@voltr/vault-sdk 1.0.21 → 2.0.0

package/src/generated/instructions/cancelRequestWithdrawVault.ts

@@ -0,0 +1,546 @@
+/**
+ * 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,
+  getAddressEncoder,
+  getBytesDecoder,
+  getBytesEncoder,
+  getProgramDerivedAddress,
+  getStructDecoder,
+  getStructEncoder,
+  SOLANA_ERROR__PROGRAM_CLIENTS__INSUFFICIENT_ACCOUNT_METAS,
+  SolanaError,
+  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 {
+  getAccountMetaFactory,
+  getAddressFromResolvedInstructionAccount,
+  type ResolvedInstructionAccount,
+} from "@solana/program-client-core";
+import {
+  findProtocolPda,
+  findRequestWithdrawVaultReceiptPda,
+  findVaultLpMintPda,
+} from "../pdas";
+import { VOLTR_VAULT_PROGRAM_ADDRESS } from "../programs";
+
+export const CANCEL_REQUEST_WITHDRAW_VAULT_DISCRIMINATOR = new Uint8Array([
+  231, 54, 14, 6, 223, 124, 127, 238,
+]);
+
+export function getCancelRequestWithdrawVaultDiscriminatorBytes() {
+  return fixEncoderSize(getBytesEncoder(), 8).encode(
+    CANCEL_REQUEST_WITHDRAW_VAULT_DISCRIMINATOR,
+  );
+}
+
+export type CancelRequestWithdrawVaultInstruction<
+  TProgram extends string = typeof VOLTR_VAULT_PROGRAM_ADDRESS,
+  TAccountUserTransferAuthority extends string | AccountMeta<string> = string,
+  TAccountProtocol extends string | AccountMeta<string> = string,
+  TAccountVault extends string | AccountMeta<string> = string,
+  TAccountVaultLpMint extends string | AccountMeta<string> = string,
+  TAccountUserLpAta extends string | AccountMeta<string> = string,
+  TAccountRequestWithdrawLpAta extends string | AccountMeta<string> = string,
+  TAccountRequestWithdrawVaultReceipt extends string | AccountMeta<string> =
+    string,
+  TAccountLpTokenProgram extends string | AccountMeta<string> =
+    "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA",
+  TAccountSystemProgram extends string | AccountMeta<string> =
+    "11111111111111111111111111111111",
+  TRemainingAccounts extends readonly AccountMeta<string>[] = [],
+> = Instruction<TProgram> &
+  InstructionWithData<ReadonlyUint8Array> &
+  InstructionWithAccounts<
+    [
+      TAccountUserTransferAuthority extends string
+        ? WritableSignerAccount<TAccountUserTransferAuthority> &
+            AccountSignerMeta<TAccountUserTransferAuthority>
+        : TAccountUserTransferAuthority,
+      TAccountProtocol extends string
+        ? ReadonlyAccount<TAccountProtocol>
+        : TAccountProtocol,
+      TAccountVault extends string
+        ? WritableAccount<TAccountVault>
+        : TAccountVault,
+      TAccountVaultLpMint extends string
+        ? WritableAccount<TAccountVaultLpMint>
+        : TAccountVaultLpMint,
+      TAccountUserLpAta extends string
+        ? WritableAccount<TAccountUserLpAta>
+        : TAccountUserLpAta,
+      TAccountRequestWithdrawLpAta extends string
+        ? WritableAccount<TAccountRequestWithdrawLpAta>
+        : TAccountRequestWithdrawLpAta,
+      TAccountRequestWithdrawVaultReceipt extends string
+        ? WritableAccount<TAccountRequestWithdrawVaultReceipt>
+        : TAccountRequestWithdrawVaultReceipt,
+      TAccountLpTokenProgram extends string
+        ? ReadonlyAccount<TAccountLpTokenProgram>
+        : TAccountLpTokenProgram,
+      TAccountSystemProgram extends string
+        ? ReadonlyAccount<TAccountSystemProgram>
+        : TAccountSystemProgram,
+      ...TRemainingAccounts,
+    ]
+  >;
+
+export type CancelRequestWithdrawVaultInstructionData = {
+  discriminator: ReadonlyUint8Array;
+};
+
+export type CancelRequestWithdrawVaultInstructionDataArgs = {};
+
+export function getCancelRequestWithdrawVaultInstructionDataEncoder(): FixedSizeEncoder<CancelRequestWithdrawVaultInstructionDataArgs> {
+  return transformEncoder(
+    getStructEncoder([["discriminator", fixEncoderSize(getBytesEncoder(), 8)]]),
+    (value) => ({
+      ...value,
+      discriminator: CANCEL_REQUEST_WITHDRAW_VAULT_DISCRIMINATOR,
+    }),
+  );
+}
+
+export function getCancelRequestWithdrawVaultInstructionDataDecoder(): FixedSizeDecoder<CancelRequestWithdrawVaultInstructionData> {
+  return getStructDecoder([
+    ["discriminator", fixDecoderSize(getBytesDecoder(), 8)],
+  ]);
+}
+
+export function getCancelRequestWithdrawVaultInstructionDataCodec(): FixedSizeCodec<
+  CancelRequestWithdrawVaultInstructionDataArgs,
+  CancelRequestWithdrawVaultInstructionData
+> {
+  return combineCodec(
+    getCancelRequestWithdrawVaultInstructionDataEncoder(),
+    getCancelRequestWithdrawVaultInstructionDataDecoder(),
+  );
+}
+
+export type CancelRequestWithdrawVaultAsyncInput<
+  TAccountUserTransferAuthority extends string = string,
+  TAccountProtocol extends string = string,
+  TAccountVault extends string = string,
+  TAccountVaultLpMint extends string = string,
+  TAccountUserLpAta extends string = string,
+  TAccountRequestWithdrawLpAta extends string = string,
+  TAccountRequestWithdrawVaultReceipt extends string = string,
+  TAccountLpTokenProgram extends string = string,
+  TAccountSystemProgram extends string = string,
+> = {
+  /** The authority that owns the LP tokens and wants to redeem them */
+  userTransferAuthority: TransactionSigner<TAccountUserTransferAuthority>;
+  protocol?: Address<TAccountProtocol>;
+  vault: Address<TAccountVault>;
+  vaultLpMint?: Address<TAccountVaultLpMint>;
+  /** The user's LP token account from which LP tokens will be burned. */
+  userLpAta?: Address<TAccountUserLpAta>;
+  /** The request's associated token account for LP. */
+  requestWithdrawLpAta?: Address<TAccountRequestWithdrawLpAta>;
+  requestWithdrawVaultReceipt?: Address<TAccountRequestWithdrawVaultReceipt>;
+  lpTokenProgram?: Address<TAccountLpTokenProgram>;
+  systemProgram?: Address<TAccountSystemProgram>;
+};
+
+export async function getCancelRequestWithdrawVaultInstructionAsync<
+  TAccountUserTransferAuthority extends string,
+  TAccountProtocol extends string,
+  TAccountVault extends string,
+  TAccountVaultLpMint extends string,
+  TAccountUserLpAta extends string,
+  TAccountRequestWithdrawLpAta extends string,
+  TAccountRequestWithdrawVaultReceipt extends string,
+  TAccountLpTokenProgram extends string,
+  TAccountSystemProgram extends string,
+  TProgramAddress extends Address = typeof VOLTR_VAULT_PROGRAM_ADDRESS,
+>(
+  input: CancelRequestWithdrawVaultAsyncInput<
+    TAccountUserTransferAuthority,
+    TAccountProtocol,
+    TAccountVault,
+    TAccountVaultLpMint,
+    TAccountUserLpAta,
+    TAccountRequestWithdrawLpAta,
+    TAccountRequestWithdrawVaultReceipt,
+    TAccountLpTokenProgram,
+    TAccountSystemProgram
+  >,
+  config?: { programAddress?: TProgramAddress },
+): Promise<
+  CancelRequestWithdrawVaultInstruction<
+    TProgramAddress,
+    TAccountUserTransferAuthority,
+    TAccountProtocol,
+    TAccountVault,
+    TAccountVaultLpMint,
+    TAccountUserLpAta,
+    TAccountRequestWithdrawLpAta,
+    TAccountRequestWithdrawVaultReceipt,
+    TAccountLpTokenProgram,
+    TAccountSystemProgram
+  >
+> {
+  // Program address.
+  const programAddress = config?.programAddress ?? VOLTR_VAULT_PROGRAM_ADDRESS;
+
+  // Original accounts.
+  const originalAccounts = {
+    userTransferAuthority: {
+      value: input.userTransferAuthority ?? null,
+      isWritable: true,
+    },
+    protocol: { value: input.protocol ?? null, isWritable: false },
+    vault: { value: input.vault ?? null, isWritable: true },
+    vaultLpMint: { value: input.vaultLpMint ?? null, isWritable: true },
+    userLpAta: { value: input.userLpAta ?? null, isWritable: true },
+    requestWithdrawLpAta: {
+      value: input.requestWithdrawLpAta ?? null,
+      isWritable: true,
+    },
+    requestWithdrawVaultReceipt: {
+      value: input.requestWithdrawVaultReceipt ?? null,
+      isWritable: true,
+    },
+    lpTokenProgram: { value: input.lpTokenProgram ?? null, isWritable: false },
+    systemProgram: { value: input.systemProgram ?? null, isWritable: false },
+  };
+  const accounts = originalAccounts as Record<
+    keyof typeof originalAccounts,
+    ResolvedInstructionAccount
+  >;
+
+  // Resolve default values.
+  if (!accounts.protocol.value) {
+    accounts.protocol.value = await findProtocolPda();
+  }
+  if (!accounts.vaultLpMint.value) {
+    accounts.vaultLpMint.value = await findVaultLpMintPda({
+      vault: getAddressFromResolvedInstructionAccount(
+        "vault",
+        accounts.vault.value,
+      ),
+    });
+  }
+  if (!accounts.lpTokenProgram.value) {
+    accounts.lpTokenProgram.value =
+      "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA" as Address<"TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA">;
+  }
+  if (!accounts.userLpAta.value) {
+    accounts.userLpAta.value = await getProgramDerivedAddress({
+      programAddress:
+        "ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL" as Address<"ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL">,
+      seeds: [
+        getAddressEncoder().encode(
+          getAddressFromResolvedInstructionAccount(
+            "userTransferAuthority",
+            accounts.userTransferAuthority.value,
+          ),
+        ),
+        getAddressEncoder().encode(
+          getAddressFromResolvedInstructionAccount(
+            "lpTokenProgram",
+            accounts.lpTokenProgram.value,
+          ),
+        ),
+        getAddressEncoder().encode(
+          getAddressFromResolvedInstructionAccount(
+            "vaultLpMint",
+            accounts.vaultLpMint.value,
+          ),
+        ),
+      ],
+    });
+  }
+  if (!accounts.requestWithdrawVaultReceipt.value) {
+    accounts.requestWithdrawVaultReceipt.value =
+      await findRequestWithdrawVaultReceiptPda({
+        vault: getAddressFromResolvedInstructionAccount(
+          "vault",
+          accounts.vault.value,
+        ),
+        userTransferAuthority: getAddressFromResolvedInstructionAccount(
+          "userTransferAuthority",
+          accounts.userTransferAuthority.value,
+        ),
+      });
+  }
+  if (!accounts.requestWithdrawLpAta.value) {
+    accounts.requestWithdrawLpAta.value = await getProgramDerivedAddress({
+      programAddress:
+        "ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL" as Address<"ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL">,
+      seeds: [
+        getAddressEncoder().encode(
+          getAddressFromResolvedInstructionAccount(
+            "requestWithdrawVaultReceipt",
+            accounts.requestWithdrawVaultReceipt.value,
+          ),
+        ),
+        getAddressEncoder().encode(
+          getAddressFromResolvedInstructionAccount(
+            "lpTokenProgram",
+            accounts.lpTokenProgram.value,
+          ),
+        ),
+        getAddressEncoder().encode(
+          getAddressFromResolvedInstructionAccount(
+            "vaultLpMint",
+            accounts.vaultLpMint.value,
+          ),
+        ),
+      ],
+    });
+  }
+  if (!accounts.systemProgram.value) {
+    accounts.systemProgram.value =
+      "11111111111111111111111111111111" as Address<"11111111111111111111111111111111">;
+  }
+
+  const getAccountMeta = getAccountMetaFactory(programAddress, "programId");
+  return Object.freeze({
+    accounts: [
+      getAccountMeta("userTransferAuthority", accounts.userTransferAuthority),
+      getAccountMeta("protocol", accounts.protocol),
+      getAccountMeta("vault", accounts.vault),
+      getAccountMeta("vaultLpMint", accounts.vaultLpMint),
+      getAccountMeta("userLpAta", accounts.userLpAta),
+      getAccountMeta("requestWithdrawLpAta", accounts.requestWithdrawLpAta),
+      getAccountMeta(
+        "requestWithdrawVaultReceipt",
+        accounts.requestWithdrawVaultReceipt,
+      ),
+      getAccountMeta("lpTokenProgram", accounts.lpTokenProgram),
+      getAccountMeta("systemProgram", accounts.systemProgram),
+    ],
+    data: getCancelRequestWithdrawVaultInstructionDataEncoder().encode({}),
+    programAddress,
+  } as CancelRequestWithdrawVaultInstruction<
+    TProgramAddress,
+    TAccountUserTransferAuthority,
+    TAccountProtocol,
+    TAccountVault,
+    TAccountVaultLpMint,
+    TAccountUserLpAta,
+    TAccountRequestWithdrawLpAta,
+    TAccountRequestWithdrawVaultReceipt,
+    TAccountLpTokenProgram,
+    TAccountSystemProgram
+  >);
+}
+
+export type CancelRequestWithdrawVaultInput<
+  TAccountUserTransferAuthority extends string = string,
+  TAccountProtocol extends string = string,
+  TAccountVault extends string = string,
+  TAccountVaultLpMint extends string = string,
+  TAccountUserLpAta extends string = string,
+  TAccountRequestWithdrawLpAta extends string = string,
+  TAccountRequestWithdrawVaultReceipt extends string = string,
+  TAccountLpTokenProgram extends string = string,
+  TAccountSystemProgram extends string = string,
+> = {
+  /** The authority that owns the LP tokens and wants to redeem them */
+  userTransferAuthority: TransactionSigner<TAccountUserTransferAuthority>;
+  protocol: Address<TAccountProtocol>;
+  vault: Address<TAccountVault>;
+  vaultLpMint: Address<TAccountVaultLpMint>;
+  /** The user's LP token account from which LP tokens will be burned. */
+  userLpAta: Address<TAccountUserLpAta>;
+  /** The request's associated token account for LP. */
+  requestWithdrawLpAta: Address<TAccountRequestWithdrawLpAta>;
+  requestWithdrawVaultReceipt: Address<TAccountRequestWithdrawVaultReceipt>;
+  lpTokenProgram?: Address<TAccountLpTokenProgram>;
+  systemProgram?: Address<TAccountSystemProgram>;
+};
+
+export function getCancelRequestWithdrawVaultInstruction<
+  TAccountUserTransferAuthority extends string,
+  TAccountProtocol extends string,
+  TAccountVault extends string,
+  TAccountVaultLpMint extends string,
+  TAccountUserLpAta extends string,
+  TAccountRequestWithdrawLpAta extends string,
+  TAccountRequestWithdrawVaultReceipt extends string,
+  TAccountLpTokenProgram extends string,
+  TAccountSystemProgram extends string,
+  TProgramAddress extends Address = typeof VOLTR_VAULT_PROGRAM_ADDRESS,
+>(
+  input: CancelRequestWithdrawVaultInput<
+    TAccountUserTransferAuthority,
+    TAccountProtocol,
+    TAccountVault,
+    TAccountVaultLpMint,
+    TAccountUserLpAta,
+    TAccountRequestWithdrawLpAta,
+    TAccountRequestWithdrawVaultReceipt,
+    TAccountLpTokenProgram,
+    TAccountSystemProgram
+  >,
+  config?: { programAddress?: TProgramAddress },
+): CancelRequestWithdrawVaultInstruction<
+  TProgramAddress,
+  TAccountUserTransferAuthority,
+  TAccountProtocol,
+  TAccountVault,
+  TAccountVaultLpMint,
+  TAccountUserLpAta,
+  TAccountRequestWithdrawLpAta,
+  TAccountRequestWithdrawVaultReceipt,
+  TAccountLpTokenProgram,
+  TAccountSystemProgram
+> {
+  // Program address.
+  const programAddress = config?.programAddress ?? VOLTR_VAULT_PROGRAM_ADDRESS;
+
+  // Original accounts.
+  const originalAccounts = {
+    userTransferAuthority: {
+      value: input.userTransferAuthority ?? null,
+      isWritable: true,
+    },
+    protocol: { value: input.protocol ?? null, isWritable: false },
+    vault: { value: input.vault ?? null, isWritable: true },
+    vaultLpMint: { value: input.vaultLpMint ?? null, isWritable: true },
+    userLpAta: { value: input.userLpAta ?? null, isWritable: true },
+    requestWithdrawLpAta: {
+      value: input.requestWithdrawLpAta ?? null,
+      isWritable: true,
+    },
+    requestWithdrawVaultReceipt: {
+      value: input.requestWithdrawVaultReceipt ?? null,
+      isWritable: true,
+    },
+    lpTokenProgram: { value: input.lpTokenProgram ?? null, isWritable: false },
+    systemProgram: { value: input.systemProgram ?? null, isWritable: false },
+  };
+  const accounts = originalAccounts as Record<
+    keyof typeof originalAccounts,
+    ResolvedInstructionAccount
+  >;
+
+  // Resolve default values.
+  if (!accounts.lpTokenProgram.value) {
+    accounts.lpTokenProgram.value =
+      "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA" as Address<"TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA">;
+  }
+  if (!accounts.systemProgram.value) {
+    accounts.systemProgram.value =
+      "11111111111111111111111111111111" as Address<"11111111111111111111111111111111">;
+  }
+
+  const getAccountMeta = getAccountMetaFactory(programAddress, "programId");
+  return Object.freeze({
+    accounts: [
+      getAccountMeta("userTransferAuthority", accounts.userTransferAuthority),
+      getAccountMeta("protocol", accounts.protocol),
+      getAccountMeta("vault", accounts.vault),
+      getAccountMeta("vaultLpMint", accounts.vaultLpMint),
+      getAccountMeta("userLpAta", accounts.userLpAta),
+      getAccountMeta("requestWithdrawLpAta", accounts.requestWithdrawLpAta),
+      getAccountMeta(
+        "requestWithdrawVaultReceipt",
+        accounts.requestWithdrawVaultReceipt,
+      ),
+      getAccountMeta("lpTokenProgram", accounts.lpTokenProgram),
+      getAccountMeta("systemProgram", accounts.systemProgram),
+    ],
+    data: getCancelRequestWithdrawVaultInstructionDataEncoder().encode({}),
+    programAddress,
+  } as CancelRequestWithdrawVaultInstruction<
+    TProgramAddress,
+    TAccountUserTransferAuthority,
+    TAccountProtocol,
+    TAccountVault,
+    TAccountVaultLpMint,
+    TAccountUserLpAta,
+    TAccountRequestWithdrawLpAta,
+    TAccountRequestWithdrawVaultReceipt,
+    TAccountLpTokenProgram,
+    TAccountSystemProgram
+  >);
+}
+
+export type ParsedCancelRequestWithdrawVaultInstruction<
+  TProgram extends string = typeof VOLTR_VAULT_PROGRAM_ADDRESS,
+  TAccountMetas extends readonly AccountMeta[] = readonly AccountMeta[],
+> = {
+  programAddress: Address<TProgram>;
+  accounts: {
+    /** The authority that owns the LP tokens and wants to redeem them */
+    userTransferAuthority: TAccountMetas[0];
+    protocol: TAccountMetas[1];
+    vault: TAccountMetas[2];
+    vaultLpMint: TAccountMetas[3];
+    /** The user's LP token account from which LP tokens will be burned. */
+    userLpAta: TAccountMetas[4];
+    /** The request's associated token account for LP. */
+    requestWithdrawLpAta: TAccountMetas[5];
+    requestWithdrawVaultReceipt: TAccountMetas[6];
+    lpTokenProgram: TAccountMetas[7];
+    systemProgram: TAccountMetas[8];
+  };
+  data: CancelRequestWithdrawVaultInstructionData;
+};
+
+export function parseCancelRequestWithdrawVaultInstruction<
+  TProgram extends string,
+  TAccountMetas extends readonly AccountMeta[],
+>(
+  instruction: Instruction<TProgram> &
+    InstructionWithAccounts<TAccountMetas> &
+    InstructionWithData<ReadonlyUint8Array>,
+): ParsedCancelRequestWithdrawVaultInstruction<TProgram, TAccountMetas> {
+  if (instruction.accounts.length < 9) {
+    throw new SolanaError(
+      SOLANA_ERROR__PROGRAM_CLIENTS__INSUFFICIENT_ACCOUNT_METAS,
+      {
+        actualAccountMetas: instruction.accounts.length,
+        expectedAccountMetas: 9,
+      },
+    );
+  }
+  let accountIndex = 0;
+  const getNextAccount = () => {
+    const accountMeta = (instruction.accounts as TAccountMetas)[accountIndex]!;
+    accountIndex += 1;
+    return accountMeta;
+  };
+  return {
+    programAddress: instruction.programAddress,
+    accounts: {
+      userTransferAuthority: getNextAccount(),
+      protocol: getNextAccount(),
+      vault: getNextAccount(),
+      vaultLpMint: getNextAccount(),
+      userLpAta: getNextAccount(),
+      requestWithdrawLpAta: getNextAccount(),
+      requestWithdrawVaultReceipt: getNextAccount(),
+      lpTokenProgram: getNextAccount(),
+      systemProgram: getNextAccount(),
+    },
+    data: getCancelRequestWithdrawVaultInstructionDataDecoder().decode(
+      instruction.data,
+    ),
+  };
+}