Upgrade Simulator, Contracts to 0.29.0

.github/ISSUE_TEMPLATE/01_bug_report.yml

@@ -93,8 +93,7 @@ body:
       label: Version
       description: What version of Compact are you running?
       options:
-        - 0.26.0 (Default)
+        - 0.29.0 (Default)
       default: 0
     validations:
       required: true
-

.github/actions/setup/action.yml

@@ -41,6 +41,6 @@ runs:
 
     - name: Setup Compact Compiler
       if: ${{ inputs.skip-compact != 'true' }}
-      uses: midnightntwrk/setup-compact-action@4130145456ad3f45934788dd4a65647eb283e658 # loose commit/not released
+      uses: midnightntwrk/setup-compact-action@836895c8fffbbea6bd986af2b17e8941ff29d1f8 # v1
       with:
-        compact-version: "0.26.0"
+        compact-version: "0.29.0"

contracts/package.json

@@ -20,6 +20,9 @@
   },
   "homepage": "https://docs.openzeppelin.com/contracts-compact/",
   "type": "module",
+  "imports": {
+    "#test-utils/address.js": "./test-utils/address.js"
+  },
   "scripts": {
     "compact": "compact-compiler",
     "compact:access": "compact-compiler --dir access",

contracts/src/access/AccessControl.compact

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 // OpenZeppelin Compact Contracts v0.0.1-alpha.1 (access/AccessControl.compact)
 
-pragma language_version >= 0.18.0;
+pragma language_version >= 0.21.0;
 
 /**
  * @module AccessControl
@@ -81,7 +81,8 @@ module AccessControl {
    * @type {Map<roleId, hasRole>}
    * @type {Map<Bytes<32>, Map<Either<ZswapCoinPublicKey, ContractAddress>, Boolean>} _operatorRoles
    */
-  export ledger _operatorRoles: Map<Bytes<32>, Map<Either<ZswapCoinPublicKey, ContractAddress>, Boolean>>;
+  export ledger _operatorRoles: Map<Bytes<32>,
+                                    Map<Either<ZswapCoinPublicKey, ContractAddress>, Boolean>>;
 
   /**
    * @description Mapping from a role identifier to an admin role identifier.
@@ -94,25 +95,21 @@ module AccessControl {
 
   export ledger DEFAULT_ADMIN_ROLE: Bytes<32>;
 
-   /**
-    * @description Returns `true` if `account` has been granted `roleId`.
-    *
-    * @circuitInfo k=10, rows=487
-    *
-    * @param {Bytes<32>} roleId - The role identifier.
-    * @param {Either<ZswapCoinPublicKey, ContractAddress>} account - The account to query.
-    * @return {Boolean} - Whether the account has the specified role.
+  /**
+   * @description Returns `true` if `account` has been granted `roleId`.
+   *
+   * @circuitInfo k=10, rows=487
+   *
+   * @param {Bytes<32>} roleId - The role identifier.
+   * @param {Either<ZswapCoinPublicKey, ContractAddress>} account - The account to query.
+   * @return {Boolean} - Whether the account has the specified role.
     */
-  export circuit hasRole(roleId: Bytes<32>, account: Either<ZswapCoinPublicKey, ContractAddress>): Boolean {
-    if (
-      _operatorRoles.member(disclose(roleId)) &&
-      _operatorRoles
-        .lookup(roleId)
-        .member(disclose(account))
-      ) {
-      return _operatorRoles
-        .lookup(roleId)
-        .lookup(disclose(account));
+  export circuit hasRole(roleId: Bytes<32>,
+                         account: Either<ZswapCoinPublicKey, ContractAddress>
+                         ): Boolean {
+    if (_operatorRoles.member(disclose(roleId)) &&
+        _operatorRoles.lookup(roleId).member(disclose(account))) {
+      return _operatorRoles.lookup(roleId).lookup(disclose(account));
     } else {
       return false;
     }
@@ -132,7 +129,7 @@ module AccessControl {
    * @return {[]} - Empty tuple.
    */
   export circuit assertOnlyRole(roleId: Bytes<32>): [] {
-    _checkRole(roleId, left<ZswapCoinPublicKey,ContractAddress>(ownPublicKey()));
+    _checkRole(roleId, left<ZswapCoinPublicKey, ContractAddress>(ownPublicKey()));
   }
 
   /**
@@ -148,7 +145,10 @@ module AccessControl {
    * @param {Either<ZswapCoinPublicKey, ContractAddress>} account - The account to query.
    * @return {[]} - Empty tuple.
    */
-  export circuit _checkRole(roleId: Bytes<32>, account: Either<ZswapCoinPublicKey, ContractAddress>): [] {
+  export circuit _checkRole(
+                   roleId: Bytes<32>,
+                   account: Either<ZswapCoinPublicKey, ContractAddress>
+                   ): [] {
     assert(hasRole(roleId, account), "AccessControl: unauthorized account");
   }
 
@@ -184,7 +184,10 @@ module AccessControl {
    * @param {Either<ZswapCoinPublicKey, ContractAddress>} account - A ZswapCoinPublicKey or ContractAddress.
    * @return {[]} - Empty tuple.
    */
-  export circuit grantRole(roleId: Bytes<32>, account: Either<ZswapCoinPublicKey, ContractAddress>): [] {
+  export circuit grantRole(
+                   roleId: Bytes<32>,
+                   account: Either<ZswapCoinPublicKey, ContractAddress>
+                   ): [] {
     assertOnlyRole(getRoleAdmin(roleId));
     _grantRole(roleId, account);
   }
@@ -202,31 +205,39 @@ module AccessControl {
    * @param {Either<ZswapCoinPublicKey, ContractAddress>} account - A ZswapCoinPublicKey or ContractAddress.
    * @return {[]} - Empty tuple.
    */
-  export circuit revokeRole(roleId: Bytes<32>, account: Either<ZswapCoinPublicKey, ContractAddress>): [] {
+  export circuit revokeRole(
+                   roleId: Bytes<32>,
+                   account: Either<ZswapCoinPublicKey, ContractAddress>
+                   ): [] {
     assertOnlyRole(getRoleAdmin(roleId));
     _revokeRole(roleId, account);
   }
 
- /**
-  * @description Revokes `roleId` from the calling account.
-  *
-  * @notice Roles are often managed via {grantRole} and {revokeRole}: this circuit's
-  * purpose is to provide a mechanism for accounts to lose their privileges
-  * if they are compromised (such as when a trusted device is misplaced).
-  *
-  * @circuitInfo k=10, rows=640
-  *
-  * Requirements:
-  *
-  * - The caller must be `callerConfirmation`.
-  * - The caller must not be a `ContractAddress`.
-  *
-  * @param {Bytes<32>} roleId - The role identifier.
-  * @param {Either<ZswapCoinPublicKey, ContractAddress>} callerConfirmation - A ZswapCoinPublicKey or ContractAddress.
-  * @return {[]} - Empty tuple.
-  */
-  export circuit renounceRole(roleId: Bytes<32>, callerConfirmation: Either<ZswapCoinPublicKey, ContractAddress>): [] {
-    assert(callerConfirmation == left<ZswapCoinPublicKey,ContractAddress>(ownPublicKey()), "AccessControl: bad confirmation");
+  /**
+   * @description Revokes `roleId` from the calling account.
+   *
+   * @notice Roles are often managed via {grantRole} and {revokeRole}: this circuit's
+   * purpose is to provide a mechanism for accounts to lose their privileges
+   * if they are compromised (such as when a trusted device is misplaced).
+   *
+   * @circuitInfo k=10, rows=640
+   *
+   * Requirements:
+   *
+   * - The caller must be `callerConfirmation`.
+   * - The caller must not be a `ContractAddress`.
+   *
+   * @param {Bytes<32>} roleId - The role identifier.
+   * @param {Either<ZswapCoinPublicKey, ContractAddress>} callerConfirmation - A ZswapCoinPublicKey or ContractAddress.
+   * @return {[]} - Empty tuple.
+   */
+  export circuit renounceRole(
+                   roleId: Bytes<32>,
+                   callerConfirmation: Either<ZswapCoinPublicKey, ContractAddress>
+                   ): [] {
+    assert(callerConfirmation == left<ZswapCoinPublicKey, ContractAddress>(ownPublicKey()),
+           "AccessControl: bad confirmation"
+           );
 
     _revokeRole(roleId, callerConfirmation);
   }
@@ -258,7 +269,10 @@ module AccessControl {
    * @param {Either<ZswapCoinPublicKey, ContractAddress>} account - A ZswapCoinPublicKey or ContractAddress.
    * @return {Boolean} roleGranted - A boolean indicating if `roleId` was granted.
    */
-  export circuit _grantRole(roleId: Bytes<32>, account: Either<ZswapCoinPublicKey, ContractAddress>): Boolean {
+  export circuit _grantRole(
+                   roleId: Bytes<32>,
+                   account: Either<ZswapCoinPublicKey, ContractAddress>
+                   ): Boolean {
     assert(!Utils_isContractAddress(account), "AccessControl: unsafe role approval");
     return _unsafeGrantRole(roleId, account);
   }
@@ -276,22 +290,20 @@ module AccessControl {
    * @param {Either<ZswapCoinPublicKey, ContractAddress>} account - A ZswapCoinPublicKey or ContractAddress.
    * @return {Boolean} roleGranted - A boolean indicating if `role` was granted.
    */
-  export circuit _unsafeGrantRole(roleId: Bytes<32>, account: Either<ZswapCoinPublicKey, ContractAddress>): Boolean {
+  export circuit _unsafeGrantRole(
+                   roleId: Bytes<32>,
+                   account: Either<ZswapCoinPublicKey, ContractAddress>
+                   ): Boolean {
     if (hasRole(roleId, account)) {
       return false;
     }
 
     if (!_operatorRoles.member(disclose(roleId))) {
       _operatorRoles.insert(
         disclose(roleId),
-        default<Map<
-          Either<ZswapCoinPublicKey, ContractAddress>,
-          Boolean
-        >>
-      );
-      _operatorRoles
-        .lookup(roleId)
-        .insert(disclose(account), true);
+        default<Map<Either<ZswapCoinPublicKey, ContractAddress>, Boolean>>
+        );
+      _operatorRoles.lookup(roleId).insert(disclose(account), true);
       return true;
     }
 
@@ -309,14 +321,15 @@ module AccessControl {
    * @param {Bytes<32>} adminRole - The admin role identifier.
    * @return {Boolean} roleRevoked - A boolean indicating if `roleId` was revoked.
    */
-  export circuit _revokeRole(roleId: Bytes<32>, account: Either<ZswapCoinPublicKey, ContractAddress>): Boolean {
+  export circuit _revokeRole(
+                   roleId: Bytes<32>,
+                   account: Either<ZswapCoinPublicKey, ContractAddress>
+                   ): Boolean {
     if (!hasRole(roleId, account)) {
       return false;
     }
 
-    _operatorRoles
-      .lookup(roleId)
-      .insert(disclose(account), false);
+    _operatorRoles.lookup(roleId).insert(disclose(account), false);
     return true;
   }
 }

contracts/src/access/Ownable.compact

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 // OpenZeppelin Compact Contracts v0.0.1-alpha.1 (access/Ownable.compact)
 
-pragma language_version >= 0.18.0;
+pragma language_version >= 0.21.0;
 
 /**
  * @module Ownable
@@ -143,7 +143,7 @@ module Ownable {
   export circuit renounceOwnership(): [] {
     Initializable_assertInitialized();
     assertOnlyOwner();
-    _transferOwnership(burnAddress());
+    _transferOwnership(shieldedBurnAddress());
   }
 
   /**
@@ -206,7 +206,9 @@ module Ownable {
    * @param {Either<ZswapCoinPublicKey, ContractAddress>} newOwner - The new owner.
    * @returns {[]} Empty tuple.
    */
-  export circuit _unsafeUncheckedTransferOwnership(newOwner: Either<ZswapCoinPublicKey, ContractAddress>): [] {
+  export circuit _unsafeUncheckedTransferOwnership(
+                   newOwner: Either<ZswapCoinPublicKey, ContractAddress>
+                   ): [] {
     Initializable_assertInitialized();
     _owner = disclose(newOwner);
   }

contracts/src/access/ZOwnablePK.compact

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 // OpenZeppelin Compact Contracts v0.0.1-alpha.1 (access/ZOwnablePK.compact)
 
-pragma language_version >= 0.18.0;
+pragma language_version >= 0.21.0;
 
 /**
  * @module ZOwnablePK
@@ -191,13 +191,14 @@ module ZOwnablePK {
     Initializable_assertInitialized();
 
     const nonce = wit_secretNonce();
-    const callerAsEither = Either<ZswapCoinPublicKey, ContractAddress> {
-      is_left: true,
-      left: ownPublicKey(),
-      right: ContractAddress { bytes: pad(32, "") }
-    };
+    const callerAsEither =
+            Either<ZswapCoinPublicKey, ContractAddress> { is_left: true,
+                                                          left: ownPublicKey(),
+                                                          right: ContractAddress { bytes: pad(32, "") } };
     const id = _computeOwnerId(callerAsEither, nonce);
-    assert(_ownerCommitment == _computeOwnerCommitment(id, _counter), "ZOwnablePK: caller is not the owner");
+    assert(_ownerCommitment == _computeOwnerCommitment(id, _counter),
+           "ZOwnablePK: caller is not the owner"
+           );
   }
 
   /**
@@ -232,19 +233,11 @@ module ZOwnablePK {
    * after every transfer to prevent duplicate commitments given the same `id`.
    * @returns {Bytes<32>} The commitment derived from `id` and `counter`.
    */
-  export circuit _computeOwnerCommitment(
-    id: Bytes<32>,
-    counter: Uint<64>,
-  ): Bytes<32> {
+  export circuit _computeOwnerCommitment(id: Bytes<32>, counter: Uint<64>,): Bytes<32> {
     Initializable_assertInitialized();
     return persistentHash<Vector<4, Bytes<32>>>(
-      [
-        id,
-        _instanceSalt,
-        counter as Field as Bytes<32>,
-        pad(32, "ZOwnablePK:shield:")
-      ]
-    );
+             [id, _instanceSalt, counter as Field as Bytes<32>, pad(32, "ZOwnablePK:shield:")]
+             );
   }
 
   /**
@@ -280,9 +273,9 @@ module ZOwnablePK {
    * @returns {Bytes<32>} The computed owner ID.
    */
   export pure circuit _computeOwnerId(
-    pk: Either<ZswapCoinPublicKey, ContractAddress>,
-    nonce: Bytes<32>
-  ): Bytes<32> {
+                        pk: Either<ZswapCoinPublicKey, ContractAddress>,
+                        nonce: Bytes<32>
+                        ): Bytes<32> {
     assert(pk.is_left, "ZOwnablePK: contract address owners are not yet supported");
 
     return persistentHash<Vector<2, Bytes<32>>>([pk.left.bytes, nonce]);