Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/frangio/test-typechain-upgrades
https://github.com/frangio/test-typechain-upgrades
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/frangio/test-typechain-upgrades
- Owner: frangio
- License: other
- Created: 2021-04-17T03:01:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-04-17T03:32:36.000Z (over 3 years ago)
- Last Synced: 2024-10-16T10:21:26.844Z (2 months ago)
- Language: TypeScript
- Size: 463 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Solidity Template
My favourite setup for writing Solidity smart contracts.
- [Hardhat](https://github.com/nomiclabs/hardhat): compile and run the smart contracts on a local development network
- [TypeChain](https://github.com/ethereum-ts/TypeChain): generate TypeScript types for smart contracts
- [Ethers](https://github.com/ethers-io/ethers.js/): renowned Ethereum library and wallet implementation
- [Waffle](https://github.com/EthWorks/Waffle): tooling for writing comprehensive smart contract tests
- [Solhint](https://github.com/protofire/solhint): linter
- [Solcover](https://github.com/sc-forks/solidity-coverage) code coverage
- [Prettier Plugin Solidity](https://github.com/prettier-solidity/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:
```sh
$ yarn install
```
### Compile
Compile the smart contracts with Hardhat:
```sh
$ yarn compile
```
### TypeChain
Compile the smart contracts and generate TypeChain artifacts:
```sh
$ yarn typechain
```
### Lint Solidity
Lint the Solidity code:
```sh
$ yarn lint:sol
```
### Lint TypeScript
Lint the TypeScript code:
```sh
$ yarn lint:ts
```
### Test
Run the Mocha tests:
```sh
$ yarn test
```
### Coverage
Generate the code coverage report:
```sh
$ yarn coverage
```
### Report Gas
See the gas usage per unit test and average gas per method call:
```sh
$ REPORT_GAS=true yarn test
```
### Clean
Delete the smart contract artifacts, the coverage reports and the Hardhat cache:
```sh
$ yarn clean
```
## Syntax Highlighting
If you use VSCode, you can enjoy syntax highlighting for your Solidity code via the
[vscode-solidity](https://github.com/juanfranblanco/vscode-solidity) extension. The recommended approach to set the
compiler version is to add the following fields to your VSCode user settings:
```json
{
"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.