Options
All
  • Public
  • Public/Protected
  • All
Menu

@metaplex-foundation/mpl-token-metadata

Index

Accounts

Instructions

Errors

constants

enums

userTypes

sdk

generated

ApproveCollectionAuthority

ApproveUseAuthority

BurnNft

ConvertMasterEditionV1ToV2

CreateMasterEdition

CreateMasterEditionV3

CreateMetadataAccount

CreateMetadataAccountV2

CreateMetadataAccountV3

DeprecatedCreateMasterEdition

DeprecatedCreateReservationList

DeprecatedMintNewEditionFromMasterEditionViaPrintingToken

DeprecatedMintPrintingTokens

DeprecatedMintPrintingTokensViaToken

DeprecatedSetReservationList

FreezeDelegatedAccount

MintNewEditionFromMasterEditionViaToken

MintNewEditionFromMasterEditionViaVaultProxy

PuffMetadata

RemoveCreatorVerification

RevokeCollectionAuthority

RevokeUseAuthority

SetAndVerifyCollection

SetAndVerifySizedCollectionItem

SetCollectionSize

SetTokenStandard

SignMetadata

ThawDelegatedAccount

UnverifyCollection

UnverifySizedCollectionItem

UpdateMetadataAccount

UpdateMetadataAccountV2

UpdatePrimarySaleHappenedViaToken

Utilize

VerifyCollection

VerifySizedCollectionItem

Accounts

CollectionAuthorityRecordArgs: { bump: number; key: Key }

Arguments used to create CollectionAuthorityRecord

Type declaration

  • bump: number
  • key: Key
EditionArgs: { edition: beet.bignum; key: Key; parent: web3.PublicKey }

Arguments used to create Edition

Type declaration

  • edition: beet.bignum
  • key: Key
  • parent: web3.PublicKey
EditionMarkerArgs: { key: Key; ledger: number[] }

Arguments used to create EditionMarker

Type declaration

  • key: Key
  • ledger: number[]
MasterEditionV1Args: { key: Key; maxSupply: beet.COption<beet.bignum>; oneTimePrintingAuthorizationMint: web3.PublicKey; printingMint: web3.PublicKey; supply: beet.bignum }

Arguments used to create MasterEditionV1

Type declaration

  • key: Key
  • maxSupply: beet.COption<beet.bignum>
  • oneTimePrintingAuthorizationMint: web3.PublicKey
  • printingMint: web3.PublicKey
  • supply: beet.bignum
MasterEditionV2Args: { key: Key; maxSupply: beet.COption<beet.bignum>; supply: beet.bignum }

Arguments used to create MasterEditionV2

Type declaration

  • key: Key
  • maxSupply: beet.COption<beet.bignum>
  • supply: beet.bignum
MetadataArgs: { collection: beet.COption<Collection>; collectionDetails: beet.COption<CollectionDetails>; data: Data; editionNonce: beet.COption<number>; isMutable: boolean; key: Key; mint: web3.PublicKey; primarySaleHappened: boolean; tokenStandard: beet.COption<TokenStandard>; updateAuthority: web3.PublicKey; uses: beet.COption<Uses> }

Arguments used to create Metadata

Type declaration

  • collection: beet.COption<Collection>
  • collectionDetails: beet.COption<CollectionDetails>
  • data: Data
  • editionNonce: beet.COption<number>
  • isMutable: boolean
  • key: Key
  • mint: web3.PublicKey
  • primarySaleHappened: boolean
  • tokenStandard: beet.COption<TokenStandard>
  • updateAuthority: web3.PublicKey
  • uses: beet.COption<Uses>
ReservationListV1Args: { key: Key; masterEdition: web3.PublicKey; reservations: ReservationV1[]; supplySnapshot: beet.COption<beet.bignum> }

Arguments used to create ReservationListV1

Type declaration

  • key: Key
  • masterEdition: web3.PublicKey
  • reservations: ReservationV1[]
  • supplySnapshot: beet.COption<beet.bignum>
ReservationListV2Args: { currentReservationSpots: beet.bignum; key: Key; masterEdition: web3.PublicKey; reservations: Reservation[]; supplySnapshot: beet.COption<beet.bignum>; totalReservationSpots: beet.bignum }

Arguments used to create ReservationListV2

Type declaration

  • currentReservationSpots: beet.bignum
  • key: Key
  • masterEdition: web3.PublicKey
  • reservations: Reservation[]
  • supplySnapshot: beet.COption<beet.bignum>
  • totalReservationSpots: beet.bignum
UseAuthorityRecordArgs: { allowedUses: beet.bignum; bump: number; key: Key }

Arguments used to create UseAuthorityRecord

Type declaration

  • allowedUses: beet.bignum
  • bump: number
  • key: Key
collectionAuthorityRecordBeet: BeetStruct<CollectionAuthorityRecord, CollectionAuthorityRecordArgs> = ...
editionBeet: BeetStruct<Edition, EditionArgs> = ...
editionMarkerBeet: BeetStruct<EditionMarker, EditionMarkerArgs> = ...
masterEditionV1Beet: FixableBeetStruct<MasterEditionV1, MasterEditionV1Args> = ...
masterEditionV2Beet: FixableBeetStruct<MasterEditionV2, MasterEditionV2Args> = ...
metadataBeet: FixableBeetStruct<Metadata, MetadataArgs> = ...
reservationListV1Beet: FixableBeetStruct<ReservationListV1, ReservationListV1Args> = ...
reservationListV2Beet: FixableBeetStruct<ReservationListV2, ReservationListV2Args> = ...
useAuthorityRecordBeet: BeetStruct<UseAuthorityRecord, UseAuthorityRecordArgs> = ...

Instructions

