Skip to content
This repository was archived by the owner on Apr 2, 2024. It is now read-only.

junekimdev/web3-quick-starter

Repository files navigation

Web3 Quick-starter

Tech Stack

  1. HEWT stack
    • Hardhat (Solidity Framework)
    • Ethers.js (Ethereum Wallet Library)
    • Waffle (Test Framework)
    • Typechain (Typescript for Web3)
  2. Hardhat plugins
    • hardhat-ethers
    • hardhat-waffle
    • hardhat-deploy
  3. Additional dependencies
    • mocha
    • chai
    • dotenv
    • nft.storage
    • prettier

Installation

  1. Clone the repo

  2. Create a file named .env in the root directory

  3. Add keys and values

    1. MASTER_ADDR=xxx
    2. ALCHEMY_API_KEY=xxx
    3. ALCHEMY_PRV_KEY=xxx
    4. ETHERSCAN_API_KEY=xxx
    5. NFT_STORAGE_API_KEY=xxx

Smart Contract Deployment

  1. Write deploy script in /deploy folder to use hardhat-deploy

  2. Compile the contract

    yarn compile
    • typechain will generate type files in /typechain-types folder
  3. Test the contract

    yarn test
  4. Deploy to local chain

    yarn deploy-local
  5. Deploy to Rinkeby Ethereum testnet

    yarn deploy-remote
    yarn verify
  6. hardhat-deploy will output ABIs under /deployment folder

About

Quick starter kit for Web3 Developers

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •