• Node.js -- JavaScript Runtime.
  • Install here
  • Recommend LTS version
• Yarn -- NPM Package Manager.
  • Install: npm install --global yarn
  • Required because Yarn Workspaces are being using in this project
• Metamask plugin installed on any chromium-based browser of choice:
  • Note the web app currently only supports Metamask wallet and provider
  • Install here

Once all the general requirements are satisfied and the repo has been cloned locally, the following command will install all the necessary dependencies to use the repository.

yarn install

The following environment variables on ./packages/contracts/.env can be setup to unlock extra features:

• ETHERSCAN_API_KEY – Etherscan is used to verify source code deployed to public networks. Sign up here and paste the api key.
• COINMARKETCAP_API_KEY – Coinmarketcap is used to measure the gas consumption of the smart contracts. Sign up here and paste the api key.
• GOERLI_URL - A Node Provider like Infura is necessary to deploy contracts to Goerli. Sign up here and paste the api key.

Runs all the unit and integration tests

yarn contracts:test

Tests can be run to also show its coverage information at the end. Run the command below and the view the coverage by opening the following generated file on the browser

yarn contracts:test

yarn contracts:gas

It is recommended to run the application locally to have a seamless experience trying out all the features of the application in swift manner without having to wait for block confirmations. However, for a more realistic usage experience run with the Goerli Testnet.

• Add relevant test accounts to the metamask wallet using the credentials in Test Wallets
• Add Hardhat Network on Metamask. Refer here
• Switch active network on Metamask to Hardhat Network.

1. Spin up a local testnet. This exposes an JSON-RPC connection at http://127.0.0.1:8545/ to interact with the testnet. Additionally default wallet accounts are funded

   yarn chain

2. Open another terminal window and run the deployment script to deploy the ICVCM smart contracts on the local testnet

   yarn deploy_contracts

3. Open another terminal window and run the frontend web app client. The website will available on http://127.0.0.1:3000/

   yarn web:start

4. Open the browser on http://127.0.0.1:3000/ and start using the client.

The ICVCM smart contracts have already been deployed to the Goerli testnet and they can be used for testing purposes

• Add relevant test accounts to metamask wallets on Goerli Test Accounts
• Switch active network on Metamask to Goerli

1. Run the frontend web app client. The website will be available on http://127.0.0.1:3000/

   yarn web:start

2. Open the browser on http://127.0.0.1:3000/ and start using the client.

TBA.

Disclaimer, the prototype built is by no means ready to be used in a production environment. If anyone chooses to use the code for real governance use cases it should go through thorough security audits and ensure it is regulator proof. The author will not be responsible for the legal and ethical issues arising from the software. - Blockchain protocol prone to cyberattack

Metamask accounts will store locally the transactions submitted by the DApp. Sometimes, as we have run many instances of the app and created many different proposals, the Metamask will fail to submit new transactions on a given accounts. To solve this problem, just reset the account by going to: Settings > Advanced > Reset Account.

Additional help for adding custom networks on Metamask can be found here

• Network Name: Hardhat Network
• New RPC URL: http://127.0.0.1:8545/
• Chain ID: 31337
• Currency Symbol: GO
• Block Explorer URL: N/A

The following test accounts are setup during deployment for testing. Please import them to Metamask to use. Help to setup can be found here

The diagram below shows a Smart Contract Class Diagram of the ICVCM Smart Contracts created in this project along with the first level of inherited contracts from OpenZeppelin.

The diagram can also be found in here.