Enum mpl_token_metadata::instruction::MetadataInstruction

source · [−]
pub enum MetadataInstruction {

Show 26 variants    CreateMetadataAccount(CreateMetadataAccountArgs),
    UpdateMetadataAccount(UpdateMetadataAccountArgs),
    DeprecatedCreateMasterEdition(CreateMasterEditionArgs),
    DeprecatedMintNewEditionFromMasterEditionViaPrintingToken,
    UpdatePrimarySaleHappenedViaToken,
    DeprecatedSetReservationList(SetReservationListArgs),
    DeprecatedCreateReservationList,
    SignMetadata,
    DeprecatedMintPrintingTokensViaToken(MintPrintingTokensViaTokenArgs),
    DeprecatedMintPrintingTokens(MintPrintingTokensViaTokenArgs),
    CreateMasterEdition(CreateMasterEditionArgs),
    MintNewEditionFromMasterEditionViaToken(MintNewEditionFromMasterEditionViaTokenArgs),
    ConvertMasterEditionV1ToV2,
    MintNewEditionFromMasterEditionViaVaultProxy(MintNewEditionFromMasterEditionViaTokenArgs),
    PuffMetadata,
    UpdateMetadataAccountV2(UpdateMetadataAccountArgsV2),
    CreateMetadataAccountV2(CreateMetadataAccountArgsV2),
    CreateMasterEditionV3(CreateMasterEditionArgs),
    VerifyCollection,
    Utilize(UtilizeArgs),
    ApproveUseAuthority(ApproveUseAuthorityArgs),
    RevokeUseAuthority,
    UnverifyCollection,
    ApproveCollectionAuthority,
    RevokeCollectionAuthority,
    SetAndVerifyCollection,

}
Expand description

Instructions supported by the Metadata program.

Variants

CreateMetadataAccount(CreateMetadataAccountArgs)

Create Metadata object. 0. [writable] Metadata key (pda of [‘metadata’, program id, mint id])

  1. [] Mint of token asset
  2. [signer] Mint authority
  3. [signer] payer
  4. [] update authority info
  5. [] System program
  6. [] Rent info

UpdateMetadataAccount(UpdateMetadataAccountArgs)

Update a Metadata 0. [writable] Metadata account

  1. [signer] Update authority key

DeprecatedCreateMasterEdition(CreateMasterEditionArgs)

Register a Metadata as a Master Edition V1, which means Editions can be minted. Henceforth, no further tokens will be mintable from this primary mint. Will throw an error if more than one token exists, and will throw an error if less than one token exists in this primary mint. 0. [writable] Unallocated edition V1 account with address as pda of [‘metadata’, program id, mint, ‘edition’]

  1. [writable] Metadata mint
  2. [writable] Printing mint - A mint you control that can mint tokens that can be exchanged for limited editions of your master edition via the MintNewEditionFromMasterEditionViaToken endpoint
  3. [writable] One time authorization printing mint - A mint you control that prints tokens that gives the bearer permission to mint any number of tokens from the printing mint one time via an endpoint with the token-metadata program for your metadata. Also burns the token.
  4. [signer] Current Update authority key
  5. [signer] Printing mint authority - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY.
  6. [signer] Mint authority on the metadata’s mint - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY
  7. [] Metadata account
  8. [signer] payer
  9. [] Token program
  10. [] System program
  11. [] Rent info
  12. [signer] One time authorization printing mint authority - must be provided if using max supply. THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY.

DeprecatedMintNewEditionFromMasterEditionViaPrintingToken

Given an authority token minted by the Printing mint of a master edition, and a brand new non-metadata-ed mint with one token make a new Metadata + Edition that is a child of the master edition denoted by this authority token. 0. [writable] New Metadata key (pda of [‘metadata’, program id, mint id])

  1. [writable] New Edition V1 (pda of [‘metadata’, program id, mint id, ‘edition’])
  2. [writable] Master Record Edition V1 (pda of [‘metadata’, program id, master metadata mint id, ‘edition’])
  3. [writable] Mint of new token - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY
  4. [signer] Mint authority of new mint
  5. [writable] Printing Mint of master record edition
  6. [writable] Token account containing Printing mint token to be transferred
  7. [writable] Edition pda to mark creation - will be checked for pre-existence. (pda of [‘metadata’, program id, master mint id, edition_number])
  8. [signer] Burn authority for this token
  9. [signer] payer
  10. [] update authority info for new metadata account
  11. [] Master record metadata account
  12. [] Token program
  13. [] System program
  14. [] Rent info
  15. [optional/writable] Reservation List - If present, and you are on this list, you can get an edition number given by your position on the list.

