Paul Razvan Berg
98371030aa
refactor: switch to yaml-based prettier config file
|
4 tahun lalu | |
|---|---|---|
| .github | 4 tahun lalu | |
| .husky | 4 tahun lalu | |
| .yarn | 4 tahun lalu | |
| contracts | 4 tahun lalu | |
| tasks | 4 tahun lalu | |
| test | 4 tahun lalu | |
| types | 4 tahun lalu | |
| .commitlintrc.js | 5 tahun lalu | |
| .czrc | 4 tahun lalu | |
| .editorconfig | 5 tahun lalu | |
| .env.example | 4 tahun lalu | |
| .eslintignore | 5 tahun lalu | |
| .eslintrc.yaml | 4 tahun lalu | |
| .gitattributes | 5 tahun lalu | |
| .gitignore | 4 tahun lalu | |
| .lintstagedrc | 4 tahun lalu | |
| .prettierignore | 5 tahun lalu | |
| .prettierrc.yaml | 4 tahun lalu | |
| .solcover.js | 4 tahun lalu | |
| .solhint.json | 4 tahun lalu | |
| .solhintignore | 5 tahun lalu | |
| .yarnrc.yml | 4 tahun lalu | |
| README.md | 4 tahun lalu | |
| hardhat.config.ts | 4 tahun lalu | |
| package.json | 4 tahun lalu | |
| tsconfig.json | 4 tahun lalu | |
| yarn.lock | 4 tahun lalu |
README.md
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.
Usage
Pre Requisites
Before running any command, you need to create a .env file and set a BIP-39 compatible mnemonic as an environment
variable. Follow the example in .env.example. If you don't already have a mnemonic, use this website to generate one.
Then, proceed with installing dependencies:
yarn install
Compile
Compile the smart contracts with Hardhat:
$ yarn compile
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:
$ REPORT_GAS=true yarn test
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 Ropsten testnet:
$ yarn deploy:network ropsten
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.