Ei kuvausta

8 Haarat

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

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