@shogun-sdk/intents-sdk 1.0.2 → 1.1.1

package/src/core/solana/generated/single-chain/instructions/fulfillDcaOrderInterval.ts

@@ -0,0 +1,538 @@
+/**
+ * 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 { type Address } from '@solana/kit';
+import {
+  combineCodec,
+  fixDecoderSize,
+  fixEncoderSize,
+  getBytesDecoder,
+  getBytesEncoder,
+  getStructDecoder,
+  getStructEncoder,
+  getU64Decoder,
+  getU64Encoder,
+  transformEncoder,
+  type Codec,
+  type Decoder,
+  type Encoder,
+  type ReadonlyUint8Array,
+} from '@solana/kit';
+import {
+  type IAccountMeta,
+  type IInstruction,
+  type IInstructionWithAccounts,
+  type IInstructionWithData,
+  type ReadonlyAccount,
+  type WritableAccount,
+  type WritableSignerAccount,
+} from '@solana/kit';
+import { type IAccountSignerMeta, type TransactionSigner } from '@solana/kit';
+import { SINGLE_CHAIN_GUARD_PROGRAM_ADDRESS } from '../programs/index.js';
+import { getAccountMetaFactory, type ResolvedAccount } from '../shared/index.js';
+
+export const FULFILL_DCA_ORDER_INTERVAL_DISCRIMINATOR = new Uint8Array([15, 118, 183, 60, 46, 43, 243, 244]);
+
+export function getFulfillDcaOrderIntervalDiscriminatorBytes() {
+  return fixEncoderSize(getBytesEncoder(), 8).encode(FULFILL_DCA_ORDER_INTERVAL_DISCRIMINATOR);
+}
+
+export type FulfillDcaOrderIntervalInstruction<
+  TProgram extends string = typeof SINGLE_CHAIN_GUARD_PROGRAM_ADDRESS,
+  TAccountSolver extends string | IAccountMeta<string> = string,
+  TAccountOrder extends string | IAccountMeta<string> = string,
+  TAccountUser extends string | IAccountMeta<string> = string,
+  TAccountGuard extends string | IAccountMeta<string> = string,
+  TAccountIxSysvar extends string | IAccountMeta<string> = 'Sysvar1nstructions1111111111111111111111111',
+  TAccountTokenInMint extends string | IAccountMeta<string> = string,
+  TAccountSolverTokenInAccount extends string | IAccountMeta<string> = string,
+  TAccountGuardTokenInAccount extends string | IAccountMeta<string> = string,
+  TAccountTokenInProgram extends string | IAccountMeta<string> = string,
+  TAccountFeeTokenMint extends string | IAccountMeta<string> = string,
+  TAccountSolverFeeTokenAccount extends string | IAccountMeta<string> = string,
+  TAccountGuardFeeTokenAccount extends string | IAccountMeta<string> = string,
+  TAccountFeeTokenProgram extends string | IAccountMeta<string> = string,
+  TAccountNativeTokenOutReceiver extends string | IAccountMeta<string> = string,
+  TAccountSystemProgram extends string | IAccountMeta<string> = '11111111111111111111111111111111',
+  TAccountTokenOutMint extends string | IAccountMeta<string> = string,
+  TAccountSolverTokenOutAccount extends string | IAccountMeta<string> = string,
+  TAccountDestinationTokenOutAccount extends string | IAccountMeta<string> = string,
+  TAccountTokenOutProgram extends string | IAccountMeta<string> = string,
+  TRemainingAccounts extends readonly IAccountMeta<string>[] = [],
+> = IInstruction<TProgram> &
+  IInstructionWithData<Uint8Array> &
+  IInstructionWithAccounts<
+    [
+      TAccountSolver extends string
+        ? WritableSignerAccount<TAccountSolver> & IAccountSignerMeta<TAccountSolver>
+        : TAccountSolver,
+      TAccountOrder extends string ? WritableAccount<TAccountOrder> : TAccountOrder,
+      TAccountUser extends string ? WritableAccount<TAccountUser> : TAccountUser,
+      TAccountGuard extends string ? WritableAccount<TAccountGuard> : TAccountGuard,
+      TAccountIxSysvar extends string ? ReadonlyAccount<TAccountIxSysvar> : TAccountIxSysvar,
+      TAccountTokenInMint extends string ? ReadonlyAccount<TAccountTokenInMint> : TAccountTokenInMint,
+      TAccountSolverTokenInAccount extends string
+        ? WritableAccount<TAccountSolverTokenInAccount>
+        : TAccountSolverTokenInAccount,
+      TAccountGuardTokenInAccount extends string
+        ? WritableAccount<TAccountGuardTokenInAccount>
+        : TAccountGuardTokenInAccount,
+      TAccountTokenInProgram extends string ? ReadonlyAccount<TAccountTokenInProgram> : TAccountTokenInProgram,
+      TAccountFeeTokenMint extends string ? ReadonlyAccount<TAccountFeeTokenMint> : TAccountFeeTokenMint,
+      TAccountSolverFeeTokenAccount extends string
+        ? WritableAccount<TAccountSolverFeeTokenAccount>
+        : TAccountSolverFeeTokenAccount,
+      TAccountGuardFeeTokenAccount extends string
+        ? WritableAccount<TAccountGuardFeeTokenAccount>
+        : TAccountGuardFeeTokenAccount,
+      TAccountFeeTokenProgram extends string ? ReadonlyAccount<TAccountFeeTokenProgram> : TAccountFeeTokenProgram,
+      TAccountNativeTokenOutReceiver extends string
+        ? ReadonlyAccount<TAccountNativeTokenOutReceiver>
+        : TAccountNativeTokenOutReceiver,
+      TAccountSystemProgram extends string ? ReadonlyAccount<TAccountSystemProgram> : TAccountSystemProgram,
+      TAccountTokenOutMint extends string ? ReadonlyAccount<TAccountTokenOutMint> : TAccountTokenOutMint,
+      TAccountSolverTokenOutAccount extends string
+        ? WritableAccount<TAccountSolverTokenOutAccount>
+        : TAccountSolverTokenOutAccount,
+      TAccountDestinationTokenOutAccount extends string
+        ? WritableAccount<TAccountDestinationTokenOutAccount>
+        : TAccountDestinationTokenOutAccount,
+      TAccountTokenOutProgram extends string ? ReadonlyAccount<TAccountTokenOutProgram> : TAccountTokenOutProgram,
+      ...TRemainingAccounts,
+    ]
+  >;
+
+export type FulfillDcaOrderIntervalInstructionData = {
+  discriminator: ReadonlyUint8Array;
+  promisedMainAmountOut: bigint;
+  mainAmountOutToTransfer: bigint;
+};
+
+export type FulfillDcaOrderIntervalInstructionDataArgs = {
+  promisedMainAmountOut: number | bigint;
+  mainAmountOutToTransfer: number | bigint;
+};
+
+export function getFulfillDcaOrderIntervalInstructionDataEncoder(): Encoder<FulfillDcaOrderIntervalInstructionDataArgs> {
+  return transformEncoder(
+    getStructEncoder([
+      ['discriminator', fixEncoderSize(getBytesEncoder(), 8)],
+      ['promisedMainAmountOut', getU64Encoder()],
+      ['mainAmountOutToTransfer', getU64Encoder()],
+    ]),
+    (value) => ({
+      ...value,
+      discriminator: FULFILL_DCA_ORDER_INTERVAL_DISCRIMINATOR,
+    }),
+  );
+}
+
+export function getFulfillDcaOrderIntervalInstructionDataDecoder(): Decoder<FulfillDcaOrderIntervalInstructionData> {
+  return getStructDecoder([
+    ['discriminator', fixDecoderSize(getBytesDecoder(), 8)],
+    ['promisedMainAmountOut', getU64Decoder()],
+    ['mainAmountOutToTransfer', getU64Decoder()],
+  ]);
+}
+
+export function getFulfillDcaOrderIntervalInstructionDataCodec(): Codec<
+  FulfillDcaOrderIntervalInstructionDataArgs,
+  FulfillDcaOrderIntervalInstructionData
+> {
+  return combineCodec(
+    getFulfillDcaOrderIntervalInstructionDataEncoder(),
+    getFulfillDcaOrderIntervalInstructionDataDecoder(),
+  );
+}
+
+export type FulfillDcaOrderIntervalInput<
+  TAccountSolver extends string = string,
+  TAccountOrder extends string = string,
+  TAccountUser extends string = string,
+  TAccountGuard extends string = string,
+  TAccountIxSysvar extends string = string,
+  TAccountTokenInMint extends string = string,
+  TAccountSolverTokenInAccount extends string = string,
+  TAccountGuardTokenInAccount extends string = string,
+  TAccountTokenInProgram extends string = string,
+  TAccountFeeTokenMint extends string = string,
+  TAccountSolverFeeTokenAccount extends string = string,
+  TAccountGuardFeeTokenAccount extends string = string,
+  TAccountFeeTokenProgram extends string = string,
+  TAccountNativeTokenOutReceiver extends string = string,
+  TAccountSystemProgram extends string = string,
+  TAccountTokenOutMint extends string = string,
+  TAccountSolverTokenOutAccount extends string = string,
+  TAccountDestinationTokenOutAccount extends string = string,
+  TAccountTokenOutProgram extends string = string,
+> = {
+  /** Solver that fulfills the order */
+  solver: TransactionSigner<TAccountSolver>;
+  /** DCA order data */
+  order: Address<TAccountOrder>;
+  /** User account that will receive lamports after closing Order account */
+  user: Address<TAccountUser>;
+  /** Guard address, that protects this DCA order execution */
+  guard: Address<TAccountGuard>;
+  /**
+   * the supplied Sysvar could be anything else.
+   * The Instruction Sysvar has not been implemented
+   * in the Anchor framework yet, so this is the safe approach.
+   */
+  ixSysvar?: Address<TAccountIxSysvar>;
+  /** Token IN mint */
+  tokenInMint: Address<TAccountTokenInMint>;
+  /** Solver token IN account, to which solver will receive tokens IN */
+  solverTokenInAccount: Address<TAccountSolverTokenInAccount>;
+  /** Guard token IN account, where tokens IN are locked */
+  guardTokenInAccount: Address<TAccountGuardTokenInAccount>;
+  /** Solana token program */
+  tokenInProgram: Address<TAccountTokenInProgram>;
+  /** Fee token mint */
+  feeTokenMint: Address<TAccountFeeTokenMint>;
+  /** Solver fee token account, from which solver is paying fees */
+  solverFeeTokenAccount: Address<TAccountSolverFeeTokenAccount>;
+  /** Guard fee token account, where Guard is collecting fees */
+  guardFeeTokenAccount: Address<TAccountGuardFeeTokenAccount>;
+  /** Solana token program */
+  feeTokenProgram: Address<TAccountFeeTokenProgram>;
+  /**
+   * If token OUT is native - receiver account is required
+   * Pubkey is checked against `secret_hash`
+   */
+  nativeTokenOutReceiver?: Address<TAccountNativeTokenOutReceiver>;
+  /** Solana System program. Must be Some if token OUT or any of extra transfers tokens is native */
+  systemProgram?: Address<TAccountSystemProgram>;
+  /**
+   * Token OUT mint
+   * None if token OUT is native
+   */
+  tokenOutMint?: Address<TAccountTokenOutMint>;
+  /**
+   * Solver token OUT account, from which solver will send tokens OUT
+   * None if token OUT is native
+   */
+  solverTokenOutAccount?: Address<TAccountSolverTokenOutAccount>;
+  /**
+   * Destination token OUT account, to which tokens OUT will be sent
+   * Authority is checked against `secret_hash`
+   * None if token OUT is native
+   */
+  destinationTokenOutAccount?: Address<TAccountDestinationTokenOutAccount>;
+  /**
+   * Solana token program
+   * None if token OUT is native
+   */
+  tokenOutProgram?: Address<TAccountTokenOutProgram>;
+  promisedMainAmountOut: FulfillDcaOrderIntervalInstructionDataArgs['promisedMainAmountOut'];
+  mainAmountOutToTransfer: FulfillDcaOrderIntervalInstructionDataArgs['mainAmountOutToTransfer'];
+};
+
+export function getFulfillDcaOrderIntervalInstruction<
+  TAccountSolver extends string,
+  TAccountOrder extends string,
+  TAccountUser extends string,
+  TAccountGuard extends string,
+  TAccountIxSysvar extends string,
+  TAccountTokenInMint extends string,
+  TAccountSolverTokenInAccount extends string,
+  TAccountGuardTokenInAccount extends string,
+  TAccountTokenInProgram extends string,
+  TAccountFeeTokenMint extends string,
+  TAccountSolverFeeTokenAccount extends string,
+  TAccountGuardFeeTokenAccount extends string,
+  TAccountFeeTokenProgram extends string,
+  TAccountNativeTokenOutReceiver extends string,
+  TAccountSystemProgram extends string,
+  TAccountTokenOutMint extends string,
+  TAccountSolverTokenOutAccount extends string,
+  TAccountDestinationTokenOutAccount extends string,
+  TAccountTokenOutProgram extends string,
+  TProgramAddress extends Address = typeof SINGLE_CHAIN_GUARD_PROGRAM_ADDRESS,
+>(
+  input: FulfillDcaOrderIntervalInput<
+    TAccountSolver,
+    TAccountOrder,
+    TAccountUser,
+    TAccountGuard,
+    TAccountIxSysvar,
+    TAccountTokenInMint,
+    TAccountSolverTokenInAccount,
+    TAccountGuardTokenInAccount,
+    TAccountTokenInProgram,
+    TAccountFeeTokenMint,
+    TAccountSolverFeeTokenAccount,
+    TAccountGuardFeeTokenAccount,
+    TAccountFeeTokenProgram,
+    TAccountNativeTokenOutReceiver,
+    TAccountSystemProgram,
+    TAccountTokenOutMint,
+    TAccountSolverTokenOutAccount,
+    TAccountDestinationTokenOutAccount,
+    TAccountTokenOutProgram
+  >,
+  config?: { programAddress?: TProgramAddress },
+): FulfillDcaOrderIntervalInstruction<
+  TProgramAddress,
+  TAccountSolver,
+  TAccountOrder,
+  TAccountUser,
+  TAccountGuard,
+  TAccountIxSysvar,
+  TAccountTokenInMint,
+  TAccountSolverTokenInAccount,
+  TAccountGuardTokenInAccount,
+  TAccountTokenInProgram,
+  TAccountFeeTokenMint,
+  TAccountSolverFeeTokenAccount,
+  TAccountGuardFeeTokenAccount,
+  TAccountFeeTokenProgram,
+  TAccountNativeTokenOutReceiver,
+  TAccountSystemProgram,
+  TAccountTokenOutMint,
+  TAccountSolverTokenOutAccount,
+  TAccountDestinationTokenOutAccount,
+  TAccountTokenOutProgram
+> {
+  // Program address.
+  const programAddress = config?.programAddress ?? SINGLE_CHAIN_GUARD_PROGRAM_ADDRESS;
+
+  // Original accounts.
+  const originalAccounts = {
+    solver: { value: input.solver ?? null, isWritable: true },
+    order: { value: input.order ?? null, isWritable: true },
+    user: { value: input.user ?? null, isWritable: true },
+    guard: { value: input.guard ?? null, isWritable: true },
+    ixSysvar: { value: input.ixSysvar ?? null, isWritable: false },
+    tokenInMint: { value: input.tokenInMint ?? null, isWritable: false },
+    solverTokenInAccount: {
+      value: input.solverTokenInAccount ?? null,
+      isWritable: true,
+    },
+    guardTokenInAccount: {
+      value: input.guardTokenInAccount ?? null,
+      isWritable: true,
+    },
+    tokenInProgram: { value: input.tokenInProgram ?? null, isWritable: false },
+    feeTokenMint: { value: input.feeTokenMint ?? null, isWritable: false },
+    solverFeeTokenAccount: {
+      value: input.solverFeeTokenAccount ?? null,
+      isWritable: true,
+    },
+    guardFeeTokenAccount: {
+      value: input.guardFeeTokenAccount ?? null,
+      isWritable: true,
+    },
+    feeTokenProgram: {
+      value: input.feeTokenProgram ?? null,
+      isWritable: false,
+    },
+    nativeTokenOutReceiver: {
+      value: input.nativeTokenOutReceiver ?? null,
+      isWritable: false,
+    },
+    systemProgram: { value: input.systemProgram ?? null, isWritable: false },
+    tokenOutMint: { value: input.tokenOutMint ?? null, isWritable: false },
+    solverTokenOutAccount: {
+      value: input.solverTokenOutAccount ?? null,
+      isWritable: true,
+    },
+    destinationTokenOutAccount: {
+      value: input.destinationTokenOutAccount ?? null,
+      isWritable: true,
+    },
+    tokenOutProgram: {
+      value: input.tokenOutProgram ?? null,
+      isWritable: false,
+    },
+  };
+  const accounts = originalAccounts as Record<keyof typeof originalAccounts, ResolvedAccount>;
+
+  // Original args.
+  const args = { ...input };
+
+  // Resolve default values.
+  if (!accounts.ixSysvar.value) {
+    accounts.ixSysvar.value =
+      'Sysvar1nstructions1111111111111111111111111' as Address<'Sysvar1nstructions1111111111111111111111111'>;
+  }
+  if (!accounts.systemProgram.value) {
+    accounts.systemProgram.value = '11111111111111111111111111111111' as Address<'11111111111111111111111111111111'>;
+  }
+
+  const getAccountMeta = getAccountMetaFactory(programAddress, 'programId');
+  const instruction = {
+    accounts: [
+      getAccountMeta(accounts.solver),
+      getAccountMeta(accounts.order),
+      getAccountMeta(accounts.user),
+      getAccountMeta(accounts.guard),
+      getAccountMeta(accounts.ixSysvar),
+      getAccountMeta(accounts.tokenInMint),
+      getAccountMeta(accounts.solverTokenInAccount),
+      getAccountMeta(accounts.guardTokenInAccount),
+      getAccountMeta(accounts.tokenInProgram),
+      getAccountMeta(accounts.feeTokenMint),
+      getAccountMeta(accounts.solverFeeTokenAccount),
+      getAccountMeta(accounts.guardFeeTokenAccount),
+      getAccountMeta(accounts.feeTokenProgram),
+      getAccountMeta(accounts.nativeTokenOutReceiver),
+      getAccountMeta(accounts.systemProgram),
+      getAccountMeta(accounts.tokenOutMint),
+      getAccountMeta(accounts.solverTokenOutAccount),
+      getAccountMeta(accounts.destinationTokenOutAccount),
+      getAccountMeta(accounts.tokenOutProgram),
+    ],
+    programAddress,
+    data: getFulfillDcaOrderIntervalInstructionDataEncoder().encode(args as FulfillDcaOrderIntervalInstructionDataArgs),
+  } as FulfillDcaOrderIntervalInstruction<
+    TProgramAddress,
+    TAccountSolver,
+    TAccountOrder,
+    TAccountUser,
+    TAccountGuard,
+    TAccountIxSysvar,
+    TAccountTokenInMint,
+    TAccountSolverTokenInAccount,
+    TAccountGuardTokenInAccount,
+    TAccountTokenInProgram,
+    TAccountFeeTokenMint,
+    TAccountSolverFeeTokenAccount,
+    TAccountGuardFeeTokenAccount,
+    TAccountFeeTokenProgram,
+    TAccountNativeTokenOutReceiver,
+    TAccountSystemProgram,
+    TAccountTokenOutMint,
+    TAccountSolverTokenOutAccount,
+    TAccountDestinationTokenOutAccount,
+    TAccountTokenOutProgram
+  >;
+
+  return instruction;
+}
+
+export type ParsedFulfillDcaOrderIntervalInstruction<
+  TProgram extends string = typeof SINGLE_CHAIN_GUARD_PROGRAM_ADDRESS,
+  TAccountMetas extends readonly IAccountMeta[] = readonly IAccountMeta[],
+> = {
+  programAddress: Address<TProgram>;
+  accounts: {
+    /** Solver that fulfills the order */
+    solver: TAccountMetas[0];
+    /** DCA order data */
+    order: TAccountMetas[1];
+    /** User account that will receive lamports after closing Order account */
+    user: TAccountMetas[2];
+    /** Guard address, that protects this DCA order execution */
+    guard: TAccountMetas[3];
+    /**
+     * the supplied Sysvar could be anything else.
+     * The Instruction Sysvar has not been implemented
+     * in the Anchor framework yet, so this is the safe approach.
+     */
+
+    ixSysvar: TAccountMetas[4];
+    /** Token IN mint */
+    tokenInMint: TAccountMetas[5];
+    /** Solver token IN account, to which solver will receive tokens IN */
+    solverTokenInAccount: TAccountMetas[6];
+    /** Guard token IN account, where tokens IN are locked */
+    guardTokenInAccount: TAccountMetas[7];
+    /** Solana token program */
+    tokenInProgram: TAccountMetas[8];
+    /** Fee token mint */
+    feeTokenMint: TAccountMetas[9];
+    /** Solver fee token account, from which solver is paying fees */
+    solverFeeTokenAccount: TAccountMetas[10];
+    /** Guard fee token account, where Guard is collecting fees */
+    guardFeeTokenAccount: TAccountMetas[11];
+    /** Solana token program */
+    feeTokenProgram: TAccountMetas[12];
+    /**
+     * If token OUT is native - receiver account is required
+     * Pubkey is checked against `secret_hash`
+     */
+
+    nativeTokenOutReceiver?: TAccountMetas[13] | undefined;
+    /** Solana System program. Must be Some if token OUT or any of extra transfers tokens is native */
+    systemProgram?: TAccountMetas[14] | undefined;
+    /**
+     * Token OUT mint
+     * None if token OUT is native
+     */
+
+    tokenOutMint?: TAccountMetas[15] | undefined;
+    /**
+     * Solver token OUT account, from which solver will send tokens OUT
+     * None if token OUT is native
+     */
+
+    solverTokenOutAccount?: TAccountMetas[16] | undefined;
+    /**
+     * Destination token OUT account, to which tokens OUT will be sent
+     * Authority is checked against `secret_hash`
+     * None if token OUT is native
+     */
+
+    destinationTokenOutAccount?: TAccountMetas[17] | undefined;
+    /**
+     * Solana token program
+     * None if token OUT is native
+     */
+
+    tokenOutProgram?: TAccountMetas[18] | undefined;
+  };
+  data: FulfillDcaOrderIntervalInstructionData;
+};
+
+export function parseFulfillDcaOrderIntervalInstruction<
+  TProgram extends string,
+  TAccountMetas extends readonly IAccountMeta[],
+>(
+  instruction: IInstruction<TProgram> & IInstructionWithAccounts<TAccountMetas> & IInstructionWithData<Uint8Array>,
+): ParsedFulfillDcaOrderIntervalInstruction<TProgram, TAccountMetas> {
+  if (instruction.accounts.length < 19) {
+    // TODO: Coded error.
+    throw new Error('Not enough accounts');
+  }
+  let accountIndex = 0;
+  const getNextAccount = () => {
+    const accountMeta = instruction.accounts![accountIndex]!;
+    accountIndex += 1;
+    return accountMeta;
+  };
+  const getNextOptionalAccount = () => {
+    const accountMeta = getNextAccount();
+    return accountMeta.address === SINGLE_CHAIN_GUARD_PROGRAM_ADDRESS ? undefined : accountMeta;
+  };
+  return {
+    programAddress: instruction.programAddress,
+    accounts: {
+      solver: getNextAccount(),
+      order: getNextAccount(),
+      user: getNextAccount(),
+      guard: getNextAccount(),
+      ixSysvar: getNextAccount(),
+      tokenInMint: getNextAccount(),
+      solverTokenInAccount: getNextAccount(),
+      guardTokenInAccount: getNextAccount(),
+      tokenInProgram: getNextAccount(),
+      feeTokenMint: getNextAccount(),
+      solverFeeTokenAccount: getNextAccount(),
+      guardFeeTokenAccount: getNextAccount(),
+      feeTokenProgram: getNextAccount(),
+      nativeTokenOutReceiver: getNextOptionalAccount(),
+      systemProgram: getNextOptionalAccount(),
+      tokenOutMint: getNextOptionalAccount(),
+      solverTokenOutAccount: getNextOptionalAccount(),
+      destinationTokenOutAccount: getNextOptionalAccount(),
+      tokenOutProgram: getNextOptionalAccount(),
+    },
+    data: getFulfillDcaOrderIntervalInstructionDataDecoder().decode(instruction.data),
+  };
+}