@xswap-link/sdk 0.10.8 → 0.10.9

package/src/services/svm/bindings/errors/custom.ts

@@ -0,0 +1,375 @@
+export type CustomError =
+  | Unauthorized
+  | InvalidRMNRemoteAddress
+  | InvalidInputsMint
+  | InvalidVersion
+  | FeeTokenMismatch
+  | RedundantOwnerProposal
+  | ReachedMaxSequenceNumber
+  | InvalidInputsTokenIndices
+  | InvalidInputsPoolAccounts
+  | InvalidInputsTokenAccounts
+  | InvalidInputsTokenAdminRegistryAccounts
+  | InvalidInputsLookupTableAccounts
+  | InvalidInputsLookupTableAccountWritable
+  | InvalidInputsTokenAmount
+  | InvalidInputsTransferAllAmount
+  | InvalidInputsAtaAddress
+  | InvalidInputsAtaWritable
+  | InvalidInputsChainSelector
+  | InsufficientLamports
+  | InsufficientFunds
+  | SourceTokenDataTooLarge
+  | InvalidTokenAdminRegistryInputsZeroAddress
+  | InvalidTokenAdminRegistryProposedAdmin
+  | SenderNotAllowed
+  | InvalidCodeVersion
+  | InvalidCcipVersionRollback
+
+export class Unauthorized extends Error {
+  static readonly code = 7000
+  readonly code = 7000
+  readonly name = "Unauthorized"
+  readonly msg = "The signer is unauthorized"
+
+  constructor(readonly logs?: string[]) {
+    super("7000: The signer is unauthorized")
+  }
+}
+
+export class InvalidRMNRemoteAddress extends Error {
+  static readonly code = 7001
+  readonly code = 7001
+  readonly name = "InvalidRMNRemoteAddress"
+  readonly msg = "Invalid RMN Remote Address"
+
+  constructor(readonly logs?: string[]) {
+    super("7001: Invalid RMN Remote Address")
+  }
+}
+
+export class InvalidInputsMint extends Error {
+  static readonly code = 7002
+  readonly code = 7002
+  readonly name = "InvalidInputsMint"
+  readonly msg = "Mint account input is invalid"
+
+  constructor(readonly logs?: string[]) {
+    super("7002: Mint account input is invalid")
+  }
+}
+
+export class InvalidVersion extends Error {
+  static readonly code = 7003
+  readonly code = 7003
+  readonly name = "InvalidVersion"
+  readonly msg = "Invalid version of the onchain state"
+
+  constructor(readonly logs?: string[]) {
+    super("7003: Invalid version of the onchain state")
+  }
+}
+
+export class FeeTokenMismatch extends Error {
+  static readonly code = 7004
+  readonly code = 7004
+  readonly name = "FeeTokenMismatch"
+  readonly msg = "Fee token doesn't match transfer token"
+
+  constructor(readonly logs?: string[]) {
+    super("7004: Fee token doesn't match transfer token")
+  }
+}
+
+export class RedundantOwnerProposal extends Error {
+  static readonly code = 7005
+  readonly code = 7005
+  readonly name = "RedundantOwnerProposal"
+  readonly msg = "Proposed owner is the current owner"
+
+  constructor(readonly logs?: string[]) {
+    super("7005: Proposed owner is the current owner")
+  }
+}
+
+export class ReachedMaxSequenceNumber extends Error {
+  static readonly code = 7006
+  readonly code = 7006
+  readonly name = "ReachedMaxSequenceNumber"
+  readonly msg = "Reached max sequence number"
+
+  constructor(readonly logs?: string[]) {
+    super("7006: Reached max sequence number")
+  }
+}
+
+export class InvalidInputsTokenIndices extends Error {
+  static readonly code = 7007
+  readonly code = 7007
+  readonly name = "InvalidInputsTokenIndices"
+  readonly msg = "Invalid pool account account indices"
+
+  constructor(readonly logs?: string[]) {
+    super("7007: Invalid pool account account indices")
+  }
+}
+
+export class InvalidInputsPoolAccounts extends Error {
+  static readonly code = 7008
+  readonly code = 7008
+  readonly name = "InvalidInputsPoolAccounts"
+  readonly msg = "Invalid pool accounts"
+
+  constructor(readonly logs?: string[]) {
+    super("7008: Invalid pool accounts")
+  }
+}
+
+export class InvalidInputsTokenAccounts extends Error {
+  static readonly code = 7009
+  readonly code = 7009
+  readonly name = "InvalidInputsTokenAccounts"
+  readonly msg = "Invalid token accounts"
+
+  constructor(readonly logs?: string[]) {
+    super("7009: Invalid token accounts")
+  }
+}
+
+export class InvalidInputsTokenAdminRegistryAccounts extends Error {
+  static readonly code = 7010
+  readonly code = 7010
+  readonly name = "InvalidInputsTokenAdminRegistryAccounts"
+  readonly msg = "Invalid Token Admin Registry account"
+
+  constructor(readonly logs?: string[]) {
+    super("7010: Invalid Token Admin Registry account")
+  }
+}
+
+export class InvalidInputsLookupTableAccounts extends Error {
+  static readonly code = 7011
+  readonly code = 7011
+  readonly name = "InvalidInputsLookupTableAccounts"
+  readonly msg = "Invalid LookupTable account"
+
+  constructor(readonly logs?: string[]) {
+    super("7011: Invalid LookupTable account")
+  }
+}
+
+export class InvalidInputsLookupTableAccountWritable extends Error {
+  static readonly code = 7012
+  readonly code = 7012
+  readonly name = "InvalidInputsLookupTableAccountWritable"
+  readonly msg = "Invalid LookupTable account writable access"
+
+  constructor(readonly logs?: string[]) {
+    super("7012: Invalid LookupTable account writable access")
+  }
+}
+
+export class InvalidInputsTokenAmount extends Error {
+  static readonly code = 7013
+  readonly code = 7013
+  readonly name = "InvalidInputsTokenAmount"
+  readonly msg = "Cannot send zero tokens"
+
+  constructor(readonly logs?: string[]) {
+    super("7013: Cannot send zero tokens")
+  }
+}
+
+export class InvalidInputsTransferAllAmount extends Error {
+  static readonly code = 7014
+  readonly code = 7014
+  readonly name = "InvalidInputsTransferAllAmount"
+  readonly msg = "Must specify zero amount to send alongside transfer_all"
+
+  constructor(readonly logs?: string[]) {
+    super("7014: Must specify zero amount to send alongside transfer_all")
+  }
+}
+
+export class InvalidInputsAtaAddress extends Error {
+  static readonly code = 7015
+  readonly code = 7015
+  readonly name = "InvalidInputsAtaAddress"
+  readonly msg = "Invalid Associated Token Account address"
+
+  constructor(readonly logs?: string[]) {
+    super("7015: Invalid Associated Token Account address")
+  }
+}
+
+export class InvalidInputsAtaWritable extends Error {
+  static readonly code = 7016
+  readonly code = 7016
+  readonly name = "InvalidInputsAtaWritable"
+  readonly msg = "Invalid Associated Token Account writable flag"
+
+  constructor(readonly logs?: string[]) {
+    super("7016: Invalid Associated Token Account writable flag")
+  }
+}
+
+export class InvalidInputsChainSelector extends Error {
+  static readonly code = 7017
+  readonly code = 7017
+  readonly name = "InvalidInputsChainSelector"
+  readonly msg = "Chain selector is invalid"
+
+  constructor(readonly logs?: string[]) {
+    super("7017: Chain selector is invalid")
+  }
+}
+
+export class InsufficientLamports extends Error {
+  static readonly code = 7018
+  readonly code = 7018
+  readonly name = "InsufficientLamports"
+  readonly msg = "Insufficient lamports"
+
+  constructor(readonly logs?: string[]) {
+    super("7018: Insufficient lamports")
+  }
+}
+
+export class InsufficientFunds extends Error {
+  static readonly code = 7019
+  readonly code = 7019
+  readonly name = "InsufficientFunds"
+  readonly msg = "Insufficient funds"
+
+  constructor(readonly logs?: string[]) {
+    super("7019: Insufficient funds")
+  }
+}
+
+export class SourceTokenDataTooLarge extends Error {
+  static readonly code = 7020
+  readonly code = 7020
+  readonly name = "SourceTokenDataTooLarge"
+  readonly msg = "Source token data is too large"
+
+  constructor(readonly logs?: string[]) {
+    super("7020: Source token data is too large")
+  }
+}
+
+export class InvalidTokenAdminRegistryInputsZeroAddress extends Error {
+  static readonly code = 7021
+  readonly code = 7021
+  readonly name = "InvalidTokenAdminRegistryInputsZeroAddress"
+  readonly msg = "New Admin can not be zero address"
+
+  constructor(readonly logs?: string[]) {
+    super("7021: New Admin can not be zero address")
+  }
+}
+
+export class InvalidTokenAdminRegistryProposedAdmin extends Error {
+  static readonly code = 7022
+  readonly code = 7022
+  readonly name = "InvalidTokenAdminRegistryProposedAdmin"
+  readonly msg = "An already owned registry can not be proposed"
+
+  constructor(readonly logs?: string[]) {
+    super("7022: An already owned registry can not be proposed")
+  }
+}
+
+export class SenderNotAllowed extends Error {
+  static readonly code = 7023
+  readonly code = 7023
+  readonly name = "SenderNotAllowed"
+  readonly msg = "Sender not allowed for that destination chain"
+
+  constructor(readonly logs?: string[]) {
+    super("7023: Sender not allowed for that destination chain")
+  }
+}
+
+export class InvalidCodeVersion extends Error {
+  static readonly code = 7024
+  readonly code = 7024
+  readonly name = "InvalidCodeVersion"
+  readonly msg = "Invalid code version"
+
+  constructor(readonly logs?: string[]) {
+    super("7024: Invalid code version")
+  }
+}
+
+export class InvalidCcipVersionRollback extends Error {
+  static readonly code = 7025
+  readonly code = 7025
+  readonly name = "InvalidCcipVersionRollback"
+  readonly msg =
+    "Invalid rollback attempt on the CCIP version of the onramp to the destination chain"
+
+  constructor(readonly logs?: string[]) {
+    super(
+      "7025: Invalid rollback attempt on the CCIP version of the onramp to the destination chain"
+    )
+  }
+}
+
+export function fromCode(code: number, logs?: string[]): CustomError | null {
+  switch (code) {
+    case 7000:
+      return new Unauthorized(logs)
+    case 7001:
+      return new InvalidRMNRemoteAddress(logs)
+    case 7002:
+      return new InvalidInputsMint(logs)
+    case 7003:
+      return new InvalidVersion(logs)
+    case 7004:
+      return new FeeTokenMismatch(logs)
+    case 7005:
+      return new RedundantOwnerProposal(logs)
+    case 7006:
+      return new ReachedMaxSequenceNumber(logs)
+    case 7007:
+      return new InvalidInputsTokenIndices(logs)
+    case 7008:
+      return new InvalidInputsPoolAccounts(logs)
+    case 7009:
+      return new InvalidInputsTokenAccounts(logs)
+    case 7010:
+      return new InvalidInputsTokenAdminRegistryAccounts(logs)
+    case 7011:
+      return new InvalidInputsLookupTableAccounts(logs)
+    case 7012:
+      return new InvalidInputsLookupTableAccountWritable(logs)
+    case 7013:
+      return new InvalidInputsTokenAmount(logs)
+    case 7014:
+      return new InvalidInputsTransferAllAmount(logs)
+    case 7015:
+      return new InvalidInputsAtaAddress(logs)
+    case 7016:
+      return new InvalidInputsAtaWritable(logs)
+    case 7017:
+      return new InvalidInputsChainSelector(logs)
+    case 7018:
+      return new InsufficientLamports(logs)
+    case 7019:
+      return new InsufficientFunds(logs)
+    case 7020:
+      return new SourceTokenDataTooLarge(logs)
+    case 7021:
+      return new InvalidTokenAdminRegistryInputsZeroAddress(logs)
+    case 7022:
+      return new InvalidTokenAdminRegistryProposedAdmin(logs)
+    case 7023:
+      return new SenderNotAllowed(logs)
+    case 7024:
+      return new InvalidCodeVersion(logs)
+    case 7025:
+      return new InvalidCcipVersionRollback(logs)
+  }
+
+  return null
+}

