Keine Beschreibung

Paul Razvan Berg c6097532be chore: remove unused dependency		vor 5 Jahren
@types	de44b881d8 feat: new clean and typechain buidler tasks	vor 5 Jahren
contracts	1453616a9f feat: upgrade to solidity 0.7.2	vor 5 Jahren
scripts	e35b229b5a feat: initial commit	vor 5 Jahren
tasks	7e4eb7e3a8 docs: write a README	vor 5 Jahren
test	a1e5e9bf4b chore: upgrade to ethereum-waffle@3.0.2	vor 5 Jahren
.commitlintrc.js	e35b229b5a feat: initial commit	vor 5 Jahren
.editorconfig	e35b229b5a feat: initial commit	vor 5 Jahren
.env.example	e35b229b5a feat: initial commit	vor 5 Jahren
.eslintignore	de44b881d8 feat: new clean and typechain buidler tasks	vor 5 Jahren
.eslintrc.yaml	c6097532be chore: remove unused dependency	vor 5 Jahren
.gitattributes	e35b229b5a feat: initial commit	vor 5 Jahren
.gitignore	e35b229b5a feat: initial commit	vor 5 Jahren
.huskyrc	e35b229b5a feat: initial commit	vor 5 Jahren
.mocharc.json	e35b229b5a feat: initial commit	vor 5 Jahren
.prettierignore	e35b229b5a feat: initial commit	vor 5 Jahren
.prettierrc	7e4eb7e3a8 docs: write a README	vor 5 Jahren
.solcover.js	5df9c857b8 perf: replace the console.logs with Errors	vor 5 Jahren
.solhint.json	7e4eb7e3a8 docs: write a README	vor 5 Jahren
.solhintignore	e35b229b5a feat: initial commit	vor 5 Jahren
LICENSE.md	7e4eb7e3a8 docs: write a README	vor 5 Jahren
README.md	7e4eb7e3a8 docs: write a README	vor 5 Jahren
buidler.config.ts	5df9c857b8 perf: replace the console.logs with Errors	vor 5 Jahren
package.json	c6097532be chore: remove unused dependency	vor 5 Jahren
tsconfig.json	c6097532be chore: remove unused dependency	vor 5 Jahren
yarn.lock	c6097532be chore: remove unused dependency	vor 5 Jahren

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

Build

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

README.md