Bez popisu

Paul Razvan Berg f1ba15eaa2 feat: compile dai and commit artifacts to vc před 4 roky
@types de44b881d8 feat: new clean and typechain buidler tasks před 5 roky
artifacts f1ba15eaa2 feat: compile dai and commit artifacts to vc před 4 roky
contracts f1ba15eaa2 feat: compile dai and commit artifacts to vc před 4 roky
scripts e35b229b5a feat: initial commit před 5 roky
tasks 7e4eb7e3a8 docs: write a README před 4 roky
typechain f1ba15eaa2 feat: compile dai and commit artifacts to vc před 4 roky
.commitlintrc.js e35b229b5a feat: initial commit před 5 roky
.editorconfig e35b229b5a feat: initial commit před 5 roky
.env.example e35b229b5a feat: initial commit před 5 roky
.eslintignore de44b881d8 feat: new clean and typechain buidler tasks před 5 roky
.eslintrc.yaml c6097532be chore: remove unused dependency před 4 roky
.gitattributes e35b229b5a feat: initial commit před 5 roky
.gitignore f1ba15eaa2 feat: compile dai and commit artifacts to vc před 4 roky
.huskyrc e35b229b5a feat: initial commit před 5 roky
.mocharc.json e35b229b5a feat: initial commit před 5 roky
.prettierignore e35b229b5a feat: initial commit před 5 roky
.prettierrc 7e4eb7e3a8 docs: write a README před 4 roky
.solcover.js 5df9c857b8 perf: replace the console.logs with Errors před 4 roky
.solhint.json f1ba15eaa2 feat: compile dai and commit artifacts to vc před 4 roky
.solhintignore e35b229b5a feat: initial commit před 5 roky
LICENSE.md 7e4eb7e3a8 docs: write a README před 4 roky
README.md 3047646cb0 Updating Waffle Link to Be Accurate před 4 roky
buidler.config.ts f1ba15eaa2 feat: compile dai and commit artifacts to vc před 4 roky
package.json f1ba15eaa2 feat: compile dai and commit artifacts to vc před 4 roky
tsconfig.json c6097532be chore: remove unused dependency před 4 roky
yarn.lock f1ba15eaa2 feat: compile dai and commit artifacts to vc před 4 roky

README.md

Solidity Template

My favourite setup for writing Solidity smart contracts.

  • Buidler: 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 Buidler:

$ yarn compile

TypeChain

Compile the smart contracts and generate TypeChain artifacts:

$ yarn build

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 Buidler cache:

$ yarn clean