package/src/services/svm/bindings/errors/index.ts

@@ -0,0 +1,62 @@
+import { PublicKey } from "@solana/web3.js"
+import { PROGRAM_ID } from "../programId"
+import * as anchor from "./anchor"
+import * as custom from "./custom"
+
+export function fromCode(
+  code: number,
+  logs?: string[]
+): custom.CustomError | anchor.AnchorError | null {
+  return code >= 6000
+    ? custom.fromCode(code, logs)
+    : anchor.fromCode(code, logs)
+}
+
+function hasOwnProperty<X extends object, Y extends PropertyKey>(
+  obj: X,
+  prop: Y
+): obj is X & Record<Y, unknown> {
+  return Object.hasOwnProperty.call(obj, prop)
+}
+
+const errorRe = /Program (\w+) failed: custom program error: (\w+)/
+
+export function fromTxError(
+  err: unknown,
+  programId: PublicKey = PROGRAM_ID
+): custom.CustomError | anchor.AnchorError | null {
+  if (
+    typeof err !== "object" ||
+    err === null ||
+    !hasOwnProperty(err, "logs") ||
+    !Array.isArray(err.logs)
+  ) {
+    return null
+  }
+
+  let firstMatch: RegExpExecArray | null = null
+  for (const logLine of err.logs) {
+    firstMatch = errorRe.exec(logLine)
+    if (firstMatch !== null) {
+      break
+    }
+  }
+
+  if (firstMatch === null) {
+    return null
+  }
+
+  const [programIdRaw, codeRaw] = firstMatch.slice(1)
+  if (programIdRaw !== programId.toString()) {
+    return null
+  }
+
+  let errorCode: number
+  try {
+    errorCode = parseInt(codeRaw, 16)
+  } catch (parseErr) {
+    return null
+  }
+
+  return fromCode(errorCode, err.logs)
+}

