HUBS-224 crowdsale with individual locking staking periods

.env.example

@@ -26,15 +26,15 @@ PRICEFEED_ADDRESS=0x2279B7A0a67DB372996a5FaB50D91eAA73d2eBe6
 TERMS_ACCEPTED_PERMISSIONER_ADDRESS=0x8A791620dd6260079BF849Dc5567aDC3F2FdC318
 
 TOKENIZER_ADDRESS=0xB7f8BC63BbcaD18155201308C8f3540b07f84F5e
-STAKED_LOCKING_CROWDSALE_ADDRESS=0x0B306BF915C4d645ff596e518fAf3F9669b97016
+#iptoken implementation=0x0DCd1Bf9A1b36cE34237eEaFef220932846BCD82
 
-USDC6_ADDRESS=0x68B1D87F95878fE05B998F19b66F4baba5De1aed
-WETH_ADDRESS=0x4ed7c70F96B99c776995fB64377f0d4aB3B0e1C1
-PLAIN_CROWDSALE_ADDRESS=0x7a2088a1bFc9d81c55368AE168C2C02570cB814F
+#timelocked token implementation=0x0B306BF915C4d645ff596e518fAf3F9669b97016
+STAKED_LOCKING_CROWDSALE_ADDRESS=0x959922bE3CAee4b8Cd9a407cc3ac1C251C2007B1
 
-#this is created during the tokenizer deployment
-IPTOKEN_IMPLEMENTATION_ADDRESS=0x0DCd1Bf9A1b36cE34237eEaFef220932846BCD82
+USDC6_ADDRESS=0x3Aa5ebB10DC797CAC828524e59A333d0A371443c
+WETH_ADDRESS=0x322813Fd9A801c5507c9de605d63CEA4f2CE6c44
+PLAIN_CROWDSALE_ADDRESS=0x09635F643e140090A9A8Dcd712eD6285858ceBef
 
 #these are generated when running the fixture scripts
 IPTS_ADDRESS=0x8dAF17A20c9DBA35f005b6324F493785D239719d
-LOCKED_IPTS_ADDRESS=0x16eBC21B3d38Db5e3EE1a022bEBA8Ec87D4CDbe6
+LOCKED_IPTS_ADDRESS=0x24B3c7704709ed1491473F30393FFc93cFB0FC34

README.md

@@ -46,7 +46,12 @@ Deprecated after migrating to Defender 2 (was 0x3D30452c48F2448764d5819a9A2b684A
 | Terms Permissioner | 0xC05D649368d8A5e2E98CAa205d47795de5fCB599 | <a href="https://sepolia.etherscan.io/address/0xC05D649368d8A5e2E98CAa205d47795de5fCB599#code" target="_blank"><img width="200" height="45" src="https://badges.thirdweb.com/contract?address=0xC05D649368d8A5e2E98CAa205d47795de5fCB599&theme=dark&chainId=1" alt="View contract" /></a> |
 | Tokenizer          | 0xca63411FF5187431028d003eD74B57531408d2F9 | <a href="https://sepolia.etherscan.io/address/0xca63411FF5187431028d003eD74B57531408d2F9#code" target="_blank"><img width="200" height="45" src="https://badges.thirdweb.com/contract?address=0xca63411FF5187431028d003eD74B57531408d2F9&theme=dark&chainId=1" alt="View contract" /></a> |
 | Crowdsale          | 0x8cA737E2cdaE1Ceb332bEf7ba9eA711a3a2f8037 | <a href="https://sepolia.etherscan.io/address/0x8cA737E2cdaE1Ceb332bEf7ba9eA711a3a2f8037#code" target="_blank"><img width="200" height="45" src="https://badges.thirdweb.com/contract?address=0x8cA737E2cdaE1Ceb332bEf7ba9eA711a3a2f8037&theme=dark&chainId=1" alt="View contract" /></a> |
-| Staked Crowdsale   | 0xd1cE2EA7d3b0C9cAB025A4aD762FC00315141ad7 | <a href="https://sepolia.etherscan.io/address/0xd1cE2EA7d3b0C9cAB025A4aD762FC00315141ad7#code" target="_blank"><img width="200" height="45" src="https://badges.thirdweb.com/contract?address=0xd1cE2EA7d3b0C9cAB025A4aD762FC00315141ad7&theme=dark&chainId=1" alt="View contract" /></a> |
+| Locking Crowdsale          | 0x67D8ed102E2168A46FA342e39A5f7D16c103Bd0d | <a href="https://sepolia.etherscan.io/address/0x67D8ed102E2168A46FA342e39A5f7D16c103Bd0d#code" target="_blank"><img width="200" height="45" src="https://badges.thirdweb.com/contract?address=0x67D8ed102E2168A46FA342e39A5f7D16c103Bd0d&theme=dark&chainId=1" alt="View contract" /></a> |
+| Staked Crowdsale   | 0xd1cE2EA7d3b0C9cAB025A4aD762FC00315141ad7 | <a href="https://sepolia.etherscan.io/address/0xd1cE2EA7d3b0C9cAB025A4aD762FC00315141ad7#code" target="_blank"><img width="200" height="45" src="https://badges.thirdweb.com/contract?address=0xd1cE2EA7d3b0C9cAB025A4aD762FC00315141ad7&theme=dark&chainId=11155111" alt="View contract" /></a> |
+
+
+timelocked token implementation=0xF8F79c1E02387b0Fc9DE0945cD9A2c06F127D851  
+~~new staked crowdsale (not used yet HUBS-224) 0x7eeb7113f90893fb95c6666e3930235850f2bc6A)~~
 
 #### Subgraphs
 
