viem 0.3.13 → 0.3.14

package/src/errors/base.ts

@@ -59,4 +59,14 @@ export class BaseError extends Error {
     this.metaMessages = args.metaMessages
     this.shortMessage = shortMessage
   }
+
+  walk(fn?: (err: unknown) => boolean) {
+    return this.#walk(this, fn)
+  }
+
+  #walk(err: unknown, fn?: (err: unknown) => boolean): unknown {
+    if (fn?.(err)) return err
+    if ((err as Error).cause) return this.#walk((err as Error).cause, fn)
+    return err
+  }
 }

package/src/errors/ccip.ts

@@ -0,0 +1,74 @@
+import type { Address } from 'abitype'
+import { BaseError } from './base.js'
+import type { Hex } from '../types/index.js'
+import { getUrl } from './utils.js'
+
+export class OffchainLookupError extends BaseError {
+  override name = 'OffchainLookupError'
+  constructor({
+    callbackSelector,
+    cause,
+    data,
+    extraData,
+    sender,
+    urls,
+  }: {
+    callbackSelector: Hex
+    cause: BaseError
+    data: Hex
+    extraData: Hex
+    sender: Address
+    urls: readonly string[]
+  }) {
+    super(
+      cause.shortMessage ||
+        'An error occurred while fetching for an offchain result.',
+      {
+        cause,
+        metaMessages: [
+          ...(cause.metaMessages || []),
+          cause.metaMessages?.length ? '' : [],
+          'Offchain Gateway Call:',
+          urls && [
+            '  Gateway URL(s):',
+            ...urls.map((url) => `    ${getUrl(url)}`),
+          ],
+          `  Sender: ${sender}`,
+          `  Data: ${data}`,
+          `  Callback selector: ${callbackSelector}`,
+          `  Extra data: ${extraData}`,
+        ].flat(),
+      },
+    )
+  }
+}
+
+export class OffchainLookupResponseMalformedError extends BaseError {
+  override name = 'OffchainLookupResponseMalformedError'
+  constructor({ result, url }: { result: any; url: string }) {
+    super(
+      'Offchain gateway response is malformed. Response data must be a hex value.',
+      {
+        metaMessages: [
+          `Gateway URL: ${getUrl(url)}`,
+          `Response: ${JSON.stringify(result)}`,
+        ],
+      },
+    )
+  }
+}
+
+export class OffchainLookupSenderMismatchError extends BaseError {
+  override name = 'OffchainLookupSenderMismatchError'
+  constructor({ sender, to }: { sender: Address; to: Address }) {
+    super(
+      'Reverted sender address does not match target contract address (`to`).',
+      {
+        metaMessages: [
+          `Contract address: ${to}`,
+          `OffchainLookup sender address: ${sender}`,
+        ],
+      },
+    )
+  }
+}

package/src/errors/index.ts

@@ -41,6 +41,12 @@ export {
   InvalidChainIdError,
 } from './chain.js'
 
