updated immutable modules to use the forked version

GWSzeto · GWSzeto · commit 22ce6e88775f · 2024-09-25T08:31:54.000-04:00
diff --git a/dependecies/immutable/allowlist/OperatorAllowlistEnforced.sol b/dependecies/immutable/allowlist/OperatorAllowlistEnforced.sol
@@ -9,6 +9,25 @@ import {IOperatorAllowlist} from "./IOperatorAllowlist.sol";
 // Errors
 import {OperatorAllowlistEnforcementErrors} from "../errors/Errors.sol";
 
+library OperatorAllowlistEnforcedStorage {
+
+    /// @custom:storage-location erc7201:operator.allowlist.enforced
+    bytes32 public constant OPERATOR_ALLOWLIST_ENFORCED_STORAGE_POSITION =
+        keccak256(abi.encode(uint256(keccak256("operator.allowlist.enforced")) - 1)) & ~bytes32(uint256(0xff));
+
+    struct Data {
+        address operatorAllowlist;
+    }
+
+    function data() internal pure returns (Data storage data_) {
+        bytes32 position = OPERATOR_ALLOWLIST_ENFORCED_STORAGE_POSITION;
+        assembly {
+            data_.slot := position
+        }
+    }
+
+}
+
 interface IERC165 {
 
     function supportsInterface(bytes4 interfaceId) external view returns (bool);
@@ -36,17 +55,19 @@ abstract contract OperatorAllowlistEnforced is OperatorAllowlistEnforcementError
      * @param targetApproval the address of the approval target to be validated
      */
     modifier validateApproval(address targetApproval) {
+        IOperatorAllowlist _operatorAllowlist = IOperatorAllowlist(_operatorAllowlistStorage().operatorAllowlist);
+
         // Check for:
         // 1. approver is an EOA. Contract constructor is handled as transfers 'from' are blocked
         // 2. approver is address or bytecode is allowlisted
-        if (msg.sender.code.length != 0 && !operatorAllowlist.isAllowlisted(msg.sender)) {
+        if (msg.sender.code.length != 0 && !_operatorAllowlist.isAllowlisted(msg.sender)) {
             revert ApproverNotInAllowlist(msg.sender);
         }
 
         // Check for:
         // 1. approval target is an EOA
         // 2. approval target address is Allowlisted or target address bytecode is Allowlisted
-        if (targetApproval.code.length != 0 && !operatorAllowlist.isAllowlisted(targetApproval)) {
+        if (targetApproval.code.length != 0 && !_operatorAllowlist.isAllowlisted(targetApproval)) {
             revert ApproveTargetNotInAllowlist(targetApproval);
         }
         _;
@@ -59,27 +80,29 @@ abstract contract OperatorAllowlistEnforced is OperatorAllowlistEnforcementError
      * @param to the address of the to target to be validated
      */
     modifier validateTransfer(address from, address to) {
+        IOperatorAllowlist _operatorAllowlist = IOperatorAllowlist(_operatorAllowlistStorage().operatorAllowlist);
+
         // Check for:
         // 1. caller is an EOA
         // 2. caller is Allowlisted or is the calling address bytecode is Allowlisted
         if (
             msg.sender != tx.origin // solhint-disable-line avoid-tx-origin
-                && !operatorAllowlist.isAllowlisted(msg.sender)
+                && !_operatorAllowlist.isAllowlisted(msg.sender)
         ) {
             revert CallerNotInAllowlist(msg.sender);
         }
 
         // Check for:
         // 1. from is an EOA
         // 2. from is Allowlisted or from address bytecode is Allowlisted
-        if (from.code.length != 0 && !operatorAllowlist.isAllowlisted(from)) {
+        if (from.code.length != 0 && !_operatorAllowlist.isAllowlisted(from)) {
             revert TransferFromNotInAllowlist(from);
         }
 
         // Check for:
         // 1. to is an EOA
         // 2. to is Allowlisted or to address bytecode is Allowlisted
-        if (to.code.length != 0 && !operatorAllowlist.isAllowlisted(to)) {
+        if (to.code.length != 0 && !_operatorAllowlist.isAllowlisted(to)) {
             revert TransferToNotInAllowlist(to);
         }
         _;
@@ -96,8 +119,17 @@ abstract contract OperatorAllowlistEnforced is OperatorAllowlistEnforcementError
             revert AllowlistDoesNotImplementIOperatorAllowlist();
         }
 
-        emit OperatorAllowlistRegistryUpdated(address(operatorAllowlist), _operatorAllowlist);
-        operatorAllowlist = IOperatorAllowlist(_operatorAllowlist);
+        emit OperatorAllowlistRegistryUpdated(_operatorAllowlistStorage().operatorAllowlist, _operatorAllowlist);
+        _operatorAllowlistStorage().operatorAllowlist = _operatorAllowlist;
+    }
+
+    /// @notice Get the current operator allowlist registry address
+    function operatorAllowlist() external view returns (address) {
+        return _operatorAllowlistStorage().operatorAllowlist;
+    }
+
+    function _operatorAllowlistStorage() internal pure returns (OperatorAllowlistEnforcedStorage.Data storage) {
+        return OperatorAllowlistEnforcedStorage.data();
     }
 
 }
diff --git a/src/module/token/immutable/ImmutableAllowlistERC1155.sol b/src/module/token/immutable/ImmutableAllowlistERC1155.sol
@@ -4,30 +4,13 @@ pragma solidity ^0.8.20;
 import {Module} from "../../../Module.sol";
 import {Role} from "../../../Role.sol";
 
+import {
+    OperatorAllowlistEnforced,
+    OperatorAllowlistEnforcedStorage
+} from "../../../../dependecies/immutable/allowlist/OperatorAllowlistEnforced.sol";
 import {BeforeApproveForAllCallback} from "../../../callback/BeforeApproveForAllCallback.sol";
-
 import {BeforeBatchTransferCallbackERC1155} from "../../../callback/BeforeBatchTransferCallbackERC1155.sol";
 import {BeforeTransferCallbackERC1155} from "../../../callback/BeforeTransferCallbackERC1155.sol";
-import {OperatorAllowlistEnforced} from "@imtbl/contracts/allowlist/OperatorAllowlistEnforced.sol";
-
-library ImmutableAllowlistStorage {
-
-    /// @custom:storage-location erc7201:token.immutableallowlist
-    bytes32 public constant IMMUTABLE_ALLOWLIST_STORAGE_POSITION =
-        keccak256(abi.encode(uint256(keccak256("token.immutableAllowlist.ERC1155")) - 1)) & ~bytes32(uint256(0xff));
-
-    struct Data {
-        address operatorAllowlistRegistry;
-    }
-
-    function data() internal pure returns (Data storage data_) {
-        bytes32 position = IMMUTABLE_ALLOWLIST_STORAGE_POSITION;
-        assembly {
-            data_.slot := position
-        }
-    }
-
-}
 
 contract ImmutableAllowlistERC1155 is
     Module,
@@ -59,32 +42,20 @@ contract ImmutableAllowlistERC1155 is
         config.callbackFunctions = new CallbackFunction[](3);
         config.fallbackFunctions = new FallbackFunction[](2);
 
-        config.callbackFunctions[1] = CallbackFunction(this.beforeApproveForAll.selector);
-        config.callbackFunctions[2] = CallbackFunction(this.beforeTransferERC1155.selector);
-        config.callbackFunctions[3] = CallbackFunction(this.beforeBatchTransferERC1155.selector);
+        config.callbackFunctions[0] = CallbackFunction(this.beforeApproveForAll.selector);
+        config.callbackFunctions[1] = CallbackFunction(this.beforeTransferERC1155.selector);
+        config.callbackFunctions[2] = CallbackFunction(this.beforeBatchTransferERC1155.selector);
 
         config.fallbackFunctions[0] =
             FallbackFunction({selector: this.setOperatorAllowlistRegistry.selector, permissionBits: Role._MANAGER_ROLE});
-        config.fallbackFunctions[1] =
-            FallbackFunction({selector: this.getOperatorAllowlistRegistry.selector, permissionBits: 0});
+        config.fallbackFunctions[1] = FallbackFunction({selector: this.operatorAllowlist.selector, permissionBits: 0});
 
         config.requiredInterfaces = new bytes4[](1);
         config.requiredInterfaces[0] = 0x80ac58cd; // ERC1155
 
         config.registerInstallationCallback = true;
     }
 
-    /*//////////////////////////////////////////////////////////////
-                            MODIFIERS
-    //////////////////////////////////////////////////////////////*/
-
-    modifier isOperatorAllowlistSet() {
-        if (_immutableAllowlistStorage().operatorAllowlistRegistry == address(0)) {
-            revert OperatorAllowlistNotSet();
-        }
-        _;
-    }
-
     /*//////////////////////////////////////////////////////////////
                             CALLBACK FUNCTIONS
     //////////////////////////////////////////////////////////////*/
@@ -93,7 +64,6 @@ contract ImmutableAllowlistERC1155 is
     function beforeApproveForAll(address _from, address _to, bool _approved)
         external
         override
-        isOperatorAllowlistSet
         validateApproval(_to)
         returns (bytes memory)
     {}
@@ -102,7 +72,6 @@ contract ImmutableAllowlistERC1155 is
     function beforeTransferERC1155(address _from, address _to, uint256 _id, uint256 _value)
         external
         override
-        isOperatorAllowlistSet
         validateTransfer(_from, _to)
         returns (bytes memory)
     {}
@@ -111,15 +80,14 @@ contract ImmutableAllowlistERC1155 is
     function beforeBatchTransferERC1155(address _from, address _to, uint256[] calldata _ids, uint256[] calldata _values)
         external
         override
-        isOperatorAllowlistSet
         validateTransfer(_from, _to)
         returns (bytes memory)
     {}
 
     /// @dev Called by a Core into an Module during the installation of the Module.
     function onInstall(bytes calldata data) external {
         address registry = abi.decode(data, (address));
-        _immutableAllowlistStorage().operatorAllowlistRegistry = registry;
+        _setOperatorAllowlistRegistry(registry);
     }
 
     /// @dev Called by a Core into an Module during the uninstallation of the Module.
@@ -145,20 +113,7 @@ contract ImmutableAllowlistERC1155 is
 
     /// @notice Set the operator allowlist registry address
     function setOperatorAllowlistRegistry(address newRegistry) external {
-        _immutableAllowlistStorage().operatorAllowlistRegistry = newRegistry;
-    }
-
-    /// @notice Get the current operator allowlist registry address
-    function getOperatorAllowlistRegistry() external view returns (address) {
-        return _immutableAllowlistStorage().operatorAllowlistRegistry;
-    }
-
-    /*//////////////////////////////////////////////////////////////
-                            INTERNAL FUNCTIONS
-    //////////////////////////////////////////////////////////////*/
-
-    function _immutableAllowlistStorage() internal pure returns (ImmutableAllowlistStorage.Data storage) {
-        return ImmutableAllowlistStorage.data();
+        _setOperatorAllowlistRegistry(newRegistry);
     }
 
 }
diff --git a/src/module/token/immutable/ImmutableAllowlistERC721.sol b/src/module/token/immutable/ImmutableAllowlistERC721.sol
@@ -4,29 +4,13 @@ pragma solidity ^0.8.20;
 import {Module} from "../../../Module.sol";
 import {Role} from "../../../Role.sol";
 
+import {
+    OperatorAllowlistEnforced,
+    OperatorAllowlistEnforcedStorage
+} from "../../../../dependecies/immutable/allowlist/OperatorAllowlistEnforced.sol";
 import {BeforeApproveCallbackERC721} from "../../../callback/BeforeApproveCallbackERC721.sol";
 import {BeforeApproveForAllCallback} from "../../../callback/BeforeApproveForAllCallback.sol";
 import {BeforeTransferCallbackERC721} from "../../../callback/BeforeTransferCallbackERC721.sol";
-import {OperatorAllowlistEnforced} from "@imtbl/contracts/allowlist/OperatorAllowlistEnforced.sol";
-
-library ImmutableAllowlistStorage {
-
-    /// @custom:storage-location erc7201:token.immutableallowlist
-    bytes32 public constant IMMUTABLE_ALLOWLIST_STORAGE_POSITION =
-        keccak256(abi.encode(uint256(keccak256("token.immutableAllowlist.ERC721")) - 1)) & ~bytes32(uint256(0xff));
-
-    struct Data {
-        address operatorAllowlistRegistry;
-    }
-
-    function data() internal pure returns (Data storage data_) {
-        bytes32 position = IMMUTABLE_ALLOWLIST_STORAGE_POSITION;
-        assembly {
-            data_.slot := position
-        }
-    }
-
-}
 
 contract ImmutableAllowlistERC721 is
     Module,
@@ -64,26 +48,14 @@ contract ImmutableAllowlistERC721 is
 
         config.fallbackFunctions[0] =
             FallbackFunction({selector: this.setOperatorAllowlistRegistry.selector, permissionBits: Role._MANAGER_ROLE});
-        config.fallbackFunctions[1] =
-            FallbackFunction({selector: this.getOperatorAllowlistRegistry.selector, permissionBits: 0});
+        config.fallbackFunctions[1] = FallbackFunction({selector: this.operatorAllowlist.selector, permissionBits: 0});
 
         config.requiredInterfaces = new bytes4[](1);
         config.requiredInterfaces[0] = 0x80ac58cd; // ERC721
 
         config.registerInstallationCallback = true;
     }
 
-    /*//////////////////////////////////////////////////////////////
-                            MODIFIERS
-    //////////////////////////////////////////////////////////////*/
-
-    modifier isOperatorAllowlistSet() {
-        if (_immutableAllowlistStorage().operatorAllowlistRegistry == address(0)) {
-            revert OperatorAllowlistNotSet();
-        }
-        _;
-    }
-
     /*//////////////////////////////////////////////////////////////
                             CALLBACK FUNCTIONS
     //////////////////////////////////////////////////////////////*/
@@ -92,7 +64,6 @@ contract ImmutableAllowlistERC721 is
     function beforeApproveERC721(address _from, address _to, uint256 _tokenId, bool _approve)
         external
         override
-        isOperatorAllowlistSet
         validateApproval(_to)
         returns (bytes memory)
     {}
@@ -101,7 +72,6 @@ contract ImmutableAllowlistERC721 is
     function beforeApproveForAll(address _from, address _to, bool _approved)
         external
         override
-        isOperatorAllowlistSet
         validateApproval(_to)
         returns (bytes memory)
     {}
@@ -110,15 +80,14 @@ contract ImmutableAllowlistERC721 is
     function beforeTransferERC721(address _from, address _to, uint256 _tokenId)
         external
         override
-        isOperatorAllowlistSet
         validateTransfer(_from, _to)
         returns (bytes memory)
     {}
 
     /// @dev Called by a Core into an Module during the installation of the Module.
     function onInstall(bytes calldata data) external {
         address registry = abi.decode(data, (address));
-        _immutableAllowlistStorage().operatorAllowlistRegistry = registry;
+        _setOperatorAllowlistRegistry(registry);
     }
 
     /// @dev Called by a Core into an Module during the uninstallation of the Module.
@@ -144,20 +113,7 @@ contract ImmutableAllowlistERC721 is
 
     /// @notice Set the operator allowlist registry address
     function setOperatorAllowlistRegistry(address newRegistry) external {
-        _immutableAllowlistStorage().operatorAllowlistRegistry = newRegistry;
-    }
-
-    /// @notice Get the current operator allowlist registry address
-    function getOperatorAllowlistRegistry() external view returns (address) {
-        return _immutableAllowlistStorage().operatorAllowlistRegistry;
-    }
-
-    /*//////////////////////////////////////////////////////////////
-                            INTERNAL FUNCTIONS
-    //////////////////////////////////////////////////////////////*/
-
-    function _immutableAllowlistStorage() internal pure returns (ImmutableAllowlistStorage.Data storage) {
-        return ImmutableAllowlistStorage.data();
+        _setOperatorAllowlistRegistry(newRegistry);
     }
 
 }
