Žiadny popis

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

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