@shogun-sdk/intents-sdk 1.3.0 → 1.4.0

package/src/core/solana/generated/cross-chain/instructions/startDcaOrderExecution.ts

@@ -0,0 +1,440 @@
+/**
+ * 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/addresses';
+import {
+  combineCodec,
+  fixDecoderSize,
+  fixEncoderSize,
+  getBytesDecoder,
+  getBytesEncoder,
+  getStructDecoder,
+  getStructEncoder,
+  transformEncoder,
+  type FixedSizeCodec,
+  type FixedSizeDecoder,
+  type FixedSizeEncoder,
+  type ReadonlyUint8Array,
+} from '@solana/codecs';
+import {
+  type AccountMeta,
+  type Instruction,
+  type InstructionWithAccounts,
+  type InstructionWithData,
+  type ReadonlyAccount,
+  type WritableAccount,
+  type WritableSignerAccount,
+} from '@solana/instructions';
+import { type AccountSignerMeta, type TransactionSigner } from '@solana/signers';
+import { SOURCE_CHAIN_GUARD_PROGRAM_ADDRESS } from '../programs/index.js';
+import { getAccountMetaFactory, type ResolvedAccount } from '../shared/index.js';
+
+export const START_DCA_ORDER_EXECUTION_DISCRIMINATOR = new Uint8Array([
+  0, 61, 163, 212, 122, 175, 14, 47,
+]);
+
+export function getStartDcaOrderExecutionDiscriminatorBytes() {
+  return fixEncoderSize(getBytesEncoder(), 8).encode(START_DCA_ORDER_EXECUTION_DISCRIMINATOR);
+}
+
+export type StartDcaOrderExecutionInstruction<
+  TProgram extends string = typeof SOURCE_CHAIN_GUARD_PROGRAM_ADDRESS,
+  TAccountSolver extends string | AccountMeta<string> = string,
+  TAccountOrder extends string | AccountMeta<string> = string,
+  TAccountGuard extends string | AccountMeta<string> = string,
+  TAccountIxSysvar extends
+    | string
+    | AccountMeta<string> = 'Sysvar1nstructions1111111111111111111111111',
+  TAccountCollateralTokenMint extends string | AccountMeta<string> = string,
+  TAccountSolverCollateralTokenAccount extends string | AccountMeta<string> = string,
+  TAccountGuardCollateralTokenAccount extends string | AccountMeta<string> = string,
+  TAccountPrevIntervalCollateralTokenDestinationAccount extends
+    | string
+    | AccountMeta<string> = string,
+  TAccountCollateralTokenProgram extends string | AccountMeta<string> = string,
+  TAccountPrevIntervalRecoveredTokenMint extends string | AccountMeta<string> = string,
+  TAccountPrevIntervalGuardRecoveredTokenAccount extends string | AccountMeta<string> = string,
+  TAccountPrevIntervalRecoveredTokenDestinationAccount extends
+    | string
+    | AccountMeta<string> = string,
+  TAccountPrevIntervalRecoveredTokenProgram extends string | AccountMeta<string> = string,
+  TRemainingAccounts extends readonly AccountMeta<string>[] = [],
+> = Instruction<TProgram> &
+  InstructionWithData<ReadonlyUint8Array> &
+  InstructionWithAccounts<
+    [
+      TAccountSolver extends string
+        ? WritableSignerAccount<TAccountSolver> & AccountSignerMeta<TAccountSolver>
+        : TAccountSolver,
+      TAccountOrder extends string ? WritableAccount<TAccountOrder> : TAccountOrder,
+      TAccountGuard extends string ? WritableAccount<TAccountGuard> : TAccountGuard,
+      TAccountIxSysvar extends string ? ReadonlyAccount<TAccountIxSysvar> : TAccountIxSysvar,
+      TAccountCollateralTokenMint extends string
+        ? ReadonlyAccount<TAccountCollateralTokenMint>
+        : TAccountCollateralTokenMint,
+      TAccountSolverCollateralTokenAccount extends string
+        ? WritableAccount<TAccountSolverCollateralTokenAccount>
+        : TAccountSolverCollateralTokenAccount,
+      TAccountGuardCollateralTokenAccount extends string
+        ? WritableAccount<TAccountGuardCollateralTokenAccount>
+        : TAccountGuardCollateralTokenAccount,
+      TAccountPrevIntervalCollateralTokenDestinationAccount extends string
+        ? WritableAccount<TAccountPrevIntervalCollateralTokenDestinationAccount>
+        : TAccountPrevIntervalCollateralTokenDestinationAccount,
+      TAccountCollateralTokenProgram extends string
+        ? ReadonlyAccount<TAccountCollateralTokenProgram>
+        : TAccountCollateralTokenProgram,
+      TAccountPrevIntervalRecoveredTokenMint extends string
+        ? ReadonlyAccount<TAccountPrevIntervalRecoveredTokenMint>
+        : TAccountPrevIntervalRecoveredTokenMint,
+      TAccountPrevIntervalGuardRecoveredTokenAccount extends string
+        ? WritableAccount<TAccountPrevIntervalGuardRecoveredTokenAccount>
+        : TAccountPrevIntervalGuardRecoveredTokenAccount,
+      TAccountPrevIntervalRecoveredTokenDestinationAccount extends string
+        ? WritableAccount<TAccountPrevIntervalRecoveredTokenDestinationAccount>
+        : TAccountPrevIntervalRecoveredTokenDestinationAccount,
+      TAccountPrevIntervalRecoveredTokenProgram extends string
+        ? ReadonlyAccount<TAccountPrevIntervalRecoveredTokenProgram>
+        : TAccountPrevIntervalRecoveredTokenProgram,
+      ...TRemainingAccounts,
+    ]
+  >;
+
+export type StartDcaOrderExecutionInstructionData = { discriminator: ReadonlyUint8Array };
+
+export type StartDcaOrderExecutionInstructionDataArgs = Object;
+
+export function getStartDcaOrderExecutionInstructionDataEncoder(): FixedSizeEncoder<StartDcaOrderExecutionInstructionDataArgs> {
+  return transformEncoder(
+    getStructEncoder([['discriminator', fixEncoderSize(getBytesEncoder(), 8)]]),
+    (value) => ({ ...value, discriminator: START_DCA_ORDER_EXECUTION_DISCRIMINATOR })
+  );
+}
+
+export function getStartDcaOrderExecutionInstructionDataDecoder(): FixedSizeDecoder<StartDcaOrderExecutionInstructionData> {
+  return getStructDecoder([['discriminator', fixDecoderSize(getBytesDecoder(), 8)]]);
+}
+
+export function getStartDcaOrderExecutionInstructionDataCodec(): FixedSizeCodec<
+  StartDcaOrderExecutionInstructionDataArgs,
+  StartDcaOrderExecutionInstructionData
+> {
+  return combineCodec(
+    getStartDcaOrderExecutionInstructionDataEncoder(),
+    getStartDcaOrderExecutionInstructionDataDecoder()
+  );
+}
+
+export type StartDcaOrderExecutionInput<
+  TAccountSolver extends string = string,
+  TAccountOrder extends string = string,
+  TAccountGuard extends string = string,
+  TAccountIxSysvar extends string = string,
+  TAccountCollateralTokenMint extends string = string,
+  TAccountSolverCollateralTokenAccount extends string = string,
+  TAccountGuardCollateralTokenAccount extends string = string,
+  TAccountPrevIntervalCollateralTokenDestinationAccount extends string = string,
+  TAccountCollateralTokenProgram extends string = string,
+  TAccountPrevIntervalRecoveredTokenMint extends string = string,
+  TAccountPrevIntervalGuardRecoveredTokenAccount extends string = string,
+  TAccountPrevIntervalRecoveredTokenDestinationAccount extends string = string,
+  TAccountPrevIntervalRecoveredTokenProgram extends string = string,
+> = {
+  /** Solver that starts DCA order execution */
+  solver: TransactionSigner<TAccountSolver>;
+  /** DCA order data */
+  order: Address<TAccountOrder>;
+  /** 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>;
+  /** Collateral token mint */
+  collateralTokenMint: Address<TAccountCollateralTokenMint>;
+  /** Solver collateral account, from which solver is paying collateral tokens and fees */
+  solverCollateralTokenAccount: Address<TAccountSolverCollateralTokenAccount>;
+  /** Guard collateral account, where Guard is collecting collateral tokens */
+  guardCollateralTokenAccount: Address<TAccountGuardCollateralTokenAccount>;
+  /**
+   * If previous interval was successfully fulfilled - previous solver collateral token
+   * account to return collateral tokens.
+   * If previous interval was failed while tokens IN were swapped to stablecoins -
+   * user collateral token account to send collateral tokens.
+   *
+   * Note: Authority Constraint is checked in program
+   */
+  prevIntervalCollateralTokenDestinationAccount?: Address<TAccountPrevIntervalCollateralTokenDestinationAccount>;
+  /** Solana token program */
+  collateralTokenProgram: Address<TAccountCollateralTokenProgram>;
+  /**
+   * (Optional) Token mint of token to be recovered for previous interval
+   * Should be either token IN (if interval was successfully executed without swap but not claimed)
+   * or stablecoin if tokens IN were swapped during previous interval (that was failed
+   * or executed, but tokens were not claimed)
+   *
+   * Note: Address Constraint is checked in program
+   */
+  prevIntervalRecoveredTokenMint?: Address<TAccountPrevIntervalRecoveredTokenMint>;
+  /** (Optional) Guard account of token to be recovered for previous interval */
+  prevIntervalGuardRecoveredTokenAccount?: Address<TAccountPrevIntervalGuardRecoveredTokenAccount>;
+  /**
+   * (Optional) Tokens receiver account of token to be recovered for previous interval
+   * Should be either previous interval solver (if interval was successfully executed but not claimed)
+   * or user account (if previous interval was failed, while tokens IN were swapped)
+   *
+   * Note: Authority Constraint is checked in program
+   */
+  prevIntervalRecoveredTokenDestinationAccount?: Address<TAccountPrevIntervalRecoveredTokenDestinationAccount>;
+  /** (Optional) Token program of token to be recovered for previous interval */
+  prevIntervalRecoveredTokenProgram?: Address<TAccountPrevIntervalRecoveredTokenProgram>;
+};
+
+export function getStartDcaOrderExecutionInstruction<
+  TAccountSolver extends string,
+  TAccountOrder extends string,
+  TAccountGuard extends string,
+  TAccountIxSysvar extends string,
+  TAccountCollateralTokenMint extends string,
+  TAccountSolverCollateralTokenAccount extends string,
+  TAccountGuardCollateralTokenAccount extends string,
+  TAccountPrevIntervalCollateralTokenDestinationAccount extends string,
+  TAccountCollateralTokenProgram extends string,
+  TAccountPrevIntervalRecoveredTokenMint extends string,
+  TAccountPrevIntervalGuardRecoveredTokenAccount extends string,
+  TAccountPrevIntervalRecoveredTokenDestinationAccount extends string,
+  TAccountPrevIntervalRecoveredTokenProgram extends string,
+  TProgramAddress extends Address = typeof SOURCE_CHAIN_GUARD_PROGRAM_ADDRESS,
+>(
+  input: StartDcaOrderExecutionInput<
+    TAccountSolver,
+    TAccountOrder,
+    TAccountGuard,
+    TAccountIxSysvar,
+    TAccountCollateralTokenMint,
+    TAccountSolverCollateralTokenAccount,
+    TAccountGuardCollateralTokenAccount,
+    TAccountPrevIntervalCollateralTokenDestinationAccount,
+    TAccountCollateralTokenProgram,
+    TAccountPrevIntervalRecoveredTokenMint,
+    TAccountPrevIntervalGuardRecoveredTokenAccount,
+    TAccountPrevIntervalRecoveredTokenDestinationAccount,
+    TAccountPrevIntervalRecoveredTokenProgram
+  >,
+  config?: { programAddress?: TProgramAddress }
+): StartDcaOrderExecutionInstruction<
+  TProgramAddress,
+  TAccountSolver,
+  TAccountOrder,
+  TAccountGuard,
+  TAccountIxSysvar,
+  TAccountCollateralTokenMint,
+  TAccountSolverCollateralTokenAccount,
+  TAccountGuardCollateralTokenAccount,
+  TAccountPrevIntervalCollateralTokenDestinationAccount,
+  TAccountCollateralTokenProgram,
+  TAccountPrevIntervalRecoveredTokenMint,
+  TAccountPrevIntervalGuardRecoveredTokenAccount,
+  TAccountPrevIntervalRecoveredTokenDestinationAccount,
+  TAccountPrevIntervalRecoveredTokenProgram
+> {
+  // Program address.
+  const programAddress = config?.programAddress ?? SOURCE_CHAIN_GUARD_PROGRAM_ADDRESS;
+
+  // Original accounts.
+  const originalAccounts = {
+    solver: { value: input.solver ?? null, isWritable: true },
+    order: { value: input.order ?? null, isWritable: true },
+    guard: { value: input.guard ?? null, isWritable: true },
+    ixSysvar: { value: input.ixSysvar ?? null, isWritable: false },
+    collateralTokenMint: { value: input.collateralTokenMint ?? null, isWritable: false },
+    solverCollateralTokenAccount: {
+      value: input.solverCollateralTokenAccount ?? null,
+      isWritable: true,
+    },
+    guardCollateralTokenAccount: {
+      value: input.guardCollateralTokenAccount ?? null,
+      isWritable: true,
+    },
+    prevIntervalCollateralTokenDestinationAccount: {
+      value: input.prevIntervalCollateralTokenDestinationAccount ?? null,
+      isWritable: true,
+    },
+    collateralTokenProgram: { value: input.collateralTokenProgram ?? null, isWritable: false },
+    prevIntervalRecoveredTokenMint: {
+      value: input.prevIntervalRecoveredTokenMint ?? null,
+      isWritable: false,
+    },
+    prevIntervalGuardRecoveredTokenAccount: {
+      value: input.prevIntervalGuardRecoveredTokenAccount ?? null,
+      isWritable: true,
+    },
+    prevIntervalRecoveredTokenDestinationAccount: {
+      value: input.prevIntervalRecoveredTokenDestinationAccount ?? null,
+      isWritable: true,
+    },
+    prevIntervalRecoveredTokenProgram: {
+      value: input.prevIntervalRecoveredTokenProgram ?? null,
+      isWritable: false,
+    },
+  };
+  const accounts = originalAccounts as Record<keyof typeof originalAccounts, ResolvedAccount>;
+
+  // Resolve default values.
+  if (!accounts.ixSysvar.value) {
+    accounts.ixSysvar.value =
+      'Sysvar1nstructions1111111111111111111111111' as Address<'Sysvar1nstructions1111111111111111111111111'>;
+  }
+
+  const getAccountMeta = getAccountMetaFactory(programAddress, 'programId');
+  const instruction = {
+    accounts: [
+      getAccountMeta(accounts.solver),
+      getAccountMeta(accounts.order),
+      getAccountMeta(accounts.guard),
+      getAccountMeta(accounts.ixSysvar),
+      getAccountMeta(accounts.collateralTokenMint),
+      getAccountMeta(accounts.solverCollateralTokenAccount),
+      getAccountMeta(accounts.guardCollateralTokenAccount),
+      getAccountMeta(accounts.prevIntervalCollateralTokenDestinationAccount),
+      getAccountMeta(accounts.collateralTokenProgram),
+      getAccountMeta(accounts.prevIntervalRecoveredTokenMint),
+      getAccountMeta(accounts.prevIntervalGuardRecoveredTokenAccount),
+      getAccountMeta(accounts.prevIntervalRecoveredTokenDestinationAccount),
+      getAccountMeta(accounts.prevIntervalRecoveredTokenProgram),
+    ],
+    programAddress,
+    data: getStartDcaOrderExecutionInstructionDataEncoder().encode({}),
+  } as StartDcaOrderExecutionInstruction<
+    TProgramAddress,
+    TAccountSolver,
+    TAccountOrder,
+    TAccountGuard,
+    TAccountIxSysvar,
+    TAccountCollateralTokenMint,
+    TAccountSolverCollateralTokenAccount,
+    TAccountGuardCollateralTokenAccount,
+    TAccountPrevIntervalCollateralTokenDestinationAccount,
+    TAccountCollateralTokenProgram,
+    TAccountPrevIntervalRecoveredTokenMint,
+    TAccountPrevIntervalGuardRecoveredTokenAccount,
+    TAccountPrevIntervalRecoveredTokenDestinationAccount,
+    TAccountPrevIntervalRecoveredTokenProgram
+  >;
+
+  return instruction;
+}
+
+export type ParsedStartDcaOrderExecutionInstruction<
+  TProgram extends string = typeof SOURCE_CHAIN_GUARD_PROGRAM_ADDRESS,
+  TAccountMetas extends readonly AccountMeta[] = readonly AccountMeta[],
+> = {
+  programAddress: Address<TProgram>;
+  accounts: {
+    /** Solver that starts DCA order execution */
+    solver: TAccountMetas[0];
+    /** DCA order data */
+    order: TAccountMetas[1];
+    /** Guard address, that protects this DCA order execution */
+    guard: TAccountMetas[2];
+    /**
+     * 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[3];
+    /** Collateral token mint */
+    collateralTokenMint: TAccountMetas[4];
+    /** Solver collateral account, from which solver is paying collateral tokens and fees */
+    solverCollateralTokenAccount: TAccountMetas[5];
+    /** Guard collateral account, where Guard is collecting collateral tokens */
+    guardCollateralTokenAccount: TAccountMetas[6];
+    /**
+     * If previous interval was successfully fulfilled - previous solver collateral token
+     * account to return collateral tokens.
+     * If previous interval was failed while tokens IN were swapped to stablecoins -
+     * user collateral token account to send collateral tokens.
+     *
+     * Note: Authority Constraint is checked in program
+     */
+
+    prevIntervalCollateralTokenDestinationAccount?: TAccountMetas[7] | undefined;
+    /** Solana token program */
+    collateralTokenProgram: TAccountMetas[8];
+    /**
+     * (Optional) Token mint of token to be recovered for previous interval
+     * Should be either token IN (if interval was successfully executed without swap but not claimed)
+     * or stablecoin if tokens IN were swapped during previous interval (that was failed
+     * or executed, but tokens were not claimed)
+     *
+     * Note: Address Constraint is checked in program
+     */
+
+    prevIntervalRecoveredTokenMint?: TAccountMetas[9] | undefined;
+    /** (Optional) Guard account of token to be recovered for previous interval */
+    prevIntervalGuardRecoveredTokenAccount?: TAccountMetas[10] | undefined;
+    /**
+     * (Optional) Tokens receiver account of token to be recovered for previous interval
+     * Should be either previous interval solver (if interval was successfully executed but not claimed)
+     * or user account (if previous interval was failed, while tokens IN were swapped)
+     *
+     * Note: Authority Constraint is checked in program
+     */
+
+    prevIntervalRecoveredTokenDestinationAccount?: TAccountMetas[11] | undefined;
+    /** (Optional) Token program of token to be recovered for previous interval */
+    prevIntervalRecoveredTokenProgram?: TAccountMetas[12] | undefined;
+  };
+  data: StartDcaOrderExecutionInstructionData;
+};
+
+export function parseStartDcaOrderExecutionInstruction<
+  TProgram extends string,
+  TAccountMetas extends readonly AccountMeta[],
+>(
+  instruction: Instruction<TProgram> &
+    InstructionWithAccounts<TAccountMetas> &
+    InstructionWithData<ReadonlyUint8Array>
+): ParsedStartDcaOrderExecutionInstruction<TProgram, TAccountMetas> {
+  if (instruction.accounts.length < 13) {
+    // 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 === SOURCE_CHAIN_GUARD_PROGRAM_ADDRESS ? undefined : accountMeta;
+  };
+  return {
+    programAddress: instruction.programAddress,
+    accounts: {
+      solver: getNextAccount(),
+      order: getNextAccount(),
+      guard: getNextAccount(),
+      ixSysvar: getNextAccount(),
+      collateralTokenMint: getNextAccount(),
+      solverCollateralTokenAccount: getNextAccount(),
+      guardCollateralTokenAccount: getNextAccount(),
+      prevIntervalCollateralTokenDestinationAccount: getNextOptionalAccount(),
+      collateralTokenProgram: getNextAccount(),
+      prevIntervalRecoveredTokenMint: getNextOptionalAccount(),
+      prevIntervalGuardRecoveredTokenAccount: getNextOptionalAccount(),
+      prevIntervalRecoveredTokenDestinationAccount: getNextOptionalAccount(),
+      prevIntervalRecoveredTokenProgram: getNextOptionalAccount(),
+    },
+    data: getStartDcaOrderExecutionInstructionDataDecoder().decode(instruction.data),
+  };
+}