@kamino-finance/farms-sdk/src/@codegen/farms/instructions/withdrawReward.ts

Farms SDK

/**
 * 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 { FARMS_PROGRAM_ADDRESS } from "../programs";
import { getAccountMetaFactory, type ResolvedAccount } from "../shared";

export const WITHDRAW_REWARD_DISCRIMINATOR = new Uint8Array([
  191, 187, 176, 137, 9, 25, 187, 244,
]);

export function getWithdrawRewardDiscriminatorBytes() {
  return fixEncoderSize(getBytesEncoder(), 8).encode(
    WITHDRAW_REWARD_DISCRIMINATOR,
  );
}

export type WithdrawRewardInstruction<
  TProgram extends string = typeof FARMS_PROGRAM_ADDRESS,
  TAccountFarmAdmin extends string | AccountMeta<string> = string,
  TAccountFarmState extends string | AccountMeta<string> = string,
  TAccountRewardMint extends string | AccountMeta<string> = string,
  TAccountRewardVault extends string | AccountMeta<string> = string,
  TAccountFarmVaultsAuthority extends string | AccountMeta<string> = string,
  TAccountAdminRewardTokenAta extends string | AccountMeta<string> = string,
  TAccountScopePrices extends string | AccountMeta<string> = string,
  TAccountTokenProgram extends string | AccountMeta<string> =
    "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA",
  TRemainingAccounts extends readonly AccountMeta<string>[] = [],
> = Instruction<TProgram> &
  InstructionWithData<ReadonlyUint8Array> &
  InstructionWithAccounts<
    [
      TAccountFarmAdmin extends string
        ? WritableSignerAccount<TAccountFarmAdmin> &
            AccountSignerMeta<TAccountFarmAdmin>
        : TAccountFarmAdmin,
      TAccountFarmState extends string
        ? WritableAccount<TAccountFarmState>
        : TAccountFarmState,
      TAccountRewardMint extends string
        ? ReadonlyAccount<TAccountRewardMint>
        : TAccountRewardMint,
      TAccountRewardVault extends string
        ? WritableAccount<TAccountRewardVault>
        : TAccountRewardVault,
      TAccountFarmVaultsAuthority extends string
        ? ReadonlyAccount<TAccountFarmVaultsAuthority>
        : TAccountFarmVaultsAuthority,
      TAccountAdminRewardTokenAta extends string
        ? WritableAccount<TAccountAdminRewardTokenAta>
        : TAccountAdminRewardTokenAta,
      TAccountScopePrices extends string
        ? ReadonlyAccount<TAccountScopePrices>
        : TAccountScopePrices,
      TAccountTokenProgram extends string
        ? ReadonlyAccount<TAccountTokenProgram>
        : TAccountTokenProgram,
      ...TRemainingAccounts,
    ]
  >;

export type WithdrawRewardInstructionData = {
  discriminator: ReadonlyUint8Array;
  amount: bigint;
  rewardIndex: bigint;
};

export type WithdrawRewardInstructionDataArgs = {
  amount: number | bigint;
  rewardIndex: number | bigint;
};

export function getWithdrawRewardInstructionDataEncoder(): FixedSizeEncoder<WithdrawRewardInstructionDataArgs> {
  return transformEncoder(
    getStructEncoder([
      ["discriminator", fixEncoderSize(getBytesEncoder(), 8)],
      ["amount", getU64Encoder()],
      ["rewardIndex", getU64Encoder()],
    ]),
    (value) => ({ ...value, discriminator: WITHDRAW_REWARD_DISCRIMINATOR }),
  );
}

export function getWithdrawRewardInstructionDataDecoder(): FixedSizeDecoder<WithdrawRewardInstructionData> {
  return getStructDecoder([
    ["discriminator", fixDecoderSize(getBytesDecoder(), 8)],
    ["amount", getU64Decoder()],
    ["rewardIndex", getU64Decoder()],
  ]);
}

export function getWithdrawRewardInstructionDataCodec(): FixedSizeCodec<
  WithdrawRewardInstructionDataArgs,
  WithdrawRewardInstructionData
> {
  return combineCodec(
    getWithdrawRewardInstructionDataEncoder(),
    getWithdrawRewardInstructionDataDecoder(),
  );
}

export type WithdrawRewardInput<
  TAccountFarmAdmin extends string = string,
  TAccountFarmState extends string = string,
  TAccountRewardMint extends string = string,
  TAccountRewardVault extends string = string,
  TAccountFarmVaultsAuthority extends string = string,
  TAccountAdminRewardTokenAta extends string = string,
  TAccountScopePrices extends string = string,
  TAccountTokenProgram extends string = string,
> = {
  farmAdmin: TransactionSigner<TAccountFarmAdmin>;
  farmState: Address<TAccountFarmState>;
  rewardMint: Address<TAccountRewardMint>;
  rewardVault: Address<TAccountRewardVault>;
  farmVaultsAuthority: Address<TAccountFarmVaultsAuthority>;
  adminRewardTokenAta: Address<TAccountAdminRewardTokenAta>;
  scopePrices?: Address<TAccountScopePrices>;
  tokenProgram?: Address<TAccountTokenProgram>;
  amount: WithdrawRewardInstructionDataArgs["amount"];
  rewardIndex: WithdrawRewardInstructionDataArgs["rewardIndex"];
};

export function getWithdrawRewardInstruction<
  TAccountFarmAdmin extends string,
  TAccountFarmState extends string,
  TAccountRewardMint extends string,
  TAccountRewardVault extends string,
  TAccountFarmVaultsAuthority extends string,
  TAccountAdminRewardTokenAta extends string,
  TAccountScopePrices extends string,
  TAccountTokenProgram extends string,
  TProgramAddress extends Address = typeof FARMS_PROGRAM_ADDRESS,
>(
  input: WithdrawRewardInput<
    TAccountFarmAdmin,
    TAccountFarmState,
    TAccountRewardMint,
    TAccountRewardVault,
    TAccountFarmVaultsAuthority,
    TAccountAdminRewardTokenAta,
    TAccountScopePrices,
    TAccountTokenProgram
  >,
  config?: { programAddress?: TProgramAddress },
): WithdrawRewardInstruction<
  TProgramAddress,
  TAccountFarmAdmin,
  TAccountFarmState,
  TAccountRewardMint,
  TAccountRewardVault,
  TAccountFarmVaultsAuthority,
  TAccountAdminRewardTokenAta,
  TAccountScopePrices,
  TAccountTokenProgram
> {
  // Program address.
  const programAddress = config?.programAddress ?? FARMS_PROGRAM_ADDRESS;

  // Original accounts.
  const originalAccounts = {
    farmAdmin: { value: input.farmAdmin ?? null, isWritable: true },
    farmState: { value: input.farmState ?? null, isWritable: true },
    rewardMint: { value: input.rewardMint ?? null, isWritable: false },
    rewardVault: { value: input.rewardVault ?? null, isWritable: true },
    farmVaultsAuthority: {
      value: input.farmVaultsAuthority ?? null,
      isWritable: false,
    },
    adminRewardTokenAta: {
      value: input.adminRewardTokenAta ?? null,
      isWritable: true,
    },
    scopePrices: { value: input.scopePrices ?? null, isWritable: false },
    tokenProgram: { value: input.tokenProgram ?? 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">;
  }

  const getAccountMeta = getAccountMetaFactory(programAddress, "programId");
  return Object.freeze({
    accounts: [
      getAccountMeta(accounts.farmAdmin),
      getAccountMeta(accounts.farmState),
      getAccountMeta(accounts.rewardMint),
      getAccountMeta(accounts.rewardVault),
      getAccountMeta(accounts.farmVaultsAuthority),
      getAccountMeta(accounts.adminRewardTokenAta),
      getAccountMeta(accounts.scopePrices),
      getAccountMeta(accounts.tokenProgram),
    ],
    data: getWithdrawRewardInstructionDataEncoder().encode(
      args as WithdrawRewardInstructionDataArgs,
    ),
    programAddress,
  } as WithdrawRewardInstruction<
    TProgramAddress,
    TAccountFarmAdmin,
    TAccountFarmState,
    TAccountRewardMint,
    TAccountRewardVault,
    TAccountFarmVaultsAuthority,
    TAccountAdminRewardTokenAta,
    TAccountScopePrices,
    TAccountTokenProgram
  >);
}

export type ParsedWithdrawRewardInstruction<
  TProgram extends string = typeof FARMS_PROGRAM_ADDRESS,
  TAccountMetas extends readonly AccountMeta[] = readonly AccountMeta[],
> = {
  programAddress: Address<TProgram>;
  accounts: {
    farmAdmin: TAccountMetas[0];
    farmState: TAccountMetas[1];
    rewardMint: TAccountMetas[2];
    rewardVault: TAccountMetas[3];
    farmVaultsAuthority: TAccountMetas[4];
    adminRewardTokenAta: TAccountMetas[5];
    scopePrices?: TAccountMetas[6] | undefined;
    tokenProgram: TAccountMetas[7];
  };
  data: WithdrawRewardInstructionData;
};

export function parseWithdrawRewardInstruction<
  TProgram extends string,
  TAccountMetas extends readonly AccountMeta[],
>(
  instruction: Instruction<TProgram> &
    InstructionWithAccounts<TAccountMetas> &
    InstructionWithData<ReadonlyUint8Array>,
): ParsedWithdrawRewardInstruction<TProgram, TAccountMetas> {
  if (instruction.accounts.length < 8) {
    // 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 === FARMS_PROGRAM_ADDRESS
      ? undefined
      : accountMeta;
  };
  return {
    programAddress: instruction.programAddress,
    accounts: {
      farmAdmin: getNextAccount(),
      farmState: getNextAccount(),
      rewardMint: getNextAccount(),
      rewardVault: getNextAccount(),
      farmVaultsAuthority: getNextAccount(),
      adminRewardTokenAta: getNextAccount(),
      scopePrices: getNextOptionalAccount(),
      tokenProgram: getNextAccount(),
    },
    data: getWithdrawRewardInstructionDataDecoder().decode(instruction.data),
  };
}