+export {
+  OffchainLookupError,
+  OffchainLookupResponseMalformedError,
+  OffchainLookupSenderMismatchError,
+} from './ccip.js'
+
 export {
   CallExecutionError,
   ContractFunctionExecutionError,

package/src/errors/request.ts

@@ -5,7 +5,7 @@ import { getUrl } from './utils.js'
 export class HttpRequestError extends BaseError {
   override name = 'HttpRequestError'
 
-  body: { [key: string]: unknown }
+  body?: { [key: string]: unknown }
   headers?: Headers
   status?: number
   url: string
@@ -17,7 +17,7 @@ export class HttpRequestError extends BaseError {
     status,
     url,
   }: {
-    body: { [key: string]: unknown }
+    body?: { [key: string]: unknown }
     details?: string
     headers?: Headers
     status?: number
@@ -28,7 +28,7 @@ export class HttpRequestError extends BaseError {
       metaMessages: [
         status && `Status: ${status}`,
         `URL: ${getUrl(url)}`,
-        `Request body: ${stringify(body)}`,
+        body && `Request body: ${stringify(body)}`,
       ].filter(Boolean) as string[],
     })
     this.body = body

package/src/errors/version.ts

@@ -1 +1 @@
-export const version = '0.3.13'
+export const version = '0.3.14'

package/src/index.ts

@@ -159,6 +159,7 @@ export {
   etherUnits,
   gweiUnits,
   weiUnits,
+  zeroAddress,
 } from './constants/index.js'
 
 export {
@@ -398,6 +399,7 @@ export {
   bytesToHex,
   bytesToNumber,
   bytesToString,
+  ccipFetch,
   concat,
   concatBytes,
   concatHex,
@@ -452,6 +454,9 @@ export {
   keccak256,
   numberToBytes,
   numberToHex,
+  offchainLookup,
+  offchainLookupAbiItem,
+  offchainLookupSignature,
   pad,
   padBytes,
   padHex,

package/src/utils/ccip.ts

@@ -0,0 +1,136 @@
+import { parseAbiItem, parseAbiParameters, type Address } from 'abitype'
+import type { PublicClient, Transport } from '../clients/index.js'
+import {
+  BaseError,
+  HttpRequestError,
+  OffchainLookupError,
+  OffchainLookupResponseMalformedError,
+  OffchainLookupSenderMismatchError,
+} from '../errors/index.js'
+import { call, type CallParameters } from '../public.js'
+import type { Chain, GetErrorArgs, Hex } from '../types/index.js'
+import { decodeErrorResult, encodeAbiParameters } from './abi/index.js'
+import { isAddressEqual } from './address/index.js'
+import { concat, isHex } from './data/index.js'
+import { stringify } from './stringify.js'
+
+export const offchainLookupSignature = '0x556f1830'
+export const offchainLookupAbiItem = parseAbiItem(
+  'error OffchainLookup(address sender, string[] urls, bytes callData, bytes4 callbackFunction, bytes extraData)',
+)
+
+export async function offchainLookup<TChain extends Chain | undefined>(
+  client: PublicClient<Transport, TChain>,
+  {
+    blockNumber,
+    blockTag,
+    data,
+    to,
+  }: Pick<CallParameters, 'blockNumber' | 'blockTag'> & {
+    data: Hex
+    to: Address
+  },
+): Promise<Hex> {
+  const { args } = decodeErrorResult({
+    data,
+    abi: [offchainLookupAbiItem],
+  }) as unknown as GetErrorArgs<
+    [typeof offchainLookupAbiItem],
+    'OffchainLookup'
+  >
+  const [sender, urls, callData, callbackSelector, extraData] = args
+
+  try {
+    if (!isAddressEqual(to, sender))
+      throw new OffchainLookupSenderMismatchError({ sender, to })
+
+    const result = await ccipFetch({ data: callData, sender, urls })
+
+    const { data: data_ } = await call(client, {
+      blockNumber,
+      blockTag,
+      data: concat([
+        callbackSelector,
+        encodeAbiParameters(parseAbiParameters('bytes,bytes'), [
+          result,
+          extraData,
+        ]),
+      ]),
+      to,
+    } as CallParameters)
+
+    return data_!
+  } catch (err) {
+    throw new OffchainLookupError({
+      callbackSelector,
+      cause: err as BaseError,
+      data,
+      extraData,
+      sender,
+      urls,
+    })
+  }
+}
+
+export async function ccipFetch({
+  data,
+  sender,
+  urls,
+}: { data: Hex; sender: Address; urls: readonly string[] }) {
+  let error = new Error('An unknown error occurred.')
+
+  for (let i = 0; i < urls.length; i++) {
+    const url = urls[i]
+    const method =
+      url.includes('{sender}') || url.includes('{data}') ? 'GET' : 'POST'
+    const body = method === 'POST' ? { data, sender } : undefined
+
+    try {
+      const response = await fetch(
+        url.replace('{sender}', sender).replace('{data}', data),
+        {
+          body: JSON.stringify(body),
+          method,
+        },
+      )
+
+      let result
+      if (
+        response.headers.get('Content-Type')?.startsWith('application/json')
+      ) {
+        result = (await response.json()).data
+      } else {
+        result = (await response.text()) as any
+      }
+
+      if (!response.ok) {
+        error = new HttpRequestError({
+          body,
+          details: stringify(result.error) || response.statusText,
+          headers: response.headers,
+          status: response.status,
+          url,
+        })
+        continue
+      }
+
+      if (!isHex(result)) {
+        error = new OffchainLookupResponseMalformedError({
+          result,
+          url,
+        })
+        continue
+      }
+
+      return result
+    } catch (err) {
+      error = new HttpRequestError({
+        body,
+        details: (err as Error).message,
+        url,
+      })
+    }
+  }
+
+  throw error
+}

package/src/utils/errors/getContractError.ts

@@ -3,11 +3,9 @@ import type { BaseError } from '../../errors/index.js'
 import {
   AbiDecodingZeroDataError,
   ContractFunctionExecutionError,
-  EstimateGasExecutionError,
   RawContractError,
 } from '../../errors/index.js'
 import {
-  CallExecutionError,
   ContractFunctionRevertedError,
   ContractFunctionZeroDataError,
 } from '../../errors/contract.js'
@@ -36,11 +34,7 @@ export function getContractError(
   const { code, data, message, shortMessage } = (
     err instanceof RawContractError
       ? err
-      : !(err.cause && 'data' in (err.cause as BaseError)) &&
-        (err instanceof CallExecutionError ||
-          err instanceof EstimateGasExecutionError)
-      ? ((err.cause as BaseError)?.cause as BaseError)?.cause || {}
-      : err.cause || {}
+      : err.walk((err) => 'data' in (err as Error))
   ) as RawContractError
 
   let cause = err

package/src/utils/errors/getNodeError.ts

@@ -67,7 +67,7 @@ export function getNodeError(
   )
     return new ExecutionRevertedError({
       cause: err,
-      message: (err.cause as BaseError).details,
+      message: (err.cause as BaseError).details || err.details,
     })
   return new UnknownNodeError({
     cause: (err.cause as BaseError).cause as BaseError,

package/src/utils/index.ts

@@ -60,6 +60,13 @@ export {
 
 export { buildRequest } from './buildRequest.js'
 
+export {
+  ccipFetch,
+  offchainLookup,
+  offchainLookupAbiItem,
+  offchainLookupSignature,
+} from './ccip.js'
+
 export { defineChain, getChainContractAddress } from './chain.js'
 
 export {