Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 3.3 KB

README.md

File metadata and controls

55 lines (37 loc) · 3.3 KB

ByoMint - a compressed NFT (cNFT) mint program for custom minting and controlled distribution of assets on Solana.

This program leverages compression on Solana enabling creators to mint and distribute cNFTs with minter customization and control.

Mainnet Program ID: GnukyHhbXhqeswaZbzDiTLZeMSHMuWNTNxw4buhS6zpg

Accounts

Faucet

On creation of a Faucet, an Collection NFT is minted to the Faucet. Each cNFT emitted will be part of said collection. Faucets have a supply_cap that limits the amount of cNFTs that can minted to a collection. The supply_cap is the total number of cNFTs that the faucet is able to emit at a given point in time. The supply_cap is an mutable property that gives the creator the power to incrementally emit tokens. Faucets have a mint_price that is also mutable so that cost of minting a cNFT to the collection can be updated. Once created, new merkle trees can be added to the Facuet at any point in time so that collection can continue to grow as needed.

When creating the faucet, the creator must provide a mint_price and seller_fee_basis_points (royalty percentage). For each cNFT that is minted, the designated mint_price is sent the Faucet account as payment for the cNFT. This program hard codes a royalty split of 50/50 to the Faucet and the wallet that mints the cNFT. If the cNFT is sold on secondary markets, like tesnor.trade, the designated seller_fee_basis_points sent to the Faucet and the minter's wallet. Use the instruction withdraw_fees as the authority of the Faucet to access the funds the faucet generates.

Faucet WL Same as above, but with the additional wl_collection that requires the minter to hold an NFT from the given collection.

Metadata Map

Metadata is assigned to cNFTs after the the token is minted. The map enables projects to customized how many layers (traits) and variants are avaialble. The number of layers is capped at 10, and the cap of variants for each layer is 255.

It is important to note that the JSON metadata file, and image need to be generated using other means that this program. A suggested solution is to use a Helius Webhook to trigger code to run that generates the JSON and image uploads them to ShdwDrive.

BYO Mint

This empty account is created during mint using the layers that the minter chooses. This PDA is essential for ensuring that each cNFT minted to the colleciton is unique.

BYO Mint

This empty account is created during mint using the mint of the token from the whitelisted collection. This PDA is essential for ensuring that there is a 1:1 relationship between cNFT mints and NFTs held from the whitelisted collection.

Instructions

create_metadata_map delete_metadata_map create_faucet add_new_tree mint update_faucet withdraw_fees create_faucet_wl add_new_tree_wl mint_wl update_faucet_wl withdraw_fees_wl

I created these projects to showcase this repo:

BYOGnomes Saga Sentients

TODOs + Project Extensions

  • Add customization for royalty splits between minter/faucet
  • NFT/SFT/SPL burn in exchange for cNFT
  • Add bg color change ix
  • Enable adding variants to metadata maps