@shogun-sdk/intents-sdk 1.3.0 → 1.4.1

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

@@ -0,0 +1,396 @@
+/**
+ * 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 CLAIM_TOKENS_FOR_DCA_INTERVAL_DISCRIMINATOR = new Uint8Array([
+  166, 78, 207, 111, 247, 63, 107, 46,
+]);
+
+export function getClaimTokensForDcaIntervalDiscriminatorBytes() {
+  return fixEncoderSize(getBytesEncoder(), 8).encode(CLAIM_TOKENS_FOR_DCA_INTERVAL_DISCRIMINATOR);
+}
+
+export type ClaimTokensForDcaIntervalInstruction<
+  TProgram extends string = typeof SOURCE_CHAIN_GUARD_PROGRAM_ADDRESS,
+  TAccountSolver extends string | AccountMeta<string> = string,
+  TAccountOrder extends string | AccountMeta<string> = string,
+  TAccountUser extends string | AccountMeta<string> = string,
+  TAccountGuard extends string | AccountMeta<string> = string,
+  TAccountIxSysvar extends
+    | string
+    | AccountMeta<string> = 'Sysvar1nstructions1111111111111111111111111',
+  TAccountRecoveredTokenMint extends string | AccountMeta<string> = string,
+  TAccountSolverRecoveredTokenAccount extends string | AccountMeta<string> = string,
+  TAccountGuardRecoveredTokenAccount extends string | AccountMeta<string> = string,
+  TAccountRecoveredTokenProgram extends string | AccountMeta<string> = string,
+  TAccountCollateralTokenMint extends string | AccountMeta<string> = string,
+  TAccountSolverCollateralTokenAccount extends string | AccountMeta<string> = string,
+  TAccountGuardCollateralTokenAccount extends string | AccountMeta<string> = string,
+  TAccountCollateralTokenProgram 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,
+      TAccountUser extends string ? WritableAccount<TAccountUser> : TAccountUser,
+      TAccountGuard extends string ? ReadonlyAccount<TAccountGuard> : TAccountGuard,
+      TAccountIxSysvar extends string ? ReadonlyAccount<TAccountIxSysvar> : TAccountIxSysvar,
+      TAccountRecoveredTokenMint extends string
+        ? ReadonlyAccount<TAccountRecoveredTokenMint>
+        : TAccountRecoveredTokenMint,
+      TAccountSolverRecoveredTokenAccount extends string
+        ? WritableAccount<TAccountSolverRecoveredTokenAccount>
+        : TAccountSolverRecoveredTokenAccount,
+      TAccountGuardRecoveredTokenAccount extends string
+        ? WritableAccount<TAccountGuardRecoveredTokenAccount>
+        : TAccountGuardRecoveredTokenAccount,
+      TAccountRecoveredTokenProgram extends string
+        ? ReadonlyAccount<TAccountRecoveredTokenProgram>
+        : TAccountRecoveredTokenProgram,
+      TAccountCollateralTokenMint extends string
+        ? ReadonlyAccount<TAccountCollateralTokenMint>
+        : TAccountCollateralTokenMint,
+      TAccountSolverCollateralTokenAccount extends string
+        ? WritableAccount<TAccountSolverCollateralTokenAccount>
+        : TAccountSolverCollateralTokenAccount,
+      TAccountGuardCollateralTokenAccount extends string
+        ? WritableAccount<TAccountGuardCollateralTokenAccount>
+        : TAccountGuardCollateralTokenAccount,
+      TAccountCollateralTokenProgram extends string
+        ? ReadonlyAccount<TAccountCollateralTokenProgram>
+        : TAccountCollateralTokenProgram,
+      ...TRemainingAccounts,
+    ]
+  >;
+
+export type ClaimTokensForDcaIntervalInstructionData = { discriminator: ReadonlyUint8Array };
+
+export type ClaimTokensForDcaIntervalInstructionDataArgs = Object;
+
+export function getClaimTokensForDcaIntervalInstructionDataEncoder(): FixedSizeEncoder<ClaimTokensForDcaIntervalInstructionDataArgs> {
+  return transformEncoder(
+    getStructEncoder([['discriminator', fixEncoderSize(getBytesEncoder(), 8)]]),
+    (value) => ({ ...value, discriminator: CLAIM_TOKENS_FOR_DCA_INTERVAL_DISCRIMINATOR })
+  );
+}
+
+export function getClaimTokensForDcaIntervalInstructionDataDecoder(): FixedSizeDecoder<ClaimTokensForDcaIntervalInstructionData> {
+  return getStructDecoder([['discriminator', fixDecoderSize(getBytesDecoder(), 8)]]);
+}
+
+export function getClaimTokensForDcaIntervalInstructionDataCodec(): FixedSizeCodec<
+  ClaimTokensForDcaIntervalInstructionDataArgs,
+  ClaimTokensForDcaIntervalInstructionData
+> {
+  return combineCodec(
+    getClaimTokensForDcaIntervalInstructionDataEncoder(),
+    getClaimTokensForDcaIntervalInstructionDataDecoder()
+  );
+}
+
+export type ClaimTokensForDcaIntervalInput<
+  TAccountSolver extends string = string,
+  TAccountOrder extends string = string,
+  TAccountUser extends string = string,
+  TAccountGuard extends string = string,
+  TAccountIxSysvar extends string = string,
+  TAccountRecoveredTokenMint extends string = string,
+  TAccountSolverRecoveredTokenAccount extends string = string,
+  TAccountGuardRecoveredTokenAccount extends string = string,
+  TAccountRecoveredTokenProgram extends string = string,
+  TAccountCollateralTokenMint extends string = string,
+  TAccountSolverCollateralTokenAccount extends string = string,
+  TAccountGuardCollateralTokenAccount extends string = string,
+  TAccountCollateralTokenProgram extends string = string,
+> = {
+  /** Solver that has successfully executed the DCA order and claims tokens */
+  solver: TransactionSigner<TAccountSolver>;
+  /** DCA order data */
+  order: Address<TAccountOrder>;
+  /** User account that will receive lamports after closing DcaOrder account */
+  user: Address<TAccountUser>;
+  /** Guard address, that protects this 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>;
+  /** Recovered token mint */
+  recoveredTokenMint: Address<TAccountRecoveredTokenMint>;
+  /**
+   * Solver token account to which tokens IN or stablecoins will be sent.
+   * - Must be either Token IN account or stablecoin account
+   * - Must be same token as Guard token account
+   */
+  solverRecoveredTokenAccount: Address<TAccountSolverRecoveredTokenAccount>;
+  /**
+   * Guard token account from which tokens IN or stablecoins will be sent to the solver
+   * - Must be either Token IN account or stablecoin account
+   * - Must be same token as Guard token account
+   */
+  guardRecoveredTokenAccount: Address<TAccountGuardRecoveredTokenAccount>;
+  /** Recovered token program */
+  recoveredTokenProgram: Address<TAccountRecoveredTokenProgram>;
+  /** Recovered token mint */
+  collateralTokenMint: Address<TAccountCollateralTokenMint>;
+  /** Solver collateral token account to which locked collateral will be sent. */
+  solverCollateralTokenAccount: Address<TAccountSolverCollateralTokenAccount>;
+  /** Guard collateral token account from which locked and taken collateral will be sent. */
+  guardCollateralTokenAccount: Address<TAccountGuardCollateralTokenAccount>;
+  /** Solana token program */
+  collateralTokenProgram: Address<TAccountCollateralTokenProgram>;
+};
+
+export function getClaimTokensForDcaIntervalInstruction<
+  TAccountSolver extends string,
+  TAccountOrder extends string,
+  TAccountUser extends string,
+  TAccountGuard extends string,
+  TAccountIxSysvar extends string,
+  TAccountRecoveredTokenMint extends string,
+  TAccountSolverRecoveredTokenAccount extends string,
+  TAccountGuardRecoveredTokenAccount extends string,
+  TAccountRecoveredTokenProgram extends string,
+  TAccountCollateralTokenMint extends string,
+  TAccountSolverCollateralTokenAccount extends string,
+  TAccountGuardCollateralTokenAccount extends string,
+  TAccountCollateralTokenProgram extends string,
+  TProgramAddress extends Address = typeof SOURCE_CHAIN_GUARD_PROGRAM_ADDRESS,
+>(
+  input: ClaimTokensForDcaIntervalInput<
+    TAccountSolver,
+    TAccountOrder,
+    TAccountUser,
+    TAccountGuard,
+    TAccountIxSysvar,
+    TAccountRecoveredTokenMint,
+    TAccountSolverRecoveredTokenAccount,
+    TAccountGuardRecoveredTokenAccount,
+    TAccountRecoveredTokenProgram,
+    TAccountCollateralTokenMint,
+    TAccountSolverCollateralTokenAccount,
+    TAccountGuardCollateralTokenAccount,
+    TAccountCollateralTokenProgram
+  >,
+  config?: { programAddress?: TProgramAddress }
+): ClaimTokensForDcaIntervalInstruction<
+  TProgramAddress,
+  TAccountSolver,
+  TAccountOrder,
+  TAccountUser,
+  TAccountGuard,
+  TAccountIxSysvar,
+  TAccountRecoveredTokenMint,
+  TAccountSolverRecoveredTokenAccount,
+  TAccountGuardRecoveredTokenAccount,
+  TAccountRecoveredTokenProgram,
+  TAccountCollateralTokenMint,
+  TAccountSolverCollateralTokenAccount,
+  TAccountGuardCollateralTokenAccount,
+  TAccountCollateralTokenProgram
+> {
+  // 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 },
+    user: { value: input.user ?? null, isWritable: true },
+    guard: { value: input.guard ?? null, isWritable: false },
+    ixSysvar: { value: input.ixSysvar ?? null, isWritable: false },
+    recoveredTokenMint: { value: input.recoveredTokenMint ?? null, isWritable: false },
+    solverRecoveredTokenAccount: {
+      value: input.solverRecoveredTokenAccount ?? null,
+      isWritable: true,
+    },
+    guardRecoveredTokenAccount: {
+      value: input.guardRecoveredTokenAccount ?? null,
+      isWritable: true,
+    },
+    recoveredTokenProgram: { value: input.recoveredTokenProgram ?? null, isWritable: false },
+    collateralTokenMint: { value: input.collateralTokenMint ?? null, isWritable: false },
+    solverCollateralTokenAccount: {
+      value: input.solverCollateralTokenAccount ?? null,
+      isWritable: true,
+    },
+    guardCollateralTokenAccount: {
+      value: input.guardCollateralTokenAccount ?? null,
+      isWritable: true,
+    },
+    collateralTokenProgram: { value: input.collateralTokenProgram ?? 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.user),
+      getAccountMeta(accounts.guard),
+      getAccountMeta(accounts.ixSysvar),
+      getAccountMeta(accounts.recoveredTokenMint),
+      getAccountMeta(accounts.solverRecoveredTokenAccount),
+      getAccountMeta(accounts.guardRecoveredTokenAccount),
+      getAccountMeta(accounts.recoveredTokenProgram),
+      getAccountMeta(accounts.collateralTokenMint),
+      getAccountMeta(accounts.solverCollateralTokenAccount),
+      getAccountMeta(accounts.guardCollateralTokenAccount),
+      getAccountMeta(accounts.collateralTokenProgram),
+    ],
+    programAddress,
+    data: getClaimTokensForDcaIntervalInstructionDataEncoder().encode({}),
+  } as ClaimTokensForDcaIntervalInstruction<
+    TProgramAddress,
+    TAccountSolver,
+    TAccountOrder,
+    TAccountUser,
+    TAccountGuard,
+    TAccountIxSysvar,
+    TAccountRecoveredTokenMint,
+    TAccountSolverRecoveredTokenAccount,
+    TAccountGuardRecoveredTokenAccount,
+    TAccountRecoveredTokenProgram,
+    TAccountCollateralTokenMint,
+    TAccountSolverCollateralTokenAccount,
+    TAccountGuardCollateralTokenAccount,
+    TAccountCollateralTokenProgram
+  >;
+
+  return instruction;
+}
+
+export type ParsedClaimTokensForDcaIntervalInstruction<
+  TProgram extends string = typeof SOURCE_CHAIN_GUARD_PROGRAM_ADDRESS,
+  TAccountMetas extends readonly AccountMeta[] = readonly AccountMeta[],
+> = {
+  programAddress: Address<TProgram>;
+  accounts: {
+    /** Solver that has successfully executed the DCA order and claims tokens */
+    solver: TAccountMetas[0];
+    /** DCA order data */
+    order: TAccountMetas[1];
+    /** User account that will receive lamports after closing DcaOrder account */
+    user: TAccountMetas[2];
+    /** Guard address, that protects this 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];
+    /** Recovered token mint */
+    recoveredTokenMint: TAccountMetas[5];
+    /**
+     * Solver token account to which tokens IN or stablecoins will be sent.
+     * - Must be either Token IN account or stablecoin account
+     * - Must be same token as Guard token account
+     */
+
+    solverRecoveredTokenAccount: TAccountMetas[6];
+    /**
+     * Guard token account from which tokens IN or stablecoins will be sent to the solver
+     * - Must be either Token IN account or stablecoin account
+     * - Must be same token as Guard token account
+     */
+
+    guardRecoveredTokenAccount: TAccountMetas[7];
+    /** Recovered token program */
+    recoveredTokenProgram: TAccountMetas[8];
+    /** Recovered token mint */
+    collateralTokenMint: TAccountMetas[9];
+    /** Solver collateral token account to which locked collateral will be sent. */
+    solverCollateralTokenAccount: TAccountMetas[10];
+    /** Guard collateral token account from which locked and taken collateral will be sent. */
+    guardCollateralTokenAccount: TAccountMetas[11];
+    /** Solana token program */
+    collateralTokenProgram: TAccountMetas[12];
+  };
+  data: ClaimTokensForDcaIntervalInstructionData;
+};
+
+export function parseClaimTokensForDcaIntervalInstruction<
+  TProgram extends string,
+  TAccountMetas extends readonly AccountMeta[],
+>(
+  instruction: Instruction<TProgram> &
+    InstructionWithAccounts<TAccountMetas> &
+    InstructionWithData<ReadonlyUint8Array>
+): ParsedClaimTokensForDcaIntervalInstruction<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;
+  };
+  return {
+    programAddress: instruction.programAddress,
+    accounts: {
+      solver: getNextAccount(),
+      order: getNextAccount(),
+      user: getNextAccount(),
+      guard: getNextAccount(),
+      ixSysvar: getNextAccount(),
+      recoveredTokenMint: getNextAccount(),
+      solverRecoveredTokenAccount: getNextAccount(),
+      guardRecoveredTokenAccount: getNextAccount(),
+      recoveredTokenProgram: getNextAccount(),
+      collateralTokenMint: getNextAccount(),
+      solverCollateralTokenAccount: getNextAccount(),
+      guardCollateralTokenAccount: getNextAccount(),
+      collateralTokenProgram: getNextAccount(),
+    },
+    data: getClaimTokensForDcaIntervalInstructionDataDecoder().decode(instruction.data),
+  };
+}

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

@@ -10,13 +10,18 @@ export * from './acceptAdmin.js';
 export * from './cancelDcaOrder.js';
 export * from './cancelOrder.js';
 export * from './claimTokens.js';
+export * from './claimTokensForDcaInterval.js';
 export * from './collectProtocolFees.js';
 export * from './createDcaOrder.js';
 export * from './createGuard.js';
 export * from './createOrder.js';
 export * from './initialize.js';
+export * from './preStartDcaOrderExecution.js';
 export * from './preStartOrderExecution.js';
 export * from './setAdmin.js';
 export * from './setAuctioneerPubKey.js';
+export * from './setCancelAuthorities.js';
+export * from './startDcaOrderExecution.js';
+export * from './startDcaOrderExecutionAfterSwap.js';
 export * from './startOrderExecution.js';
 export * from './startOrderExecutionAfterSwap.js';