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

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.2 (token/NativeShieldedTokenCore.compact)
 
 pragma language_version >= 0.26.0;
 
@@ -70,8 +70,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 +140,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 +151,7 @@ module NativeShieldedTokenCore {
   /**
    * @description Returns the token name.
    *
-   * @circuitInfo k=6, rows=28
+   * @constraints k=6, rows=26
    *
    * Requirements:
    *
@@ -157,7 +167,7 @@ module NativeShieldedTokenCore {
   /**
    * @description Returns the symbol of the token.
    *
-   * @circuitInfo k=6, rows=28
+   * @constraints k=6, rows=26
    *
    * Requirements:
    *
@@ -175,7 +185,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 +202,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:
    *
@@ -218,7 +228,7 @@ module NativeShieldedTokenCore {
    * 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=11096
    *
    * Requirements:
    *
@@ -261,7 +271,7 @@ module NativeShieldedTokenCore {
    * `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=47753
    *
    * Requirements:
    *
@@ -313,7 +323,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.2 (token/NativeShieldedTokenFamily.compact)
 
 pragma language_version >= 0.26.0;
 
@@ -97,7 +97,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 +110,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 +126,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 +142,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 +158,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 +186,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=11096
    *
    * Requirements:
    *
@@ -227,7 +227,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=47753
    *
    * Requirements:
    *
@@ -263,7 +263,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:
    *

package/token/NonFungibleToken.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.1 (token/NonFungibleToken.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.2 (token/NonFungibleToken.compact)
 
 pragma language_version >= 0.26.0;
 
@@ -85,8 +85,13 @@ module NonFungibleToken {
   import CompactStandardLibrary;
   import "../utils/Utils" prefix Utils_;
 
-  /// Public state
+  /**
+   * @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">;
 
   /**
@@ -160,7 +165,7 @@ module NonFungibleToken {
    * This MUST be called in the implementing contract's constructor.
    * Failure to do so can lead to an irreparable contract.
    *
-   * @circuitInfo k=6, rows=52
+   * @constraints k=6, rows=52
    *
    * Requirements:
    *
@@ -206,7 +211,7 @@ module NonFungibleToken {
   /**
    * @description Returns the number of tokens in `owner`'s account.
    *
-   * @circuitInfo k=10, rows=673
+   * @constraints k=10, rows=671
    *
    * Requirements:
    *
@@ -229,7 +234,7 @@ module NonFungibleToken {
   /**
    * @description Returns the owner of the `tokenId` token.
    *
-   * @circuitInfo k=9, rows=333
+   * @constraints k=9, rows=331
    *
    * Requirements:
    *
@@ -247,7 +252,7 @@ module NonFungibleToken {
   /**
    * @description Returns the token name.
    *
-   * @circuitInfo k=6, rows=28
+   * @constraints k=6, rows=26
    *
    * Requirements:
    *
@@ -263,7 +268,7 @@ module NonFungibleToken {
   /**
    * @description Returns the symbol of the token.
    *
-   * @circuitInfo k=6, rows=28
+   * @constraints k=6, rows=26
    *
    * Requirements:
    *
@@ -280,7 +285,7 @@ module NonFungibleToken {
    * @description Returns the token URI for the given `tokenId`. Returns the empty
    * string if a tokenURI does not exist.
    *
-   * @circuitInfo k=9, rows=326
+   * @constraints k=9, rows=324
    *
    * Requirements:
    *
@@ -309,7 +314,7 @@ module NonFungibleToken {
   /**
    * @description Sets the URI as `tokenURI` for the given `tokenId`.
    *
-   * @circuitInfo k=9, rows=289
+   * @constraints k=9, rows=287
    *
    * Requirements:
    *
@@ -338,7 +343,7 @@ module NonFungibleToken {
    * In the case of an external (non-contract) caller, the caller's identity is derived from the `wit_NonFungibleTokenSK`
    * witness as `persistentHash(secretKey)`.
    *
-   * @circuitInfo k=13, rows=3468
+   * @constraints k=13, rows=3491
    *
    * Requirements:
    *
@@ -359,7 +364,7 @@ module NonFungibleToken {
   /**
    * @description Returns the account approved for `tokenId` token.
    *
-   * @circuitInfo k=9, rows=422
+   * @constraints k=9, rows=420
    *
    * Requirements:
    *
@@ -383,7 +388,7 @@ module NonFungibleToken {
    * In the case of an external (non-contract) caller, the caller's identity is derived from the `wit_NonFungibleTokenSK`
    * witness as `persistentHash(secretKey)`.
    *
-   * @circuitInfo k=13, rows=2936
+   * @constraints k=13, rows=2938
    *
    * Requirements:
    *
@@ -406,7 +411,7 @@ module NonFungibleToken {
   /**
    * @description Returns if the `operator` is allowed to manage all of the assets of `owner`.
    *
-   * @circuitInfo k=11, rows=1343
+   * @constraints k=11, rows=1341
    *
    * Requirements:
    *
@@ -439,7 +444,7 @@ module NonFungibleToken {
    * In the case of an external (non-contract) caller, the caller's identity is derived from the `wit_NonFungibleTokenSK`
    * witness as `persistentHash(secretKey)`.
    *
-   * @circuitInfo k=13, rows=4800
+   * @constraints k=13, rows=4701
    *
    * Requirements:
    *
@@ -477,7 +482,7 @@ module NonFungibleToken {
    * 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=4797
+   * @constraints k=13, rows=4698
    *
    * Requirements:
    *
@@ -511,7 +516,7 @@ module NonFungibleToken {
   /**
    * @description Returns the owner of the `tokenId`. Does NOT revert if token doesn't exist.
    *
-   * @circuitInfo k=9, rows=308
+   * @constraints k=9, rows=306
    *
    * Requirements:
    *
@@ -532,7 +537,7 @@ module NonFungibleToken {
   /**
    * @description Returns the approved address for `tokenId`. Returns the zero value if `tokenId` is not minted.
    *
-   * @circuitInfo k=9, rows=308
+   * @constraints k=9, rows=306
    *
    * Requirements:
    *
@@ -553,7 +558,7 @@ module NonFungibleToken {
    * @description Returns whether `spender` is allowed to manage `owner`'s tokens, or `tokenId` in
    * particular (ignoring whether it is owned by `owner`).
    *
-   * @circuitInfo k=11, rows=1798
+   * @constraints k=11, rows=1796
    *
    * Requirements:
    *
@@ -585,7 +590,7 @@ module NonFungibleToken {
   /**
    * @description Checks if `spender` can operate on `tokenId`, assuming the provided `owner` is the actual owner.
    *
-   * @circuitInfo k=11, rows=1804
+   * @constraints k=11, rows=1802
    *
    * Requirements:
    *
@@ -666,7 +671,7 @@ module NonFungibleToken {
   /**
    * @description Mints `tokenId` and transfers it to `to`.
    *
-   * @circuitInfo k=11, rows=1473
+   * @constraints k=11, rows=1388
    *
    * Requirements:
    *
@@ -690,7 +695,7 @@ module NonFungibleToken {
   /**
    * @description Mints `tokenId` and transfers it to `to`. It does NOT check if the recipient is a ContractAddress.
    *
-   * @circuitInfo k=11, rows=1470
+   * @constraints k=11, rows=1385
    *
    * Requirements:
    *
@@ -723,7 +728,7 @@ module NonFungibleToken {
    * The approval is cleared when the token is burned.
    * This circuit does not check if the sender is authorized to operate on the token.
    *
-   * @circuitInfo k=10, rows=509
+   * @constraints k=10, rows=507
    *
    * Requirements:
    *
@@ -748,7 +753,7 @@ module NonFungibleToken {
    * 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=2067
+   * @constraints k=11, rows=1982
    *
    * Requirements:
    *
@@ -779,7 +784,7 @@ module NonFungibleToken {
    * As opposed to {_unsafeTransferFrom}, this imposes no restrictions on the caller's identity.
    * It does NOT check if the recipient is a ContractAddress.
    *
-   * @circuitInfo k=12, rows=2064
+   * @constraints k=11, rows=1979
    *
    * Requirements:
    *
@@ -815,7 +820,7 @@ module NonFungibleToken {
   /**
    * @description Approve `to` to operate on `tokenId`.
    *
-   * @circuitInfo k=11, rows=1810
+   * @constraints k=11, rows=1840
    *
    * Requirements:
    *
@@ -856,7 +861,7 @@ module NonFungibleToken {
   /**
    * @description Approve `operator` to operate on all of `owner` tokens.
    *
-   * @circuitInfo k=11, rows=1261
+   * @constraints k=11, rows=1280
    *
    * Requirements:
    *
@@ -895,7 +900,7 @@ module NonFungibleToken {
    * @description Reverts if the `tokenId` doesn't have a current owner (it hasn't been minted, or it has been burned).
    * Returns the owner.
    *
-   * @circuitInfo k=9, rows=331
+   * @constraints k=9, rows=329
    *
    * Requirements:
    *

package/token/extensions/ConfidentialFungibleTokenPublicSupply.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.1 (token/extensions/ConfidentialFungibleTokenPublicSupply.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.2 (token/extensions/ConfidentialFungibleTokenPublicSupply.compact)
 
 pragma language_version >= 0.26.0;
 
@@ -33,15 +33,20 @@ pragma language_version >= 0.26.0;
 module ConfidentialFungibleTokenPublicSupply {
   import CompactStandardLibrary;
 
-  // The public circulating supply. Mint and burn disclose their amounts
-  // through the delta on this value.
+  /**
+   * @description Total tokens in circulation, tracked in the clear even though
+   * balances are encrypted. Raised by `_addSupply` and lowered by `_subSupply`,
+   * each rejecting over/underflow.
+   *
+   * @warning Mint and burn disclose their amounts through the delta on this value
+   */
   export ledger _totalSupply: Uint<128>;
 
   /**
    * @description Increases `totalSupply` by `value`. Call alongside the token
    * module's `_mint`. The added amount is disclosed via the supply delta.
    *
-   * @circuitInfo k=9, rows=401
+   * @constraints k=9, rows=399
    *
    * Requirements:
    *
@@ -62,7 +67,7 @@ module ConfidentialFungibleTokenPublicSupply {
    * module's `_burn` or `_burnFrom`. The removed amount is disclosed via the
    * supply delta.
    *
-   * @circuitInfo k=9, rows=256
+   * @constraints k=9, rows=254
    *
    * Requirements:
    *
@@ -80,7 +85,7 @@ module ConfidentialFungibleTokenPublicSupply {
   /**
    * @description Returns the public total token supply.
    *
-   * @circuitInfo k=6, rows=26
+   * @constraints k=6, rows=24
    *
    * @return {Uint<128>} - The total supply.
    */

package/token/extensions/NativeShieldedTokenDerivedNonce.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.4.0-alpha.1 (token/extensions/NativeShieldedTokenDerivedNonce.compact)
+// OpenZeppelin Compact Contracts v0.4.0-alpha.2 (token/extensions/NativeShieldedTokenDerivedNonce.compact)
 
 pragma language_version >= 0.26.0;
 
@@ -59,7 +59,7 @@ module NativeShieldedTokenDerivedNonce {
    * @notice The derivation input is public ledger state, so mints using this
    * nonce are recipient-public; see the module notes.
    *
-   * @circuitInfo k=9, rows=451
+   * @constraints k=9, rows=447
    *
    * @return {Bytes<32>} - The next derived coin nonce.
    */

package/token/extensions/NativeShieldedTokenFamilyPublicSupply.compact

@@ -76,7 +76,7 @@ module NativeShieldedTokenFamilyPublicSupply {
    * @description Adds `amount` to the exact minted total for `domain`. Call
    * once per successful `NativeShieldedTokenFamily._mint`.
    *
-   * @circuitInfo k=10, rows=653
+   * @constraints k=10, rows=645
    *
    * @param {Bytes<32>} domain - 32-byte token discriminator.
    * @param {Uint<64>} amount - The minted amount.
@@ -93,7 +93,7 @@ module NativeShieldedTokenFamilyPublicSupply {
    * @dev Enforces per-domain `burned <= minted`; an unpaired, duplicate, or
    * wrong-domain burn reverts.
    *
-   * @circuitInfo k=10, rows=755
+   * @constraints k=10, rows=747
    *
    * @param {Bytes<32>} domain - 32-byte token discriminator.
    * @param {Uint<128>} amount - The burned amount.
@@ -106,7 +106,7 @@ module NativeShieldedTokenFamilyPublicSupply {
   /**
    * @description Returns the exact amount ever minted for `domain`.
    *
-   * @circuitInfo k=9, rows=344
+   * @constraints k=9, rows=342
    *
    * @param {Bytes<32>} domain - 32-byte token discriminator.
    * @return {Uint<128>} - The total amount minted.
@@ -120,7 +120,7 @@ module NativeShieldedTokenFamilyPublicSupply {
    * @notice This is a lower bound: coins sent directly to the burn address
    * without going through the contract are not counted.
    *
-   * @circuitInfo k=9, rows=341
+   * @constraints k=9, rows=339
    *
    * @param {Bytes<32>} domain - 32-byte token discriminator.
    * @return {Uint<128>} - The total amount burned through the contract.
@@ -134,7 +134,7 @@ module NativeShieldedTokenFamilyPublicSupply {
    * @notice This is an UPPER BOUND on circulating supply, not an exact value:
    * burns that bypass the contract are invisible. See the module notes.
    *
-   * @circuitInfo k=9, rows=439
+   * @constraints k=9, rows=437
    *
    * @param {Bytes<32>} domain - 32-byte token discriminator.
    * @return {Uint<128>} - The upper bound on tokens in existence.

package/token/extensions/NativeShieldedTokenPublicSupply.compact

@@ -80,7 +80,7 @@ module NativeShieldedTokenPublicSupply {
    * @description Adds `amount` to the exact minted total. Call once per
    * successful `NativeShieldedToken._mint`.
    *
-   * @circuitInfo k=9, rows=375
+   * @constraints k=9, rows=373
    *
    * @param {Uint<64>} amount - The minted amount.
    * @return {[]} - Empty tuple.
@@ -94,7 +94,7 @@ module NativeShieldedTokenPublicSupply {
    * per successful `NativeShieldedToken._burn` / `_burnFromSelf`.
    * @dev Enforces `burned <= minted`; an unpaired or duplicate burn reverts.
    *
-   * @circuitInfo k=9, rows=477
+   * @constraints k=9, rows=475
    *
    * @param {Uint<128>} amount - The burned amount.
    * @return {[]} - Empty tuple.
@@ -106,7 +106,7 @@ module NativeShieldedTokenPublicSupply {
   /**
    * @description Returns the exact amount ever minted.
    *
-   * @circuitInfo k=7, rows=65
+   * @constraints k=7, rows=63
    *
    * @return {Uint<128>} - The total amount minted.
    */
@@ -119,7 +119,7 @@ module NativeShieldedTokenPublicSupply {
    * @notice This is a lower bound: coins sent directly to the burn address
    * without going through the contract are not counted.
    *
-   * @circuitInfo k=7, rows=62
+   * @constraints k=7, rows=60
    *
    * @return {Uint<128>} - The total amount burned through the contract.
    */
@@ -132,7 +132,7 @@ module NativeShieldedTokenPublicSupply {
    * @notice This is an UPPER BOUND on circulating supply, not an exact value:
    * burns that bypass the contract are invisible. See the module notes.
    *
-   * @circuitInfo k=9, rows=160
+   * @constraints k=9, rows=158
    *
    * @return {Uint<128>} - The upper bound on tokens in existence.
    */

package/token/extensions/NativeShieldedTokenPublicSupplyCore.compact

@@ -71,7 +71,7 @@ module NativeShieldedTokenPublicSupplyCore {
    * once per successful token `_mint`.
    * @dev Checks for overflow in order to output a readable error message.
    *
-   * @circuitInfo k=10, rows=653
+   * @constraints k=10, rows=645
    *
    * @param {Bytes<32>} domain - 32-byte token discriminator.
    * @param {Uint<64>} amount - The minted amount.
@@ -91,7 +91,7 @@ module NativeShieldedTokenPublicSupplyCore {
    * The guard also keeps the add and the `totalSupply` subtraction within
    * bounds, so no separate overflow/underflow check is needed.
    *
-   * @circuitInfo k=10, rows=755
+   * @constraints k=10, rows=747
    *
    * @param {Bytes<32>} domain - 32-byte token discriminator.
    * @param {Uint<128>} amount - The burned amount.
@@ -111,7 +111,7 @@ module NativeShieldedTokenPublicSupplyCore {
   /**
    * @description Returns the exact amount ever minted for `domain`.
    *
-   * @circuitInfo k=9, rows=344
+   * @constraints k=9, rows=342
    *
    * @param {Bytes<32>} domain - 32-byte token discriminator.
    * @return {Uint<128>} - The total amount minted.
@@ -128,7 +128,7 @@ module NativeShieldedTokenPublicSupplyCore {
    * @notice This is a lower bound: coins sent directly to the burn address
    * without going through the contract are not counted.
    *
-   * @circuitInfo k=9, rows=341
+   * @constraints k=9, rows=339
    *
    * @param {Bytes<32>} domain - 32-byte token discriminator.
    * @return {Uint<128>} - The total amount burned through the contract.
@@ -150,7 +150,7 @@ module NativeShieldedTokenPublicSupplyCore {
    * fires in normal operation. It is kept so the getter is a total function that
    * reads cleanly (returning 0) rather than reverting on an out-of-bound state.
    *
-   * @circuitInfo k=9, rows=439
+   * @constraints k=9, rows=437
    *
    * @param {Bytes<32>} domain - 32-byte token discriminator.
    * @return {Uint<128>} - The upper bound on tokens in existence.