In Game Quest Contract

Summary

1. Description
2. Features
3. Token ID
4. Events
5. Running Tests
6. How To Deploy The Contract
7. Deployed Contract

Description

A Solidity smart contract implementing soulbound ERC1155 tokens for in-game quests. This contract ensures that tokens representing quests or achievements cannot be transferred or approved for transfer, effectively making them soulbound.

Features

• Soulbound Tokens: Tokens cannot be transferred approved for transfer or burned by anyone, including the owner.
• Access Control: Utilizes OpenZeppelin's AccessControl for role-based permissions.
• Minting: Only addresses with the MINTER_ROLE can mint new tokens or batches of tokens. In order to get this role, an admin should grant it.
• URI Setting: Only addresses with the URI_SETTER_ROLE can update the token URI.

Token ID

mint and mintBatch functions accept an Id that will be constructed off-chain this way:

- first 4 cyphers is the game id, eg: 1234
- second 7 cyphers for the quest id, eg: 0004567
- the resulting id will be: #12340004567

This way the tokenId will always be 4+7=11 cyphers. This is an important constraint since the smart contract need it for security reasons.

Events

The contract will emit:

• when mint(address account, uint256 id, uint256 amount, bytes memory data) is called:

event TransferSingle(address indexed operator, address indexed from, address indexed to, uint256 id, uint256 value);

• when mintBatch(address to, uint256[] memory ids, uint256[] memory amounts, bytes memory data) is called:

event TransferBatch(
        address indexed operator,
        address indexed from,
        address indexed to,
        uint256[] ids,
        uint256[] values
    );

• when addGameIdAndMinter(uint256 gameID, address minter)

    event MinterSet(uint256 indexed gameID, address indexed minter);

• when function removeGameIdAndMinter(uint256 gameID)

     event MinterRemoved(uint256 indexed gameID, address indexed minter);

Running Tests

To run tests, run the following command

    make test-all

How To Deploy The Contract

you need to add an account using cast wallet import, give it a name and add it to the .env.testnet file (or the .env.mainnet, to deploy on mainnet), then run

the command below is to deploy on testnet. Commands to deploy on mainnet will come shortly.

    make deploy-testnet

Deployed Contract

• testnet: 0xBF05b6CF5dF3891327a601543719b37593047C00