@kamino-finance/kliquidity-sdk/src/@codegen/kliquidity/instructions/withdraw.ts

Typescript SDK for interacting with the Kamino Liquidity (kliquidity) protocol

/**
 * This code was AUTOGENERATED using the Codama library.
 * Please DO NOT EDIT THIS FILE, instead use visitors
 * to add features, then rerun Codama to update it.
 *
 * @see https://github.com/codama-idl/codama
 */

import { combineCodec, fixDecoderSize, fixEncoderSize, getBytesDecoder, getBytesEncoder, getStructDecoder, getStructEncoder, getU64Decoder, getU64Encoder, transformEncoder, type AccountMeta, type AccountSignerMeta, type Address, type FixedSizeCodec, type FixedSizeDecoder, type FixedSizeEncoder, type Instruction, type InstructionWithAccounts, type InstructionWithData, type ReadonlyAccount, type ReadonlyUint8Array, type TransactionSigner, type WritableAccount, type WritableSignerAccount } from '@solana/kit';
import { YVAULTS_PROGRAM_ADDRESS } from '../programs';
import { getAccountMetaFactory, type ResolvedAccount } from '../shared';

export const WITHDRAW_DISCRIMINATOR = new Uint8Array([183, 18, 70, 156, 148, 109, 161, 34]);

export function getWithdrawDiscriminatorBytes() { return fixEncoderSize(getBytesEncoder(), 8).encode(WITHDRAW_DISCRIMINATOR); }

