Upgrade to use fhevm contracts v0.9.0 (#248)

arr00 · 0xalexbel · james-toussaint · arr00 · commit f5f22c0b518a · 2025-11-12T16:26:43.000-03:00
* chore: fhevm-v9 * chore: port all tests for fhevm v9 * Merge pull request #1 from OpenZeppelin/chore/update-disclose-flow update disclose flow * Update wrapper contract (#2) * Update wrapper contract * fix tests * fix mock * update docs * add changeset * request id unnecessary * Update contracts/token/ERC7984/extensions/ERC7984ERC20Wrapper.sol Co-authored-by: James Toussaint <33313130+james-toussaint@users.noreply.github.com> * remove unused params * Update test/token/ERC7984/ERC7984.test.ts Co-authored-by: James Toussaint <33313130+james-toussaint@users.noreply.github.com> * `cts` -> `handles` * `cleartext` -> `cleartextAmount` * Update test/token/ERC7984/extensions/ERC7984Wrapper.test.ts Co-authored-by: James Toussaint <33313130+james-toussaint@users.noreply.github.com> * nit --------- Co-authored-by: 0xalexbel <alexandre.belhoste@zama.ai> Co-authored-by: James Toussaint <33313130+james-toussaint@users.noreply.github.com>
diff --git a/.changeset/puny-nails-bathe.md b/.changeset/puny-nails-bathe.md
@@ -0,0 +1,5 @@
+---
+'openzeppelin-confidential-contracts': minor
+---
+
+Migrate FHEVM contracts from v0.8 to v0.9
diff --git a/contracts/mocks/docs/SwapERC7984ToERC20.sol b/contracts/mocks/docs/SwapERC7984ToERC20.sol
@@ -1,15 +1,15 @@
 // SPDX-License-Identifier: MIT
-pragma solidity ^0.8.24;
+pragma solidity ^0.8.27;
 
 import {FHE, externalEuint64, euint64} from "@fhevm/solidity/lib/FHE.sol";
 import {IERC20} from "@openzeppelin/contracts/interfaces/IERC20.sol";
 import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 import {IERC7984} from "../../interfaces/IERC7984.sol";
 
-contract SwapConfidentialToERC20 {
-    error SwapConfidentialToERC20InvalidGatewayRequest(uint256 requestId);
+contract SwapERC7984ToERC20 {
+    error SwapERC7984ToERC20InvalidFinalization(euint64 amount);
 
-    mapping(uint256 requestId => address) private _receivers;
+    mapping(euint64 amount => address) private _receivers;
     IERC7984 private _fromToken;
     IERC20 private _toToken;
 
@@ -23,23 +23,21 @@ contract SwapConfidentialToERC20 {
         FHE.allowTransient(amount, address(_fromToken));
         euint64 amountTransferred = _fromToken.confidentialTransferFrom(msg.sender, address(this), amount);
 
-        bytes32[] memory cts = new bytes32[](1);
-        cts[0] = euint64.unwrap(amountTransferred);
-        uint256 requestID = FHE.requestDecryption(cts, this.finalizeSwap.selector);
-
-        // register who is getting the tokens
-        _receivers[requestID] = msg.sender;
+        FHE.makePubliclyDecryptable(amountTransferred);
+        _receivers[amountTransferred] = msg.sender;
     }
 
-    function finalizeSwap(uint256 requestID, bytes calldata cleartexts, bytes calldata decryptionProof) public virtual {
-        FHE.checkSignatures(requestID, cleartexts, decryptionProof);
-        uint64 amount = abi.decode(cleartexts, (uint64));
-        address to = _receivers[requestID];
-        require(to != address(0), SwapConfidentialToERC20InvalidGatewayRequest(requestID));
-        delete _receivers[requestID];
+    function finalizeSwap(euint64 amount, uint64 cleartextAmount, bytes calldata decryptionProof) public virtual {
+        bytes32[] memory handles = new bytes32[](1);
+        handles[0] = euint64.unwrap(amount);
+
+        FHE.verifySignatures(handles, abi.encode(cleartextAmount), decryptionProof);
+        address to = _receivers[amount];
+        require(to != address(0), SwapERC7984ToERC20InvalidFinalization(amount));
+        delete _receivers[amount];
 
-        if (amount != 0) {
-            SafeERC20.safeTransfer(_toToken, to, amount);
+        if (cleartextAmount != 0) {
+            SafeERC20.safeTransfer(_toToken, to, cleartextAmount);
         }
     }
 }
diff --git a/contracts/mocks/finance/VestingWalletCliffConfidentialMock.sol b/contracts/mocks/finance/VestingWalletCliffConfidentialMock.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.24;
 
-import {SepoliaConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
+import {EthereumConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
 import {VestingWalletCliffConfidential} from "../../finance/VestingWalletCliffConfidential.sol";
 
-abstract contract VestingWalletCliffConfidentialMock is VestingWalletCliffConfidential, SepoliaConfig {}
+abstract contract VestingWalletCliffConfidentialMock is VestingWalletCliffConfidential, EthereumConfig {}
diff --git a/contracts/mocks/finance/VestingWalletConfidentialFactoryMock.sol b/contracts/mocks/finance/VestingWalletConfidentialFactoryMock.sol
@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.24;
 
-import {SepoliaConfig, ZamaConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
+import {EthereumConfig, ZamaConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
 import {FHE} from "@fhevm/solidity/lib/FHE.sol";
 import {ERC7821WithExecutor} from "./../../finance/ERC7821WithExecutor.sol";
 import {VestingWalletCliffConfidential} from "./../../finance/VestingWalletCliffConfidential.sol";
 import {VestingWalletConfidentialFactory} from "./../../finance/VestingWalletConfidentialFactory.sol";
 
-abstract contract VestingWalletConfidentialFactoryMock is VestingWalletConfidentialFactory, SepoliaConfig {
+abstract contract VestingWalletConfidentialFactoryMock is VestingWalletConfidentialFactory, EthereumConfig {
     function _deployVestingWalletImplementation() internal virtual override returns (address) {
         return address(new VestingWalletCliffExecutorConfidential());
     }
@@ -46,7 +46,7 @@ abstract contract VestingWalletConfidentialFactoryMock is VestingWalletConfident
 }
 
 // slither-disable-next-line locked-ether
-contract VestingWalletCliffExecutorConfidential is VestingWalletCliffConfidential, ERC7821WithExecutor, SepoliaConfig {
+contract VestingWalletCliffExecutorConfidential is VestingWalletCliffConfidential, ERC7821WithExecutor, EthereumConfig {
     constructor() {
         _disableInitializers();
     }
diff --git a/contracts/mocks/finance/VestingWalletConfidentialMock.sol b/contracts/mocks/finance/VestingWalletConfidentialMock.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.24;
 
-import {SepoliaConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
+import {EthereumConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
 import {VestingWalletConfidential} from "../../finance/VestingWalletConfidential.sol";
 
-abstract contract VestingWalletConfidentialMock is VestingWalletConfidential, SepoliaConfig {}
+abstract contract VestingWalletConfidentialMock is VestingWalletConfidential, EthereumConfig {}
diff --git a/contracts/mocks/token/ERC7984ERC20WrapperMock.sol b/contracts/mocks/token/ERC7984ERC20WrapperMock.sol
@@ -1,11 +1,11 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.27;
 
-import {SepoliaConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
+import {EthereumConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
 import {IERC20} from "@openzeppelin/contracts/interfaces/IERC20.sol";
 import {ERC7984ERC20Wrapper, ERC7984} from "../../token/ERC7984/extensions/ERC7984ERC20Wrapper.sol";
 
-contract ERC7984ERC20WrapperMock is ERC7984ERC20Wrapper, SepoliaConfig {
+contract ERC7984ERC20WrapperMock is ERC7984ERC20Wrapper, EthereumConfig {
     constructor(
         IERC20 token,
         string memory name,
diff --git a/contracts/mocks/token/ERC7984FreezableMock.sol b/contracts/mocks/token/ERC7984FreezableMock.sol
@@ -2,7 +2,7 @@
 
 pragma solidity ^0.8.27;
 
-import {SepoliaConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
+import {EthereumConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
 import {FHE, euint64, externalEuint64} from "@fhevm/solidity/lib/FHE.sol";
 import {ERC7984} from "../../token/ERC7984/ERC7984.sol";
 import {ERC7984Freezable} from "../../token/ERC7984/extensions/ERC7984Freezable.sol";
diff --git a/contracts/mocks/token/ERC7984Mock.sol b/contracts/mocks/token/ERC7984Mock.sol
@@ -2,12 +2,12 @@
 
 pragma solidity ^0.8.27;
 
-import {SepoliaConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
+import {EthereumConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
 import {FHE, eaddress, euint64, externalEuint64} from "@fhevm/solidity/lib/FHE.sol";
 import {ERC7984} from "../../token/ERC7984/ERC7984.sol";
 
 // solhint-disable func-name-mixedcase
-contract ERC7984Mock is ERC7984, SepoliaConfig {
+contract ERC7984Mock is ERC7984, EthereumConfig {
     address private immutable _OWNER;
 
     event EncryptedAmountCreated(euint64 amount);
diff --git a/contracts/mocks/token/ERC7984ObserverAccessMock.sol b/contracts/mocks/token/ERC7984ObserverAccessMock.sol
@@ -2,7 +2,6 @@
 
 pragma solidity ^0.8.27;
 
-import {SepoliaConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
 import {FHE, euint64, externalEuint64} from "@fhevm/solidity/lib/FHE.sol";
 import {ERC7984ObserverAccess} from "../../token/ERC7984/extensions/ERC7984ObserverAccess.sol";
 import {ERC7984Mock} from "./ERC7984Mock.sol";
diff --git a/contracts/mocks/token/ERC7984ReceiverMock.sol b/contracts/mocks/token/ERC7984ReceiverMock.sol
@@ -1,11 +1,11 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.27;
 
-import {SepoliaConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
+import {EthereumConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
 import {FHE, ebool, euint64} from "@fhevm/solidity/lib/FHE.sol";
 import {IERC7984Receiver} from "../../interfaces/IERC7984Receiver.sol";
 
-contract ERC7984ReceiverMock is IERC7984Receiver, SepoliaConfig {
+contract ERC7984ReceiverMock is IERC7984Receiver, EthereumConfig {
     event ConfidentialTransferCallback(bool success);
 
     error InvalidInput(uint8 input);
diff --git a/contracts/mocks/token/ERC7984RestrictedMock.sol b/contracts/mocks/token/ERC7984RestrictedMock.sol
@@ -2,11 +2,11 @@
 
 pragma solidity ^0.8.27;
 
-import {SepoliaConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
+import {EthereumConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
 import {FHE} from "@fhevm/solidity/lib/FHE.sol";
 import {ERC7984Restricted} from "../../token/ERC7984/extensions/ERC7984Restricted.sol";
 
-abstract contract ERC7984RestrictedMock is ERC7984Restricted, SepoliaConfig {
+abstract contract ERC7984RestrictedMock is ERC7984Restricted, EthereumConfig {
     function _mint(address to, uint64 amount) internal {
         _mint(to, FHE.asEuint64(amount));
     }
diff --git a/contracts/mocks/utils/FHESafeMathMock.sol b/contracts/mocks/utils/FHESafeMathMock.sol
@@ -1,11 +1,11 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.27;
 
-import {SepoliaConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
+import {EthereumConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
 import {FHE, ebool, euint64, externalEuint64} from "@fhevm/solidity/lib/FHE.sol";
 import {FHESafeMath} from "./../../utils/FHESafeMath.sol";
 
-contract FHESafeMathMock is SepoliaConfig {
+contract FHESafeMathMock is EthereumConfig {
     event HandleCreated(euint64 amount);
     event ResultComputed(ebool success, euint64 updated);
 
diff --git a/contracts/mocks/utils/HandleAccessManagerMock.sol b/contracts/mocks/utils/HandleAccessManagerMock.sol
@@ -1,11 +1,11 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.24;
 
-import {SepoliaConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
+import {EthereumConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
 import {FHE, euint64} from "@fhevm/solidity/lib/FHE.sol";
 import {HandleAccessManager} from "./../../utils/HandleAccessManager.sol";
 
-contract HandleAccessManagerMock is HandleAccessManager, SepoliaConfig {
+contract HandleAccessManagerMock is HandleAccessManager, EthereumConfig {
     event HandleCreated(euint64 handle);
 
     function _validateHandleAllowance(bytes32 handle) internal view override {}
diff --git a/contracts/mocks/utils/HandleAccessManagerUserMock.sol b/contracts/mocks/utils/HandleAccessManagerUserMock.sol
@@ -1,11 +1,11 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.24;
 
-import {SepoliaConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
+import {EthereumConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
 import {Impl} from "@fhevm/solidity/lib/FHE.sol";
 import {HandleAccessManager} from "./../../utils/HandleAccessManager.sol";
 
-contract HandleAccessManagerUserMock is SepoliaConfig {
+contract HandleAccessManagerUserMock is EthereumConfig {
     function getTransientAllowance(HandleAccessManager allowance, bytes32 handle) public {
         allowance.getHandleAllowance(handle, address(this), false);
         require(Impl.isAllowed(handle, address(this)), "HandleAccessManagerUserMock: Not allowed");
diff --git a/contracts/token/ERC7984/ERC7984.sol b/contracts/token/ERC7984/ERC7984.sol
@@ -32,6 +32,9 @@ abstract contract ERC7984 is IERC7984, ERC165 {
     string private _symbol;
     string private _contractURI;
 
+    /// @dev Emitted when an encrypted amount `encryptedAmount` is requested for disclosure by `requester`.
+    event AmountDiscloseRequested(euint64 indexed encryptedAmount, address indexed requester);
+
     /// @dev The given receiver `receiver` is invalid for transfers.
     error ERC7984InvalidReceiver(address receiver);
 
@@ -196,42 +199,39 @@ abstract contract ERC7984 is IERC7984, ERC165 {
     }
 
     /**
-     * @dev Discloses an encrypted amount `encryptedAmount` publicly via an {IERC7984-AmountDisclosed}
-     * event. The caller and this contract must be authorized to use the encrypted amount on the ACL.
+     * @dev Starts the process to disclose an encrypted amount `encryptedAmount` publicly by making it
+     * publicly decryptable. Emits the {AmountDiscloseRequested} event.
      *
-     * NOTE: This is an asynchronous operation where the actual decryption happens off-chain and
-     * {finalizeDiscloseEncryptedAmount} is called with the result.
+     * NOTE: Both `msg.sender` and `address(this)` must have permission to access the encrypted amount
+     * `encryptedAmount` to request disclosure of the encrypted amount `encryptedAmount`.
      */
-    function discloseEncryptedAmount(euint64 encryptedAmount) public virtual {
+    function requestDiscloseEncryptedAmount(euint64 encryptedAmount) public virtual {
         require(
             FHE.isAllowed(encryptedAmount, msg.sender),
             ERC7984UnauthorizedUseOfEncryptedAmount(encryptedAmount, msg.sender)
         );
 
-        bytes32[] memory cts = new bytes32[](1);
-        cts[0] = euint64.unwrap(encryptedAmount);
-        FHE.requestDecryption(cts, this.finalizeDiscloseEncryptedAmount.selector);
+        FHE.makePubliclyDecryptable(encryptedAmount);
+        emit AmountDiscloseRequested(encryptedAmount, msg.sender);
     }
 
     /**
-     * @dev Finalizes a disclose encrypted amount request.
-     * For gas saving purposes, the `requestId` might not be related to a
-     * {discloseEncryptedAmount} request. As a result, the current {finalizeDiscloseEncryptedAmount}
-     * function might emit a disclosed amount related to another decryption request context.
-     * In this case it would only display public information
-     * since the handle would have already been allowed for public decryption through a previous
-     * `FHE.requestDecryption` call.
-     * The downside of this behavior is that a {finalizeDiscloseEncryptedAmount} watcher might observe
-     * unexpected `AmountDisclosed` events.
+     * @dev Publicly discloses an encrypted value with a given decryption proof. Emits the {AmountDisclosed} event.
+     *
+     * NOTE: May not be tied to a prior request via {requestDiscloseEncryptedAmount}.
      */
-    function finalizeDiscloseEncryptedAmount(
-        uint256 requestId,
-        bytes calldata cleartexts,
+    function discloseEncryptedAmount(
+        euint64 encryptedAmount,
+        uint64 cleartextAmount,
         bytes calldata decryptionProof
     ) public virtual {
-        FHE.checkSignatures(requestId, cleartexts, decryptionProof);
-        euint64 requestHandle = euint64.wrap(FHE.loadRequestedHandles(requestId)[0]);
-        emit AmountDisclosed(requestHandle, abi.decode(cleartexts, (uint64)));
+        bytes32[] memory handles = new bytes32[](1);
+        handles[0] = euint64.unwrap(encryptedAmount);
+
+        bytes memory cleartextMemory = abi.encode(cleartextAmount);
+
+        FHE.verifySignatures(handles, cleartextMemory, decryptionProof);
+        emit AmountDisclosed(encryptedAmount, cleartextAmount);
     }
 
     function _setOperator(address holder, address operator, uint48 until) internal virtual {
diff --git a/contracts/token/ERC7984/extensions/ERC7984ERC20Wrapper.sol b/contracts/token/ERC7984/extensions/ERC7984ERC20Wrapper.sol
@@ -24,8 +24,12 @@ abstract contract ERC7984ERC20Wrapper is ERC7984, IERC1363Receiver {
     uint8 private immutable _decimals;
     uint256 private immutable _rate;
 
-    /// @dev Mapping from gateway decryption request ID to the address that will receive the tokens
-    mapping(uint256 decryptionRequest => address) private _receivers;
+    mapping(euint64 unwrapAmount => address recipient) private _unwrapRequests;
+
+    event UnwrapRequested(address indexed receiver, euint64 amount);
+    event UnwrapFinalized(address indexed receiver, euint64 encryptedAmount, uint64 cleartextAmount);
+
+    error InvalidUnwrapRequest(euint64 amount);
 
     constructor(IERC20 underlying_) {
         _underlying = underlying_;
@@ -102,8 +106,7 @@ abstract contract ERC7984ERC20Wrapper is ERC7984, IERC1363Receiver {
      * @dev Unwraps tokens from `from` and sends the underlying tokens to `to`. The caller must be `from`
      * or be an approved operator for `from`. `amount * rate()` underlying tokens are sent to `to`.
      *
-     * NOTE: This is an asynchronous function and waits for decryption to be completed off-chain before disbursing
-     * tokens.
+     * NOTE: The unwrap request created by this function must be finalized by calling {finalizeUnwrap}.
      * NOTE: The caller *must* already be approved by ACL for the given `amount`.
      */
     function unwrap(address from, address to, euint64 amount) public virtual {
@@ -124,20 +127,26 @@ abstract contract ERC7984ERC20Wrapper is ERC7984, IERC1363Receiver {
         _unwrap(from, to, FHE.fromExternal(encryptedAmount, inputProof));
     }
 
-    /**
-     * @dev Fills an unwrap request for a given request id related to a decrypted unwrap amount.
-     */
+    /// @dev Fills an unwrap request for a given cipher-text `burntAmount` with the `cleartextAmount` and `decryptionProof`.
     function finalizeUnwrap(
-        uint256 requestID,
-        bytes calldata cleartexts,
+        euint64 burntAmount,
+        uint64 burntAmountCleartext,
         bytes calldata decryptionProof
     ) public virtual {
-        FHE.checkSignatures(requestID, cleartexts, decryptionProof);
-        address to = _receivers[requestID];
-        require(to != address(0), ERC7984InvalidGatewayRequest(requestID));
-        delete _receivers[requestID];
+        address to = _unwrapRequests[burntAmount];
+        require(to != address(0), InvalidUnwrapRequest(burntAmount));
+        delete _unwrapRequests[burntAmount];
+
+        bytes32[] memory handles = new bytes32[](1);
+        handles[0] = euint64.unwrap(burntAmount);
+
+        bytes memory cleartexts = abi.encode(burntAmountCleartext);
+
+        FHE.verifySignatures(handles, cleartexts, decryptionProof);
+
+        SafeERC20.safeTransfer(underlying(), to, burntAmountCleartext * rate());
 
-        SafeERC20.safeTransfer(underlying(), to, abi.decode(cleartexts, (uint64)) * rate());
+        emit UnwrapFinalized(to, burntAmount, burntAmountCleartext);
     }
 
     function _unwrap(address from, address to, euint64 amount) internal virtual {
@@ -146,14 +155,12 @@ abstract contract ERC7984ERC20Wrapper is ERC7984, IERC1363Receiver {
 
         // try to burn, see how much we actually got
         euint64 burntAmount = _burn(from, amount);
+        FHE.makePubliclyDecryptable(burntAmount);
 
-        // decrypt that burntAmount
-        bytes32[] memory cts = new bytes32[](1);
-        cts[0] = euint64.unwrap(burntAmount);
-        uint256 requestID = FHE.requestDecryption(cts, this.finalizeUnwrap.selector);
+        assert(_unwrapRequests[burntAmount] == address(0));
+        _unwrapRequests[burntAmount] = to;
 
-        // register who is getting the tokens
-        _receivers[requestID] = to;
+        emit UnwrapRequested(to, burntAmount);
     }
 
     /**
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/test/helpers/accounts.ts b/test/helpers/accounts.ts
diff --git a/test/token/ERC7984/ERC7984.test.ts b/test/token/ERC7984/ERC7984.test.ts
diff --git a/test/token/ERC7984/extensions/ERC7984Wrapper.test.ts b/test/token/ERC7984/extensions/ERC7984Wrapper.test.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'openzeppelin-confidential-contracts': minor
 +---
++
 +Migrate FHEVM contracts from v0.8 to v0.9