@openzeppelin/compact-contracts 0.3.0-alpha.1 → 0.3.0-rc.1

package/token/extensions/{NativeShieldedTokenFamilySupply.compact → NativeShieldedTokenFamilyPublicSupply.compact}

@@ -1,16 +1,16 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.2.0 (token/extensions/NativeShieldedTokenFamilySupply.compact)
+// OpenZeppelin Compact Contracts v0.2.0 (token/extensions/NativeShieldedTokenFamilyPublicSupply.compact)
 
 pragma language_version >= 0.23.0;
 
 /**
- * @module NativeShieldedTokenFamilySupply
+ * @module NativeShieldedTokenFamilyPublicSupply
  * @description Optional standalone extension that adds per-domain on-chain
  * supply accounting to a `NativeShieldedTokenFamily`. It exposes `_addMinted` /
  * `_addBurned` building blocks plus the `totalMinted` / `totalBurned` /
  * `totalSupply` getters, each keyed by domain. It imports no token module.
  *
- * It is a thin wrapper over `NativeShieldedTokenSupplyCore`, forwarding the
+ * It is a thin wrapper over `NativeShieldedTokenPublicSupplyCore`, forwarding the
  * caller's per-call `domain`, so the accounting logic and guarantees live in
  * the shared core.
  *
@@ -20,7 +20,7 @@ pragma language_version >= 0.23.0;
  *
  *   export circuit mint(
  *     domain: Bytes<32>,
- *     recipient: Either<ZswapCoinPublicKey, ContractAddress>,
+ *     recipient: ZswapCoinPublicKey,
  *     amount: Uint<64>,
  *     nonce: Bytes<32>
  *   ): ShieldedCoinInfo {
@@ -33,7 +33,7 @@ pragma language_version >= 0.23.0;
  *     domain: Bytes<32>,
  *     coin: ShieldedCoinInfo,
  *     amount: Uint<128>,
- *     refundTo: Either<ZswapCoinPublicKey, ContractAddress>
+ *     refundTo: ZswapCoinPublicKey
  *   ): Maybe<ShieldedCoinInfo> {
  *     const refund = Family__burn(domain, coin, amount, refundTo);
  *     Supply__addBurned(domain, amount);
@@ -51,25 +51,25 @@ pragma language_version >= 0.23.0;
  *
  * @dev Mint amounts are already public via the protocol's `shieldedMints`
  * effect, so `_addMinted` adds accounting, not disclosure. See
- * `NativeShieldedTokenSupplyCore` for the exact / lower-bound / upper-bound
+ * `NativeShieldedTokenPublicSupplyCore` for the exact / lower-bound / upper-bound
  * guarantees, the per-domain `burned <= minted` invariant, and the mint-side
  * drift caveat.
  *
  * @warning Pair every mint with `_addMinted` and every burn with `_addBurned` on
  * every path, under the matching domain; mis-wiring is a security-critical,
  * undetectable error (e.g. an undercounted mint makes `_addBurned` reject
- * legitimate burns). See `NativeShieldedTokenSupplyCore`.
+ * legitimate burns). See `NativeShieldedTokenPublicSupplyCore`.
  */
