Merge pull request #35 from code-423n4/feature/deploy-token-sale

add TokenSale to deploy script

Author: HickupHH3

scripts/config.ts

@@ -1,5 +1,5 @@
 import {BigNumber as BN, constants} from 'ethers';
-import {ONE_DAY, ONE_YEAR} from '../test/shared/Constants';
+import {ONE_18, ONE_DAY, ONE_YEAR} from '../test/shared/Constants';
 
 type Config = {
   FREE_SUPPLY: BN;
@@ -9,9 +9,38 @@ type Config = {
   VEST_DURATION: number;
   MERKLE_ROOT: string;
   TIMELOCK_DELAY: number;
+  TOKEN_SALE_START: number;
+  TOKEN_SALE_DURATION: number;
+  TOKEN_SALE_USDC: string;
+  TOKEN_SALE_ARENA_PRICE: BN;
+  TOKEN_SALE_RECIPIENT: string;
+  TOKEN_SALE_WHITELIST: typeof TOKEN_SALE_WHITELIST;
   EXPORT_FILENAME: string;
 };
 
+const TOKEN_SALE_WHITELIST = [
+  {buyer: '0x0f4Aeb1847B7F1a735f4a5Af7E8C299b793c1a9A', arenaAmount: BN.from(`10000`).mul(ONE_18)},
+  {buyer: '0x3Ab0029e1C4515134464b267557cB80A39902699', arenaAmount: BN.from(`10001`).mul(ONE_18)},
+  {buyer: '0x4F3F7ca7E91D869180EBbA55e4322845a8Dc6862', arenaAmount: BN.from(`10002`).mul(ONE_18)},
+  {buyer: '0x5dcEb6f4dc5b64Af6271A5Ab3297DbE3C01dd57B', arenaAmount: BN.from(`10003`).mul(ONE_18)},
+  {buyer: '0x62641eAE546835813B56EC7b544756A532275Dd3', arenaAmount: BN.from(`10004`).mul(ONE_18)},
+  {buyer: '0x670f9e8B37d5816c2eB93A1D94841C66652a8E26', arenaAmount: BN.from(`10005`).mul(ONE_18)},
+  {buyer: '0x691Cbab55CC1806d29994784Ba9d9e679c03f164', arenaAmount: BN.from(`10006`).mul(ONE_18)},
+  {buyer: '0x697ccd97C8419EBba7347CEF03a0CD02804EbF54', arenaAmount: BN.from(`10007`).mul(ONE_18)},
+  {buyer: '0x6c422839E7EceDb6d2A86F3F2bFd03aDd154Fc27', arenaAmount: BN.from(`10008`).mul(ONE_18)},
+  {buyer: '0x7C0fb88c87c30eBF70340E25fe47763e53b907cF', arenaAmount: BN.from(`10009`).mul(ONE_18)},
+  {buyer: '0x8498EAb53e03E3143d77B2303eDBdAC6C9041D33', arenaAmount: BN.from(`10010`).mul(ONE_18)},
+  {buyer: '0x8D31BAC0870e323354eAF6F98277860772FFB2d4', arenaAmount: BN.from(`10011`).mul(ONE_18)},
+  {buyer: '0xA432F83d8054F5F859cAcb86574baC5e07DD6529', arenaAmount: BN.from(`10012`).mul(ONE_18)},
+  {buyer: '0xD3488b8C87416946D82CC957178B0863A1F089b2', arenaAmount: BN.from(`10013`).mul(ONE_18)},
+  {buyer: '0xD5388291EAbe96b56069440C97046791E2F72573', arenaAmount: BN.from(`10014`).mul(ONE_18)},
+  {buyer: '0xF20eb7eAf52712EA0Aa80467741f34E6b0dB18F8', arenaAmount: BN.from(`10015`).mul(ONE_18)},
+  {buyer: '0xa1fA3C686C9c4E5e8407b32B67191B079a65ffD2', arenaAmount: BN.from(`10016`).mul(ONE_18)},
+  {buyer: '0xbB79597641483Ed96BCE9fc24b4D63F720898b8A', arenaAmount: BN.from(`10017`).mul(ONE_18)},
+  {buyer: '0xe552C6A88E71B2A5069Dec480507F54321Dc65F3', arenaAmount: BN.from(`10018`).mul(ONE_18)},
+  {buyer: '0xf4290941dBc8b31c277E30deFF3fC59979FC6757', arenaAmount: BN.from(`10019`).mul(ONE_18)},
+];
+
 export const allConfigs: {[key: number]: Config} = {
   // rinkeby
   4: {
@@ -22,6 +51,12 @@ export const allConfigs: {[key: number]: Config} = {
     VEST_DURATION: 4 * ONE_DAY,
     MERKLE_ROOT: '0xd97c9a423833d78e0562b8ed2d14752b54e7ef9b52314cafb197e3a339299901',
     TIMELOCK_DELAY: 1800, // 30 mins
+    TOKEN_SALE_START: Math.floor(new Date(`2021-12-27T13:16:00.000Z`).getTime() / 1000),
+    TOKEN_SALE_DURATION: 14 * ONE_DAY,
+    TOKEN_SALE_USDC: '0x2791bca1f2de4661ed88a30c99a7a9449aa84174', // USDC 6 decimals
+    TOKEN_SALE_ARENA_PRICE: BN.from(30_000).mul(ONE_18).div(ONE_18), // 0.03 USDC * 1e18 / 1.0 ARENA
+    TOKEN_SALE_RECIPIENT: '0x670f9e8B37d5816c2eB93A1D94841C66652a8E26', // TODO: change this to real recipient
+    TOKEN_SALE_WHITELIST,
     EXPORT_FILENAME: 'rinkebyAddresses.json',
   },
   // polygon mainnet
@@ -33,6 +68,12 @@ export const allConfigs: {[key: number]: Config} = {
     VEST_DURATION: 4 * ONE_YEAR,
     MERKLE_ROOT: '0x0', // TODO: edit value
     TIMELOCK_DELAY: 2 * ONE_DAY, // 2 days (same as ENS)
+    TOKEN_SALE_START: Math.floor(new Date(`2021-12-27T13:50:00.000Z`).getTime() / 1000),
+    TOKEN_SALE_DURATION: 14 * ONE_DAY,
+    TOKEN_SALE_USDC: '0x2791bca1f2de4661ed88a30c99a7a9449aa84174',
+    TOKEN_SALE_ARENA_PRICE: BN.from(30_000).mul(ONE_18).div(ONE_18), // 0.03 USDC * 1e18 / 1.0 ARENA
+    TOKEN_SALE_RECIPIENT: '0x670f9e8B37d5816c2eB93A1D94841C66652a8E26',
+    TOKEN_SALE_WHITELIST,
     EXPORT_FILENAME: 'polygonAddresses.json',
   },
 };

scripts/deploy.ts

@@ -1,4 +1,5 @@
 import {task} from 'hardhat/config';
+import {BigNumber as BN} from 'ethers';
 import {expect} from 'chai';
 import fs from 'fs';
 
@@ -11,6 +12,8 @@ import {
   TimelockController,
   ArenaGovernor__factory,
   ArenaGovernor,
+  TokenSale__factory,
+  TokenSale,
 } from '../typechain';
 
 import {allConfigs} from './config';
@@ -20,6 +23,7 @@ let token: ArenaToken;
 let revokableTokenLock: RevokableTokenLock;
 let timelock: TimelockController;
 let governor: ArenaGovernor;
+let tokenSale: TokenSale;
 
 // see OZ docs: https://docs.openzeppelin.com/contracts/4.x/api/governance#timelock-roles
 const ADMIN_ROLE = '0x5f58e3a2316349923ce3780f8d587db2d72378aed66a8261c916544fa6846ca5';
@@ -77,6 +81,21 @@ task('deploy', 'deploy contracts').setAction(async (taskArgs, hre) => {
   await governor.deployed();
   console.log(`governor address: ${governor.address}`);
 
+  console.log(`deploying tokensale...`);
+  const TokenSaleFactory = (await hre.ethers.getContractFactory('TokenSale')) as TokenSale__factory;
+  tokenSale = await TokenSaleFactory.deploy(
+    config.TOKEN_SALE_USDC,
+    token.address,
+    config.TOKEN_SALE_START,
+    config.TOKEN_SALE_DURATION,
+    config.TOKEN_SALE_ARENA_PRICE,
+    config.TOKEN_SALE_RECIPIENT,
+    revokableTokenLock.address,
+    config.VEST_DURATION
+  );
+  await tokenSale.deployed();
+  console.log(`tokensale address: ${tokenSale.address}`);
+
   // give governor proposer role
   // https://docs.openzeppelin.com/contracts/4.x/api/governance#timelock-proposer
   await timelock.grantRole(PROPOSER_ROLE, governor.address);
@@ -92,12 +111,25 @@ task('deploy', 'deploy contracts').setAction(async (taskArgs, hre) => {
 
   // set revoker role in TokenLock to timelock
   await revokableTokenLock.setRevoker(timelock.address);
+  // set token sale in TokenLock
+  await revokableTokenLock.setTokenSale(tokenSale.address);
 
   // transfer tokenlock admin role to timelock
   await revokableTokenLock.transferOwnership(timelock.address);
 
-  // transfer all tokens held by deployer to timelock
-  await token.transfer(timelock.address, config.FREE_SUPPLY);
+  // set up token sale whitelist
+  await tokenSale.changeWhiteList(
+    config.TOKEN_SALE_WHITELIST.map(({buyer}) => buyer),
+    config.TOKEN_SALE_WHITELIST.map(({arenaAmount}) => arenaAmount)
+  );
+  // transfer token sale admin role to timelock
+  await tokenSale.transferOwnership(timelock.address);
+
+  // transfer all tokens held by deployer to token sale and timelock
+  const TOKEN_SALE_SUPPLY = config.TOKEN_SALE_WHITELIST.reduce((sum, el) => sum.add(el.arenaAmount), BN.from(`0`));
+  console.log(`transferring ${TOKEN_SALE_SUPPLY.toString()} ARENA to TokenSale. Remaining back to Timelock`);
+  await token.transfer(tokenSale.address, TOKEN_SALE_SUPPLY);
+  await token.transfer(timelock.address, config.FREE_SUPPLY.sub(TOKEN_SALE_SUPPLY));
 
   // transfer token admin role to timelock
   await token.transferOwnership(timelock.address);
@@ -109,6 +141,7 @@ task('deploy', 'deploy contracts').setAction(async (taskArgs, hre) => {
     tokenLock: revokableTokenLock.address,
     timelock: timelock.address,
     governor: governor.address,
+    tokenSale: tokenSale.address,
   };
   let exportJson = JSON.stringify(addressesToExport, null, 2);
   fs.writeFileSync(config.EXPORT_FILENAME, exportJson);
@@ -136,6 +169,9 @@ task('deploy', 'deploy contracts').setAction(async (taskArgs, hre) => {
   // TokenLock revoker should be timelock
   expect(await revokableTokenLock.revoker()).to.be.eq(timelock.address);
 
+  // TokenLock token sale should be set
+  expect(await revokableTokenLock.tokenSale()).to.be.eq(tokenSale.address);
+
   // TokenLock owner should be timelock
   expect(await revokableTokenLock.owner()).to.be.eq(timelock.address);
 
@@ -145,6 +181,11 @@ task('deploy', 'deploy contracts').setAction(async (taskArgs, hre) => {
   // check Token's tokenlock has been set
   expect(await token.tokenLock()).to.be.eq(revokableTokenLock.address);
 
+  // check TokenSale's tokenlock has been set
+  expect(await tokenSale.tokenLock()).to.be.eq(revokableTokenLock.address);
+  // Token's owner should be timelock
+  expect(await tokenSale.owner()).to.be.eq(timelock.address);
+
   /////////////////////////
   // CONFIG VERIFICATION //
   /////////////////////////
@@ -153,8 +194,11 @@ task('deploy', 'deploy contracts').setAction(async (taskArgs, hre) => {
   // check ArenaToken's token balance == AIRDROP_SUPPLY
   expect(await token.balanceOf(token.address)).to.be.eq(config.AIRDROP_SUPPLY);
 
-  // check timelock's token balance == FREE_SUPPLY
-  expect(await token.balanceOf(timelock.address)).to.be.eq(config.FREE_SUPPLY);
+  // check timelock's token balance == TOKEN_SALE_SUPPLY
+  expect(await token.balanceOf(tokenSale.address)).to.be.eq(TOKEN_SALE_SUPPLY);
+
+  // check timelock's token balance == FREE_SUPPLY - TOKEN_SALE_SUPPLY (rest of it)
+  expect(await token.balanceOf(timelock.address)).to.be.eq(config.FREE_SUPPLY.sub(TOKEN_SALE_SUPPLY));
 
   // check timelock's minDelay
   expect(await timelock.getMinDelay()).to.be.eq(config.TIMELOCK_DELAY);

scripts/verify.ts

@@ -2,14 +2,15 @@ import {task} from 'hardhat/config';
 import {HardhatRuntimeEnvironment} from 'hardhat/types';
 import fs from 'fs';
 
-import {ArenaToken, RevokableTokenLock, TimelockController, ArenaGovernor} from '../typechain';
+import {ArenaToken, RevokableTokenLock, TimelockController, ArenaGovernor, TokenSale} from '../typechain';
 
 import {allConfigs} from './config';
 
 let token: ArenaToken;
 let revokableTokenLock: RevokableTokenLock;
 let timelock: TimelockController;
 let governor: ArenaGovernor;
+let tokenSale: TokenSale;
 
 task('verifyContracts', 'verify deployed contracts')
   .addParam('i', 'JSON file containing exported addresses')
@@ -21,6 +22,7 @@ task('verifyContracts', 'verify deployed contracts')
     revokableTokenLock = await hre.ethers.getContractAt('RevokableTokenLock', addresses['tokenLock']);
     timelock = await hre.ethers.getContractAt('TimelockController', addresses['timelock']);
     governor = await hre.ethers.getContractAt('ArenaGovernor', addresses['governor']);
+    tokenSale = await hre.ethers.getContractAt('TokenSale', addresses['tokenSale']);
 
     let config = allConfigs[networkId];
 
@@ -32,10 +34,19 @@ task('verifyContracts', 'verify deployed contracts')
       new Date(config.CLAIM_END_DATE).getTime() / 1000,
       config.VEST_DURATION,
     ]);
-
     await verifyContract(hre, revokableTokenLock.address, [token.address, addresses['deployer']]);
     await verifyContract(hre, timelock.address, [config.TIMELOCK_DELAY, [], []]);
     await verifyContract(hre, governor.address, [token.address, timelock.address]);
+    await verifyContract(hre, tokenSale.address, [
+      config.TOKEN_SALE_USDC,
+      token.address,
+      config.TOKEN_SALE_START,
+      config.TOKEN_SALE_DURATION,
+      config.TOKEN_SALE_ARENA_PRICE,
+      config.TOKEN_SALE_RECIPIENT,
+      revokableTokenLock.address,
+      config.VEST_DURATION,
+    ]);
     process.exit(0);
   });