Keine Beschreibung

Paul Razvan Berg bea88a384c docs: remove note about machine dependency and link to #31		vor 4 Jahren
.github	75c189ce71 docs: add funding link	vor 4 Jahren
contracts	98fbf71e87 feat: upgrade to solc@0.8.1	vor 4 Jahren
scripts	fdd57f4853 style: sort imports with vscode extension	vor 4 Jahren
tasks	87a4060123 fix: re-enable cleaning of coverage files	vor 4 Jahren
test	0c9a466deb refactor: use the hardhat way to import contract artifact	vor 4 Jahren
types	1ad3da6869 test: add 'loadFixture' to Mocha context augmentation	vor 4 Jahren
.commitlintrc.js	e35b229b5a feat: initial commit	vor 5 Jahren
.czrc	432ed42c39 chore: add .czrc config file	vor 4 Jahren
.editorconfig	e35b229b5a feat: initial commit	vor 5 Jahren
.env.example	4e7d7b3907 chore: remove INFURA_API_KEY from .env.example	vor 4 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	dfc146c7b1 refactor: initialise signers without mocha delay	vor 4 Jahren
.prettierignore	e35b229b5a feat: initial commit	vor 5 Jahren
.prettierrc	7e4eb7e3a8 docs: write a README	vor 5 Jahren
.solcover.js	77a9890fcf test: add "lcov" istanbul reporter	vor 4 Jahren
.solhint.json	98fbf71e87 feat: upgrade to solc@0.8.1	vor 4 Jahren
.solhintignore	e35b229b5a feat: initial commit	vor 5 Jahren
LICENSE.md	7e4eb7e3a8 docs: write a README	vor 5 Jahren
README.md	59f7d45bcb chore: remove dots (...) in README.md json snippet	vor 4 Jahren
hardhat.config.ts	bea88a384c docs: remove note about machine dependency and link to #31	vor 4 Jahren
package.json	baee203b23 docs: add note about vscode-solidity extension	vor 4 Jahren
tsconfig.json	0c8e0814e1 refactor: simplify hardhat.config.ts	vor 4 Jahren
yarn.lock	baee203b23 docs: add note about vscode-solidity extension	vor 4 Jahren

Solidity Template

My favourite 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 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 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

Clean

Delete the smart contract artifacts, the coverage reports and the Hardhat cache:

$ yarn clean

Syntax Highlighting

If you use VSCode, you can enjoy syntax highlighting for your Solidity code via the vscode-solidity extension. The recommended approach to set the compiler version is to add the following fields to your VSCode user settings:

{
  "solidity.compileUsingRemoteVersion": "v0.8.3+commit.8d00100c",
  "solidity.defaultCompiler": "remote"
}

Where of course v0.8.3+commit.8d00100c can be replaced with any other version.

README.md