Tidak Ada Deskripsi

0 Rilis

Paul Razvan Berg c2e2f045b1 build: bump hardhat dep		4 tahun lalu
.github	75c189ce71 docs: add funding link	4 tahun lalu
.husky	002ef88aed build: add yarn resolution for "@ethersproject/wallet"	4 tahun lalu
.yarn	18e4052b20 build: upgrade dependencies	4 tahun lalu
contracts	a2b2843e3b feat: solidity v0.8.4 custom errors in Greeter.sol	4 tahun lalu
scripts	03802c8e55 build: add @ethersproject/contracts dep	4 tahun lalu
tasks	87a4060123 fix: re-enable cleaning of coverage files	5 tahun lalu
test	0c9a466deb refactor: use the hardhat way to import contract artifact	4 tahun lalu
types	c5e90a5385 chore: import Greeter type from Greeter.d.ts	4 tahun lalu
.commitlintrc.js	e35b229b5a feat: initial commit	5 tahun lalu
.czrc	432ed42c39 chore: add .czrc config file	4 tahun lalu
.editorconfig	e35b229b5a feat: initial commit	5 tahun lalu
.env.example	4e7d7b3907 chore: remove INFURA_API_KEY from .env.example	5 tahun lalu
.eslintignore	de44b881d8 feat: new clean and typechain buidler tasks	5 tahun lalu
.eslintrc.yaml	61d16cf326 build: upgrade to latest versions of eslint and typescript-eslint	4 tahun lalu
.gitattributes	e35b229b5a feat: initial commit	5 tahun lalu
.gitignore	ddc8b5f4a9 build: upgrade to yarn v2	4 tahun lalu
.lintstagedrc	6080e4eed5 refactor: move lint-staged config to bespoke file	4 tahun lalu
.prettierignore	e35b229b5a feat: initial commit	5 tahun lalu
.prettierrc	7e4eb7e3a8 docs: write a README	5 tahun lalu
.solcover.js	77a9890fcf test: add "lcov" istanbul reporter	4 tahun lalu
.solhint.json	a2b2843e3b feat: solidity v0.8.4 custom errors in Greeter.sol	4 tahun lalu
.solhintignore	e35b229b5a feat: initial commit	5 tahun lalu
.yarnrc.yml	18e4052b20 build: upgrade dependencies	4 tahun lalu
LICENSE.md	7e4eb7e3a8 docs: write a README	5 tahun lalu
README.md	3b83497ee9 feat: upgrade to solc@0.8.4	4 tahun lalu
hardhat.config.ts	9472e65626 refactor: 💡 simplify hardhat config infuraApiKey & mnemonic	4 tahun lalu
package.json	c2e2f045b1 build: bump hardhat dep	4 tahun lalu
tsconfig.json	a894b85bfc chore: add "artifacts" under "exclude" array in tsconfig.json	4 tahun lalu
yarn.lock	c2e2f045b1 build: bump hardhat dep	4 tahun lalu

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

Report Gas

See the gas usage per unit test and average gas per method call:

$ REPORT_GAS=true yarn test

Clean

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

$ yarn clean

Deploy

Deploy the contracts to Hardhat Network:

$ yarn deploy

Deploy the contracts to a specific network, such as the Ropsten testnet:

$ yarn deploy:network ropsten

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.4+commit.c7e474f2",
  "solidity.defaultCompiler": "remote"
}

Where of course v0.8.4+commit.c7e474f2 can be replaced with any other version.

README.md