README.md

ERC11155 Token & Receiver

Commands

• yarn : installation
• yarn compile : compilation
• yarn test : tests
• yarn migrate : migrating to rinkeby
• yarn verify : verifying Token on etherscan

How to deploy your NFT on rinkeby?

• Install using yarn
• Rename .env.example to .env and set the values of environment variables accordingly
• Set the tokenURI in line 12 of Mushroom.sol
• Set the metadata in the meta directory
• Set the nfts in the nfts directory
• Run yarn migrate to deploy the contracts to rinkeby
• Run yarn verify to verify the contracts on etherscan
• Visit https://testnets.opensea.io/ and enter the address of above deployed Mushroom contract
• Enjoy with your NFTs!!!

Notes for MushroomReceiver

• This contract is made to recieve ERC1155 tokens
• The admin of this contract can transfer tokens to anyone

Deployments

• Mushroom
• Token on Opensea

Dependencies

"dependencies": {
    "@openzeppelin/contracts": "^4.0.0",
    "@truffle/hdwallet-provider": "1.0.40",
    "dotenv": "^8.2.0",
    "truffle-plugin-verify": "^0.5.7"
}

Resources/Credits/References

• https://forum.openzeppelin.com/t/create-an-erc1155/4433
• https://github.com/OpenZeppelin/openzeppelin-contracts/tree/master/contracts/token/ERC1155
• https://docs.opensea.io/docs/metadata-standards
• https://docs.openzeppelin.com/contracts/3.x/erc1155#constructing_an_erc1155_token_contract

Token holder & distributor commands

• truffle test

• truffle migrate

• truffle exec scripts/1_mint.js

• requestNFTClaim(_oracle, _jobId, _tokenSymbol).

  • create a request in the oracle
  • oracle will find a NODE for completing this job
  • oracle assigns the job to NODE

• NODE will process the request

  • Confirm the NFTClaim the server
  • If results into true:
    • initiate the transaction to transfer the NFT