@chainlink/ccip-sdk 0.91.0 → 0.92.0

package/src/utils.ts

@@ -1,5 +1,3 @@
-import { Buffer } from 'buffer'
-
 import bs58 from 'bs58'
 import {
   type BigNumberish,
@@ -13,7 +11,16 @@ import {
 } from 'ethers'
 import { memoize } from 'micro-memoize'
 
-import type { Chain } from './chain.ts'
+import type { Chain, ChainStatic } from './chain.ts'
+import {
+  CCIPBlockBeforeTimestampNotFoundError,
+  CCIPChainFamilyUnsupportedError,
+  CCIPChainNotFoundError,
+  CCIPDataFormatUnsupportedError,
+  CCIPError,
+  CCIPHttpError,
+  CCIPTypeVersionInvalidError,
+} from './errors/index.ts'
 import SELECTORS from './selectors.ts'
 import { supportedChains } from './supported-chains.ts'
 import { type NetworkInfo, type WithLogger, ChainFamily } from './types.ts'
@@ -55,7 +62,7 @@ export async function getSomeBlockNumberBefore(
   }
 
   if (beforeTimestamp > timestamp) {
-    throw new Error(`Could not find a block prior to timestamp=${timestamp}`)
+    throw new CCIPBlockBeforeTimestampNotFoundError(timestamp)
   }
 
   // now, bin-search based on timestamp proportions, looking for
@@ -96,7 +103,7 @@ export async function getSomeBlockNumberBefore(
 // memoized so we always output the same object for a given chainId
 const networkInfoFromChainId = memoize((chainId: NetworkInfo['chainId']): NetworkInfo => {
   const sel = SELECTORS[chainId]
-  if (!sel?.name) throw new Error(`Chain not found: ${chainId}`)
+  if (!sel?.name) throw new CCIPChainNotFoundError(chainId)
   return {
     chainId: isNaN(+chainId) ? chainId : +chainId,
     chainSelector: sel.selector,
@@ -118,14 +125,17 @@ const networkInfoFromChainId = memoize((chainId: NetworkInfo['chainId']): Networ
 export const networkInfo = memoize(function networkInfo_(
   selectorOrIdOrName: bigint | number | string,
 ): NetworkInfo {
-  let chainId
+  let chainId, match
   if (typeof selectorOrIdOrName === 'number') {
     chainId = selectorOrIdOrName
-  } else if (typeof selectorOrIdOrName === 'string' && selectorOrIdOrName.match(/^\d+$/)) {
-    selectorOrIdOrName = BigInt(selectorOrIdOrName)
+  } else if (
+    typeof selectorOrIdOrName === 'string' &&
+    (match = selectorOrIdOrName.match(/^(-?\d+)n?$/))
+  ) {
+    selectorOrIdOrName = BigInt(match[1])
   }
   if (typeof selectorOrIdOrName === 'bigint') {
-    // maybe we got a number deserialized as bigint
+    // maybe we got a chainId deserialized as bigint
     if (selectorOrIdOrName.toString() in SELECTORS) {
       chainId = Number(selectorOrIdOrName)
     } else {
@@ -135,10 +145,10 @@ export const networkInfo = memoize(function networkInfo_(
           break
         }
       }
-      if (!chainId) throw new Error(`Selector not found: ${selectorOrIdOrName}`)
+      if (!chainId) throw new CCIPChainNotFoundError(selectorOrIdOrName)
     }
   } else if (typeof selectorOrIdOrName === 'string') {
-    if (selectorOrIdOrName.includes('-')) {
+    if (selectorOrIdOrName.includes('-', 1)) {
       for (const id in SELECTORS) {
         if (SELECTORS[id].name === selectorOrIdOrName) {
           chainId = id
@@ -212,10 +222,28 @@ export function bigIntReviver(_key: string, value: unknown): unknown {
  **/
 export function decodeAddress(address: BytesLike, family: ChainFamily = ChainFamily.EVM): string {
   const chain = supportedChains[family]
-  if (!chain) throw new Error(`Unsupported chain family: ${family}`)
+  if (!chain) throw new CCIPChainFamilyUnsupportedError(family)
   return chain.getAddress(getAddressBytes(address))
 }
 
+/**
+ * Validate a value is a txHash string in some supported chain family
+ **/
+export function isSupportedTxHash(txHash: unknown, family?: ChainFamily): txHash is string {
+  let chains: ChainStatic[]
+  if (!family) chains = Object.values(supportedChains)
+  else if (family in supportedChains) chains = [supportedChains[family]!]
+  else throw new CCIPChainFamilyUnsupportedError(family)
+  for (const C of chains) {
+    try {
+      if (C.isTxHash(txHash)) return true
+    } catch (_) {
+      // continue
+    }
+  }
+  return false
+}
+
 /**
  * Version of decodeAddress which is aware of custom cross-chain OnRamp formats
  **/
@@ -247,7 +275,6 @@ export function leToBigInt(data: BytesLike | readonly number[]): bigint {
 export function toLeArray(value: BigNumberish, width?: Numeric): Uint8Array {
   return toBeArray(value, width).reverse()
 }
-
 /**
  * Checks if the given data is a valid Base64 encoded string.
  * @param data - Data to check.
@@ -274,10 +301,19 @@ export function getDataBytes(data: BytesLike | readonly number[]): Uint8Array {
   } else if (isBase64(data)) {
     return decodeBase64(data)
   } else {
-    throw new Error(`Unsupported data format: ${util.inspect(data)}`)
+    throw new CCIPDataFormatUnsupportedError(util.inspect(data))
   }
 }
 
+/**
+ * Converts bytes to a Node.js Buffer.
+ * @param bytes - Bytes to convert (hex string, Uint8Array, Base64, etc).
+ * @returns Node.js Buffer.
+ */
+export function bytesToBuffer(bytes: BytesLike | readonly number[]): Buffer {
+  return Buffer.from(getDataBytes(bytes))
+}
+
 /**
  * Extracts address bytes, handling both hex and Base58 formats.
  * @param address - Address in hex or Base58 format.
@@ -349,10 +385,7 @@ export function parseTypeAndVersion(
   typeAndVersion: string,
 ): Awaited<ReturnType<Chain['typeAndVersion']>> {
   const match = typeAndVersion.match(/^(\w.+\S)\s+v?(\d+\.\d+(?:\.\d+)?)([^\d.].*)?$/)
-  if (!match)
-    throw new Error(
-      `Invalid typeAndVersion: "${typeAndVersion}", len=${typeAndVersion.length}, hex=0x${Buffer.from(typeAndVersion).toString('hex')}`,
-    )
+  if (!match) throw new CCIPTypeVersionInvalidError(typeAndVersion)
   const [, typeRaw, version] = match
   // some string normalization
   const type = typeRaw
@@ -414,6 +447,7 @@ export function createRateLimitedFetch(
     if (method && methodRateLimits[method]) {
       while (isMethodRateLimited(method)) {
         const oldestRequest = methodRateLimits[method].queue[0]
+        if (!oldestRequest) break // Queue was cleaned, no longer rate limited
         const waitTime = windowMs - (Date.now() - oldestRequest.timestamp)
         if (waitTime > 0) {
           await sleep(waitTime + 100) // Add small buffer
@@ -424,6 +458,7 @@ export function createRateLimitedFetch(
     // Wait for global rate limit
     while (isRateLimited()) {
       const oldestRequest = requestQueue[0]
+      if (!oldestRequest) break // Queue was cleaned, no longer rate limited
       const waitTime = windowMs - (Date.now() - oldestRequest.timestamp)
       if (waitTime > 0) {
         await sleep(waitTime + 100) // Add small buffer
@@ -484,7 +519,7 @@ export function createRateLimitedFetch(
         recordRequest(method)
         // logger.debug('__fetching', input, init?.body)
 
-        const response = await fetch(input, init)
+        const response = await globalThis.fetch(input, init)
 
         // Update method rate limits from response headers
         updateMethodRateLimits(response, method)
@@ -497,15 +532,15 @@ export function createRateLimitedFetch(
 
         // For 429 responses, throw an error to trigger retry
         if (response.status === 429) {
-          throw new Error(`HTTP ${response.status}: ${response.statusText}`)
+          throw new CCIPHttpError(response.status, response.statusText)
         }
 
         // For other non-2xx responses, don't retry
         logger.debug('fetch non-retryable error', input, response.status, init?.body)
-        throw new Error(`HTTP ${response.status}: ${response.statusText}`)
+        throw new CCIPHttpError(response.status, response.statusText)
       } catch (error) {
         logger.debug('fetch errored', attempt, error, input, init?.body)
-        lastError = error instanceof Error ? error : new Error(String(error))
+        lastError = error instanceof Error ? error : CCIPError.from(error, 'HTTP_ERROR')
 
         // Only retry on rate limit errors
         if (!isRateLimitError(lastError)) {
@@ -519,7 +554,7 @@ export function createRateLimitedFetch(
       }
     }
 
-    throw lastError || new Error('Request failed after all retries')
+    throw lastError || CCIPError.from('Request failed after all retries', 'HTTP_ERROR')
   }
 }
 

package/tsconfig.json

@@ -14,6 +14,7 @@
     "verbatimModuleSyntax": true,
     "erasableSyntaxOnly": true,
     "resolveJsonModule": true,
-    "noImplicitOverride": true
+    "noImplicitOverride": true,
+    "useUnknownInCatchVariables": true
   }
 }