package/src/services/svm/bindings/instructions/ccipSend.ts

@@ -0,0 +1,112 @@
+import { TransactionInstruction, PublicKey, AccountMeta } from "@solana/web3.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import BN from "bn.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as borsh from "@coral-xyz/borsh" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as types from "../types" // eslint-disable-line @typescript-eslint/no-unused-vars
+import { PROGRAM_ID } from "../programId"
+
+export interface CcipSendArgs {
+  destChainSelector: BN
+  message: types.SVM2AnyMessageFields
+  tokenIndexes: Uint8Array
+}
+
+export interface CcipSendAccounts {
+  config: PublicKey
+  destChainState: PublicKey
+  nonce: PublicKey
+  authority: PublicKey
+  systemProgram: PublicKey
+  feeTokenProgram: PublicKey
+  feeTokenMint: PublicKey
+  /** If paying with native SOL, this must be the zero address. */
+  feeTokenUserAssociatedAccount: PublicKey
+  feeTokenReceiver: PublicKey
+  feeBillingSigner: PublicKey
+  feeQuoter: PublicKey
+  feeQuoterConfig: PublicKey
+  feeQuoterDestChain: PublicKey
+  feeQuoterBillingTokenConfig: PublicKey
+  feeQuoterLinkTokenConfig: PublicKey
+  rmnRemote: PublicKey
+  rmnRemoteCurses: PublicKey
+  rmnRemoteConfig: PublicKey
+}
+
+export const layout = borsh.struct([
+  borsh.u64("destChainSelector"),
+  types.SVM2AnyMessage.layout("message"),
+  borsh.vecU8("tokenIndexes"),
+])
+
+/**
+ * On Ramp Flow //
+ * Sends a message to the destination chain.
+ *
+ * Request a message to be sent to the destination chain.
+ * The method name needs to be ccip_send with Anchor encoding.
+ * This function is called by the CCIP Sender Contract (or final user) to send a message to the CCIP Router.
+ * The message will be sent to the receiver on the destination chain selector.
+ * This message emits the event CCIPMessageSent with all the necessary data to be retrieved by the OffChain Code
+ *
+ * # Arguments
+ *
+ * * `ctx` - The context containing the accounts required for sending the message.
+ * * `dest_chain_selector` - The chain selector for the destination chain.
+ * * `message` - The message to be sent. The size limit of data is 256 bytes.
+ * * `token_indexes` - Indices into the remaining accounts vector where the subslice for a token begins.
+ */
+export function ccipSend(
+  args: CcipSendArgs,
+  accounts: CcipSendAccounts,
+  programId: PublicKey = PROGRAM_ID
+) {
+  const keys: Array<AccountMeta> = [
+    { pubkey: accounts.config, isSigner: false, isWritable: false },
+    { pubkey: accounts.destChainState, isSigner: false, isWritable: true },
+    { pubkey: accounts.nonce, isSigner: false, isWritable: true },
+    { pubkey: accounts.authority, isSigner: true, isWritable: true },
+    { pubkey: accounts.systemProgram, isSigner: false, isWritable: false },
+    { pubkey: accounts.feeTokenProgram, isSigner: false, isWritable: false },
+    { pubkey: accounts.feeTokenMint, isSigner: false, isWritable: false },
+    {
+      pubkey: accounts.feeTokenUserAssociatedAccount,
+      isSigner: false,
+      isWritable: false,
+    },
+    { pubkey: accounts.feeTokenReceiver, isSigner: false, isWritable: true },
+    { pubkey: accounts.feeBillingSigner, isSigner: false, isWritable: false },
+    { pubkey: accounts.feeQuoter, isSigner: false, isWritable: false },
+    { pubkey: accounts.feeQuoterConfig, isSigner: false, isWritable: false },
+    { pubkey: accounts.feeQuoterDestChain, isSigner: false, isWritable: false },
+    {
+      pubkey: accounts.feeQuoterBillingTokenConfig,
+      isSigner: false,
+      isWritable: false,
+    },
+    {
+      pubkey: accounts.feeQuoterLinkTokenConfig,
+      isSigner: false,
+      isWritable: false,
+    },
+    { pubkey: accounts.rmnRemote, isSigner: false, isWritable: false },
+    { pubkey: accounts.rmnRemoteCurses, isSigner: false, isWritable: false },
+    { pubkey: accounts.rmnRemoteConfig, isSigner: false, isWritable: false },
+  ]
+  const identifier = Buffer.from([108, 216, 134, 191, 249, 234, 33, 84])
+  const buffer = Buffer.alloc(1000)
+  const len = layout.encode(
+    {
+      destChainSelector: args.destChainSelector,
+      message: types.SVM2AnyMessage.toEncodable(args.message),
+      tokenIndexes: Buffer.from(
+        args.tokenIndexes.buffer,
+        args.tokenIndexes.byteOffset,
+        args.tokenIndexes.length
+      ),
+    },
+    buffer
+  )
+  const data = Buffer.concat([identifier, buffer]).slice(0, 8 + len)
+  const ix = new TransactionInstruction({ keys, programId, data })
+  return ix
+}

