Function getCloseTreeV2Instruction

getCloseTreeV2Instruction<
    TAccountTreeAuthority extends string,
    TAccountAuthority extends string,
    TAccountMerkleTree extends string,
    TAccountRecipient extends string,
    TAccountCompressionProgram extends string,
    TAccountLogWrapper extends string,
    TAccountSystemProgram extends string,
    TProgramAddress extends
        Address = Address<"BGUMAp9Gq7iTEuizy4pqaxsTyUCBK68MDfK752saRPUY">,
>(
    input: CloseTreeV2Input<
        TAccountTreeAuthority,
        TAccountAuthority,
        TAccountMerkleTree,
        TAccountRecipient,
        TAccountCompressionProgram,
        TAccountLogWrapper,
        TAccountSystemProgram,
    >,
    config?: { programAddress?: TProgramAddress },
): CloseTreeV2Instruction<
    TProgramAddress,
    TAccountTreeAuthority,
    TAccountAuthority,
    TAccountMerkleTree,
    TAccountRecipient,
    TAccountCompressionProgram,
    TAccountLogWrapper,
    TAccountSystemProgram,
>
Closes an empty V2 tree and its TreeConfig PDA, reclaiming rent.

Only the tree creator or delegate may close a tree, and it must be empty (no un-burned leaves) for the underlying compression program to allow the close.
Type Parameters
- TAccountTreeAuthority extends string
- TAccountAuthority extends string
- TAccountMerkleTree extends string
- TAccountRecipient extends string
- TAccountCompressionProgram extends string
- TAccountLogWrapper extends string
- TAccountSystemProgram extends string
- TProgramAddress extends Address = Address<"BGUMAp9Gq7iTEuizy4pqaxsTyUCBK68MDfK752saRPUY">
Parameters
- input: CloseTreeV2Input<
      TAccountTreeAuthority,
      TAccountAuthority,
      TAccountMerkleTree,
      TAccountRecipient,
      TAccountCompressionProgram,
      TAccountLogWrapper,
      TAccountSystemProgram,
  >
- Optionalconfig: { programAddress?: TProgramAddress }
Returns CloseTreeV2Instruction<
    TProgramAddress,
    TAccountTreeAuthority,
    TAccountAuthority,
    TAccountMerkleTree,
    TAccountRecipient,
    TAccountCompressionProgram,
    TAccountLogWrapper,
    TAccountSystemProgram,
>
- Defined in instructions/closeTreeV2.ts:317

Function getCloseTreeV2Instruction

Type Parameters

Parameters

Returns CloseTreeV2Instruction< TProgramAddress, TAccountTreeAuthority, TAccountAuthority, TAccountMerkleTree, TAccountRecipient, TAccountCompressionProgram, TAccountLogWrapper, TAccountSystemProgram,>

Settings

Returns CloseTreeV2Instruction<
TProgramAddress,
TAccountTreeAuthority,
TAccountAuthority,
TAccountMerkleTree,
TAccountRecipient,
TAccountCompressionProgram,
TAccountLogWrapper,
TAccountSystemProgram,
>