This project demonstrates a setup for smart-contract development with hardhat and react.js
Clone this repo:
git clone git@github.com:teonite/blockchain-template.git
Install hardhat & frontend dependencies:
yarn install && pushd frontend && yarn install && popd
Prepare .env file:
cp .env.example .env
and fill in your variables.
For local development we'll use a hardhat node. Run it with:
yarn run node
Then we need to deploy the contract:
yarn deploy:local
Your node logs should display info about the deployment.
Once the contract is deployed you can run vite dev server and start hacking on your app:
yarn dev
Run contract tests with:
yarn test:contracts
More info:
For multisignature deployment, you'll need an OpenZeppelin account and a Gnosis Safe. Follow this guide to gain understanding of the whole multisig deployment process: https://docs.openzeppelin.com/defender/guide-upgrades. This repository comes with multisig deployment helper scripts. Fill in your .env file with Gnosis Safe address and:
- Deploy the proxy contract to Rinkeby network:
yarn deploy:rinkeby
Then fill in .env file with proxy contract address.
- Transfer proxy ownership to Gnosis Safe:
yarn transfer-ownership:rinkeby
- Once the changes were made to the contract, you can propose the upgrade with:
yarn upgrade:rinkeby
- https://hardhat.org/ - Ethereum development environment
- https://vitejs.dev/ - alternative to create react app
- https://defender.openzeppelin.com/ - security operations platform for Ethereum
- https://gnosis-safe.io/ - multisignature wallet platform
- https://github.com/dethcrypto/TypeChain - TypeScript bindings for Ethereum smart contracts
- https://github.com/ethers-io/ethers.js/ - Ethereum wallet implementation in JS/TS
- https://github.com/protofire/solhint - Solidity code linter
- no hot reloading for contract, could possibly be resolved with https://github.com/symfoni/symfoni-monorepo, but the library seems abandoned (symfoni/hardhat-react-boilerplate#10)
- CI contract upgrades don't work - to make it work we'll have to commit .openzeppelin directory to git from gh job.