albertlieyingadrian/multisig-liquidity-pool

Web3 implementation for an ICO (Initial Coin Offering) + Liquidity Pool (ala Uniswap) with multi-signature deployment on Ethereum

Advanced Sample Hardhat Project

This project demonstrates an advanced Hardhat use case, integrating other tools commonly used alongside Hardhat in the ecosystem.

The project comes with a sample contract, a test for that contract, a sample script that deploys that contract, and an example of a task implementation, which simply lists the available accounts. It also comes with a variety of other tools, preconfigured to work with the project code.

Try running some of the following tasks:

npx hardhat accounts
npx hardhat compile
npx hardhat clean
npx hardhat test
npx hardhat node
npx hardhat help
REPORT_GAS=true npx hardhat test
npx hardhat coverage
npx hardhat run scripts/deploy.ts
TS_NODE_FILES=true npx ts-node scripts/deploy.ts
npx eslint '**/*.{js,ts}'
npx eslint '**/*.{js,ts}' --fix
npx prettier '**/*.{json,sol,md}' --check
npx prettier '**/*.{json,sol,md}' --write
npx solhint 'contracts/**/*.sol'
npx solhint 'contracts/**/*.sol' --fix

Etherscan verification

To try out Etherscan verification, you first need to deploy a contract to an Ethereum network that's supported by Etherscan, such as Ropsten.

In this project, copy the .env.example file to a file named .env, and then edit it to fill in the details. Enter your Etherscan API key, your Ropsten node URL (eg from Alchemy), and the private key of the account which will send the deployment transaction. With a valid .env file in place, first deploy your contract:

hardhat run --network ropsten scripts/deploy.ts

Then, copy the deployment address and paste it in to replace DEPLOYED_CONTRACT_ADDRESS in this command:

npx hardhat verify --network ropsten DEPLOYED_CONTRACT_ADDRESS "Hello, Hardhat!"

Performance optimizations

For faster runs of your tests and scripts, consider skipping ts-node's type checking by setting the environment variable TS_NODE_TRANSPILE_ONLY to 1 in hardhat's environment. For more details see the documentation.

Deployment Result

Rinkeby

Deploying contracts with the account: 0x6684561D15A28a4b4a96fd5D63778862457d9bd6
Account balance: 600470644566999930
Treasury address 0xb4204d2D9A51572E858Ef53715486899bB6fe112
SpaceCoin deployed to: 0x6dce6D3C01657156A628Df999a26Ec6470c2563c
SpaceCoinICO deployed to: 0x2Dae42f82d93D93fC005ED1780752c47AE3D132b
SpaceCoinLP Pool deployed to: 0xD8f1E3a98E44852AE1CC9D6C5c34163D7C80dcD2
SpaceRouter deployed to: 0xEC469B61AD5C24cFFb9692fddAC92522E171CAD5

Goerli

Deploying contracts with the account: 0x6684561D15A28a4b4a96fd5D63778862457d9bd6
Account balance: 1039550994533264672
Treasury address 0xb4204d2D9A51572E858Ef53715486899bB6fe112
SpaceCoin deployed to: 0x18145471761C96B55513039E83621E1c02b0D170
SpaceCoinICO deployed to: 0x588B9DC7C2A3227196BA03665bA8EAB90284B5aE
SpaceCoinLP Pool deployed to: 0x30a3c2d9cB20e072ff487cfA8409Df379a69B551
SpaceRouter deployed to: 0x256535fa25d745CB68F3a936CaBDFFE3Fc34fE7F
Transfering ownership to multisig wallet: 0xE08b81dd3a878eb6fAB1b856231b9c7FD39D718E

Design Exercises

Consider and write down the positive and negative tradeoffs of the following configurations for a multisig wallet. In particular, consider how each configuration handles the common failure modes of wallet security. 1-of-N M-of-N (where M: such that 1 < M < N) N-of-N

a. 1-of-N

+ Easy and fast for funds to be transferred out for a pool account e.g. investment / common pool for a group

- It is not too different from the usual wallet that requires 1 signature to perform a transaction, so if this person is a bad actor, he could perform a harmful transaction e.g. withdrawing all money from a treasury account, etc

b. M-of-N (where M: such that 1 < M < N)

+ Safer compared to 1-of-N model and at least it allows some people (M) to confirm first before performing a transaction on behalf of a group. If one private key gets lost, at least there are still some private keys to sign the transaction.

- Could be dominated by only some owners instead of all owners if the owners of the multisg wallet are not selected correctly. So some transactions could be controlled by some owners only

c. N-of-N

+ The safest one because it requires all owners to confirm before a transaction is executed

- Losing one of the private keys makes it impossible to sign the transaction because it requires all owners' confirmation

Deliverables

Contracts and Wallet

Name	Link
Gnosis Safe Multisig Wallet	https://gnosis-safe.io/app/gor:0xE08b81dd3a878eb6fAB1b856231b9c7FD39D718E
SpaceCoin Contract	https://goerli.etherscan.io/address/0x9f0000b944edD1Ee4338724415c5D261e04248e1
SpaceCoinICO Contract	https://goerli.etherscan.io/address/0x890f2D98777F50024D7DEe18eB589E33B32A5DD9
SpaceCoinLP Contract	https://goerli.etherscan.io/address/0xEC469B61AD5C24cFFb9692fddAC92522E171CAD5
SpaceRouter Contract	https://goerli.etherscan.io/address/0xd8FC763771BAbe4C51b2fB7e70B132aeE9653540

Transactions

Name	Link
SpaceCoin TransferOwnership	https://goerli.etherscan.io/tx/0xe2e582bf9605966c2dc39e05887f2fe59a03239bad2a86572984f88a8d96cede
SpaceCoinICO TransferOwnership	https://goerli.etherscan.io/tx/0x94c86f3b018ad5210ffbfb46846b67061cb24d5c9a002cc5d5d0a94ae38558b3
SpaceCoinLP TransferOwnership	https://goerli.etherscan.io/tx/0x82752c16c92b342adf17c7e5aa85560a255f6b611c4f8a33bf0a2d41758012e7
SpaceRouter TransferOwnership	https://goerli.etherscan.io/tx/0xb74a883c09ba19ccb7042a4c1f534c928b1efc691c8566536b14e0fdfd34633a
Exec Transaction Gnosis Safe	https://goerli.etherscan.io/tx/0x5f8240af32dfb1bbd512972c0dd1249bf09a55bebd5148584a9344ba7dba7142