@dank-bank/markets v1.0.3
Solidity Template
My favourite setup for writing Solidity smart contracts.
- Hardhat: compile and run the smart contracts on a local development network
- TypeChain: generate TypeScript types for smart contracts
- Ethers: renowned Ethereum library and wallet implementation
- Waffle: tooling for writing comprehensive smart contract tests
- Solhint: linter
- Solcover: code coverage
- Prettier Plugin Solidity: code formatter
This is a GitHub template, which means you can reuse it as many times as you want. You can do that by clicking the "Use this template" button at the top of the page.
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/sample-script.ts
Then, run the verify task, passing the address of the contract replacing DEPLOYED_CONTRACT_ADDRESS
, the network where it's deployed by replacing NETWORK
, and the constructor arguments that were used to deploy it (if any):
npx hardhat verify --network NETWORK DEPLOYED_CONTRACT_ADDRESS "Constructor argument 1"
Usage
Pre Requisites
Before running any command, make sure to install dependencies:
$ yarn install
Compile
Compile the smart contracts with Hardhat:
$ yarn compile
Run a local node
Expose a JSON-RPC interface to Hardhat Network
$ yarn start
TypeChain
Compile the smart contracts and generate TypeChain artifacts:
$ yarn typechain
Lint Solidity
Lint the Solidity code:
$ yarn lint:sol
Lint TypeScript
Lint the TypeScript code:
$ yarn lint:ts
Test
Run the Mocha tests:
$ yarn test
Coverage
Generate the code coverage report:
$ yarn coverage
Report Gas
See the gas usage per unit test and average gas per method call:
$ yarn test:gas
Clean
Delete the smart contract artifacts, the coverage reports and the Hardhat cache:
$ yarn clean
Deploy
Deploy the contracts to Hardhat Network:
$ yarn deploy
Deploy the contracts to a specific network, such as the Mainnet testnet:
$ yarn deploy:mainnet
Deployed contract addresses and other information regarding deployments can be found in the .openzeppelin
folder
Syntax Highlighting
If you use VSCode, you can enjoy syntax highlighting for your Solidity code via the vscode-solidity extension. The recommended approach to set the compiler version is to add the following fields to your VSCode user settings:
{
"solidity.compileUsingRemoteVersion": "v0.8.4+commit.c7e474f2",
"solidity.defaultCompiler": "remote"
}
Where of course v0.8.4+commit.c7e474f2
can be replaced with any other version.
2 years ago