https://github.com/nickbytes/quick-test
https://github.com/nickbytes/quick-test
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/nickbytes/quick-test
- Owner: nickbytes
- License: mit
- Created: 2022-01-21T02:42:37.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-21T02:42:39.000Z (over 4 years ago)
- Last Synced: 2025-02-09T01:36:37.591Z (over 1 year ago)
- Language: TypeScript
- Size: 35.2 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Solidity Template
Uses
- [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
- [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
```
### Test
Run the Mocha tests:
```sh
$ yarn test
```
### Deploy contract to netowrk (requires Mnemonic and infura API key)
```
npx hardhat run --network rinkeby ./scripts/deploy.ts
```
### Validate a contract with etherscan (requires API ke)
```
npx hardhat verify --network "Constructor argument 1"
```
### Added plugins
- Gas reporter [hardhat-gas-reporter](https://hardhat.org/plugins/hardhat-gas-reporter.html)
- Etherscan [hardhat-etherscan](https://hardhat.org/plugins/nomiclabs-hardhat-etherscan.html)
## Thanks
If you like it than you soulda put a start ⭐ on it