UpdatePrimarySaleHappenedViaToken

Allows updating the primary sale boolean on Metadata solely through owning an account containing a token from the metadata’s mint and being a signer on this transaction. A sort of limited authority for limited update capability that is required for things like Metaplex to work without needing full authority passing.

  1. [writable] Metadata key (pda of [‘metadata’, program id, mint id])
  2. [signer] Owner on the token account
  3. [] Account containing tokens from the metadata’s mint

DeprecatedSetReservationList(SetReservationListArgs)

Reserve up to 200 editions in sequence for up to 200 addresses in an existing reservation PDA, which can then be used later by redeemers who have printing tokens as a reservation to get a specific edition number as opposed to whatever one is currently listed on the master edition. Used by Auction Manager to guarantee printing order on bid redemption. AM will call whenever the first person redeems a printing bid to reserve the whole block of winners in order and then each winner when they get their token submits their mint and account with the pda that was created by that first bidder - the token metadata can then cross reference these people with the list and see that bidder A gets edition #2, so on and so forth.

NOTE: If you have more than 20 addresses in a reservation list, this may be called multiple times to build up the list, otherwise, it simply wont fit in one transaction. Only provide a total_reservation argument on the first call, which will allocate the edition space, and in follow up calls this will specifically be unnecessary (and indeed will error.)

  1. [writable] Master Edition V1 key (pda of [‘metadata’, program id, mint id, ‘edition’])
  2. [writable] PDA for ReservationList of [‘metadata’, program id, master edition key, ‘reservation’, resource-key]
  3. [signer] The resource you tied the reservation list too

DeprecatedCreateReservationList

Create an empty reservation list for a resource who can come back later as a signer and fill the reservation list with reservations to ensure that people who come to get editions get the number they expect. See SetReservationList for more.

  1. [writable] PDA for ReservationList of [‘metadata’, program id, master edition key, ‘reservation’, resource-key]
  2. [signer] Payer
  3. [signer] Update authority
  4. [] Master Edition V1 key (pda of [‘metadata’, program id, mint id, ‘edition’])
  5. [] A resource you wish to tie the reservation list to. This is so your later visitors who come to redeem can derive your reservation list PDA with something they can easily get at. You choose what this should be.
  6. [] Metadata key (pda of [‘metadata’, program id, mint id])
  7. [] System program
  8. [] Rent info

SignMetadata

Sign a piece of metadata that has you as an unverified creator so that it is now verified. 0. [writable] Metadata (pda of [‘metadata’, program id, mint id])

  1. [signer] Creator

DeprecatedMintPrintingTokensViaToken(MintPrintingTokensViaTokenArgs)

Using a one time authorization token from a master edition v1, print any number of printing tokens from the printing_mint one time, burning the one time authorization token.

  1. [writable] Destination account
  2. [writable] Token account containing one time authorization token
  3. [writable] One time authorization mint
  4. [writable] Printing mint
  5. [signer] Burn authority
  6. [] Metadata key (pda of [‘metadata’, program id, mint id])
  7. [] Master Edition V1 key (pda of [‘metadata’, program id, mint id, ‘edition’])
  8. [] Token program
  9. [] Rent

DeprecatedMintPrintingTokens(MintPrintingTokensViaTokenArgs)

Using your update authority, mint printing tokens for your master edition.

  1. [writable] Destination account
  2. [writable] Printing mint
  3. [signer] Update authority
  4. [] Metadata key (pda of [‘metadata’, program id, mint id])
  5. [] Master Edition V1 key (pda of [‘metadata’, program id, mint id, ‘edition’])
  6. [] Token program
  7. [] Rent

CreateMasterEdition(CreateMasterEditionArgs)

Register a Metadata as a Master Edition V2, which means Edition V2s can be minted. Henceforth, no further tokens will be mintable from this primary mint. Will throw an error if more than one token exists, and will throw an error if less than one token exists in this primary mint. 0. [writable] Unallocated edition V2 account with address as pda of [‘metadata’, program id, mint, ‘edition’]

  1. [writable] Metadata mint
  2. [signer] Update authority
  3. [signer] Mint authority on the metadata’s mint - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY
  4. [signer] payer
  5. [] Metadata account
  6. [] Token program
  7. [] System program
  8. [] Rent info

MintNewEditionFromMasterEditionViaToken(MintNewEditionFromMasterEditionViaTokenArgs)

