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

package/token/NativeShieldedTokenCore.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.1 (token/NativeShieldedTokenCore.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.3 (token/NativeShieldedTokenCore.compact)
 
 pragma language_version >= 0.26.0;
 
@@ -44,6 +44,18 @@ pragma language_version >= 0.26.0;
  * compose `NativeShieldedTokenDerivedNonce` and pass its `_deriveNonce()`
  * output, at the cost of making those mints recipient-public.
  *
+ * @notice A recipient may be any coin public key, or this contract's own
+ * address. Any other contract address is rejected.
+ *
+ * @dev Recipient arm
+ * 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
+ * contract-held coins.
+ *
  * @dev Burn variants
  * `_burn` destroys value from a coin provided within the current transaction
  * (e.g. the caller's wallet pays the contract): it receives the coin and spends
@@ -70,8 +82,18 @@ module NativeShieldedTokenCore {
    */
   export ledger _isInitialized: Boolean;
 
+  /**
+   * @description The token's human-readable name, set once at construction.
+   */
   export sealed ledger _name: Opaque<"string">;
+  /**
+   * @description The token's ticker symbol, set once at construction.
+   */
   export sealed ledger _symbol: Opaque<"string">;
+  /**
+   * @description The number of decimals used to display balances, set once at
+   * construction. Purely presentational; no circuit scales by it.
+   */
   export sealed ledger _decimals: Uint<8>;
 
   /**
@@ -130,7 +152,7 @@ module NativeShieldedTokenCore {
    * @dev Does not gate on init (it reports it), so it is safe to call before
    * `initialize`.
    *
-   * @circuitInfo k=6, rows=26
+   * @constraints k=6, rows=24
    *
    * @return {Boolean} - True once `initialize` has run.
    */
@@ -141,7 +163,7 @@ module NativeShieldedTokenCore {
   /**
    * @description Returns the token name.
    *
-   * @circuitInfo k=6, rows=28
+   * @constraints k=6, rows=26
    *
    * Requirements:
    *
@@ -157,7 +179,7 @@ module NativeShieldedTokenCore {
   /**
    * @description Returns the symbol of the token.
    *
-   * @circuitInfo k=6, rows=28
+   * @constraints k=6, rows=26
    *
    * Requirements:
    *
@@ -175,7 +197,7 @@ module NativeShieldedTokenCore {
    * @dev This is a display convention only. The protocol stores and operates
    * on integer values without reference to decimals.
    *
-   * @circuitInfo k=6, rows=28
+   * @constraints k=6, rows=26
    *
    * Requirements:
    *
@@ -192,7 +214,7 @@ module NativeShieldedTokenCore {
    * @description Returns the coin color for `domain` under this contract's
    * address: `tokenType(domain, kernel.self())`, computed at call time.
    *
-   * @circuitInfo k=13, rows=4248
+   * @constraints k=13, rows=4239
    *
    * Requirements:
    *
@@ -212,21 +234,26 @@ 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.
+   * commitment, which the protocol rejects. A `right(kernel.self())` recipient
+   * is claimed via `receiveShielded` in this same call, so the consumer SHOULD
+   * persist the returned coin info: it is the contract's holding and is not
+   * otherwise recoverable.
    *
    * @notice The returned coin info is the only copy available to the
    * recipient; callers SHOULD deliver it out of band. Wallets cannot detect
    * contract-minted coins by scanning the chain.
    *
-   * @circuitInfo k=14, rows=11119
+   * @constraints k=15, rows=16980
    *
    * Requirements:
    *
    * - Contract is initialized.
    * - `recipient` is not zero.
+   * - `recipient`, if a contract address, is this contract's own address.
    *
    * @param {Bytes<32>} domain - 32-byte token discriminator.
-   * @param {Either<ZswapCoinPublicKey, ContractAddress>} recipient - The coin recipient.
+   * @param {Either<ZswapCoinPublicKey, ContractAddress>} recipient - The coin
+   * recipient: any coin public key, or this contract's own address.
    * @param {Uint<64>} amount - Quantity to mint. Capped at `Uint<64>` by the protocol.
    * @param {Bytes<32>} nonce - Caller-supplied nonce. Must be unique per (domain, contract).
    * @return {ShieldedCoinInfo} - The newly created coin's info (nonce, color, value).
@@ -238,9 +265,16 @@ module NativeShieldedTokenCore {
                    nonce: Bytes<32>
                    ): ShieldedCoinInfo {
     assertInitialized();
+    const self = kernel.self();
     assert(!Utils_isKeyOrAddressZero(recipient), "NativeShieldedToken: invalid recipient");
+    assert(recipient.is_left || recipient.right == self, "NativeShieldedToken: recipient contract must be self");
 
-    return mintShieldedToken(disclose(domain), disclose(amount), disclose(nonce), disclose(recipient));
+    const coin = mintShieldedToken(disclose(domain), disclose(amount), disclose(nonce), disclose(recipient));
+    if (disclose(!recipient.is_left)) {
+      receiveShielded(coin);
+    }
+
+    return coin;
   }
 
   /**
@@ -255,13 +289,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.
+   * `_burnFromSelf` instead. A `right(kernel.self())` refund is claimed via
+   * `receiveShielded` 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.
    *
-   * @circuitInfo k=16, rows=47932
+   * @constraints k=16, rows=53639
    *
    * Requirements:
    *
@@ -270,12 +305,14 @@ module NativeShieldedTokenCore {
    * - `amount` is less than or equal to `coin.value`.
    * - `refundTo` is not zero (the zero key is the burn address; a zero
    *   `refundTo` would silently burn the change as well).
+   * - `refundTo`, if a contract address, is this contract's own address.
    *
    * @param {Bytes<32>} domain - 32-byte token discriminator.
    * @param {ShieldedCoinInfo} coin - The coin to burn from.
    * @param {Uint<128>} amount - Value to destroy. Must be <= `coin.value`.
    * @param {Either<ZswapCoinPublicKey, ContractAddress>} refundTo - Where to
-   * route the unspent portion (`coin.value - amount`).
+   * route the unspent portion (`coin.value - amount`): any coin public key, or
+   * this contract's own address.
    * @return {Maybe<ShieldedCoinInfo>} - The refund coin created for `refundTo`,
    * or `none` if the coin was burned in full.
    */
@@ -286,9 +323,11 @@ module NativeShieldedTokenCore {
                    refundTo: Either<ZswapCoinPublicKey, ContractAddress>
                    ): Maybe<ShieldedCoinInfo> {
     assertInitialized();
-    assert(coin.color == tokenType(disclose(domain), kernel.self()), "NativeShieldedToken: wrong token");
+    const self = kernel.self();
+    assert(coin.color == tokenType(disclose(domain), self), "NativeShieldedToken: wrong token");
     assert(coin.value >= amount, "NativeShieldedToken: insufficient coin value");
     assert(!Utils_isKeyOrAddressZero(refundTo), "NativeShieldedToken: invalid refund target");
+    assert(refundTo.is_left || refundTo.right == self, "NativeShieldedToken: refund contract must be self");
 
     receiveShielded(disclose(coin));
     const sendRes = sendImmediateShielded(disclose(coin), shieldedBurnAddress(), disclose(amount));
@@ -299,6 +338,9 @@ 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>();
@@ -313,7 +355,7 @@ module NativeShieldedTokenCore {
    * ledger state: the change replaces `coin` as the contract's holding, and
    * its info is not otherwise recoverable.
    *
-   * @circuitInfo k=15, rows=23583
+   * @constraints k=15, rows=23484
    *
    * Requirements:
    *

package/token/NativeShieldedTokenFamily.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.1 (token/NativeShieldedTokenFamily.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.3 (token/NativeShieldedTokenFamily.compact)
 
 pragma language_version >= 0.26.0;
 
@@ -26,6 +26,10 @@ pragma language_version >= 0.26.0;
  * set of core state (a single init flag and one name/symbol/decimals).
  * Pick one flavor per contract.
  *
+ * @notice Recipients must be coin public keys: contract-addressed recipients
+ * are not supported at this layer. For a coin the contract holds itself, use
+ * `_mintToSelf`, which mints to `kernel.self()` and claims it in the same call.
+ *
  * @notice This module exposes composable building blocks for minting and
  * burning native shielded coins. It does NOT include access control: consuming
  * contracts compose that via the module/contract pattern (Ownable,
@@ -97,7 +101,7 @@ module NativeShieldedTokenFamily {
   /**
    * @description Returns whether the contract has been initialized.
    *
-   * @circuitInfo k=6, rows=26
+   * @constraints k=6, rows=24
    *
    * @return {Boolean} - True once `initialize` has run.
    */
@@ -110,7 +114,7 @@ module NativeShieldedTokenFamily {
    * contract. Per-type identity belongs in the consumer's own state; see the
    * module notes.
    *
-   * @circuitInfo k=6, rows=28
+   * @constraints k=6, rows=26
    *
    * Requirements:
    *
@@ -126,7 +130,7 @@ module NativeShieldedTokenFamily {
    * @description Returns the family symbol shared by all token types of this
    * contract.
    *
-   * @circuitInfo k=6, rows=28
+   * @constraints k=6, rows=26
    *
    * Requirements:
    *
@@ -142,7 +146,7 @@ module NativeShieldedTokenFamily {
    * @description Returns the family-wide number of decimals used to get the
    * user representation.
    *
-   * @circuitInfo k=6, rows=28
+   * @constraints k=6, rows=26
    *
    * Requirements:
    *
@@ -158,7 +162,7 @@ module NativeShieldedTokenFamily {
    * @description Returns the coin color (token type) for `domain` under this
    * contract's address, so integrators do not have to re-derive it by hand.
    *
-   * @circuitInfo k=13, rows=4248
+   * @constraints k=13, rows=4239
    *
    * Requirements:
    *
@@ -186,7 +190,7 @@ module NativeShieldedTokenFamily {
    * recipient; callers SHOULD deliver it out of band. Wallets cannot detect
    * contract-minted coins by scanning the chain.
    *
-   * @circuitInfo k=14, rows=11119
+   * @constraints k=14, rows=10727
    *
    * Requirements:
    *
@@ -195,18 +199,59 @@ module NativeShieldedTokenFamily {
    *
    * @param {Bytes<32>} domain - 32-byte token discriminator. Same domain + same
    * contract address produces the same coin color (i.e. same token type).
-   * @param {Either<ZswapCoinPublicKey, ContractAddress>} recipient - The coin recipient.
+   * @param {ZswapCoinPublicKey} recipient - The coin recipient.
    * @param {Uint<64>} amount - Quantity to mint. Capped at `Uint<64>` by the protocol.
    * @param {Bytes<32>} nonce - Caller-supplied nonce. Must be unique per (domain, contract).
    * @return {ShieldedCoinInfo} - The newly created coin's info (nonce, color, value).
    */
   export circuit _mint(
                    domain: Bytes<32>,
-                   recipient: Either<ZswapCoinPublicKey, ContractAddress>,
+                   recipient: ZswapCoinPublicKey,
+                   amount: Uint<64>,
+                   nonce: Bytes<32>
+                   ): ShieldedCoinInfo {
+    return Core__mint(
+      domain,
+      left<ZswapCoinPublicKey, ContractAddress>(recipient),
+      amount,
+      nonce
+    );
+  }
+
+  /**
+   * @description Mints `amount` of the token identified by `domain` to this
+   * contract itself, claiming the coin in the same call. Forwards to
+   * `NativeShieldedTokenCore._mint` with `right(kernel.self())`.
+   *
+   * @dev Nonce uniqueness is the caller's responsibility, as in `_mint`. Spend
+   * the coin later with `_burnFromSelf`, once it carries an `mt_index`.
+   *
+   * @notice The consumer SHOULD persist the returned coin info in its own
+   * ledger state: it is the contract's holding and is not otherwise
+   * recoverable.
+   *
+   * @constraints k=14, rows=16309
+   *
+   * Requirements:
+   *
+   * - Contract is initialized.
+   *
+   * @param {Bytes<32>} domain - 32-byte token discriminator.
+   * @param {Uint<64>} amount - Quantity to mint. Capped at `Uint<64>` by the protocol.
+   * @param {Bytes<32>} nonce - Caller-supplied nonce. Must be unique per (domain, contract).
+   * @return {ShieldedCoinInfo} - The newly created coin's info (nonce, color, value).
+   */
+  export circuit _mintToSelf(
+                   domain: Bytes<32>,
                    amount: Uint<64>,
                    nonce: Bytes<32>
                    ): ShieldedCoinInfo {
-    return Core__mint(domain, recipient, amount, nonce);
+    return Core__mint(
+      domain,
+      right<ZswapCoinPublicKey, ContractAddress>(kernel.self()),
+      amount,
+      nonce
+    );
   }
 
   /**
@@ -227,7 +272,7 @@ module NativeShieldedTokenFamily {
    * `refundTo`; callers SHOULD deliver it out of band. Wallets cannot detect
    * contract-sent coins by scanning the chain.
    *
-   * @circuitInfo k=16, rows=47932
+   * @constraints k=16, rows=41603
    *
    * Requirements:
    *
@@ -240,8 +285,8 @@ module NativeShieldedTokenFamily {
    * @param {Bytes<32>} domain - 32-byte token discriminator.
    * @param {ShieldedCoinInfo} coin - The coin to burn from.
    * @param {Uint<128>} amount - Value to destroy. Must be <= `coin.value`.
-   * @param {Either<ZswapCoinPublicKey, ContractAddress>} refundTo - Where to
-   * route the unspent portion (`coin.value - amount`).
+   * @param {ZswapCoinPublicKey} refundTo - Where to route the unspent
+   * portion (`coin.value - amount`).
    * @return {Maybe<ShieldedCoinInfo>} - The refund coin created for `refundTo`,
    * or `none` if the coin was burned in full.
    */
@@ -249,9 +294,14 @@ module NativeShieldedTokenFamily {
                    domain: Bytes<32>,
                    coin: ShieldedCoinInfo,
                    amount: Uint<128>,
-                   refundTo: Either<ZswapCoinPublicKey, ContractAddress>
+                   refundTo: ZswapCoinPublicKey
                    ): Maybe<ShieldedCoinInfo> {
-    return Core__burn(domain, coin, amount, refundTo);
+    return Core__burn(
+      domain,
+      coin,
+      amount,
+      left<ZswapCoinPublicKey, ContractAddress>(refundTo)
+    );
   }
 
   /**
@@ -263,7 +313,7 @@ module NativeShieldedTokenFamily {
    * ledger state: the change replaces `coin` as the contract's holding, and
    * its info is not otherwise recoverable.
    *
-   * @circuitInfo k=15, rows=23583
+   * @constraints k=15, rows=23484
    *
    * Requirements:
    *