@chainlink/ccip-sdk 0.94.0 → 0.96.0

package/src/aptos/index.ts

@@ -1,5 +1,6 @@
 import {
   Aptos,
+  AptosApiError,
   AptosConfig,
   Deserializer,
   Network,
@@ -9,9 +10,7 @@ import {
 import {
   type BytesLike,
   concat,
-  dataLength,
   dataSlice,
-  decodeBase64,
   getBytes,
   hexlify,
   isBytesLike,
@@ -23,6 +22,7 @@ import type { PickDeep } from 'type-fest'
 
 import {
   type ChainContext,
+  type GetBalanceOpts,
   type LogFilter,
   type TokenInfo,
   type TokenPoolRemote,
@@ -41,7 +41,7 @@ import {
   CCIPAptosTransactionTypeInvalidError,
   CCIPAptosWalletInvalidError,
   CCIPError,
-  CCIPOnRampRequiredError,
+  CCIPTokenPoolChainConfigNotFoundError,
 } from '../errors/index.ts'
 import {
   type EVMExtraArgsV2,
@@ -88,13 +88,7 @@ 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,
-  getMessageById,
-  getMessagesInBatch,
-  getMessagesInTx,
-} from '../requests.ts'
+import { buildMessageForDest, decodeMessage, getMessagesInBatch } from '../requests.ts'
 export type { UnsignedAptosTx }
 
 /**
@@ -185,6 +179,7 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
    * @param url - RPC URL, Aptos Network enum value or [fullNodeUrl, Network] tuple.
    * @param ctx - context containing logger
    * @returns A new AptosChain instance.
+   * @throws {@link CCIPAptosNetworkUnknownError} if network cannot be determined from URL
    */
   static async fromUrl(
     url: string | Network | readonly [string, Network],
@@ -211,7 +206,11 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
     return getVersionTimestamp(this.provider, version)
   }
 
-  /** {@inheritDoc Chain.getTransaction} */
+  /**
+   * {@inheritDoc Chain.getTransaction}
+   * @throws {@link CCIPAptosTransactionInvalidError} if hash/version format is invalid
+   * @throws {@link CCIPAptosTransactionTypeInvalidError} if transaction is not a user transaction
+   */
   async getTransaction(hashOrVersion: string | number): Promise<ChainTransaction> {
     let tx
     if (isHexString(hashOrVersion, 32)) {
@@ -246,24 +245,6 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
     yield* streamAptosLogs(this, opts)
   }
 
-  /** {@inheritDoc Chain.getMessagesInTx} */
-  async getMessagesInTx(tx: string | ChainTransaction): Promise<CCIPRequest[]> {
-    return getMessagesInTx(this, typeof tx === 'string' ? await this.getTransaction(tx) : tx)
-  }
-
-  /** {@inheritDoc Chain.getMessageById} */
-  override async getMessageById(
-    messageId: string,
-    onRamp?: string,
-    opts?: { page?: number },
-  ): Promise<CCIPRequest> {
-    if (!onRamp) throw new CCIPOnRampRequiredError()
-    return getMessageById(this, messageId, {
-      address: await this.getOnRampForRouter(onRamp, 0n),
-      ...opts,
-    })
-  }
-
   /** {@inheritDoc Chain.getMessagesInBatch} */
   async getMessagesInBatch<
     R extends PickDeep<
@@ -353,7 +334,22 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
     throw CCIPError.from(firstErr ?? `Could not view 'get_token' in ${tokenPool}`, 'UNKNOWN')
   }
 
-  /** {@inheritDoc Chain.getTokenAdminRegistryFor} */
+  /** {@inheritDoc Chain.getBalance} */
+  async getBalance(opts: GetBalanceOpts): Promise<bigint> {
+    const { holder, token } = opts
+    const asset = token ?? '0x1::aptos_coin::AptosCoin'
+
+    const balance = await this.provider.getBalance({
+      accountAddress: holder,
+      asset,
+    })
+    return BigInt(balance)
+  }
+
+  /**
+   * {@inheritDoc Chain.getTokenAdminRegistryFor}
+   * @throws {@link CCIPAptosRegistryTypeInvalidError} if registry type is invalid
+   */
   async getTokenAdminRegistryFor(address: string): Promise<string> {
     const registry = address.split('::')[0] + '::token_admin_registry'
     const [type] = await this.typeAndVersion(registry)
@@ -367,6 +363,7 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
    * Decodes a CCIP message from an Aptos log event.
    * @param log - Log with data field.
    * @returns Decoded CCIPMessage or undefined if not valid.
+   * @throws {@link CCIPAptosLogInvalidError} if log data format is invalid
    */
   static decodeMessage(log: {
     data: BytesLike | Record<string, unknown>
@@ -429,6 +426,7 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
    * Encodes extra arguments for Aptos CCIP messages.
    * @param extraArgs - Extra arguments to encode.
    * @returns Encoded extra arguments as hex string.
+   * @throws {@link CCIPAptosExtraArgsEncodingError} if extra args format is not supported
    */
   static encodeExtraArgs(extraArgs: ExtraArgs): string {
     if ('gasLimit' in extraArgs && 'allowOutOfOrderExecution' in extraArgs)
@@ -451,6 +449,7 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
    * @param log - Log with data field.
    * @param lane - Lane info for filtering.
    * @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 {
     if (!data || typeof data != 'object') throw new CCIPAptosLogInvalidError(data)
@@ -484,6 +483,7 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
    * Decodes an execution receipt from an Aptos log event.
    * @param log - Log with data field.
    * @returns ExecutionReceipt or undefined if not valid.
+   * @throws {@link CCIPAptosLogInvalidError} if log data format is invalid
    */
   static decodeReceipt({ data }: Pick<Log_, 'data'>): ExecutionReceipt | undefined {
     if (!data || typeof data != 'object') throw new CCIPAptosLogInvalidError(data)
@@ -498,19 +498,20 @@ 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
    */
-  static getAddress(bytes: BytesLike): string {
+  static getAddress(bytes: BytesLike | readonly number[]): string {
     let suffix = ''
-    if (typeof bytes === 'string' && !bytes.startsWith('0x')) {
-      bytes = decodeBase64(bytes)
-    } else if (typeof bytes === 'string') {
+    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)
       }
     }
-    if (dataLength(bytes) > 32) throw new CCIPAptosAddressInvalidError(hexlify(bytes))
+    bytes = getDataBytes(bytes)
+    if (bytes.length > 32) throw new CCIPAptosAddressInvalidError(hexlify(bytes))
     return zeroPadValue(bytes, 32) + suffix
   }
 
@@ -567,7 +568,10 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
     }
   }
 
-  /** {@inheritDoc Chain.sendMessage} */
+  /**
+   * {@inheritDoc Chain.sendMessage}
+   * @throws {@link CCIPAptosWalletInvalidError} if wallet is not a valid Aptos account
+   */
   async sendMessage(opts: Parameters<Chain['sendMessage']>[0]): Promise<CCIPRequest> {
     const account = opts.wallet
     if (!isAptosAccount(account)) {
@@ -602,7 +606,10 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
     return Promise.resolve(request.message.tokenAmounts.map(() => undefined))
   }
 
-  /** {@inheritDoc Chain.generateUnsignedExecuteReport} */
+  /**
+   * {@inheritDoc Chain.generateUnsignedExecuteReport}
+   * @throws {@link CCIPAptosExtraArgsV2RequiredError} if message missing EVMExtraArgsV2 fields
+   */
   async generateUnsignedExecuteReport({
     payer,
     offRamp,
@@ -626,7 +633,10 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
     }
   }
 
-  /** {@inheritDoc Chain.executeReport} */
+  /**
+   * {@inheritDoc Chain.executeReport}
+   * @throws {@link CCIPAptosWalletInvalidError} if wallet is not a valid Aptos account
+   */
   async executeReport(opts: Parameters<Chain['executeReport']>[0]): Promise<CCIPExecution> {
     const account = opts.wallet
     if (!isAptosAccount(account)) {
@@ -685,7 +695,10 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
     return page
   }
 
-  /** {@inheritDoc Chain.getRegistryTokenConfig} */
+  /**
+   * {@inheritDoc Chain.getRegistryTokenConfig}
+   * @throws {@link CCIPAptosTokenNotRegisteredError} if token is not registered
+   */
   async getRegistryTokenConfig(
     registry: string,
     token: string,
@@ -711,8 +724,8 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
     }
   }
 
-  /** {@inheritDoc Chain.getTokenPoolConfigs} */
-  async getTokenPoolConfigs(tokenPool: string): Promise<{
+  /** {@inheritDoc Chain.getTokenPoolConfig} */
+  async getTokenPoolConfig(tokenPool: string): Promise<{
     token: string
     router: string
     typeAndVersion?: string
@@ -763,8 +776,8 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
       tokens: string
     }
     const modulesNames = (await this._getAccountModulesNames(tokenPool))
-      .reverse()
       .filter((name) => name.endsWith('token_pool'))
+      .sort((a, b) => b.length - a.length)
     let firstErr
     for (const name of modulesNames) {
       try {
@@ -803,40 +816,49 @@ export class AptosChain extends Chain<typeof ChainFamily.Aptos> {
                   functionArguments: [chain.chainSelector],
                 },
               })
-              const [
-                [remoteToken],
-                [remotePools],
-                [inboundRateLimiterState],
-                [outboundRateLimiterState],
-              ] = await Promise.all([
-                remoteToken$,
-                remotePools$,
-                inboundRateLimiterState$,
-                outboundRateLimiterState$,
-              ])
-              return [
-                chain.name,
-                {
-                  remoteToken: decodeAddress(remoteToken, chain.family),
-                  remotePools: remotePools.map((pool) => decodeAddress(pool, chain.family)),
-                  inboundRateLimiterState: inboundRateLimiterState.is_enabled
-                    ? {
-                        capacity: BigInt(inboundRateLimiterState.capacity),
-                        lastUpdated: Number(inboundRateLimiterState.last_updated),
-                        rate: BigInt(inboundRateLimiterState.rate),
-                        tokens: BigInt(inboundRateLimiterState.tokens),
-                      }
-                    : null,
-                  outboundRateLimiterState: outboundRateLimiterState.is_enabled
-                    ? {
-                        capacity: BigInt(outboundRateLimiterState.capacity),
-                        lastUpdated: Number(outboundRateLimiterState.last_updated),
-                        rate: BigInt(outboundRateLimiterState.rate),
-                        tokens: BigInt(outboundRateLimiterState.tokens),
-                      }
-                    : null,
-                },
-              ] as const
+              try {
+                const [
+                  [remoteToken],
+                  [remotePools],
+                  [inboundRateLimiterState],
+                  [outboundRateLimiterState],
+                ] = await Promise.all([
+                  remoteToken$,
+                  remotePools$,
+                  inboundRateLimiterState$,
+                  outboundRateLimiterState$,
+                ])
+                return [
+                  chain.name,
+                  {
+                    remoteToken: decodeAddress(remoteToken, chain.family),
+                    remotePools: remotePools.map((pool) => decodeAddress(pool, chain.family)),
+                    inboundRateLimiterState: inboundRateLimiterState.is_enabled
+                      ? {
+                          capacity: BigInt(inboundRateLimiterState.capacity),
+                          lastUpdated: Number(inboundRateLimiterState.last_updated),
+                          rate: BigInt(inboundRateLimiterState.rate),
+                          tokens: BigInt(inboundRateLimiterState.tokens),
+                        }
+                      : null,
+                    outboundRateLimiterState: outboundRateLimiterState.is_enabled
+                      ? {
+                          capacity: BigInt(outboundRateLimiterState.capacity),
+                          lastUpdated: Number(outboundRateLimiterState.last_updated),
+                          rate: BigInt(outboundRateLimiterState.rate),
+                          tokens: BigInt(outboundRateLimiterState.tokens),
+                        }
+                      : null,
+                  },
+                ] as const
+              } catch (err) {
+                if (
+                  err instanceof AptosApiError &&
+                  err.message.includes('Key not found in the smart table')
+                )
+                  throw new CCIPTokenPoolChainConfigNotFoundError(tokenPool, tokenPool, chain.name)
+                throw err
+              }
             }),
           ),
         )

package/src/aptos/logs.ts

@@ -10,10 +10,10 @@ import { memoize } from 'micro-memoize'
 import type { LogFilter } from '../chain.ts'
 import {
   CCIPAptosAddressModuleRequiredError,
-  CCIPAptosTopicInvalidError,
   CCIPAptosTransactionTypeUnexpectedError,
   CCIPLogsWatchRequiresFinalityError,
   CCIPLogsWatchRequiresStartError,
+  CCIPTopicsInvalidError,
 } from '../errors/index.ts'
 import type { Log_ } from '../types.ts'
 import { sleep } from '../utils.ts'
@@ -245,11 +245,11 @@ export async function* streamAptosLogs(
   const limit = 100
   if (!opts.address || !opts.address.includes('::')) throw new CCIPAptosAddressModuleRequiredError()
   if (opts.topics?.length !== 1 || typeof opts.topics[0] !== 'string')
-    throw new CCIPAptosTopicInvalidError()
+    throw new CCIPTopicsInvalidError(opts.topics!)
   let eventHandlerField = opts.topics[0]
   if (!eventHandlerField.includes('/')) {
     eventHandlerField = (eventToHandler as Record<string, string>)[eventHandlerField]!
-    if (!eventHandlerField) throw new CCIPAptosTopicInvalidError(opts.topics[0])
+    if (!eventHandlerField) throw new CCIPTopicsInvalidError(opts.topics)
   }
   const [stateAddr] = await ctx.provider.view<[string]>({
     payload: {