@chainlink/ccip-sdk 1.2.1 → 1.3.1

package/src/ton/index.ts

@@ -1,26 +1,38 @@
 import { Buffer } from 'buffer'
 
-import { type Transaction, Address, Cell, beginCell, toNano } from '@ton/core'
+import {
+  type Transaction,
+  Address,
+  BitReader,
+  BitString,
+  Cell,
+  Slice,
+  beginCell,
+  toNano,
+} from '@ton/core'
 import { TonClient } from '@ton/ton'
 import { type AxiosAdapter, getAdapter } from 'axios'
 import {
   type BytesLike,
-  concat,
-  dataLength,
   dataSlice,
   hexlify,
   isBytesLike,
   isHexString,
   toBeArray,
   toBeHex,
-  toBigInt,
 } from 'ethers'
 import { type Memoized, memoize } from 'micro-memoize'
 import type { PickDeep } from 'type-fest'
 
 import { streamTransactionsForAddress } from './logs.ts'
-import { generateUnsignedCcipSend, getFee as getFeeImpl } from './send.ts'
-import { type ChainContext, type GetBalanceOpts, type LogFilter, Chain } from '../chain.ts'
+import { encodeExtraArgsCell, generateUnsignedCcipSend, getFee as getFeeImpl } from './send.ts'
+import {
+  type ChainContext,
+  type GetBalanceOpts,
+  type LogFilter,
+  type TokenTransferFeeOpts,
+  Chain,
+} from '../chain.ts'
 import {
   CCIPArgumentInvalidError,
   CCIPExecutionReportChainMismatchError,
@@ -56,7 +68,6 @@ import {
   bytesToBuffer,
   createRateLimitedFetch,
   decodeAddress,
-  getDataBytes,
   networkInfo,
   parseTypeAndVersion,
   sleep,
@@ -76,16 +87,6 @@ function isTvmError(error: unknown): error is Error & { exitCode: number } {
   return error instanceof Error && 'exitCode' in error && typeof error.exitCode === 'number'
 }
 
-function bitsToBytes(bits: string): Uint8Array {
-  return Uint8Array.from(bits.match(/.{1,8}/g)!.map((byte) => parseInt(byte.padEnd(8, '0'), 2)))
-}
-
-function bytesToBits(bytes: Uint8Array): string {
-  return Array.from(bytes)
-    .map((B) => B.toString(2).padStart(8, '0'))
-    .join('')
-}
-
 /**
  * TON chain implementation supporting TON networks.
  *
@@ -668,24 +669,14 @@ export class TONChain extends Chain<typeof ChainFamily.TON> {
 
       // Load extraArgs from ref 2
       const extraArgsCell = bodySlice.loadRef()
-      const extraArgsSlice = extraArgsCell.beginParse()
-
-      // Read tag (32 bits)
-      const extraArgsTag = extraArgsSlice.loadUint(32)
-      if (extraArgsTag !== Number(EVMExtraArgsV2Tag)) return undefined
-
-      // Read gasLimit (maybe uint256): 1 bit flag + 256 bits if present
-      const hasGasLimit = extraArgsSlice.loadBit()
-      const gasLimit = hasGasLimit ? extraArgsSlice.loadUintBig(256) : 0n
-
-      // Read allowOutOfOrderExecution (1 bit)
-      const allowOutOfOrderExecution = extraArgsSlice.loadBit()
 
       // Build extraArgs as raw hex matching reference format
-      const extraArgs = '0x' + extraArgsCell.toBoc().toString('hex')
+      const extraArgs = '0x' + extraArgsCell.bits.toString().toLowerCase().replace('_', '0')
+      const parsed = this.decodeExtraArgs(extraArgs)
+      if (!parsed) return
+      const { _tag, ...extraArgsObj } = parsed
 
       // Load tokenAmounts from ref 3
-      const _tokenAmountsCell = bodySlice.loadRef()
       const tokenAmounts: CCIPMessage_V1_6_EVM['tokenAmounts'] = [] // TODO: FIXME: parse when implemented
 
       // Load feeToken (inline address in body)
@@ -704,8 +695,7 @@ export class TONChain extends Chain<typeof ChainFamily.TON> {
         feeTokenAmount,
         feeValueJuels,
         extraArgs,
-        gasLimit,
-        allowOutOfOrderExecution,
+        ...extraArgsObj,
       }
     } catch {
       return undefined
@@ -723,17 +713,8 @@ export class TONChain extends Chain<typeof ChainFamily.TON> {
    * @returns Hex string of BOC-encoded extra args (0x-prefixed)
    */
   static encodeExtraArgs(args: ExtraArgs): string {
-    if ('gasLimit' in args && 'allowOutOfOrderExecution' in args) {
-      return concat([
-        EVMExtraArgsV2Tag,
-        bitsToBytes(
-          '1' +
-            bytesToBits(toBeArray(args.gasLimit, 32)) +
-            (args.allowOutOfOrderExecution ? '1' : '0'),
-        ),
-      ])
-    }
-    return '0x'
+    const cell = encodeExtraArgsCell(args)
+    return '0x' + cell.bits.toString().toLowerCase().replace('_', '0')
   }
 
   /**
@@ -751,19 +732,23 @@ export class TONChain extends Chain<typeof ChainFamily.TON> {
   static decodeExtraArgs(
     extraArgs: BytesLike,
   ): (EVMExtraArgsV2 & { _tag: 'EVMExtraArgsV2' }) | undefined {
-    if (dataSlice(extraArgs, 0, 4) !== EVMExtraArgsV2Tag || dataLength(extraArgs) < 5) return
-    const data = getDataBytes(extraArgs).subarray(4)
-    let bits = bytesToBits(data)
-    let gasLimit = 0n
-    if (bits[0] === '1') {
-      if (bits.length < 1 + 32 * 8) return
-      gasLimit = toBigInt(bitsToBytes(bits.substring(1, 1 + 32 * 8)))
-      bits = bits.substring(1 + 32 * 8)
-    } else {
-      bits = bits.substring(1)
+    let bytes
+    try {
+      bytes = bytesToBuffer(extraArgs)
+
+      // If the data is BOC-wrapped (starts with TON BOC magic 0xb5ee9c72), extract bits
+      if (dataSlice(bytes, 0, 4) !== EVMExtraArgsV2Tag) {
+        const cell = Cell.fromBoc(bytes)[0]!
+        bytes = bytesToBuffer('0x' + cell.bits.toString().toLowerCase().replace('_', '0'))
+      }
+      if (dataSlice(bytes, 0, 4) !== EVMExtraArgsV2Tag) return
+    } catch {
+      return
     }
 
-    const allowOutOfOrderExecution = bits[0] === '1'
+    const slice = new Slice(new BitReader(new BitString(bytes, 32, bytes.length * 8)), [])
+    const gasLimit = slice.loadMaybeUintBig(256) ?? 0n
+    const allowOutOfOrderExecution = slice.loadBit()
 
     return {
       _tag: 'EVMExtraArgsV2',
@@ -1226,7 +1211,7 @@ export class TONChain extends Chain<typeof ChainFamily.TON> {
    * {@inheritDoc Chain.getTokenPoolConfig}
    * @throws {@link CCIPNotImplementedError} always (not implemented for TON)
    */
-  async getTokenPoolConfig(_tokenPool: string): Promise<never> {
+  async getTokenPoolConfig(_tokenPool: string, _feeOpts?: TokenTransferFeeOpts): Promise<never> {
     return Promise.reject(new CCIPNotImplementedError('getTokenPoolConfig'))
   }
 

package/src/ton/send.ts

@@ -3,10 +3,10 @@ import { type TonClient, Address } from '@ton/ton'
 import { zeroPadValue } from 'ethers'
 
 import type { UnsignedTONTx } from './types.ts'
-import { CCIPError, CCIPErrorCode } from '../errors/index.ts'
-import { EVMExtraArgsV2Tag } from '../extra-args.ts'
-import type { AnyMessage, WithLogger } from '../types.ts'
-import { bytesToBuffer, getDataBytes } from '../utils.ts'
+import { CCIPError, CCIPErrorCode, CCIPExtraArgsInvalidError } from '../errors/index.ts'
+import { type ExtraArgs, EVMExtraArgsV2Tag } from '../extra-args.ts'
+import { type AnyMessage, type WithLogger, ChainFamily } from '../types.ts'
+import { bigIntReplacer, bytesToBuffer, getDataBytes } from '../utils.ts'
 
 /** Opcode for Router ccipSend operation */
 export const CCIP_SEND_OPCODE = 0x31768d95
@@ -51,28 +51,27 @@ function encodeTokenAmounts(
  * Format per chainlink-ton TL-B:
  * - tag: 32-bit opcode (0x181dcf10)
  * - gasLimit: Maybe<uint256> (1 bit flag + 256 bits if present)
- * - allowOutOfOrderExecution: 1 bit (must be true)
+ * - allowOutOfOrderExecution: 1 bit
+ * @param extraArgs - Extra arguments for CCIP message
+ * @returns Cell encoding the extra arguments
  */
-function encodeExtraArgsCell(extraArgs: AnyMessage['extraArgs']): Cell {
-  const allowOutOfOrderExecution = true
-
-  let gasLimit = 0n
-  let hasGasLimit = false
-
-  if ('gasLimit' in extraArgs && extraArgs.gasLimit > 0n) {
-    hasGasLimit = true
+export function encodeExtraArgsCell(extraArgs: ExtraArgs): Cell {
+  if (
+    Object.keys(extraArgs).filter((k) => k !== '_tag').length !== 2 ||
+    !('gasLimit' in extraArgs && 'allowOutOfOrderExecution' in extraArgs)
+  )
+    throw new CCIPExtraArgsInvalidError(ChainFamily.TON, JSON.stringify(extraArgs, bigIntReplacer))
+
+  let gasLimit: bigint | null = null
+  if (extraArgs.gasLimit > 0n) {
     gasLimit = extraArgs.gasLimit
   }
 
-  const builder = beginCell()
-    .storeUint(Number(EVMExtraArgsV2Tag), 32) // 0x181dcf10
-    .storeBit(hasGasLimit)
-
-  if (hasGasLimit) {
-    builder.storeUint(gasLimit, 256)
-  }
+  const builder = beginCell().storeUint(Number(EVMExtraArgsV2Tag), 32) // 0x181dcf10
+  builder.storeMaybeUint(gasLimit, 256)
+  builder.storeBit(extraArgs.allowOutOfOrderExecution)
 
-  return builder.storeBit(allowOutOfOrderExecution).endCell()
+  return builder.endCell()
 }
 
 /**

package/src/types.ts

@@ -470,7 +470,7 @@ export type AnyMessage = {
  * }
  * ```
  */
-export type MessageInput = Partial<AnyMessage> & {
+export type MessageInput = Partial<Omit<AnyMessage, 'extraArgs'>> & {
   receiver: AnyMessage['receiver']
   extraArgs?: Partial<ExtraArgs>
   fee?: bigint

package/src/utils.ts

@@ -16,12 +16,14 @@ import yaml from 'yaml'
 
 import type { Chain, ChainStatic } from './chain.ts'
 import {
+  CCIPAbortError,
   CCIPBlockBeforeTimestampNotFoundError,
   CCIPChainFamilyUnsupportedError,
   CCIPChainNotFoundError,
   CCIPDataFormatUnsupportedError,
   CCIPError,
   CCIPHttpError,
+  CCIPTimeoutError,
   CCIPTypeVersionInvalidError,
   HttpStatus,
 } from './errors/index.ts'
@@ -614,9 +616,8 @@ export function parseTypeAndVersion(
 ): Awaited<ReturnType<Chain['typeAndVersion']>> {
   const match = typeAndVersion.match(/^(\w.+\S)\s+v?(\d+\.\d+(?:\.\d+)?)([^\d.].*)?$/)
   if (!match) throw new CCIPTypeVersionInvalidError(typeAndVersion)
-  const [, typeRaw, version] = match
   // some string normalization
-  const type = typeRaw!
+  const type = match[1]!
     .replaceAll(/-(\w)/g, (_, w: string) => w.toUpperCase()) // kebabToPascal
     .replace(/ccip/gi, 'CCIP')
     .replace(
@@ -624,8 +625,15 @@ export function parseTypeAndVersion(
       (_, o: string, n: string, ramp: string) =>
         `${o.toUpperCase()}${n.toLowerCase()}${ramp.charAt(0).toUpperCase()}${ramp.slice(1).toLowerCase()}`,
     ) // ccipOfframp -> CCIPOffRamp
-  if (!match[3]) return [type, version!, typeAndVersion]
-  else return [type, version!, typeAndVersion, match[3]]
+    .replace('router', 'Router') // ccip-router -> CCIPRouter
+
+  let version = match[2]!
+  // for core contracts, always use patch `.0`, to match CCIPVersion
+  if (type.match(/((o(n|ff)ramp)|router)\b/gi))
+    version = version.replace(/^(\d+\.\d+)(?:\.\d+)?$/, '$1.0')
+
+  if (!match[3]) return [type, version, typeAndVersion]
+  else return [type, version, typeAndVersion, match[3]]
 }
 
 /* eslint-disable jsdoc/require-jsdoc */
@@ -815,6 +823,46 @@ export function createRateLimitedFetch(
   }
 }
 
+/**
+ * Performs a fetch request with timeout and abort signal support.
+ *
+ * @param url - URL to fetch
+ * @param operation - Operation name for error context
+ * @param opts - Optional timeout, abort signal, fetch function, and extra RequestInit fields
+ * @returns Promise resolving to Response
+ * @throws CCIPTimeoutError if request times out
+ * @throws CCIPAbortError if request is aborted via signal
+ */
+export async function fetchWithTimeout(
+  url: string,
+  operation: string,
+  opts?: {
+    timeoutMs?: number
+    signal?: AbortSignal
+    fetch?: typeof globalThis.fetch
+    init?: RequestInit
+  },
+): Promise<Response> {
+  const timeoutMs = opts?.timeoutMs ?? 30_000
+  const fetchFn = opts?.fetch ?? globalThis.fetch.bind(globalThis)
+  const timeoutSignal = AbortSignal.timeout(timeoutMs)
+  const combinedSignal = opts?.signal
+    ? AbortSignal.any([timeoutSignal, opts.signal])
+    : timeoutSignal
+
+  try {
+    return await fetchFn(url, { ...opts?.init, signal: combinedSignal })
+  } catch (error) {
+    if (error instanceof Error && (error.name === 'AbortError' || error.name === 'TimeoutError')) {
+      if (opts?.signal?.aborted) {
+        throw new CCIPAbortError(operation)
+      }
+      throw new CCIPTimeoutError(operation, timeoutMs)
+    }
+    throw error
+  }
+}
+
 // barebones `node:util` backfill, if needed
 const util =
   'util' in globalThis