Integrate Creator Token Standard into the Royalty Module (#132)

* Initialize CreatorTokenERC721 Extension

Signed-off-by: Aadam Debevec <[email protected]>

* add basic testing for CreatorTokenExtension

Signed-off-by: Aadam Debevec <[email protected]>

* add extension creatortoken 20/1155

Signed-off-by: Aadam Debevec <[email protected]>

* update extension creatortokenerc1155

Signed-off-by: Aadam Debevec <[email protected]>

* test suite for CreatorToker20/1155

Signed-off-by: Aadam Debevec <[email protected]>

* add batch transfer testing for 1155 and forge fmt

Signed-off-by: Aadam Debevec <[email protected]>

* change default evm_version back to london and create profile for cancun

Signed-off-by: Aadam Debevec <[email protected]>

* check evm version for creatortoken testing

Signed-off-by: Aadam Debevec <[email protected]>

* optimize loop in batchTransfer hook

Signed-off-by: Aadam Debevec <[email protected]>

* Integrated Creator Token Standard into Royalty Module

- forge install: creator-token-contracts
1.1.2
- forge install: creator-token-standards
v3.0.0
- forge install: PermitC
v1.0.0
- royalty modules to implement creator token standards
- added script to deploy creator token standard NFT
- updated foundry toml file
- checkpoint: made sure that all of the code has been ported over successfully
- all tests pass for ERC-1155 royalty
- tests pass for ERC721 and 1155 versions of the updated royalty modules
- removed instances of old creator token contracts

* updated based on PR feedback

* switched from uint96 to uint16

---------

Signed-off-by: Aadam Debevec <[email protected]>
Co-authored-by: Aadam Debevec <[email protected]>

Author: GWSzeto

.gitmodules

@@ -10,3 +10,12 @@
 [submodule "lib/ERC721A-Upgradeable"]
 	path = lib/ERC721A-Upgradeable
 	url = https://github.com/chiru-labs/ERC721A-Upgradeable
+[submodule "lib/creator-token-contracts"]
+	path = lib/creator-token-contracts
+	url = https://github.com/limitbreakinc/creator-token-contracts
+[submodule "lib/creator-token-standards"]
+	path = lib/creator-token-standards
+	url = https://github.com/limitbreakinc/creator-token-standards
+[submodule "lib/PermitC"]
+	path = lib/PermitC
+	url = https://github.com/limitbreakinc/PermitC

coverage.md

@@ -0,0 +1,21 @@
+Uncovered for src/module/token/royalty/RoyaltyERC1155.sol:
+- Function "encodeBytesOnUninstall" (location: source ID 105, line 166, chars 6329-6426, hits: 0)
+- Line (location: source ID 105, line 167, chars 6410-6419, hits: 0)
+- Statement (location: source ID 105, line 167, chars 6410-6419, hits: 0)
+- Branch (branch: 0, path: 1) (location: source ID 105, line 182, chars 6937-7182, hits: 0)
+- Branch (branch: 1, path: 1) (location: source ID 105, line 200, chars 7464-7917, hits: 0)
+- Line (location: source ID 105, line 211, chars 7871-7874, hits: 0)
+- Statement (location: source ID 105, line 211, chars 7871-7874, hits: 0)
+- Function "onUninstall" (location: source ID 105, line 229, chars 8450-8503, hits: 0)
+- Branch (branch: 2, path: 0) (location: source ID 105, line 286, chars 10597-10670, hits: 0)
+- Line (location: source ID 105, line 287, chars 10630-10659, hits: 0)
+- Statement (location: source ID 105, line 287, chars 10630-10659, hits: 0)
+- Function "getTransferValidationFunction" (location: source ID 105, line 307, chars 11282-11619, hits: 0)
+- Line (location: source ID 105, line 312, chars 11431-11581, hits: 0)
+- Statement (location: source ID 105, line 312, chars 11431-11581, hits: 0)
+- Line (location: source ID 105, line 317, chars 11591-11612, hits: 0)
+- Statement (location: source ID 105, line 317, chars 11591-11612, hits: 0)
+- Branch (branch: 3, path: 0) (location: source ID 105, line 332, chars 12045-12125, hits: 0)
+- Line (location: source ID 105, line 333, chars 12085-12114, hits: 0)
+- Statement (location: source ID 105, line 333, chars 12085-12114, hits: 0)
+- Statement (location: source ID 105, line 376, chars 13428-13454, hits: 0)

foundry.toml

@@ -14,6 +14,7 @@ gas_reports = [
   "ERC1155Core"
 ]
 ignored_warnings_from = ["node_modules", "lib", "test"]
+fs_permissions = [{ access = "read", path = "./"}]
 
 [fmt]
 line_length = 120

lib/PermitC

@@ -2,4 +2,6 @@ ds-test/=lib/forge-std/lib/ds-test/src/
 forge-std/=lib/forge-std/src/
 @solady/=lib/solady/src/
 @erc721a/=lib/erc721a/contracts/
-@erc721a-upgradeable/=lib/ERC721A-Upgradeable/contracts/
+@erc721a-upgradeable/=lib/ERC721A-Upgradeable/contracts/
+@limitbreak/creator-token-standards/=lib/creator-token-standards/src/
+@limitbreak/permit-c/=lib/PermitC/src/

lib/creator-token-contracts

@@ -1,32 +1,301 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {ModularModule} from "../../../ModularModule.sol";
+
 import {Role} from "../../../Role.sol";
-import {RoyaltyERC721} from "./RoyaltyERC721.sol";
 
-contract RoyaltyERC1155 is RoyaltyERC721 {
+import {BeforeBatchTransferCallbackERC1155} from "../../../callback/BeforeBatchTransferCallbackERC1155.sol";
+import {BeforeTransferCallbackERC1155} from "../../../callback/BeforeTransferCallbackERC1155.sol";
+import {IInstallationCallback} from "../../../interface/IInstallationCallback.sol";
+
+import {ICreatorToken} from "@limitbreak/creator-token-standards/interfaces/ICreatorToken.sol";
+
+import {ITransferValidator} from "@limitbreak/creator-token-standards/interfaces/ITransferValidator.sol";
+import {ITransferValidatorSetTokenType} from
+    "@limitbreak/creator-token-standards/interfaces/ITransferValidatorSetTokenType.sol";
+import {TOKEN_TYPE_ERC1155} from "@limitbreak/permit-c/Constants.sol";
+
+library RoyaltyStorage {
+
+    /// @custom:storage-location erc7201:token.royalty.ERC1155
+    bytes32 public constant ROYALTY_STORAGE_POSITION =
+        keccak256(abi.encode(uint256(keccak256("token.royalty.erc1155")) - 1)) & ~bytes32(uint256(0xff));
+
+    struct Data {
+        // default royalty info
+        RoyaltyERC1155.RoyaltyInfo defaultRoyaltyInfo;
+        // tokenId => royalty info
+        mapping(uint256 => RoyaltyERC1155.RoyaltyInfo) royaltyInfoForToken;
+        // the addresss of the transfer validator
+        address transferValidator;
+    }
+
+    function data() internal pure returns (Data storage data_) {
+        bytes32 position = ROYALTY_STORAGE_POSITION;
+        assembly {
+            data_.slot := position
+        }
+    }
+
+}
+
+contract RoyaltyERC1155 is
+    ModularModule,
+    IInstallationCallback,
+    BeforeTransferCallbackERC1155,
+    BeforeBatchTransferCallbackERC1155
+{
+
+    /*//////////////////////////////////////////////////////////////
+                                STRUCTS
+    //////////////////////////////////////////////////////////////*/
+
+    /**
+     *   @notice RoyaltyInfo struct to store royalty information.
+     *   @param recipient The address that will receive the royalty payment.
+     *   @param bps The percentage of a secondary sale that will be paid as royalty.
+     */
+    struct RoyaltyInfo {
+        address recipient;
+        uint16 bps;
+    }
+
+    /*//////////////////////////////////////////////////////////////
+                                EVENTS
+    //////////////////////////////////////////////////////////////*/
+
+    /// @notice Emitted when the default royalty info for a token is updated.
+    event DefaultRoyaltyUpdated(address indexed recipient, uint16 bps);
+
+    /// @notice Emitted when the royalty info for a specific NFT is updated.
+    event TokenRoyaltyUpdated(uint256 indexed tokenId, address indexed recipient, uint16 bps);
+
+    /// @notice Emitted when the transfer validator is updated.
+    event TransferValidatorUpdated(address oldValidator, address newValidator);
+
+    /*//////////////////////////////////////////////////////////////
+                               ERRORS
+    //////////////////////////////////////////////////////////////*/
+
+    /// @notice Emitted when royalty BPS exceeds 10,000.
+    error RoyaltyExceedsMaxBps();
+
+    /// @notice Revert with an error if the transfer validator is not valid
+    error InvalidTransferValidatorContract();
+
+    /*//////////////////////////////////////////////////////////////
+                               MODULE CONFIG
+    //////////////////////////////////////////////////////////////*/
 
     /// @notice Returns all implemented callback and module functions.
     function getModuleConfig() external pure virtual override returns (ModuleConfig memory config) {
-        config.fallbackFunctions = new FallbackFunction[](5);
+        config.callbackFunctions = new CallbackFunction[](2);
+        config.fallbackFunctions = new FallbackFunction[](8);
+
+        config.callbackFunctions[0] = CallbackFunction(this.beforeTransferERC1155.selector);
+        config.callbackFunctions[1] = CallbackFunction(this.beforeBatchTransferERC1155.selector);
 
         config.fallbackFunctions[0] = FallbackFunction({selector: this.royaltyInfo.selector, permissionBits: 0});
         config.fallbackFunctions[1] =
             FallbackFunction({selector: this.getDefaultRoyaltyInfo.selector, permissionBits: 0});
         config.fallbackFunctions[2] =
             FallbackFunction({selector: this.getRoyaltyInfoForToken.selector, permissionBits: 0});
         config.fallbackFunctions[3] =
-            FallbackFunction({selector: this.setDefaultRoyaltyInfo.selector, permissionBits: Role._MANAGER_ROLE});
+            FallbackFunction({selector: this.getTransferValidator.selector, permissionBits: 0});
         config.fallbackFunctions[4] =
+            FallbackFunction({selector: this.getTransferValidationFunction.selector, permissionBits: 0});
+        config.fallbackFunctions[5] =
+            FallbackFunction({selector: this.setDefaultRoyaltyInfo.selector, permissionBits: Role._MANAGER_ROLE});
+        config.fallbackFunctions[6] =
             FallbackFunction({selector: this.setRoyaltyInfoForToken.selector, permissionBits: Role._MANAGER_ROLE});
-
-        config.supportedInterfaces = new bytes4[](1);
-        config.supportedInterfaces[0] = 0x2a55205a; // IERC2981.
+        config.fallbackFunctions[7] =
+            FallbackFunction({selector: this.setTransferValidator.selector, permissionBits: Role._MANAGER_ROLE});
 
         config.requiredInterfaces = new bytes4[](1);
         config.requiredInterfaces[0] = 0xd9b67a26; // ERC1155
 
+        config.supportedInterfaces = new bytes4[](1);
+        config.supportedInterfaces[0] = 0x2a55205a; // IERC2981.
+
         config.registerInstallationCallback = true;
     }
 
+    /*//////////////////////////////////////////////////////////////
+                    Encode install / uninstall data
+    //////////////////////////////////////////////////////////////*/
+
+    /// @dev Returns bytes encoded install params, to be sent to `onInstall` function
+    function encodeBytesOnInstall(address royaltyRecipient, uint16 royaltyBps, address transferValidator)
+        external
+        pure
+        returns (bytes memory)
+    {
+        return abi.encode(royaltyRecipient, royaltyBps, transferValidator);
+    }
+
+    /// @dev Returns bytes encoded uninstall params, to be sent to `onUninstall` function
+    function encodeBytesOnUninstall() external pure returns (bytes memory) {
+        return "";
+    }
+
+    /*//////////////////////////////////////////////////////////////
+                            CALLBACK FUNCTIONS
+    //////////////////////////////////////////////////////////////*/
+
+    /// @notice Callback function for ERC1155.transferFrom/safeTransferFrom
+    function beforeTransferERC1155(address from, address to, uint256 _id, uint256 _value)
+        external
+        virtual
+        override
+        returns (bytes memory)
+    {
+        address transferValidator = getTransferValidator();
+        if (transferValidator != address(0)) {
+            ITransferValidator(transferValidator).validateTransfer(msg.sender, from, to, _id, _value);
+        }
+    }
+
+    function beforeBatchTransferERC1155(address from, address to, uint256[] calldata ids, uint256[] calldata values)
+        external
+        virtual
+        override
+        returns (bytes memory)
+    {
+        address transferValidator = getTransferValidator();
+        if (transferValidator != address(0)) {
+            uint256 length = ids.length;
+            for (uint256 i = 0; i < length; i++) {
+                ITransferValidator(transferValidator).validateTransfer(msg.sender, from, to, ids[i], values[i]);
+            }
+        }
+    }
+
+    /// @dev Called by a Core into an Module during the installation of the Module.
+    function onInstall(bytes calldata data) external {
+        (address royaltyRecipient, uint16 royaltyBps, address transferValidator) =
+            abi.decode(data, (address, uint16, address));
+        _setDefaultRoyaltyInfo(royaltyRecipient, royaltyBps);
+        _setTransferValidator(transferValidator);
+    }
+
+    /// @dev Called by a Core into an Module during the uninstallation of the Module.
+    function onUninstall(bytes calldata data) external {}
+
+    /*//////////////////////////////////////////////////////////////
+                            FALLBACK FUNCTIONS
+    //////////////////////////////////////////////////////////////*/
+
+    /// @notice Returns the royalty recipient and amount for a given sale.
+    function royaltyInfo(uint256 _tokenId, uint256 _salePrice)
+        external
+        view
+        virtual
+        returns (address receiver, uint256 royaltyAmount)
+    {
+        (address overrideRecipient, uint16 overrideBps) = getRoyaltyInfoForToken(_tokenId);
+        (address defaultRecipient, uint16 defaultBps) = getDefaultRoyaltyInfo();
+
+        receiver = overrideRecipient == address(0) ? defaultRecipient : overrideRecipient;
+
+        uint16 bps = overrideBps == 0 ? defaultBps : overrideBps;
+        royaltyAmount = (_salePrice * bps) / 10_000;
+    }
+
+    /// @notice Returns the overriden royalty info for a given token.
+    function getRoyaltyInfoForToken(uint256 _tokenId) public view returns (address, uint16) {
+        RoyaltyStorage.Data storage data = RoyaltyStorage.data();
+        RoyaltyInfo memory royaltyForToken = data.royaltyInfoForToken[_tokenId];
+
+        return (royaltyForToken.recipient, uint16(royaltyForToken.bps));
+    }
+
+    /// @notice Returns the default royalty info for a given token.
+    function getDefaultRoyaltyInfo() public view returns (address, uint16) {
+        RoyaltyInfo memory defaultRoyaltyInfo = RoyaltyStorage.data().defaultRoyaltyInfo;
+        return (defaultRoyaltyInfo.recipient, uint16(defaultRoyaltyInfo.bps));
+    }
+
+    /// @notice Sets the default royalty info for a given token.
+    function setDefaultRoyaltyInfo(address _royaltyRecipient, uint16 _royaltyBps) external {
+        _setDefaultRoyaltyInfo(_royaltyRecipient, _royaltyBps);
+    }
+
+    /// @notice Sets the royalty info for a specific NFT of a token collection.
+    function setRoyaltyInfoForToken(uint256 _tokenId, address _recipient, uint16 _bps) external {
+        if (_bps > 10_000) {
+            revert RoyaltyExceedsMaxBps();
+        }
+
+        RoyaltyStorage.data().royaltyInfoForToken[_tokenId] = RoyaltyInfo({recipient: _recipient, bps: _bps});
+
+        emit TokenRoyaltyUpdated(_tokenId, _recipient, _bps);
+    }
+
+    /// @notice Returns the transfer validator contract address for this token contract.
+    function getTransferValidator() public view returns (address validator) {
+        return _royaltyStorage().transferValidator;
+    }
+
+    /**
+     * @notice Returns the function selector for the transfer validator's validation function to be called
+     * @notice for transaction simulation.
+     */
+    function getTransferValidationFunction() external pure returns (bytes4 functionSignature, bool isViewFunction) {
+        functionSignature = bytes4(keccak256("validateTransfer(address,address,address,uint256,uint256)"));
+        isViewFunction = true;
+    }
+
+    function setTransferValidator(address validator) external {
+        _setTransferValidator(validator);
+    }
+
+    /*//////////////////////////////////////////////////////////////
+                            INTERNAL FUNCTIONS
+    //////////////////////////////////////////////////////////////*/
+
+    function _setDefaultRoyaltyInfo(address _royaltyRecipient, uint16 _royaltyBps) internal {
+        if (_royaltyBps > 10_000) {
+            revert RoyaltyExceedsMaxBps();
+        }
+
+        RoyaltyStorage.data().defaultRoyaltyInfo = RoyaltyInfo({recipient: _royaltyRecipient, bps: _royaltyBps});
+
+        emit DefaultRoyaltyUpdated(_royaltyRecipient, _royaltyBps);
+    }
+
+    function _setTransferValidator(address validator) internal {
+        bool isValidTransferValidator = validator.code.length > 0;
+
+        if (validator != address(0) && !isValidTransferValidator) {
+            revert InvalidTransferValidatorContract();
+        }
+
+        emit TransferValidatorUpdated(address(getTransferValidator()), validator);
+
+        _royaltyStorage().transferValidator = validator;
+        _registerTokenType(validator);
+    }
+
+    function _registerTokenType(address validator) internal {
+        if (validator != address(0)) {
+            uint256 validatorCodeSize;
+            assembly {
+                validatorCodeSize := extcodesize(validator)
+            }
+            if (validatorCodeSize > 0) {
+                try ITransferValidatorSetTokenType(validator).setTokenTypeOfCollection(address(this), _tokenType()) {}
+                    catch {}
+            }
+        }
+    }
+
+    function _tokenType() internal pure virtual returns (uint16 tokenType) {
+        return uint16(TOKEN_TYPE_ERC1155);
+    }
+
+    function _royaltyStorage() internal pure returns (RoyaltyStorage.Data storage) {
+        return RoyaltyStorage.data();
+    }
+
 }