export type WithdrawInstruction<TProgram extends string = typeof YVAULTS_PROGRAM_ADDRESS, TAccountUser extends string | AccountMeta<string> = string, TAccountStrategy extends string | AccountMeta<string> = string, TAccountGlobalConfig extends string | AccountMeta<string> = string, TAccountPool extends string | AccountMeta<string> = string, TAccountPosition extends string | AccountMeta<string> = string, TAccountTickArrayLower extends string | AccountMeta<string> = string, TAccountTickArrayUpper extends string | AccountMeta<string> = string, TAccountTokenAVault extends string | AccountMeta<string> = string, TAccountTokenBVault extends string | AccountMeta<string> = string, TAccountBaseVaultAuthority extends string | AccountMeta<string> = string, TAccountPoolTokenVaultA extends string | AccountMeta<string> = string, TAccountPoolTokenVaultB extends string | AccountMeta<string> = string, TAccountTokenAAta extends string | AccountMeta<string> = string, TAccountTokenBAta extends string | AccountMeta<string> = string, TAccountTokenAMint extends string | AccountMeta<string> = string, TAccountTokenBMint extends string | AccountMeta<string> = string, TAccountUserSharesAta extends string | AccountMeta<string> = string, TAccountSharesMint extends string | AccountMeta<string> = string, TAccountTreasuryFeeTokenAVault extends string | AccountMeta<string> = string, TAccountTreasuryFeeTokenBVault extends string | AccountMeta<string> = string, TAccountTokenProgram extends string | AccountMeta<string> = "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA", TAccountTokenProgram2022 extends string | AccountMeta<string> = string, TAccountTokenATokenProgram extends string | AccountMeta<string> = string, TAccountTokenBTokenProgram extends string | AccountMeta<string> = string, TAccountMemoProgram extends string | AccountMeta<string> = string, TAccountPositionTokenAccount extends string | AccountMeta<string> = string, TAccountPoolProgram extends string | AccountMeta<string> = string, TAccountInstructionSysvarAccount extends string | AccountMeta<string> = "Sysvar1nstructions1111111111111111111111111", TAccountEventAuthority extends string | AccountMeta<string> = string, TRemainingAccounts extends readonly AccountMeta<string>[] = []> =
Instruction<TProgram> & InstructionWithData<ReadonlyUint8Array> & InstructionWithAccounts<[TAccountUser extends string ? WritableSignerAccount<TAccountUser> & AccountSignerMeta<TAccountUser> : TAccountUser, TAccountStrategy extends string ? WritableAccount<TAccountStrategy> : TAccountStrategy, TAccountGlobalConfig extends string ? ReadonlyAccount<TAccountGlobalConfig> : TAccountGlobalConfig, TAccountPool extends string ? WritableAccount<TAccountPool> : TAccountPool, TAccountPosition extends string ? WritableAccount<TAccountPosition> : TAccountPosition, TAccountTickArrayLower extends string ? WritableAccount<TAccountTickArrayLower> : TAccountTickArrayLower, TAccountTickArrayUpper extends string ? WritableAccount<TAccountTickArrayUpper> : TAccountTickArrayUpper, TAccountTokenAVault extends string ? WritableAccount<TAccountTokenAVault> : TAccountTokenAVault, TAccountTokenBVault extends string ? WritableAccount<TAccountTokenBVault> : TAccountTokenBVault, TAccountBaseVaultAuthority extends string ? ReadonlyAccount<TAccountBaseVaultAuthority> : TAccountBaseVaultAuthority, TAccountPoolTokenVaultA extends string ? WritableAccount<TAccountPoolTokenVaultA> : TAccountPoolTokenVaultA, TAccountPoolTokenVaultB extends string ? WritableAccount<TAccountPoolTokenVaultB> : TAccountPoolTokenVaultB, TAccountTokenAAta extends string ? WritableAccount<TAccountTokenAAta> : TAccountTokenAAta, TAccountTokenBAta extends string ? WritableAccount<TAccountTokenBAta> : TAccountTokenBAta, TAccountTokenAMint extends string ? ReadonlyAccount<TAccountTokenAMint> : TAccountTokenAMint, TAccountTokenBMint extends string ? ReadonlyAccount<TAccountTokenBMint> : TAccountTokenBMint, TAccountUserSharesAta extends string ? WritableAccount<TAccountUserSharesAta> : TAccountUserSharesAta, TAccountSharesMint extends string ? WritableAccount<TAccountSharesMint> : TAccountSharesMint, TAccountTreasuryFeeTokenAVault extends string ? WritableAccount<TAccountTreasuryFeeTokenAVault> : TAccountTreasuryFeeTokenAVault, TAccountTreasuryFeeTokenBVault extends string ? WritableAccount<TAccountTreasuryFeeTokenBVault> : TAccountTreasuryFeeTokenBVault, TAccountTokenProgram extends string ? ReadonlyAccount<TAccountTokenProgram> : TAccountTokenProgram, TAccountTokenProgram2022 extends string ? ReadonlyAccount<TAccountTokenProgram2022> : TAccountTokenProgram2022, TAccountTokenATokenProgram extends string ? ReadonlyAccount<TAccountTokenATokenProgram> : TAccountTokenATokenProgram, TAccountTokenBTokenProgram extends string ? ReadonlyAccount<TAccountTokenBTokenProgram> : TAccountTokenBTokenProgram, TAccountMemoProgram extends string ? ReadonlyAccount<TAccountMemoProgram> : TAccountMemoProgram, TAccountPositionTokenAccount extends string ? WritableAccount<TAccountPositionTokenAccount> : TAccountPositionTokenAccount, TAccountPoolProgram extends string ? ReadonlyAccount<TAccountPoolProgram> : TAccountPoolProgram, TAccountInstructionSysvarAccount extends string ? ReadonlyAccount<TAccountInstructionSysvarAccount> : TAccountInstructionSysvarAccount, TAccountEventAuthority extends string ? ReadonlyAccount<TAccountEventAuthority> : TAccountEventAuthority, ...TRemainingAccounts]>;

export type WithdrawInstructionData = { discriminator: ReadonlyUint8Array; sharesAmount: bigint;  };

export type WithdrawInstructionDataArgs = { sharesAmount: number | bigint;  };

export function getWithdrawInstructionDataEncoder(): FixedSizeEncoder<WithdrawInstructionDataArgs> {
    return transformEncoder(getStructEncoder([['discriminator', fixEncoderSize(getBytesEncoder(), 8)], ['sharesAmount', getU64Encoder()]]), (value) => ({ ...value, discriminator: WITHDRAW_DISCRIMINATOR }));
}

