@chainlink/ccip-sdk 0.96.0 → 1.0.0

package/src/aptos/exec.ts

@@ -1,6 +1,6 @@
 import { type Aptos, AccountAddress } from '@aptos-labs/ts-sdk'
 
-import type { ExecutionReport } from '../types.ts'
+import type { ExecutionInput } from '../types.ts'
 import { serializeExecutionReport } from './types.ts'
 import type { CCIPMessage_V1_6_EVM } from '../evm/messages.ts'
 
@@ -18,7 +18,7 @@ export async function generateUnsignedExecuteReport(
   provider: Aptos,
   payer: string,
   offRamp: string,
-  execReport: ExecutionReport<CCIPMessage_V1_6_EVM>,
+  execReport: ExecutionInput<CCIPMessage_V1_6_EVM>,
   opts?: { gasLimit?: number },
 ) {
   // Prepare proofs as byte arrays

package/src/aptos/hasher.ts

@@ -6,9 +6,9 @@ import {
 } from '../errors/index.ts'
 import { decodeExtraArgs } from '../extra-args.ts'
 import { type LeafHasher, LEAF_DOMAIN_SEPARATOR } from '../hasher/common.ts'
+import { encodeNumber, encodeRawBytes } from '../shared/bcs-codecs.ts'
 import { type CCIPMessage, type CCIPMessage_V1_6, CCIPVersion } from '../types.ts'
 import { getAddressBytes, networkInfo } from '../utils.ts'
-import { encodeNumber, encodeRawBytes } from './utils.ts'
 
 /**
  * Creates a leaf hasher for Aptos CCIP messages.

package/src/aptos/index.ts

@@ -7,16 +7,7 @@ import {
   SimpleTransaction,
   TransactionResponseType,
 } from '@aptos-labs/ts-sdk'
-import {
-  type BytesLike,
-  concat,
-  dataSlice,
-  getBytes,
-  hexlify,
-  isBytesLike,
-  isHexString,
-  zeroPadValue,
-} from 'ethers'
+import { type BytesLike, concat, isBytesLike, isHexString } from 'ethers'
 import { memoize } from 'micro-memoize'
 import type { PickDeep } from 'type-fest'
 
@@ -28,9 +19,11 @@ import {
   type TokenPoolRemote,
   Chain,
 } from '../chain.ts'
+import { generateUnsignedExecuteReport } from './exec.ts'
+import { getAptosLeafHasher } from './hasher.ts'
+import { getUserTxByVersion, getVersionTimestamp, streamAptosLogs } from './logs.ts'
 import { generateUnsignedCcipSend, getFee } from './send.ts'
 import {
-  CCIPAptosAddressInvalidError,
   CCIPAptosExtraArgsEncodingError,
   CCIPAptosExtraArgsV2RequiredError,
   CCIPAptosLogInvalidError,
@@ -50,26 +43,26 @@ import {
   EVMExtraArgsV2Tag,
   SVMExtraArgsV1Tag,
 } from '../extra-args.ts'
-import {
-  type UnsignedAptosTx,
-  EVMExtraArgsV2Codec,
-  SVMExtraArgsV1Codec,
-  isAptosAccount,
-} from './types.ts'
+import { type UnsignedAptosTx, isAptosAccount } from './types.ts'
 import type { LeafHasher } from '../hasher/common.ts'
+import {
+  BcsEVMExtraArgsV2Codec,
+  BcsSVMExtraArgsV1Codec,
+  decodeMoveExtraArgs,
+  getMoveAddress,
+} from '../shared/bcs-codecs.ts'
 import { supportedChains } from '../supported-chains.ts'
 import {
   type CCIPExecution,
   type CCIPMessage,
   type CCIPRequest,
+  type ChainLog,
   type ChainTransaction,
   type CommitReport,
+  type ExecutionInput,
   type ExecutionReceipt,
-  type ExecutionReport,
   type Lane,
-  type Log_,
   type NetworkInfo,
-  type OffchainTokenData,
   type WithLogger,
   ChainFamily,
 } from '../types.ts'
@@ -78,14 +71,10 @@ import {
   decodeAddress,
   decodeOnRampAddress,
   getAddressBytes,
-  getDataBytes,
   networkInfo,
   parseTypeAndVersion,
   util,
 } from '../utils.ts'
-import { generateUnsignedExecuteReport } from './exec.ts'
-import { getAptosLeafHasher } from './hasher.ts'
-import { getUserTxByVersion, getVersionTimestamp, streamAptosLogs } from './logs.ts'
 import { getTokenInfo } from './token.ts'
 import type { CCIPMessage_V1_6_EVM } from '../evm/messages.ts'
 import { buildMessageForDest, decodeMessage, getMessagesInBatch } from '../requests.ts'
@@ -98,13 +87,18 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
   static {
     supportedChains[ChainFamily.Aptos] = AptosChain
   }
+  /** Chain family identifier for Aptos networks. */
   static readonly family = ChainFamily.Aptos
+  /** Native token decimals (8 for APT). */
   static readonly decimals = 8
 
   readonly destroy$: Promise<void>
+  /** The Aptos SDK provider for blockchain interactions. */
   provider: Aptos
 
+  /** Retrieves token information for a given token address. */
   getTokenInfo: (token: string) => Promise<TokenInfo>
+  /** @internal */
   _getAccountModulesNames: (address: string) => Promise<string[]>
 
   /**
@@ -241,22 +235,22 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
   }
 
   /** {@inheritDoc Chain.getLogs} */
-  async *getLogs(opts: LogFilter & { versionAsHash?: boolean }): AsyncIterableIterator<Log_> {
+  async *getLogs(opts: LogFilter & { versionAsHash?: boolean }): AsyncIterableIterator<ChainLog> {
     yield* streamAptosLogs(this, opts)
   }
 
   /** {@inheritDoc Chain.getMessagesInBatch} */
-  async getMessagesInBatch<
+  override async getMessagesInBatch<
     R extends PickDeep<
       CCIPRequest,
       'lane' | `log.${'topics' | 'address' | 'blockNumber'}` | 'message.sequenceNumber'
     >,
   >(
     request: R,
-    commit: Pick<CommitReport, 'minSeqNr' | 'maxSeqNr'>,
+    range: Pick<CommitReport, 'minSeqNr' | 'maxSeqNr'>,
     opts?: { page?: number },
   ): Promise<R['message'][]> {
-    return getMessagesInBatch(this, request, commit, opts)
+    return getMessagesInBatch(this, request, range, opts)
   }
 
   /** {@inheritDoc Chain.typeAndVersion} */
@@ -296,8 +290,8 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
     return Promise.resolve(router.split('::')[0] + '::onramp')
   }
 
-  /** {@inheritDoc Chain.getOnRampForOffRamp} */
-  async getOnRampForOffRamp(offRamp: string, sourceChainSelector: bigint): Promise<string> {
+  /** {@inheritDoc Chain.getOnRampsForOffRamp} */
+  async getOnRampsForOffRamp(offRamp: string, sourceChainSelector: bigint): Promise<string[]> {
     const [sourceChainConfig] = await this.provider.view<[{ on_ramp: string }]>({
       payload: {
         function:
@@ -305,12 +299,7 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
         functionArguments: [sourceChainSelector],
       },
     })
-    return decodeAddress(sourceChainConfig.on_ramp, networkInfo(sourceChainSelector).family)
-  }
-
-  /** {@inheritDoc Chain.getCommitStoreForOffRamp} */
-  getCommitStoreForOffRamp(offRamp: string): Promise<string> {
-    return Promise.resolve(offRamp.split('::')[0] + '::offramp')
+    return [decodeAddress(sourceChainConfig.on_ramp, networkInfo(sourceChainSelector).family)]
   }
 
   /** {@inheritDoc Chain.getTokenForTokenPool} */
@@ -393,33 +382,7 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
     | (EVMExtraArgsV2 & { _tag: 'EVMExtraArgsV2' })
     | (SVMExtraArgsV1 & { _tag: 'SVMExtraArgsV1' })
     | undefined {
-    const data = getDataBytes(extraArgs),
-      tag = dataSlice(data, 0, 4)
-    switch (tag) {
-      case EVMExtraArgsV2Tag: {
-        const parsed = EVMExtraArgsV2Codec.parse(getBytes(dataSlice(data, 4)))
-        // Aptos serialization of EVMExtraArgsV2: 37 bytes total: 4 tag + 32 LE gasLimit + 1 allowOOOE
-        return {
-          _tag: 'EVMExtraArgsV2',
-          ...parsed,
-          gasLimit: BigInt(parsed.gasLimit),
-        }
-      }
-      case SVMExtraArgsV1Tag: {
-        const parsed = SVMExtraArgsV1Codec.parse(getBytes(dataSlice(data, 4)))
-        // Aptos serialization of SVMExtraArgsV1: 13 bytes total: 4 tag + 8 LE computeUnits
-        return {
-          _tag: 'SVMExtraArgsV1',
-          ...parsed,
-          computeUnits: BigInt(parsed.computeUnits),
-          accountIsWritableBitmap: BigInt(parsed.accountIsWritableBitmap),
-          tokenReceiver: decodeAddress(new Uint8Array(parsed.tokenReceiver), ChainFamily.Solana),
-          accounts: parsed.accounts.map((account) =>
-            decodeAddress(new Uint8Array(account), ChainFamily.Solana),
-          ),
-        }
-      }
-    }
+    return decodeMoveExtraArgs(extraArgs)
   }
 
   /**
@@ -430,11 +393,11 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
    */
   static encodeExtraArgs(extraArgs: ExtraArgs): string {
     if ('gasLimit' in extraArgs && 'allowOutOfOrderExecution' in extraArgs)
-      return concat([EVMExtraArgsV2Tag, EVMExtraArgsV2Codec.serialize(extraArgs).toBytes()])
+      return concat([EVMExtraArgsV2Tag, BcsEVMExtraArgsV2Codec.serialize(extraArgs).toBytes()])
     else if ('computeUnits' in extraArgs)
       return concat([
         SVMExtraArgsV1Tag,
-        SVMExtraArgsV1Codec.serialize({
+        BcsSVMExtraArgsV1Codec.serialize({
           ...extraArgs,
           computeUnits: Number(extraArgs.computeUnits),
           tokenReceiver: getAddressBytes(extraArgs.tokenReceiver),
@@ -451,7 +414,7 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
    * @returns Array of CommitReport or undefined if not valid.
    * @throws {@link CCIPAptosLogInvalidError} if log data format is invalid
    */
-  static decodeCommits({ data }: Pick<Log_, 'data'>, lane?: Lane): CommitReport[] | undefined {
+  static decodeCommits({ data }: Pick<ChainLog, 'data'>, lane?: Lane): CommitReport[] | undefined {
     if (!data || typeof data != 'object') throw new CCIPAptosLogInvalidError(data)
     const data_ = data as {
       blessed_merkle_roots: unknown[] | undefined
@@ -485,7 +448,7 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
    * @returns ExecutionReceipt or undefined if not valid.
    * @throws {@link CCIPAptosLogInvalidError} if log data format is invalid
    */
-  static decodeReceipt({ data }: Pick<Log_, 'data'>): ExecutionReceipt | undefined {
+  static decodeReceipt({ data }: Pick<ChainLog, 'data'>): ExecutionReceipt | undefined {
     if (!data || typeof data != 'object') throw new CCIPAptosLogInvalidError(data)
     const data_ = data as { message_id: string; state: number }
     if (!data_.message_id || !data_.state) return
@@ -498,21 +461,10 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
    * Converts bytes to an Aptos address.
    * @param bytes - Bytes to convert.
    * @returns Aptos address (0x-prefixed hex, 32 bytes padded).
-   * @throws {@link CCIPAptosAddressInvalidError} if bytes length exceeds 32
+   * @throws {@link CCIPDataFormatUnsupportedError} if bytes length exceeds 32
    */
   static getAddress(bytes: BytesLike | readonly number[]): string {
-    let suffix = ''
-    if (Array.isArray(bytes)) bytes = new Uint8Array(bytes)
-    if (typeof bytes === 'string' && bytes.startsWith('0x')) {
-      const idx = bytes.indexOf('::')
-      if (idx > 0) {
-        suffix = bytes.slice(idx)
-        bytes = bytes.slice(0, idx)
-      }
-    }
-    bytes = getDataBytes(bytes)
-    if (bytes.length > 32) throw new CCIPAptosAddressInvalidError(hexlify(bytes))
-    return zeroPadValue(bytes, 32) + suffix
+    return getMoveAddress(bytes)
   }
 
   /**
@@ -600,31 +552,30 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
     return (await this.getMessagesInTx(await this.getTransaction(hash)))[0]!
   }
 
-  /** {@inheritDoc Chain.getOffchainTokenData} */
-  getOffchainTokenData(request: CCIPRequest): Promise<OffchainTokenData[]> {
-    // default offchain token data
-    return Promise.resolve(request.message.tokenAmounts.map(() => undefined))
-  }
-
   /**
-   * {@inheritDoc Chain.generateUnsignedExecuteReport}
+   * {@inheritDoc Chain.generateUnsignedExecute}
    * @throws {@link CCIPAptosExtraArgsV2RequiredError} if message missing EVMExtraArgsV2 fields
    */
-  async generateUnsignedExecuteReport({
+  async generateUnsignedExecute({
     payer,
-    offRamp,
-    execReport,
     ...opts
-  }: Parameters<Chain['generateUnsignedExecuteReport']>[0]): Promise<UnsignedAptosTx> {
-    if (!('allowOutOfOrderExecution' in execReport.message && 'gasLimit' in execReport.message)) {
+  }: Parameters<Chain['generateUnsignedExecute']>[0]): Promise<UnsignedAptosTx> {
+    if (
+      !(
+        'input' in opts &&
+        'message' in opts.input &&
+        'allowOutOfOrderExecution' in opts.input.message &&
+        'gasLimit' in opts.input.message
+      )
+    ) {
       throw new CCIPAptosExtraArgsV2RequiredError()
     }
 
     const tx = await generateUnsignedExecuteReport(
       this.provider,
       payer,
-      offRamp,
-      execReport as ExecutionReport<CCIPMessage_V1_6_EVM>,
+      opts.offRamp,
+      opts.input as ExecutionInput<CCIPMessage_V1_6_EVM>,
       opts,
     )
     return {
@@ -634,16 +585,16 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
   }
 
   /**
-   * {@inheritDoc Chain.executeReport}
+   * {@inheritDoc Chain.execute}
    * @throws {@link CCIPAptosWalletInvalidError} if wallet is not a valid Aptos account
    */
-  async executeReport(opts: Parameters<Chain['executeReport']>[0]): Promise<CCIPExecution> {
+  async execute(opts: Parameters<Chain['execute']>[0]): Promise<CCIPExecution> {
     const account = opts.wallet
     if (!isAptosAccount(account)) {
       throw new CCIPAptosWalletInvalidError(this.constructor.name, util.inspect(opts.wallet))
     }
 
-    const unsignedTx = await this.generateUnsignedExecuteReport({
+    const unsignedTx = await this.generateUnsignedExecute({
       ...opts,
       payer: account.accountAddress.toString(),
     })
@@ -670,9 +621,13 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
    * @returns Parsed data or undefined.
    */
   static parse(data: unknown) {
-    if (isBytesLike(data)) {
-      const parsedExtraArgs = this.decodeExtraArgs(data)
-      if (parsedExtraArgs) return parsedExtraArgs
+    try {
+      if (isBytesLike(data)) {
+        const parsedExtraArgs = this.decodeExtraArgs(data)
+        if (parsedExtraArgs) return parsedExtraArgs
+      }
+    } catch {
+      // ignore
     }
   }
 

package/src/aptos/logs.ts

@@ -15,7 +15,7 @@ import {
   CCIPLogsWatchRequiresStartError,
   CCIPTopicsInvalidError,
 } from '../errors/index.ts'
-import type { Log_ } from '../types.ts'
+import type { ChainLog } from '../types.ts'
 import { sleep } from '../utils.ts'
 
 const DEFAULT_POLL_INTERVAL = 5e3
@@ -241,7 +241,7 @@ async function* fetchEventsBackward(
 export async function* streamAptosLogs(
   ctx: { provider: Aptos },
   opts: LogFilter & { versionAsHash?: boolean },
-): AsyncGenerator<Log_> {
+): AsyncGenerator<ChainLog> {
   const limit = 100
   if (!opts.address || !opts.address.includes('::')) throw new CCIPAptosAddressModuleRequiredError()
   if (opts.topics?.length !== 1 || typeof opts.topics[0] !== 'string')

package/src/aptos/types.ts

@@ -8,7 +8,7 @@ import { bcs } from '@mysten/bcs'
 import { getBytes } from 'ethers'
 
 import type { CCIPMessage_V1_6_EVM } from '../evm/messages.ts'
-import type { ChainFamily, ExecutionReport } from '../types.ts'
+import type { ChainFamily, ExecutionInput } from '../types.ts'
 import { getAddressBytes } from '../utils.ts'
 
 /** Aptos account type with async transaction signing capability. */
@@ -31,19 +31,6 @@ export function isAptosAccount(account: unknown): account is AptosAsyncAccount {
   )
 }
 
-export const EVMExtraArgsV2Codec = bcs.struct('EVMExtraArgsV2', {
-  gasLimit: bcs.u256(),
-  allowOutOfOrderExecution: bcs.bool(),
-})
-
-export const SVMExtraArgsV1Codec = bcs.struct('SVMExtraArgsV1', {
-  computeUnits: bcs.u32(),
-  accountIsWritableBitmap: bcs.u64(),
-  allowOutOfOrderExecution: bcs.bool(),
-  tokenReceiver: bcs.vector(bcs.u8()),
-  accounts: bcs.vector(bcs.vector(bcs.u8())),
-})
-
 export const ExecutionReportCodec = bcs.struct('ExecutionReport', {
   sourceChainSelector: bcs.u64(),
   messageId: bcs.fixedArray(32, bcs.u8()),
@@ -74,7 +61,7 @@ export const ExecutionReportCodec = bcs.struct('ExecutionReport', {
  * @returns BCS-encoded bytes.
  */
 export function serializeExecutionReport(
-  execReport: ExecutionReport<CCIPMessage_V1_6_EVM>,
+  execReport: ExecutionInput<CCIPMessage_V1_6_EVM>,
 ): Uint8Array {
   const message = execReport.message
   return ExecutionReportCodec.serialize({