@openzeppelin/confidential-contracts 0.2.0 → 0.3.0

package/build/contracts/VestingWalletConfidentialFactory.json

@@ -55,7 +55,7 @@
         {
           "indexed": true,
           "internalType": "address",
-          "name": "confidentialFungibleToken",
+          "name": "token",
           "type": "address"
         },
         {
@@ -78,7 +78,7 @@
       "inputs": [
         {
           "internalType": "address",
-          "name": "confidentialFungibleToken",
+          "name": "token",
           "type": "address"
         },
         {

package/finance/ERC7821WithExecutor.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Confidential Contracts (last updated v0.2.0) (finance/ERC7821WithExecutor.sol)
+// OpenZeppelin Confidential Contracts (last updated v0.3.0) (finance/ERC7821WithExecutor.sol)
 pragma solidity ^0.8.20;
 
 import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
@@ -15,8 +15,7 @@ abstract contract ERC7821WithExecutor is Initializable, ERC7821 {
     }
 
     // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.ERC7821WithExecutor")) - 1)) & ~bytes32(uint256(0xff))
-    // solhint-disable-next-line const-name-snakecase
-    bytes32 private constant ERC7821WithExecutorStorageLocation =
+    bytes32 private constant ERC7821_WITH_EXECUTOR_STORAGE_LOCATION =
         0x246106ffca67a7d3806ba14f6748826b9c39c9fa594b14f83fe454e8e9d0dc00;
 
     /// @dev Trusted address that is able to execute arbitrary calls from the vesting wallet via `ERC7821.execute`.
@@ -40,7 +39,7 @@ abstract contract ERC7821WithExecutor is Initializable, ERC7821 {
 
     function _getERC7821WithExecutorStorage() private pure returns (ERC7821WithExecutorStorage storage $) {
         assembly ("memory-safe") {
-            $.slot := ERC7821WithExecutorStorageLocation
+            $.slot := ERC7821_WITH_EXECUTOR_STORAGE_LOCATION
         }
     }
 }

package/finance/VestingWalletCliffConfidential.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Confidential Contracts (last updated v0.2.0) (finance/VestingWalletCliffConfidential.sol)
+// OpenZeppelin Confidential Contracts (last updated v0.3.0) (finance/VestingWalletCliffConfidential.sol)
 pragma solidity ^0.8.27;
 
 import {euint128} from "@fhevm/solidity/lib/FHE.sol";
@@ -16,8 +16,7 @@ abstract contract VestingWalletCliffConfidential is VestingWalletConfidential {
     }
 
     // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.VestingWalletCliffConfidential")) - 1)) & ~bytes32(uint256(0xff))
-    // solhint-disable-next-line const-name-snakecase
-    bytes32 private constant VestingWalletCliffStorageLocation =
+    bytes32 private constant VESTING_WALLET_CLIFF_STORAGE_LOCATION =
         0x3c715f77db997bdb68403fafb54820cd57dedce553ed6315028656b0d601c700;
 
     /// @dev The specified cliff duration is larger than the vesting duration.
@@ -67,7 +66,7 @@ abstract contract VestingWalletCliffConfidential is VestingWalletConfidential {
 
     function _getVestingWalletCliffStorage() private pure returns (VestingWalletCliffStorage storage $) {
         assembly ("memory-safe") {
-            $.slot := VestingWalletCliffStorageLocation
+            $.slot := VESTING_WALLET_CLIFF_STORAGE_LOCATION
         }
     }
 }

package/finance/VestingWalletConfidential.sol

@@ -1,14 +1,14 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Confidential Contracts (last updated v0.2.0) (finance/VestingWalletConfidential.sol)
+// OpenZeppelin Confidential Contracts (last updated v0.3.0) (finance/VestingWalletConfidential.sol)
 pragma solidity ^0.8.24;
 
 import {FHE, ebool, euint64, euint128} from "@fhevm/solidity/lib/FHE.sol";
 import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
 import {ReentrancyGuardTransient} from "@openzeppelin/contracts/utils/ReentrancyGuardTransient.sol";
-import {IConfidentialFungibleToken} from "./../interfaces/IConfidentialFungibleToken.sol";
+import {IERC7984} from "./../interfaces/IERC7984.sol";
 
 /**
- * @dev A vesting wallet is an ownable contract that can receive ConfidentialFungibleTokens, and release these
+ * @dev A vesting wallet is an ownable contract that can receive ERC7984 tokens, and release these
  * assets to the wallet owner, also referred to as "beneficiary", according to a vesting schedule.
  *
  * Any assets transferred to this contract will follow the vesting schedule as if they were locked from the beginning.
@@ -34,8 +34,7 @@ abstract contract VestingWalletConfidential is OwnableUpgradeable, ReentrancyGua
     }
 
     // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.VestingWalletConfidential")) - 1)) & ~bytes32(uint256(0xff))
-    // solhint-disable-next-line const-name-snakecase
-    bytes32 private constant VestingWalletStorageLocation =
+    bytes32 private constant VESTING_WALLET_STORAGE_LOCATION =
         0x78ce9ee9eb65fa0cf5bf10e861c3a95cb7c3c713c96ab1e5323a21e846796800;
 
     /// @dev Emitted when releasable vested tokens are released.
@@ -63,7 +62,7 @@ abstract contract VestingWalletConfidential is OwnableUpgradeable, ReentrancyGua
 
     /**
      * @dev Getter for the amount of releasable `token` tokens. `token` should be the address of an
-     * {IConfidentialFungibleToken} contract.
+     * {IERC7984} contract.
      */
     function releasable(address token) public virtual returns (euint64) {
         euint128 vestedAmount_ = vestedAmount(token, uint48(block.timestamp));
@@ -80,7 +79,7 @@ abstract contract VestingWalletConfidential is OwnableUpgradeable, ReentrancyGua
     function release(address token) public virtual nonReentrant {
         euint64 amount = releasable(token);
         FHE.allowTransient(amount, token);
-        euint64 amountSent = IConfidentialFungibleToken(token).confidentialTransfer(owner(), amount);
+        euint64 amountSent = IERC7984(token).confidentialTransfer(owner(), amount);
 
         // This could overflow if the total supply is resent `type(uint128).max/type(uint64).max` times. This is an accepted risk.
         euint128 newReleasedAmount = FHE.add(released(token), amountSent);
@@ -96,10 +95,7 @@ abstract contract VestingWalletConfidential is OwnableUpgradeable, ReentrancyGua
      */
     function vestedAmount(address token, uint48 timestamp) public virtual returns (euint128) {
         return
-            _vestingSchedule(
-                FHE.add(released(token), IConfidentialFungibleToken(token).confidentialBalanceOf(address(this))),
-                timestamp
-            );
+            _vestingSchedule(FHE.add(released(token), IERC7984(token).confidentialBalanceOf(address(this))), timestamp);
     }
 
     /**
@@ -139,7 +135,7 @@ abstract contract VestingWalletConfidential is OwnableUpgradeable, ReentrancyGua
 
     function _getVestingWalletStorage() private pure returns (VestingWalletStorage storage $) {
         assembly ("memory-safe") {
-            $.slot := VestingWalletStorageLocation
+            $.slot := VESTING_WALLET_STORAGE_LOCATION
         }
     }
 }

package/finance/VestingWalletConfidentialFactory.sol

@@ -1,10 +1,10 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Confidential Contracts (last updated v0.2.0) (finance/VestingWalletConfidentialFactory.sol)
+// OpenZeppelin Confidential Contracts (last updated v0.3.0) (finance/VestingWalletConfidentialFactory.sol)
 pragma solidity ^0.8.27;
 
 import {FHE, euint64, externalEuint64} from "@fhevm/solidity/lib/FHE.sol";
 import {Clones} from "@openzeppelin/contracts/proxy/Clones.sol";
-import {IConfidentialFungibleToken} from "./../interfaces/IConfidentialFungibleToken.sol";
+import {IERC7984} from "./../interfaces/IERC7984.sol";
 
 /**
  * @dev A factory which enables batch funding of vesting wallets.
@@ -23,7 +23,7 @@ abstract contract VestingWalletConfidentialFactory {
     /// @dev Emitted for each vesting wallet funded within a batch.
     event VestingWalletConfidentialFunded(
         address indexed vestingWalletConfidential,
-        address indexed confidentialFungibleToken,
+        address indexed token,
         euint64 transferredAmount,
         bytes initArgs
     );
@@ -43,7 +43,7 @@ abstract contract VestingWalletConfidentialFactory {
      * Emits a {VestingWalletConfidentialFunded} event for each funded vesting plan.
      */
     function batchFundVestingWalletConfidential(
-        address confidentialFungibleToken,
+        address token,
         VestingPlan[] calldata vestingPlans,
         bytes calldata inputProof
     ) public virtual {
@@ -55,19 +55,14 @@ abstract contract VestingWalletConfidentialFactory {
             address vestingWalletAddress = predictVestingWalletConfidential(vestingPlan.initArgs);
 
             euint64 encryptedAmount = FHE.fromExternal(vestingPlan.encryptedAmount, inputProof);
-            FHE.allowTransient(encryptedAmount, confidentialFungibleToken);
-            euint64 transferredAmount = IConfidentialFungibleToken(confidentialFungibleToken).confidentialTransferFrom(
+            FHE.allowTransient(encryptedAmount, token);
+            euint64 transferredAmount = IERC7984(token).confidentialTransferFrom(
                 msg.sender,
                 vestingWalletAddress,
                 encryptedAmount
             );
 
-            emit VestingWalletConfidentialFunded(
-                vestingWalletAddress,
-                confidentialFungibleToken,
-                transferredAmount,
-                vestingPlan.initArgs
-            );
+            emit VestingWalletConfidentialFunded(vestingWalletAddress, token, transferredAmount, vestingPlan.initArgs);
         }
     }
 

package/interfaces/{IConfidentialFungibleToken.sol → IERC7984.sol}

@@ -1,11 +1,12 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Confidential Contracts (last updated v0.2.0) (interfaces/IConfidentialFungibleToken.sol)
+// OpenZeppelin Confidential Contracts (last updated v0.3.0) (interfaces/IERC7984.sol)
 pragma solidity ^0.8.24;
 
 import {euint64, externalEuint64} from "@fhevm/solidity/lib/FHE.sol";
+import {IERC165} from "@openzeppelin/contracts/interfaces/IERC165.sol";
 
 /// @dev Draft interface for a confidential fungible token standard utilizing the Zama FHE library.
-interface IConfidentialFungibleToken {
+interface IERC7984 is IERC165 {
     /**
      * @dev Emitted when the expiration timestamp for an operator `operator` is updated for a given `holder`.
      * The operator may move any amount of tokens on behalf of the holder until the timestamp `until`.
@@ -32,8 +33,8 @@ interface IConfidentialFungibleToken {
     /// @dev Returns the number of decimals of the token. Recommended to be 6.
     function decimals() external view returns (uint8);
 
-    /// @dev Returns the token URI.
-    function tokenURI() external view returns (string memory);
+    /// @dev Returns the contract URI. See https://eips.ethereum.org/EIPS/eip-7572[ERC-7572] for details.
+    function contractURI() external view returns (string memory);
 
     /// @dev Returns the confidential total supply of the token.
     function confidentialTotalSupply() external view returns (euint64);
@@ -91,7 +92,7 @@ interface IConfidentialFungibleToken {
      * @dev Similar to {confidentialTransfer-address-externalEuint64-bytes} but with a callback to `to` after
      * the transfer.
      *
-     * The callback is made to the {IConfidentialFungibleTokenReceiver-onConfidentialTransferReceived} function on the
+     * The callback is made to the {IERC7984Receiver-onConfidentialTransferReceived} function on the
      * to address with the actual transferred amount (may differ from the given `encryptedAmount`) and the given
      * data `data`.
      */

package/interfaces/{IConfidentialFungibleTokenReceiver.sol → IERC7984Receiver.sol}

@@ -1,11 +1,11 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Confidential Contracts (last updated v0.2.0) (interfaces/IConfidentialFungibleTokenReceiver.sol)
+// OpenZeppelin Confidential Contracts (last updated v0.3.0) (interfaces/IERC7984Receiver.sol)
 pragma solidity ^0.8.24;
 
 import {ebool, euint64} from "@fhevm/solidity/lib/FHE.sol";
 
-/// @dev Interface for contracts that can receive confidential token transfers with a callback.
-interface IConfidentialFungibleTokenReceiver {
+/// @dev Interface for contracts that can receive ERC7984 transfers with a callback.
+interface IERC7984Receiver {
     /**
      * @dev Called upon receiving a confidential token transfer. Returns an encrypted boolean indicating success
      * of the callback. If false is returned, the transfer must be reversed.

package/interfaces/IERC7984Rwa.sol

@@ -0,0 +1,63 @@
+// SPDX-License-Identifier: MIT
+// OpenZeppelin Confidential Contracts (last updated v0.3.0) (interfaces/IERC7984Rwa.sol)
+pragma solidity ^0.8.24;
+
+import {externalEuint64, euint64} from "@fhevm/solidity/lib/FHE.sol";
+import {IERC7984} from "./IERC7984.sol";
+
+/// @dev Interface for confidential RWA contracts.
+interface IERC7984Rwa is IERC7984 {
+    /// @dev Returns true if the contract is paused, false otherwise.
+    function paused() external view returns (bool);
+    /// @dev Returns whether an account is allowed to interact with the token.
+    function isUserAllowed(address account) external view returns (bool);
+    /// @dev Returns the confidential frozen balance of an account.
+    function confidentialFrozen(address account) external view returns (euint64);
+    /// @dev Returns the confidential available (unfrozen) balance of an account. Up to {IERC7984-confidentialBalanceOf}.
+    function confidentialAvailable(address account) external returns (euint64);
+    /// @dev Pauses contract.
+    function pause() external;
+    /// @dev Unpauses contract.
+    function unpause() external;
+    /// @dev Blocks a user account.
+    function blockUser(address account) external;
+    /// @dev Unblocks a user account.
+    function unblockUser(address account) external;
+    /// @dev Sets confidential amount of token for an account as frozen with proof.
+    function setConfidentialFrozen(
+        address account,
+        externalEuint64 encryptedAmount,
+        bytes calldata inputProof
+    ) external;
+    /// @dev Sets confidential amount of token for an account as frozen.
+    function setConfidentialFrozen(address account, euint64 encryptedAmount) external;
+    /// @dev Mints confidential amount of tokens to account with proof.
+    function confidentialMint(
+        address to,
+        externalEuint64 encryptedAmount,
+        bytes calldata inputProof
+    ) external returns (euint64);
+    /// @dev Mints confidential amount of tokens to account.
+    function confidentialMint(address to, euint64 encryptedAmount) external returns (euint64);
+    /// @dev Burns confidential amount of tokens from account with proof.
+    function confidentialBurn(
+        address account,
+        externalEuint64 encryptedAmount,
+        bytes calldata inputProof
+    ) external returns (euint64);
+    /// @dev Burns confidential amount of tokens from account.
+    function confidentialBurn(address account, euint64 encryptedAmount) external returns (euint64);
+    /// @dev Forces transfer of confidential amount of tokens from account to account with proof by skipping compliance checks.
+    function forceConfidentialTransferFrom(
+        address from,
+        address to,
+        externalEuint64 encryptedAmount,
+        bytes calldata inputProof
+    ) external returns (euint64);
+    /// @dev Forces transfer of confidential amount of tokens from account to account by skipping compliance checks.
+    function forceConfidentialTransferFrom(
+        address from,
+        address to,
+        euint64 encryptedAmount
+    ) external returns (euint64);
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openzeppelin/confidential-contracts",
   "description": "Smart Contract library for use with confidential coprocessors",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "files": [
     "**/*.sol",
     "/build/contracts/*.json",
@@ -32,8 +32,8 @@
   },
   "homepage": "https://openzeppelin.com/contracts/",
   "peerDependencies": {
-    "@fhevm/solidity": "0.7.0",
-    "@openzeppelin/contracts": "^5.3.0",
-    "@openzeppelin/contracts-upgradeable": "^5.3.0"
+    "@fhevm/solidity": "0.9.1",
+    "@openzeppelin/contracts": "^5.4.0",
+    "@openzeppelin/contracts-upgradeable": "^5.4.0"
   }
 }