export function getWithdrawInstructionDataDecoder(): FixedSizeDecoder<WithdrawInstructionData> {
    return getStructDecoder([['discriminator', fixDecoderSize(getBytesDecoder(), 8)], ['sharesAmount', getU64Decoder()]]);
}

export function getWithdrawInstructionDataCodec(): FixedSizeCodec<WithdrawInstructionDataArgs, WithdrawInstructionData> {
    return combineCodec(getWithdrawInstructionDataEncoder(), getWithdrawInstructionDataDecoder());
}

export type WithdrawInput<TAccountUser extends string = string, TAccountStrategy extends string = string, TAccountGlobalConfig extends string = string, TAccountPool extends string = string, TAccountPosition extends string = string, TAccountTickArrayLower extends string = string, TAccountTickArrayUpper extends string = string, TAccountTokenAVault extends string = string, TAccountTokenBVault extends string = string, TAccountBaseVaultAuthority extends string = string, TAccountPoolTokenVaultA extends string = string, TAccountPoolTokenVaultB extends string = string, TAccountTokenAAta extends string = string, TAccountTokenBAta extends string = string, TAccountTokenAMint extends string = string, TAccountTokenBMint extends string = string, TAccountUserSharesAta extends string = string, TAccountSharesMint extends string = string, TAccountTreasuryFeeTokenAVault extends string = string, TAccountTreasuryFeeTokenBVault extends string = string, TAccountTokenProgram extends string = string, TAccountTokenProgram2022 extends string = string, TAccountTokenATokenProgram extends string = string, TAccountTokenBTokenProgram extends string = string, TAccountMemoProgram extends string = string, TAccountPositionTokenAccount extends string = string, TAccountPoolProgram extends string = string, TAccountInstructionSysvarAccount extends string = string, TAccountEventAuthority extends string = string> =  {
  user: TransactionSigner<TAccountUser>;
strategy: Address<TAccountStrategy>;
globalConfig: Address<TAccountGlobalConfig>;
pool: Address<TAccountPool>;
position: Address<TAccountPosition>;
tickArrayLower: Address<TAccountTickArrayLower>;
tickArrayUpper: Address<TAccountTickArrayUpper>;
tokenAVault: Address<TAccountTokenAVault>;
tokenBVault: Address<TAccountTokenBVault>;
baseVaultAuthority: Address<TAccountBaseVaultAuthority>;
poolTokenVaultA: Address<TAccountPoolTokenVaultA>;
poolTokenVaultB: Address<TAccountPoolTokenVaultB>;
tokenAAta: Address<TAccountTokenAAta>;
tokenBAta: Address<TAccountTokenBAta>;
tokenAMint: Address<TAccountTokenAMint>;
tokenBMint: Address<TAccountTokenBMint>;
userSharesAta: Address<TAccountUserSharesAta>;
sharesMint: Address<TAccountSharesMint>;
treasuryFeeTokenAVault: Address<TAccountTreasuryFeeTokenAVault>;
treasuryFeeTokenBVault: Address<TAccountTreasuryFeeTokenBVault>;
tokenProgram?: Address<TAccountTokenProgram>;
tokenProgram2022: Address<TAccountTokenProgram2022>;
tokenATokenProgram: Address<TAccountTokenATokenProgram>;
tokenBTokenProgram: Address<TAccountTokenBTokenProgram>;
memoProgram: Address<TAccountMemoProgram>;
positionTokenAccount: Address<TAccountPositionTokenAccount>;
poolProgram: Address<TAccountPoolProgram>;
instructionSysvarAccount?: Address<TAccountInstructionSysvarAccount>;
eventAuthority?: Address<TAccountEventAuthority>;
sharesAmount: WithdrawInstructionDataArgs["sharesAmount"];
}

