Paul Razvan Berg
20e0db3dff
docs: add license
|
%!s(int64=3) %!d(string=hai) anos | |
|---|---|---|
| .github | %!s(int64=4) %!d(string=hai) anos | |
| .husky | %!s(int64=4) %!d(string=hai) anos | |
| .yarn | %!s(int64=3) %!d(string=hai) anos | |
| contracts | %!s(int64=3) %!d(string=hai) anos | |
| src | %!s(int64=3) %!d(string=hai) anos | |
| tasks | %!s(int64=3) %!d(string=hai) anos | |
| test | %!s(int64=3) %!d(string=hai) anos | |
| .commitlintrc.yaml | %!s(int64=4) %!d(string=hai) anos | |
| .czrc | %!s(int64=4) %!d(string=hai) anos | |
| .editorconfig | %!s(int64=5) %!d(string=hai) anos | |
| .env.example | %!s(int64=3) %!d(string=hai) anos | |
| .eslintignore | %!s(int64=3) %!d(string=hai) anos | |
| .eslintrc.yaml | %!s(int64=4) %!d(string=hai) anos | |
| .gitignore | %!s(int64=3) %!d(string=hai) anos | |
| .lintstagedrc | %!s(int64=3) %!d(string=hai) anos | |
| .prettierignore | %!s(int64=3) %!d(string=hai) anos | |
| .prettierrc.yaml | %!s(int64=3) %!d(string=hai) anos | |
| .solcover.js | %!s(int64=3) %!d(string=hai) anos | |
| .solhint.json | %!s(int64=4) %!d(string=hai) anos | |
| .solhintignore | %!s(int64=3) %!d(string=hai) anos | |
| .yarnrc.yml | %!s(int64=3) %!d(string=hai) anos | |
| LICENSE.md | %!s(int64=3) %!d(string=hai) anos | |
| README.md | %!s(int64=3) %!d(string=hai) anos | |
| hardhat.config.ts | %!s(int64=3) %!d(string=hai) anos | |
| package.json | %!s(int64=3) %!d(string=hai) anos | |
| tsconfig.json | %!s(int64=3) %!d(string=hai) anos | |
| yarn.lock | %!s(int64=3) %!d(string=hai) anos |
README.md
Solidity Template
My favorite 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 repo is a GitHub template, so to start using it, click 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 --greeting "Bonjour, le monde!"
Syntax Highlighting
If you use VSCode, you can get Solidity syntax highlighting via the vscode-solidity extension.
Caveats
Ethers and Waffle
If you can't get the Waffle matchers to work, try to
make your ethers package version match the version used by the @ethereum-waffle/chai package. Seem
#111 for more details.