Function getCompressInstruction

getCompressInstruction<
    TAccountTreeAuthority extends string,
    TAccountLeafOwner extends string,
    TAccountLeafDelegate extends string,
    TAccountMerkleTree extends string,
    TAccountTokenAccount extends string,
    TAccountMint extends string,
    TAccountMetadata extends string,
    TAccountMasterEdition extends string,
    TAccountPayer extends string,
    TAccountLogWrapper extends string,
    TAccountCompressionProgram extends string,
    TAccountTokenProgram extends string,
    TAccountTokenMetadataProgram extends string,
    TAccountSystemProgram extends string,
    TProgramAddress extends
        Address = Address<"BGUMAp9Gq7iTEuizy4pqaxsTyUCBK68MDfK752saRPUY">,
>(
    input: CompressInput<
        TAccountTreeAuthority,
        TAccountLeafOwner,
        TAccountLeafDelegate,
        TAccountMerkleTree,
        TAccountTokenAccount,
        TAccountMint,
        TAccountMetadata,
        TAccountMasterEdition,
        TAccountPayer,
        TAccountLogWrapper,
        TAccountCompressionProgram,
        TAccountTokenProgram,
        TAccountTokenMetadataProgram,
        TAccountSystemProgram,
    >,
    config?: { programAddress?: TProgramAddress },
): CompressInstruction<
    TProgramAddress,
    TAccountTreeAuthority,
    TAccountLeafOwner,
    TAccountLeafDelegate,
    TAccountMerkleTree,
    TAccountTokenAccount,
    TAccountMint,
    TAccountMetadata,
    TAccountMasterEdition,
    TAccountPayer,
    TAccountLogWrapper,
    TAccountCompressionProgram,
    TAccountTokenProgram,
    TAccountTokenMetadataProgram,
    TAccountSystemProgram,
>
Compresses an existing decompressed (SPL/Token Metadata) NFT into a new leaf of a compressed Merkle tree.

Reads the mint, token account, metadata and master edition of the decompressed NFT to build the leaf, then appends it to the tree.
Type Parameters
- TAccountTreeAuthority extends string
- TAccountLeafOwner extends string
- TAccountLeafDelegate extends string
- TAccountMerkleTree extends string
- TAccountTokenAccount extends string
- TAccountMint extends string
- TAccountMetadata extends string
- TAccountMasterEdition extends string
- TAccountPayer extends string
- TAccountLogWrapper extends string
- TAccountCompressionProgram extends string
- TAccountTokenProgram extends string
- TAccountTokenMetadataProgram extends string
- TAccountSystemProgram extends string
- TProgramAddress extends Address = Address<"BGUMAp9Gq7iTEuizy4pqaxsTyUCBK68MDfK752saRPUY">
Parameters
- input: CompressInput<
      TAccountTreeAuthority,
      TAccountLeafOwner,
      TAccountLeafDelegate,
      TAccountMerkleTree,
      TAccountTokenAccount,
      TAccountMint,
      TAccountMetadata,
      TAccountMasterEdition,
      TAccountPayer,
      TAccountLogWrapper,
      TAccountCompressionProgram,
      TAccountTokenProgram,
      TAccountTokenMetadataProgram,
      TAccountSystemProgram,
  >
- Optionalconfig: { programAddress?: TProgramAddress }
Returns CompressInstruction<
    TProgramAddress,
    TAccountTreeAuthority,
    TAccountLeafOwner,
    TAccountLeafDelegate,
    TAccountMerkleTree,
    TAccountTokenAccount,
    TAccountMint,
    TAccountMetadata,
    TAccountMasterEdition,
    TAccountPayer,
    TAccountLogWrapper,
    TAccountCompressionProgram,
    TAccountTokenProgram,
    TAccountTokenMetadataProgram,
    TAccountSystemProgram,
>
- Defined in instructions/compress.ts:448

Function getCompressInstruction

Type Parameters

Parameters

Settings