Нема описа

Paul Razvan Berg b173741333 fix: deploy task		пре 3 година
.github	f4cd769e48 chore: use .yaml extension for FUNDING file	пре 4 година
.husky	624f0092b3 chore: fix commitlint git hook	пре 4 година
.yarn	62fbfc271b build: upgrade to yarn v3.2.0	пре 3 година
contracts	0fe5d39be7 chore: track all contract types in version control	пре 3 година
src	0fe5d39be7 chore: track all contract types in version control	пре 3 година
tasks	b173741333 fix: deploy task	пре 3 година
test	e72b0d9e7d style: configure "prettier-plugin-sort-imports"	пре 3 година
.commitlintrc.yaml	624f0092b3 chore: fix commitlint git hook	пре 4 година
.czrc	432ed42c39 chore: add .czrc config file	пре 4 година
.editorconfig	e35b229b5a feat: initial commit	пре 5 година
.env.example	305e37c7c0 chore: fix ARBISCAN name in env var	пре 3 година
.eslintignore	afe1da2d87 refactor: move typechain bindings from "typechain" to "types"	пре 3 година
.eslintrc.yaml	2de6b59757 chore: delete stale ganache id in chainsIds	пре 4 година
.gitignore	0fe5d39be7 chore: track all contract types in version control	пре 3 година
.lintstagedrc	585f39c172 chore: lint yaml and yml in lint-staged config	пре 3 година
.prettierignore	afe1da2d87 refactor: move typechain bindings from "typechain" to "types"	пре 3 година
.prettierrc.yaml	e72b0d9e7d style: configure "prettier-plugin-sort-imports"	пре 3 година
.solcover.js	afe1da2d87 refactor: move typechain bindings from "typechain" to "types"	пре 3 година
.solhint.json	8156684d15 build: upgrade deps	пре 4 година
.solhintignore	e1a2242816 chore: add prefix "**" to paths in .solhintignore	пре 3 година
.yarnrc.yml	62fbfc271b build: upgrade to yarn v3.2.0	пре 3 година
README.md	eb12b87ac5 fix: add $ to yarn install	пре 3 година
hardhat.config.ts	78e778212b fix: infura urls for arbitrum and optimism	пре 3 година
package.json	7eed7a5374 build: upgrade deps	пре 3 година
tsconfig.json	b4443d51b2 chore: add "src" to "includes" in "tsconfig.json"	пре 3 година
yarn.lock	7eed7a5374 build: upgrade deps	пре 3 година

Solidity Template

My favorite 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, you need to create a .env file and set a BIP-39 compatible mnemonic as an environment variable. Follow the example in .env.example. If you don't already have a mnemonic, use this website to generate one.

Then, proceed with installing 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 --greeting "Bonjour, le monde!"

Syntax Highlighting

If you use VSCode, you can enjoy syntax highlighting for your Solidity code via the hardhat-vscode extension.

README.md