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 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 Hardhat cache:

$ yarn clean

坚固性模板

使用

先决条件

编译

类型链

Lint TypeScript

测试

覆盖率

清理

我最喜欢的编写可靠智能合约的设置。

• 硬件：在本地开发中编译并运行智能合约网络
• 类型链：为智能合约生成TypeScript类型
• 以太：著名的以太坊eth库和钱包实现
• Waffle: tooling for writing comprehensive smart contract tests
• Solhint: linter
• Solcover code coverage
• Prettier Plugin Solidity: code formatter

这是一个GitHub模板，这意味着您可以根据需要多次重用它。您可以通过单击页面顶部的“使用此模板”按钮来完成此操作。

使用

先决条件

在运行任何命令之前，请确保安装依赖项：

$ yarn install

编译

使用Hardhat编译智能合约：

$ yarn compile

类型链

编译智能合约并生成类型链工件：

$ yarn build

Lint TypeScript

Lint实体代码：

$ yarn lint:sol

测试

Lint类型脚本代码：

$ yarn lint:ts

覆盖率

运行Mocha测试：

$ yarn test

清理

生成代码覆盖率报告：

$ yarn coverage

Clean

删除智能合约工件，覆盖率报告和安全帽缓存：

$ yarn clean