amanusk / hardhat-template

Template to build smart contract with hardhat + typescript + ethers

Solidity Template

This is a basic hardhat template to get you started writing and compiling contract. The template is configured with some sensible defaults but tries to stay minimal. It comes with most sensible plugins already installed via the suggested hardhat-toolbox.

• 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

Use the template 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

Test

Run the tests:

yarn test

Test gas costs

To get a report of gas costs, set env REPORT_GAS to true

To take a snapshot of the contract's gas costs

yarn test:gas

Deploy contract to network (requires Mnemonic and Infura API key)

npx hardhat run --network goerli ./scripts/deploy.ts

Validate a contract with etherscan (requires API key)

npx hardhat verify --network <network> <DEPLOYED_CONTRACT_ADDRESS> "Constructor argument 1"

Thanks

If you like it than you shoulda put a start ⭐ on it

Twitter: @amanusk_

License

MIT