@chainlink/ccip-sdk 0.95.0 → 0.97.0

package/src/sui/index.ts

@@ -7,7 +7,6 @@ import { isValidSuiAddress, isValidTransactionDigest, normalizeSuiAddress } from
 import { type BytesLike, dataLength, hexlify, isBytesLike, isHexString } from 'ethers'
 import type { PickDeep, SetOptional } from 'type-fest'
 
-import { AptosChain } from '../aptos/index.ts'
 import {
   type ChainContext,
   type ChainStatic,
@@ -15,24 +14,33 @@ import {
   type LogFilter,
   Chain,
 } from '../chain.ts'
+import { getCcipStateAddress, getOffRampForCcip } from './discovery.ts'
+import { type CommitEvent, streamSuiLogs } from './events.ts'
+import { getSuiLeafHasher } from './hasher.ts'
+import {
+  deriveObjectID,
+  fetchTokenConfigs,
+  getLatestPackageId,
+  getObjectRef,
+  getReceiverModule,
+} from './objects.ts'
 import {
   CCIPContractNotRouterError,
   CCIPDataFormatUnsupportedError,
   CCIPError,
   CCIPErrorCode,
   CCIPExecTxRevertedError,
-  CCIPNotImplementedError,
-} from '../errors/index.ts'
-import {
+  CCIPExecutionReportChainMismatchError,
   CCIPLogsAddressRequiredError,
+  CCIPNotImplementedError,
   CCIPSuiLogInvalidError,
   CCIPTopicsInvalidError,
-} from '../errors/specialized.ts'
+} from '../errors/index.ts'
 import type { EVMExtraArgsV2, ExtraArgs, SVMExtraArgsV1, SuiExtraArgsV1 } from '../extra-args.ts'
 import type { LeafHasher } from '../hasher/common.ts'
 import { decodeMessage, getMessagesInBatch } from '../requests.ts'
+import { decodeMoveExtraArgs, getMoveAddress } from '../shared/bcs-codecs.ts'
 import { supportedChains } from '../supported-chains.ts'