export function getWithdrawInstruction<TAccountUser extends string, TAccountStrategy extends string, TAccountGlobalConfig extends string, TAccountPool extends string, TAccountPosition extends string, TAccountTickArrayLower extends string, TAccountTickArrayUpper extends string, TAccountTokenAVault extends string, TAccountTokenBVault extends string, TAccountBaseVaultAuthority extends string, TAccountPoolTokenVaultA extends string, TAccountPoolTokenVaultB extends string, TAccountTokenAAta extends string, TAccountTokenBAta extends string, TAccountTokenAMint extends string, TAccountTokenBMint extends string, TAccountUserSharesAta extends string, TAccountSharesMint extends string, TAccountTreasuryFeeTokenAVault extends string, TAccountTreasuryFeeTokenBVault extends string, TAccountTokenProgram extends string, TAccountTokenProgram2022 extends string, TAccountTokenATokenProgram extends string, TAccountTokenBTokenProgram extends string, TAccountMemoProgram extends string, TAccountPositionTokenAccount extends string, TAccountPoolProgram extends string, TAccountInstructionSysvarAccount extends string, TAccountEventAuthority extends string, TProgramAddress extends Address = typeof YVAULTS_PROGRAM_ADDRESS>(input: WithdrawInput<TAccountUser, TAccountStrategy, TAccountGlobalConfig, TAccountPool, TAccountPosition, TAccountTickArrayLower, TAccountTickArrayUpper, TAccountTokenAVault, TAccountTokenBVault, TAccountBaseVaultAuthority, TAccountPoolTokenVaultA, TAccountPoolTokenVaultB, TAccountTokenAAta, TAccountTokenBAta, TAccountTokenAMint, TAccountTokenBMint, TAccountUserSharesAta, TAccountSharesMint, TAccountTreasuryFeeTokenAVault, TAccountTreasuryFeeTokenBVault, TAccountTokenProgram, TAccountTokenProgram2022, TAccountTokenATokenProgram, TAccountTokenBTokenProgram, TAccountMemoProgram, TAccountPositionTokenAccount, TAccountPoolProgram, TAccountInstructionSysvarAccount, TAccountEventAuthority>, config?: { programAddress?: TProgramAddress } ): WithdrawInstruction<TProgramAddress, TAccountUser, TAccountStrategy, TAccountGlobalConfig, TAccountPool, TAccountPosition, TAccountTickArrayLower, TAccountTickArrayUpper, TAccountTokenAVault, TAccountTokenBVault, TAccountBaseVaultAuthority, TAccountPoolTokenVaultA, TAccountPoolTokenVaultB, TAccountTokenAAta, TAccountTokenBAta, TAccountTokenAMint, TAccountTokenBMint, TAccountUserSharesAta, TAccountSharesMint, TAccountTreasuryFeeTokenAVault, TAccountTreasuryFeeTokenBVault, TAccountTokenProgram, TAccountTokenProgram2022, TAccountTokenATokenProgram, TAccountTokenBTokenProgram, TAccountMemoProgram, TAccountPositionTokenAccount, TAccountPoolProgram, TAccountInstructionSysvarAccount, TAccountEventAuthority> {
  // Program address.
const programAddress = config?.programAddress ?? YVAULTS_PROGRAM_ADDRESS;

 // Original accounts.
const originalAccounts = { user: { value: input.user ?? null, isWritable: true }, strategy: { value: input.strategy ?? null, isWritable: true }, globalConfig: { value: input.globalConfig ?? null, isWritable: false }, pool: { value: input.pool ?? null, isWritable: true }, position: { value: input.position ?? null, isWritable: true }, tickArrayLower: { value: input.tickArrayLower ?? null, isWritable: true }, tickArrayUpper: { value: input.tickArrayUpper ?? null, isWritable: true }, tokenAVault: { value: input.tokenAVault ?? null, isWritable: true }, tokenBVault: { value: input.tokenBVault ?? null, isWritable: true }, baseVaultAuthority: { value: input.baseVaultAuthority ?? null, isWritable: false }, poolTokenVaultA: { value: input.poolTokenVaultA ?? null, isWritable: true }, poolTokenVaultB: { value: input.poolTokenVaultB ?? null, isWritable: true }, tokenAAta: { value: input.tokenAAta ?? null, isWritable: true }, tokenBAta: { value: input.tokenBAta ?? null, isWritable: true }, tokenAMint: { value: input.tokenAMint ?? null, isWritable: false }, tokenBMint: { value: input.tokenBMint ?? null, isWritable: false }, userSharesAta: { value: input.userSharesAta ?? null, isWritable: true }, sharesMint: { value: input.sharesMint ?? null, isWritable: true }, treasuryFeeTokenAVault: { value: input.treasuryFeeTokenAVault ?? null, isWritable: true }, treasuryFeeTokenBVault: { value: input.treasuryFeeTokenBVault ?? null, isWritable: true }, tokenProgram: { value: input.tokenProgram ?? null, isWritable: false }, tokenProgram2022: { value: input.tokenProgram2022 ?? null, isWritable: false }, tokenATokenProgram: { value: input.tokenATokenProgram ?? null, isWritable: false }, tokenBTokenProgram: { value: input.tokenBTokenProgram ?? null, isWritable: false }, memoProgram: { value: input.memoProgram ?? null, isWritable: false }, positionTokenAccount: { value: input.positionTokenAccount ?? null, isWritable: true }, poolProgram: { value: input.poolProgram ?? null, isWritable: false }, instructionSysvarAccount: { value: input.instructionSysvarAccount ?? null, isWritable: false }, eventAuthority: { value: input.eventAuthority ?? null, isWritable: false } }
const accounts = originalAccounts as Record<keyof typeof originalAccounts, ResolvedAccount>;


// Original args.
const args = { ...input,  };


// Resolve default values.
if (!accounts.tokenProgram.value) {
accounts.tokenProgram.value = 'TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA' as Address<'TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA'>;
}
if (!accounts.instructionSysvarAccount.value) {
accounts.instructionSysvarAccount.value = 'Sysvar1nstructions1111111111111111111111111' as Address<'Sysvar1nstructions1111111111111111111111111'>;
}

const getAccountMeta = getAccountMetaFactory(programAddress, 'programId');
return Object.freeze({ accounts: [getAccountMeta(accounts.user), getAccountMeta(accounts.strategy), getAccountMeta(accounts.globalConfig), getAccountMeta(accounts.pool), getAccountMeta(accounts.position), getAccountMeta(accounts.tickArrayLower), getAccountMeta(accounts.tickArrayUpper), getAccountMeta(accounts.tokenAVault), getAccountMeta(accounts.tokenBVault), getAccountMeta(accounts.baseVaultAuthority), getAccountMeta(accounts.poolTokenVaultA), getAccountMeta(accounts.poolTokenVaultB), getAccountMeta(accounts.tokenAAta), getAccountMeta(accounts.tokenBAta), getAccountMeta(accounts.tokenAMint), getAccountMeta(accounts.tokenBMint), getAccountMeta(accounts.userSharesAta), getAccountMeta(accounts.sharesMint), getAccountMeta(accounts.treasuryFeeTokenAVault), getAccountMeta(accounts.treasuryFeeTokenBVault), getAccountMeta(accounts.tokenProgram), getAccountMeta(accounts.tokenProgram2022), getAccountMeta(accounts.tokenATokenProgram), getAccountMeta(accounts.tokenBTokenProgram), getAccountMeta(accounts.memoProgram), getAccountMeta(accounts.positionTokenAccount), getAccountMeta(accounts.poolProgram), getAccountMeta(accounts.instructionSysvarAccount), getAccountMeta(accounts.eventAuthority)], data: getWithdrawInstructionDataEncoder().encode(args as WithdrawInstructionDataArgs), programAddress } as WithdrawInstruction<TProgramAddress, TAccountUser, TAccountStrategy, TAccountGlobalConfig, TAccountPool, TAccountPosition, TAccountTickArrayLower, TAccountTickArrayUpper, TAccountTokenAVault, TAccountTokenBVault, TAccountBaseVaultAuthority, TAccountPoolTokenVaultA, TAccountPoolTokenVaultB, TAccountTokenAAta, TAccountTokenBAta, TAccountTokenAMint, TAccountTokenBMint, TAccountUserSharesAta, TAccountSharesMint, TAccountTreasuryFeeTokenAVault, TAccountTreasuryFeeTokenBVault, TAccountTokenProgram, TAccountTokenProgram2022, TAccountTokenATokenProgram, TAccountTokenBTokenProgram, TAccountMemoProgram, TAccountPositionTokenAccount, TAccountPoolProgram, TAccountInstructionSysvarAccount, TAccountEventAuthority>);
}

