Function getTransferInstruction

getTransferInstruction<
    TAccountTreeAuthority extends string,
    TAccountLeafOwner extends string,
    TAccountLeafDelegate extends string,
    TAccountNewLeafOwner extends string,
    TAccountMerkleTree extends string,
    TAccountLogWrapper extends string,
    TAccountCompressionProgram extends string,
    TAccountSystemProgram extends string,
    TProgramAddress extends
        Address = Address<"BGUMAp9Gq7iTEuizy4pqaxsTyUCBK68MDfK752saRPUY">,
>(
    input: TransferInput<
        TAccountTreeAuthority,
        TAccountLeafOwner,
        TAccountLeafDelegate,
        TAccountNewLeafOwner,
        TAccountMerkleTree,
        TAccountLogWrapper,
        TAccountCompressionProgram,
        TAccountSystemProgram,
    >,
    config?: { programAddress?: TProgramAddress },
): TransferInstruction<
    TProgramAddress,
    TAccountTreeAuthority,
    TAccountLeafOwner,
    TAccountLeafDelegate,
    TAccountNewLeafOwner,
    TAccountMerkleTree,
    TAccountLogWrapper,
    TAccountCompressionProgram,
    TAccountSystemProgram,
>
Transfers a compressed NFT leaf from one owner to another.

Must be signed by the current leaf owner or delegate. Clears any existing delegate on the leaf as part of the transfer.
Type Parameters
- TAccountTreeAuthority extends string
- TAccountLeafOwner extends string
- TAccountLeafDelegate extends string
- TAccountNewLeafOwner extends string
- TAccountMerkleTree extends string
- TAccountLogWrapper extends string
- TAccountCompressionProgram extends string
- TAccountSystemProgram extends string
- TProgramAddress extends Address = Address<"BGUMAp9Gq7iTEuizy4pqaxsTyUCBK68MDfK752saRPUY">
Parameters
- input: TransferInput<
      TAccountTreeAuthority,
      TAccountLeafOwner,
      TAccountLeafDelegate,
      TAccountNewLeafOwner,
      TAccountMerkleTree,
      TAccountLogWrapper,
      TAccountCompressionProgram,
      TAccountSystemProgram,
  >
- Optionalconfig: { programAddress?: TProgramAddress }
Returns TransferInstruction<
    TProgramAddress,
    TAccountTreeAuthority,
    TAccountLeafOwner,
    TAccountLeafDelegate,
    TAccountNewLeafOwner,
    TAccountMerkleTree,
    TAccountLogWrapper,
    TAccountCompressionProgram,
    TAccountSystemProgram,
>
- Defined in instructions/transfer.ts:415

Function getTransferInstruction

Type Parameters

Parameters

Returns TransferInstruction< TProgramAddress, TAccountTreeAuthority, TAccountLeafOwner, TAccountLeafDelegate, TAccountNewLeafOwner, TAccountMerkleTree, TAccountLogWrapper, TAccountCompressionProgram, TAccountSystemProgram,>

Settings

Returns TransferInstruction<
TProgramAddress,
TAccountTreeAuthority,
TAccountLeafOwner,
TAccountLeafDelegate,
TAccountNewLeafOwner,
TAccountMerkleTree,
TAccountLogWrapper,
TAccountCompressionProgram,
TAccountSystemProgram,
>