VRF-Enabled Mystery Box

Clone the repo and install all dependencies.

If you want to use npm, run:

git clone https://github.com/smartcontractkit/quickstarts-mysterybox.git && \
cd quickstarts-mysterybox && \
npm install

Alternatively, you can use yarn to install dependencies:

git clone [email protected]:smartcontractkit/quickstarts-mysterybox.git && \
cd quickstarts-mysterybox && \
yarn install

Copy the .env.example file to .env and fill in the values.

cp .env.example .env

Set the parameters for the NFT contract. If you don't have a VRF subscription, delete the VRF_SUBSCRIPTION_ID parameter.

Parameter	Description	Example
NFT_NAME	The name of the NFT collection	MysteryBox
NFT_SYMBOL	The symbol of the NFT collection	BOX
NFT_UNREVEALED_URI	The metadata URI for all tokens before reveal	https://example.com
NFT_MAX_SUPPLY	The maximum number of tokens that can be minted	100
NFT_MAX_MINT_PER_USER	The maximum number of tokens that can be minted per user address	10
NFT_FEE	The fee for minting a token in ETH	0.01
NFT_ROYALTY_BPS	The royalty fee for selling a token in basis points	500
VRF_SUBSCRIPTION_ID	A funded Chainlink VRF V2.5 subscription ID. If you leave this blank, a new subscription will be created and funded on deploy.	79850349243438349975305816782035019118399435445660033947721688676378382535454

Hardhat is an Ethereum development environment that is used here to configure and deploy the mystery box contract. You need the following information:

Parameter	Description	Example
SEPOLIA_RPC_URL	The RPC URL for the Ethereum Sepolia network.	https://eth-sepolia.g.alchemy.com/v2/...
PRIVATE_KEY	The private key of the account you want to deploy from.	abc123abc123abc123abc123abc123...
SCANNER_API_KEY	The API key for Etherscan used for contract verification.	ABC123ABC123ABC123ABC123ABC123ABC1

To run the unit tests, run the following command:

npm run test

If you want to see gas usage, run the following command:

REPORT_GAS=true npm run test

For coverage reports, run the following command:

npm run coverage

Run the npx hardhat run command and replace <network> with the network that you want to deploy to. The network must be configured in hardhat.config.ts.

npx hardhat run scripts/deploy.ts --network <network>

In addition to deploying the contract, the deploy script also completes the following steps automatically:

1. Create and fund a VRF V2.5 subscription if one is not provided. Make sure the deployer account has enough LINK to fund the subscription. The initial funding amount is configured in network-config.ts. For testnets, you can use the LINK faucet to get LINK. If your subscription is underfunded, your VRF request will be pending for 24 hours. If this happens, check the Subscription Manager to see the additional balance needed.

2. Add the deployed contract address as a consumer to the VRF subscription. If you provided a subscription ID, make sure the deployer account is the owner of the subscription. Otherwise, comment out the addConsumerToSubscription function in the deploy script and add the contract address manually.

3. Generate a Merkle tree for the allowlist. The merkle tree is generated from the address list in scripts/data/whitelist.json file.

4. Verify the contract on Etherscan. This is important to show users the source code for the contract so they can confirm how it works. It's also required to run the example yourself.

After the deployment is complete, the terminal prints the link to view your contract on Etherscan.

After the contract is deployed, run the example using contract functions on Etherscan.

1. Open the Etherscan link from your terminal to view your contract.
2. On the Contract tab, click the Write Contract tab to view your contract's write functions.
3. Click Connect to Web3 to connect your wallet to Etherscan so you can run the functions.
4. Enable public minting:
5. Open the setPublicMint function.
6. Enter a value of true.
7. Click Write to run the function. Approve the transaction in MetaMask.
8. Mint an NFT to test the contract:
9. Open the publicMint function.
10. Enter a publicMint value of 0.01 ETH and an amount of 1.
11. Click Write to run the function. Approve the transaction in MetaMask.
12. Reveal the box:
13. Open the reveal function.
14. Click reveal to reveal the mystery box.
15. After the reveal, you can find the NFT in the token list for your externally owned account (EOA).