@openzeppelin/confidential-contracts 0.5.0-rc.0 → 0.5.0

package/token/ERC7984/extensions/ERC7984Rwa.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Confidential Contracts (last updated v0.5.0-rc.0) (token/ERC7984/extensions/ERC7984Rwa.sol)
+// OpenZeppelin Confidential Contracts (last updated v0.5.0) (token/ERC7984/extensions/ERC7984Rwa.sol)
 
 pragma solidity ^0.8.27;
 
@@ -257,7 +257,7 @@ abstract contract ERC7984Rwa is IERC7984Rwa, ERC7984Freezable, ERC7984Restricted
         return super._update(from, to, encryptedAmount);
     }
 
-    /// @dev Bypasses {ERC7984Restricted} `from` restriction check when performing a {forceConfidentialTransferFrom}.
+    /// @dev Bypasses {ERC7984Restricted} `from` restriction check when performing a forced transfer or token recovery.
     function _checkSenderRestriction(address account) internal view override {
         if (_isForceTransfer(msg.sig)) {
             return;
@@ -265,6 +265,14 @@ abstract contract ERC7984Rwa is IERC7984Rwa, ERC7984Freezable, ERC7984Restricted
         super._checkSenderRestriction(account);
     }
 
+    /// @dev Bypasses {ERC7984Restricted} `to` restriction check when performing a forced transfer or token recovery.
+    function _checkRecipientRestriction(address account) internal view override {
+        if (_isForceTransfer(msg.sig)) {
+            return;
+        }
+        super._checkRecipientRestriction(account);
+    }
+
     /// @dev Bypasses {Pausable} check when performing a {forceConfidentialTransferFrom}.
     function _requireNotPaused() internal view override {
         if (_isForceTransfer(msg.sig)) {
@@ -280,4 +288,14 @@ abstract contract ERC7984Rwa is IERC7984Rwa, ERC7984Freezable, ERC7984Restricted
             selector == 0x44fd6e40 || // bytes4(keccak256("forceConfidentialTransferFrom(address,address,bytes32)"))
             selector == this.recoverAddress.selector;
     }
+
+    /// @dev Restrict overrides of {Context._msgSender}. Please use other account abstraction methods instead.
+    function _msgSender() internal view override returns (address) {
+        return super._msgSender();
+    }
+
+    /// @dev Restrict overrides of {Context._msgData}. Please use other account abstraction methods instead.
+    function _msgData() internal view override returns (bytes calldata) {
+        return super._msgData();
+    }
 }

package/token/ERC7984/utils/ERC7984BalanceCapHookModule.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Confidential Contracts (last updated v0.5.0-rc.0) (token/ERC7984/utils/ERC7984BalanceCapHookModule.sol)
+// OpenZeppelin Confidential Contracts (last updated v0.5.0) (token/ERC7984/utils/ERC7984BalanceCapHookModule.sol)
 
 pragma solidity ^0.8.27;
 
@@ -56,22 +56,23 @@ contract ERC7984BalanceCapHookModule is ERC7984HookModule {
         address from,
         address to,
         euint64 encryptedAmount
-    ) internal override returns (ebool) {
-        ebool compliant;
-        if (to == address(0) || from == to || !FHE.isInitialized(maxBalance(token))) {
-            compliant = FHE.asEbool(true);
-        } else {
+    ) internal override returns (ebool result) {
+        // super call
+        result = super._preTransfer(token, from, to, encryptedAmount);
+
+        // in non trivial cases, check (and document) compliance.
+        if (to != address(0) && to != from && FHE.isInitialized(maxBalance(token))) {
             euint64 balance = IERC7984Rwa(token).confidentialBalanceOf(to);
             _accessHandle(token, balance);
 
             // Note, if the balance would result in an overflow, transfer will fail due to total supply overflow.
             (, euint64 futureBalance) = FHESafeMath.tryIncrease(balance, encryptedAmount);
-            compliant = FHE.le(futureBalance, maxBalance(token));
-        }
+            ebool compliant = FHE.le(futureBalance, maxBalance(token));
+            _emitPreTransferResults(token, from, to, encryptedAmount, compliant, bytes32(0));
 
-        _emitPreTransferResults(token, from, to, encryptedAmount, compliant, bytes32(0));
-
-        return FHE.and(compliant, super._preTransfer(token, from, to, encryptedAmount));
+            // integrate this module compliance result into the super result.
+            result = FHE.and(result, compliant);
+        }
     }
 
     /**
@@ -83,10 +84,4 @@ contract ERC7984BalanceCapHookModule is ERC7984HookModule {
         (externalEuint64 maxBalance_, bytes memory inputProof) = abi.decode(initData, (externalEuint64, bytes));
         _setMaxBalance(token, FHE.fromExternal(maxBalance_, inputProof));
     }
-
-    /// @inheritdoc ERC7984HookModule
-    function _onUninstall(address token, bytes calldata deinitData) internal virtual override {
-        super._onUninstall(token, deinitData);
-        _maxBalances[token] = euint64.wrap(0);
-    }
 }

package/token/ERC7984/utils/ERC7984HolderCapHookModule.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Confidential Contracts (last updated v0.5.0-rc.0) (token/ERC7984/utils/ERC7984HolderCapHookModule.sol)
+// OpenZeppelin Confidential Contracts (last updated v0.5.0) (token/ERC7984/utils/ERC7984HolderCapHookModule.sol)
 
 pragma solidity ^0.8.27;
 
@@ -64,31 +64,32 @@ contract ERC7984HolderCapHookModule is ERC7984HookModule {
         address from,
         address to,
         euint64 encryptedAmount
-    ) internal override returns (ebool) {
-        if (to == address(0) || to == from) {
-            return FHE.asEbool(true);
+    ) internal override returns (ebool result) {
+        result = super._preTransfer(token, from, to, encryptedAmount);
+
+        // in non trivial cases, check compliance.
+        if (to != address(0) && to != from) {
+            euint64 fromBalance = IERC7984Rwa(token).confidentialBalanceOf(from);
+            euint64 toBalance = IERC7984Rwa(token).confidentialBalanceOf(to);
+
+            _accessHandle(token, fromBalance);
+            _accessHandle(token, toBalance);
+
+            euint64 encryptedZero = FHE.asEuint64(0);
+
+            // note, if from is address(0):
+            // - fromBalance is an encrypted zero
+            // - from will be (erroneously) removed from the holder count only encryptedAmount is a zero
+            // that is fine because if encryptedAmount is a zero, then this value is dropped anyway.
+            euint64 adjustedHolderCount = FHE.add(
+                FHE.sub(holderCount(token), FHE.asEuint64(FHE.eq(fromBalance, encryptedAmount))),
+                FHE.asEuint64(FHE.and(FHE.eq(toBalance, encryptedZero), FHE.ne(encryptedAmount, encryptedZero)))
+            );
+            ebool compliant = FHE.le(adjustedHolderCount, maxHolderCount(token));
+
+            // integrate this module compliance result into the super result.
+            result = FHE.and(result, compliant);
         }
-
-        euint64 fromBalance = IERC7984Rwa(token).confidentialBalanceOf(from);
-        euint64 toBalance = IERC7984Rwa(token).confidentialBalanceOf(to);
-
-        _accessHandle(token, fromBalance);
-        _accessHandle(token, toBalance);
-
-        euint64 encryptedZero = FHE.asEuint64(0);
-
-        // note, if from is address(0):
-        // - fromBalance is an encrypted zero
-        // - from will be (erroneously) removed from the holder count only encryptedAmount is a zero
-        // that is fine because if encryptedAmount is a zero, then this value is dropped anyway.
-        euint64 adjustedHolderCount = FHE.add(
-            FHE.sub(holderCount(token), FHE.asEuint64(FHE.eq(fromBalance, encryptedAmount))),
-            FHE.asEuint64(FHE.and(FHE.eq(toBalance, encryptedZero), FHE.ne(encryptedAmount, encryptedZero)))
-        );
-
-        ebool compliant = FHE.le(adjustedHolderCount, maxHolderCount(token));
-
-        return FHE.and(compliant, super._preTransfer(token, from, to, encryptedAmount));
     }
 
     /// @inheritdoc ERC7984HookModule
@@ -130,16 +131,11 @@ contract ERC7984HolderCapHookModule is ERC7984HookModule {
             !FHE.isInitialized(IERC7984Rwa(token).confidentialTotalSupply()),
             ERC7984HolderCapHookModuleTotalSupplyInitialized()
         );
+        _holderCounts[token] = euint64.wrap(0);
 
         super._onInstall(token, initData);
 
         uint64 maxHolderCount_ = abi.decode(initData, (uint64));
         _setMaxHolderCount(token, maxHolderCount_);
     }
-
-    function _onUninstall(address token, bytes calldata deinitData) internal virtual override {
-        super._onUninstall(token, deinitData);
-        delete _maxHolderCounts[token];
-        _holderCounts[token] = euint64.wrap(0);
-    }
 }

package/token/ERC7984/utils/ERC7984HookModule.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Confidential Contracts (last updated v0.5.0-rc.0) (token/ERC7984/utils/ERC7984HookModule.sol)
+// OpenZeppelin Confidential Contracts (last updated v0.5.0) (token/ERC7984/utils/ERC7984HookModule.sol)
 
 pragma solidity ^0.8.27;
 
@@ -18,14 +18,6 @@ abstract contract ERC7984HookModule is IERC7984HookModule, ERC165 {
     /// @dev The caller `user` does not have access to the encrypted amount `amount`.
     error ERC7984HookModuleUnauthorizedUseOfEncryptedAmount(euint64 amount, address user);
 
-    /// @dev The module is already installed for the given token.
-    error ERC7984HookModuleAlreadyInstalled(address token);
-
-    /// @dev The module is not installed for the given token.
-    error ERC7984HookModuleNotInstalled(address token);
-
-    mapping(address token => bool) private _installed;
-
     /// @inheritdoc IERC7984HookModule
     function preTransfer(address from, address to, euint64 encryptedAmount) public virtual returns (ebool) {
         require(
@@ -48,18 +40,9 @@ abstract contract ERC7984HookModule is IERC7984HookModule, ERC165 {
 
     /// @inheritdoc IERC7984HookModule
     function onInstall(bytes calldata initData) public virtual {
-        require(!_isModuleInstalled(msg.sender), ERC7984HookModuleAlreadyInstalled(msg.sender));
-
         _onInstall(msg.sender, initData);
     }
 
-    /// @inheritdoc IERC7984HookModule
-    function onUninstall(bytes calldata deinitData) public virtual {
-        require(_isModuleInstalled(msg.sender), ERC7984HookModuleNotInstalled(msg.sender));
-
-        _onUninstall(msg.sender, deinitData);
-    }
-
     /// @inheritdoc ERC165
     function supportsInterface(bytes4 interfaceId) public view virtual override(ERC165, IERC165) returns (bool) {
         return interfaceId == type(IERC7984HookModule).interfaceId || super.supportsInterface(interfaceId);
@@ -67,19 +50,9 @@ abstract contract ERC7984HookModule is IERC7984HookModule, ERC165 {
 
     /**
      * @dev Internal function which may be overridden by the derived contract to perform actions
-     * when the module is installed.
+     * when the module is installed. Should clean up dirty state from possible previous installations.
      */
-    function _onInstall(address token, bytes calldata /* initData */) internal virtual {
-        _installed[token] = true;
-    }
-
-    /**
-     * @dev Internal function which may be overridden by the derived contract to perform actions
-     * when the module is uninstalled.
-     */
-    function _onUninstall(address token, bytes calldata /* deinitData */) internal virtual {
-        delete _installed[token];
-    }
+    function _onInstall(address /* token */, bytes calldata /* initData */) internal virtual {}
 
     /**
      * @dev Internal function which runs before a transfer. Transient access is already granted to the module
@@ -111,18 +84,6 @@ abstract contract ERC7984HookModule is IERC7984HookModule, ERC165 {
         // default to no-op
     }
 
-    /**
-     * @dev Check if the module is installed for the given token. The default implementation reads from
-     * an internal storage flag maintained by {onInstall} and {onUninstall}. Derived contracts may override
-     * to extend the check, but should typically rely on the default behavior.
-     *
-     * NOTE: This function should use internal storage to check if the module is installed for the given token.
-     * Do not use external storage like {ERC7984Hooked-isModuleInstalled}.
-     */
-    function _isModuleInstalled(address token) internal view virtual returns (bool) {
-        return _installed[token];
-    }
-
     /// @dev Allow modules to get access to token handles during transaction.
     function _getTokenHandleAllowance(address token, euint64 handle) internal virtual {
         _getTokenHandleAllowance(token, handle, false);

package/utils/FHESafeMath.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Confidential Contracts (last updated v0.5.0-rc.0) (utils/FHESafeMath.sol)
+// OpenZeppelin Confidential Contracts (last updated v0.5.0) (utils/FHESafeMath.sol)
 pragma solidity ^0.8.24;
 
 import {FHE, ebool, euint64} from "@fhevm/solidity/lib/FHE.sol";

package/utils/HandleAccessManager.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Confidential Contracts (last updated v0.5.0-rc.0) (utils/HandleAccessManager.sol)
+// OpenZeppelin Confidential Contracts (last updated v0.5.0) (utils/HandleAccessManager.sol)
 pragma solidity ^0.8.26;
 
 import {Impl} from "@fhevm/solidity/lib/Impl.sol";

package/utils/structs/CheckpointsConfidential.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Confidential Contracts (last updated v0.5.0-rc.0) (utils/structs/CheckpointsConfidential.sol)
+// OpenZeppelin Confidential Contracts (last updated v0.5.0) (utils/structs/CheckpointsConfidential.sol)
 // This file was procedurally generated from scripts/generate/templates/CheckpointsConfidential.js.
 
 pragma solidity ^0.8.24;