Smart-Contract-Takarakuji

Live site : https://web3-takarakuji-devdeep-j-s.vercel.app/ or https://web3-takarakuji.vercel.app/

Demo video: https://www.youtube.com/watch?v=4kvGJ2u2Exc

Getting Started

Requirements

• git
  • You'll know you did it right if you can run git --version and you see a response like git version x.x.x
• Nodejs
  • You'll know you've installed node right if you can run:
    • node --version and get an output like: vx. x.x
• Yarn instead of npm
  • You'll know you've installed yarn right if you can run:
    • yarn --version and get an output like: x.x.x
    • You might need to install it with npm or corepack

Quickstart

git clone https://github.com/Devdeep-J-S/Smart-Contract-Takarakuji.git
cd Smart-Contract-Takarakuji
yarn

Usage

Deploy:

yarn hardhat deploy

Testing

yarn hardhat test

Test Coverage

yarn hardhat coverage

Deployment to a testnet or mainnet

1. Setup environment variabltes

You'll want to set your SEPOLIA_RPC_URL and PRIVATE_KEY as environment variables. You can add them to a .env file. 2. Get testnet ETH

Head over to faucets.chain.link and get some tesnet ETH & LINK. You should see the ETH and LINK show up in your metamask.

3. Setup a Chainlink VRF Subscription ID

Head over to vrf.chain.link and setup a new subscription, and get a subscriptionId. You can reuse an old subscription if you already have one.

1. A subscription ID

2. Your subscription should be funded with LINK

3. Deploy

Then run:

yarn hardhat deploy --network sepolia

And copy / remember the contract address.

4. Add your contract address as a Chainlink VRF Consumer

Go back to vrf.chain.link and under your subscription add Add consumer and add your contract address. You should also fund the contract with a minimum of 1 LINK.

5. Register a Chainlink Keepers Upkeep

Go to keepers.chain.link and register a new upkeep. Choose Custom logic as your trigger mechanism for automation. Your UI will look something like this once completed:

6. Enter Takarakuji

yarn hardhat run scripts/enter.js --network sepolia

Estimate gas cost in USD

To get a USD estimation of gas cost, you'll need a COINMARKETCAP_API_KEY environment variable. You can get one for free from CoinMarketCap.

Then, uncomment the line coinmarketcap: COINMARKETCAP_API_KEY, in hardhat.config.js to get the USD estimation. Just note, everytime you run your tests it will use an API call, so it might make sense to have using coinmarketcap disabled until you need it. You can disable it by just commenting the line back out.

Verify on etherscan

If you deploy to a testnet or mainnet, you can verify it if you get an API Key from Etherscan and set it as an environemnt variable named ETHERSCAN_API_KEY. You can pop it into your .env file as seen in the .env.example.

Linting

To check linting / code formatting:

yarn lint

or, to fix:

yarn lint:fix