viem 2.57.5 → 2.57.6

package/tempo/ExecutionError.ts

@@ -8,7 +8,7 @@ import { formatAbiItem } from '../utils/abi/formatAbiItem.js'
 import { toFunctionSelector } from '../utils/hash/toFunctionSelector.js'
 import * as Abis from './Abis.js'
 
-type AllAbis = typeof Abis.core
+type AllAbis = typeof Abis.coreErrors
 type AbiErrorName = Extract<AllAbis[number], { type: 'error' }>['name']
 
 type DecodedError<error = DecodeErrorResultReturnType<AllAbis>> =
@@ -230,6 +230,88 @@ export const messages: Record<`${AbiErrorName}(${string})`, string> = {
   'ZeroPublicKey()': 'Public key cannot be zero.',
 }
 
+/** Steps to resolve an error, keyed by error signature in `Abis.core`. */
+export const hints: Partial<Record<keyof typeof messages, readonly string[]>> =
+  {
+    'CallNotAllowed()': [
+      "The access key's scopes do not allow this target, selector, or recipient.",
+      'Authorize an access key whose scopes include this call.',
+    ],
+    'ContractPaused()': [
+      'The token is paused. An account with the unpause role can unpause it.',
+    ],
+    'ExpiringNonceReplay()': ['Resend the transaction with a new nonce.'],
+    'ExpiryInPast()': ['Set the expiry to a future time.'],
+    'InsufficientAllowance()': [
+      'Approve the spender for at least this amount.',
+    ],
+    'InsufficientBalance(uint256,uint256,address)': [
+      'Fund the account or lower the amount.',
+    ],
+    'InsufficientFeeTokenBalance()': [
+      'Fund the account with the fee token, or pay fees with another token.',
+    ],
+    'KeyAlreadyExists()': ['Use a new access key, or revoke the existing one.'],
+    'KeyAlreadyRevoked()': [
+      'Revoked access keys cannot be used or re-authorized. Authorize a new access key.',
+    ],
+    'KeyExpired()': ['Authorize a new access key.'],
+    'KeyNotFound()': [
+      'Authorize the access key first, or authorize it in the same transaction with a key authorization.',
+    ],
+    'PolicyForbids()': [
+      'The token transfer policy forbids this sender or recipient.',
+    ],
+    'SpendingLimitExceeded()': [
+      'Raise the spending limit, or wait for a periodic limit to reset.',
+    ],
+    'UnauthorizedCaller()': ['Sign with the root key or an admin access key.'],
+    'AmountExceedsDeposit()': [
+      'Top up the channel, or use a voucher for a smaller amount.',
+    ],
+    'AmountNotIncreasing()': [
+      'Use a voucher with a higher cumulative amount than the amount already settled.',
+    ],
+    'BelowMinimumOrderSize(uint128)': ['Place a larger order.'],
+    'ChannelNotFound()': [
+      'Check the channel details, or open the channel first.',
+    ],
+    'CloseNotReady()': [
+      'Request a close, then wait for the grace period to end before withdrawing.',
+    ],
+    'InsufficientBalance()': [
+      'Deposit more of the token, or lower the amount.',
+    ],
+    'InsufficientLiquidity()': ['Use a smaller amount.'],
+    'InsufficientOutput()': [
+      'Lower the minimum output amount, or sell a smaller amount.',
+    ],
+    'InsufficientReserves()': ['Use a smaller amount.'],
+    'InvalidExpiringNonceExpiry()': [
+      'Set the transaction expiry to a time in the near future.',
+    ],
+    'InvalidFlipTick()': [
+      'Choose a flip tick on the correct side of the order tick.',
+    ],
+    'MaxInputExceeded()': [
+      'Raise the maximum input amount, or buy a smaller amount.',
+    ],
+    'OrderDoesNotExist()': [
+      'Check the order ID. Filled and cancelled orders no longer exist.',
+    ],
+    'OrderNotStale()': [
+      'Only orders whose maker lost authorization can be cancelled as stale.',
+    ],
+    'PairDoesNotExist()': ['Create the trading pair first.'],
+    'PolicyNotFound()': ['Check the policy ID, or create the policy first.'],
+    'SignatureTypeMismatch(uint8,uint8)': [
+      'Sign with the same key type the access key was authorized with.',
+    ],
+    'SupplyCapExceeded()': ['Mint a smaller amount, or raise the supply cap.'],
+    'TickOutOfBounds(int16)': ['Use a tick within the allowed range.'],
+    'Unauthorized()': ['The account lacks the permission this call requires.'],
+  }
+
 /** Interpolate `{0}`, `{1}`, … placeholders with args. */
 function interpolate(template: string, args?: readonly unknown[]): string {
   if (!args) return template
@@ -370,7 +452,7 @@ function parse(error: Exclude<from.Parameters, Hex>): ExecutionError {
   const data = extractRevertData(error)
   if (data) {
     try {
-      const decoded = decodeErrorResult({ abi: Abis.core, data })
+      const decoded = decodeErrorResult({ abi: Abis.coreErrors, data })
       const template =
         messages[formatAbiItem(decoded.abiItem) as keyof typeof messages]
       return {
@@ -382,7 +464,7 @@ function parse(error: Exclude<from.Parameters, Hex>): ExecutionError {
       } as never
     } catch {
       if (data.length === 10) {
-        const abiItem = Abis.core.find(
+        const abiItem = Abis.coreErrors.find(
           (item) =>
             item.type === 'error' &&
             toFunctionSelector(formatAbiItem(item)) === data.toLowerCase(),
@@ -399,6 +481,22 @@ function parse(error: Exclude<from.Parameters, Hex>): ExecutionError {
     }
   }
 
+  // Nodes print zero-argument errors as `Name(Name)`, whose revert data is the selector alone.
+  const debugMatch = /\b(\w+)\(\1\)/.exec(raw)
+  const abiItem = debugMatch
+    ? Abis.coreErrors.find(
+        (item) => item.name === debugMatch[1] && item.inputs.length === 0,
+      )
+    : undefined
+  if (abiItem)
+    return {
+      abiItem,
+      args: undefined,
+      data: toFunctionSelector(formatAbiItem(abiItem)),
+      errorName: abiItem.name,
+      message: messages[formatAbiItem(abiItem) as keyof typeof messages]!,
+    } as DecodedError
+
   // Human-readable names cannot distinguish overloads with different templates.
   const nameMatch = /:\s*(\w+)\(([^)]*)\)/.exec(raw)
   if (nameMatch) {