@chainlink/ccip-sdk 0.91.0 → 0.92.0

package/src/errors/utils.ts

@@ -0,0 +1,73 @@
+import { CCIPError } from './CCIPError.ts'
+import type { CCIPErrorCode } from './codes.ts'
+
+/** Returns retry delay in ms, or null if permanent. */
+export function getRetryDelay(error: CCIPError): number | null {
+  if (!error.isTransient) return null
+  return error.retryAfterMs ?? getDefaultRetryDelay(error.code)
+}
+
+function getDefaultRetryDelay(code: CCIPErrorCode): number {
+  switch (code) {
+    case 'BLOCK_NOT_FOUND':
+      return 12000
+    case 'MESSAGE_ID_NOT_FOUND':
+    case 'MESSAGE_NOT_FOUND_IN_TX':
+      return 30000
+    case 'COMMIT_NOT_FOUND':
+      return 60000
+    case 'HTTP_ERROR':
+      return 5000
+    case 'USDC_ATTESTATION_FAILED':
+    case 'LBTC_ATTESTATION_ERROR':
+      return 30000
+    default:
+      return 5000
+  }
+}
+
+/** Returns true if error is transient and should be retried. */
+export function shouldRetry(error: unknown): boolean {
+  if (error instanceof CCIPError) {
+    return error.isTransient
+  }
+  if (error instanceof Error) {
+    const msg = error.message.toLowerCase()
+    return (
+      msg.includes('timeout') ||
+      msg.includes('econnrefused') ||
+      msg.includes('network') ||
+      msg.includes('rate limit')
+    )
+  }
+  return false
+}
+
+/** Format error for structured logging. */
+export function formatErrorForLogging(error: CCIPError): Record<string, unknown> {
+  return {
+    name: error.name,
+    code: error.code,
+    message: error.message,
+    isTransient: error.isTransient,
+    context: error.context,
+    recovery: error.recovery,
+    stack: error.stack,
+    cause:
+      error.cause instanceof Error
+        ? { name: error.cause.name, message: error.cause.message }
+        : error.cause,
+  }
+}
+
+/** Assert condition or throw CCIPError. */
+export function assert(
+  condition: unknown,
+  code: CCIPErrorCode,
+  message: string,
+  context?: Record<string, unknown>,
+): asserts condition {
+  if (!condition) {
+    throw new CCIPError(code, message, { context, isTransient: false })
+  }
+}

package/src/evm/abi/CommitStore_1_5.ts