-module NativeShieldedTokenFamilySupply {
+module NativeShieldedTokenFamilyPublicSupply {
   import CompactStandardLibrary;
-  import "./NativeShieldedTokenSupplyCore" prefix Core_;
+  import "./NativeShieldedTokenPublicSupplyCore" prefix Core_;
 
   // Circuits use the `Core_` prefix above. The named import/re-export below is
   // only for the core supply ledger keys, so the implementing contract's ledger
   // keys read as `_totalMinted` / `_totalBurned` rather than
-  // `NativeShieldedTokenSupplyCore__totalMinted`. The circuit names are
+  // `NativeShieldedTokenPublicSupplyCore__totalMinted`. The circuit names are
   // intentionally NOT imported unprefixed, to avoid potential clashes.
-  import { _totalMinted, _totalBurned } from "./NativeShieldedTokenSupplyCore";
+  import { _totalMinted, _totalBurned } from "./NativeShieldedTokenPublicSupplyCore";
   export { _totalMinted, _totalBurned };
 
   /**

package/token/extensions/{NativeShieldedTokenSupply.compact → NativeShieldedTokenPublicSupply.compact}

@@ -1,16 +1,16 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.2.0 (token/extensions/NativeShieldedTokenSupply.compact)
+// OpenZeppelin Compact Contracts v0.2.0 (token/extensions/NativeShieldedTokenPublicSupply.compact)
 
 pragma language_version >= 0.23.0;
 
 /**
- * @module NativeShieldedTokenSupply
+ * @module NativeShieldedTokenPublicSupply
  * @description Optional standalone extension that adds on-chain supply
  * accounting to a `NativeShieldedToken`. It exposes scalar `_addMinted` /
  * `_addBurned` building blocks plus the `totalMinted` / `totalBurned` /
  * `totalSupply` getters. It imports no token module.
  *
- * It is a thin wrapper over `NativeShieldedTokenSupplyCore`, forwarding a
+ * It is a thin wrapper over `NativeShieldedTokenPublicSupplyCore`, forwarding a
  * single fixed key (the paired contract has exactly one token type), so the
  * accounting logic and guarantees live in the shared core.
  *
@@ -18,7 +18,7 @@ pragma language_version >= 0.23.0;
  * pieces, calling the accounting block alongside the matching token op:
  *
  *   export circuit mint(
- *     recipient: Either<ZswapCoinPublicKey, ContractAddress>,
+ *     recipient: ZswapCoinPublicKey,
  *     amount: Uint<64>,
  *     nonce: Bytes<32>
  *   ): ShieldedCoinInfo {
@@ -30,7 +30,7 @@ pragma language_version >= 0.23.0;
  *   export circuit burn(
  *     coin: ShieldedCoinInfo,
  *     amount: Uint<128>,
- *     refundTo: Either<ZswapCoinPublicKey, ContractAddress>
+ *     refundTo: ZswapCoinPublicKey
  *   ): Maybe<ShieldedCoinInfo> {
  *     const refund = Token__burn(coin, amount, refundTo);
  *     Supply__addBurned(amount);
@@ -48,24 +48,24 @@ pragma language_version >= 0.23.0;
  *
  * @dev Mint amounts are already public via the protocol's `shieldedMints`
  * effect, so `_addMinted` adds accounting, not disclosure. See
- * `NativeShieldedTokenSupplyCore` for the exact / lower-bound / upper-bound
+ * `NativeShieldedTokenPublicSupplyCore` for the exact / lower-bound / upper-bound
  * guarantees, the `burned <= minted` invariant, and the mint-side drift caveat.
  *
  * @warning Pair every mint with `_addMinted` and every burn with `_addBurned` on
  * every path; mis-wiring is a security-critical, undetectable error (e.g. an
  * undercounted mint makes `_addBurned` reject legitimate burns). See
- * `NativeShieldedTokenSupplyCore`.
+ * `NativeShieldedTokenPublicSupplyCore`.
  */
-module NativeShieldedTokenSupply {
+module NativeShieldedTokenPublicSupply {
   import CompactStandardLibrary;
-  import "./NativeShieldedTokenSupplyCore" prefix Core_;
+  import "./NativeShieldedTokenPublicSupplyCore" prefix Core_;
 
   // Circuits use the `Core_` prefix above. The named import/re-export below is
   // only for the core supply ledger keys, so the implementing contract's ledger
   // keys read as `_totalMinted` / `_totalBurned` rather than
-  // `NativeShieldedTokenSupplyCore__totalMinted`. The circuit names are
+  // `NativeShieldedTokenPublicSupplyCore__totalMinted`. The circuit names are
   // intentionally NOT imported unprefixed, to avoid potential clashes.
-  import { _totalMinted, _totalBurned } from "./NativeShieldedTokenSupplyCore";
+  import { _totalMinted, _totalBurned } from "./NativeShieldedTokenPublicSupplyCore";
   export { _totalMinted, _totalBurned };
 
   /**

package/token/extensions/{NativeShieldedTokenSupplyCore.compact → NativeShieldedTokenPublicSupplyCore.compact}

@@ -1,10 +1,10 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.2.0 (token/extensions/NativeShieldedTokenSupplyCore.compact)
+// OpenZeppelin Compact Contracts v0.2.0 (token/extensions/NativeShieldedTokenPublicSupplyCore.compact)
 
 pragma language_version >= 0.23.0;
 
 /**
- * @module NativeShieldedTokenSupplyCore
+ * @module NativeShieldedTokenPublicSupplyCore
  * @description Shared, domain-keyed core of the optional supply-accounting
  * extension. It owns the per-domain minted/burned maps and exposes the
  * `_addMinted` / `_addBurned` building blocks plus the `totalMinted` /
@@ -13,12 +13,12 @@ pragma language_version >= 0.23.0;
  * This module is NOT meant to be composed directly. It is the de-duplicated
  * base behind the two user-facing flavors:
  *
- * - `NativeShieldedTokenSupply` — pairs with `NativeShieldedToken`; forwards a
+ * - `NativeShieldedTokenPublicSupply` — pairs with `NativeShieldedToken`; forwards a
  *   single fixed key (the contract has one token type).
- * - `NativeShieldedTokenFamilySupply` — pairs with `NativeShieldedTokenFamily`;
+ * - `NativeShieldedTokenFamilyPublicSupply` — pairs with `NativeShieldedTokenFamily`;
  *   forwards the caller's per-call `domain`.
  *
- * @dev Assertion messages use the generic `NativeShieldedTokenSupply:` prefix
+ * @dev Assertion messages use the generic `NativeShieldedTokenPublicSupply:` prefix
  * so they read sensibly from either flavor. There is no initialization: an
  * absent domain key reads as 0, and the getters do not gate on the paired token
  * module's init flag (a counter reading 0 before init is correct), so init
@@ -51,7 +51,7 @@ pragma language_version >= 0.23.0;
  *   overstates circulating supply.
  * Call the matching accounting block on every mint and burn path, same domain.
  */
-module NativeShieldedTokenSupplyCore {
+module NativeShieldedTokenPublicSupplyCore {
   import CompactStandardLibrary;
   import "../../utils/Utils" prefix Utils_;
 
@@ -79,7 +79,7 @@ module NativeShieldedTokenSupplyCore {
    */
   export circuit _addMinted(domain: Bytes<32>, amount: Uint<64>): [] {
     const current = totalMinted(domain);
-    assert(Utils_UINT128_MAX() - current >= amount, "NativeShieldedTokenSupply: arithmetic overflow");
+    assert(Utils_UINT128_MAX() - current >= amount, "NativeShieldedTokenPublicSupply: arithmetic overflow");
     _totalMinted.insert(disclose(domain), disclose((current + amount) as Uint<128>));
   }
 
@@ -103,8 +103,8 @@ module NativeShieldedTokenSupplyCore {
     // First guards the subtraction below from underflowing on an already-corrupt
     // state (stored burned past minted); the second is the reachable per-call
     // check that this burn does not push the domain past its minted total.
-    assert(minted >= current, "NativeShieldedTokenSupply: burned total exceeds minted");
-    assert(minted - current >= amount, "NativeShieldedTokenSupply: burn exceeds available supply");
+    assert(minted >= current, "NativeShieldedTokenPublicSupply: burned total exceeds minted");
+    assert(minted - current >= amount, "NativeShieldedTokenPublicSupply: burn exceeds available supply");
     _totalBurned.insert(disclose(domain), disclose((current + amount) as Uint<128>));
   }
 

package/utils/Utils.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.3.0-alpha.1 (utils/Utils.compact)
+// OpenZeppelin Compact Contracts v0.3.0-rc.1 (utils/Utils.compact)
 
 pragma language_version >= 0.23.0;
 
@@ -150,6 +150,16 @@ module Utils {
    * ## ID Derivation
    * `accountId = persistentHash(secretKey)`
    *
+   * @dev The absence of a domain-separation tag is DELIBERATE. This identifier
+   * is global by design: the same key material yields the same identity in
+   * every module deriving one, so a user who wishes to carry one identity
+   * across modules can. Modules wanting a per-deployment, unlinkable identity
+   * should not use this circuit.
+   *
+   * @dev NOT FOR PRIVATE DERIVATION. This returns an identifier, not a secret,
+   * and the construction is untagged. A circuit deriving a PRIVATE value from a
+   * secret MUST use its own domain-separation tag.
+   *
    * @param {Bytes<32>} secretKey - A 32-byte cryptographically secure random value.
    *
    * @returns {Bytes<32>} accountId - The computed account identifier.

package/multisig/SignerManager.compact

@@ -1,205 +0,0 @@
-// SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.3.0-alpha.1 (multisig/SignerManager.compact)
-
-pragma language_version >= 0.23.0;
-
-/**
- * @module SignerManager<T>
- * @description Manages signer registry, threshold enforcement, and signer
- * validation for multisig governance contracts.
- *
- * Parameterized over the signer identity type `T`, allowing the consuming
- * contract to choose the identity mechanism at import time. Common
- * instantiations include:
- *
- * - `Either<ZswapCoinPublicKey, ContractAddress>` for ownPublicKey()-based identity
- * - `Bytes<32>` for commitment-based identity (e.g., hash of ECDSA public key)
- * - `NativePoint` for Schnorr/MuSig aggregated key
- *
- * SignerManager does not resolve caller identity. It receives a validated
- * caller from the contract layer and checks it against the registry.
- * This separation allows the identity mechanism to change without
- * modifying the module.
- *
- * Underscore-prefixed circuits (_addSigner, _removeSigner,
- * _changeThreshold) have no access control enforcement. The consuming
- * contract must gate these behind its own authorization policy.
- */
-module SignerManager<T> {
-  import CompactStandardLibrary;
-
-  // ─── State ──────────────────────────────────────────────────────────────────
-
-  export ledger _signers: Set<T>;
-  export ledger _signerCount: Uint<8>;
-  export ledger _threshold: Uint<8>;
-
-  // ─── Initialization ─────────────────────────────────────────────────────────
-
-  /**
-   * @description Initializes the signer manager with the given threshold
-   * and an initial set of signers.
-   * Must be called in the contract's constructor.
-   *
-   * Requirements:
-   *
-   * - `thresh` must be greater than 0.
-   * - `signers` must not contain duplicates.
-   *
-   * @param {Vector<n, T>} signers - The initial signer set.
-   * @param {Uint<8>} thresh - The minimum number of approvals required.
-   *
-   * @returns {[]} Empty tuple.
-   */
-  export circuit initialize<#n>(
-    signers: Vector<n, T>,
-    thresh: Uint<8>
-  ): [] {
-    assert(thresh > 0, "SignerManager: threshold must be > 0");
-    _threshold = disclose(thresh);
-
-    for (const signer of signers) {
-      _addSigner(signer);
-    }
-
-    assert(_signerCount >= thresh, "SignerManager: threshold exceeds signer count");
-  }
-
-  // ─── Guards ─────────────────────────────────────────────────────────────
-
-  /**
-   * @description Asserts that the given caller is an active signer.
-   *
-   * Requirements:
-   *
-   * - `caller` must be a member of the signers registry.
-   *
-   * @param {T} caller - The identity to validate.
-   *
-   * @returns {[]} Empty tuple.
-   */
-  export circuit assertSigner(caller: T): [] {
-    assert(isSigner(caller), "SignerManager: not a signer");
-  }
-
-  /**
-   * @description Asserts that the given approval count meets the threshold.
-   *
-   * Requirements:
-   *
-   * - `approvalCount` must be >= threshold.
-   *
-   * @param {Uint<8>} approvalCount - The current number of approvals.
-   *
-   * @returns {[]} Empty tuple.
-   */
-  export circuit assertThresholdMet(approvalCount: Uint<8>): [] {
-    assert(approvalCount >= _threshold, "SignerManager: threshold not met");
-  }
-
-  // ─── View ──────────────────────────────────────────────────────────
-
-  /**
-   * @description Returns the current signer count.
-   *
-   * @returns {Uint<8>} The number of active signers.
-   */
-  export circuit getSignerCount(): Uint<8> {
-    return _signerCount;
-  }
-
-  /**
-   * @description Returns the approval threshold.
-   *
-   * @returns {Uint<8>} The threshold.
-   */
-  export circuit getThreshold(): Uint<8> {
-    return _threshold;
-  }
-
-  /**
-   * @description Returns whether the given account is an active signer.
-   *
-   * @param {T} account - The account to check.
-   *
-   * @returns {Boolean} True if the account is an active signer.
-   */
-  export circuit isSigner(account: T): Boolean {
-    return _signers.member(disclose(account));
-  }
-
-  // ─── Signer Management ─────────────────────────────────────────────────────
-
-  /**
-   * @description Adds a new signer to the registry.
-   *
-   * @notice Access control is NOT enforced here.
-   * The consuming contract must gate this behind its own
-   * authorization policy.
-   *
-   * Requirements:
-   *
-   * - `signer` must not already be an active signer.
-   *
-   * @param {T} signer - The signer to add.
-   *
-   * @returns {[]} Empty tuple.
-   */
-  export circuit _addSigner(signer: T): [] {
-    assert(
-      !isSigner(signer),
-      "SignerManager: signer already active"
-    );
-
-    _signers.insert(disclose(signer));
-    _signerCount = _signerCount + 1 as Uint<8>;
-  }
-
-  /**
-   * @description Removes a signer from the registry.
-   *
-   * @notice Access control is NOT enforced here.
-   * The consuming contract must gate this behind its own
-   * authorization policy.
-   *
-   * Requirements:
-   *
-   * - `signer` must be an active signer.
-   * - Removal must not drop signer count below threshold.
-   *
-   * @param {T} signer - The signer to remove.
-   *
-   * @returns {[]} Empty tuple.
-   */
-  export circuit _removeSigner(signer: T): [] {
-    assert(isSigner(signer), "SignerManager: not a signer");
-
-    const newCount = _signerCount - 1 as Uint<8>;
-    assert(newCount >= _threshold, "SignerManager: removal would breach threshold");
-
-    _signers.remove(disclose(signer));
-    _signerCount = newCount;
-  }
-
-  /**
-   * @description Updates the approval threshold.
-   *
-   * @notice Access control is NOT enforced here.
-   * The consuming contract must gate this behind its own
-   * authorization policy.
-   *
-   * Requirements:
-   *
-   * - `newThreshold` must be greater than 0.
-   * - `newThreshold` must not exceed the current signer count.
-   *
-   * @param {Uint<8>} newThreshold - The new minimum number of approvals required.
-   *
-   * @returns {[]} Empty tuple.
-   */
-  export circuit _changeThreshold(newThreshold: Uint<8>): [] {
-    assert(newThreshold > 0, "SignerManager: threshold must be > 0");
-    assert(newThreshold <= _signerCount, "SignerManager: threshold exceeds signer count");
-    _threshold = disclose(newThreshold);
-  }
-}