Merge pull request #149 from moleculeprotocol/feature/eip-1167

Revisit EIP1167 for IPNFT Tokenization

Author: elmariachi111

.env.example

@@ -1,4 +1,5 @@
 RPC_URL="http://127.0.0.1:8545"
+MAINNET_RPC_URL=
 #RPC_URL="https://goerli.infura.io/v3/<your infura key>"
 INUFRA_KEY=
 ETHERSCAN_API_KEY=

.github/workflows/test.yml

@@ -34,12 +34,14 @@ jobs:
         id: build
 
       - name: Run Forge tests
+        env:
+          MAINNET_RPC_URL: ${{ secrets.MAINNET_RPC_URL }}
         run: |
           forge test -vvv
         id: test
 
       - name: Run Hardhat tests
-        run: yarn hardhat test --network hardhat
+        run: yarn test
 
       # - name: Run Slither
       #   uses: crytic/[email protected]

README.md

@@ -18,7 +18,9 @@ IP-NFTs allow their users to tokenize intellectual property. This repo contains
 
 - Subgraph: <https://api.thegraph.com/subgraphs/name/moleculeprotocol/ip-nft-mainnet>
 
-tokenizer implementation 2: 0x9C70FA8c87D7e94Fd63eeCCcA657D5c4224a36f3
+tokenizer implementation 1.2: 0xE8701330F196FeFe415b28dAA767AB076F42557A
+tokenizer implementation 1.1: 0x9C70FA8c87D7e94Fd63eeCCcA657D5c4224a36f3
+iptoken implementation: 0x9E4fc6E6d1A64e3429aB852d3CB31AD7aa06997A
 ipnft implementation 2.4: 0x6B179Dffac5E190c670176606f552cB792847f80
 
 Defender Relayer that signs off minting requests from our side:
