@robertprp/intents-sdk/src/core/solana/generated/single-chain/instructions/createDcaOrder.ts

Shogun Network Intent-based cross-chain swaps 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 { getAddressEncoder, getProgramDerivedAddress, type Address } from '@solana/kit';
import {
  combineCodec,
  fixDecoderSize,
  fixEncoderSize,
  getArrayDecoder,
  getArrayEncoder,
  getBytesDecoder,
  getBytesEncoder,
  getStructDecoder,
  getStructEncoder,
  getU32Decoder,
  getU32Encoder,
  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 { expectAddress, getAccountMetaFactory, type ResolvedAccount } from '../shared/index.js';

export const CREATE_DCA_ORDER_DISCRIMINATOR = new Uint8Array([95, 66, 166, 38, 170, 3, 150, 169]);

export function getCreateDcaOrderDiscriminatorBytes() {
  return fixEncoderSize(getBytesEncoder(), 8).encode(CREATE_DCA_ORDER_DISCRIMINATOR);
}

export type CreateDcaOrderInstruction<
  TProgram extends string = typeof SINGLE_CHAIN_GUARD_PROGRAM_ADDRESS,
  TAccountUser extends string | IAccountMeta<string> = string,
  TAccountOrder extends string | IAccountMeta<string> = string,
  TAccountGuard extends string | IAccountMeta<string> = string,
  TAccountSystemProgram extends string | IAccountMeta<string> = '11111111111111111111111111111111',
  TAccountAssociatedTokenProgram extends string | IAccountMeta<string> = 'ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL',
  TAccountTokenInMint extends string | IAccountMeta<string> = string,
  TAccountUserTokenInAccount extends string | IAccountMeta<string> = string,
  TAccountGuardTokenInAccount extends string | IAccountMeta<string> = string,
  TAccountTokenInProgram extends string | IAccountMeta<string> = string,
  TRemainingAccounts extends readonly IAccountMeta<string>[] = [],
> = IInstruction<TProgram> &
  IInstructionWithData<Uint8Array> &
  IInstructionWithAccounts<
    [
      TAccountUser extends string
        ? WritableSignerAccount<TAccountUser> & IAccountSignerMeta<TAccountUser>
        : TAccountUser,
      TAccountOrder extends string
        ? WritableSignerAccount<TAccountOrder> & IAccountSignerMeta<TAccountOrder>
        : TAccountOrder,
      TAccountGuard extends string ? ReadonlyAccount<TAccountGuard> : TAccountGuard,
      TAccountSystemProgram extends string ? ReadonlyAccount<TAccountSystemProgram> : TAccountSystemProgram,
      TAccountAssociatedTokenProgram extends string
        ? ReadonlyAccount<TAccountAssociatedTokenProgram>
        : TAccountAssociatedTokenProgram,
      TAccountTokenInMint extends string ? ReadonlyAccount<TAccountTokenInMint> : TAccountTokenInMint,
      TAccountUserTokenInAccount extends string
        ? WritableAccount<TAccountUserTokenInAccount>
        : TAccountUserTokenInAccount,
      TAccountGuardTokenInAccount extends string
        ? WritableAccount<TAccountGuardTokenInAccount>
        : TAccountGuardTokenInAccount,
      TAccountTokenInProgram extends string ? ReadonlyAccount<TAccountTokenInProgram> : TAccountTokenInProgram,
      ...TRemainingAccounts,
    ]
  >;

export type CreateDcaOrderInstructionData = {
  discriminator: ReadonlyUint8Array;
  amountInPerInterval: bigint;
  amountOutMin: bigint;
  totalIntervals: number;
  intervalDuration: number;
  secretHash: ReadonlyUint8Array;
  extraTransfersAmounts: Array<bigint>;
  deadline: number;
};

export type CreateDcaOrderInstructionDataArgs = {
  amountInPerInterval: number | bigint;
  amountOutMin: number | bigint;
  totalIntervals: number;
  intervalDuration: number;
  secretHash: ReadonlyUint8Array;
  extraTransfersAmounts: Array<number | bigint>;
  deadline: number;
};

export function getCreateDcaOrderInstructionDataEncoder(): Encoder<CreateDcaOrderInstructionDataArgs> {
  return transformEncoder(
    getStructEncoder([
      ['discriminator', fixEncoderSize(getBytesEncoder(), 8)],
      ['amountInPerInterval', getU64Encoder()],
      ['amountOutMin', getU64Encoder()],
      ['totalIntervals', getU32Encoder()],
      ['intervalDuration', getU32Encoder()],
      ['secretHash', fixEncoderSize(getBytesEncoder(), 32)],
      ['extraTransfersAmounts', getArrayEncoder(getU64Encoder())],
      ['deadline', getU32Encoder()],
    ]),
    (value) => ({ ...value, discriminator: CREATE_DCA_ORDER_DISCRIMINATOR }),
  );
}

export function getCreateDcaOrderInstructionDataDecoder(): Decoder<CreateDcaOrderInstructionData> {
  return getStructDecoder([
    ['discriminator', fixDecoderSize(getBytesDecoder(), 8)],
    ['amountInPerInterval', getU64Decoder()],
    ['amountOutMin', getU64Decoder()],
    ['totalIntervals', getU32Decoder()],
    ['intervalDuration', getU32Decoder()],
    ['secretHash', fixDecoderSize(getBytesDecoder(), 32)],
    ['extraTransfersAmounts', getArrayDecoder(getU64Decoder())],
    ['deadline', getU32Decoder()],
  ]);
}

export function getCreateDcaOrderInstructionDataCodec(): Codec<
  CreateDcaOrderInstructionDataArgs,
  CreateDcaOrderInstructionData
> {
  return combineCodec(getCreateDcaOrderInstructionDataEncoder(), getCreateDcaOrderInstructionDataDecoder());
}

export type CreateDcaOrderAsyncInput<
  TAccountUser extends string = string,
  TAccountOrder extends string = string,
  TAccountGuard extends string = string,
  TAccountSystemProgram extends string = string,
  TAccountAssociatedTokenProgram extends string = string,
  TAccountTokenInMint extends string = string,
  TAccountUserTokenInAccount extends string = string,
  TAccountGuardTokenInAccount extends string = string,
  TAccountTokenInProgram extends string = string,
> = {
  /** User creating the DCA order */
  user: TransactionSigner<TAccountUser>;
  /** Account that will store DCA order data */
  order: TransactionSigner<TAccountOrder>;
  /** Guard address, that will protect this order execution */
  guard: Address<TAccountGuard>;
  /** Solana System program */
  systemProgram?: Address<TAccountSystemProgram>;
  /** Solana token program */
  associatedTokenProgram?: Address<TAccountAssociatedTokenProgram>;
  /** Token IN that user wants to spend */
  tokenInMint: Address<TAccountTokenInMint>;
  /** Token IN account from which user is spending tokens IN */
  userTokenInAccount: Address<TAccountUserTokenInAccount>;
  /** Token IN account that will store Tokens IN after DCA order creation */
  guardTokenInAccount?: Address<TAccountGuardTokenInAccount>;
  /** Solana token program */
  tokenInProgram: Address<TAccountTokenInProgram>;
  amountInPerInterval: CreateDcaOrderInstructionDataArgs['amountInPerInterval'];
  amountOutMin: CreateDcaOrderInstructionDataArgs['amountOutMin'];
  totalIntervals: CreateDcaOrderInstructionDataArgs['totalIntervals'];
  intervalDuration: CreateDcaOrderInstructionDataArgs['intervalDuration'];
  secretHash: CreateDcaOrderInstructionDataArgs['secretHash'];
  extraTransfersAmounts: CreateDcaOrderInstructionDataArgs['extraTransfersAmounts'];
  deadline: CreateDcaOrderInstructionDataArgs['deadline'];
};

export async function getCreateDcaOrderInstructionAsync<
  TAccountUser extends string,
  TAccountOrder extends string,
  TAccountGuard extends string,
  TAccountSystemProgram extends string,
  TAccountAssociatedTokenProgram extends string,
  TAccountTokenInMint extends string,
  TAccountUserTokenInAccount extends string,
  TAccountGuardTokenInAccount extends string,
  TAccountTokenInProgram extends string,
  TProgramAddress extends Address = typeof SINGLE_CHAIN_GUARD_PROGRAM_ADDRESS,
>(
  input: CreateDcaOrderAsyncInput<
    TAccountUser,
    TAccountOrder,
    TAccountGuard,
    TAccountSystemProgram,
    TAccountAssociatedTokenProgram,
    TAccountTokenInMint,
    TAccountUserTokenInAccount,
    TAccountGuardTokenInAccount,
    TAccountTokenInProgram
  >,
  config?: { programAddress?: TProgramAddress },
): Promise<
  CreateDcaOrderInstruction<
    TProgramAddress,
    TAccountUser,
    TAccountOrder,
    TAccountGuard,
    TAccountSystemProgram,
    TAccountAssociatedTokenProgram,
    TAccountTokenInMint,
    TAccountUserTokenInAccount,
    TAccountGuardTokenInAccount,
    TAccountTokenInProgram
  >
> {
  // Program address.
  const programAddress = config?.programAddress ?? SINGLE_CHAIN_GUARD_PROGRAM_ADDRESS;

  // Original accounts.
  const originalAccounts = {
    user: { value: input.user ?? null, isWritable: true },
    order: { value: input.order ?? null, isWritable: true },
    guard: { value: input.guard ?? null, isWritable: false },
    systemProgram: { value: input.systemProgram ?? null, isWritable: false },
    associatedTokenProgram: {
      value: input.associatedTokenProgram ?? null,
      isWritable: false,
    },
    tokenInMint: { value: input.tokenInMint ?? null, isWritable: false },
    userTokenInAccount: {
      value: input.userTokenInAccount ?? null,
      isWritable: true,
    },
    guardTokenInAccount: {
      value: input.guardTokenInAccount ?? null,
      isWritable: true,
    },
    tokenInProgram: { value: input.tokenInProgram ?? null, isWritable: false },
  };
  const accounts = originalAccounts as Record<keyof typeof originalAccounts, ResolvedAccount>;

  // Original args.
  const args = { ...input };

  // Resolve default values.
  if (!accounts.systemProgram.value) {
    accounts.systemProgram.value = '11111111111111111111111111111111' as Address<'11111111111111111111111111111111'>;
  }
  if (!accounts.associatedTokenProgram.value) {
    accounts.associatedTokenProgram.value =
      'ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL' as Address<'ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL'>;
  }
  if (!accounts.guardTokenInAccount.value) {
    accounts.guardTokenInAccount.value = await getProgramDerivedAddress({
      programAddress:
        'ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL' as Address<'ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL'>,
      seeds: [
        getAddressEncoder().encode(expectAddress(accounts.guard.value)),
        getAddressEncoder().encode(expectAddress(accounts.tokenInProgram.value)),
        getAddressEncoder().encode(expectAddress(accounts.tokenInMint.value)),
      ],
    });
  }

  const getAccountMeta = getAccountMetaFactory(programAddress, 'programId');
  const instruction = {
    accounts: [
      getAccountMeta(accounts.user),
      getAccountMeta(accounts.order),
      getAccountMeta(accounts.guard),
      getAccountMeta(accounts.systemProgram),
      getAccountMeta(accounts.associatedTokenProgram),
      getAccountMeta(accounts.tokenInMint),
      getAccountMeta(accounts.userTokenInAccount),
      getAccountMeta(accounts.guardTokenInAccount),
      getAccountMeta(accounts.tokenInProgram),
    ],
    programAddress,
    data: getCreateDcaOrderInstructionDataEncoder().encode(args as CreateDcaOrderInstructionDataArgs),
  } as CreateDcaOrderInstruction<
    TProgramAddress,
    TAccountUser,
    TAccountOrder,
    TAccountGuard,
    TAccountSystemProgram,
    TAccountAssociatedTokenProgram,
    TAccountTokenInMint,
    TAccountUserTokenInAccount,
    TAccountGuardTokenInAccount,
    TAccountTokenInProgram
  >;

  return instruction;
}

export type CreateDcaOrderInput<
  TAccountUser extends string = string,
  TAccountOrder extends string = string,
  TAccountGuard extends string = string,
  TAccountSystemProgram extends string = string,
  TAccountAssociatedTokenProgram extends string = string,
  TAccountTokenInMint extends string = string,
  TAccountUserTokenInAccount extends string = string,
  TAccountGuardTokenInAccount extends string = string,
  TAccountTokenInProgram extends string = string,
> = {
  /** User creating the DCA order */
  user: TransactionSigner<TAccountUser>;
  /** Account that will store DCA order data */
  order: TransactionSigner<TAccountOrder>;
  /** Guard address, that will protect this order execution */
  guard: Address<TAccountGuard>;
  /** Solana System program */
  systemProgram?: Address<TAccountSystemProgram>;
  /** Solana token program */
  associatedTokenProgram?: Address<TAccountAssociatedTokenProgram>;
  /** Token IN that user wants to spend */
  tokenInMint: Address<TAccountTokenInMint>;
  /** Token IN account from which user is spending tokens IN */
  userTokenInAccount: Address<TAccountUserTokenInAccount>;
  /** Token IN account that will store Tokens IN after DCA order creation */
  guardTokenInAccount: Address<TAccountGuardTokenInAccount>;
  /** Solana token program */
  tokenInProgram: Address<TAccountTokenInProgram>;
  amountInPerInterval: CreateDcaOrderInstructionDataArgs['amountInPerInterval'];
  amountOutMin: CreateDcaOrderInstructionDataArgs['amountOutMin'];
  totalIntervals: CreateDcaOrderInstructionDataArgs['totalIntervals'];
  intervalDuration: CreateDcaOrderInstructionDataArgs['intervalDuration'];
  secretHash: CreateDcaOrderInstructionDataArgs['secretHash'];
  extraTransfersAmounts: CreateDcaOrderInstructionDataArgs['extraTransfersAmounts'];
  deadline: CreateDcaOrderInstructionDataArgs['deadline'];
};

export function getCreateDcaOrderInstruction<
  TAccountUser extends string,
  TAccountOrder extends string,
  TAccountGuard extends string,
  TAccountSystemProgram extends string,
  TAccountAssociatedTokenProgram extends string,
  TAccountTokenInMint extends string,
  TAccountUserTokenInAccount extends string,
  TAccountGuardTokenInAccount extends string,
  TAccountTokenInProgram extends string,
  TProgramAddress extends Address = typeof SINGLE_CHAIN_GUARD_PROGRAM_ADDRESS,
>(
  input: CreateDcaOrderInput<
    TAccountUser,
    TAccountOrder,
    TAccountGuard,
    TAccountSystemProgram,
    TAccountAssociatedTokenProgram,
    TAccountTokenInMint,
    TAccountUserTokenInAccount,
    TAccountGuardTokenInAccount,
    TAccountTokenInProgram
  >,
  config?: { programAddress?: TProgramAddress },
): CreateDcaOrderInstruction<
  TProgramAddress,
  TAccountUser,
  TAccountOrder,
  TAccountGuard,
  TAccountSystemProgram,
  TAccountAssociatedTokenProgram,
  TAccountTokenInMint,
  TAccountUserTokenInAccount,
  TAccountGuardTokenInAccount,
  TAccountTokenInProgram
> {
  // Program address.
  const programAddress = config?.programAddress ?? SINGLE_CHAIN_GUARD_PROGRAM_ADDRESS;

  // Original accounts.
  const originalAccounts = {
    user: { value: input.user ?? null, isWritable: true },
    order: { value: input.order ?? null, isWritable: true },
    guard: { value: input.guard ?? null, isWritable: false },
    systemProgram: { value: input.systemProgram ?? null, isWritable: false },
    associatedTokenProgram: {
      value: input.associatedTokenProgram ?? null,
      isWritable: false,
    },
    tokenInMint: { value: input.tokenInMint ?? null, isWritable: false },
    userTokenInAccount: {
      value: input.userTokenInAccount ?? null,
      isWritable: true,
    },
    guardTokenInAccount: {
      value: input.guardTokenInAccount ?? null,
      isWritable: true,
    },
    tokenInProgram: { value: input.tokenInProgram ?? null, isWritable: false },
  };
  const accounts = originalAccounts as Record<keyof typeof originalAccounts, ResolvedAccount>;

  // Original args.
  const args = { ...input };

  // Resolve default values.
  if (!accounts.systemProgram.value) {
    accounts.systemProgram.value = '11111111111111111111111111111111' as Address<'11111111111111111111111111111111'>;
  }
  if (!accounts.associatedTokenProgram.value) {
    accounts.associatedTokenProgram.value =
      'ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL' as Address<'ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL'>;
  }

  const getAccountMeta = getAccountMetaFactory(programAddress, 'programId');
  const instruction = {
    accounts: [
      getAccountMeta(accounts.user),
      getAccountMeta(accounts.order),
      getAccountMeta(accounts.guard),
      getAccountMeta(accounts.systemProgram),
      getAccountMeta(accounts.associatedTokenProgram),
      getAccountMeta(accounts.tokenInMint),
      getAccountMeta(accounts.userTokenInAccount),
      getAccountMeta(accounts.guardTokenInAccount),
      getAccountMeta(accounts.tokenInProgram),
    ],
    programAddress,
    data: getCreateDcaOrderInstructionDataEncoder().encode(args as CreateDcaOrderInstructionDataArgs),
  } as CreateDcaOrderInstruction<
    TProgramAddress,
    TAccountUser,
    TAccountOrder,
    TAccountGuard,
    TAccountSystemProgram,
    TAccountAssociatedTokenProgram,
    TAccountTokenInMint,
    TAccountUserTokenInAccount,
    TAccountGuardTokenInAccount,
    TAccountTokenInProgram
  >;

  return instruction;
}

export type ParsedCreateDcaOrderInstruction<
  TProgram extends string = typeof SINGLE_CHAIN_GUARD_PROGRAM_ADDRESS,
  TAccountMetas extends readonly IAccountMeta[] = readonly IAccountMeta[],
> = {
  programAddress: Address<TProgram>;
  accounts: {
    /** User creating the DCA order */
    user: TAccountMetas[0];
    /** Account that will store DCA order data */
    order: TAccountMetas[1];
    /** Guard address, that will protect this order execution */
    guard: TAccountMetas[2];
    /** Solana System program */
    systemProgram: TAccountMetas[3];
    /** Solana token program */
    associatedTokenProgram: TAccountMetas[4];
    /** Token IN that user wants to spend */
    tokenInMint: TAccountMetas[5];
    /** Token IN account from which user is spending tokens IN */
    userTokenInAccount: TAccountMetas[6];
    /** Token IN account that will store Tokens IN after DCA order creation */
    guardTokenInAccount: TAccountMetas[7];
    /** Solana token program */
    tokenInProgram: TAccountMetas[8];
  };
  data: CreateDcaOrderInstructionData;
};

export function parseCreateDcaOrderInstruction<TProgram extends string, TAccountMetas extends readonly IAccountMeta[]>(
  instruction: IInstruction<TProgram> & IInstructionWithAccounts<TAccountMetas> & IInstructionWithData<Uint8Array>,
): ParsedCreateDcaOrderInstruction<TProgram, TAccountMetas> {
  if (instruction.accounts.length < 9) {
    // TODO: Coded error.
    throw new Error('Not enough accounts');
  }
  let accountIndex = 0;
  const getNextAccount = () => {
    const accountMeta = instruction.accounts![accountIndex]!;
    accountIndex += 1;
    return accountMeta;
  };
  return {
    programAddress: instruction.programAddress,
    accounts: {
      user: getNextAccount(),
      order: getNextAccount(),
      guard: getNextAccount(),
      systemProgram: getNextAccount(),
      associatedTokenProgram: getNextAccount(),
      tokenInMint: getNextAccount(),
      userTokenInAccount: getNextAccount(),
      guardTokenInAccount: getNextAccount(),
      tokenInProgram: getNextAccount(),
    },
    data: getCreateDcaOrderInstructionDataDecoder().decode(instruction.data),
  };
}