MysteryBox Smart Contract

Brief introduction

MysteryBox Smart Contract is an Ethereum smart contract for people to sell/buy NFT tokens. Inspired by Fukubukuro, people can put NFT(s) in a box and customers/players can pick an NFT(randomly).

For design details, please see API document.

Getting Started

Project setup

This project has git submodules. You need to initialize these submodules first.

git submodule update --init --recursive

To install required node.js modules

npm ci

To compile the solidity source code

npm run compile

To run unit test:

npm run test

To deploy the smart contract on Ethereum rinkeby testnet:

npm run deploy rinkeby

Using the helper.ts script to set up the deployed smart contracts.

Troubleshoot & Tips

• This project is powered by hardhat.   You can change your network configuration in hardhat.config.ts file.
• This smart contract involves some randomness, hence, the estimated gas consumption is probably not accurate. To make sure transaction gas limit is large enough, we need to give a larger gas consumption.

Deployed Contract Address

MysteryBox & MaskTestNFT

Qualification Contract

testnet $MASK token address

Known issue and limitation

This smart contract only support Enumerable ERC721 NFT.

Contribute

Any contribution is welcomed to make it better.

If you have any questions, please create an issue.

Security report

If you have any security issue, please send to [email protected].

License

MIT LICENSE