@openzeppelin/compact-contracts 0.4.0-alpha.3 → 0.4.0-alpha.5

package/multisig/presets/ShieldedMultiSigV2.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.3 (multisig/presets/ShieldedMultiSigV2.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.5 (multisig/presets/ShieldedMultiSigV2.compact)
 
 pragma language_version >= 0.26.0;
 
@@ -82,11 +82,11 @@ module ShieldedMultiSigV2 {
    *
    * - `instanceSalt` should be cryptographically random.
    * - `signerCommitments` must not contain duplicates.
-   * - `thresh` must be non-zero and must not exceed 2.
+   * - `thresh` must be 2, the number of signatures `execute` verifies.
    *
    * @param {Bytes<32>} instanceSalt - Per-deployment salt for commitment derivation.
    * @param {Vector<3, Bytes<32>>} signerCommitments - Hashed signer identities.
-   * @param {Uint<8>} thresh - Minimum approvals required.
+   * @param {Uint<8>} thresh - Approvals required. Must be 2.
    * @returns {[]} Empty tuple.
    */
   export circuit initialize(
@@ -165,7 +165,10 @@ module ShieldedMultiSigV2 {
    * commitment from their public key and the instance salt, rejects duplicates,
    * and enforces the threshold.
    *
-   * @constraints k=17, rows=104644 (zkir-v3)
+   * @notice `to` must be a `ShieldedUser`. A contract-addressed coin would be
+   * unclaimable, making the transaction malformed.
+   *
+   * @constraints k=17, rows=98977 (zkir-v3)
    *
    * Requirements:
    *
@@ -173,6 +176,7 @@ module ShieldedMultiSigV2 {
    * - Both signatures must be valid over the message hash and use the low-s
    *   encoding.
    * - Signers must not be duplicates.
+   * - `to.kind` must be `ShieldedUser`.
    * - Coin value must be >= amount.
    *
    * @param {Proposal_Recipient} to - The recipient.
@@ -210,9 +214,14 @@ module ShieldedMultiSigV2 {
 
     EcdsaSignerManager_assertApprovals(msgHash, pubkeys, signatures);
 
-    // Execute transfer
-    const normalizedRecipient = Proposal_toShieldedRecipient(to);
-    return Treasury__send(coin, normalizedRecipient, amount);
+    assert(
+      to.kind == Proposal_RecipientKind.ShieldedUser,
+      "Multisig: recipient must be a coin public key"
+    );
+    const recipient = left<ZswapCoinPublicKey, ContractAddress>(
+      ZswapCoinPublicKey { bytes: to.address }
+    );
+    return Treasury__send(coin, recipient, amount);
   }
 
   // ─── Commitments ────────────────────────────────────────────────

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/compact-contracts",
-  "version": "0.4.0-alpha.3",
+  "version": "0.4.0-alpha.5",
   "description": "OpenZeppelin Compact contract library",
   "keywords": [
     "openzeppelin",
@@ -63,13 +63,15 @@
     "@midnightntwrk/ledger-v9": "1.0.0-rc.5",
     "@midnightntwrk/wallet-sdk-address-format": "4.0.0-beta.2",
     "@noble/curves": "^2.2.0",
-    "@noble/hashes": "^2.2.0",
-    "@openzeppelin/compact-simulator": "^0.4.0",
+    "@noble/hashes": "^2.4.0",
+    "@openzeppelin/compact-deployer": "^0.3.1",
+    "@openzeppelin/compact-simulator": "^0.4.1",
     "@tsconfig/node24": "^24.0.5",
-    "@types/node": "26.5.1",
+    "@types/node": "26.6.2",
     "@vitest/coverage-v8": "^5.0.0",
     "ethers": "^6.17.0",
     "fast-check": "^4.10.1",
+    "pino": "^9.7.0",
     "ts-node": "^10.9.2",
     "typescript": "^6.0.3",
     "vite": "^8.3.0",

package/security/Allowlist.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.3 (security/Allowlist.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.5 (security/Allowlist.compact)
 
 pragma language_version >= 0.26.0;
 

package/security/Blocklist.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.3 (security/Blocklist.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.5 (security/Blocklist.compact)
 
 pragma language_version >= 0.26.0;
 

package/security/Initializable.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.3 (security/Initializable.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.5 (security/Initializable.compact)
 
 pragma language_version >= 0.26.0;
 

package/security/Pausable.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.3 (security/Pausable.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.5 (security/Pausable.compact)
 
 pragma language_version >= 0.26.0;
 

package/token/ConfidentialFungibleToken.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.3 (token/ConfidentialFungibleToken.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.5 (token/ConfidentialFungibleToken.compact)
 
 pragma language_version >= 0.26.0;
 
@@ -242,6 +242,22 @@ pragma language_version >= 0.26.0;
  * Raising the limit itself is a node-side change, tracked upstream:
  * https://github.com/midnightntwrk/midnight-node/issues/1202.
  *
+ * Upgrades. Add operations, never change how existing state is derived or laid
+ * out. A CMA upgrade swaps verifier keys on an instance whose ledger already
+ * holds data so whatever that data was written under has to stay fixed e.g. slot
+ * indices, nonce and key derivation, stored encodings. Slot changes at least
+ * show up in a diff. Key derivation is the quiet one. `_encryptionKeys` holds
+ * the key `derivePk` returned at `register` time, `register` refuses a second
+ * key for an account id, and the id does not move (untagged by design, see
+ * `Utils.computeAccountId`), so a circuit deriving a different key leaves
+ * `assertDecryptsTo` and `_assertOwnsEncryptionKey` rejecting the stored one
+ * with no way to re-register. This means balances, pending balances, escrow and
+ * memos are all permanently unreachable. An instance's derivation is fixed when
+ * it is deployed, so off-chain code mirroring `derivePk` must use that one for
+ * the life of the instance. Adopting a newer derivation cannot recover an
+ * instance whose keys were stored under the old one. A changed derivation
+ * applies to fresh deployments only.
+ *
  * Residual griefing. The dual-balance split (see `sweep`) stops dust
  * credits from churning a victim's spendable ciphertext, but every `_credit`
  * still appends a memo, and only the recipient can `clearMemos`. An attacker

package/token/FungibleToken.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.3 (token/FungibleToken.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.5 (token/FungibleToken.compact)
 
 pragma language_version >= 0.26.0;
 

package/token/MultiToken.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.3 (token/MultiToken.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.5 (token/MultiToken.compact)
 
 pragma language_version >= 0.26.0;
 

package/token/NativeShieldedToken.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.3 (token/NativeShieldedToken.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.5 (token/NativeShieldedToken.compact)
 
 pragma language_version >= 0.26.0;
 
@@ -232,7 +232,7 @@ module NativeShieldedToken {
    * ledger state: it is the contract's holding and is not otherwise
    * recoverable.
    *
-   * @constraints k=14, rows=16033
+   * @constraints k=14, rows=10221
    *
    * Requirements:
    *

package/token/NativeShieldedTokenCore.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.3 (token/NativeShieldedTokenCore.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.5 (token/NativeShieldedTokenCore.compact)
 
 pragma language_version >= 0.26.0;
 
@@ -51,9 +51,10 @@ pragma language_version >= 0.26.0;
  * The ledger accepts a contract-addressed commitment only if the recipient
  * contract's own call claims it as a shielded receive in the same transaction,
  * and no primitive claims a receive on another contract's behalf. So the
- * address arm is accepted only for `kernel.self()`, where `_mint` / `_burn`
- * claim the coin themselves in the same call. The flavors do not expose the
- * arm at all: they take a `ZswapCoinPublicKey` and offer `_mintToSelf` for
+ * address arm is accepted only for `kernel.self()`, which `mintShieldedToken`
+ * and `sendShielded` claim as a receive themselves. A `receiveShielded` on top
+ * emits a duplicate output for the same commitment. The flavors do not expose
+ * the arm at all: they take a `ZswapCoinPublicKey` and offer `_mintToSelf` for
  * contract-held coins.
  *
  * @dev Burn variants
@@ -235,7 +236,7 @@ module NativeShieldedTokenCore {
    * @dev The caller is fully responsible for nonce uniqueness. Reusing a
    * nonce for the same (domain, value, recipient) produces a duplicate
    * commitment, which the protocol rejects. A `right(kernel.self())` recipient
-   * is claimed via `receiveShielded` in this same call, so the consumer SHOULD
+   * is claimed by `mintShieldedToken` in this same call, so the consumer SHOULD
    * persist the returned coin info: it is the contract's holding and is not
    * otherwise recoverable.
    *
@@ -243,7 +244,7 @@ module NativeShieldedTokenCore {
    * recipient; callers SHOULD deliver it out of band. Wallets cannot detect
    * contract-minted coins by scanning the chain.
    *
-   * @constraints k=15, rows=16980
+   * @constraints k=14, rows=11109
    *
    * Requirements:
    *
@@ -269,12 +270,7 @@ module NativeShieldedTokenCore {
     assert(!Utils_isKeyOrAddressZero(recipient), "NativeShieldedToken: invalid recipient");
     assert(recipient.is_left || recipient.right == self, "NativeShieldedToken: recipient contract must be self");
 
-    const coin = mintShieldedToken(disclose(domain), disclose(amount), disclose(nonce), disclose(recipient));
-    if (disclose(!recipient.is_left)) {
-      receiveShielded(coin);
-    }
-
-    return coin;
+    return mintShieldedToken(disclose(domain), disclose(amount), disclose(nonce), disclose(recipient));
   }
 
   /**
@@ -289,14 +285,14 @@ module NativeShieldedTokenCore {
    * @dev The coin is received by the contract and spent in the same
    * transaction, so the spend goes through `sendImmediateShielded` (the
    * transient path). For coins the contract already holds, use
-   * `_burnFromSelf` instead. A `right(kernel.self())` refund is claimed via
-   * `receiveShielded` in this same call.
+   * `_burnFromSelf` instead. A `right(kernel.self())` refund is claimed by
+   * `sendImmediateShielded` in this same call.
    *
    * @notice The returned refund coin info is the only copy available to
    * `refundTo`; callers SHOULD deliver it out of band. Wallets cannot detect
    * contract-sent coins by scanning the chain.
    *
-   * @constraints k=16, rows=53639
+   * @constraints k=16, rows=47764
    *
    * Requirements:
    *
@@ -338,9 +334,6 @@ module NativeShieldedTokenCore {
         disclose(refundTo),
         disclose(sendRes.change.value.value)
       );
-      if (disclose(!refundTo.is_left)) {
-        receiveShielded(refundRes.sent);
-      }
       return some<ShieldedCoinInfo>(refundRes.sent);
     }
     return none<ShieldedCoinInfo>();

package/token/NativeShieldedTokenFamily.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.3 (token/NativeShieldedTokenFamily.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.5 (token/NativeShieldedTokenFamily.compact)
 
 pragma language_version >= 0.26.0;
 
@@ -230,7 +230,7 @@ module NativeShieldedTokenFamily {
    * ledger state: it is the contract's holding and is not otherwise
    * recoverable.
    *
-   * @constraints k=14, rows=16309
+   * @constraints k=14, rows=10497
    *
    * Requirements:
    *

package/token/NonFungibleToken.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.3 (token/NonFungibleToken.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.5 (token/NonFungibleToken.compact)
 
 pragma language_version >= 0.26.0;
 

package/token/extensions/ConfidentialFungibleTokenPublicSupply.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.3 (token/extensions/ConfidentialFungibleTokenPublicSupply.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.5 (token/extensions/ConfidentialFungibleTokenPublicSupply.compact)
 
 pragma language_version >= 0.26.0;
 

package/token/extensions/NativeShieldedTokenDerivedNonce.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.3 (token/extensions/NativeShieldedTokenDerivedNonce.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.5 (token/extensions/NativeShieldedTokenDerivedNonce.compact)
 
 pragma language_version >= 0.26.0;
 

package/utils/EvmAbi.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.3 (utils/EvmAbi.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.5 (utils/EvmAbi.compact)
 
 pragma language_version >= 0.26.0;
 

package/utils/Utils.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.3 (utils/Utils.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.5 (utils/Utils.compact)
 
 pragma language_version >= 0.26.0;