@@ -204,6 +209,9 @@ The crowdsale computation model can be tried out here: <https://docs.google.com/
 Deploying and verifying a single contract without the help of any script
 `forge create --rpc-url $RPC_URL --private-key $PRIVATE_KEY --chain 5 --etherscan-api-key $ETHERSCAN_API_KEY --verify src/crowdsale/StakedLockingCrowdSale.sol:StakedLockingCrowdSale`
 
+Verifying a the staked crowdsale crowdsale
+`forge verify-contract --chain-id=11155111 --etherscan-api-key=$ETHERSCAN_API_KEY --constructor-args $(cast abi-encode "constructor(address)" 0xF8F79c1E02387b0Fc9DE0945cD9A2c06F127D851) 0x7eeb7113f90893fb95c6666e3930235850f2bc6A src/crowdsale/StakedLockingCrowdSale.sol:StakedLockingCrowdSale`
+
 ### Deploying (vested) test tokens
 
 To test staked / vested token interactions, you need some test tokens. Here are 2 convenient script to get them running:

script/DeployTokenizer.s.sol

@@ -11,6 +11,7 @@ import { BioPriceFeed } from "../src/BioPriceFeed.sol";
 import { IPermissioner, TermsAcceptedPermissioner } from "../src/Permissioner.sol";
 import { CrowdSale } from "../src/crowdsale/CrowdSale.sol";
 import { StakedLockingCrowdSale } from "../src/crowdsale/StakedLockingCrowdSale.sol";
+import { TimelockedToken } from "../src/TimelockedToken.sol";
 
 contract DeployTokenizerInfrastructure is Script {
     function run() public {
@@ -27,13 +28,16 @@ contract DeployTokenizerInfrastructure is Script {
         tokenizer.setIPTokenImplementation(initialIpTokenImplementation);
 
         CrowdSale crowdSale = new CrowdSale();
-        StakedLockingCrowdSale stakedLockingCrowdSale = new StakedLockingCrowdSale();
+        //this allows the default TimelockedToken implementation to be verified on chain explorers
+        TimelockedToken timelockedTokenImplementation = new TimelockedToken();
+        StakedLockingCrowdSale stakedLockingCrowdSale = new StakedLockingCrowdSale(timelockedTokenImplementation);
         vm.stopBroadcast();
 
         console.log("TERMS_ACCEPTED_PERMISSIONER_ADDRESS=%s", address(permissioner));
         console.log("TOKENIZER_ADDRESS=%s", address(tokenizer));
         console.log("CROWDSALE_ADDRESS=%s", address(crowdSale));
         console.log("STAKED_LOCKING_CROWDSALE_ADDRESS=%s", address(stakedLockingCrowdSale));
+        console.log("timelocked token implementation=%s", address(timelockedTokenImplementation));
         console.log("initial IP Token implementation=%s", address(initialIpTokenImplementation));
     }
 }

script/dev/CrowdSale.s.sol

@@ -31,21 +31,19 @@ contract DeployCrowdSale is CommonScript {
     }
 }
 
