@openzeppelin/compact-contracts 0.1.0 → 0.3.0-alpha

package/README.md

@@ -1,4 +1,4 @@
-[![Generic badge](https://img.shields.io/badge/Compact%20Compiler-0.29.0-1abc9c.svg)](https://docs.midnight.network/relnotes/compact/minokawa-0-18-26-0)
+[![Generic badge](https://img.shields.io/badge/Compact%20Compiler-0.31.0-1abc9c.svg)](https://docs.midnight.network/relnotes/compact/minokawa-0-18-26-0)
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
 
 This project is built on the Midnight Network.
@@ -37,8 +37,8 @@ Follow Midnight's [Compact Developer Tools installation guide](https://docs.midn
 ```bash
 $ compact compile --version
 
-Compactc version: 0.29.0
-0.29.0
+Compactc version: 0.31.0
+0.31.0
 ```
 
 ### Installation
@@ -199,7 +199,6 @@ make sure to check out the [contribution guide](CONTRIBUTING.md) in advance.
 >
 > - [Node.js](https://nodejs.org/)
 > - [Yarn](https://yarnpkg.com/getting-started/install)
-> - [Turbo](https://turborepo.com/docs/getting-started/installation)
 > - [Compact](https://docs.midnight.network/blog/compact-developer-tools)
 
 ### Set up the project
@@ -215,20 +214,20 @@ git clone git@github.com:OpenZeppelin/compact-contracts.git
 ```bash
 nvm install && \
 yarn && \
-turbo compact
+yarn compact
 ```
 
 ### Run tests
 
 ```bash
-turbo test
+yarn test
 ```
 
 ### Check/apply Biome formatter
 
 ```bash
-turbo fmt-and-lint
-turbo fmt-and-lint:fix
+yarn fmt-and-lint
+yarn fmt-and-lint:fix
 ```
 
 ### Advanced
@@ -236,8 +235,8 @@ turbo fmt-and-lint:fix
 #### Targeted compilation
 
 ```bash
-turbo compact:access
-turbo compact:archive
+yarn compact:access
+yarn compact:archive
 ...
 ```
 
@@ -246,11 +245,11 @@ turbo compact:archive
 ZK key generation is slow and usually unnecessary during development.
 
 ```bash
-# Individual module compilation (recommended for development)
-turbo compact:token  --filter=@openzeppelin/compact-contracts -- --skip-zk
-
 # Full compilation with skip-zk (use environment variable)
-SKIP_ZK=true turbo compact
+SKIP_ZK=true yarn compact
+
+# Access compilation with skip-zk (this compiles security first as a dependency)
+SKIP_ZK=true yarn compact:access
 ```
 
 #### Clean environment
@@ -258,13 +257,13 @@ SKIP_ZK=true turbo compact
 ```bash
 # WARNING!
 # These are destructive commands
-turbo clean
+yarn clean
 rm -rf .turbo/
 ```
 
 ### Troubleshooting
 
-- **Issues with turbo's cache?** Try cleaning: `turbo clean && rm -rf .turbo/`
+- **Issues with turbo's cache?** Try cleaning: `yarn clean && rm -rf .turbo/`
 - **Node version issues?** Use `nvm use` to switch to the correct version
 
 ## Security

package/access/AccessControl.compact

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.1.0 (access/AccessControl.compact)
+// OpenZeppelin Compact Contracts v0.3.0-alpha (access/AccessControl.compact)
 
-pragma language_version >= 0.21.0;
+pragma language_version >= 0.23.0;
 
 /**
  * @module AccessControl
@@ -442,38 +442,6 @@ module AccessControl {
    * @returns {Bytes<32>} accountId - The computed account identifier.
    */
   circuit _computeAccountId(): Bytes<32> {
-    return computeAccountId(wit_AccessControlSK());
-  }
-
-  /**
-   * @description Computes an account identifier without on-chain state, allowing a user to derive
-   * their identity commitment before submitting it in a grant or revoke operation.
-   * This is the off-chain counterpart to {_computeAccountId} and produces an identical result
-   * given the same inputs.
-   *
-   * @warning OpSec: The `secretKey` parameter is a sensitive secret. Mishandling it can
-   * permanently compromise the privacy guarantees of this system:
-   *
-   * - **Never log or persist** the `secretKey` in plaintext — avoid browser devtools,
-   *   application logs, analytics pipelines, or any observable side-channel.
-   * - **Store offline or in secure enclaves** — hardware security modules (HSMs),
-   *   air-gapped devices, or encrypted vaults are strongly preferred over hot storage.
-   * - **Use cryptographically secure randomness** — generate keys with `crypto.getRandomValues()`
-   *   or equivalent; weak or predictable keys can be brute-forced to reveal your identity.
-   * - **Treat key loss as identity loss** — a lost key cannot be recovered. Back up
-   *   keys securely before using them in role commitments.
-   * - **Avoid calling this circuit in untrusted environments** — executing this in an
-   *   unverified browser extension, compromised runtime, or shared machine may expose
-   *   the key to a malicious observer.
-   *
-   * ## ID Derivation
-   * `accountId = persistentHash(secretKey)`
-   *
-   * @param {Bytes<32>} secretKey - A 32-byte cryptographically secure random value.
-   *
-   * @returns {Bytes<32>} accountId - The computed account identifier.
-   */
-  export pure circuit computeAccountId(secretKey: Bytes<32>): Bytes<32> {
-    return persistentHash<Vector<1, Bytes<32>>>([secretKey]);
+    return Utils_computeAccountId(wit_AccessControlSK());
   }
 }

package/access/Ownable.compact

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.1.0 (access/Ownable.compact)
+// OpenZeppelin Compact Contracts v0.3.0-alpha (access/Ownable.compact)
 
-pragma language_version >= 0.21.0;
+pragma language_version >= 0.23.0;
 
 /**
  * @module Ownable
@@ -85,9 +85,15 @@ pragma language_version >= 0.21.0;
  */
 module Ownable {
   import CompactStandardLibrary;
-  import "../security/Initializable" prefix Initializable_;
   import "../utils/Utils" prefix Utils_;
 
+  /**
+   * @description Initialization flag, tracked per-module to avoid the compiler's
+   * shared transitive-dependency state bug (LFDT-Minokawa/compact#270). See the
+   * Initializable module for rationale.
+   */
+  export ledger _isInitialized: Boolean;
+
   export ledger _owner: Either<Bytes<32>, ContractAddress>;
 
   /**
@@ -117,11 +123,38 @@ module Ownable {
    * @returns {[]} Empty tuple.
    */
   export circuit initialize(initialOwner: Either<Bytes<32>, ContractAddress>): [] {
-    Initializable_initialize();
-    assert(!_isTargetZero(initialOwner), "Ownable: invalid initial owner");
+    assertNotInitialized();
+    _isInitialized = true;
+    assert(!Utils_isTargetZero(initialOwner), "Ownable: invalid initial owner");
     _transferOwnership(initialOwner);
   }
 
+  /**
+   * @description Asserts that the contract has been initialized, throwing an error if not.
+   *
+   * Requirements:
+   *
+   * - Contract must be initialized.
+   *
+   * @return {[]} - Empty tuple.
+   */
+  circuit assertInitialized(): [] {
+    assert(_isInitialized, "Ownable: contract not initialized");
+  }
+
+  /**
+   * @description Asserts that the contract has not been initialized, throwing an error if it has.
+   *
+   * Requirements:
+   *
+   * - Contract must not be initialized.
+   *
+   * @return {[]} - Empty tuple.
+   */
+  circuit assertNotInitialized(): [] {
+    assert(!_isInitialized, "Ownable: contract already initialized");
+  }
+
   /**
    * @description Returns the current contract owner.
    *
@@ -134,7 +167,7 @@ module Ownable {
    * @returns {Either<Bytes<32>, ContractAddress>} - The contract owner.
    */
   export circuit owner(): Either<Bytes<32>, ContractAddress> {
-    Initializable_assertInitialized();
+    assertInitialized();
     return _owner;
   }
 
@@ -158,7 +191,7 @@ module Ownable {
    * @returns {[]} Empty tuple.
    */
   export circuit transferOwnership(newOwner: Either<Bytes<32>, ContractAddress>): [] {
-    Initializable_assertInitialized();
+    assertInitialized();
     const isContractAddr = !newOwner.is_left;
     assert(!isContractAddr, "Ownable: unsafe ownership transfer");
     _unsafeTransferOwnership(newOwner);
@@ -184,9 +217,9 @@ module Ownable {
    * @returns {[]} Empty tuple.
    */
   export circuit _unsafeTransferOwnership(newOwner: Either<Bytes<32>, ContractAddress>): [] {
-    Initializable_assertInitialized();
+    assertInitialized();
     assertOnlyOwner();
-    assert(!_isTargetZero(newOwner), "Ownable: invalid new owner");
+    assert(!Utils_isTargetZero(newOwner), "Ownable: invalid new owner");
     _unsafeUncheckedTransferOwnership(newOwner);
   }
 
@@ -205,7 +238,7 @@ module Ownable {
    * @returns {[]} Empty tuple.
    */
   export circuit renounceOwnership(): [] {
-    Initializable_assertInitialized();
+    assertInitialized();
     assertOnlyOwner();
 
     // We use `left` here because `assertOnlyOwner` would return a misleading
@@ -233,7 +266,7 @@ module Ownable {
    * @returns {[]} Empty tuple.
    */
   export circuit assertOnlyOwner(): [] {
-    Initializable_assertInitialized();
+    assertInitialized();
     if (_owner.is_left) {
       assert(_computeAccountId() == _owner.left, "Ownable: caller is not the owner");
     } else {
@@ -260,7 +293,7 @@ module Ownable {
    * @returns {[]} Empty tuple.
    */
   export circuit _transferOwnership(newOwner: Either<Bytes<32>, ContractAddress>): [] {
-    Initializable_assertInitialized();
+    assertInitialized();
     const isContractAddr = !newOwner.is_left;
     assert(!isContractAddr, "Ownable: unsafe ownership transfer");
     _unsafeUncheckedTransferOwnership(newOwner);
@@ -286,7 +319,7 @@ module Ownable {
   export circuit _unsafeUncheckedTransferOwnership(
                    newOwner: Either<Bytes<32>, ContractAddress>
                    ): [] {
-    Initializable_assertInitialized();
+    assertInitialized();
     const canonAcct = Utils_canonicalize<Bytes<32>, ContractAddress>(newOwner);
     _owner = disclose(canonAcct);
   }
@@ -302,52 +335,6 @@ module Ownable {
    * @returns {Bytes<32>} accountId - The computed account identifier.
    */
   circuit _computeAccountId(): Bytes<32> {
-    return computeAccountId(wit_OwnableSK());
-  }
-
-  /**
-   * @description Computes an account identifier without on-chain state, allowing a user to derive
-   * their identity commitment before submitting it in an ownership transfer.
-   * This is the off-chain counterpart to {_computeAccountId} and produces an identical result
-   * given the same inputs.
-   *
-   * @warning OpSec: The `secretKey` parameter is a sensitive secret. Mishandling it can
-   * permanently compromise the security of this system:
-   *
-   * - **Never log or persist** the `secretKey` in plaintext — avoid browser devtools,
-   *   application logs, analytics pipelines, or any observable side-channel.
-   * - **Store offline or in secure enclaves** — hardware security modules (HSMs),
-   *   air-gapped devices, or encrypted vaults are strongly preferred over hot storage.
-   * - **Use cryptographically secure randomness** — generate keys with `crypto.getRandomValues()`
-   *   or equivalent; weak or predictable keys can be brute-forced to reveal your identity.
-   * - **Treat key loss as identity loss** — a lost key cannot be recovered.
-   * - **Avoid calling this circuit in untrusted environments** — executing this in an
-   *   unverified browser extension, compromised runtime, or shared machine may expose
-   *   the key to a malicious observer.
-   *
-   * ## ID Derivation
-   * `accountId = persistentHash(secretKey)`
-   *
-   * @param {Bytes<32>} secretKey - A 32-byte cryptographically secure random value.
-   *
-   * @returns {Bytes<32>} accountId - The computed account identifier.
-   */
-  export pure circuit computeAccountId(secretKey: Bytes<32>): Bytes<32> {
-    return persistentHash<Vector<1, Bytes<32>>>([secretKey]);
-  }
-
-  /**
-   * @description Returns `true` if `target`'s active branch (as indicated by `is_left`)
-   * holds the zero value.
-   *
-   * @param {Either<Bytes<32>, ContractAddress>} target - The value to check.
-   * @returns {Boolean} - `true` if the active branch is zero, `false` otherwise.
-   */
-  circuit _isTargetZero(target: Either<Bytes<32>, ContractAddress>): Boolean {
-    if (target.is_left) {
-      return target.left == default<Bytes<32>>;
-    } else {
-      return target.right == default<ContractAddress>;
-    }
+    return Utils_computeAccountId(wit_OwnableSK());
   }
 }

package/access/ShieldedAccessControl.compact

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.1.0 (access/ShieldedAccessControl.compact)
+// OpenZeppelin Compact Contracts v0.3.0-alpha (access/ShieldedAccessControl.compact)
 
-pragma language_version >= 0.21.0;
+pragma language_version >= 0.23.0;
 
 /**
  * @module ShieldedAccessControl
@@ -168,7 +168,6 @@ pragma language_version >= 0.21.0;
 module ShieldedAccessControl {
   import CompactStandardLibrary;
   import "../utils/Utils" prefix Utils_;
-  import "../security/Initializable" prefix Initializable_;
 
   export enum UpdateType {
     Grant,
@@ -181,6 +180,13 @@ module ShieldedAccessControl {
   export new type AccountIdentifier = Bytes<32>;
   export new type RoleNullifier = Bytes<32>;
 
+  /**
+   * @description Initialization flag, tracked per-module to avoid the compiler's
+   * shared transitive-dependency state bug (LFDT-Minokawa/compact#270). See the
+   * Initializable module for rationale.
+   */
+  export ledger _isInitialized: Boolean;
+
   /**
    * @ledger _operatorRoles
    * @description A Merkle tree of role commitments stored as SHA256(role | accountId | instanceSalt | commitmentDomain)
@@ -259,11 +265,38 @@ module ShieldedAccessControl {
    */
   export circuit initialize(instanceSalt: Bytes<32>): [] {
     assert(instanceSalt != default<Bytes<32>>, "ShieldedAccessControl: Instance salt must not be 0");
-    Initializable_initialize();
+    assertNotInitialized();
+    _isInitialized = true;
 
     _instanceSalt = disclose(instanceSalt);
   }
 
+  /**
+   * @description Asserts that the contract has been initialized, throwing an error if not.
+   *
+   * Requirements:
+   *
+   * - Contract must be initialized.
+   *
+   * @return {[]} - Empty tuple.
+   */
+  circuit assertInitialized(): [] {
+    assert(_isInitialized, "ShieldedAccessControl: contract not initialized");
+  }
+
+  /**
+   * @description Asserts that the contract has not been initialized, throwing an error if it has.
+   *
+   * Requirements:
+   *
+   * - Contract must not be initialized.
+   *
+   * @return {[]} - Empty tuple.
+   */
+  circuit assertNotInitialized(): [] {
+    assert(!_isInitialized, "ShieldedAccessControl: contract already initialized");
+  }
+
   /**
    * @description The default admin role for all roles. Only accounts with this role will be able to grant or revoke other roles
    * unless custom admin roles are created.
@@ -295,7 +328,7 @@ module ShieldedAccessControl {
    * @return {[]} - Empty tuple.
    */
   export circuit assertOnlyRole(role: RoleIdentifier): [] {
-    Initializable_assertInitialized();
+    assertInitialized();
     assert(_uncheckedCanProveRole(role), "ShieldedAccessControl: unauthorized account");
   }
 
@@ -320,7 +353,7 @@ module ShieldedAccessControl {
    * @return {Boolean} - A boolean determining if a caller successfully proved ownership of `role`
    */
   export circuit canProveRole(role: RoleIdentifier): Boolean {
-    Initializable_assertInitialized();
+    assertInitialized();
     return _uncheckedCanProveRole(role);
   }
 
@@ -417,7 +450,7 @@ module ShieldedAccessControl {
    * @return {[]} - Empty tuple.
    */
   export circuit _grantRole(role: RoleIdentifier, accountId: AccountIdentifier): [] {
-    Initializable_assertInitialized();
+    assertInitialized();
     _updateRole(role, accountId, UpdateType.Grant);
   }
 
@@ -449,7 +482,7 @@ module ShieldedAccessControl {
    * @return {[]} - Empty tuple.
    */
   export circuit renounceRole(role: RoleIdentifier, accountIdConfirmation: AccountIdentifier): [] {
-    Initializable_assertInitialized();
+    assertInitialized();
 
     assert(accountIdConfirmation == _computeAccountId(),
            "ShieldedAccessControl: bad confirmation"
@@ -515,7 +548,7 @@ module ShieldedAccessControl {
    * @return {[]} - Empty tuple.
    */
   export circuit _revokeRole(role: RoleIdentifier, accountId: AccountIdentifier): [] {
-    Initializable_assertInitialized();
+    assertInitialized();
     _updateRole(role, accountId, UpdateType.Revoke);
   }
 
@@ -599,7 +632,7 @@ module ShieldedAccessControl {
    * @return {[]} - Empty tuple.
    */
   export circuit _setRoleAdmin(role: RoleIdentifier, adminId: RoleIdentifier): [] {
-    Initializable_assertInitialized();
+    assertInitialized();
     _adminRoles.insert(disclose(role), disclose(adminId));
   }
 

package/access/ZOwnablePK.compact

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.1.0 (access/ZOwnablePK.compact)
+// OpenZeppelin Compact Contracts v0.3.0-alpha (access/ZOwnablePK.compact)
 
-pragma language_version >= 0.21.0;
+pragma language_version >= 0.23.0;
 
 /**
  * @module ZOwnablePK
@@ -45,7 +45,13 @@ pragma language_version >= 0.21.0;
  */
 module ZOwnablePK {
   import CompactStandardLibrary;
-  import "../security/Initializable" prefix Initializable_;
+
+  /**
+   * @description Initialization flag, tracked per-module to avoid the compiler's
+   * shared transitive-dependency state bug (LFDT-Minokawa/compact#270). See the
+   * Initializable module for rationale.
+   */
+  export ledger _isInitialized: Boolean;
 
   /**
    * @ledger _ownerCommitment
@@ -56,6 +62,7 @@ module ZOwnablePK {
    * A commitment of `default<Bytes<32>>` (i.e., zero) indicates the contract is unowned.
    */
   export ledger _ownerCommitment: Bytes<32>;
+
   /**
    * @ledger _counter
    * @description Internal transfer counter used to prevent commitment reuse.
@@ -64,6 +71,7 @@ module ZOwnablePK {
    * `instanceSalt` to compute unique owner commitments over time.
    */
   export ledger _counter: Counter;
+
   /**
    * @sealed @ledger _instanceSalt
    * @description A per-instance value provided at initialization used to namespace
@@ -104,13 +112,40 @@ module ZOwnablePK {
    * @returns {[]} Empty tuple.
    */
   export circuit initialize(ownerId: Bytes<32>, instanceSalt: Bytes<32>): [] {
-    Initializable_initialize();
+    assertNotInitialized();
+    _isInitialized = true;
 
     assert(ownerId != default<Bytes<32>>, "ZOwnablePK: invalid id");
     _instanceSalt = disclose(instanceSalt);
     _transferOwnership(ownerId);
   }
 
+  /**
+   * @description Asserts that the contract has been initialized, throwing an error if not.
+   *
+   * Requirements:
+   *
+   * - Contract must be initialized.
+   *
+   * @return {[]} - Empty tuple.
+   */
+  circuit assertInitialized(): [] {
+    assert(_isInitialized, "ZOwnablePK: contract not initialized");
+  }
+
+  /**
+   * @description Asserts that the contract has not been initialized, throwing an error if it has.
+   *
+   * Requirements:
+   *
+   * - Contract must not be initialized.
+   *
+   * @return {[]} - Empty tuple.
+   */
+  circuit assertNotInitialized(): [] {
+    assert(!_isInitialized, "ZOwnablePK: contract already initialized");
+  }
+
   /**
    * @description Returns the current commitment representing the contract owner.
    * The full commitment is: `SHA256(SHA256(pk, nonce), instanceSalt, counter, domain)`.
@@ -124,7 +159,7 @@ module ZOwnablePK {
    * @returns {Bytes<32>} The current owner's commitment.
    */
   export circuit owner(): Bytes<32> {
-    Initializable_assertInitialized();
+    assertInitialized();
     return _ownerCommitment;
   }
 
@@ -144,7 +179,7 @@ module ZOwnablePK {
    * @returns {[]} Empty tuple.
    */
   export circuit transferOwnership(newOwnerId: Bytes<32>): [] {
-    Initializable_assertInitialized();
+    assertInitialized();
 
     assertOnlyOwner();
     assert(newOwnerId != default<Bytes<32>>, "ZOwnablePK: invalid id");
@@ -166,7 +201,7 @@ module ZOwnablePK {
    * @returns {[]} Empty tuple.
    */
   export circuit renounceOwnership(): [] {
-    Initializable_assertInitialized();
+    assertInitialized();
 
     assertOnlyOwner();
     _ownerCommitment.resetToDefault();
@@ -188,7 +223,7 @@ module ZOwnablePK {
    * @returns {[]} Empty tuple.
    */
   export circuit assertOnlyOwner(): [] {
-    Initializable_assertInitialized();
+    assertInitialized();
 
     const nonce = wit_secretNonce();
     const callerAsEither =
@@ -234,7 +269,7 @@ module ZOwnablePK {
    * @returns {Bytes<32>} The commitment derived from `id` and `counter`.
    */
   export circuit _computeOwnerCommitment(id: Bytes<32>, counter: Uint<64>,): Bytes<32> {
-    Initializable_assertInitialized();
+    assertInitialized();
     return persistentHash<Vector<4, Bytes<32>>>(
              [id, _instanceSalt, counter as Field as Bytes<32>, pad(32, "ZOwnablePK:shield:")]
              );
@@ -296,7 +331,7 @@ module ZOwnablePK {
    * @returns {[]} Empty tuple.
    */
   export circuit _transferOwnership(newOwnerId: Bytes<32>): [] {
-    Initializable_assertInitialized();
+    assertInitialized();
 
     _counter.increment(1);
     _ownerCommitment = disclose(_computeOwnerCommitment(newOwnerId, _counter));