@@ -37,11 +39,11 @@ Defender Relayer that signs off minting requests from our side:
 | Crowdsale              | [0x8c83DA72b4591bE526ca8C7cb848bC89c0e23373](https://goerli.etherscan.io/address/0x8c83DA72b4591bE526ca8C7cb848bC89c0e23373#code>) | <a href="https://thirdweb.com/goerli/0x8c83DA72b4591bE526ca8C7cb848bC89c0e23373?utm_source=contract_badge" target="_blank"><img width="200" height="45" src="https://badges.thirdweb.com/contract?address=0x8c83DA72b4591bE526ca8C7cb848bC89c0e23373&theme=dark&chainId=5" alt="View contract" /></a> |
 | StakedLockingCrowdSale | [0x46c3369dece07176ad7164906d3593aa4c126d35](https://goerli.etherscan.io/address/0x46c3369dece07176ad7164906d3593aa4c126d35#code)  | <a href="https://thirdweb.com/goerli/0x46c3369dece07176ad7164906d3593aa4c126d35?utm_source=contract_badge" target="_blank"><img width="200" height="45" src="https://badges.thirdweb.com/contract?address=0x46c3369dece07176ad7164906d3593aa4c126d35&theme=dark&chainId=5" alt="View contract" /></a> |
 | SignedMintAuthorizer   | [0x5e555eE24DB66825171Ac63EA614864987CEf1Af](https://goerli.etherscan.io/address/0x5e555eE24DB66825171Ac63EA614864987CEf1Af#code)  | <a href="https://thirdweb.com/goerli/0x5e555eE24DB66825171Ac63EA614864987CEf1Af?utm_source=contract_badge" target="_blank"><img width="200" height="45" src="https://badges.thirdweb.com/contract?address=0x5e555eE24DB66825171Ac63EA614864987CEf1Af&theme=dark&chainId=5" alt="View contract" /></a> |
+| IPToken Implementation | [0x38Ca0fEEc7cd48629f9388727bfA747859a6feE7](https://goerli.etherscan.io/address/0x38Ca0fEEc7cd48629f9388727bfA747859a6feE7#code)  | <a href="https://thirdweb.com/goerli/0x38Ca0fEEc7cd48629f9388727bfA747859a6feE7?utm_source=contract_badge" target="_blank"><img width="200" height="45" src="https://badges.thirdweb.com/contract?address=0x38Ca0fEEc7cd48629f9388727bfA747859a6feE7&theme=dark&chainId=5" alt="View contract" /></a> |
 
-- Subgraph: https://api.thegraph.com/subgraphs/name/moleculeprotocol/ip-nft-goerli>
+- Subgraph: https://api.thegraph.com/subgraphs/name/moleculeprotocol/ip-nft-goerli
 
-- Tokenizer: 0xb12494eeA6B992d0A1Db3C5423BE7a2d2337F58c (formerly known as Synthesizer)
-  Implementation: 0x64580CC2c28aaEd31B2DF9a154dA9620C690BDec (reinit 4)
+- Tokenizer Implementation 1.2: 0x18E5ae026CFC8020b2eDbA7050eA6144Fd313c02 (reinit 4) <https://goerli.etherscan.io/address/0x18E5ae026CFC8020b2eDbA7050eA6144Fd313c02#code>
 
 - Bio pricefeed: 0x8647dEFdEAAdF5448d021B364B2F17815aba4360
   <https://goerli.etherscan.io/address/0x8647defdeaadf5448d021b364b2f17815aba4360#code>

foundry.toml

@@ -3,10 +3,25 @@ src = 'src'
 out = 'out'
 libs = ['lib']
 test = 'test'
-cache_path  = 'cache_forge'
+cache_path = 'cache_forge'
 solc_version = "0.8.18"
-gas_reports = ["IPNFT", "IPNFTV2", "SchmackoSwap", "Tokenizer", "IPToken", "CrowdSale", "LockingCrowdSale", "StakedLockingCrowdSale", "TimelockedToken", "TermsAcceptedPermissioner", "SignedMintAuthorizer"]
-fs_permissions = [{ access = "read-write", path = "./SALEID.txt"}]
+gas_reports = [
+  "IPNFT",
+  "IPNFTV2",
+  "SchmackoSwap",
+  "Tokenizer",
+  "IPToken",
+  "CrowdSale",
+  "LockingCrowdSale",
+  "StakedLockingCrowdSale",
+  "TimelockedToken",
+  "TermsAcceptedPermissioner",
+  "SignedMintAuthorizer",
+]
+fs_permissions = [
+  { access = "read-write", path = "./SALEID.txt" },
+  { access = "read", path = "./out" },
+]
 
 [fmt]
 bracket_spacing = true
@@ -18,5 +33,5 @@ override_spacing = false
 
 [rpc_endpoints]
 optimism = "https://optimism-goerli.infura.io/v3/${INFURA_KEY}"
-goerli   = "https://goerli.infura.io/v3/${INFURA_KEY}"
-mainnet  = "https://mainnet.infura.io/v3/${INFURA_KEY}" 
+goerli = "https://goerli.infura.io/v3/${INFURA_KEY}"
+mainnet = "https://mainnet.infura.io/v3/${INFURA_KEY}"

lib/forge-std

@@ -1,6 +1,8 @@
 {
   "license": "MIT",
-  "scripts": {},
+  "scripts": {
+    "test": "hardhat test --network hardhat"
+  },
   "devDependencies": {
     "@nomicfoundation/hardhat-foundry": "^1.0.0",
     "@nomicfoundation/hardhat-network-helpers": "^1.0.6",

package.json

@@ -0,0 +1,16 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.18;
+
+import "forge-std/Script.sol";
+import "../src/IPToken.sol";
+
+contract DeployIPTokenImpl is Script {
+    function run() external {
+        vm.startBroadcast();
+        IPToken iptoken = new IPToken();
+        vm.stopBroadcast();
+
+        console.log("new ip token implementation at %s", address(iptoken));
+    }
+}

script/IPToken.s.sol

@@ -0,0 +1,24 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.18;
+
+import "forge-std/Script.sol";
+import { Tokenizer } from "../../src/Tokenizer.sol";
+import { IPToken } from "../../src/IPToken.sol";
+import { console } from "forge-std/console.sol";
+
+contract RolloutTokenizerV12 is Script {
+    function run() public {
+        vm.startBroadcast();
+
+        IPToken newIpTokenImplementation = new IPToken();
+        Tokenizer newTokenizerImplementation = new Tokenizer();
+
+        bytes memory upgradeCallData = abi.encodeWithSelector(Tokenizer.setIPTokenImplementation.selector, address(newIpTokenImplementation));
+
+        console.log("NEWTOKENIMPLEMENTATION=%s", address(newIpTokenImplementation));
+        console.log("NEWTOKENIZER=%s", address(newTokenizerImplementation));
+        console.logBytes(upgradeCallData);
+
+        vm.stopBroadcast();
+    }
+}

script/prod/RolloutTokenizerV12.s.sol

@@ -40,6 +40,10 @@ contract IPToken is ERC20BurnableUpgradeable, OwnableUpgradeable {
         _metadata = metadata_;
     }
 
+    constructor() {
+        _disableInitializers();
+    }
+
     modifier onlyIssuerOrOwner() {
         if (_msgSender() != _metadata.originalOwner && _msgSender() != owner()) {
             revert OnlyIssuerOrOwner();

src/IPToken.sol

@@ -11,10 +11,11 @@ import { IPNFT } from "./IPNFT.sol";
 
 error MustOwnIpnft();
 error AlreadyTokenized();
+error ZeroAddress();
 
-/// @title Tokenizer 1.1
+/// @title Tokenizer 1.2
 /// @author molecule.to
-/// @notice tokenizes an IPNFT to an ERC20 token (called IPT) and controls its supply.
+/// @notice tokenizes an IPNFT to an ERC20 token (called IPToken or IPT) and controls its supply.
 contract Tokenizer is UUPSUpgradeable, OwnableUpgradeable {
     event TokensCreated(
         uint256 indexed moleculesId,
@@ -27,15 +28,23 @@ contract Tokenizer is UUPSUpgradeable, OwnableUpgradeable {
         string symbol
     );
 
+    event IPTokenImplementationUpdated(IPToken indexed old, IPToken indexed _new);
+    event PermissionerUpdated(IPermissioner indexed old, IPermissioner indexed _new);
+
     IPNFT internal ipnft;
 
-    //this is the old term to keep the storage layout intact
+    /// @dev a map of all IPTs. We're staying with the the initial term "synthesized" to keep the storage layout intact
     mapping(uint256 => IPToken) public synthesized;
+
+    /// @dev not used, needed to ensure that storage slots are still in order after 1.1 -> 1.2, use ipTokenImplementation
     /// @custom:oz-upgrades-unsafe-allow state-variable-immutable
     address immutable tokenImplementation;
 
     /// @dev the permissioner checks if senders have agreed to legal requirements
-    IPermissioner permissioner;
+    IPermissioner public permissioner;
+
+    /// @notice the IPToken implementation this Tokenizer spawns
+    IPToken public ipTokenImplementation;
 
     /**
      * @param _ipnft the IPNFT contract
@@ -50,12 +59,28 @@ contract Tokenizer is UUPSUpgradeable, OwnableUpgradeable {
 
     /// @custom:oz-upgrades-unsafe-allow constructor
     constructor() {
-        tokenImplementation = address(new IPToken());
+        tokenImplementation = address(0);
         _disableInitializers();
     }
 
     /**
-     * @dev called after an upgrade to reinitialize a new permissioner impl. This is 4 for görli compatibility
+     * @notice sets the new implementation address of the IPToken
+     * @param _ipTokenImplementation address pointing to the new implementation
+     */
+    function setIPTokenImplementation(IPToken _ipTokenImplementation) external onlyOwner {
+        /*
+        could call some functions on old contract to make sure its tokenizer not another contract behind a proxy for safety
+        */
+        if (address(_ipTokenImplementation) == address(0)) {
+            revert ZeroAddress();
+        }
+
+        emit IPTokenImplementationUpdated(ipTokenImplementation, _ipTokenImplementation);
+        ipTokenImplementation = _ipTokenImplementation;
+    }
+
+    /**
+     * @dev called after an upgrade to reinitialize a new permissioner impl.
      * @param _permissioner the new TermsPermissioner
      */
     function reinit(IPermissioner _permissioner) public onlyOwner reinitializer(4) {
@@ -84,7 +109,7 @@ contract Tokenizer is UUPSUpgradeable, OwnableUpgradeable {
         }
 
         // https://github.com/OpenZeppelin/workshops/tree/master/02-contracts-clone
-        token = IPToken(Clones.clone(tokenImplementation));
+        token = IPToken(Clones.clone(address(ipTokenImplementation)));
         string memory name = string.concat("IP Tokens of IPNFT #", Strings.toString(ipnftId));
         token.initialize(name, tokenSymbol, TokenMetadata(ipnftId, _msgSender(), agreementCid));