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

package/token/ConfidentialNoteFungibleToken.compact

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

package/token/FungibleToken.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.5.0-alpha.1 (token/FungibleToken.compact)
+// OpenZeppelin Compact Contracts v0.5.0-alpha.2 (token/FungibleToken.compact)
 
 pragma language_version >= 0.26.0;
 
@@ -22,12 +22,12 @@ pragma language_version >= 0.26.0;
  * canonicalized in `balanceOf` and `allowance`. `_spendAllowance` canonicalizes
  * independently to ensure consistent lookups before delegating to `_approve`.
  *
- * @notice At the moment Midnight does not support contract-to-contract (C2C) communication, but
- * there are ongoing efforts to enable this in the future. Thus, the main circuits of this module
- * (`transfer`, `transferFrom`, `_transfer`, `_mint`) reject `ContractAddress` recipients via an
- * `isContract` guard, because a contract that receives tokens currently cannot move them back out.
- * Developers who need to experiment with contract recipients can use the `_unsafe` variants, which
- * skip the guard (the caller accepts that such tokens are stranded until C2C lands).
+ * @notice This library has not yet migrated to contract-to-contract (C2C) calls. Thus, the main
+ * circuits of this module (`transfer`, `transferFrom`, `_transfer`, `_mint`) reject
+ * `ContractAddress` recipients via an `isContract` guard, because a contract that receives tokens
+ * currently cannot move them back out. Developers who need to experiment with contract recipients
+ * can use the `_unsafe` variants, which skip the guard (the caller accepts that such tokens are
+ * stranded until the C2C migration lands).
  *
  * @dev Migration plan (safe -> C2C-capable transfers)
  *
@@ -39,9 +39,9 @@ pragma language_version >= 0.26.0;
  * which is the only kind of upgrade the CMA supports. Widening the types later would instead force
  * a ledger-layout rewrite, which the CMA cannot perform.
  *
- * When C2C lands, an already-deployed token migrates without changing its address or ledger state.
- * Below, `FN` stands for each guarded circuit (`transfer`, `transferFrom`, `_transfer`, `_mint`)
- * and `_unsafeFN` for its unsafe counterpart:
+ * When the C2C migration lands, an already-deployed token migrates without changing its address or
+ * ledger state. Below, `FN` stands for each guarded circuit (`transfer`, `transferFrom`,
+ * `_transfer`, `_mint`) and `_unsafeFN` for its unsafe counterpart:
  *
  * - Minor release: mark `_unsafeFN` deprecated (and emit a warning if possible); keep its
  *   implementation intact so existing callers continue to work.
