Function getRedeemInstruction

getRedeemInstruction<
    TAccountTreeAuthority extends string,
    TAccountLeafOwner extends string,
    TAccountLeafDelegate extends string,
    TAccountMerkleTree extends string,
    TAccountVoucher extends string,
    TAccountLogWrapper extends string,
    TAccountCompressionProgram extends string,
    TAccountSystemProgram extends string,
    TProgramAddress extends
        Address = Address<"BGUMAp9Gq7iTEuizy4pqaxsTyUCBK68MDfK752saRPUY">,
>(
    input: RedeemInput<
        TAccountTreeAuthority,
        TAccountLeafOwner,
        TAccountLeafDelegate,
        TAccountMerkleTree,
        TAccountVoucher,
        TAccountLogWrapper,
        TAccountCompressionProgram,
        TAccountSystemProgram,
    >,
    config?: { programAddress?: TProgramAddress },
): RedeemInstruction<
    TProgramAddress,
    TAccountTreeAuthority,
    TAccountLeafOwner,
    TAccountLeafDelegate,
    TAccountMerkleTree,
    TAccountVoucher,
    TAccountLogWrapper,
    TAccountCompressionProgram,
    TAccountSystemProgram,
>
Redeems (vouches for) a leaf, removing it from the tree and recording its data in a new voucher PDA.

This is the first step of decompression: once redeemed, the leaf slot in the tree is emptied and the leaf's data is preserved in voucher until decompressV1 consumes it, or cancelRedeem restores it.
Type Parameters
- TAccountTreeAuthority extends string
- TAccountLeafOwner extends string
- TAccountLeafDelegate extends string
- TAccountMerkleTree extends string
- TAccountVoucher extends string
- TAccountLogWrapper extends string
- TAccountCompressionProgram extends string
- TAccountSystemProgram extends string
- TProgramAddress extends Address = Address<"BGUMAp9Gq7iTEuizy4pqaxsTyUCBK68MDfK752saRPUY">
Parameters
- input: RedeemInput<
      TAccountTreeAuthority,
      TAccountLeafOwner,
      TAccountLeafDelegate,
      TAccountMerkleTree,
      TAccountVoucher,
      TAccountLogWrapper,
      TAccountCompressionProgram,
      TAccountSystemProgram,
  >
- Optionalconfig: { programAddress?: TProgramAddress }
Returns RedeemInstruction<
    TProgramAddress,
    TAccountTreeAuthority,
    TAccountLeafOwner,
    TAccountLeafDelegate,
    TAccountMerkleTree,
    TAccountVoucher,
    TAccountLogWrapper,
    TAccountCompressionProgram,
    TAccountSystemProgram,
>
- Defined in instructions/redeem.ts:429

Function getRedeemInstruction

Type Parameters

Parameters

Returns RedeemInstruction< TProgramAddress, TAccountTreeAuthority, TAccountLeafOwner, TAccountLeafDelegate, TAccountMerkleTree, TAccountVoucher, TAccountLogWrapper, TAccountCompressionProgram, TAccountSystemProgram,>

Settings

Returns RedeemInstruction<
TProgramAddress,
TAccountTreeAuthority,
TAccountLeafOwner,
TAccountLeafDelegate,
TAccountMerkleTree,
TAccountVoucher,
TAccountLogWrapper,
TAccountCompressionProgram,
TAccountSystemProgram,
>