export type ParsedWithdrawInstruction<TProgram extends string = typeof YVAULTS_PROGRAM_ADDRESS, TAccountMetas extends readonly AccountMeta[] = readonly AccountMeta[]> = { programAddress: Address<TProgram>;
accounts: {
user: TAccountMetas[0];
strategy: TAccountMetas[1];
globalConfig: TAccountMetas[2];
pool: TAccountMetas[3];
position: TAccountMetas[4];
tickArrayLower: TAccountMetas[5];
tickArrayUpper: TAccountMetas[6];
tokenAVault: TAccountMetas[7];
tokenBVault: TAccountMetas[8];
baseVaultAuthority: TAccountMetas[9];
poolTokenVaultA: TAccountMetas[10];
poolTokenVaultB: TAccountMetas[11];
tokenAAta: TAccountMetas[12];
tokenBAta: TAccountMetas[13];
tokenAMint: TAccountMetas[14];
tokenBMint: TAccountMetas[15];
userSharesAta: TAccountMetas[16];
sharesMint: TAccountMetas[17];
treasuryFeeTokenAVault: TAccountMetas[18];
treasuryFeeTokenBVault: TAccountMetas[19];
tokenProgram: TAccountMetas[20];
tokenProgram2022: TAccountMetas[21];
tokenATokenProgram: TAccountMetas[22];
tokenBTokenProgram: TAccountMetas[23];
memoProgram: TAccountMetas[24];
positionTokenAccount: TAccountMetas[25];
poolProgram: TAccountMetas[26];
instructionSysvarAccount: TAccountMetas[27];
eventAuthority?: TAccountMetas[28] | undefined;
};
data: WithdrawInstructionData; };

