Function getUpdateMetadataInstruction

getUpdateMetadataInstruction<
    TAccountTreeAuthority extends string,
    TAccountAuthority extends string,
    TAccountCollectionMint extends string,
    TAccountCollectionMetadata extends string,
    TAccountCollectionAuthorityRecordPda extends string,
    TAccountLeafOwner extends string,
    TAccountLeafDelegate extends string,
    TAccountPayer extends string,
    TAccountMerkleTree extends string,
    TAccountLogWrapper extends string,
    TAccountCompressionProgram extends string,
    TAccountTokenMetadataProgram extends string,
    TAccountSystemProgram extends string,
    TProgramAddress extends
        Address = Address<"BGUMAp9Gq7iTEuizy4pqaxsTyUCBK68MDfK752saRPUY">,
>(
    input: UpdateMetadataInput<
        TAccountTreeAuthority,
        TAccountAuthority,
        TAccountCollectionMint,
        TAccountCollectionMetadata,
        TAccountCollectionAuthorityRecordPda,
        TAccountLeafOwner,
        TAccountLeafDelegate,
        TAccountPayer,
        TAccountMerkleTree,
        TAccountLogWrapper,
        TAccountCompressionProgram,
        TAccountTokenMetadataProgram,
        TAccountSystemProgram,
    >,
    config?: { programAddress?: TProgramAddress },
): UpdateMetadataInstruction<
    TProgramAddress,
    TAccountTreeAuthority,
    TAccountAuthority,
    TAccountCollectionMint,
    TAccountCollectionMetadata,
    TAccountCollectionAuthorityRecordPda,
    TAccountLeafOwner,
    TAccountLeafDelegate,
    TAccountPayer,
    TAccountMerkleTree,
    TAccountLogWrapper,
    TAccountCompressionProgram,
    TAccountTokenMetadataProgram,
    TAccountSystemProgram,
>
Updates the on-chain metadata fields of a compressed NFT leaf.

The caller supplies currentMetadata (verified against the leaf's stored dataHash) and updateArgs describing which fields to change; unset fields in updateArgs are left as-is.
Type Parameters
- TAccountTreeAuthority extends string
- TAccountAuthority extends string
- TAccountCollectionMint extends string
- TAccountCollectionMetadata extends string
- TAccountCollectionAuthorityRecordPda extends string
- TAccountLeafOwner extends string
- TAccountLeafDelegate extends string
- TAccountPayer extends string
- TAccountMerkleTree extends string
- TAccountLogWrapper extends string
- TAccountCompressionProgram extends string
- TAccountTokenMetadataProgram extends string
- TAccountSystemProgram extends string
- TProgramAddress extends Address = Address<"BGUMAp9Gq7iTEuizy4pqaxsTyUCBK68MDfK752saRPUY">
Parameters
- input: UpdateMetadataInput<
      TAccountTreeAuthority,
      TAccountAuthority,
      TAccountCollectionMint,
      TAccountCollectionMetadata,
      TAccountCollectionAuthorityRecordPda,
      TAccountLeafOwner,
      TAccountLeafDelegate,
      TAccountPayer,
      TAccountMerkleTree,
      TAccountLogWrapper,
      TAccountCompressionProgram,
      TAccountTokenMetadataProgram,
      TAccountSystemProgram,
  >
- Optionalconfig: { programAddress?: TProgramAddress }
Returns UpdateMetadataInstruction<
    TProgramAddress,
    TAccountTreeAuthority,
    TAccountAuthority,
    TAccountCollectionMint,
    TAccountCollectionMetadata,
    TAccountCollectionAuthorityRecordPda,
    TAccountLeafOwner,
    TAccountLeafDelegate,
    TAccountPayer,
    TAccountMerkleTree,
    TAccountLogWrapper,
    TAccountCompressionProgram,
    TAccountTokenMetadataProgram,
    TAccountSystemProgram,
>
- Defined in instructions/updateMetadata.ts:552

Function getUpdateMetadataInstruction

Type Parameters

Parameters

Settings