raid-guild/character-sheets-contracts

Contracts for the CharacterSheets suite of contracts by raid guild

Character Sheets

Author: MrDeadCe11

This is a combination of an ERC721 base contract the Character sheets, and an ERC1155 Experience and items. These allow you to mint a erc721 token that will also deploy an ERC6551 token bound account for that token. This acts as a base profile image that can be assigned any erc1155 token on top of that. the items and experience can be give out by the game master which is assigned upon the creation of the contracts.

You will need a copy of Foundry installed before proceeding. See the installation guide for details.

Setup

git clone https://github.com/MrDeadCe11/character-sheets
cd character-sheets
forge install

Run Tests

forge test

Update Gas Snapshots

forge snapshot

Deployment

make deploy-contracts network=<sepolia/gnosis>

Verify Deployed Contracts

make verify-contracts network=<sepolia/gnosis>

Create new characterSheets and sub contracts

To use the character Sheets factory you will need the following addresses available to input into the script

• A list of address that you would like to give administrator privileges to.
• the address of the Moloch Dao who's members will be eligible to use the protocol
• the base image uri for the character sheets NFT contract
• the base METADATA uri for the character sheets nft contract
• the base image URI for the Experience and Items ERC1155 contract
• the base image URI for the Classes contract

The bash script will ask for this info during the creation of the contracts you can either paste them directly into the CLI or add them to the addresses.json file before running the script.

make create-sheets network=<sepolia/gnosis>

Basic contract interactions

once new contracts are deployed you can...

• Make a new Class
• Make a new Item
• Roll a character sheet

make execute network=<sepolia/gnosis>

Pumpedlunch's Hats Module addresses: from https://github.com/pumpedlunch/HatsEligibilityModules/releases

• Gnosis
• AddressHatsEligiblityModule: 0x9AaF0df5657b634131784523F4F5e83459c61986
• ERC721HatsEligibilityModule: 0x6bAa65D3E024D8ebA717085691dd8A985e9F267E

character-sheets-contracts's Issues

Add ability for a character from one game to join another game

• Being added to an additional game requires passing the game's existing eligibility check
• If they pass, they would receive a player hat, and their character would receive a character hat
• Note that XP, classes, and items between games will remain separate

Deploy contracts to Optimism, Polygon, and Sepolia

Alter crafting in contracts to not transfer assets from external contracts.

If an item requirement doesn't originate from the items/classes/exp contracts don't transfer it to our contracts, only check that the required balance is held by the account.

Burn XP only for emergencies

• Remove all burn XP calls, except for functions that are meant to be used as an emergency
• Emergency class burning should include burning class-XP (Refer #32)

Fix item distribution when used for crafting

if certain items are used for crafting then they are transferred to the items manager.
Then if the player dismantled those crafter items there is a possibility of the user obtaining item that amounts to more than the distribution.

Allow gameMaster or "anyone" to rollCharacterSheet for a player

After transferring a character, the player can no longer create a new character

• Even after transferring their character, a player is unable to create a new one (the function call reverts)
• It's also not possible for the new player of the character to transfer it back to the old player

Support class specific XP

• Add a address => classId => xpBalance mapping to the class contract, so that XP can be associated with a particular class
• A mintXP function should be added to the class contract, which updates the balance of the class-XP mapping, and also mints the existing ERC-20 XP
• If class-based XP passes a level threshold, an additional class NFT should be minted (thus leveling up that class)

Mint new hat when an eligible address is added

• To avoid doing two transactions on the frontend, the eligibility modules should wrap minting of a new hat with addEligibleAddresses
• https://github.com/raid-guild/character-sheets-contracts/blob/main/src/adaptors/hats-modules/AdminHatEligibilityModule.sol#L119

Upgrade item contract to allow "and/or" class restrictions