-/**
- * @title deploy crowdSale
- * @author
- */
 contract DeployStakedCrowdSale is CommonScript {
     function run() public {
         prepareAddresses();
         vm.startBroadcast(deployer);
-        StakedLockingCrowdSale stakedLockingCrowdSale = new StakedLockingCrowdSale();
-
+        TimelockedToken lockingCrowdsaleImplementation = new TimelockedToken();
+        StakedLockingCrowdSale stakedLockingCrowdSale = new StakedLockingCrowdSale(lockingCrowdsaleImplementation);
+
         TokenVesting vestedDaoToken = TokenVesting(vm.envAddress("VDAO_TOKEN_ADDRESS"));
         vestedDaoToken.grantRole(vestedDaoToken.ROLE_CREATE_SCHEDULE(), address(stakedLockingCrowdSale));
         stakedLockingCrowdSale.trustVestingContract(vestedDaoToken);
         vm.stopBroadcast();
 
+        console.log("timelocked token implementation=%s", address(lockingCrowdsaleImplementation));
         console.log("STAKED_LOCKING_CROWDSALE_ADDRESS=%s", address(stakedLockingCrowdSale));
     }
 }
@@ -154,7 +152,7 @@ contract FixtureStakedCrowdSale is FixtureCrowdSale {
     function startSale() internal override returns (uint256 saleId) {
         Sale memory _sale = prepareRun();
         vm.startBroadcast(bob);
-        saleId = _slCrowdSale.startSale(_sale, daoToken, vestedDaoToken, 1e18, 7 days);
+        saleId = _slCrowdSale.startSale(_sale, daoToken, vestedDaoToken, 1e18, 7 days, 7 days);
         vm.stopBroadcast();
     }
 

script/dev/SignTermsMessage.s.sol

@@ -6,7 +6,7 @@ import "forge-std/console.sol";
 import "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
 
 contract SignTermsMessage is Script {
-    function run() public {
+    function run() public view {
         uint256 pk = vm.envUint("PRIVATE_KEY");
         string memory terms =
             "As an IP token holder of IPNFT #10, I accept all terms that I've read here: ipfs://bafkreigk5dvqblnkdniges6ft5kmuly47ebw4vho6siikzmkaovq6sjstq\n\nChain Id: 31337\nVersion: 1";

script/dev/Tokenizer.s.sol

@@ -25,7 +25,7 @@ contract DeployTokenizer is CommonScript {
 
         vm.stopBroadcast();
         console.log("TOKENIZER_ADDRESS=%s", address(tokenizer));
-        console.log("IPTOKEN_IMPLEMENTATION_ADDRESS=%s", address(initialIpTokenImplementation));
+        console.log("iptoken implementation=%s", address(initialIpTokenImplementation));
     }
 }
 

script/prod/RolloutV25Sale.sol

@@ -0,0 +1,51 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.18;
+
+import "forge-std/Script.sol";
+import "forge-std/console.sol";
+import { ERC1967Proxy } from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
+import { IPNFT } from "../../src/IPNFT.sol";
+import { IPermissioner, TermsAcceptedPermissioner } from "../../src/Permissioner.sol";
+import { StakedLockingCrowdSale } from "../../src/crowdsale/StakedLockingCrowdSale.sol";
+import { LockingCrowdSale, ITrustedLockingContracts } from "../../src/crowdsale/LockingCrowdSale.sol";
+import { TimelockedToken } from "../../src/TimelockedToken.sol";
+
+contract RolloutV25Sale is Script {
+    function run() public {
+        address moleculeDevMultisig = 0xCfA0F84660fB33bFd07C369E5491Ab02C449f71B;
+        vm.startBroadcast();
+
+        TimelockedToken timelockedTokenImplementation = new TimelockedToken();
+        StakedLockingCrowdSale stakedLockingCrowdSale = new StakedLockingCrowdSale(timelockedTokenImplementation);
+        stakedLockingCrowdSale.transferOwnership(moleculeDevMultisig);
+        vm.stopBroadcast();
+
+        console.log("STAKED_LOCKING_CROWDSALE_ADDRESS=%s", address(stakedLockingCrowdSale));
+        console.log("timelocked token implementation=%s", address(timelockedTokenImplementation));
+        // 0x7c36c64DA1c3a2065074caa9C48e7648FB733aAB
+        // vestedDaoToken.grantRole(vestedDaoToken.ROLE_CREATE_SCHEDULE(), address(stakedLockingCrowdSale));
+        // stakedLockingCrowdSale.trustVestingContract(vestedDaoToken);
+    }
+}
+
+contract RolloutV25LockingSale is Script {
+    function run() public {
+        //mainnet 0xCfA0F84660fB33bFd07C369E5491Ab02C449f71B;
+        address moleculeDevMultisig = 0x9d5a6ae551f1117946FF6e0e86ef9A1B20C90Cb0;
+
+        ITrustedLockingContracts stakedLockingCrowdsale = ITrustedLockingContracts(0xd1cE2EA7d3b0C9cAB025A4aD762FC00315141ad7);
+        TimelockedToken timelockedTokenImplementation = TimelockedToken(0xF8F79c1E02387b0Fc9DE0945cD9A2c06F127D851); 
+
+        vm.startBroadcast();
+        LockingCrowdSale lockingCrowdsale = new LockingCrowdSale(timelockedTokenImplementation);
+        lockingCrowdsale.trustLockingContractSource(stakedLockingCrowdsale);
+        lockingCrowdsale.transferOwnership(moleculeDevMultisig);
+        vm.stopBroadcast();
+
+        console.log("LOCKING_CROWDSALE_ADDRESS=%s", address(lockingCrowdsale));
+        //console.log("timelocked token implementation=%s", address(timelockedTokenImplementation));
+        // 0x7c36c64DA1c3a2065074caa9C48e7648FB733aAB
+        // vestedDaoToken.grantRole(vestedDaoToken.ROLE_CREATE_SCHEDULE(), address(stakedLockingCrowdSale));
+        // stakedLockingCrowdSale.trustVestingContract(vestedDaoToken);
+    }
+}

setupLocal.sh

@@ -9,6 +9,14 @@ set +a
 fixtures=false
 extrafixtures=false
 
+show_help() {
+    echo "Usage: setupLocal.sh [OPTION]"
+    echo "Sets up the local environment for the IPNFT contracts."
+    echo "Options:"
+    echo "  -f  also runs basic fixture scripts"
+    echo "  -x  also runs extra fixture scripts (crowdsales)"
+}
+
 # Parse command-line options
 while getopts "fx" opt; do
   case ${opt} in

src/crowdsale/LockingCrowdSale.sol

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.18;
 
+import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import { IERC20Metadata } from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";
@@ -12,6 +13,7 @@ import { CrowdSale, Sale } from "./CrowdSale.sol";
 error UnsupportedInitializer();
 error InvalidDuration();
 
+
 /**
  * @title LockingCrowdSale
  * @author molecule.to
@@ -25,16 +27,30 @@ contract LockingCrowdSale is CrowdSale {
     /// @notice map from token address to reusable TimelockedToken contracts
     mapping(address => TimelockedToken) public lockingContracts;
 
-    address immutable lockingTokenImplementation = address(new TimelockedToken());
+    address immutable public TIMELOCKED_TOKEN_IMPLEMENTATION;
 
     event Started(uint256 indexed saleId, address indexed issuer, Sale sale, TimelockedToken lockingToken, uint256 lockingDuration, uint16 feeBp);
     event LockingContractCreated(TimelockedToken indexed lockingContract, IERC20Metadata indexed underlyingToken);
 
+    constructor(TimelockedToken _timelockedTokenImplementation) {
+        TIMELOCKED_TOKEN_IMPLEMENTATION = address(_timelockedTokenImplementation);
+    }
+
     /// @dev disable parent sale starting functions
     function startSale(Sale calldata) public pure override returns (uint256) {
         revert UnsupportedInitializer();
     }
 
+    /**
+     * @notice allows the owner to trust a timelocked token contract for a specific underlying token so it's not registered again.
+     * 
+     * @param token the underlying token
+     * @param _lockingContract the timelocked token contract to trust
+     */
+    function trustLockingContract(IERC20 token, TimelockedToken _lockingContract) public onlyOwner {
+        lockingContracts[address(token)] = _lockingContract;
+    }
+
     /**
      * @notice allows anyone to create a timelocked token that's controlled by this sale contract
      *         helpful if you want to reuse the timelocked token for your own custom schedules
@@ -114,7 +130,7 @@ contract LockingCrowdSale is CrowdSale {
      * @return lockedTokenContract address of the new timelocked token contract
      */
     function _makeNewLockedTokenContract(IERC20Metadata auctionToken) private returns (TimelockedToken lockedTokenContract) {
-        lockedTokenContract = TimelockedToken(Clones.clone(lockingTokenImplementation));
+        lockedTokenContract = TimelockedToken(Clones.clone(TIMELOCKED_TOKEN_IMPLEMENTATION));
         lockedTokenContract.initialize(auctionToken);
         emit LockingContractCreated(lockedTokenContract, auctionToken);
     }