export function parseWithdrawInstruction<TProgram extends string, TAccountMetas extends readonly AccountMeta[]>(instruction: Instruction<TProgram> & InstructionWithAccounts<TAccountMetas> & InstructionWithData<ReadonlyUint8Array>): ParsedWithdrawInstruction<TProgram, TAccountMetas> {
  if (instruction.accounts.length < 29) {
  // TODO: Coded error.
  throw new Error('Not enough accounts');
}
let accountIndex = 0;
const getNextAccount = () => {
  const accountMeta = (instruction.accounts as TAccountMetas)[accountIndex]!;
  accountIndex += 1;
  return accountMeta;
}
const getNextOptionalAccount = () => {
  const accountMeta = getNextAccount();
  return accountMeta.address === YVAULTS_PROGRAM_ADDRESS ? undefined : accountMeta;
};
  return { programAddress: instruction.programAddress, accounts: { user: getNextAccount(), strategy: getNextAccount(), globalConfig: getNextAccount(), pool: getNextAccount(), position: getNextAccount(), tickArrayLower: getNextAccount(), tickArrayUpper: getNextAccount(), tokenAVault: getNextAccount(), tokenBVault: getNextAccount(), baseVaultAuthority: getNextAccount(), poolTokenVaultA: getNextAccount(), poolTokenVaultB: getNextAccount(), tokenAAta: getNextAccount(), tokenBAta: getNextAccount(), tokenAMint: getNextAccount(), tokenBMint: getNextAccount(), userSharesAta: getNextAccount(), sharesMint: getNextAccount(), treasuryFeeTokenAVault: getNextAccount(), treasuryFeeTokenBVault: getNextAccount(), tokenProgram: getNextAccount(), tokenProgram2022: getNextAccount(), tokenATokenProgram: getNextAccount(), tokenBTokenProgram: getNextAccount(), memoProgram: getNextAccount(), positionTokenAccount: getNextAccount(), poolProgram: getNextAccount(), instructionSysvarAccount: getNextAccount(), eventAuthority: getNextOptionalAccount() }, data: getWithdrawInstructionDataDecoder().decode(instruction.data) };
}