@@ -269,8 +269,8 @@ module FungibleToken {
    *
    * @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
+   * @notice Transfers to contract addresses are disallowed until this library migrates to
+   * contract-to-contract calls. This restriction prevents assets from
    * being inadvertently locked in contracts that cannot currently handle token receipt.
    *
    * Requirements:
@@ -300,9 +300,10 @@ module FungibleToken {
    *
    * @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.
-   * Once contract-to-contract calls are supported, this circuit may be deprecated.
+   * @warning Transfers to contract addresses are considered unsafe because this library has not yet
+   * migrated to contract-to-contract calls.
+   * Tokens sent to a contract address may become irretrievable.
+   * Once this library migrates to contract-to-contract calls, this circuit may be deprecated.
    *
    * Requirements:
    *
@@ -385,8 +386,8 @@ module FungibleToken {
    *
    * @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
+   * @notice Transfers to contract addresses are disallowed until this library migrates to
+   * contract-to-contract calls. This restriction prevents assets from
    * being inadvertently locked in contracts that cannot currently handle token receipt.
    *
    * Requirements:
@@ -419,9 +420,10 @@ module FungibleToken {
    *
    * @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.
-   * Once contract-to-contract calls are supported, this circuit may be deprecated.
+   * @warning Transfers to contract addresses are considered unsafe because this library has not yet
+   * migrated to contract-to-contract calls.
+   * Tokens sent to a contract address may become irretrievable.
+   * Once this library migrates to contract-to-contract calls, this circuit may be deprecated.
    *
    * Requirements:
    *
@@ -456,8 +458,8 @@ module FungibleToken {
    *
    * @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
+   * @notice Transfers to contract addresses are disallowed until this library migrates to
+   * contract-to-contract calls. This restriction prevents assets from
    * being inadvertently locked in contracts that cannot currently handle token receipt.
    *
    * Requirements:
@@ -489,9 +491,10 @@ module FungibleToken {
    *
    * @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.
-   * Once contract-to-contract calls are supported, this circuit may be deprecated.
+   * @warning Transfers to contract addresses are considered unsafe because this library has not yet
+   * migrated to contract-to-contract calls.
+   * Tokens sent to a contract address may become irretrievable.
+   * Once this library migrates to contract-to-contract calls, this circuit may be deprecated.
    *
    * Requirements:
    *
@@ -567,8 +570,8 @@ module FungibleToken {
    *
    * @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
+   * @notice Transfers to contract addresses are disallowed until this library migrates to
+   * contract-to-contract calls. This restriction prevents assets from
    * being inadvertently locked in contracts that cannot currently handle token receipt.
    *
    * Requirements:
@@ -593,9 +596,10 @@ module FungibleToken {
    *
    * @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.
-   * Once contract-to-contract calls are supported, this circuit may be deprecated.
+   * @warning Transfers to contract addresses are considered unsafe because this library has not yet
+   * migrated to contract-to-contract calls.
+   * Tokens sent to a contract address may become irretrievable.
+   * Once this library migrates to contract-to-contract calls, this circuit may be deprecated.
    *
    * Requirements:
    *

package/token/MultiToken.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.5.0-alpha.1 (token/MultiToken.compact)
+// OpenZeppelin Compact Contracts v0.5.0-alpha.2 (token/MultiToken.compact)
 
 pragma language_version >= 0.26.0;
 
@@ -49,8 +49,8 @@ pragma language_version >= 0.26.0;
  * Since this module does not offer mint or transfer batching,
  * balance batching is also not included at this time.
  *
- * 3. Introspection - Compact currently cannot support contract-to-contract
- * queries for introspection. ERC165 (or an equivalent thereof) is NOT
+ * 3. Introspection - This library has not yet migrated to contract-to-contract
+ * calls, so there are no introspection queries. ERC165 (or an equivalent thereof) is NOT
  * included in the contract.
  *
  * 4. Safe transfers - The lack of an introspection mechanism means
@@ -93,7 +93,7 @@ pragma language_version >= 0.26.0;
  * an `isContract` guard, because a contract that receives tokens currently cannot move them back
  * out. The `_unsafe` variants (`_unsafeTransferFrom`, `_unsafeTransfer`, `_unsafeMint`) skip the
  * guard for callers who need contract recipients (accepting that such tokens are stranded until
- * C2C lands).
+ * the C2C migration lands).
  *
  * The recipient type is the final `Either<Bytes<32>, ContractAddress>` from day one, in both
  * circuit signatures and ledger maps. This is deliberate. Midnight's upgrade mechanism, the
@@ -103,7 +103,8 @@ pragma language_version >= 0.26.0;
  * which is the only kind of upgrade the CMA supports. Widening the types later would instead force
  * a ledger-layout rewrite, which the CMA cannot perform.
  *
- * When C2C lands, an already-deployed token migrates without changing its address or ledger state:
+ * When the C2C migration lands, an already-deployed token migrates without changing its address or
+ * ledger state:
  *
  * - Minor release: mark the `_unsafe` variants deprecated (and emit a warning if possible); keep
  *   their implementation intact so existing callers continue to work.
@@ -120,7 +121,7 @@ pragma language_version >= 0.26.0;
  *
  * - Consider changing the underscore in the internal methods to `unsafe` or
  * adopting dot notation for prefixing imports.
- * - Revise logic once contract-to-contract interactions are available on midnight.
+ * - Revise logic once this library migrates to contract-to-contract calls.
  */
 module MultiToken {
   import CompactStandardLibrary;
@@ -328,8 +329,8 @@ 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)`.
    *
-   * @notice Transfers to contract addresses are currently disallowed until contract-to-contract
-   * interactions are supported in Compact. This restriction prevents assets from
+   * @notice Transfers to contract addresses are disallowed until this library migrates to
+   * contract-to-contract calls. This restriction prevents assets from
    * being inadvertently locked in contracts that cannot currently handle token receipt.
    *
    * @constraints k=13, rows=4833
@@ -365,8 +366,8 @@ module MultiToken {
    * Does not impose restrictions on the caller, making it suitable for composition
    * in higher-level contract logic.
    *
-   * @notice Transfers to contract addresses are currently disallowed until contract-to-contract
-   * interactions are supported in Compact. This restriction prevents assets from
+   * @notice Transfers to contract addresses are disallowed until this library migrates to
+   * contract-to-contract calls. This restriction prevents assets from
    * being inadvertently locked in contracts that cannot currently handle token receipt.
    *
    * @constraints k=12, rows=2381
@@ -458,9 +459,10 @@ 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)`.
    *
-   * @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.
-   * Once contract-to-contract calls are supported, this circuit may be deprecated.
+   * @warning Transfers to contract addresses are considered unsafe because this library has not yet
+   * migrated to contract-to-contract calls.
+   * Tokens sent to a contract address may become irretrievable.
+   * Once this library migrates to contract-to-contract calls, this circuit may be deprecated.
    *
    * @constraints k=13, rows=4832
    *
@@ -500,9 +502,10 @@ module MultiToken {
    * Does not impose restrictions on the caller, making it suitable as a low-level
    * building block for advanced contract logic.
    *
-   * @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.
-   * Once contract-to-contract calls are supported, this circuit may be deprecated.
+   * @warning Transfers to contract addresses are considered unsafe because this library has not yet
+   * migrated to contract-to-contract calls.
+   * Tokens sent to a contract address may become irretrievable.
+   * Once this library migrates to contract-to-contract calls, this circuit may be deprecated.
    *
    * @constraints k=12, rows=2380
    *
@@ -563,8 +566,8 @@ module MultiToken {
   /**
    * @description Creates a `value` amount of tokens of type `id`, and assigns them to `to`.
    *
-   * @notice Transfers to contract addresses are currently disallowed until contract-to-contract
-   * interactions are supported in Compact. This restriction prevents assets from
+   * @notice Transfers to contract addresses are disallowed until this library migrates to
+   * contract-to-contract calls. This restriction prevents assets from
    * being inadvertently locked in contracts that cannot currently handle token receipt.
    *
    * @constraints k=11, rows=1449
@@ -592,9 +595,10 @@ module MultiToken {
   /**
    * @description Unsafe variant of `_mint` which allows transfers to contract addresses.
    *
-   * @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.
-   * Once contract-to-contract calls are supported, this circuit may be deprecated.
+   * @warning Transfers to contract addresses are considered unsafe because this library has not yet
+   * migrated to contract-to-contract calls.
+   * Tokens sent to a contract address may become irretrievable.
+   * Once this library migrates to contract-to-contract calls, this circuit may be deprecated.
    *
    * @constraints k=11, rows=1448
    *

package/token/NativeShieldedToken.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.5.0-alpha.1 (token/NativeShieldedToken.compact)
+// OpenZeppelin Compact Contracts v0.5.0-alpha.2 (token/NativeShieldedToken.compact)
 
 pragma language_version >= 0.26.0;
 
@@ -62,7 +62,7 @@ pragma language_version >= 0.26.0;
  * shared-`Initializable`-flag "one `initialize` per contract" limit no longer
  * applies.)
  *
- * @notice Out of scope (phase two, pending contract-to-contract support):
+ * @notice Out of scope (phase two, pending this library's contract-to-contract migration):
  * `balanceOf`, `allowance`, and transfer mediation are not representable for
  * native shielded UTXOs — once a user holds a coin, the contract cannot observe
  * or restrict its movement.

package/token/NativeShieldedTokenCore.compact

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

package/token/NativeShieldedTokenFamily.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.5.0-alpha.1 (token/NativeShieldedTokenFamily.compact)
+// OpenZeppelin Compact Contracts v0.5.0-alpha.2 (token/NativeShieldedTokenFamily.compact)
 
 pragma language_version >= 0.26.0;
 
@@ -8,8 +8,8 @@ pragma language_version >= 0.26.0;
  * @description A module for issuing a FAMILY of native shielded (Zswap)
  * token types from one contract, discriminated by a per-call domain.
  *
- * This flavor exists because of Midnight's composition model: there is no
- * contract-to-contract interaction and no way for a contract to deploy
+ * This flavor exists because of Midnight's composition model: this library has no
+ * contract-to-contract interaction yet and a contract cannot deploy
  * another, so the Ethereum pattern of one token contract per asset (stamped
  * out by a factory) is unavailable. A protocol that issues many related
  * tokens — e.g. a DEX minting one liquidity-share token per pair — must do
@@ -61,7 +61,7 @@ pragma language_version >= 0.26.0;
  * need an on-chain `totalSupply(domain)`; see it for the privacy trade-off it
  * introduces (it makes contract-mediated burn amounts public).
  *
- * @notice Out of scope (phase two, pending contract-to-contract support):
+ * @notice Out of scope (phase two, pending this library's contract-to-contract migration):
  * `balanceOf`, `allowance`, transfer mediation, batch operations, and operator
  * approvals are not representable for native shielded UTXOs — once a user holds
  * a coin, the contract cannot observe or restrict its movement.

package/token/NonFungibleToken.compact

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Compact Contracts v0.5.0-alpha.1 (token/NonFungibleToken.compact)
+// OpenZeppelin Compact Contracts v0.5.0-alpha.2 (token/NonFungibleToken.compact)
 
 pragma language_version >= 0.26.0;
 
@@ -24,12 +24,12 @@ pragma language_version >= 0.26.0;
  * This is due to encoding limits on the midnight circuit backend:
  * https://github.com/midnightntwrk/compactc/issues/929
  *
- * @notice At the moment Midnight does not support contract-to-contract (C2C) communication, but
- * there are ongoing efforts to enable this in the future. Thus, the main circuits of this module
- * (`transfer`, `transferFrom`, `_transfer`, `_mint`) reject `ContractAddress` recipients via an
- * `isContract` guard, because a contract that receives a token currently cannot move it back out.
- * Developers who need to experiment with contract recipients can use the `_unsafe` variants, which
- * skip the guard (the caller accepts that such tokens are stranded until C2C lands).
+ * @notice This library has not yet migrated to contract-to-contract (C2C) calls. Thus, the main
+ * circuits of this module (`transfer`, `transferFrom`, `_transfer`, `_mint`) reject
+ * `ContractAddress` recipients via an `isContract` guard, because a contract that receives a token
+ * currently cannot move it back out. Developers who need to experiment with contract recipients can
+ * use the `_unsafe` variants, which skip the guard (the caller accepts that such tokens are
+ * stranded until the C2C migration lands).
  *
  * @dev Migration plan (safe -> C2C-capable `transfer`)
  *
@@ -41,7 +41,8 @@ pragma language_version >= 0.26.0;
  * which is the only kind of upgrade the CMA supports. Widening the types later would instead force
  * a ledger-layout rewrite, which the CMA cannot perform.
  *
- * When C2C lands, an already-deployed token migrates without changing its address or ledger state:
+ * When the C2C migration lands, an already-deployed token migrates without changing its address or
+ * ledger state:
  *
  * - Minor release: mark `_unsafeTransfer` deprecated (and emit a warning if possible); keep its
  *   implementation intact so existing callers continue to work.
@@ -437,9 +438,9 @@ module NonFungibleToken {
   /**
    * @description Transfers `tokenId` token from `fromAddress` to `to`.
    *
-   * @notice Transfers to contract addresses are currently disallowed until contract-to-contract interactions
-   * are supported in Compact. This restriction prevents assets from being inadvertently locked in contracts that cannot
-   * currently handle token receipt.
+   * @notice Transfers to contract addresses are disallowed until this library migrates to
+   * contract-to-contract calls. This restriction prevents assets from being inadvertently
+   * locked in contracts that cannot currently handle token receipt.
    *
    * In the case of an external (non-contract) caller, the caller's identity is derived from the `wit_NonFungibleTokenSK`
    * witness as `persistentHash(secretKey)`.
@@ -478,9 +479,10 @@ 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)`.
    *
-   * @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.
-   * Once contract-to-contract calls are supported, this circuit may be deprecated.
+   * @warning Transfers to contract addresses are considered unsafe because this library has not yet
+   * migrated to contract-to-contract calls.
+   * Tokens sent to a contract address may become irretrievable.
+   * Once this library migrates to contract-to-contract calls, this circuit may be deprecated.
    *
    * @constraints k=13, rows=4699
    *
@@ -706,9 +708,10 @@ module NonFungibleToken {
    * - `tokenId` must not exist.
    * - `to` is not zero.
    *
-   * @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.
-   * Once contract-to-contract calls are supported, this circuit may be deprecated.
+   * @warning Transfers to contract addresses are considered unsafe because this library has not yet
+   * migrated to contract-to-contract calls.
+   * Tokens sent to a contract address may become irretrievable.
+   * Once this library migrates to contract-to-contract calls, this circuit may be deprecated.
    *
    * @param {Either<Bytes<32>, ContractAddress>} to - The account receiving `tokenId`
    * @param {Uint<128>} tokenId - The token to transfer
@@ -752,8 +755,8 @@ module NonFungibleToken {
    * @description Transfers `tokenId` from `fromAddress` to `to`.
    * As opposed to {transferFrom}, this imposes no restrictions on the caller's identity.
    *
-   * @notice Transfers to contract addresses are currently disallowed until contract-to-contract
-   * interactions are supported in Compact. This restriction prevents assets from being inadvertently
+   * @notice Transfers to contract addresses are disallowed until this library migrates to
+   * contract-to-contract calls. This restriction prevents assets from being inadvertently
    * locked in contracts that cannot currently handle token receipt.
    *
    * @constraints k=11, rows=1982
@@ -795,9 +798,10 @@ module NonFungibleToken {
    * - `to` is not zero.
    * - `tokenId` token must be owned by `fromAddress`.
    *
-   * @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.
-   * Once contract-to-contract calls are supported, this circuit may be deprecated.
+   * @warning Transfers to contract addresses are considered unsafe because this library has not yet
+   * migrated to contract-to-contract calls.
+   * Tokens sent to a contract address may become irretrievable.
+   * Once this library migrates to contract-to-contract calls, this circuit may be deprecated.
    *
    * @param {Either<Bytes<32>, ContractAddress>} fromAddress - The source account of the token transfer
    * @param {Either<Bytes<32>, ContractAddress>} to - The target account of the token transfer

package/token/examples/ZOwnableNativeShieldedTokenExample.compact

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

package/token/extensions/ConfidentialFungibleTokenPublicSupply.compact

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