@chainlink/ccip-sdk 0.97.0 → 1.0.0

package/src/sui/index.ts

@@ -47,15 +47,14 @@ import {
   type CCIPMessage,
   type CCIPRequest,
   type CCIPVersion,
+  type ChainLog,
   type ChainTransaction,
   type CommitReport,
   type ExecutionInput,
   type ExecutionReceipt,
   type ExecutionState,
   type Lane,
-  type Log_,
   type NetworkInfo,
-  type OffchainTokenData,
   type WithLogger,
   ChainFamily,
 } from '../types.ts'
@@ -181,7 +180,7 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
     })
 
     // Extract events from the transaction
-    const events: Log_[] = []
+    const events: ChainLog[] = []
     if (txResponse.events?.length) {
       for (const [i, event] of txResponse.events.entries()) {
         const eventType = event.type
@@ -576,7 +575,7 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
    * @returns Decoded CCIPMessage or undefined if not valid.
    * @throws {@link CCIPSuiLogInvalidError} if log data format is invalid
    */
-  static decodeMessage(log: Log_): CCIPMessage | undefined {
+  static decodeMessage(log: ChainLog): CCIPMessage | undefined {
     const { data } = log
     if (
       (typeof data !== 'string' || !data.startsWith('{')) &&
@@ -622,7 +621,7 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
    * @returns Array of decoded commit reports or undefined.
    */
   static decodeCommits(
-    { data, topics }: SetOptional<Pick<Log_, 'data' | 'topics'>, 'topics'>,
+    { data, topics }: SetOptional<Pick<ChainLog, 'data' | 'topics'>, 'topics'>,
     lane?: Lane,
   ): CommitReport[] | undefined {
     // Check if this is an CommitReportAccepted event
@@ -658,7 +657,7 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
   static decodeReceipt({
     data,
     topics,
-  }: SetOptional<Pick<Log_, 'data' | 'topics'>, 'topics'>): ExecutionReceipt | undefined {
+  }: SetOptional<Pick<ChainLog, 'data' | 'topics'>, 'topics'>): ExecutionReceipt | undefined {
     // Check if this is an ExecutionStateChanged event
     if (topics?.[0] && topics[0] !== 'ExecutionStateChanged') return
 
@@ -728,12 +727,6 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
     return Promise.reject(new CCIPNotImplementedError('SuiChain.sendMessage'))
   }
 
-  /** {@inheritDoc Chain.getOffchainTokenData} */
-  getOffchainTokenData(request: CCIPRequest): Promise<OffchainTokenData[]> {
-    // default offchain token data
-    return Promise.resolve(request.message.tokenAmounts.map(() => undefined))
-  }
-
   /** {@inheritDoc Chain.generateUnsignedExecute} */
   override generateUnsignedExecute(
     _opts: Parameters<Chain['generateUnsignedExecute']>[0],

package/src/ton/exec.ts

@@ -1,11 +1,8 @@
 import { type Cell, beginCell } from '@ton/core'
 
 import type { ExecutionInput } from '../types.ts'
-import {
-  type CCIPMessage_V1_6_TON,
-  MANUALLY_EXECUTE_OPCODE,
-  serializeExecutionReport,
-} from './types.ts'
+import { MANUALLY_EXECUTE_OPCODE, serializeExecutionReport } from './types.ts'
+import type { CCIPMessage_V1_6_EVM } from '../evm/messages.ts'
 
 /**
  * Generates an unsigned execute report payload for the TON OffRamp contract.
@@ -17,7 +14,7 @@ import {
  */
 export function generateUnsignedExecuteReport(
   offRamp: string,
-  execReport: ExecutionInput<CCIPMessage_V1_6_TON>,
+  execReport: ExecutionInput<CCIPMessage_V1_6_EVM>,
   opts?: { gasLimit?: number },
 ): { to: string; body: Cell } {
   // Serialize the execution report

package/src/ton/index.ts

@@ -29,14 +29,13 @@ import { supportedChains } from '../supported-chains.ts'
 import {
   type CCIPExecution,
   type CCIPRequest,
+  type ChainLog,
   type ChainTransaction,
   type CommitReport,
   type ExecutionInput,
   type ExecutionReceipt,
   type Lane,
-  type Log_,
   type NetworkInfo,
-  type OffchainTokenData,
   type WithLogger,
   CCIPVersion,
   ChainFamily,
@@ -52,8 +51,9 @@ import {
 } from '../utils.ts'
 import { generateUnsignedExecuteReport } from './exec.ts'
 import { getTONLeafHasher } from './hasher.ts'
-import { type CCIPMessage_V1_6_TON, type UnsignedTONTx, isTONWallet } from './types.ts'
+import { type UnsignedTONTx, isTONWallet } from './types.ts'
 import { crc32, lookupTxByRawHash, parseJettonContent } from './utils.ts'
+import type { CCIPMessage_V1_6_EVM } from '../evm/messages.ts'
 export type { TONWallet, UnsignedTONTx } from './types.ts'
 
 /**
@@ -308,13 +308,13 @@ export class TONChain extends Chain<typeof ChainFamily.TON> {
     const compositeHash = `${address.toRawString()}:${tx.lt}:${tx.hash().toString('hex')}`
     const res = {
       hash: compositeHash,
-      logs: [] as Log_[],
+      logs: [] as ChainLog[],
       blockNumber: Number(tx.lt), // Note: This is lt (logical time), not block seqno
       timestamp: tx.now,
       from: address.toRawString(),
       tx,
     }
-    const logs: Log_[] = []
+    const logs: ChainLog[] = []
     for (const [index, msg] of tx.outMessages) {
       if (msg.info.type !== 'external-out') continue
       const topics = []
@@ -350,7 +350,7 @@ export class TONChain extends Chain<typeof ChainFamily.TON> {
    * @param opts - Log filter options (startBlock/endBlock are interpreted as lt values)
    * @throws {@link CCIPTopicsInvalidError} if topics format is invalid
    */
-  async *getLogs(opts: LogFilter): AsyncIterableIterator<Log_> {
+  async *getLogs(opts: LogFilter): AsyncIterableIterator<ChainLog> {
     let topics
     if (opts.topics?.length) {
       if (!opts.topics.every((topic) => typeof topic === 'string'))
@@ -587,7 +587,7 @@ export class TONChain extends Chain<typeof ChainFamily.TON> {
   }: {
     data: unknown
     topics?: readonly string[]
-  }): CCIPMessage_V1_6_TON | undefined {
+  }): CCIPMessage_V1_6_EVM | undefined {
     if (!data || typeof data !== 'string') return
     if (topics?.length && topics[0] !== crc32('CCIPMessageSent')) return
 
@@ -660,7 +660,7 @@ export class TONChain extends Chain<typeof ChainFamily.TON> {
 
       // Load tokenAmounts from ref 3
       const _tokenAmountsCell = bodySlice.loadRef()
-      const tokenAmounts: CCIPMessage_V1_6_TON['tokenAmounts'] = [] // TODO: FIXME: parse when implemented
+      const tokenAmounts: CCIPMessage_V1_6_EVM['tokenAmounts'] = [] // TODO: FIXME: parse when implemented
 
       // Load feeToken (inline address in body)
       const feeToken = bodySlice.loadMaybeAddress()?.toString() ?? ''
@@ -1099,11 +1099,6 @@ export class TONChain extends Chain<typeof ChainFamily.TON> {
     throw new CCIPTransactionNotFoundError(seqno.toString())
   }
 
-  /** {@inheritDoc Chain.getOffchainTokenData} */
-  getOffchainTokenData(request: CCIPRequest): Promise<OffchainTokenData[]> {
-    return Promise.resolve(request.message.tokenAmounts.map(() => undefined))
-  }
-
   /**
    * {@inheritDoc Chain.generateUnsignedExecute}
    * @throws {@link CCIPExtraArgsInvalidError} if extra args are not EVMExtraArgsV2 format
@@ -1125,7 +1120,7 @@ export class TONChain extends Chain<typeof ChainFamily.TON> {
 
     const unsigned = generateUnsignedExecuteReport(
       offRamp,
-      input as ExecutionInput<CCIPMessage_V1_6_TON>,
+      input as ExecutionInput<CCIPMessage_V1_6_EVM>,
       opts,
     )
 
@@ -1161,7 +1156,7 @@ export class TONChain extends Chain<typeof ChainFamily.TON> {
       ...unsigned,
     })
 
-    const message = opts.input.message as CCIPMessage_V1_6_TON
+    const message = opts.input.message as CCIPMessage_V1_6_EVM
     for await (const exec of this.getExecutionReceipts({
       offRamp,
       messageId: message.messageId,

package/src/ton/types.ts

@@ -2,13 +2,10 @@ import { type Builder, Address, Cell, beginCell } from '@ton/core'
 import { toBigInt } from 'ethers'
 
 import { CCIPDataFormatUnsupportedError } from '../errors/specialized.ts'
-import type { EVMExtraArgsV2 } from '../extra-args.ts'
+import type { CCIPMessage_V1_6_EVM } from '../evm/messages.ts'
 import type { CCIPMessage_V1_6, ChainFamily, ExecutionInput } from '../types.ts'
 import { bytesToBuffer } from '../utils.ts'
 
-/** TON-specific CCIP v1.6 message type with EVMExtraArgsV2 (GenericExtraArgsV2) */
-export type CCIPMessage_V1_6_TON = CCIPMessage_V1_6 & EVMExtraArgsV2
-
 /** Opcode for OffRamp_ManuallyExecute message on TON */
 export const MANUALLY_EXECUTE_OPCODE = 0xa00785cf
 
@@ -83,7 +80,7 @@ function asSnakeData<T>(array: T[], builderFn: (item: T) => Builder): Cell {
  * @returns BOC-serialized Cell containing the execution report.
  */
 export function serializeExecutionReport(
-  execReport: ExecutionInput<CCIPMessage_V1_6_TON>,
+  execReport: ExecutionInput<CCIPMessage_V1_6_EVM>,
 ): Builder {
   return beginCell()
     .storeUint(execReport.message.sourceChainSelector, 64)
@@ -97,7 +94,7 @@ export function serializeExecutionReport(
     .storeUint(execReport.proofFlagBits, 256)
 }
 
-function serializeMessage(message: CCIPMessage_V1_6_TON): Builder {
+function serializeMessage(message: CCIPMessage_V1_6_EVM): Builder {
   return beginCell()
     .storeUint(BigInt(message.messageId), 256)
     .storeUint(message.sourceChainSelector, 64)

package/src/types.ts

@@ -1,5 +1,6 @@
 import type { AbiParametersToPrimitiveTypes, ExtractAbiEvent } from 'abitype'
-import type { BytesLike, Log } from 'ethers'
+import type { BytesLike, Log as EVMLog } from 'ethers'
+import type { SetOptional } from 'type-fest'
 
 import type { APICCIPRequestMetadata } from './api/types.ts'
 import type OffRamp_1_6_ABI from './evm/abi/OffRamp_1_6.ts'
@@ -7,7 +8,6 @@ import type { CCIPMessage_EVM, CCIPMessage_V1_6_EVM, CCIPMessage_V2_0 } from './
 import type { ExtraArgs } from './extra-args.ts'
 import type { CCIPMessage_V1_6_Solana } from './solana/types.ts'
 import type { CCIPMessage_V1_6_Sui } from './sui/types.ts'
-import type { CCIPMessage_V1_6_TON } from './ton/types.ts'
 // v1.6 Base type from EVM contains the intersection of all other CCIPMessage v1.6 types
 export type { CCIPMessage_V1_6 } from './evm/messages.ts'
 
@@ -157,17 +157,20 @@ export interface Lane<V extends CCIPVersion = CCIPVersion> {
 export type CCIPMessage<V extends CCIPVersion = CCIPVersion> = V extends typeof CCIPVersion.V2_0
   ? CCIPMessage_V2_0
   : V extends typeof CCIPVersion.V1_6
-    ? CCIPMessage_V1_6_EVM | CCIPMessage_V1_6_Solana | CCIPMessage_V1_6_Sui | CCIPMessage_V1_6_TON
+    ? CCIPMessage_V1_6_EVM | CCIPMessage_V1_6_Solana | CCIPMessage_V1_6_Sui
     : CCIPMessage_EVM<V>
 
 /**
  * Generic log structure compatible across chain families.
  */
-export type Log_ = Pick<Log, 'topics' | 'index' | 'address' | 'blockNumber' | 'transactionHash'> & {
+export type ChainLog = Pick<
+  EVMLog,
+  'topics' | 'index' | 'address' | 'blockNumber' | 'transactionHash'
+> & {
   /** Log data as bytes or parsed object. */
   data: BytesLike | Record<string, unknown>
   /** Optional reference to the containing transaction. */
-  tx?: ChainTransaction
+  tx?: SetOptional<ChainTransaction, 'logs'>
 }
 
 /**
@@ -188,7 +191,7 @@ export type ChainTransaction = {
   /** Transaction hash. */
   hash: string
   /** Logs emitted by this transaction. */
-  logs: readonly Log_[]
+  logs: readonly ChainLog[]
   /** Block number containing this transaction. */
   blockNumber: number
   /** Unix timestamp of the block. */
@@ -206,9 +209,9 @@ export interface CCIPRequest<V extends CCIPVersion = CCIPVersion> {
   /** Lane configuration for this request. */
   lane: Lane<V>
   message: CCIPMessage<V>
-  log: Log_
+  log: ChainLog
   /** Transaction that emitted the request. */
-  tx: Pick<ChainTransaction, 'hash' | 'logs' | 'blockNumber' | 'timestamp' | 'from' | 'error'>
+  tx: Omit<ChainTransaction, 'logs'>
 
   /**
    * API-enriched metadata. Present only when fetched via CCIP API.
@@ -263,7 +266,7 @@ export type CCIPVerifications =
       /** The commit report data. */
       report: CommitReport
       /** Log event from the commit. */
-      log: Log_
+      log: ChainLog
     }
   | {
       /** Policy for this request */
@@ -373,7 +376,7 @@ export interface CCIPExecution {
   /** Execution receipt data. */
   receipt: ExecutionReceipt
   /** Log event from the execution. */
-  log: Log_
+  log: ChainLog
   /** Unix timestamp of the execution. */
   timestamp: number
 }