Paul Razvan Berg
432ed42c39
chore: add .czrc config file
|
4 tahun lalu | |
|---|---|---|
| .github | 4 tahun lalu | |
| contracts | 4 tahun lalu | |
| scripts | 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 | 5 tahun lalu | |
| .huskyrc | 5 tahun lalu | |
| .mocharc.json | 4 tahun lalu | |
| .prettierignore | 5 tahun lalu | |
| .prettierrc | 4 tahun lalu | |
| .solcover.js | 4 tahun lalu | |
| .solhint.json | 4 tahun lalu | |
| .solhintignore | 5 tahun lalu | |
| LICENSE.md | 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, make sure to install 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
Clean
Delete the smart contract artifacts, the coverage reports and the Hardhat cache:
$ yarn clean