-import { getSuiLeafHasher } from './hasher.ts'
 import {
   type AnyMessage,
   type CCIPExecution,
@@ -41,8 +49,8 @@ import {
   type CCIPVersion,
   type ChainTransaction,
   type CommitReport,
+  type ExecutionInput,
   type ExecutionReceipt,
-  type ExecutionReport,
   type ExecutionState,
   type Lane,
   type Log_,
@@ -59,20 +67,11 @@ import {
   parseTypeAndVersion,
   util,
 } from '../utils.ts'
-import { getCcipStateAddress, getOffRampForCcip } from './discovery.ts'
-import { type CommitEvent, streamSuiLogs } from './events.ts'
 import {
   type SuiManuallyExecuteInput,
   type TokenConfig,
   buildManualExecutionPTB,
 } from './manuallyExec/index.ts'
-import {
-  deriveObjectID,
-  fetchTokenConfigs,
-  getLatestPackageId,
-  getObjectRef,
-  getReceiverModule,
-} from './objects.ts'
 import type { CCIPMessage_V1_6_Sui } from './types.ts'
 
 const DEFAULT_GAS_LIMIT = 1000000n
@@ -125,6 +124,8 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
    * Creates a SuiChain instance from an RPC URL.
    * @param url - HTTP or WebSocket endpoint URL for the Sui network.
    * @returns A new SuiChain instance.
+   * @throws {@link CCIPDataFormatUnsupportedError} if unable to fetch chain identifier
+   * @throws {@link CCIPError} if chain identifier is not supported
    */
   static async fromUrl(url: string, ctx?: ChainContext): Promise<SuiChain> {
     const client = new SuiClient({ url })
@@ -208,7 +209,11 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
     }
   }
 
-  /** {@inheritDoc Chain.getLogs} */
+  /**
+   * {@inheritDoc Chain.getLogs}
+   * @throws {@link CCIPLogsAddressRequiredError} if address is not provided
+   * @throws {@link CCIPTopicsInvalidError} if topics format is invalid
+   */
   async *getLogs(opts: LogFilter & { versionAsHash?: boolean }) {
     if (!opts.address) throw new CCIPLogsAddressRequiredError()
 
@@ -240,13 +245,16 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
     >,
   >(
     request: R,
-    commit: Pick<CommitReport, 'minSeqNr' | 'maxSeqNr'>,
-    opts?: { page?: number },
+    range: Pick<CommitReport, 'minSeqNr' | 'maxSeqNr'>,
+    opts?: Pick<LogFilter, 'page'>,
   ): Promise<R['message'][]> {
-    return getMessagesInBatch(this, request, commit, opts)
+    return getMessagesInBatch(this, request, range, opts)
   }
 
-  /** {@inheritDoc Chain.typeAndVersion} */
+  /**
+   * {@inheritDoc Chain.typeAndVersion}
+   * @throws {@link CCIPDataFormatUnsupportedError} if view call fails
+   */
   async typeAndVersion(address: string) {
     // requires address to have `::<module>` suffix
     address = await getLatestPackageId(address, this.client)
@@ -280,7 +288,10 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
     return Promise.resolve(onRamp)
   }
 
-  /** {@inheritDoc Chain.getRouterForOffRamp} */
+  /**
+   * {@inheritDoc Chain.getRouterForOffRamp}
+   * @throws {@link CCIPContractNotRouterError} always (Sui architecture doesn't have separate router)
+   */
   getRouterForOffRamp(offRamp: string, _sourceChainSelector: bigint): Promise<string> {
     throw new CCIPContractNotRouterError(offRamp, 'unknown')
   }
@@ -305,8 +316,11 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
     return Promise.resolve(router)
   }
 
-  /** {@inheritDoc Chain.getOnRampForOffRamp} */
-  async getOnRampForOffRamp(offRamp: string, sourceChainSelector: bigint): Promise<string> {
+  /**
+   * {@inheritDoc Chain.getOnRampsForOffRamp}
+   * @throws {@link CCIPDataFormatUnsupportedError} if view call fails
+   */
+  async getOnRampsForOffRamp(offRamp: string, sourceChainSelector: bigint): Promise<string[]> {
     offRamp = await getLatestPackageId(offRamp, this.client)
     const functionName = 'get_source_chain_config'
     // Preserve module suffix if present, otherwise add it
@@ -375,15 +389,14 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
     const onRampBytes = configBytes.slice(offset, offset + onRampLength)
 
     // Decode the address from the onRamp bytes
-    return decodeAddress(onRampBytes, networkInfo(sourceChainSelector).family)
+    return [decodeAddress(onRampBytes, networkInfo(sourceChainSelector).family)]
   }
 
-  /** {@inheritDoc Chain.getCommitStoreForOffRamp} */
-  getCommitStoreForOffRamp(offRamp: string): Promise<string> {
-    return Promise.resolve(offRamp)
-  }
-
-  /** {@inheritDoc Chain.getTokenForTokenPool} */
+  /**
+   * {@inheritDoc Chain.getTokenForTokenPool}
+   * @throws {@link CCIPError} if token pool type is invalid or state not found
+   * @throws {@link CCIPDataFormatUnsupportedError} if view call fails
+   */
   async getTokenForTokenPool(tokenPool: string): Promise<string> {
     const normalizedTokenPool = normalizeSuiAddress(tokenPool)
 
@@ -481,7 +494,10 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
     return coinMetadataAddress
   }
 
-  /** {@inheritDoc Chain.getTokenInfo} */
+  /**
+   * {@inheritDoc Chain.getTokenInfo}
+   * @throws {@link CCIPError} if token address is invalid or metadata cannot be loaded
+   */
   async getTokenInfo(token: string): Promise<{ symbol: string; decimals: number }> {
     const normalizedTokenAddress = normalizeSuiAddress(token)
     if (!isValidSuiAddress(normalizedTokenAddress)) {
@@ -558,6 +574,7 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
    * Decodes a CCIP message from a Sui log event.
    * @param log - Log event data.
    * @returns Decoded CCIPMessage or undefined if not valid.
+   * @throws {@link CCIPSuiLogInvalidError} if log data format is invalid
    */
   static decodeMessage(log: Log_): CCIPMessage | undefined {
     const { data } = log
@@ -585,13 +602,14 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
     | (EVMExtraArgsV2 & { _tag: 'EVMExtraArgsV2' })
     | (SVMExtraArgsV1 & { _tag: 'SVMExtraArgsV1' })
     | undefined {
-    return AptosChain.decodeExtraArgs(extraArgs)
+    return decodeMoveExtraArgs(extraArgs)
   }
 
   /**
    * Encodes extra arguments for CCIP messages.
    * @param _extraArgs - Extra arguments to encode.
    * @returns Encoded extra arguments as a hex string.
+   * @throws {@link CCIPNotImplementedError} always (not yet implemented)
    */
   static encodeExtraArgs(_extraArgs: ExtraArgs): string {
     throw new CCIPNotImplementedError()
@@ -672,7 +690,7 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
    * @returns Sui address.
    */
   static getAddress(bytes: BytesLike | readonly number[]): string {
-    return AptosChain.getAddress(bytes)
+    return getMoveAddress(bytes)
   }
 
   /**
@@ -716,20 +734,27 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
     return Promise.resolve(request.message.tokenAmounts.map(() => undefined))
   }
 
-  /** {@inheritDoc Chain.generateUnsignedExecuteReport} */
-  override generateUnsignedExecuteReport(
-    _opts: Parameters<Chain['generateUnsignedExecuteReport']>[0],
+  /** {@inheritDoc Chain.generateUnsignedExecute} */
+  override generateUnsignedExecute(
+    _opts: Parameters<Chain['generateUnsignedExecute']>[0],
   ): Promise<never> {
-    return Promise.reject(new CCIPNotImplementedError('SuiChain.generateUnsignedExecuteReport'))
+    return Promise.reject(new CCIPNotImplementedError('SuiChain.generateUnsignedExecute'))
   }
 
-  /** {@inheritDoc Chain.executeReport} */
-  async executeReport(
-    opts: Parameters<Chain['executeReport']>[0] & {
+  /**
+   * {@inheritDoc Chain.execute}
+   * @throws {@link CCIPError} if transaction submission fails
+   * @throws {@link CCIPExecTxRevertedError} if transaction reverts
+   */
+  async execute(
+    opts: Parameters<Chain['execute']>[0] & {
       receiverObjectIds?: string[]
     },
   ): Promise<CCIPExecution> {
-    const { execReport, offRamp } = opts
+    if (!('input' in opts && 'message' in opts.input)) {
+      throw new CCIPExecutionReportChainMismatchError('Sui')
+    }
+    const { input, offRamp } = opts
     const wallet = opts.wallet as Keypair
 
     // Discover the CCIP package from the offramp
@@ -741,20 +766,20 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
       this.client,
       ccip,
       ccipObjectRef,
-      execReport.message.receiver,
+      input.message.receiver,
     )
     let tokenConfigs: TokenConfig[] = []
-    if (execReport.message.tokenAmounts.length !== 0) {
+    if (input.message.tokenAmounts.length !== 0) {
       tokenConfigs = await fetchTokenConfigs(
         this.client,
         ccip,
         ccipObjectRef,
-        execReport.message.tokenAmounts as CCIPMessage<typeof CCIPVersion.V1_6>['tokenAmounts'],
+        input.message.tokenAmounts as CCIPMessage<typeof CCIPVersion.V1_6>['tokenAmounts'],
       )
     }
 
-    const input: SuiManuallyExecuteInput = {
-      executionReport: execReport as ExecutionReport<CCIPMessage_V1_6_Sui>,
+    const suiInput: SuiManuallyExecuteInput = {
+      executionReport: input as ExecutionInput<CCIPMessage_V1_6_Sui>,
       offrampAddress: offRamp,
       ccipAddress: ccip,
       ccipObjectRef,
@@ -766,16 +791,16 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
       this.logger.info(
         `Overriding Sui Manual Execution receiverObjectIds with: ${opts.receiverObjectIds.join(', ')}`,
       )
-      input.overrideReceiverObjectIds = opts.receiverObjectIds
+      suiInput.overrideReceiverObjectIds = opts.receiverObjectIds
     }
-    const tx = buildManualExecutionPTB(input)
+    const tx = buildManualExecutionPTB(suiInput)
 
     // Set gas budget if provided
     if (opts.gasLimit) {
       tx.setGasBudget(opts.gasLimit)
     }
 
-    this.logger.info(`Executing Sui CCIP executeReport transaction...`)
+    this.logger.info(`Executing Sui CCIP execute transaction...`)
     // Sign and execute the transaction
     let result: SuiTransactionBlockResponse
     try {
@@ -790,7 +815,7 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
     } catch (e) {
       throw new CCIPError(
         CCIPErrorCode.TRANSACTION_NOT_FINALIZED,
-        `Failed to send Sui executeReport transaction: ${(e as Error).message}`,
+        `Failed to send Sui execute transaction: ${(e as Error).message}`,
       )
     }
 
@@ -838,9 +863,9 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
     return Promise.reject(new CCIPNotImplementedError('SuiChain.getRegistryTokenConfig'))
   }
 
-  /** {@inheritDoc Chain.getTokenPoolConfigs} */
-  async getTokenPoolConfigs(_tokenPool: string): Promise<never> {
-    return Promise.reject(new CCIPNotImplementedError('SuiChain.getTokenPoolConfigs'))
+  /** {@inheritDoc Chain.getTokenPoolConfig} */
+  async getTokenPoolConfig(_tokenPool: string): Promise<never> {
+    return Promise.reject(new CCIPNotImplementedError('SuiChain.getTokenPoolConfig'))
   }
 
   /** {@inheritDoc Chain.getTokenPoolRemotes} */
@@ -853,7 +878,13 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
     return Promise.reject(new CCIPNotImplementedError('SuiChain.getFeeTokens'))
   }
 
-  /** {@inheritDoc ChainStatic.buildMessageForDest} */
+  /**
+   * Returns a copy of a message, populating missing fields like `extraArgs` with defaults.
+   * It's expected to return a message suitable at least for basic token transfers.
+   *
+   * @param message - AnyMessage (from source), containing at least `receiver`
+   * @returns A message suitable for `sendMessage` to this destination chain family
+   */
   static override buildMessageForDest(
     message: Parameters<ChainStatic['buildMessageForDest']>[0],
   ): AnyMessage & { extraArgs: SuiExtraArgsV1 } {
@@ -872,7 +903,8 @@ export class SuiChain extends Chain<typeof ChainFamily.Sui> {
     const tokenReceiver =
       message.extraArgs &&
       'tokenReceiver' in message.extraArgs &&
-      message.extraArgs.tokenReceiver != null
+      message.extraArgs.tokenReceiver != null &&
+      typeof message.extraArgs.tokenReceiver === 'string'
         ? message.extraArgs.tokenReceiver
         : message.tokenAmounts?.length
           ? this.getAddress(message.receiver)

package/src/sui/manuallyExec/encoder.ts

@@ -5,7 +5,7 @@ import type { BytesLike } from 'ethers'
 
 import { CCIPMessageInvalidError } from '../../errors/specialized.ts'
 import { decodeExtraArgs } from '../../extra-args.ts'
-import type { CCIPMessage, CCIPVersion, ExecutionReport } from '../../types.ts'
+import type { CCIPMessage, CCIPVersion, ExecutionInput } from '../../types.ts'
 import { bytesToBuffer, getAddressBytes, getDataBytes, networkInfo } from '../../utils.ts'
 
 const Any2SuiTokenTransferBCS = bcs.struct('Any2SuiTokenTransfer', {
@@ -39,7 +39,7 @@ const ExecutionReportBCS = bcs.struct('ExecutionReport', {
  * @returns Serialized execution report as Uint8Array.
  */
 export function serializeExecutionReport(
-  executionReport: ExecutionReport<CCIPMessage<typeof CCIPVersion.V1_6>>,
+  executionReport: ExecutionInput<CCIPMessage<typeof CCIPVersion.V1_6>>,
 ): Uint8Array {
   const { message, offchainTokenData, proofs } = executionReport
 

package/src/sui/manuallyExec/index.ts

@@ -5,7 +5,7 @@ import { Transaction } from '@mysten/sui/transactions'
 import { serializeExecutionReport } from './encoder.ts'
 import { CCIPMessageInvalidError } from '../../errors/specialized.ts'
 import { decodeExtraArgs } from '../../extra-args.ts'
-import type { ExecutionReport } from '../../types.ts'
+import type { ExecutionInput } from '../../types.ts'
 import { networkInfo } from '../../utils.ts'
 import type { CCIPMessage_V1_6_Sui } from '../types.ts'
 
@@ -30,7 +30,7 @@ export type TokenConfig = {
 /** Input parameters for building a Sui manual execution transaction. */
 export type SuiManuallyExecuteInput = {
   offrampAddress: string
-  executionReport: ExecutionReport<CCIPMessage_V1_6_Sui>
+  executionReport: ExecutionInput<CCIPMessage_V1_6_Sui>
   ccipAddress: string
   ccipObjectRef: string
   offrampStateObject: string

package/src/ton/exec.ts

@@ -1,6 +1,6 @@
 import { type Cell, beginCell } from '@ton/core'
 
-import type { ExecutionReport } from '../types.ts'
+import type { ExecutionInput } from '../types.ts'
 import {
   type CCIPMessage_V1_6_TON,
   MANUALLY_EXECUTE_OPCODE,
@@ -17,7 +17,7 @@ import {
  */
 export function generateUnsignedExecuteReport(
   offRamp: string,
-  execReport: ExecutionReport<CCIPMessage_V1_6_TON>,
+  execReport: ExecutionInput<CCIPMessage_V1_6_TON>,
   opts?: { gasLimit?: number },
 ): { to: string; body: Cell } {
   // Serialize the execution report