Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 1.88 KB

README.md

File metadata and controls

70 lines (45 loc) · 1.88 KB
Raw

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. Many more plugins are available in the hardhat ecosystem, add them as you go.

Uses

  • 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
  • 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

Test

Run the Mocha tests:

$ 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 <network> <DEPLOYED_CONTRACT_ADDRESS> "Constructor argument 1"

Added plugins

Thanks

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

Twitter: [@amanusk_][https://twitter.com/amanusk_]

License

MIT