ApproveCollectionAuthorityInstructionAccounts: { collectionAuthorityRecord: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; newCollectionAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the ApproveCollectionAuthority instruction

property

[writable] collectionAuthorityRecord Collection Authority Record PDA

property

[] newCollectionAuthority A Collection Authority

property

[writable, signer] updateAuthority Update Authority of Collection NFT

property

[writable, signer] payer Payer

property

[] metadata Collection Metadata account

property

[] mint Mint of Collection Metadata

Type declaration

  • collectionAuthorityRecord: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • newCollectionAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
ApproveUseAuthorityInstructionAccounts: { burner: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; owner: web3.PublicKey; ownerTokenAccount: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenProgram?: web3.PublicKey; useAuthorityRecord: web3.PublicKey; user: web3.PublicKey }

Accounts required by the ApproveUseAuthority instruction

property

[writable] useAuthorityRecord Use Authority Record PDA

property

[writable, signer] owner Owner

property

[writable, signer] payer Payer

property

[] user A Use Authority

property

[writable] ownerTokenAccount Owned Token Account Of Mint

property

[] metadata Metadata account

property

[] mint Mint of Metadata

property

[] burner Program As Signer (Burner)

Type declaration

  • burner: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • owner: web3.PublicKey
  • ownerTokenAccount: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • useAuthorityRecord: web3.PublicKey
  • user: web3.PublicKey
ApproveUseAuthorityInstructionArgs: { approveUseAuthorityArgs: ApproveUseAuthorityArgs }

Type declaration

BurnNftInstructionAccounts: { collectionMetadata?: web3.PublicKey; masterEditionAccount: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; owner: web3.PublicKey; splTokenProgram: web3.PublicKey; tokenAccount: web3.PublicKey }

Accounts required by the BurnNft instruction

property

[writable] metadata Metadata (pda of ['metadata', program id, mint id])

property

[writable, signer] owner NFT owner

property

[writable] mint Mint of the NFT

property

[writable] tokenAccount Token account to close

property

[writable] masterEditionAccount MasterEdition2 of the NFT

property

[] splTokenProgram SPL Token Program

property

[writable] collectionMetadata (optional) Metadata of the Collection

Type declaration

  • Optional collectionMetadata?: web3.PublicKey
  • masterEditionAccount: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • owner: web3.PublicKey
  • splTokenProgram: web3.PublicKey
  • tokenAccount: web3.PublicKey
ConvertMasterEditionV1ToV2InstructionAccounts: { masterEdition: web3.PublicKey; oneTimeAuth: web3.PublicKey; printingMint: web3.PublicKey }

Accounts required by the ConvertMasterEditionV1ToV2 instruction

property

[writable] masterEdition Master Record Edition V1 (pda of ['metadata', program id, master metadata mint id, 'edition'])

property

[writable] oneTimeAuth One time authorization mint

property

[writable] printingMint Printing mint

Type declaration

  • masterEdition: web3.PublicKey
  • oneTimeAuth: web3.PublicKey
  • printingMint: web3.PublicKey
CreateMasterEditionInstructionAccounts: { edition: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; mintAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the CreateMasterEdition instruction

property

[writable] edition Unallocated edition V2 account with address as pda of ['metadata', program id, mint, 'edition']

property

[writable] mint Metadata mint

property

[signer] updateAuthority Update authority

property

[signer] mintAuthority Mint authority on the metadata's mint - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY

property

[writable, signer] payer payer

property

[] metadata Metadata account

Type declaration

  • edition: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • mintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
CreateMasterEditionInstructionArgs: { createMasterEditionArgs: CreateMasterEditionArgs }

Type declaration

CreateMasterEditionV3InstructionAccounts: { edition: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; mintAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the CreateMasterEditionV3 instruction

property

[writable] edition Unallocated edition V2 account with address as pda of ['metadata', program id, mint, 'edition']

property

[writable] mint Metadata mint

property

[signer] updateAuthority Update authority

property

[signer] mintAuthority Mint authority on the metadata's mint - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY

property

[writable, signer] payer payer

property

[writable] metadata Metadata account

Type declaration

  • edition: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • mintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
CreateMasterEditionV3InstructionArgs: { createMasterEditionArgs: CreateMasterEditionArgs }

Type declaration

CreateMetadataAccountInstructionAccounts: { metadata: web3.PublicKey; mint: web3.PublicKey; mintAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the CreateMetadataAccount instruction

property

[writable] metadata Metadata key (pda of ['metadata', program id, mint id])

property

[] mint Mint of token asset

property

[signer] mintAuthority Mint authority

property

[writable, signer] payer payer

property

[] updateAuthority update authority info

Type declaration

  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • mintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
CreateMetadataAccountInstructionArgs: { createMetadataAccountArgs: CreateMetadataAccountArgs }

Type declaration

CreateMetadataAccountV2InstructionAccounts: { metadata: web3.PublicKey; mint: web3.PublicKey; mintAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the CreateMetadataAccountV2 instruction

property

[writable] metadata Metadata key (pda of ['metadata', program id, mint id])

property

[] mint Mint of token asset

property

[signer] mintAuthority Mint authority

property

[writable, signer] payer payer

property

[] updateAuthority update authority info

Type declaration

  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • mintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
CreateMetadataAccountV2InstructionArgs: { createMetadataAccountArgsV2: CreateMetadataAccountArgsV2 }

Type declaration

CreateMetadataAccountV3InstructionAccounts: { metadata: web3.PublicKey; mint: web3.PublicKey; mintAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the CreateMetadataAccountV3 instruction

property

[writable] metadata Metadata key (pda of ['metadata', program id, mint id])

property

[] mint Mint of token asset

property

[signer] mintAuthority Mint authority

property

[writable, signer] payer payer

property

[] updateAuthority update authority info

Type declaration

  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • mintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
CreateMetadataAccountV3InstructionArgs: { createMetadataAccountArgsV3: CreateMetadataAccountArgsV3 }

Type declaration

DeprecatedCreateMasterEditionInstructionAccounts: { edition: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; mintAuthority: web3.PublicKey; oneTimePrintingAuthorizationMint: web3.PublicKey; oneTimePrintingAuthorizationMintAuthority: web3.PublicKey; payer: web3.PublicKey; printingMint: web3.PublicKey; printingMintAuthority: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the DeprecatedCreateMasterEdition instruction

property

[writable] edition Unallocated edition V1 account with address as pda of ['metadata', program id, mint, 'edition']

property

[writable] mint Metadata mint

property

[writable] printingMint 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

property

[writable] oneTimePrintingAuthorizationMint 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.

property

[signer] updateAuthority Current Update authority key

property

[signer] printingMintAuthority Printing mint authority - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY.

property

[signer] mintAuthority Mint authority on the metadata's mint - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY

property

[] metadata Metadata account

property

[signer] payer payer

property

[signer] oneTimePrintingAuthorizationMintAuthority One time authorization printing mint authority - must be provided if using max supply. THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY.

Type declaration

  • edition: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • mintAuthority: web3.PublicKey
  • oneTimePrintingAuthorizationMint: web3.PublicKey
  • oneTimePrintingAuthorizationMintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • printingMint: web3.PublicKey
  • printingMintAuthority: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
DeprecatedCreateMasterEditionInstructionArgs: { createMasterEditionArgs: CreateMasterEditionArgs }

Type declaration

DeprecatedCreateReservationListInstructionAccounts: { masterEdition: web3.PublicKey; metadata: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; reservationList: web3.PublicKey; resource: web3.PublicKey; systemProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the DeprecatedCreateReservationList instruction

property

[writable] reservationList PDA for ReservationList of ['metadata', program id, master edition key, 'reservation', resource-key]

property

[signer] payer Payer

property

[signer] updateAuthority Update authority

property

[] masterEdition Master Edition V1 key (pda of ['metadata', program id, mint id, 'edition'])

property

[] resource 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.

property

[] metadata Metadata key (pda of ['metadata', program id, mint id])

Type declaration

  • masterEdition: web3.PublicKey
  • metadata: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • reservationList: web3.PublicKey
  • resource: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
DeprecatedMintNewEditionFromMasterEditionViaPrintingTokenInstructionAccounts: { burnAuthority: web3.PublicKey; edition: web3.PublicKey; editionMarker: web3.PublicKey; masterEdition: web3.PublicKey; masterMetadata: web3.PublicKey; masterTokenAccount: web3.PublicKey; masterUpdateAuthority: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; mintAuthority: web3.PublicKey; payer: web3.PublicKey; printingMint: web3.PublicKey; rent?: web3.PublicKey; reservationList?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenProgram?: web3.PublicKey }

Accounts required by the DeprecatedMintNewEditionFromMasterEditionViaPrintingToken instruction

property

[writable] metadata New Metadata key (pda of ['metadata', program id, mint id])

property

[writable] edition New Edition V1 (pda of ['metadata', program id, mint id, 'edition'])

property

[writable] masterEdition Master Record Edition V1 (pda of ['metadata', program id, master metadata mint id, 'edition'])

property

[writable] mint Mint of new token - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY

property

[signer] mintAuthority Mint authority of new mint

property

[writable] printingMint Printing Mint of master record edition

property

[writable] masterTokenAccount Token account containing Printing mint token to be transferred

property

[writable] editionMarker Edition pda to mark creation - will be checked for pre-existence. (pda of ['metadata', program id, master mint id, edition_number])

property

[signer] burnAuthority Burn authority for this token

property

[signer] payer payer

property

[] masterUpdateAuthority update authority info for new metadata account

property

[] masterMetadata Master record metadata account

property

[writable] reservationList (optional) Reservation List - If present, and you are on this list, you can get an edition number given by your position on the list.

Type declaration

  • burnAuthority: web3.PublicKey
  • edition: web3.PublicKey
  • editionMarker: web3.PublicKey
  • masterEdition: web3.PublicKey
  • masterMetadata: web3.PublicKey
  • masterTokenAccount: web3.PublicKey
  • masterUpdateAuthority: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • mintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • printingMint: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional reservationList?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
DeprecatedMintPrintingTokensInstructionAccounts: { destination: web3.PublicKey; masterEdition: web3.PublicKey; metadata: web3.PublicKey; printingMint: web3.PublicKey; rent?: web3.PublicKey; tokenProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the DeprecatedMintPrintingTokens instruction

property

[writable] destination Destination account

property

[writable] printingMint Printing mint

property

[signer] updateAuthority Update authority

property

[] metadata Metadata key (pda of ['metadata', program id, mint id])

property

[] masterEdition Master Edition V1 key (pda of ['metadata', program id, mint id, 'edition'])

Type declaration

  • destination: web3.PublicKey
  • masterEdition: web3.PublicKey
  • metadata: web3.PublicKey
  • printingMint: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
DeprecatedMintPrintingTokensInstructionArgs: { mintPrintingTokensViaTokenArgs: MintPrintingTokensViaTokenArgs }

Type declaration

DeprecatedMintPrintingTokensViaTokenInstructionAccounts: { burnAuthority: web3.PublicKey; destination: web3.PublicKey; masterEdition: web3.PublicKey; metadata: web3.PublicKey; oneTimePrintingAuthorizationMint: web3.PublicKey; printingMint: web3.PublicKey; rent?: web3.PublicKey; token: web3.PublicKey; tokenProgram?: web3.PublicKey }

Accounts required by the DeprecatedMintPrintingTokensViaToken instruction

property

[writable] destination Destination account

property

[writable] token Token account containing one time authorization token

property

[writable] oneTimePrintingAuthorizationMint One time authorization mint

property

[writable] printingMint Printing mint

property

[signer] burnAuthority Burn authority

property

[] metadata Metadata key (pda of ['metadata', program id, mint id])

property

[] masterEdition Master Edition V1 key (pda of ['metadata', program id, mint id, 'edition'])

Type declaration

  • burnAuthority: web3.PublicKey
  • destination: web3.PublicKey
  • masterEdition: web3.PublicKey
  • metadata: web3.PublicKey
  • oneTimePrintingAuthorizationMint: web3.PublicKey
  • printingMint: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • token: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
DeprecatedMintPrintingTokensViaTokenInstructionArgs: { mintPrintingTokensViaTokenArgs: MintPrintingTokensViaTokenArgs }

Type declaration

DeprecatedSetReservationListInstructionAccounts: { masterEdition: web3.PublicKey; reservationList: web3.PublicKey; resource: web3.PublicKey }

Accounts required by the DeprecatedSetReservationList instruction

property

[writable] masterEdition Master Edition V1 key (pda of ['metadata', program id, mint id, 'edition'])

property

[writable] reservationList PDA for ReservationList of ['metadata', program id, master edition key, 'reservation', resource-key]

property

[signer] resource The resource you tied the reservation list too

Type declaration

  • masterEdition: web3.PublicKey
  • reservationList: web3.PublicKey
  • resource: web3.PublicKey
DeprecatedSetReservationListInstructionArgs: { setReservationListArgs: SetReservationListArgs }

Type declaration

FreezeDelegatedAccountInstructionAccounts: { delegate: web3.PublicKey; edition: web3.PublicKey; mint: web3.PublicKey; tokenAccount: web3.PublicKey; tokenProgram?: web3.PublicKey }

Accounts required by the FreezeDelegatedAccount instruction

property

[writable, signer] delegate Delegate

property

[writable] tokenAccount Token account to freeze

property

[] edition Edition

property

[] mint Token mint

Type declaration

  • delegate: web3.PublicKey
  • edition: web3.PublicKey
  • mint: web3.PublicKey
  • tokenAccount: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
MintNewEditionFromMasterEditionViaTokenInstructionAccounts: { editionMarkPda: web3.PublicKey; masterEdition: web3.PublicKey; metadata: web3.PublicKey; newEdition: web3.PublicKey; newMetadata: web3.PublicKey; newMetadataUpdateAuthority: web3.PublicKey; newMint: web3.PublicKey; newMintAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenAccount: web3.PublicKey; tokenAccountOwner: web3.PublicKey; tokenProgram?: web3.PublicKey }

Accounts required by the MintNewEditionFromMasterEditionViaToken instruction

property

[writable] newMetadata New Metadata key (pda of ['metadata', program id, mint id])

property

[writable] newEdition New Edition (pda of ['metadata', program id, mint id, 'edition'])

property

[writable] masterEdition Master Record Edition V2 (pda of ['metadata', program id, master metadata mint id, 'edition'])

property

[writable] newMint Mint of new token - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY

property

[writable] editionMarkPda 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).

property

[signer] newMintAuthority Mint authority of new mint

property

[writable, signer] payer payer

property

[signer] tokenAccountOwner owner of token account containing master token (#8)

property

[] tokenAccount token account containing token from master metadata mint

property

[] newMetadataUpdateAuthority Update authority info for new metadata

property

[] metadata Master record metadata account

Type declaration

  • editionMarkPda: web3.PublicKey
  • masterEdition: web3.PublicKey
  • metadata: web3.PublicKey
  • newEdition: web3.PublicKey
  • newMetadata: web3.PublicKey
  • newMetadataUpdateAuthority: web3.PublicKey
  • newMint: web3.PublicKey
  • newMintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • tokenAccount: web3.PublicKey
  • tokenAccountOwner: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
MintNewEditionFromMasterEditionViaTokenInstructionArgs: { mintNewEditionFromMasterEditionViaTokenArgs: MintNewEditionFromMasterEditionViaTokenArgs }

Type declaration

MintNewEditionFromMasterEditionViaVaultProxyInstructionAccounts: { editionMarkPda: web3.PublicKey; masterEdition: web3.PublicKey; metadata: web3.PublicKey; newEdition: web3.PublicKey; newMetadata: web3.PublicKey; newMetadataUpdateAuthority: web3.PublicKey; newMint: web3.PublicKey; newMintAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; safetyDepositBox: web3.PublicKey; safetyDepositStore: web3.PublicKey; systemProgram?: web3.PublicKey; tokenProgram?: web3.PublicKey; tokenVaultProgram: web3.PublicKey; vault: web3.PublicKey; vaultAuthority: web3.PublicKey }

Accounts required by the MintNewEditionFromMasterEditionViaVaultProxy instruction

property

[writable] newMetadata New Metadata key (pda of ['metadata', program id, mint id])

property

[writable] newEdition New Edition (pda of ['metadata', program id, mint id, 'edition'])

property

[writable] masterEdition Master Record Edition V2 (pda of ['metadata', program id, master metadata mint id, 'edition']

property

[writable] newMint Mint of new token - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY

property

[writable] editionMarkPda 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).

property

[signer] newMintAuthority Mint authority of new mint

property

[writable, signer] payer payer

property

[signer] vaultAuthority Vault authority

property

[] safetyDepositStore Safety deposit token store account

property

[] safetyDepositBox Safety deposit box

property

[] vault Vault

property

[] newMetadataUpdateAuthority Update authority info for new metadata

property

[] metadata Master record metadata account

property

[] tokenVaultProgram Token vault program

Type declaration

  • editionMarkPda: web3.PublicKey
  • masterEdition: web3.PublicKey
  • metadata: web3.PublicKey
  • newEdition: web3.PublicKey
  • newMetadata: web3.PublicKey
  • newMetadataUpdateAuthority: web3.PublicKey
  • newMint: web3.PublicKey
  • newMintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • safetyDepositBox: web3.PublicKey
  • safetyDepositStore: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • tokenVaultProgram: web3.PublicKey
  • vault: web3.PublicKey
  • vaultAuthority: web3.PublicKey
MintNewEditionFromMasterEditionViaVaultProxyInstructionArgs: { mintNewEditionFromMasterEditionViaTokenArgs: MintNewEditionFromMasterEditionViaTokenArgs }

Type declaration

PuffMetadataInstructionAccounts: { metadata: web3.PublicKey }

Accounts required by the PuffMetadata instruction

property

[writable] metadata Metadata account

Type declaration

  • metadata: web3.PublicKey
RemoveCreatorVerificationInstructionAccounts: { creator: web3.PublicKey; metadata: web3.PublicKey }

Accounts required by the RemoveCreatorVerification instruction

property

[writable] metadata Metadata (pda of ['metadata', program id, mint id])

property

[signer] creator Creator

Type declaration

  • creator: web3.PublicKey
  • metadata: web3.PublicKey
RevokeCollectionAuthorityInstructionAccounts: { collectionAuthorityRecord: web3.PublicKey; delegateAuthority: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; revokeAuthority: web3.PublicKey }

Accounts required by the RevokeCollectionAuthority instruction

property

[writable] collectionAuthorityRecord Collection Authority Record PDA

property

[writable] delegateAuthority Delegated Collection Authority

property

[writable, signer] revokeAuthority Update Authority, or Delegated Authority, of Collection NFT

property

[] metadata Metadata account

property

[] mint Mint of Metadata

Type declaration

  • collectionAuthorityRecord: web3.PublicKey
  • delegateAuthority: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • revokeAuthority: web3.PublicKey
RevokeUseAuthorityInstructionAccounts: { metadata: web3.PublicKey; mint: web3.PublicKey; owner: web3.PublicKey; ownerTokenAccount: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenProgram?: web3.PublicKey; useAuthorityRecord: web3.PublicKey; user: web3.PublicKey }

Accounts required by the RevokeUseAuthority instruction

property

[writable] useAuthorityRecord Use Authority Record PDA

property

[writable, signer] owner Owner

property

[] user A Use Authority

property

[writable] ownerTokenAccount Owned Token Account Of Mint

property

[] mint Mint of Metadata

property

[] metadata Metadata account

Type declaration

  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • owner: web3.PublicKey
  • ownerTokenAccount: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • useAuthorityRecord: web3.PublicKey
  • user: web3.PublicKey
SetAndVerifyCollectionInstructionAccounts: { collection: web3.PublicKey; collectionAuthority: web3.PublicKey; collectionAuthorityRecord?: web3.PublicKey; collectionMasterEditionAccount: web3.PublicKey; collectionMint: web3.PublicKey; metadata: web3.PublicKey; payer: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the SetAndVerifyCollection instruction

property

[writable] metadata Metadata account

property

[writable, signer] collectionAuthority Collection Update authority

property

[writable, signer] payer Payer

property

[] updateAuthority Update Authority of Collection NFT and NFT

property

[] collectionMint Mint of the Collection

property

[] collection Metadata Account of the Collection

property

[] collectionMasterEditionAccount MasterEdition2 Account of the Collection Token

property

[] collectionAuthorityRecord (optional) Collection Authority Record PDA

Type declaration

  • collection: web3.PublicKey
  • collectionAuthority: web3.PublicKey
  • Optional collectionAuthorityRecord?: web3.PublicKey
  • collectionMasterEditionAccount: web3.PublicKey
  • collectionMint: web3.PublicKey
  • metadata: web3.PublicKey
  • payer: web3.PublicKey
  • updateAuthority: web3.PublicKey
SetAndVerifySizedCollectionItemInstructionAccounts: { collection: web3.PublicKey; collectionAuthority: web3.PublicKey; collectionAuthorityRecord?: web3.PublicKey; collectionMasterEditionAccount: web3.PublicKey; collectionMint: web3.PublicKey; metadata: web3.PublicKey; payer: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the SetAndVerifySizedCollectionItem instruction

property

[writable] metadata Metadata account

property

[signer] collectionAuthority Collection Update authority

property

[writable, signer] payer payer

property

[] updateAuthority Update Authority of Collection NFT and NFT

property

[] collectionMint Mint of the Collection

property

[writable] collection Metadata Account of the Collection

property

[writable] collectionMasterEditionAccount MasterEdition2 Account of the Collection Token

property

[] collectionAuthorityRecord (optional) Collection Authority Record PDA

Type declaration

  • collection: web3.PublicKey
  • collectionAuthority: web3.PublicKey
  • Optional collectionAuthorityRecord?: web3.PublicKey
  • collectionMasterEditionAccount: web3.PublicKey
  • collectionMint: web3.PublicKey
  • metadata: web3.PublicKey
  • payer: web3.PublicKey
  • updateAuthority: web3.PublicKey
SetCollectionSizeInstructionAccounts: { collectionAuthority: web3.PublicKey; collectionAuthorityRecord?: web3.PublicKey; collectionMetadata: web3.PublicKey; collectionMint: web3.PublicKey }

Accounts required by the SetCollectionSize instruction

property

[writable] collectionMetadata Collection Metadata account

property

[writable, signer] collectionAuthority Collection Update authority

property

[] collectionMint Mint of the Collection

property

[] collectionAuthorityRecord (optional) Collection Authority Record PDA

Type declaration

  • collectionAuthority: web3.PublicKey
  • Optional collectionAuthorityRecord?: web3.PublicKey
  • collectionMetadata: web3.PublicKey
  • collectionMint: web3.PublicKey
SetCollectionSizeInstructionArgs: { setCollectionSizeArgs: SetCollectionSizeArgs }

Type declaration

SetTokenStandardInstructionAccounts: { edition?: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the SetTokenStandard instruction

property

[writable] metadata Metadata account

property

[writable, signer] updateAuthority Metadata update authority

property

[] mint Mint account

property

[] edition (optional) Edition account

Type declaration

  • Optional edition?: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • updateAuthority: web3.PublicKey
SignMetadataInstructionAccounts: { creator: web3.PublicKey; metadata: web3.PublicKey }

Accounts required by the SignMetadata instruction

property

[writable] metadata Metadata (pda of ['metadata', program id, mint id])

property

[signer] creator Creator

Type declaration

  • creator: web3.PublicKey
  • metadata: web3.PublicKey
ThawDelegatedAccountInstructionAccounts: { delegate: web3.PublicKey; edition: web3.PublicKey; mint: web3.PublicKey; tokenAccount: web3.PublicKey; tokenProgram?: web3.PublicKey }

Accounts required by the ThawDelegatedAccount instruction

property

[writable, signer] delegate Delegate

property

[writable] tokenAccount Token account to thaw

property

[] edition Edition

property

[] mint Token mint

Type declaration

  • delegate: web3.PublicKey
  • edition: web3.PublicKey
  • mint: web3.PublicKey
  • tokenAccount: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
UnverifyCollectionInstructionAccounts: { collection: web3.PublicKey; collectionAuthority: web3.PublicKey; collectionAuthorityRecord?: web3.PublicKey; collectionMasterEditionAccount: web3.PublicKey; collectionMint: web3.PublicKey; metadata: web3.PublicKey }

Accounts required by the UnverifyCollection instruction

property

[writable] metadata Metadata account

property

[writable, signer] collectionAuthority Collection Authority

property

[] collectionMint Mint of the Collection

property

[] collection Metadata Account of the Collection

property

[] collectionMasterEditionAccount MasterEdition2 Account of the Collection Token

property

[] collectionAuthorityRecord (optional) Collection Authority Record PDA

Type declaration

  • collection: web3.PublicKey
  • collectionAuthority: web3.PublicKey
  • Optional collectionAuthorityRecord?: web3.PublicKey
  • collectionMasterEditionAccount: web3.PublicKey
  • collectionMint: web3.PublicKey
  • metadata: web3.PublicKey
UnverifySizedCollectionItemInstructionAccounts: { collection: web3.PublicKey; collectionAuthority: web3.PublicKey; collectionAuthorityRecord?: web3.PublicKey; collectionMasterEditionAccount: web3.PublicKey; collectionMint: web3.PublicKey; metadata: web3.PublicKey; payer: web3.PublicKey }

Accounts required by the UnverifySizedCollectionItem instruction

property

[writable] metadata Metadata account

property

[signer] collectionAuthority Collection Authority

property

[writable, signer] payer payer

property

[] collectionMint Mint of the Collection

property

[writable] collection Metadata Account of the Collection

property

[] collectionMasterEditionAccount MasterEdition2 Account of the Collection Token

property

[] collectionAuthorityRecord (optional) Collection Authority Record PDA

Type declaration

  • collection: web3.PublicKey
  • collectionAuthority: web3.PublicKey
  • Optional collectionAuthorityRecord?: web3.PublicKey
  • collectionMasterEditionAccount: web3.PublicKey
  • collectionMint: web3.PublicKey
  • metadata: web3.PublicKey
  • payer: web3.PublicKey
UpdateMetadataAccountInstructionAccounts: { metadata: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the UpdateMetadataAccount instruction

property

[writable] metadata Metadata account

property

[signer] updateAuthority Update authority key

Type declaration

  • metadata: web3.PublicKey
  • updateAuthority: web3.PublicKey
UpdateMetadataAccountInstructionArgs: { updateMetadataAccountArgs: UpdateMetadataAccountArgs }

Type declaration

UpdateMetadataAccountV2InstructionAccounts: { metadata: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the UpdateMetadataAccountV2 instruction

property

[writable] metadata Metadata account

property

[signer] updateAuthority Update authority key

Type declaration

  • metadata: web3.PublicKey
  • updateAuthority: web3.PublicKey
UpdateMetadataAccountV2InstructionArgs: { updateMetadataAccountArgsV2: UpdateMetadataAccountArgsV2 }

Type declaration

UpdatePrimarySaleHappenedViaTokenInstructionAccounts: { metadata: web3.PublicKey; owner: web3.PublicKey; token: web3.PublicKey }

Accounts required by the UpdatePrimarySaleHappenedViaToken instruction

property

[writable] metadata Metadata key (pda of ['metadata', program id, mint id])

property

[signer] owner Owner on the token account

property

[] token Account containing tokens from the metadata's mint

Type declaration

  • metadata: web3.PublicKey
  • owner: web3.PublicKey
  • token: web3.PublicKey
UtilizeInstructionAccounts: { ataProgram?: web3.PublicKey; burner?: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; owner: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenAccount: web3.PublicKey; tokenProgram?: web3.PublicKey; useAuthority: web3.PublicKey; useAuthorityRecord?: web3.PublicKey }

Accounts required by the Utilize instruction

property

[writable] metadata Metadata account

property

[writable] tokenAccount Token Account Of NFT

property

[writable] mint Mint of the Metadata

property

[writable, signer] useAuthority A Use Authority / Can be the current Owner of the NFT

property

[] owner Owner

property

[writable] useAuthorityRecord (optional) Use Authority Record PDA If present the program Assumes a delegated use authority

property

[] burner (optional) Program As Signer (Burner)

Type declaration

  • Optional ataProgram?: web3.PublicKey
  • Optional burner?: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • owner: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • tokenAccount: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • useAuthority: web3.PublicKey
  • Optional useAuthorityRecord?: web3.PublicKey
UtilizeInstructionArgs: { utilizeArgs: UtilizeArgs }

Type declaration

VerifyCollectionInstructionAccounts: { collection: web3.PublicKey; collectionAuthority: web3.PublicKey; collectionMasterEditionAccount: web3.PublicKey; collectionMint: web3.PublicKey; metadata: web3.PublicKey; payer: web3.PublicKey }

Accounts required by the VerifyCollection instruction

property

[writable] metadata Metadata account

property

[writable, signer] collectionAuthority Collection Update authority

property

[writable, signer] payer payer

property

[] collectionMint Mint of the Collection

property

[] collection Metadata Account of the Collection

property

[] collectionMasterEditionAccount MasterEdition2 Account of the Collection Token

Type declaration

  • collection: web3.PublicKey
  • collectionAuthority: web3.PublicKey
  • collectionMasterEditionAccount: web3.PublicKey
  • collectionMint: web3.PublicKey
  • metadata: web3.PublicKey
  • payer: web3.PublicKey
VerifySizedCollectionItemInstructionAccounts: { collection: web3.PublicKey; collectionAuthority: web3.PublicKey; collectionAuthorityRecord?: web3.PublicKey; collectionMasterEditionAccount: web3.PublicKey; collectionMint: web3.PublicKey; metadata: web3.PublicKey; payer: web3.PublicKey }

Accounts required by the VerifySizedCollectionItem instruction

property

[writable] metadata Metadata account

property

[signer] collectionAuthority Collection Update authority

property

[writable, signer] payer payer

property

[] collectionMint Mint of the Collection

property

[writable] collection Metadata Account of the Collection

property

[] collectionMasterEditionAccount MasterEdition2 Account of the Collection Token

property

[] collectionAuthorityRecord (optional) Collection Authority Record PDA

Type declaration

  • collection: web3.PublicKey
  • collectionAuthority: web3.PublicKey
  • Optional collectionAuthorityRecord?: web3.PublicKey
  • collectionMasterEditionAccount: web3.PublicKey
  • collectionMint: web3.PublicKey
  • metadata: web3.PublicKey
  • payer: web3.PublicKey
ApproveCollectionAuthorityStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
ApproveUseAuthorityStruct: BeetArgsStruct<ApproveUseAuthorityInstructionArgs & { instructionDiscriminator: number }> = ...
BurnNftStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
ConvertMasterEditionV1ToV2Struct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
CreateMasterEditionStruct: FixableBeetArgsStruct<CreateMasterEditionInstructionArgs & { instructionDiscriminator: number }> = ...
CreateMasterEditionV3Struct: FixableBeetArgsStruct<CreateMasterEditionV3InstructionArgs & { instructionDiscriminator: number }> = ...
CreateMetadataAccountStruct: FixableBeetArgsStruct<CreateMetadataAccountInstructionArgs & { instructionDiscriminator: number }> = ...
CreateMetadataAccountV2Struct: FixableBeetArgsStruct<CreateMetadataAccountV2InstructionArgs & { instructionDiscriminator: number }> = ...
CreateMetadataAccountV3Struct: FixableBeetArgsStruct<CreateMetadataAccountV3InstructionArgs & { instructionDiscriminator: number }> = ...
DeprecatedCreateMasterEditionStruct: FixableBeetArgsStruct<DeprecatedCreateMasterEditionInstructionArgs & { instructionDiscriminator: number }> = ...
DeprecatedCreateReservationListStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
DeprecatedMintNewEditionFromMasterEditionViaPrintingTokenStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
DeprecatedMintPrintingTokensStruct: BeetArgsStruct<DeprecatedMintPrintingTokensInstructionArgs & { instructionDiscriminator: number }> = ...
DeprecatedMintPrintingTokensViaTokenStruct: BeetArgsStruct<DeprecatedMintPrintingTokensViaTokenInstructionArgs & { instructionDiscriminator: number }> = ...
DeprecatedSetReservationListStruct: FixableBeetArgsStruct<DeprecatedSetReservationListInstructionArgs & { instructionDiscriminator: number }> = ...
FreezeDelegatedAccountStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
MintNewEditionFromMasterEditionViaTokenStruct: BeetArgsStruct<MintNewEditionFromMasterEditionViaTokenInstructionArgs & { instructionDiscriminator: number }> = ...
MintNewEditionFromMasterEditionViaVaultProxyStruct: BeetArgsStruct<MintNewEditionFromMasterEditionViaVaultProxyInstructionArgs & { instructionDiscriminator: number }> = ...
PuffMetadataStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
RemoveCreatorVerificationStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
RevokeCollectionAuthorityStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
RevokeUseAuthorityStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
SetAndVerifyCollectionStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
SetAndVerifySizedCollectionItemStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
SetCollectionSizeStruct: BeetArgsStruct<SetCollectionSizeInstructionArgs & { instructionDiscriminator: number }> = ...
SetTokenStandardStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
SignMetadataStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
ThawDelegatedAccountStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
UnverifyCollectionStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
UnverifySizedCollectionItemStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
UpdateMetadataAccountStruct: FixableBeetArgsStruct<UpdateMetadataAccountInstructionArgs & { instructionDiscriminator: number }> = ...
UpdateMetadataAccountV2Struct: FixableBeetArgsStruct<UpdateMetadataAccountV2InstructionArgs & { instructionDiscriminator: number }> = ...
UpdatePrimarySaleHappenedViaTokenStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
UtilizeStruct: BeetArgsStruct<UtilizeInstructionArgs & { instructionDiscriminator: number }> = ...
VerifyCollectionStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
VerifySizedCollectionItemStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...

Errors

  • errorFromCode(code: number): MaybeErrorWithCode
  • errorFromName(name: string): MaybeErrorWithCode

constants

PROGRAM_ADDRESS: "metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s" = 'metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s'

Program address

PROGRAM_ID: PublicKey = ...

Program public key

enums

CollectionDetails: beet.DataEnumKeyAsKind<CollectionDetailsRecord>

Union type respresenting the CollectionDetails data enum defined in Rust.

NOTE: that it includes a __kind property which allows to narrow types in switch/if statements. Additionally isCollectionDetails* type guards are exposed below to narrow to a specific variant.

userTypes

CollectionDetails: beet.DataEnumKeyAsKind<CollectionDetailsRecord>

Union type respresenting the CollectionDetails data enum defined in Rust.

NOTE: that it includes a __kind property which allows to narrow types in switch/if statements. Additionally isCollectionDetails* type guards are exposed below to narrow to a specific variant.

approveUseAuthorityArgsBeet: BeetArgsStruct<ApproveUseAuthorityArgs> = ...
collectionBeet: BeetArgsStruct<Collection> = ...
collectionDetailsBeet: FixableBeet<{ __kind: "V1" } & { size: bignum }, Partial<{ __kind: "V1" } & { size: bignum }>> = ...
createMasterEditionArgsBeet: FixableBeetArgsStruct<CreateMasterEditionArgs> = ...
createMetadataAccountArgsBeet: FixableBeetArgsStruct<CreateMetadataAccountArgs> = ...
createMetadataAccountArgsV2Beet: FixableBeetArgsStruct<CreateMetadataAccountArgsV2> = ...
createMetadataAccountArgsV3Beet: FixableBeetArgsStruct<CreateMetadataAccountArgsV3> = ...
creatorBeet: BeetArgsStruct<Creator> = ...
dataBeet: FixableBeetArgsStruct<Data> = ...
dataV2Beet: FixableBeetArgsStruct<DataV2> = ...
keyBeet: FixedSizeBeet<Key, Key> = ...
mintNewEditionFromMasterEditionViaTokenArgsBeet: BeetArgsStruct<MintNewEditionFromMasterEditionViaTokenArgs> = ...
mintPrintingTokensViaTokenArgsBeet: BeetArgsStruct<MintPrintingTokensViaTokenArgs> = ...
reservationBeet: BeetArgsStruct<Reservation> = ...
reservationV1Beet: BeetArgsStruct<ReservationV1> = ...
setCollectionSizeArgsBeet: BeetArgsStruct<SetCollectionSizeArgs> = ...
setReservationListArgsBeet: FixableBeetArgsStruct<SetReservationListArgs> = ...
tokenStandardBeet: FixedSizeBeet<TokenStandard, TokenStandard> = ...
updateMetadataAccountArgsBeet: FixableBeetArgsStruct<UpdateMetadataAccountArgs> = ...
updateMetadataAccountArgsV2Beet: FixableBeetArgsStruct<UpdateMetadataAccountArgsV2> = ...
useMethodBeet: FixedSizeBeet<UseMethod, UseMethod> = ...
usesBeet: BeetArgsStruct<Uses> = ...
utilizeArgsBeet: BeetArgsStruct<UtilizeArgs> = ...

sdk

ApproveUseAuthorityArgs: { numberOfUses: beet.bignum }

Type declaration

  • numberOfUses: beet.bignum
Collection: { key: web3.PublicKey; verified: boolean }

Type declaration

  • key: web3.PublicKey
  • verified: boolean
CreateMasterEditionArgs: { maxSupply: beet.COption<beet.bignum> }

Type declaration

  • maxSupply: beet.COption<beet.bignum>
CreateMetadataAccountArgs: { data: Data; isMutable: boolean }

Type declaration

  • data: Data
  • isMutable: boolean
CreateMetadataAccountArgsV2: { data: DataV2; isMutable: boolean }

Type declaration

  • data: DataV2
  • isMutable: boolean
CreateMetadataAccountArgsV3: { collectionDetails: beet.COption<CollectionDetails>; data: DataV2; isMutable: boolean }

Type declaration

Creator: { address: web3.PublicKey; share: number; verified: boolean }

Type declaration

  • address: web3.PublicKey
  • share: number
  • verified: boolean
Data: { creators: beet.COption<Creator[]>; name: string; sellerFeeBasisPoints: number; symbol: string; uri: string }

Type declaration

  • creators: beet.COption<Creator[]>
  • name: string
  • sellerFeeBasisPoints: number
  • symbol: string
  • uri: string
DataV2: { collection: beet.COption<Collection>; creators: beet.COption<Creator[]>; name: string; sellerFeeBasisPoints: number; symbol: string; uri: string; uses: beet.COption<Uses> }

Type declaration

  • collection: beet.COption<Collection>
  • creators: beet.COption<Creator[]>
  • name: string
  • sellerFeeBasisPoints: number
  • symbol: string
  • uri: string
  • uses: beet.COption<Uses>
MintNewEditionFromMasterEditionViaTokenArgs: { edition: beet.bignum }

Type declaration

  • edition: beet.bignum
MintPrintingTokensViaTokenArgs: { supply: beet.bignum }

Type declaration

  • supply: beet.bignum
Reservation: { address: web3.PublicKey; spotsRemaining: beet.bignum; totalSpots: beet.bignum }

Type declaration

  • address: web3.PublicKey
  • spotsRemaining: beet.bignum
  • totalSpots: beet.bignum
ReservationV1: { address: web3.PublicKey; spotsRemaining: number; totalSpots: number }

Type declaration

  • address: web3.PublicKey
  • spotsRemaining: number
  • totalSpots: number
SetCollectionSizeArgs: { size: beet.bignum }

Type declaration

  • size: beet.bignum
SetReservationListArgs: { offset: beet.bignum; reservations: Reservation[]; totalReservationSpots: beet.COption<beet.bignum>; totalSpotOffset: beet.bignum }

Type declaration

  • offset: beet.bignum
  • reservations: Reservation[]
  • totalReservationSpots: beet.COption<beet.bignum>
  • totalSpotOffset: beet.bignum
UpdateMetadataAccountArgs: { data: beet.COption<Data>; primarySaleHappened: beet.COption<boolean>; updateAuthority: beet.COption<web3.PublicKey> }

Type declaration

  • data: beet.COption<Data>
  • primarySaleHappened: beet.COption<boolean>
  • updateAuthority: beet.COption<web3.PublicKey>
UpdateMetadataAccountArgsV2: { data: beet.COption<DataV2>; isMutable: beet.COption<boolean>; primarySaleHappened: beet.COption<boolean>; updateAuthority: beet.COption<web3.PublicKey> }

Type declaration

  • data: beet.COption<DataV2>
  • isMutable: beet.COption<boolean>
  • primarySaleHappened: beet.COption<boolean>
  • updateAuthority: beet.COption<web3.PublicKey>
Uses: { remaining: beet.bignum; total: beet.bignum; useMethod: UseMethod }

Type declaration

  • remaining: beet.bignum
  • total: beet.bignum
  • useMethod: UseMethod
UtilizeArgs: { numberOfUses: beet.bignum }

Type declaration

  • numberOfUses: beet.bignum
accountProviders: { CollectionAuthorityRecord: typeof CollectionAuthorityRecord; Edition: typeof Edition; EditionMarker: typeof EditionMarker; MasterEditionV1: typeof MasterEditionV1; MasterEditionV2: typeof MasterEditionV2; Metadata: typeof Metadata; ReservationListV1: typeof ReservationListV1; ReservationListV2: typeof ReservationListV2; UseAuthorityRecord: typeof UseAuthorityRecord } = ...

Type declaration

approveCollectionAuthorityInstructionDiscriminator: 23 = 23
approveUseAuthorityInstructionDiscriminator: 20 = 20
burnNftInstructionDiscriminator: 29 = 29
convertMasterEditionV1ToV2InstructionDiscriminator: 12 = 12
createMasterEditionInstructionDiscriminator: 10 = 10
createMasterEditionV3InstructionDiscriminator: 17 = 17
createMetadataAccountInstructionDiscriminator: 0 = 0
createMetadataAccountV2InstructionDiscriminator: 16 = 16
createMetadataAccountV3InstructionDiscriminator: 33 = 33
cusper: ErrorResolver = ...
deprecatedCreateMasterEditionInstructionDiscriminator: 2 = 2
deprecatedCreateReservationListInstructionDiscriminator: 6 = 6
deprecatedMintNewEditionFromMasterEditionViaPrintingTokenInstructionDiscriminator: 3 = 3
deprecatedMintPrintingTokensInstructionDiscriminator: 9 = 9
deprecatedMintPrintingTokensViaTokenInstructionDiscriminator: 8 = 8
deprecatedSetReservationListInstructionDiscriminator: 5 = 5
freezeDelegatedAccountInstructionDiscriminator: 26 = 26
mintNewEditionFromMasterEditionViaTokenInstructionDiscriminator: 11 = 11
mintNewEditionFromMasterEditionViaVaultProxyInstructionDiscriminator: 13 = 13
puffMetadataInstructionDiscriminator: 14 = 14
removeCreatorVerificationInstructionDiscriminator: 28 = 28
revokeCollectionAuthorityInstructionDiscriminator: 24 = 24
revokeUseAuthorityInstructionDiscriminator: 21 = 21
setAndVerifyCollectionInstructionDiscriminator: 25 = 25
setAndVerifySizedCollectionItemInstructionDiscriminator: 32 = 32
setCollectionSizeInstructionDiscriminator: 34 = 34
setTokenStandardInstructionDiscriminator: 35 = 35
signMetadataInstructionDiscriminator: 7 = 7
thawDelegatedAccountInstructionDiscriminator: 27 = 27
unverifyCollectionInstructionDiscriminator: 22 = 22
unverifySizedCollectionItemInstructionDiscriminator: 31 = 31
updateMetadataAccountInstructionDiscriminator: 1 = 1
updateMetadataAccountV2InstructionDiscriminator: 15 = 15
updatePrimarySaleHappenedViaTokenInstructionDiscriminator: 4 = 4
utilizeInstructionDiscriminator: 19 = 19
verifyCollectionInstructionDiscriminator: 18 = 18
verifySizedCollectionItemInstructionDiscriminator: 30 = 30
  • isCollectionDetailsV1(x: { __kind: "V1" } & { size: bignum }): x is { __kind: "V1" } & { size: bignum } & { __kind: "V1" }

generated

ApproveCollectionAuthorityInstructionAccounts: { collectionAuthorityRecord: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; newCollectionAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the ApproveCollectionAuthority instruction

property

[writable] collectionAuthorityRecord Collection Authority Record PDA

property

[] newCollectionAuthority A Collection Authority

property

[writable, signer] updateAuthority Update Authority of Collection NFT

property

[writable, signer] payer Payer

property

[] metadata Collection Metadata account

property

[] mint Mint of Collection Metadata

Type declaration

  • collectionAuthorityRecord: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • newCollectionAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
ApproveUseAuthorityInstructionAccounts: { burner: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; owner: web3.PublicKey; ownerTokenAccount: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenProgram?: web3.PublicKey; useAuthorityRecord: web3.PublicKey; user: web3.PublicKey }

Accounts required by the ApproveUseAuthority instruction

property

[writable] useAuthorityRecord Use Authority Record PDA

property

[writable, signer] owner Owner

property

[writable, signer] payer Payer

property

[] user A Use Authority

property

[writable] ownerTokenAccount Owned Token Account Of Mint

property

[] metadata Metadata account

property

[] mint Mint of Metadata

property

[] burner Program As Signer (Burner)

Type declaration

  • burner: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • owner: web3.PublicKey
  • ownerTokenAccount: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • useAuthorityRecord: web3.PublicKey
  • user: web3.PublicKey
ApproveUseAuthorityInstructionArgs: { approveUseAuthorityArgs: ApproveUseAuthorityArgs }

Type declaration

BurnNftInstructionAccounts: { collectionMetadata?: web3.PublicKey; masterEditionAccount: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; owner: web3.PublicKey; splTokenProgram: web3.PublicKey; tokenAccount: web3.PublicKey }

Accounts required by the BurnNft instruction

property

[writable] metadata Metadata (pda of ['metadata', program id, mint id])

property

[writable, signer] owner NFT owner

property

[writable] mint Mint of the NFT

property

[writable] tokenAccount Token account to close

property

[writable] masterEditionAccount MasterEdition2 of the NFT

property

[] splTokenProgram SPL Token Program

property

[writable] collectionMetadata (optional) Metadata of the Collection

Type declaration

  • Optional collectionMetadata?: web3.PublicKey
  • masterEditionAccount: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • owner: web3.PublicKey
  • splTokenProgram: web3.PublicKey
  • tokenAccount: web3.PublicKey
CollectionAuthorityRecordArgs: { bump: number; key: Key }

Arguments used to create CollectionAuthorityRecord

Type declaration

  • bump: number
  • key: Key
CollectionDetails: beet.DataEnumKeyAsKind<CollectionDetailsRecord>

Union type respresenting the CollectionDetails data enum defined in Rust.

NOTE: that it includes a __kind property which allows to narrow types in switch/if statements. Additionally isCollectionDetails* type guards are exposed below to narrow to a specific variant.

ConvertMasterEditionV1ToV2InstructionAccounts: { masterEdition: web3.PublicKey; oneTimeAuth: web3.PublicKey; printingMint: web3.PublicKey }

Accounts required by the ConvertMasterEditionV1ToV2 instruction

property

[writable] masterEdition Master Record Edition V1 (pda of ['metadata', program id, master metadata mint id, 'edition'])

property

[writable] oneTimeAuth One time authorization mint

property

[writable] printingMint Printing mint

Type declaration

  • masterEdition: web3.PublicKey
  • oneTimeAuth: web3.PublicKey
  • printingMint: web3.PublicKey
CreateMasterEditionInstructionAccounts: { edition: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; mintAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the CreateMasterEdition instruction

property

[writable] edition Unallocated edition V2 account with address as pda of ['metadata', program id, mint, 'edition']

property

[writable] mint Metadata mint

property

[signer] updateAuthority Update authority

property

[signer] mintAuthority Mint authority on the metadata's mint - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY

property

[writable, signer] payer payer

property

[] metadata Metadata account

Type declaration

  • edition: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • mintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
CreateMasterEditionInstructionArgs: { createMasterEditionArgs: CreateMasterEditionArgs }

Type declaration

CreateMasterEditionV3InstructionAccounts: { edition: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; mintAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the CreateMasterEditionV3 instruction

property

[writable] edition Unallocated edition V2 account with address as pda of ['metadata', program id, mint, 'edition']

property

[writable] mint Metadata mint

property

[signer] updateAuthority Update authority

property

[signer] mintAuthority Mint authority on the metadata's mint - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY

property

[writable, signer] payer payer

property

[writable] metadata Metadata account

Type declaration

  • edition: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • mintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
CreateMasterEditionV3InstructionArgs: { createMasterEditionArgs: CreateMasterEditionArgs }

Type declaration

CreateMetadataAccountInstructionAccounts: { metadata: web3.PublicKey; mint: web3.PublicKey; mintAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the CreateMetadataAccount instruction

property

[writable] metadata Metadata key (pda of ['metadata', program id, mint id])

property

[] mint Mint of token asset

property

[signer] mintAuthority Mint authority

property

[writable, signer] payer payer

property

[] updateAuthority update authority info

Type declaration

  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • mintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
CreateMetadataAccountInstructionArgs: { createMetadataAccountArgs: CreateMetadataAccountArgs }

Type declaration

CreateMetadataAccountV2InstructionAccounts: { metadata: web3.PublicKey; mint: web3.PublicKey; mintAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the CreateMetadataAccountV2 instruction

property

[writable] metadata Metadata key (pda of ['metadata', program id, mint id])

property

[] mint Mint of token asset

property

[signer] mintAuthority Mint authority

property

[writable, signer] payer payer

property

[] updateAuthority update authority info

Type declaration

  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • mintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
CreateMetadataAccountV2InstructionArgs: { createMetadataAccountArgsV2: CreateMetadataAccountArgsV2 }

Type declaration

CreateMetadataAccountV3InstructionAccounts: { metadata: web3.PublicKey; mint: web3.PublicKey; mintAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the CreateMetadataAccountV3 instruction

property

[writable] metadata Metadata key (pda of ['metadata', program id, mint id])

property

[] mint Mint of token asset

property

[signer] mintAuthority Mint authority

property

[writable, signer] payer payer

property

[] updateAuthority update authority info

Type declaration

  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • mintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
CreateMetadataAccountV3InstructionArgs: { createMetadataAccountArgsV3: CreateMetadataAccountArgsV3 }

Type declaration

DeprecatedCreateMasterEditionInstructionAccounts: { edition: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; mintAuthority: web3.PublicKey; oneTimePrintingAuthorizationMint: web3.PublicKey; oneTimePrintingAuthorizationMintAuthority: web3.PublicKey; payer: web3.PublicKey; printingMint: web3.PublicKey; printingMintAuthority: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the DeprecatedCreateMasterEdition instruction

property

[writable] edition Unallocated edition V1 account with address as pda of ['metadata', program id, mint, 'edition']

property

[writable] mint Metadata mint

property

[writable] printingMint 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

property

[writable] oneTimePrintingAuthorizationMint 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.

property

[signer] updateAuthority Current Update authority key

property

[signer] printingMintAuthority Printing mint authority - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY.

property

[signer] mintAuthority Mint authority on the metadata's mint - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY

property

[] metadata Metadata account

property

[signer] payer payer

property

[signer] oneTimePrintingAuthorizationMintAuthority One time authorization printing mint authority - must be provided if using max supply. THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY.

Type declaration

  • edition: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • mintAuthority: web3.PublicKey
  • oneTimePrintingAuthorizationMint: web3.PublicKey
  • oneTimePrintingAuthorizationMintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • printingMint: web3.PublicKey
  • printingMintAuthority: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
DeprecatedCreateMasterEditionInstructionArgs: { createMasterEditionArgs: CreateMasterEditionArgs }

Type declaration

DeprecatedCreateReservationListInstructionAccounts: { masterEdition: web3.PublicKey; metadata: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; reservationList: web3.PublicKey; resource: web3.PublicKey; systemProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the DeprecatedCreateReservationList instruction

property

[writable] reservationList PDA for ReservationList of ['metadata', program id, master edition key, 'reservation', resource-key]

property

[signer] payer Payer

property

[signer] updateAuthority Update authority

property

[] masterEdition Master Edition V1 key (pda of ['metadata', program id, mint id, 'edition'])

property

[] resource 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.

property

[] metadata Metadata key (pda of ['metadata', program id, mint id])

Type declaration

  • masterEdition: web3.PublicKey
  • metadata: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • reservationList: web3.PublicKey
  • resource: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
DeprecatedMintNewEditionFromMasterEditionViaPrintingTokenInstructionAccounts: { burnAuthority: web3.PublicKey; edition: web3.PublicKey; editionMarker: web3.PublicKey; masterEdition: web3.PublicKey; masterMetadata: web3.PublicKey; masterTokenAccount: web3.PublicKey; masterUpdateAuthority: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; mintAuthority: web3.PublicKey; payer: web3.PublicKey; printingMint: web3.PublicKey; rent?: web3.PublicKey; reservationList?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenProgram?: web3.PublicKey }

Accounts required by the DeprecatedMintNewEditionFromMasterEditionViaPrintingToken instruction

property

[writable] metadata New Metadata key (pda of ['metadata', program id, mint id])

property

[writable] edition New Edition V1 (pda of ['metadata', program id, mint id, 'edition'])

property

[writable] masterEdition Master Record Edition V1 (pda of ['metadata', program id, master metadata mint id, 'edition'])

property

[writable] mint Mint of new token - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY

property

[signer] mintAuthority Mint authority of new mint

property

[writable] printingMint Printing Mint of master record edition

property

[writable] masterTokenAccount Token account containing Printing mint token to be transferred

property

[writable] editionMarker Edition pda to mark creation - will be checked for pre-existence. (pda of ['metadata', program id, master mint id, edition_number])

property

[signer] burnAuthority Burn authority for this token

property

[signer] payer payer

property

[] masterUpdateAuthority update authority info for new metadata account

property

[] masterMetadata Master record metadata account

property

[writable] reservationList (optional) Reservation List - If present, and you are on this list, you can get an edition number given by your position on the list.

Type declaration

  • burnAuthority: web3.PublicKey
  • edition: web3.PublicKey
  • editionMarker: web3.PublicKey
  • masterEdition: web3.PublicKey
  • masterMetadata: web3.PublicKey
  • masterTokenAccount: web3.PublicKey
  • masterUpdateAuthority: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • mintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • printingMint: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional reservationList?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
DeprecatedMintPrintingTokensInstructionAccounts: { destination: web3.PublicKey; masterEdition: web3.PublicKey; metadata: web3.PublicKey; printingMint: web3.PublicKey; rent?: web3.PublicKey; tokenProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the DeprecatedMintPrintingTokens instruction

property

[writable] destination Destination account

property

[writable] printingMint Printing mint

property

[signer] updateAuthority Update authority

property

[] metadata Metadata key (pda of ['metadata', program id, mint id])

property

[] masterEdition Master Edition V1 key (pda of ['metadata', program id, mint id, 'edition'])

Type declaration

  • destination: web3.PublicKey
  • masterEdition: web3.PublicKey
  • metadata: web3.PublicKey
  • printingMint: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
DeprecatedMintPrintingTokensInstructionArgs: { mintPrintingTokensViaTokenArgs: MintPrintingTokensViaTokenArgs }

Type declaration

DeprecatedMintPrintingTokensViaTokenInstructionAccounts: { burnAuthority: web3.PublicKey; destination: web3.PublicKey; masterEdition: web3.PublicKey; metadata: web3.PublicKey; oneTimePrintingAuthorizationMint: web3.PublicKey; printingMint: web3.PublicKey; rent?: web3.PublicKey; token: web3.PublicKey; tokenProgram?: web3.PublicKey }

Accounts required by the DeprecatedMintPrintingTokensViaToken instruction

property

[writable] destination Destination account

property

[writable] token Token account containing one time authorization token

property

[writable] oneTimePrintingAuthorizationMint One time authorization mint

property

[writable] printingMint Printing mint

property

[signer] burnAuthority Burn authority

property

[] metadata Metadata key (pda of ['metadata', program id, mint id])

property

[] masterEdition Master Edition V1 key (pda of ['metadata', program id, mint id, 'edition'])

Type declaration

  • burnAuthority: web3.PublicKey
  • destination: web3.PublicKey
  • masterEdition: web3.PublicKey
  • metadata: web3.PublicKey
  • oneTimePrintingAuthorizationMint: web3.PublicKey
  • printingMint: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • token: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
DeprecatedMintPrintingTokensViaTokenInstructionArgs: { mintPrintingTokensViaTokenArgs: MintPrintingTokensViaTokenArgs }

Type declaration

DeprecatedSetReservationListInstructionAccounts: { masterEdition: web3.PublicKey; reservationList: web3.PublicKey; resource: web3.PublicKey }

Accounts required by the DeprecatedSetReservationList instruction

property

[writable] masterEdition Master Edition V1 key (pda of ['metadata', program id, mint id, 'edition'])

property

[writable] reservationList PDA for ReservationList of ['metadata', program id, master edition key, 'reservation', resource-key]

property

[signer] resource The resource you tied the reservation list too

Type declaration

  • masterEdition: web3.PublicKey
  • reservationList: web3.PublicKey
  • resource: web3.PublicKey
DeprecatedSetReservationListInstructionArgs: { setReservationListArgs: SetReservationListArgs }

Type declaration

EditionArgs: { edition: beet.bignum; key: Key; parent: web3.PublicKey }

Arguments used to create Edition

Type declaration

  • edition: beet.bignum
  • key: Key
  • parent: web3.PublicKey
EditionMarkerArgs: { key: Key; ledger: number[] }

Arguments used to create EditionMarker

Type declaration

  • key: Key
  • ledger: number[]
FreezeDelegatedAccountInstructionAccounts: { delegate: web3.PublicKey; edition: web3.PublicKey; mint: web3.PublicKey; tokenAccount: web3.PublicKey; tokenProgram?: web3.PublicKey }

Accounts required by the FreezeDelegatedAccount instruction

property

[writable, signer] delegate Delegate

property

[writable] tokenAccount Token account to freeze

property

[] edition Edition

property

[] mint Token mint

Type declaration

  • delegate: web3.PublicKey
  • edition: web3.PublicKey
  • mint: web3.PublicKey
  • tokenAccount: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
MasterEditionV1Args: { key: Key; maxSupply: beet.COption<beet.bignum>; oneTimePrintingAuthorizationMint: web3.PublicKey; printingMint: web3.PublicKey; supply: beet.bignum }

Arguments used to create MasterEditionV1

Type declaration

  • key: Key
  • maxSupply: beet.COption<beet.bignum>
  • oneTimePrintingAuthorizationMint: web3.PublicKey
  • printingMint: web3.PublicKey
  • supply: beet.bignum
MasterEditionV2Args: { key: Key; maxSupply: beet.COption<beet.bignum>; supply: beet.bignum }

Arguments used to create MasterEditionV2

Type declaration

  • key: Key
  • maxSupply: beet.COption<beet.bignum>
  • supply: beet.bignum
MetadataArgs: { collection: beet.COption<Collection>; collectionDetails: beet.COption<CollectionDetails>; data: Data; editionNonce: beet.COption<number>; isMutable: boolean; key: Key; mint: web3.PublicKey; primarySaleHappened: boolean; tokenStandard: beet.COption<TokenStandard>; updateAuthority: web3.PublicKey; uses: beet.COption<Uses> }

Arguments used to create Metadata

Type declaration

  • collection: beet.COption<Collection>
  • collectionDetails: beet.COption<CollectionDetails>
  • data: Data
  • editionNonce: beet.COption<number>
  • isMutable: boolean
  • key: Key
  • mint: web3.PublicKey
  • primarySaleHappened: boolean
  • tokenStandard: beet.COption<TokenStandard>
  • updateAuthority: web3.PublicKey
  • uses: beet.COption<Uses>
MintNewEditionFromMasterEditionViaTokenInstructionAccounts: { editionMarkPda: web3.PublicKey; masterEdition: web3.PublicKey; metadata: web3.PublicKey; newEdition: web3.PublicKey; newMetadata: web3.PublicKey; newMetadataUpdateAuthority: web3.PublicKey; newMint: web3.PublicKey; newMintAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenAccount: web3.PublicKey; tokenAccountOwner: web3.PublicKey; tokenProgram?: web3.PublicKey }

Accounts required by the MintNewEditionFromMasterEditionViaToken instruction

property

[writable] newMetadata New Metadata key (pda of ['metadata', program id, mint id])

property

[writable] newEdition New Edition (pda of ['metadata', program id, mint id, 'edition'])

property

[writable] masterEdition Master Record Edition V2 (pda of ['metadata', program id, master metadata mint id, 'edition'])

property

[writable] newMint Mint of new token - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY

property

[writable] editionMarkPda 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).

property

[signer] newMintAuthority Mint authority of new mint

property

[writable, signer] payer payer

property

[signer] tokenAccountOwner owner of token account containing master token (#8)

property

[] tokenAccount token account containing token from master metadata mint

property

[] newMetadataUpdateAuthority Update authority info for new metadata

property

[] metadata Master record metadata account

Type declaration

  • editionMarkPda: web3.PublicKey
  • masterEdition: web3.PublicKey
  • metadata: web3.PublicKey
  • newEdition: web3.PublicKey
  • newMetadata: web3.PublicKey
  • newMetadataUpdateAuthority: web3.PublicKey
  • newMint: web3.PublicKey
  • newMintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • tokenAccount: web3.PublicKey
  • tokenAccountOwner: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
MintNewEditionFromMasterEditionViaTokenInstructionArgs: { mintNewEditionFromMasterEditionViaTokenArgs: MintNewEditionFromMasterEditionViaTokenArgs }

Type declaration

MintNewEditionFromMasterEditionViaVaultProxyInstructionAccounts: { editionMarkPda: web3.PublicKey; masterEdition: web3.PublicKey; metadata: web3.PublicKey; newEdition: web3.PublicKey; newMetadata: web3.PublicKey; newMetadataUpdateAuthority: web3.PublicKey; newMint: web3.PublicKey; newMintAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; safetyDepositBox: web3.PublicKey; safetyDepositStore: web3.PublicKey; systemProgram?: web3.PublicKey; tokenProgram?: web3.PublicKey; tokenVaultProgram: web3.PublicKey; vault: web3.PublicKey; vaultAuthority: web3.PublicKey }

Accounts required by the MintNewEditionFromMasterEditionViaVaultProxy instruction

property

[writable] newMetadata New Metadata key (pda of ['metadata', program id, mint id])

property

[writable] newEdition New Edition (pda of ['metadata', program id, mint id, 'edition'])

property

[writable] masterEdition Master Record Edition V2 (pda of ['metadata', program id, master metadata mint id, 'edition']

property

[writable] newMint Mint of new token - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY

property

[writable] editionMarkPda 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).

property

[signer] newMintAuthority Mint authority of new mint

property

[writable, signer] payer payer

property

[signer] vaultAuthority Vault authority

property

[] safetyDepositStore Safety deposit token store account

property

[] safetyDepositBox Safety deposit box

property

[] vault Vault

property

[] newMetadataUpdateAuthority Update authority info for new metadata

property

[] metadata Master record metadata account

property

[] tokenVaultProgram Token vault program

Type declaration

  • editionMarkPda: web3.PublicKey
  • masterEdition: web3.PublicKey
  • metadata: web3.PublicKey
  • newEdition: web3.PublicKey
  • newMetadata: web3.PublicKey
  • newMetadataUpdateAuthority: web3.PublicKey
  • newMint: web3.PublicKey
  • newMintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • safetyDepositBox: web3.PublicKey
  • safetyDepositStore: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • tokenVaultProgram: web3.PublicKey
  • vault: web3.PublicKey
  • vaultAuthority: web3.PublicKey
MintNewEditionFromMasterEditionViaVaultProxyInstructionArgs: { mintNewEditionFromMasterEditionViaTokenArgs: MintNewEditionFromMasterEditionViaTokenArgs }

Type declaration

PuffMetadataInstructionAccounts: { metadata: web3.PublicKey }

Accounts required by the PuffMetadata instruction

property

[writable] metadata Metadata account

Type declaration

  • metadata: web3.PublicKey
RemoveCreatorVerificationInstructionAccounts: { creator: web3.PublicKey; metadata: web3.PublicKey }

Accounts required by the RemoveCreatorVerification instruction

property

[writable] metadata Metadata (pda of ['metadata', program id, mint id])

property

[signer] creator Creator

Type declaration

  • creator: web3.PublicKey
  • metadata: web3.PublicKey
ReservationListV1Args: { key: Key; masterEdition: web3.PublicKey; reservations: ReservationV1[]; supplySnapshot: beet.COption<beet.bignum> }

Arguments used to create ReservationListV1

Type declaration

  • key: Key
  • masterEdition: web3.PublicKey
  • reservations: ReservationV1[]
  • supplySnapshot: beet.COption<beet.bignum>
ReservationListV2Args: { currentReservationSpots: beet.bignum; key: Key; masterEdition: web3.PublicKey; reservations: Reservation[]; supplySnapshot: beet.COption<beet.bignum>; totalReservationSpots: beet.bignum }

Arguments used to create ReservationListV2

Type declaration

  • currentReservationSpots: beet.bignum
  • key: Key
  • masterEdition: web3.PublicKey
  • reservations: Reservation[]
  • supplySnapshot: beet.COption<beet.bignum>
  • totalReservationSpots: beet.bignum
RevokeCollectionAuthorityInstructionAccounts: { collectionAuthorityRecord: web3.PublicKey; delegateAuthority: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; revokeAuthority: web3.PublicKey }

Accounts required by the RevokeCollectionAuthority instruction

property

[writable] collectionAuthorityRecord Collection Authority Record PDA

property

[writable] delegateAuthority Delegated Collection Authority

property

[writable, signer] revokeAuthority Update Authority, or Delegated Authority, of Collection NFT

property

[] metadata Metadata account

property

[] mint Mint of Metadata

Type declaration

  • collectionAuthorityRecord: web3.PublicKey
  • delegateAuthority: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • revokeAuthority: web3.PublicKey
RevokeUseAuthorityInstructionAccounts: { metadata: web3.PublicKey; mint: web3.PublicKey; owner: web3.PublicKey; ownerTokenAccount: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenProgram?: web3.PublicKey; useAuthorityRecord: web3.PublicKey; user: web3.PublicKey }

Accounts required by the RevokeUseAuthority instruction

property

[writable] useAuthorityRecord Use Authority Record PDA

property

[writable, signer] owner Owner

property

[] user A Use Authority

property

[writable] ownerTokenAccount Owned Token Account Of Mint

property

[] mint Mint of Metadata

property

[] metadata Metadata account

Type declaration

  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • owner: web3.PublicKey
  • ownerTokenAccount: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • useAuthorityRecord: web3.PublicKey
  • user: web3.PublicKey
SetAndVerifyCollectionInstructionAccounts: { collection: web3.PublicKey; collectionAuthority: web3.PublicKey; collectionAuthorityRecord?: web3.PublicKey; collectionMasterEditionAccount: web3.PublicKey; collectionMint: web3.PublicKey; metadata: web3.PublicKey; payer: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the SetAndVerifyCollection instruction

property

[writable] metadata Metadata account

property

[writable, signer] collectionAuthority Collection Update authority

property

[writable, signer] payer Payer

property

[] updateAuthority Update Authority of Collection NFT and NFT

property

[] collectionMint Mint of the Collection

property

[] collection Metadata Account of the Collection

property

[] collectionMasterEditionAccount MasterEdition2 Account of the Collection Token

property

[] collectionAuthorityRecord (optional) Collection Authority Record PDA

Type declaration

  • collection: web3.PublicKey
  • collectionAuthority: web3.PublicKey
  • Optional collectionAuthorityRecord?: web3.PublicKey
  • collectionMasterEditionAccount: web3.PublicKey
  • collectionMint: web3.PublicKey
  • metadata: web3.PublicKey
  • payer: web3.PublicKey
  • updateAuthority: web3.PublicKey
SetAndVerifySizedCollectionItemInstructionAccounts: { collection: web3.PublicKey; collectionAuthority: web3.PublicKey; collectionAuthorityRecord?: web3.PublicKey; collectionMasterEditionAccount: web3.PublicKey; collectionMint: web3.PublicKey; metadata: web3.PublicKey; payer: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the SetAndVerifySizedCollectionItem instruction

property

[writable] metadata Metadata account

property

[signer] collectionAuthority Collection Update authority

property

[writable, signer] payer payer

property

[] updateAuthority Update Authority of Collection NFT and NFT

property

[] collectionMint Mint of the Collection

property

[writable] collection Metadata Account of the Collection

property

[writable] collectionMasterEditionAccount MasterEdition2 Account of the Collection Token

property

[] collectionAuthorityRecord (optional) Collection Authority Record PDA

Type declaration

  • collection: web3.PublicKey
  • collectionAuthority: web3.PublicKey
  • Optional collectionAuthorityRecord?: web3.PublicKey
  • collectionMasterEditionAccount: web3.PublicKey
  • collectionMint: web3.PublicKey
  • metadata: web3.PublicKey
  • payer: web3.PublicKey
  • updateAuthority: web3.PublicKey
SetCollectionSizeInstructionAccounts: { collectionAuthority: web3.PublicKey; collectionAuthorityRecord?: web3.PublicKey; collectionMetadata: web3.PublicKey; collectionMint: web3.PublicKey }

Accounts required by the SetCollectionSize instruction

property

[writable] collectionMetadata Collection Metadata account

property

[writable, signer] collectionAuthority Collection Update authority

property

[] collectionMint Mint of the Collection

property

[] collectionAuthorityRecord (optional) Collection Authority Record PDA

Type declaration

  • collectionAuthority: web3.PublicKey
  • Optional collectionAuthorityRecord?: web3.PublicKey
  • collectionMetadata: web3.PublicKey
  • collectionMint: web3.PublicKey
SetCollectionSizeInstructionArgs: { setCollectionSizeArgs: SetCollectionSizeArgs }

Type declaration

SetTokenStandardInstructionAccounts: { edition?: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the SetTokenStandard instruction

property

[writable] metadata Metadata account

property

[writable, signer] updateAuthority Metadata update authority

property

[] mint Mint account

property

[] edition (optional) Edition account

Type declaration

  • Optional edition?: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • updateAuthority: web3.PublicKey
SignMetadataInstructionAccounts: { creator: web3.PublicKey; metadata: web3.PublicKey }

Accounts required by the SignMetadata instruction

property

[writable] metadata Metadata (pda of ['metadata', program id, mint id])

property

[signer] creator Creator

Type declaration

  • creator: web3.PublicKey
  • metadata: web3.PublicKey
ThawDelegatedAccountInstructionAccounts: { delegate: web3.PublicKey; edition: web3.PublicKey; mint: web3.PublicKey; tokenAccount: web3.PublicKey; tokenProgram?: web3.PublicKey }

Accounts required by the ThawDelegatedAccount instruction

property

[writable, signer] delegate Delegate

property

[writable] tokenAccount Token account to thaw

property

[] edition Edition

property

[] mint Token mint

Type declaration

  • delegate: web3.PublicKey
  • edition: web3.PublicKey
  • mint: web3.PublicKey
  • tokenAccount: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
UnverifyCollectionInstructionAccounts: { collection: web3.PublicKey; collectionAuthority: web3.PublicKey; collectionAuthorityRecord?: web3.PublicKey; collectionMasterEditionAccount: web3.PublicKey; collectionMint: web3.PublicKey; metadata: web3.PublicKey }

Accounts required by the UnverifyCollection instruction

property

[writable] metadata Metadata account

property

[writable, signer] collectionAuthority Collection Authority

property

[] collectionMint Mint of the Collection

property

[] collection Metadata Account of the Collection

property

[] collectionMasterEditionAccount MasterEdition2 Account of the Collection Token

property

[] collectionAuthorityRecord (optional) Collection Authority Record PDA

Type declaration

  • collection: web3.PublicKey
  • collectionAuthority: web3.PublicKey
  • Optional collectionAuthorityRecord?: web3.PublicKey
  • collectionMasterEditionAccount: web3.PublicKey
  • collectionMint: web3.PublicKey
  • metadata: web3.PublicKey
UnverifySizedCollectionItemInstructionAccounts: { collection: web3.PublicKey; collectionAuthority: web3.PublicKey; collectionAuthorityRecord?: web3.PublicKey; collectionMasterEditionAccount: web3.PublicKey; collectionMint: web3.PublicKey; metadata: web3.PublicKey; payer: web3.PublicKey }

Accounts required by the UnverifySizedCollectionItem instruction

property

[writable] metadata Metadata account

property

[signer] collectionAuthority Collection Authority

property

[writable, signer] payer payer

property

[] collectionMint Mint of the Collection

property

[writable] collection Metadata Account of the Collection

property

[] collectionMasterEditionAccount MasterEdition2 Account of the Collection Token

property

[] collectionAuthorityRecord (optional) Collection Authority Record PDA

Type declaration

  • collection: web3.PublicKey
  • collectionAuthority: web3.PublicKey
  • Optional collectionAuthorityRecord?: web3.PublicKey
  • collectionMasterEditionAccount: web3.PublicKey
  • collectionMint: web3.PublicKey
  • metadata: web3.PublicKey
  • payer: web3.PublicKey
UpdateMetadataAccountInstructionAccounts: { metadata: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the UpdateMetadataAccount instruction

property

[writable] metadata Metadata account

property

[signer] updateAuthority Update authority key

Type declaration

  • metadata: web3.PublicKey
  • updateAuthority: web3.PublicKey
UpdateMetadataAccountInstructionArgs: { updateMetadataAccountArgs: UpdateMetadataAccountArgs }

Type declaration

UpdateMetadataAccountV2InstructionAccounts: { metadata: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the UpdateMetadataAccountV2 instruction

property

[writable] metadata Metadata account

property

[signer] updateAuthority Update authority key

Type declaration

  • metadata: web3.PublicKey
  • updateAuthority: web3.PublicKey
UpdateMetadataAccountV2InstructionArgs: { updateMetadataAccountArgsV2: UpdateMetadataAccountArgsV2 }

Type declaration

UpdatePrimarySaleHappenedViaTokenInstructionAccounts: { metadata: web3.PublicKey; owner: web3.PublicKey; token: web3.PublicKey }

Accounts required by the UpdatePrimarySaleHappenedViaToken instruction

property

[writable] metadata Metadata key (pda of ['metadata', program id, mint id])

property

[signer] owner Owner on the token account

property

[] token Account containing tokens from the metadata's mint

Type declaration

  • metadata: web3.PublicKey
  • owner: web3.PublicKey
  • token: web3.PublicKey
UseAuthorityRecordArgs: { allowedUses: beet.bignum; bump: number; key: Key }

Arguments used to create UseAuthorityRecord

Type declaration

  • allowedUses: beet.bignum
  • bump: number
  • key: Key
UtilizeInstructionAccounts: { ataProgram?: web3.PublicKey; burner?: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; owner: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenAccount: web3.PublicKey; tokenProgram?: web3.PublicKey; useAuthority: web3.PublicKey; useAuthorityRecord?: web3.PublicKey }

Accounts required by the Utilize instruction

property

[writable] metadata Metadata account

property

[writable] tokenAccount Token Account Of NFT

property

[writable] mint Mint of the Metadata

property

[writable, signer] useAuthority A Use Authority / Can be the current Owner of the NFT

property

[] owner Owner

property

[writable] useAuthorityRecord (optional) Use Authority Record PDA If present the program Assumes a delegated use authority

property

[] burner (optional) Program As Signer (Burner)

Type declaration

  • Optional ataProgram?: web3.PublicKey
  • Optional burner?: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • owner: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • tokenAccount: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • useAuthority: web3.PublicKey
  • Optional useAuthorityRecord?: web3.PublicKey
UtilizeInstructionArgs: { utilizeArgs: UtilizeArgs }

Type declaration

VerifyCollectionInstructionAccounts: { collection: web3.PublicKey; collectionAuthority: web3.PublicKey; collectionMasterEditionAccount: web3.PublicKey; collectionMint: web3.PublicKey; metadata: web3.PublicKey; payer: web3.PublicKey }

Accounts required by the VerifyCollection instruction

property

[writable] metadata Metadata account

property

[writable, signer] collectionAuthority Collection Update authority

property

[writable, signer] payer payer

property

[] collectionMint Mint of the Collection

property

[] collection Metadata Account of the Collection

property

[] collectionMasterEditionAccount MasterEdition2 Account of the Collection Token

Type declaration

  • collection: web3.PublicKey
  • collectionAuthority: web3.PublicKey
  • collectionMasterEditionAccount: web3.PublicKey
  • collectionMint: web3.PublicKey
  • metadata: web3.PublicKey
  • payer: web3.PublicKey
VerifySizedCollectionItemInstructionAccounts: { collection: web3.PublicKey; collectionAuthority: web3.PublicKey; collectionAuthorityRecord?: web3.PublicKey; collectionMasterEditionAccount: web3.PublicKey; collectionMint: web3.PublicKey; metadata: web3.PublicKey; payer: web3.PublicKey }

Accounts required by the VerifySizedCollectionItem instruction

property

[writable] metadata Metadata account

property

[signer] collectionAuthority Collection Update authority

property

[writable, signer] payer payer

property

[] collectionMint Mint of the Collection

property

[writable] collection Metadata Account of the Collection

property

[] collectionMasterEditionAccount MasterEdition2 Account of the Collection Token

property

[] collectionAuthorityRecord (optional) Collection Authority Record PDA

Type declaration

  • collection: web3.PublicKey
  • collectionAuthority: web3.PublicKey
  • Optional collectionAuthorityRecord?: web3.PublicKey
  • collectionMasterEditionAccount: web3.PublicKey
  • collectionMint: web3.PublicKey
  • metadata: web3.PublicKey
  • payer: web3.PublicKey
ApproveCollectionAuthorityStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
ApproveUseAuthorityStruct: BeetArgsStruct<ApproveUseAuthorityInstructionArgs & { instructionDiscriminator: number }> = ...
BurnNftStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
ConvertMasterEditionV1ToV2Struct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
CreateMasterEditionStruct: FixableBeetArgsStruct<CreateMasterEditionInstructionArgs & { instructionDiscriminator: number }> = ...
CreateMasterEditionV3Struct: FixableBeetArgsStruct<CreateMasterEditionV3InstructionArgs & { instructionDiscriminator: number }> = ...
CreateMetadataAccountStruct: FixableBeetArgsStruct<CreateMetadataAccountInstructionArgs & { instructionDiscriminator: number }> = ...
CreateMetadataAccountV2Struct: FixableBeetArgsStruct<CreateMetadataAccountV2InstructionArgs & { instructionDiscriminator: number }> = ...
CreateMetadataAccountV3Struct: FixableBeetArgsStruct<CreateMetadataAccountV3InstructionArgs & { instructionDiscriminator: number }> = ...
DeprecatedCreateMasterEditionStruct: FixableBeetArgsStruct<DeprecatedCreateMasterEditionInstructionArgs & { instructionDiscriminator: number }> = ...
DeprecatedCreateReservationListStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
DeprecatedMintNewEditionFromMasterEditionViaPrintingTokenStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
DeprecatedMintPrintingTokensStruct: BeetArgsStruct<DeprecatedMintPrintingTokensInstructionArgs & { instructionDiscriminator: number }> = ...
DeprecatedMintPrintingTokensViaTokenStruct: BeetArgsStruct<DeprecatedMintPrintingTokensViaTokenInstructionArgs & { instructionDiscriminator: number }> = ...
DeprecatedSetReservationListStruct: FixableBeetArgsStruct<DeprecatedSetReservationListInstructionArgs & { instructionDiscriminator: number }> = ...
FreezeDelegatedAccountStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
MintNewEditionFromMasterEditionViaTokenStruct: BeetArgsStruct<MintNewEditionFromMasterEditionViaTokenInstructionArgs & { instructionDiscriminator: number }> = ...
MintNewEditionFromMasterEditionViaVaultProxyStruct: BeetArgsStruct<MintNewEditionFromMasterEditionViaVaultProxyInstructionArgs & { instructionDiscriminator: number }> = ...
PROGRAM_ADDRESS: "metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s" = 'metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s'

Program address

PROGRAM_ID: PublicKey = ...

Program public key

PuffMetadataStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
RemoveCreatorVerificationStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
RevokeCollectionAuthorityStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
RevokeUseAuthorityStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
SetAndVerifyCollectionStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
SetAndVerifySizedCollectionItemStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
SetCollectionSizeStruct: BeetArgsStruct<SetCollectionSizeInstructionArgs & { instructionDiscriminator: number }> = ...
SetTokenStandardStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
SignMetadataStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
ThawDelegatedAccountStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
UnverifyCollectionStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
UnverifySizedCollectionItemStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
UpdateMetadataAccountStruct: FixableBeetArgsStruct<UpdateMetadataAccountInstructionArgs & { instructionDiscriminator: number }> = ...
UpdateMetadataAccountV2Struct: FixableBeetArgsStruct<UpdateMetadataAccountV2InstructionArgs & { instructionDiscriminator: number }> = ...
UpdatePrimarySaleHappenedViaTokenStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
UtilizeStruct: BeetArgsStruct<UtilizeInstructionArgs & { instructionDiscriminator: number }> = ...
VerifyCollectionStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
VerifySizedCollectionItemStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...
approveUseAuthorityArgsBeet: BeetArgsStruct<ApproveUseAuthorityArgs> = ...
collectionAuthorityRecordBeet: BeetStruct<CollectionAuthorityRecord, CollectionAuthorityRecordArgs> = ...
collectionBeet: BeetArgsStruct<Collection> = ...
collectionDetailsBeet: FixableBeet<{ __kind: "V1" } & { size: bignum }, Partial<{ __kind: "V1" } & { size: bignum }>> = ...
createMasterEditionArgsBeet: FixableBeetArgsStruct<CreateMasterEditionArgs> = ...
createMetadataAccountArgsBeet: FixableBeetArgsStruct<CreateMetadataAccountArgs> = ...
createMetadataAccountArgsV2Beet: FixableBeetArgsStruct<CreateMetadataAccountArgsV2> = ...
createMetadataAccountArgsV3Beet: FixableBeetArgsStruct<CreateMetadataAccountArgsV3> = ...
creatorBeet: BeetArgsStruct<Creator> = ...
dataBeet: FixableBeetArgsStruct<Data> = ...
dataV2Beet: FixableBeetArgsStruct<DataV2> = ...
editionBeet: BeetStruct<Edition, EditionArgs> = ...
editionMarkerBeet: BeetStruct<EditionMarker, EditionMarkerArgs> = ...
keyBeet: FixedSizeBeet<Key, Key> = ...
masterEditionV1Beet: FixableBeetStruct<MasterEditionV1, MasterEditionV1Args> = ...
masterEditionV2Beet: FixableBeetStruct<MasterEditionV2, MasterEditionV2Args> = ...
metadataBeet: FixableBeetStruct<Metadata, MetadataArgs> = ...
mintNewEditionFromMasterEditionViaTokenArgsBeet: BeetArgsStruct<MintNewEditionFromMasterEditionViaTokenArgs> = ...
mintPrintingTokensViaTokenArgsBeet: BeetArgsStruct<MintPrintingTokensViaTokenArgs> = ...
reservationBeet: BeetArgsStruct<Reservation> = ...
reservationListV1Beet: FixableBeetStruct<ReservationListV1, ReservationListV1Args> = ...
reservationListV2Beet: FixableBeetStruct<ReservationListV2, ReservationListV2Args> = ...
reservationV1Beet: BeetArgsStruct<ReservationV1> = ...
setCollectionSizeArgsBeet: BeetArgsStruct<SetCollectionSizeArgs> = ...
setReservationListArgsBeet: FixableBeetArgsStruct<SetReservationListArgs> = ...
tokenStandardBeet: FixedSizeBeet<TokenStandard, TokenStandard> = ...
updateMetadataAccountArgsBeet: FixableBeetArgsStruct<UpdateMetadataAccountArgs> = ...
updateMetadataAccountArgsV2Beet: FixableBeetArgsStruct<UpdateMetadataAccountArgsV2> = ...
useAuthorityRecordBeet: BeetStruct<UseAuthorityRecord, UseAuthorityRecordArgs> = ...
useMethodBeet: FixedSizeBeet<UseMethod, UseMethod> = ...
usesBeet: BeetArgsStruct<Uses> = ...
utilizeArgsBeet: BeetArgsStruct<UtilizeArgs> = ...
  • errorFromCode(code: number): MaybeErrorWithCode
  • errorFromName(name: string): MaybeErrorWithCode

ApproveCollectionAuthority

ApproveCollectionAuthorityInstructionAccounts: { collectionAuthorityRecord: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; newCollectionAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the ApproveCollectionAuthority instruction

property

[writable] collectionAuthorityRecord Collection Authority Record PDA

property

[] newCollectionAuthority A Collection Authority

property

[writable, signer] updateAuthority Update Authority of Collection NFT

property

[writable, signer] payer Payer

property

[] metadata Collection Metadata account

property

[] mint Mint of Collection Metadata

Type declaration

  • collectionAuthorityRecord: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • newCollectionAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
ApproveCollectionAuthorityStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...

ApproveUseAuthority

ApproveUseAuthorityInstructionAccounts: { burner: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; owner: web3.PublicKey; ownerTokenAccount: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenProgram?: web3.PublicKey; useAuthorityRecord: web3.PublicKey; user: web3.PublicKey }

Accounts required by the ApproveUseAuthority instruction

property

[writable] useAuthorityRecord Use Authority Record PDA

property

[writable, signer] owner Owner

property

[writable, signer] payer Payer

property

[] user A Use Authority

property

[writable] ownerTokenAccount Owned Token Account Of Mint

property

[] metadata Metadata account

property

[] mint Mint of Metadata

property

[] burner Program As Signer (Burner)

Type declaration

  • burner: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • owner: web3.PublicKey
  • ownerTokenAccount: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • useAuthorityRecord: web3.PublicKey
  • user: web3.PublicKey
ApproveUseAuthorityInstructionArgs: { approveUseAuthorityArgs: ApproveUseAuthorityArgs }

Type declaration

ApproveUseAuthorityStruct: BeetArgsStruct<ApproveUseAuthorityInstructionArgs & { instructionDiscriminator: number }> = ...

BurnNft

BurnNftInstructionAccounts: { collectionMetadata?: web3.PublicKey; masterEditionAccount: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; owner: web3.PublicKey; splTokenProgram: web3.PublicKey; tokenAccount: web3.PublicKey }

Accounts required by the BurnNft instruction

property

[writable] metadata Metadata (pda of ['metadata', program id, mint id])

property

[writable, signer] owner NFT owner

property

[writable] mint Mint of the NFT

property

[writable] tokenAccount Token account to close

property

[writable] masterEditionAccount MasterEdition2 of the NFT

property

[] splTokenProgram SPL Token Program

property

[writable] collectionMetadata (optional) Metadata of the Collection

Type declaration

  • Optional collectionMetadata?: web3.PublicKey
  • masterEditionAccount: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • owner: web3.PublicKey
  • splTokenProgram: web3.PublicKey
  • tokenAccount: web3.PublicKey
BurnNftStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...

ConvertMasterEditionV1ToV2

ConvertMasterEditionV1ToV2InstructionAccounts: { masterEdition: web3.PublicKey; oneTimeAuth: web3.PublicKey; printingMint: web3.PublicKey }

Accounts required by the ConvertMasterEditionV1ToV2 instruction

property

[writable] masterEdition Master Record Edition V1 (pda of ['metadata', program id, master metadata mint id, 'edition'])

property

[writable] oneTimeAuth One time authorization mint

property

[writable] printingMint Printing mint

Type declaration

  • masterEdition: web3.PublicKey
  • oneTimeAuth: web3.PublicKey
  • printingMint: web3.PublicKey
ConvertMasterEditionV1ToV2Struct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...

CreateMasterEdition

CreateMasterEditionInstructionAccounts: { edition: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; mintAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the CreateMasterEdition instruction

property

[writable] edition Unallocated edition V2 account with address as pda of ['metadata', program id, mint, 'edition']

property

[writable] mint Metadata mint

property

[signer] updateAuthority Update authority

property

[signer] mintAuthority Mint authority on the metadata's mint - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY

property

[writable, signer] payer payer

property

[] metadata Metadata account

Type declaration

  • edition: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • mintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
CreateMasterEditionInstructionArgs: { createMasterEditionArgs: CreateMasterEditionArgs }

Type declaration

CreateMasterEditionStruct: FixableBeetArgsStruct<CreateMasterEditionInstructionArgs & { instructionDiscriminator: number }> = ...

CreateMasterEditionV3

CreateMasterEditionV3InstructionAccounts: { edition: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; mintAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the CreateMasterEditionV3 instruction

property

[writable] edition Unallocated edition V2 account with address as pda of ['metadata', program id, mint, 'edition']

property

[writable] mint Metadata mint

property

[signer] updateAuthority Update authority

property

[signer] mintAuthority Mint authority on the metadata's mint - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY

property

[writable, signer] payer payer

property

[writable] metadata Metadata account

Type declaration

  • edition: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • mintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
CreateMasterEditionV3InstructionArgs: { createMasterEditionArgs: CreateMasterEditionArgs }

Type declaration

CreateMasterEditionV3Struct: FixableBeetArgsStruct<CreateMasterEditionV3InstructionArgs & { instructionDiscriminator: number }> = ...

CreateMetadataAccount

CreateMetadataAccountInstructionAccounts: { metadata: web3.PublicKey; mint: web3.PublicKey; mintAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the CreateMetadataAccount instruction

property

[writable] metadata Metadata key (pda of ['metadata', program id, mint id])

property

[] mint Mint of token asset

property

[signer] mintAuthority Mint authority

property

[writable, signer] payer payer

property

[] updateAuthority update authority info

Type declaration

  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • mintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
CreateMetadataAccountInstructionArgs: { createMetadataAccountArgs: CreateMetadataAccountArgs }

Type declaration

CreateMetadataAccountStruct: FixableBeetArgsStruct<CreateMetadataAccountInstructionArgs & { instructionDiscriminator: number }> = ...

CreateMetadataAccountV2

CreateMetadataAccountV2InstructionAccounts: { metadata: web3.PublicKey; mint: web3.PublicKey; mintAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the CreateMetadataAccountV2 instruction

property

[writable] metadata Metadata key (pda of ['metadata', program id, mint id])

property

[] mint Mint of token asset

property

[signer] mintAuthority Mint authority

property

[writable, signer] payer payer

property

[] updateAuthority update authority info

Type declaration

  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • mintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
CreateMetadataAccountV2InstructionArgs: { createMetadataAccountArgsV2: CreateMetadataAccountArgsV2 }

Type declaration

CreateMetadataAccountV2Struct: FixableBeetArgsStruct<CreateMetadataAccountV2InstructionArgs & { instructionDiscriminator: number }> = ...

CreateMetadataAccountV3

CreateMetadataAccountV3InstructionAccounts: { metadata: web3.PublicKey; mint: web3.PublicKey; mintAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the CreateMetadataAccountV3 instruction

property

[writable] metadata Metadata key (pda of ['metadata', program id, mint id])

property

[] mint Mint of token asset

property

[signer] mintAuthority Mint authority

property

[writable, signer] payer payer

property

[] updateAuthority update authority info

Type declaration

  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • mintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
CreateMetadataAccountV3InstructionArgs: { createMetadataAccountArgsV3: CreateMetadataAccountArgsV3 }

Type declaration

CreateMetadataAccountV3Struct: FixableBeetArgsStruct<CreateMetadataAccountV3InstructionArgs & { instructionDiscriminator: number }> = ...

DeprecatedCreateMasterEdition

DeprecatedCreateMasterEditionInstructionAccounts: { edition: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; mintAuthority: web3.PublicKey; oneTimePrintingAuthorizationMint: web3.PublicKey; oneTimePrintingAuthorizationMintAuthority: web3.PublicKey; payer: web3.PublicKey; printingMint: web3.PublicKey; printingMintAuthority: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the DeprecatedCreateMasterEdition instruction

property

[writable] edition Unallocated edition V1 account with address as pda of ['metadata', program id, mint, 'edition']

property

[writable] mint Metadata mint

property

[writable] printingMint 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

property

[writable] oneTimePrintingAuthorizationMint 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.

property

[signer] updateAuthority Current Update authority key

property

[signer] printingMintAuthority Printing mint authority - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY.

property

[signer] mintAuthority Mint authority on the metadata's mint - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY

property

[] metadata Metadata account

property

[signer] payer payer

property

[signer] oneTimePrintingAuthorizationMintAuthority One time authorization printing mint authority - must be provided if using max supply. THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY.

Type declaration

  • edition: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • mintAuthority: web3.PublicKey
  • oneTimePrintingAuthorizationMint: web3.PublicKey
  • oneTimePrintingAuthorizationMintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • printingMint: web3.PublicKey
  • printingMintAuthority: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
DeprecatedCreateMasterEditionInstructionArgs: { createMasterEditionArgs: CreateMasterEditionArgs }

Type declaration

DeprecatedCreateMasterEditionStruct: FixableBeetArgsStruct<DeprecatedCreateMasterEditionInstructionArgs & { instructionDiscriminator: number }> = ...

DeprecatedCreateReservationList

DeprecatedCreateReservationListInstructionAccounts: { masterEdition: web3.PublicKey; metadata: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; reservationList: web3.PublicKey; resource: web3.PublicKey; systemProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the DeprecatedCreateReservationList instruction

property

[writable] reservationList PDA for ReservationList of ['metadata', program id, master edition key, 'reservation', resource-key]

property

[signer] payer Payer

property

[signer] updateAuthority Update authority

property

[] masterEdition Master Edition V1 key (pda of ['metadata', program id, mint id, 'edition'])

property

[] resource 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.

property

[] metadata Metadata key (pda of ['metadata', program id, mint id])

Type declaration

  • masterEdition: web3.PublicKey
  • metadata: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • reservationList: web3.PublicKey
  • resource: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
DeprecatedCreateReservationListStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...

DeprecatedMintNewEditionFromMasterEditionViaPrintingToken

DeprecatedMintNewEditionFromMasterEditionViaPrintingTokenInstructionAccounts: { burnAuthority: web3.PublicKey; edition: web3.PublicKey; editionMarker: web3.PublicKey; masterEdition: web3.PublicKey; masterMetadata: web3.PublicKey; masterTokenAccount: web3.PublicKey; masterUpdateAuthority: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; mintAuthority: web3.PublicKey; payer: web3.PublicKey; printingMint: web3.PublicKey; rent?: web3.PublicKey; reservationList?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenProgram?: web3.PublicKey }

Accounts required by the DeprecatedMintNewEditionFromMasterEditionViaPrintingToken instruction

property

[writable] metadata New Metadata key (pda of ['metadata', program id, mint id])

property

[writable] edition New Edition V1 (pda of ['metadata', program id, mint id, 'edition'])

property

[writable] masterEdition Master Record Edition V1 (pda of ['metadata', program id, master metadata mint id, 'edition'])

property

[writable] mint Mint of new token - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY

property

[signer] mintAuthority Mint authority of new mint

property

[writable] printingMint Printing Mint of master record edition

property

[writable] masterTokenAccount Token account containing Printing mint token to be transferred

property

[writable] editionMarker Edition pda to mark creation - will be checked for pre-existence. (pda of ['metadata', program id, master mint id, edition_number])

property

[signer] burnAuthority Burn authority for this token

property

[signer] payer payer

property

[] masterUpdateAuthority update authority info for new metadata account

property

[] masterMetadata Master record metadata account

property

[writable] reservationList (optional) Reservation List - If present, and you are on this list, you can get an edition number given by your position on the list.

Type declaration

  • burnAuthority: web3.PublicKey
  • edition: web3.PublicKey
  • editionMarker: web3.PublicKey
  • masterEdition: web3.PublicKey
  • masterMetadata: web3.PublicKey
  • masterTokenAccount: web3.PublicKey
  • masterUpdateAuthority: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • mintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • printingMint: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional reservationList?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
DeprecatedMintNewEditionFromMasterEditionViaPrintingTokenStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...

DeprecatedMintPrintingTokens

DeprecatedMintPrintingTokensInstructionAccounts: { destination: web3.PublicKey; masterEdition: web3.PublicKey; metadata: web3.PublicKey; printingMint: web3.PublicKey; rent?: web3.PublicKey; tokenProgram?: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the DeprecatedMintPrintingTokens instruction

property

[writable] destination Destination account

property

[writable] printingMint Printing mint

property

[signer] updateAuthority Update authority

property

[] metadata Metadata key (pda of ['metadata', program id, mint id])

property

[] masterEdition Master Edition V1 key (pda of ['metadata', program id, mint id, 'edition'])

Type declaration

  • destination: web3.PublicKey
  • masterEdition: web3.PublicKey
  • metadata: web3.PublicKey
  • printingMint: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • updateAuthority: web3.PublicKey
DeprecatedMintPrintingTokensInstructionArgs: { mintPrintingTokensViaTokenArgs: MintPrintingTokensViaTokenArgs }

Type declaration

DeprecatedMintPrintingTokensStruct: BeetArgsStruct<DeprecatedMintPrintingTokensInstructionArgs & { instructionDiscriminator: number }> = ...

DeprecatedMintPrintingTokensViaToken

DeprecatedMintPrintingTokensViaTokenInstructionAccounts: { burnAuthority: web3.PublicKey; destination: web3.PublicKey; masterEdition: web3.PublicKey; metadata: web3.PublicKey; oneTimePrintingAuthorizationMint: web3.PublicKey; printingMint: web3.PublicKey; rent?: web3.PublicKey; token: web3.PublicKey; tokenProgram?: web3.PublicKey }

Accounts required by the DeprecatedMintPrintingTokensViaToken instruction

property

[writable] destination Destination account

property

[writable] token Token account containing one time authorization token

property

[writable] oneTimePrintingAuthorizationMint One time authorization mint

property

[writable] printingMint Printing mint

property

[signer] burnAuthority Burn authority

property

[] metadata Metadata key (pda of ['metadata', program id, mint id])

property

[] masterEdition Master Edition V1 key (pda of ['metadata', program id, mint id, 'edition'])

Type declaration

  • burnAuthority: web3.PublicKey
  • destination: web3.PublicKey
  • masterEdition: web3.PublicKey
  • metadata: web3.PublicKey
  • oneTimePrintingAuthorizationMint: web3.PublicKey
  • printingMint: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • token: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
DeprecatedMintPrintingTokensViaTokenInstructionArgs: { mintPrintingTokensViaTokenArgs: MintPrintingTokensViaTokenArgs }

Type declaration

DeprecatedMintPrintingTokensViaTokenStruct: BeetArgsStruct<DeprecatedMintPrintingTokensViaTokenInstructionArgs & { instructionDiscriminator: number }> = ...

DeprecatedSetReservationList

DeprecatedSetReservationListInstructionAccounts: { masterEdition: web3.PublicKey; reservationList: web3.PublicKey; resource: web3.PublicKey }

Accounts required by the DeprecatedSetReservationList instruction

property

[writable] masterEdition Master Edition V1 key (pda of ['metadata', program id, mint id, 'edition'])

property

[writable] reservationList PDA for ReservationList of ['metadata', program id, master edition key, 'reservation', resource-key]

property

[signer] resource The resource you tied the reservation list too

Type declaration

  • masterEdition: web3.PublicKey
  • reservationList: web3.PublicKey
  • resource: web3.PublicKey
DeprecatedSetReservationListInstructionArgs: { setReservationListArgs: SetReservationListArgs }

Type declaration

DeprecatedSetReservationListStruct: FixableBeetArgsStruct<DeprecatedSetReservationListInstructionArgs & { instructionDiscriminator: number }> = ...

FreezeDelegatedAccount

FreezeDelegatedAccountInstructionAccounts: { delegate: web3.PublicKey; edition: web3.PublicKey; mint: web3.PublicKey; tokenAccount: web3.PublicKey; tokenProgram?: web3.PublicKey }

Accounts required by the FreezeDelegatedAccount instruction

property

[writable, signer] delegate Delegate

property

[writable] tokenAccount Token account to freeze

property

[] edition Edition

property

[] mint Token mint

Type declaration

  • delegate: web3.PublicKey
  • edition: web3.PublicKey
  • mint: web3.PublicKey
  • tokenAccount: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
FreezeDelegatedAccountStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...

MintNewEditionFromMasterEditionViaToken

MintNewEditionFromMasterEditionViaTokenInstructionAccounts: { editionMarkPda: web3.PublicKey; masterEdition: web3.PublicKey; metadata: web3.PublicKey; newEdition: web3.PublicKey; newMetadata: web3.PublicKey; newMetadataUpdateAuthority: web3.PublicKey; newMint: web3.PublicKey; newMintAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenAccount: web3.PublicKey; tokenAccountOwner: web3.PublicKey; tokenProgram?: web3.PublicKey }

Accounts required by the MintNewEditionFromMasterEditionViaToken instruction

property

[writable] newMetadata New Metadata key (pda of ['metadata', program id, mint id])

property

[writable] newEdition New Edition (pda of ['metadata', program id, mint id, 'edition'])

property

[writable] masterEdition Master Record Edition V2 (pda of ['metadata', program id, master metadata mint id, 'edition'])

property

[writable] newMint Mint of new token - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY

property

[writable] editionMarkPda 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).

property

[signer] newMintAuthority Mint authority of new mint

property

[writable, signer] payer payer

property

[signer] tokenAccountOwner owner of token account containing master token (#8)

property

[] tokenAccount token account containing token from master metadata mint

property

[] newMetadataUpdateAuthority Update authority info for new metadata

property

[] metadata Master record metadata account

Type declaration

  • editionMarkPda: web3.PublicKey
  • masterEdition: web3.PublicKey
  • metadata: web3.PublicKey
  • newEdition: web3.PublicKey
  • newMetadata: web3.PublicKey
  • newMetadataUpdateAuthority: web3.PublicKey
  • newMint: web3.PublicKey
  • newMintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • tokenAccount: web3.PublicKey
  • tokenAccountOwner: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
MintNewEditionFromMasterEditionViaTokenInstructionArgs: { mintNewEditionFromMasterEditionViaTokenArgs: MintNewEditionFromMasterEditionViaTokenArgs }

Type declaration

MintNewEditionFromMasterEditionViaTokenStruct: BeetArgsStruct<MintNewEditionFromMasterEditionViaTokenInstructionArgs & { instructionDiscriminator: number }> = ...

MintNewEditionFromMasterEditionViaVaultProxy

MintNewEditionFromMasterEditionViaVaultProxyInstructionAccounts: { editionMarkPda: web3.PublicKey; masterEdition: web3.PublicKey; metadata: web3.PublicKey; newEdition: web3.PublicKey; newMetadata: web3.PublicKey; newMetadataUpdateAuthority: web3.PublicKey; newMint: web3.PublicKey; newMintAuthority: web3.PublicKey; payer: web3.PublicKey; rent?: web3.PublicKey; safetyDepositBox: web3.PublicKey; safetyDepositStore: web3.PublicKey; systemProgram?: web3.PublicKey; tokenProgram?: web3.PublicKey; tokenVaultProgram: web3.PublicKey; vault: web3.PublicKey; vaultAuthority: web3.PublicKey }

Accounts required by the MintNewEditionFromMasterEditionViaVaultProxy instruction

property

[writable] newMetadata New Metadata key (pda of ['metadata', program id, mint id])

property

[writable] newEdition New Edition (pda of ['metadata', program id, mint id, 'edition'])

property

[writable] masterEdition Master Record Edition V2 (pda of ['metadata', program id, master metadata mint id, 'edition']

property

[writable] newMint Mint of new token - THIS WILL TRANSFER AUTHORITY AWAY FROM THIS KEY

property

[writable] editionMarkPda 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).

property

[signer] newMintAuthority Mint authority of new mint

property

[writable, signer] payer payer

property

[signer] vaultAuthority Vault authority

property

[] safetyDepositStore Safety deposit token store account

property

[] safetyDepositBox Safety deposit box

property

[] vault Vault

property

[] newMetadataUpdateAuthority Update authority info for new metadata

property

[] metadata Master record metadata account

property

[] tokenVaultProgram Token vault program

Type declaration

  • editionMarkPda: web3.PublicKey
  • masterEdition: web3.PublicKey
  • metadata: web3.PublicKey
  • newEdition: web3.PublicKey
  • newMetadata: web3.PublicKey
  • newMetadataUpdateAuthority: web3.PublicKey
  • newMint: web3.PublicKey
  • newMintAuthority: web3.PublicKey
  • payer: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • safetyDepositBox: web3.PublicKey
  • safetyDepositStore: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • tokenVaultProgram: web3.PublicKey
  • vault: web3.PublicKey
  • vaultAuthority: web3.PublicKey
MintNewEditionFromMasterEditionViaVaultProxyInstructionArgs: { mintNewEditionFromMasterEditionViaTokenArgs: MintNewEditionFromMasterEditionViaTokenArgs }

Type declaration

MintNewEditionFromMasterEditionViaVaultProxyStruct: BeetArgsStruct<MintNewEditionFromMasterEditionViaVaultProxyInstructionArgs & { instructionDiscriminator: number }> = ...

PuffMetadata

PuffMetadataInstructionAccounts: { metadata: web3.PublicKey }

Accounts required by the PuffMetadata instruction

property

[writable] metadata Metadata account

Type declaration

  • metadata: web3.PublicKey
PuffMetadataStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...

RemoveCreatorVerification

RemoveCreatorVerificationInstructionAccounts: { creator: web3.PublicKey; metadata: web3.PublicKey }

Accounts required by the RemoveCreatorVerification instruction

property

[writable] metadata Metadata (pda of ['metadata', program id, mint id])

property

[signer] creator Creator

Type declaration

  • creator: web3.PublicKey
  • metadata: web3.PublicKey
RemoveCreatorVerificationStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...

RevokeCollectionAuthority

RevokeCollectionAuthorityInstructionAccounts: { collectionAuthorityRecord: web3.PublicKey; delegateAuthority: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; revokeAuthority: web3.PublicKey }

Accounts required by the RevokeCollectionAuthority instruction

property

[writable] collectionAuthorityRecord Collection Authority Record PDA

property

[writable] delegateAuthority Delegated Collection Authority

property

[writable, signer] revokeAuthority Update Authority, or Delegated Authority, of Collection NFT

property

[] metadata Metadata account

property

[] mint Mint of Metadata

Type declaration

  • collectionAuthorityRecord: web3.PublicKey
  • delegateAuthority: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • revokeAuthority: web3.PublicKey
RevokeCollectionAuthorityStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...

RevokeUseAuthority

RevokeUseAuthorityInstructionAccounts: { metadata: web3.PublicKey; mint: web3.PublicKey; owner: web3.PublicKey; ownerTokenAccount: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenProgram?: web3.PublicKey; useAuthorityRecord: web3.PublicKey; user: web3.PublicKey }

Accounts required by the RevokeUseAuthority instruction

property

[writable] useAuthorityRecord Use Authority Record PDA

property

[writable, signer] owner Owner

property

[] user A Use Authority

property

[writable] ownerTokenAccount Owned Token Account Of Mint

property

[] mint Mint of Metadata

property

[] metadata Metadata account

Type declaration

  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • owner: web3.PublicKey
  • ownerTokenAccount: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • useAuthorityRecord: web3.PublicKey
  • user: web3.PublicKey
RevokeUseAuthorityStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...

SetAndVerifyCollection

SetAndVerifyCollectionInstructionAccounts: { collection: web3.PublicKey; collectionAuthority: web3.PublicKey; collectionAuthorityRecord?: web3.PublicKey; collectionMasterEditionAccount: web3.PublicKey; collectionMint: web3.PublicKey; metadata: web3.PublicKey; payer: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the SetAndVerifyCollection instruction

property

[writable] metadata Metadata account

property

[writable, signer] collectionAuthority Collection Update authority

property

[writable, signer] payer Payer

property

[] updateAuthority Update Authority of Collection NFT and NFT

property

[] collectionMint Mint of the Collection

property

[] collection Metadata Account of the Collection

property

[] collectionMasterEditionAccount MasterEdition2 Account of the Collection Token

property

[] collectionAuthorityRecord (optional) Collection Authority Record PDA

Type declaration

  • collection: web3.PublicKey
  • collectionAuthority: web3.PublicKey
  • Optional collectionAuthorityRecord?: web3.PublicKey
  • collectionMasterEditionAccount: web3.PublicKey
  • collectionMint: web3.PublicKey
  • metadata: web3.PublicKey
  • payer: web3.PublicKey
  • updateAuthority: web3.PublicKey
SetAndVerifyCollectionStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...

SetAndVerifySizedCollectionItem

SetAndVerifySizedCollectionItemInstructionAccounts: { collection: web3.PublicKey; collectionAuthority: web3.PublicKey; collectionAuthorityRecord?: web3.PublicKey; collectionMasterEditionAccount: web3.PublicKey; collectionMint: web3.PublicKey; metadata: web3.PublicKey; payer: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the SetAndVerifySizedCollectionItem instruction

property

[writable] metadata Metadata account

property

[signer] collectionAuthority Collection Update authority

property

[writable, signer] payer payer

property

[] updateAuthority Update Authority of Collection NFT and NFT

property

[] collectionMint Mint of the Collection

property

[writable] collection Metadata Account of the Collection

property

[writable] collectionMasterEditionAccount MasterEdition2 Account of the Collection Token

property

[] collectionAuthorityRecord (optional) Collection Authority Record PDA

Type declaration

  • collection: web3.PublicKey
  • collectionAuthority: web3.PublicKey
  • Optional collectionAuthorityRecord?: web3.PublicKey
  • collectionMasterEditionAccount: web3.PublicKey
  • collectionMint: web3.PublicKey
  • metadata: web3.PublicKey
  • payer: web3.PublicKey
  • updateAuthority: web3.PublicKey
SetAndVerifySizedCollectionItemStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...

SetCollectionSize

SetCollectionSizeInstructionAccounts: { collectionAuthority: web3.PublicKey; collectionAuthorityRecord?: web3.PublicKey; collectionMetadata: web3.PublicKey; collectionMint: web3.PublicKey }

Accounts required by the SetCollectionSize instruction

property

[writable] collectionMetadata Collection Metadata account

property

[writable, signer] collectionAuthority Collection Update authority

property

[] collectionMint Mint of the Collection

property

[] collectionAuthorityRecord (optional) Collection Authority Record PDA

Type declaration

  • collectionAuthority: web3.PublicKey
  • Optional collectionAuthorityRecord?: web3.PublicKey
  • collectionMetadata: web3.PublicKey
  • collectionMint: web3.PublicKey
SetCollectionSizeInstructionArgs: { setCollectionSizeArgs: SetCollectionSizeArgs }

Type declaration

SetCollectionSizeStruct: BeetArgsStruct<SetCollectionSizeInstructionArgs & { instructionDiscriminator: number }> = ...

SetTokenStandard

SetTokenStandardInstructionAccounts: { edition?: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the SetTokenStandard instruction

property

[writable] metadata Metadata account

property

[writable, signer] updateAuthority Metadata update authority

property

[] mint Mint account

property

[] edition (optional) Edition account

Type declaration

  • Optional edition?: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • updateAuthority: web3.PublicKey
SetTokenStandardStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...

SignMetadata

SignMetadataInstructionAccounts: { creator: web3.PublicKey; metadata: web3.PublicKey }

Accounts required by the SignMetadata instruction

property

[writable] metadata Metadata (pda of ['metadata', program id, mint id])

property

[signer] creator Creator

Type declaration

  • creator: web3.PublicKey
  • metadata: web3.PublicKey
SignMetadataStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...

ThawDelegatedAccount

ThawDelegatedAccountInstructionAccounts: { delegate: web3.PublicKey; edition: web3.PublicKey; mint: web3.PublicKey; tokenAccount: web3.PublicKey; tokenProgram?: web3.PublicKey }

Accounts required by the ThawDelegatedAccount instruction

property

[writable, signer] delegate Delegate

property

[writable] tokenAccount Token account to thaw

property

[] edition Edition

property

[] mint Token mint

Type declaration

  • delegate: web3.PublicKey
  • edition: web3.PublicKey
  • mint: web3.PublicKey
  • tokenAccount: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
ThawDelegatedAccountStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...

UnverifyCollection

UnverifyCollectionInstructionAccounts: { collection: web3.PublicKey; collectionAuthority: web3.PublicKey; collectionAuthorityRecord?: web3.PublicKey; collectionMasterEditionAccount: web3.PublicKey; collectionMint: web3.PublicKey; metadata: web3.PublicKey }

Accounts required by the UnverifyCollection instruction

property

[writable] metadata Metadata account

property

[writable, signer] collectionAuthority Collection Authority

property

[] collectionMint Mint of the Collection

property

[] collection Metadata Account of the Collection

property

[] collectionMasterEditionAccount MasterEdition2 Account of the Collection Token

property

[] collectionAuthorityRecord (optional) Collection Authority Record PDA

Type declaration

  • collection: web3.PublicKey
  • collectionAuthority: web3.PublicKey
  • Optional collectionAuthorityRecord?: web3.PublicKey
  • collectionMasterEditionAccount: web3.PublicKey
  • collectionMint: web3.PublicKey
  • metadata: web3.PublicKey
UnverifyCollectionStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...

UnverifySizedCollectionItem

UnverifySizedCollectionItemInstructionAccounts: { collection: web3.PublicKey; collectionAuthority: web3.PublicKey; collectionAuthorityRecord?: web3.PublicKey; collectionMasterEditionAccount: web3.PublicKey; collectionMint: web3.PublicKey; metadata: web3.PublicKey; payer: web3.PublicKey }

Accounts required by the UnverifySizedCollectionItem instruction

property

[writable] metadata Metadata account

property

[signer] collectionAuthority Collection Authority

property

[writable, signer] payer payer

property

[] collectionMint Mint of the Collection

property

[writable] collection Metadata Account of the Collection

property

[] collectionMasterEditionAccount MasterEdition2 Account of the Collection Token

property

[] collectionAuthorityRecord (optional) Collection Authority Record PDA

Type declaration

  • collection: web3.PublicKey
  • collectionAuthority: web3.PublicKey
  • Optional collectionAuthorityRecord?: web3.PublicKey
  • collectionMasterEditionAccount: web3.PublicKey
  • collectionMint: web3.PublicKey
  • metadata: web3.PublicKey
  • payer: web3.PublicKey
UnverifySizedCollectionItemStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...

UpdateMetadataAccount

UpdateMetadataAccountInstructionAccounts: { metadata: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the UpdateMetadataAccount instruction

property

[writable] metadata Metadata account

property

[signer] updateAuthority Update authority key

Type declaration

  • metadata: web3.PublicKey
  • updateAuthority: web3.PublicKey
UpdateMetadataAccountInstructionArgs: { updateMetadataAccountArgs: UpdateMetadataAccountArgs }

Type declaration

UpdateMetadataAccountStruct: FixableBeetArgsStruct<UpdateMetadataAccountInstructionArgs & { instructionDiscriminator: number }> = ...

UpdateMetadataAccountV2

UpdateMetadataAccountV2InstructionAccounts: { metadata: web3.PublicKey; updateAuthority: web3.PublicKey }

Accounts required by the UpdateMetadataAccountV2 instruction

property

[writable] metadata Metadata account

property

[signer] updateAuthority Update authority key

Type declaration

  • metadata: web3.PublicKey
  • updateAuthority: web3.PublicKey
UpdateMetadataAccountV2InstructionArgs: { updateMetadataAccountArgsV2: UpdateMetadataAccountArgsV2 }

Type declaration

UpdateMetadataAccountV2Struct: FixableBeetArgsStruct<UpdateMetadataAccountV2InstructionArgs & { instructionDiscriminator: number }> = ...

UpdatePrimarySaleHappenedViaToken

UpdatePrimarySaleHappenedViaTokenInstructionAccounts: { metadata: web3.PublicKey; owner: web3.PublicKey; token: web3.PublicKey }

Accounts required by the UpdatePrimarySaleHappenedViaToken instruction

property

[writable] metadata Metadata key (pda of ['metadata', program id, mint id])

property

[signer] owner Owner on the token account

property

[] token Account containing tokens from the metadata's mint

Type declaration

  • metadata: web3.PublicKey
  • owner: web3.PublicKey
  • token: web3.PublicKey
UpdatePrimarySaleHappenedViaTokenStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...

Utilize

UtilizeInstructionAccounts: { ataProgram?: web3.PublicKey; burner?: web3.PublicKey; metadata: web3.PublicKey; mint: web3.PublicKey; owner: web3.PublicKey; rent?: web3.PublicKey; systemProgram?: web3.PublicKey; tokenAccount: web3.PublicKey; tokenProgram?: web3.PublicKey; useAuthority: web3.PublicKey; useAuthorityRecord?: web3.PublicKey }

Accounts required by the Utilize instruction

property

[writable] metadata Metadata account

property

[writable] tokenAccount Token Account Of NFT

property

[writable] mint Mint of the Metadata

property

[writable, signer] useAuthority A Use Authority / Can be the current Owner of the NFT

property

[] owner Owner

property

[writable] useAuthorityRecord (optional) Use Authority Record PDA If present the program Assumes a delegated use authority

property

[] burner (optional) Program As Signer (Burner)

Type declaration

  • Optional ataProgram?: web3.PublicKey
  • Optional burner?: web3.PublicKey
  • metadata: web3.PublicKey
  • mint: web3.PublicKey
  • owner: web3.PublicKey
  • Optional rent?: web3.PublicKey
  • Optional systemProgram?: web3.PublicKey
  • tokenAccount: web3.PublicKey
  • Optional tokenProgram?: web3.PublicKey
  • useAuthority: web3.PublicKey
  • Optional useAuthorityRecord?: web3.PublicKey
UtilizeInstructionArgs: { utilizeArgs: UtilizeArgs }

Type declaration

UtilizeStruct: BeetArgsStruct<UtilizeInstructionArgs & { instructionDiscriminator: number }> = ...

VerifyCollection

VerifyCollectionInstructionAccounts: { collection: web3.PublicKey; collectionAuthority: web3.PublicKey; collectionMasterEditionAccount: web3.PublicKey; collectionMint: web3.PublicKey; metadata: web3.PublicKey; payer: web3.PublicKey }

Accounts required by the VerifyCollection instruction

property

[writable] metadata Metadata account

property

[writable, signer] collectionAuthority Collection Update authority

property

[writable, signer] payer payer

property

[] collectionMint Mint of the Collection

property

[] collection Metadata Account of the Collection

property

[] collectionMasterEditionAccount MasterEdition2 Account of the Collection Token

Type declaration

  • collection: web3.PublicKey
  • collectionAuthority: web3.PublicKey
  • collectionMasterEditionAccount: web3.PublicKey
  • collectionMint: web3.PublicKey
  • metadata: web3.PublicKey
  • payer: web3.PublicKey
VerifyCollectionStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...

VerifySizedCollectionItem

VerifySizedCollectionItemInstructionAccounts: { collection: web3.PublicKey; collectionAuthority: web3.PublicKey; collectionAuthorityRecord?: web3.PublicKey; collectionMasterEditionAccount: web3.PublicKey; collectionMint: web3.PublicKey; metadata: web3.PublicKey; payer: web3.PublicKey }

Accounts required by the VerifySizedCollectionItem instruction

property

[writable] metadata Metadata account

property

[signer] collectionAuthority Collection Update authority

property

[writable, signer] payer payer

property

[] collectionMint Mint of the Collection

property

[writable] collection Metadata Account of the Collection

property

[] collectionMasterEditionAccount MasterEdition2 Account of the Collection Token

property

[] collectionAuthorityRecord (optional) Collection Authority Record PDA

Type declaration

  • collection: web3.PublicKey
  • collectionAuthority: web3.PublicKey
  • Optional collectionAuthorityRecord?: web3.PublicKey
  • collectionMasterEditionAccount: web3.PublicKey
  • collectionMint: web3.PublicKey
  • metadata: web3.PublicKey
  • payer: web3.PublicKey
VerifySizedCollectionItemStruct: BeetArgsStruct<{ instructionDiscriminator: number }> = ...

Generated using TypeDoc