package/src/services/svm/bindings/instructions/getFee.ts

@@ -0,0 +1,73 @@
+import { TransactionInstruction, PublicKey, AccountMeta } from "@solana/web3.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import BN from "bn.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as borsh from "@coral-xyz/borsh" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as types from "../types" // eslint-disable-line @typescript-eslint/no-unused-vars
+import { PROGRAM_ID } from "../programId"
+
+export interface GetFeeArgs {
+  destChainSelector: BN
+  message: types.SVM2AnyMessageFields
+}
+
+export interface GetFeeAccounts {
+  config: PublicKey
+  destChainState: PublicKey
+  feeQuoter: PublicKey
+  feeQuoterConfig: PublicKey
+  feeQuoterDestChain: PublicKey
+  feeQuoterBillingTokenConfig: PublicKey
+  feeQuoterLinkTokenConfig: PublicKey
+}
+
+export const layout = borsh.struct([
+  borsh.u64("destChainSelector"),
+  types.SVM2AnyMessage.layout("message"),
+])
+
+/**
+ * Queries the onramp for the fee required to send a message.
+ *
+ * This call is permissionless. Note it does not verify whether there's a curse active
+ * in order to avoid the RMN CPI overhead.
+ *
+ * # Arguments
+ *
+ * * `ctx` - The context containing the accounts required for obtaining the message fee.
+ * * `dest_chain_selector` - The chain selector for the destination chain.
+ * * `message` - The message to be sent. The size limit of data is 256 bytes.
+ */
+export function getFee(
+  args: GetFeeArgs,
+  accounts: GetFeeAccounts,
+  programId: PublicKey = PROGRAM_ID
+) {
+  const keys: Array<AccountMeta> = [
+    { pubkey: accounts.config, isSigner: false, isWritable: false },
+    { pubkey: accounts.destChainState, isSigner: false, isWritable: false },
+    { pubkey: accounts.feeQuoter, isSigner: false, isWritable: false },
+    { pubkey: accounts.feeQuoterConfig, isSigner: false, isWritable: false },
+    { pubkey: accounts.feeQuoterDestChain, isSigner: false, isWritable: false },
+    {
+      pubkey: accounts.feeQuoterBillingTokenConfig,
+      isSigner: false,
+      isWritable: false,
+    },
+    {
+      pubkey: accounts.feeQuoterLinkTokenConfig,
+      isSigner: false,
+      isWritable: false,
+    },
+  ]
+  const identifier = Buffer.from([115, 195, 235, 161, 25, 219, 60, 29])
+  const buffer = Buffer.alloc(1000)
+  const len = layout.encode(
+    {
+      destChainSelector: args.destChainSelector,
+      message: types.SVM2AnyMessage.toEncodable(args.message),
+    },
+    buffer
+  )
+  const data = Buffer.concat([identifier, buffer]).slice(0, 8 + len)
+  const ix = new TransactionInstruction({ keys, programId, data })
+  return ix
+}

package/src/services/svm/bindings/instructions/index.ts

@@ -0,0 +1,4 @@
+export { ccipSend } from "./ccipSend";
+export type { CcipSendArgs, CcipSendAccounts } from "./ccipSend";
+export { getFee } from "./getFee";
+export type { GetFeeArgs, GetFeeAccounts } from "./getFee";

package/src/services/svm/bindings/programId.ts

@@ -0,0 +1,6 @@
+import { PublicKey } from "@solana/web3.js"
+
+// This constant will not get overwritten on subsequent code generations and it's safe to modify it's value.
+export const PROGRAM_ID: PublicKey = new PublicKey(
+  "Ccip8ZTcM2qHjVt8FYHtuCAqjc637yLKnsJ5q5r2e6eL"
+)