Given a token account containing the master edition token to prove authority, and a brand new non-metadata-ed mint with one token make a new Metadata + Edition that is a child of the master edition denoted by this authority token. 0. [writable] New Metadata key (pda of [‘metadata’, program id, mint id])

  1. [writable] New Edition (pda of [‘metadata’, program id, mint id, ‘edition’])
  2. [writable] Master Record Edition V2 (pda of [‘metadata’, program id, master metadata mint id, ‘edition’])
  3. [writable] Mint of new token - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY
  4. [writable] Edition pda to mark creation - will be checked for pre-existence. (pda of [‘metadata’, program id, master metadata mint id, ‘edition’, edition_number]) where edition_number is NOT the edition number you pass in args but actually edition_number = floor(edition/EDITION_MARKER_BIT_SIZE).
  5. [signer] Mint authority of new mint
  6. [signer] payer
  7. [signer] owner of token account containing master token (#8)
  8. [] token account containing token from master metadata mint
  9. [] Update authority info for new metadata
  10. [] Master record metadata account
  11. [] Token program
  12. [] System program
  13. [] Rent info

ConvertMasterEditionV1ToV2

Converts the Master Edition V1 to a Master Edition V2, draining lamports from the two printing mints to the owner of the token account holding the master edition token. Permissionless. Can only be called if there are currenly no printing tokens or one time authorization tokens in circulation.

  1. [writable] Master Record Edition V1 (pda of [‘metadata’, program id, master metadata mint id, ‘edition’])
  2. [writable] One time authorization mint
  3. [writable] Printing mint

MintNewEditionFromMasterEditionViaVaultProxy(MintNewEditionFromMasterEditionViaTokenArgs)

Proxy Call to Mint Edition using a Store Token Account as a Vault Authority.

  1. [writable] New Metadata key (pda of [‘metadata’, program id, mint id])
  2. [writable] New Edition (pda of [‘metadata’, program id, mint id, ‘edition’])
  3. [writable] Master Record Edition V2 (pda of [‘metadata’, program id, master metadata mint id, ‘edition’]
  4. [writable] Mint of new token - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY
  5. [writable] Edition pda to mark creation - will be checked for pre-existence. (pda of [‘metadata’, program id, master metadata mint id, ‘edition’, edition_number]) where edition_number is NOT the edition number you pass in args but actually edition_number = floor(edition/EDITION_MARKER_BIT_SIZE).
  6. [signer] Mint authority of new mint
  7. [signer] payer
  8. [signer] Vault authority
  9. [] Safety deposit token store account
  10. [] Safety deposit box
  11. [] Vault
  12. [] Update authority info for new metadata
  13. [] Master record metadata account
  14. [] Token program
  15. [] Token vault program
  16. [] System program
  17. [] Rent info

PuffMetadata

Puff a Metadata - make all of it’s variable length fields (name/uri/symbol) a fixed length using a null character so that it can be found using offset searches by the RPC to make client lookups cheaper. 0. [writable] Metadata account

UpdateMetadataAccountV2(UpdateMetadataAccountArgsV2)

Update a Metadata with is_mutable as a parameter 0. [writable] Metadata account

  1. [signer] Update authority key

CreateMetadataAccountV2(CreateMetadataAccountArgsV2)

Create Metadata object. 0. [writable] Metadata key (pda of [‘metadata’, program id, mint id])

  1. [] Mint of token asset
  2. [signer] Mint authority
  3. [signer] payer
  4. [] update authority info
  5. [] System program
  6. [] Rent info

CreateMasterEditionV3(CreateMasterEditionArgs)

Register a Metadata as a Master Edition V2, which means Edition V2s can be minted. Henceforth, no further tokens will be mintable from this primary mint. Will throw an error if more than one token exists, and will throw an error if less than one token exists in this primary mint. 0. [writable] Unallocated edition V2 account with address as pda of [‘metadata’, program id, mint, ‘edition’]

  1. [writable] Metadata mint
  2. [signer] Update authority
  3. [signer] Mint authority on the metadata’s mint - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY
  4. [signer] payer
  5. [writable] Metadata account
  6. [] Token program
  7. [] System program
  8. [] Rent info

VerifyCollection

See verify_collection for Doc

Utilize(UtilizeArgs)

See utilize for Doc

ApproveUseAuthority(ApproveUseAuthorityArgs)

See approve_use_authority for Doc

RevokeUseAuthority

See revoke_use_authority for Doc

UnverifyCollection

See unverify_collection for Doc

ApproveCollectionAuthority

See approve_collection_authority for Doc

RevokeCollectionAuthority

See revoke_collection_authority for Doc

SetAndVerifyCollection

See set_and_verify_collection for Doc

Trait Implementations

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes. Read more

Deserialize this instance from a slice of bytes.

Serialize this instance into a vector of bytes.

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.