This repository walks through how to set up and deploy the contracts for launching your NFT Packs through Sequence.
Each pack is an ERC1155 item that can be purchased through a primary sale contract and transferred between wallets. When a user wants to obtain the pack's contents, they must call the contract's commit function, which burns the pack, and after some time, they receive a random reward according to the distribution by the developer. This can be also used to create bundles containing multiple NFT items in a deterministic fashion by ensuring an equal distribution across all packs.
Use pnpm to install dependencies:
pnpm installThis will also copy .env.example to .env if .env doesn't exist yet.
You can use the pre-provided env vars to test things out.
Run the project locally:
pnpm devThe app will start on localhost:4444
To provide your own keys from Sequence Builder, simply edit the .env file accordingly.
To see the chains supported by sequence click here
Start by selecting your desired project you would like to create a pack for and head to Contracts > Deploy.
Follow this guide in order to deploy a collectible contract as well as upload the collection metadata that you wish to include in the pack content.
Create a CSV with the list of possible contents that will be randomly selected when a Pack is opened. The table should have the following format:
Lootbox ID,Item 1 Token Addr,Item 1 Token IDs,Item 1 Amounts,Item 2 Token Addr,Item 2 Token IDs,Item 2 Amounts
1,0x0e799553da6fff56a501923006896ed99a55658c,"1,2","5,10",0x8b2020feeed9f75b23b07cb8eb36f127479c1fea,4,5
2,0x8b2020feeed9f75b23b07cb8eb36f127479c1fea,5,2,,,
3,0x0e799553da6fff56a501923006896ed99a55658c,3,3,,,
We have an example csv file that you can edit located generated-packs.csv.
Once successfully deployed, return to the contracts page and select + Deploy new contract again. Then select Pack and click Deploy new contract and upload the csv you generated previously.
Make sure that the number of rows in the CSV is equal to the supply you set during the configuration.
Now you need to grant minting permission to the Pack contract for each of the collections that you set previously in the pack content.
- Copy the Pack contract address.
- Navigate to the specific contract and select the settings to view Permissions.
- Once you have the modal open, select the Permissions tab.
- Click Edit or + Add Collaborator.
- Complete the form with the Pack contract address to add it as a collaborator.
- In the dropdown, assign the Minter role.
- Complete and sign the transaction to update the contract Access Control.
Add the Pack contract to the list of sponsored addresses in the Onboard > Gas Sponsorship section.
- Copy the Pack contract address.
- Follow the appropriate guide to set up your Gas Tank and include the contract address as a sponsored address.
Make sure before running that you update the .env values with your deployed contracts, project ID, and embedded wallet configuration. Afterwards, you can start the application via:
pnpm devTo test out pack openings, mint a few of the packs specifically with Token ID 1 to your wallet address via Builder. Then try out opening packs!
The opening goes through a 2 step process, first a commit() phase where the user commits to opening their pack which kicks off the RNG. Then the reveal() phase which utilizes the RNG to distribute the contents of the randomly chosen pack. If successful, you should see Your Collectibles update in a few moments after opening a pack.
In production, you'll likely want to use a couple methodologies to distribute Packs using your preferred method such as:
- You can mint and send Packs directly to user wallets.
- Or, use a sale contract to allow users to purchase Packs.
Make sure the Pack contract and all collection contracts are correctly configured and permissions are in place before distribution. We also recommend to include an pack opening animation during the commit -> reveal() phase while the RNG processes.