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

package/token/FungibleToken.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.1 (token/FungibleToken.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.3 (token/FungibleToken.compact)
 
 pragma language_version >= 0.26.0;
 
@@ -93,10 +93,24 @@ module FungibleToken {
   export ledger _allowances: Map<Either<Bytes<32>, ContractAddress>,
                                  Map<Either<Bytes<32>, ContractAddress>, Uint<128>>>;
 
+  /**
+   * @description Total tokens in circulation. `_update` raises it on a mint and
+   * lowers it on a burn, rejecting an increase that would overflow `Uint<128>`.
+   */
   export ledger _totalSupply: Uint<128>;
 
+  /**
+   * @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>;
 
 
@@ -116,7 +130,7 @@ module FungibleToken {
    * @dev This MUST be called in the implementing contract's constructor. Failure to do so
    * can lead to an irreparable contract.
    *
-   * @circuitInfo k=10, rows=71
+   * @constraints k=10, rows=71
    *
    * @param {Opaque<"string">} name_ - The name of the token.
    * @param {Opaque<"string">} symbol_ - The symbol of the token.
@@ -164,7 +178,7 @@ module FungibleToken {
   /**
    * @description Returns the token name.
    *
-   * @circuitInfo k=6, rows=28
+   * @constraints k=6, rows=26
    *
    * Requirements:
    *
@@ -180,7 +194,7 @@ module FungibleToken {
   /**
    * @description Returns the symbol of the token.
    *
-   * @circuitInfo k=6, rows=28
+   * @constraints k=6, rows=26
    *
    * Requirements:
    *
@@ -196,7 +210,7 @@ module FungibleToken {
   /**
    * @description Returns the number of decimals used to get its user representation.
    *
-   * @circuitInfo k=6, rows=28
+   * @constraints k=6, rows=26
    *
    * Requirements:
    *
@@ -212,7 +226,7 @@ module FungibleToken {
   /**
    * @description Returns the value of tokens in existence.
    *
-   * @circuitInfo k=6, rows=28
+   * @constraints k=6, rows=26
    *
    * Requirements:
    *
@@ -228,7 +242,7 @@ module FungibleToken {
   /**
    * @description Returns the value of tokens owned by `account`.
    *
-   * @circuitInfo k=10, rows=673
+   * @constraints k=10, rows=668
    *
    * @dev Manually checks if `account` is a key in the map and returns 0 if it is not.
    *
@@ -253,7 +267,7 @@ module FungibleToken {
   /**
    * @description Moves a `value` amount of tokens from the caller's account to `to`.
    *
-   * @circuitInfo k=13, rows=3985
+   * @constraints k=13, rows=3743
    *
    * @notice Transfers to contract addresses are currently disallowed until contract-to-contract
    * interactions are supported in Compact. This restriction prevents assets from
@@ -284,7 +298,7 @@ module FungibleToken {
   /**
    * @description Unsafe variant of `transfer` which allows transfers to contract addresses.
    *
-   * @circuitInfo k=13, rows=3982
+   * @constraints k=13, rows=3740
    *
    * @warning Transfers to contract addresses are considered unsafe because contract-to-contract
    * calls are not currently supported. Tokens sent to a contract address may become irretrievable.
@@ -314,7 +328,7 @@ module FungibleToken {
    * @description Returns the remaining number of tokens that `spender` will be allowed to spend on behalf of `owner`
    * through `transferFrom`. This value changes when `approve` or `transferFrom` are called.
    *
-   * @circuitInfo k=11, rows=1346
+   * @constraints k=11, rows=1350
    *
    * @dev Manually checks if `owner` and `spender` are keys in the map and returns 0 if they are not.
    *
@@ -344,7 +358,7 @@ module FungibleToken {
   /**
    * @description Sets a `value` amount of tokens as allowance of `spender` over the caller's tokens.
    *
-   * @circuitInfo k=13, rows=3072
+   * @constraints k=13, rows=3066
    *
    * Requirements:
    *
@@ -369,7 +383,7 @@ module FungibleToken {
    * @description Moves `value` tokens from `fromAddress` to `to` using the allowance mechanism.
    * `value` is the deducted from the caller's allowance.
    *
-   * @circuitInfo k=13, rows=4960
+   * @constraints k=13, rows=4906
    *
    * @notice Transfers to contract addresses are currently disallowed until contract-to-contract
    * interactions are supported in Compact. This restriction prevents assets from
@@ -403,7 +417,7 @@ module FungibleToken {
   /**
    * @description Unsafe variant of `transferFrom` which allows transfers to contract addresses.
    *
-   * @circuitInfo k=13, rows=4957
+   * @constraints k=13, rows=4903
    *
    * @warning Transfers to contract addresses are considered unsafe because contract-to-contract
    * calls are not currently supported. Tokens sent to a contract address may become irretrievable.
@@ -440,7 +454,7 @@ module FungibleToken {
    * This circuit is equivalent to {transfer}, and can be used to
    * e.g. implement automatic token fees, slashing mechanisms, etc.
    *
-   * @circuitInfo k=12, rows=2345
+   * @constraints k=12, rows=2125
    *
    * @notice Transfers to contract addresses are currently disallowed until contract-to-contract
    * interactions are supported in Compact. This restriction prevents assets from
@@ -473,7 +487,7 @@ module FungibleToken {
   /**
    * @description Unsafe variant of `transferFrom` which allows transfers to contract addresses.
    *
-   * @circuitInfo k=12, rows=2342
+   * @constraints k=12, rows=2122
    *
    * @warning Transfers to contract addresses are considered unsafe because contract-to-contract
    * calls are not currently supported. Tokens sent to a contract address may become irretrievable.
@@ -507,7 +521,7 @@ module FungibleToken {
    * (or `to`) is the zero address.
    * @dev Checks for a mint overflow in order to output a more readable error message.
    *
-   * @circuitInfo k=11, rows=1305
+   * @constraints k=11, rows=1305
    *
    * Requirements:
    *
@@ -551,7 +565,7 @@ module FungibleToken {
    * @description Creates a `value` amount of tokens and assigns them to `account`,
    * by transferring it from the zero address. Relies on the `update` mechanism.
    *
-   * @circuitInfo k=11, rows=1437
+   * @constraints k=11, rows=1328
    *
    * @notice Transfers to contract addresses are currently disallowed until contract-to-contract
    * interactions are supported in Compact. This restriction prevents assets from
@@ -577,7 +591,7 @@ module FungibleToken {
   /**
    * @description Unsafe variant of `_mint` which allows transfers to contract addresses.
    *
-   * @circuitInfo k=11, rows=1434
+   * @constraints k=11, rows=1325
    *
    * @warning Transfers to contract addresses are considered unsafe because contract-to-contract
    * calls are not currently supported. Tokens sent to a contract address may become irretrievable.
@@ -605,7 +619,7 @@ module FungibleToken {
    * @description Destroys a `value` amount of tokens from `account`, lowering the total supply.
    * Relies on the `_update` mechanism.
    *
-   * @circuitInfo k=11, rows=1377
+   * @constraints k=11, rows=1268
    *
    * Requirements:
    *
@@ -628,7 +642,7 @@ module FungibleToken {
    * This circuit is equivalent to `approve`, and can be used to
    * e.g. set automatic allowances for certain subsystems, etc.
    *
-   * @circuitInfo k=11, rows=1406
+   * @constraints k=11, rows=1407
    *
    * Requirements:
    *
@@ -667,7 +681,7 @@ module FungibleToken {
    * @description Updates `owner`'s allowance for `spender` based on spent `value`.
    * Does not update the allowance value in case of infinite allowance.
    *
-   * @circuitInfo k=11, rows=1729
+   * @constraints k=11, rows=1935
    *
    * Requirements:
    *

package/token/MultiToken.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.1 (token/MultiToken.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.3 (token/MultiToken.compact)
 
 pragma language_version >= 0.26.0;
 
@@ -176,7 +176,7 @@ module MultiToken {
   /**
    * @description Initializes the contract by setting the base URI for all tokens.
    *
-   * @circuitInfo k=6, rows=33
+   * @constraints k=6, rows=31
    *
    * Requirements:
    *
@@ -224,7 +224,7 @@ module MultiToken {
    * Clients calling this function must replace the `\{id\}` substring with the
    * actual token type ID.
    *
-   * @circuitInfo k=8, rows=176
+   * @constraints k=8, rows=176
    *
    * Requirements:
    *
@@ -241,7 +241,7 @@ module MultiToken {
   /**
    * @description Returns the amount of `id` tokens owned by `account`.
    *
-   * @circuitInfo k=10, rows=875
+   * @constraints k=10, rows=867
    *
    * Requirements:
    *
@@ -270,7 +270,7 @@ module MultiToken {
    * In the case of an external (non-contract) caller, the caller's identity is derived from the `wit_MultiTokenSK`
    * witness as `persistentHash(secretKey)`.
    *
-   * @circuitInfo k=13, rows=2944
+   * @constraints k=13, rows=2938
    *
    * Requirements:
    *
@@ -295,7 +295,7 @@ module MultiToken {
   /**
    * @description Queries if `operator` is an authorized operator for `account`.
    *
-   * @circuitInfo k=11, rows=1343
+   * @constraints k=11, rows=1347
    *
    * Requirements:
    *
@@ -332,7 +332,7 @@ module MultiToken {
    * interactions are supported in Compact. This restriction prevents assets from
    * being inadvertently locked in contracts that cannot currently handle token receipt.
    *
-   * @circuitInfo k=13, rows=4926
+   * @constraints k=13, rows=4833
    *
    * Requirements:
    *
@@ -369,7 +369,7 @@ module MultiToken {
    * interactions are supported in Compact. This restriction prevents assets from
    * being inadvertently locked in contracts that cannot currently handle token receipt.
    *
-   * @circuitInfo k=12, rows=2450
+   * @constraints k=12, rows=2381
    *
    * Requirements:
    *
@@ -462,7 +462,7 @@ module MultiToken {
    * calls are not currently supported. Tokens sent to a contract address may become irretrievable.
    * Once contract-to-contract calls are supported, this circuit may be deprecated.
    *
-   * @circuitInfo k=13, rows=4925
+   * @constraints k=13, rows=4832
    *
    * Requirements:
    *
@@ -504,7 +504,7 @@ module MultiToken {
    * calls are not currently supported. Tokens sent to a contract address may become irretrievable.
    * Once contract-to-contract calls are supported, this circuit may be deprecated.
    *
-   * @circuitInfo k=12, rows=2449
+   * @constraints k=12, rows=2380
    *
    * Requirements:
    *
@@ -546,7 +546,7 @@ module MultiToken {
    * `https://token-cdn-domain/000000000000000000000000000000000000000000000000000000000004cce0.json`
    * for token type ID 0x4cce0.
    *
-   * @circuitInfo k=6, rows=28
+   * @constraints k=6, rows=26
    *
    * Requirements:
    *
@@ -567,7 +567,7 @@ module MultiToken {
    * interactions are supported in Compact. This restriction prevents assets from
    * being inadvertently locked in contracts that cannot currently handle token receipt.
    *
-   * @circuitInfo k=11, rows=1531
+   * @constraints k=11, rows=1449
    *
    * Requirements:
    *
@@ -596,7 +596,7 @@ module MultiToken {
    * calls are not currently supported. Tokens sent to a contract address may become irretrievable.
    * Once contract-to-contract calls are supported, this circuit may be deprecated.
    *
-   * @circuitInfo k=11, rows=1530
+   * @constraints k=11, rows=1448
    *
    * Requirements:
    *
@@ -621,7 +621,7 @@ module MultiToken {
   /**
    * @description Destroys a `value` amount of tokens of type `id` from `fromAddress`.
    *
-   * @circuitInfo k=11, rows=1222
+   * @constraints k=11, rows=1275
    *
    * Requirements:
    *
@@ -649,7 +649,7 @@ module MultiToken {
    * @notice This circuit does not check for access permissions but can be useful as a building block
    * for more complex contract logic.
    *
-   * @circuitInfo k=11, rows=1279
+   * @constraints k=11, rows=1280
    *
    * Requirements:
    *

package/token/NativeShieldedToken.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.1 (token/NativeShieldedToken.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.3 (token/NativeShieldedToken.compact)
 
 pragma language_version >= 0.26.0;
 
@@ -20,6 +20,10 @@ pragma language_version >= 0.26.0;
  * share one 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,
@@ -106,7 +110,7 @@ module NativeShieldedToken {
   /**
    * @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.
    */
@@ -117,7 +121,7 @@ module NativeShieldedToken {
   /**
    * @description Returns the token name.
    *
-   * @circuitInfo k=6, rows=28
+   * @constraints k=6, rows=26
    *
    * Requirements:
    *
@@ -132,7 +136,7 @@ module NativeShieldedToken {
   /**
    * @description Returns the symbol of the token.
    *
-   * @circuitInfo k=6, rows=28
+   * @constraints k=6, rows=26
    *
    * Requirements:
    *
@@ -147,7 +151,7 @@ module NativeShieldedToken {
   /**
    * @description Returns the number of decimals used to get its user representation.
    *
-   * @circuitInfo k=6, rows=28
+   * @constraints k=6, rows=26
    *
    * Requirements:
    *
@@ -163,7 +167,7 @@ module NativeShieldedToken {
    * @description Returns this token's coin color:
    * `tokenType(_domain, kernel.self())`, computed at call time.
    *
-   * @circuitInfo k=13, rows=3971
+   * @constraints k=13, rows=3962
    *
    * Requirements:
    *
@@ -190,25 +194,65 @@ module NativeShieldedToken {
    * recipient; callers SHOULD deliver it out of band. Wallets cannot detect
    * contract-minted coins by scanning the chain.
    *
-   * @circuitInfo k=14, rows=10843
+   * @constraints k=14, rows=10450
    *
    * Requirements:
    *
    * - Contract is initialized.
    * - `recipient` is not zero.
    *
-   * @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 for this
    * contract's color.
    * @return {ShieldedCoinInfo} - The newly created coin's info (nonce, color, value).
    */
   export circuit _mint(
-                   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` 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=16033
+   *
+   * Requirements:
+   *
+   * - Contract is initialized.
+   *
+   * @param {Uint<64>} amount - Quantity to mint. Capped at `Uint<64>` by the protocol.
+   * @param {Bytes<32>} nonce - Caller-supplied nonce. Must be unique for this
+   * contract's color.
+   * @return {ShieldedCoinInfo} - The newly created coin's info (nonce, color, value).
+   */
+  export circuit _mintToSelf(
                    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
+    );
   }
 
   /**
@@ -229,7 +273,7 @@ module NativeShieldedToken {
    * `refundTo`; callers SHOULD deliver it out of band. Wallets cannot detect
    * contract-sent coins by scanning the chain.
    *
-   * @circuitInfo k=16, rows=47656
+   * @constraints k=16, rows=41327
    *
    * Requirements:
    *
@@ -241,17 +285,22 @@ module NativeShieldedToken {
    *
    * @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.
    */
   export circuit _burn(
                    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 +312,7 @@ module NativeShieldedToken {
    * ledger state: the change replaces `coin` as the contract's holding, and
    * its info is not otherwise recoverable.
    *
-   * @circuitInfo k=15, rows=23307
+   * @constraints k=15, rows=23208
    *
    * Requirements:
    *