@@ -1,6 +1,6 @@
 export default [
   // generate:
-  // fetch('https://github.com/smartcontractkit/ccip/raw/release/2.14.0-ccip1.5/core/gethwrappers/ccip/generated/commit_store/commit_store.go')
+  // fetch('https://github.com/smartcontractkit/ccip/raw/release/2.17.0-ccip1.5/core/gethwrappers/ccip/generated/commit_store/commit_store.go')
   //   .then((res) => res.text())
   //   .then((body) => body.match(/^\s*ABI: "(.*?)",$/m)?.[1])
   //   .then((abi) => JSON.parse(abi.replace(/\\"/g, '"')))

package/src/evm/abi/LockReleaseTokenPool_1_5.ts

@@ -1,6 +1,6 @@
 export default [
   // generate:
-  // fetch('https://github.com/smartcontractkit/ccip/raw/release/2.14.0-ccip1.5/core/gethwrappers/ccip/generated/lock_release_token_pool/lock_release_token_pool.go')
+  // fetch('https://github.com/smartcontractkit/ccip/raw/release/2.17.0-ccip1.5/core/gethwrappers/ccip/generated/lock_release_token_pool/lock_release_token_pool.go')
   //   .then((res) => res.text())
   //   .then((body) => body.match(/^\s*ABI: "(.*?)",$/m)?.[1])
   //   .then((abi) => JSON.parse(abi.replace(/\\"/g, '"')))

package/src/evm/abi/OffRamp_1_5.ts

@@ -1,6 +1,6 @@
 export default [
   // generate:
-  // fetch('https://github.com/smartcontractkit/ccip/raw/release/2.14.0-ccip1.5/core/gethwrappers/ccip/generated/evm_2_evm_offramp/evm_2_evm_offramp.go')
+  // fetch('https://github.com/smartcontractkit/ccip/raw/release/2.17.0-ccip1.5/core/gethwrappers/ccip/generated/evm_2_evm_offramp/evm_2_evm_offramp.go')
   //   .then((res) => res.text())
   //   .then((body) => body.match(/^\s*ABI: "(.*?)",$/m)?.[1])
   //   .then((abi) => JSON.parse(abi.replace(/\\"/g, '"')))

package/src/evm/abi/OnRamp_1_5.ts

@@ -1,6 +1,6 @@
 export default [
   // generate:
-  // fetch('https://github.com/smartcontractkit/ccip/raw/release/2.14.0-ccip1.5/core/gethwrappers/ccip/generated/evm_2_evm_onramp/evm_2_evm_onramp.go')
+  // fetch('https://github.com/smartcontractkit/ccip/raw/release/2.17.0-ccip1.5/core/gethwrappers/ccip/generated/evm_2_evm_onramp/evm_2_evm_onramp.go')
   //   .then((res) => res.text())
   //   .then((body) => body.match(/^\s*ABI: "(.*?)",$/m)?.[1])
   //   .then((abi) => JSON.parse(abi.replace(/\\"/g, '"')))

package/src/evm/abi/PriceRegistry_1_2.ts

@@ -0,0 +1,438 @@
+export default [
+  // generate:
+  // fetch('https://github.com/smartcontractkit/ccip/raw/release/2.17.0-ccip1.5/core/gethwrappers/ccip/generated/price_registry_1_2_0/price_registry.go')
+  //   .then((res) => res.text())
+  //   .then((body) => body.match(/^\s*ABI: "(.*?)",$/m)?.[1])
+  //   .then((abi) => JSON.parse(abi.replace(/\\"/g, '"')))
+  //   .then((obj) => require('util').inspect(obj, {depth:99}).split('\n').slice(1, -1))
+  {
+    inputs: [
+      {
+        internalType: 'address[]',
+        name: 'priceUpdaters',
+        type: 'address[]',
+      },
+      {
+        internalType: 'address[]',
+        name: 'feeTokens',
+        type: 'address[]',
+      },
+      {
+        internalType: 'uint32',
+        name: 'stalenessThreshold',
+        type: 'uint32',
+      },
+    ],
+    stateMutability: 'nonpayable',
+    type: 'constructor',
+  },
+  {
+    inputs: [{ internalType: 'uint64', name: 'chain', type: 'uint64' }],
+    name: 'ChainNotSupported',
+    type: 'error',
+  },
+  { inputs: [], name: 'InvalidStalenessThreshold', type: 'error' },
+  { inputs: [], name: 'OnlyCallableByUpdaterOrOwner', type: 'error' },
+  {
+    inputs: [
+      {
+        internalType: 'uint64',
+        name: 'destChainSelector',
+        type: 'uint64',
+      },
+      { internalType: 'uint256', name: 'threshold', type: 'uint256' },
+      { internalType: 'uint256', name: 'timePassed', type: 'uint256' },
+    ],
+    name: 'StaleGasPrice',
+    type: 'error',
+  },
+  {
+    inputs: [
+      { internalType: 'address', name: 'token', type: 'address' },
+      { internalType: 'uint256', name: 'threshold', type: 'uint256' },
+      { internalType: 'uint256', name: 'timePassed', type: 'uint256' },
+    ],
+    name: 'StaleTokenPrice',
+    type: 'error',
+  },
+  {
+    inputs: [{ internalType: 'address', name: 'token', type: 'address' }],
+    name: 'TokenNotSupported',
+    type: 'error',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'feeToken',
+        type: 'address',
+      },
+    ],
+    name: 'FeeTokenAdded',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'feeToken',
+        type: 'address',
+      },
+    ],
+    name: 'FeeTokenRemoved',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'from',
+        type: 'address',
+      },
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'to',
+        type: 'address',
+      },
+    ],
+    name: 'OwnershipTransferRequested',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'from',
+        type: 'address',
+      },
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'to',
+        type: 'address',
+      },
+    ],
+    name: 'OwnershipTransferred',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'priceUpdater',
+        type: 'address',
+      },
+    ],
+    name: 'PriceUpdaterRemoved',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'priceUpdater',
+        type: 'address',
+      },
+    ],
+    name: 'PriceUpdaterSet',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'token',
+        type: 'address',
+      },
+      {
+        indexed: false,
+        internalType: 'uint256',
+        name: 'value',
+        type: 'uint256',
+      },
+      {
+        indexed: false,
+        internalType: 'uint256',
+        name: 'timestamp',
+        type: 'uint256',
+      },
+    ],
+    name: 'UsdPerTokenUpdated',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'uint64',
+        name: 'destChain',
+        type: 'uint64',
+      },
+      {
+        indexed: false,
+        internalType: 'uint256',
+        name: 'value',
+        type: 'uint256',
+      },
+      {
+        indexed: false,
+        internalType: 'uint256',
+        name: 'timestamp',
+        type: 'uint256',
+      },
+    ],
+    name: 'UsdPerUnitGasUpdated',
+    type: 'event',
+  },
+  {
+    inputs: [],
+    name: 'acceptOwnership',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'address[]',
+        name: 'feeTokensToAdd',
+        type: 'address[]',
+      },
+      {
+        internalType: 'address[]',
+        name: 'feeTokensToRemove',
+        type: 'address[]',
+      },
+    ],
+    name: 'applyFeeTokensUpdates',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'address[]',
+        name: 'priceUpdatersToAdd',
+        type: 'address[]',
+      },
+      {
+        internalType: 'address[]',
+        name: 'priceUpdatersToRemove',
+        type: 'address[]',
+      },
+    ],
+    name: 'applyPriceUpdatersUpdates',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'address', name: 'fromToken', type: 'address' },
+      {
+        internalType: 'uint256',
+        name: 'fromTokenAmount',
+        type: 'uint256',
+      },
+      { internalType: 'address', name: 'toToken', type: 'address' },
+    ],
+    name: 'convertTokenAmount',
+    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'uint64',
+        name: 'destChainSelector',
+        type: 'uint64',
+      },
+    ],
+    name: 'getDestinationChainGasPrice',
+    outputs: [
+      {
+        components: [
+          { internalType: 'uint224', name: 'value', type: 'uint224' },
+          { internalType: 'uint32', name: 'timestamp', type: 'uint32' },
+        ],
+        internalType: 'structInternal.TimestampedPackedUint224',
+        name: '',
+        type: 'tuple',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'getFeeTokens',
+    outputs: [{ internalType: 'address[]', name: '', type: 'address[]' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'getPriceUpdaters',
+    outputs: [{ internalType: 'address[]', name: '', type: 'address[]' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'getStalenessThreshold',
+    outputs: [{ internalType: 'uint128', name: '', type: 'uint128' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      { internalType: 'address', name: 'token', type: 'address' },
+      {
+        internalType: 'uint64',
+        name: 'destChainSelector',
+        type: 'uint64',
+      },
+    ],
+    name: 'getTokenAndGasPrices',
+    outputs: [
+      { internalType: 'uint224', name: 'tokenPrice', type: 'uint224' },
+      {
+        internalType: 'uint224',
+        name: 'gasPriceValue',
+        type: 'uint224',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [{ internalType: 'address', name: 'token', type: 'address' }],
+    name: 'getTokenPrice',
+    outputs: [
+      {
+        components: [
+          { internalType: 'uint224', name: 'value', type: 'uint224' },
+          { internalType: 'uint32', name: 'timestamp', type: 'uint32' },
+        ],
+        internalType: 'structInternal.TimestampedPackedUint224',
+        name: '',
+        type: 'tuple',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [{ internalType: 'address[]', name: 'tokens', type: 'address[]' }],
+    name: 'getTokenPrices',
+    outputs: [
+      {
+        components: [
+          { internalType: 'uint224', name: 'value', type: 'uint224' },
+          { internalType: 'uint32', name: 'timestamp', type: 'uint32' },
+        ],
+        internalType: 'structInternal.TimestampedPackedUint224[]',
+        name: '',
+        type: 'tuple[]',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [{ internalType: 'address', name: 'token', type: 'address' }],
+    name: 'getValidatedTokenPrice',
+    outputs: [{ internalType: 'uint224', name: '', type: 'uint224' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'owner',
+    outputs: [{ internalType: 'address', name: '', type: 'address' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [{ internalType: 'address', name: 'to', type: 'address' }],
+    name: 'transferOwnership',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'typeAndVersion',
+    outputs: [{ internalType: 'string', name: '', type: 'string' }],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        components: [
+          {
+            components: [
+              {
+                internalType: 'address',
+                name: 'sourceToken',
+                type: 'address',
+              },
+              {
+                internalType: 'uint224',
+                name: 'usdPerToken',
+                type: 'uint224',
+              },
+            ],
+            internalType: 'structInternal.TokenPriceUpdate[]',
+            name: 'tokenPriceUpdates',
+            type: 'tuple[]',
+          },
+          {
+            components: [
+              {
+                internalType: 'uint64',
+                name: 'destChainSelector',
+                type: 'uint64',
+              },
+              {
+                internalType: 'uint224',
+                name: 'usdPerUnitGas',
+                type: 'uint224',
+              },
+            ],
+            internalType: 'structInternal.GasPriceUpdate[]',
+            name: 'gasPriceUpdates',
+            type: 'tuple[]',
+          },
+        ],
+        internalType: 'structInternal.PriceUpdates',
+        name: 'priceUpdates',
+        type: 'tuple',
+      },
+    ],
+    name: 'updatePrices',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  // generate:end
+] as const

package/src/evm/const.ts

@@ -13,6 +13,7 @@ import OffRamp_1_6_ABI from './abi/OffRamp_1_6.ts'
 import EVM2EVMOnRamp_1_2_ABI from './abi/OnRamp_1_2.ts'
 import EVM2EVMOnRamp_1_5_ABI from './abi/OnRamp_1_5.ts'
 import OnRamp_1_6_ABI from './abi/OnRamp_1_6.ts'
+import PriceRegistry_1_2_ABI from './abi/PriceRegistry_1_2.ts'
 import Router_ABI from './abi/Router.ts'
 import TokenAdminRegistry_ABI from './abi/TokenAdminRegistry_1_5.ts'
 
@@ -43,6 +44,7 @@ export const interfaces = {
   OnRamp_v1_6: new Interface(OnRamp_1_6_ABI),
   EVM2EVMOnRamp_v1_5: new Interface(EVM2EVMOnRamp_1_5_ABI),
   EVM2EVMOnRamp_v1_2: new Interface(EVM2EVMOnRamp_1_2_ABI),
+  PriceRegistry_v1_2: new Interface(PriceRegistry_1_2_ABI),
   Custom: new Interface(customErrors),
 } as const
 

package/src/evm/hasher.ts

@@ -1,6 +1,7 @@
 import { concat, id, keccak256, toBeHex, zeroPadValue } from 'ethers'
 import type { ReadonlyDeep } from 'type-fest'
 
+import { CCIPExtraArgsInvalidError } from '../errors/index.ts'
 import { decodeExtraArgs } from '../extra-args.ts'
 import { type LeafHasher, LEAF_DOMAIN_SEPARATOR } from '../hasher/common.ts'
 import type { CCIPMessage, CCIPVersion, WithLogger } from '../types.ts'
@@ -112,13 +113,13 @@ export function getV16LeafHasher(
     logger.debug('Message', message)
     const parsedArgs = decodeExtraArgs(
       message.extraArgs,
-      networkInfo(message.header.sourceChainSelector).family,
+      networkInfo(message.sourceChainSelector).family,
     )
     if (
       !parsedArgs ||
       (parsedArgs._tag !== 'EVMExtraArgsV1' && parsedArgs._tag !== 'EVMExtraArgsV2')
     )
-      throw new Error('Invalid extraArgs, not EVMExtraArgsV1|2')
+      throw new CCIPExtraArgsInvalidError('EVM', message.extraArgs)
     const tokenAmounts = message.tokenAmounts.map((ta) => ({
       ...ta,
       sourcePoolAddress: zeroPadValue(getAddressBytes(ta.sourcePoolAddress), 32),
@@ -140,11 +141,11 @@ export function getV16LeafHasher(
         'uint64 nonce',
       ],
       [
-        message.header.messageId,
+        message.messageId,
         message.receiver,
-        message.header.sequenceNumber,
+        message.sequenceNumber,
         parsedArgs.gasLimit,
-        message.header.nonce,
+        message.nonce,
       ],
     )
 
@@ -170,7 +171,7 @@ export function getV16LeafHasher(
     )
 
     logger.debug('v1.6 leafHasher:', {
-      messageId: message.header.messageId,
+      messageId: message.messageId,
       encodedTokens,
       fixedSizeValues,
       packedValues,