viem 2.57.4 → 2.57.6

package/tempo/actions/nonce.ts

@@ -6,12 +6,20 @@ import type { WatchContractEventParameters } from '../../actions/public/watchCon
 import { watchContractEvent } from '../../actions/public/watchContractEvent.js'
 import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
+import type { BaseErrorType } from '../../errors/base.js'
 import type { Chain } from '../../types/chain.js'
 import type { ExtractAbiItem, GetEventArgs } from '../../types/contract.js'
 import type { Log as viem_Log } from '../../types/log.js'
 import type { UnionOmit } from '../../types/utils.js'
 import * as Abis from '../Abis.js'
 import * as Addresses from '../Addresses.js'
+import type * as Errors from '../errors.js'
+import { TempoExecutionError } from '../errors.js'
+import {
+  formatTime,
+  type Resolvers,
+  withExecutionError,
+} from '../internal/errors.js'
 import type { ReadParameters } from '../internal/types.js'
 import { defineCall } from '../internal/utils.js'
 
@@ -47,7 +55,7 @@ export async function getNonce<
   parameters: getNonce.Parameters,
 ): Promise<getNonce.ReturnValue> {
   const { account, nonceKey, ...rest } = parameters
-  return readContract(client, {
+  return withExecutionError(readContract)(client, {
     ...rest,
     ...getNonce.call({ account, nonceKey }),
   })
@@ -108,6 +116,8 @@ export namespace getNonce {
       functionName: 'getNonce',
     })
   }
+
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 export function watchNonceIncremented<
@@ -153,3 +163,78 @@ export declare namespace watchNonceIncremented {
     onNonceIncremented: (args: Args, log: Log) => void
   }
 }
+
+// Errors
+
+/** Errors this module throws for decoded Tempo errors. Narrow with `error.name`. */
+export type ExecutionErrorType =
+  | NonceInvalidExpiryErrorType
+  | NonceReplayErrorType
+
+/** `NonceReplayError` with a literal `name`, for narrowing. */
+export type NonceReplayErrorType = NonceReplayError & {
+  name: 'NonceReplayError'
+}
+
+/** Thrown when an expiring nonce transaction was already submitted. */
+export class NonceReplayError extends TempoExecutionError<
+  Errors.TempoExecutionError.Decoded<'ExpiringNonceReplay'>
+> {
+  /** Transaction expiry (Unix seconds), when known. */
+  validBefore: number | bigint | undefined
+
+  constructor(
+    parameters: Errors.TempoExecutionError.Parameters & {
+      validBefore?: number | bigint | undefined
+    },
+  ) {
+    super(parameters, {
+      details: { 'valid before': formatTime(parameters.validBefore) },
+      name: 'NonceReplayError',
+    })
+    this.validBefore = parameters.validBefore
+  }
+}
+
+/** `NonceInvalidExpiryError` with a literal `name`, for narrowing. */
+export type NonceInvalidExpiryErrorType = NonceInvalidExpiryError & {
+  name: 'NonceInvalidExpiryError'
+}
+
+/** Thrown when an expiring nonce transaction's `validBefore` is in the past or too far ahead. */
+export class NonceInvalidExpiryError extends TempoExecutionError<
+  Errors.TempoExecutionError.Decoded<'InvalidExpiringNonceExpiry'>
+> {
+  /** Current time (Unix seconds) when the error was handled. */
+  now: number
+  /** Transaction expiry (Unix seconds), when known. */
+  validBefore: number | bigint | undefined
+
+  constructor(
+    parameters: Errors.TempoExecutionError.Parameters & {
+      validBefore?: number | bigint | undefined
+    },
+  ) {
+    const now = Math.floor(Date.now() / 1000)
+    super(parameters, {
+      details: {
+        'valid before': formatTime(parameters.validBefore),
+        now: formatTime(now),
+      },
+      name: 'NonceInvalidExpiryError',
+    })
+    this.now = now
+    this.validBefore = parameters.validBefore
+  }
+}
+
+/** @internal */
+export const errorResolvers: Resolvers = {
+  'ExpiringNonceReplay()': ({ base, parameters }) =>
+    new NonceReplayError({ ...base, validBefore: parameters.validBefore }),
+  'InvalidExpiringNonceExpiry()': ({ base, parameters }) =>
+    new NonceInvalidExpiryError({
+      ...base,
+      validBefore: parameters.validBefore,
+    }),
+}

package/tempo/actions/policy.ts

@@ -18,6 +18,9 @@ import type { Compute, UnionOmit } from '../../types/utils.js'
 import { parseEventLogs } from '../../utils/abi/parseEventLogs.js'
 import * as Abis from '../Abis.js'
 import * as Addresses from '../Addresses.js'
+import type * as Errors from '../errors.js'
+import { TempoExecutionError } from '../errors.js'
+import { type Resolvers, withExecutionError } from '../internal/errors.js'
 import type { ReadParameters, WriteParameters } from '../internal/types.js'
 import { defineCall } from '../internal/utils.js'
 import type { TransactionReceipt } from '../Transaction.js'
@@ -87,7 +90,7 @@ export namespace create {
   export type ReturnValue = WriteContractReturnType
 
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 
   /** @internal */
   export async function inner<
@@ -112,7 +115,7 @@ export namespace create {
     const admin = parseAccount(account).address!
 
     const call = create.call({ admin, type, addresses })
-    return action(client, {
+    return withExecutionError(action)(client, {
       ...rest,
       account,
       chain,
@@ -261,7 +264,7 @@ export namespace createSync {
   >
 
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -316,7 +319,7 @@ export namespace setAdmin {
   export type ReturnValue = WriteContractReturnType
 
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 
   /** @internal */
   export async function inner<
@@ -330,7 +333,7 @@ export namespace setAdmin {
   ): Promise<ReturnType<action>> {
     const { policyId, admin, ...rest } = parameters
     const call = setAdmin.call({ policyId, admin })
-    return (await action(client, {
+    return (await withExecutionError(action)(client, {
       ...rest,
       ...call,
     } as never)) as never
@@ -466,7 +469,7 @@ export namespace setAdminSync {
   >
 
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -524,7 +527,7 @@ export namespace modifyWhitelist {
   export type ReturnValue = WriteContractReturnType
 
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 
   /** @internal */
   export async function inner<
@@ -542,7 +545,7 @@ export namespace modifyWhitelist {
       allowed,
       policyId,
     })
-    return (await action(client, {
+    return (await withExecutionError(action)(client, {
       ...rest,
       ...call,
     } as never)) as never
@@ -681,7 +684,7 @@ export namespace modifyWhitelistSync {
   >
 
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -739,7 +742,7 @@ export namespace modifyBlacklist {
   export type ReturnValue = WriteContractReturnType
 
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 
   /** @internal */
   export async function inner<
@@ -757,7 +760,7 @@ export namespace modifyBlacklist {
       policyId,
       restricted,
     })
-    return (await action(client, {
+    return (await withExecutionError(action)(client, {
       ...rest,
       ...call,
     } as never)) as never
@@ -896,7 +899,7 @@ export namespace modifyBlacklistSync {
   >
 
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -927,7 +930,7 @@ export async function getData<chain extends Chain | undefined>(
   parameters: getData.Parameters,
 ): Promise<getData.ReturnValue> {
   const { policyId, ...rest } = parameters
-  const result = await readContract(client, {
+  const result = await withExecutionError(readContract)(client, {
     ...rest,
     ...getData.call({ policyId }),
   })
@@ -967,6 +970,8 @@ export namespace getData {
       functionName: 'policyData',
     })
   }
+
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -998,7 +1003,7 @@ export async function isAuthorized<chain extends Chain | undefined>(
   parameters: isAuthorized.Parameters,
 ): Promise<isAuthorized.ReturnValue> {
   const { policyId, user, ...rest } = parameters
-  return readContract(client, {
+  return withExecutionError(readContract)(client, {
     ...rest,
     ...isAuthorized.call({ policyId, user }),
   })
@@ -1035,6 +1040,8 @@ export namespace isAuthorized {
       functionName: 'isAuthorized',
     })
   }
+
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -1335,3 +1342,48 @@ export declare namespace watchBlacklistUpdated {
     onBlacklistUpdated: (args: Args, log: Log) => void
   }
 }
+
+// Errors
+
+/** Errors this module throws for decoded Tempo errors. Narrow with `error.name`. */
+export type ExecutionErrorType = PolicyNotFoundErrorType
+
+/** `PolicyNotFoundError` with a literal `name`, for narrowing. */
+export type PolicyNotFoundErrorType = PolicyNotFoundError & {
+  name: 'PolicyNotFoundError'
+}
+
+/** Thrown when a transfer policy does not exist. */
+export class PolicyNotFoundError extends TempoExecutionError<
+  Errors.TempoExecutionError.Decoded<'PolicyNotFound'>
+> {
+  /** Policy ID, when known. */
+  policyId: bigint | undefined
+
+  constructor(
+    parameters: Errors.TempoExecutionError.Parameters & {
+      policyId?: bigint | undefined
+    },
+  ) {
+    const { policyId } = parameters
+    super(parameters, {
+      details: { policy: policyId },
+      name: 'PolicyNotFoundError',
+      shortMessage:
+        policyId === undefined
+          ? undefined
+          : `Transfer policy ${policyId} does not exist.`,
+    })
+    this.policyId = policyId
+  }
+}
+
+/** @internal */
+export const errorResolvers: Resolvers = {
+  'PolicyNotFound()': ({ base, call }) =>
+    new PolicyNotFoundError({
+      ...base,
+      policyId:
+        call?.arg<bigint>('policyId') ?? call?.arg<bigint>('newPolicyId'),
+    }),
+}

package/tempo/actions/propAmm.ts

@@ -23,6 +23,8 @@ import { isAddressEqual } from '../../utils/address/isAddressEqual.js'
 import { pad } from '../../utils/data/pad.js'
 import * as Abis from '../Abis.js'
 import * as Expiry from '../Expiry.js'
+import type * as Errors from '../errors.js'
+import { withExecutionError } from '../internal/errors.js'
 import type { ReadParameters, WriteParameters } from '../internal/types.js'
 import { defineCall, pickWriteParameters } from '../internal/utils.js'
 import type { TransactionReceipt } from '../Transaction.js'
@@ -52,7 +54,10 @@ export async function baseToken<chain extends Chain | undefined>(
   parameters: baseToken.Parameters,
 ): Promise<baseToken.ReturnValue> {
   const { pool, ...rest } = parameters
-  return readContract(client, { ...rest, ...baseToken.call({ pool }) })
+  return withExecutionError(readContract)(client, {
+    ...rest,
+    ...baseToken.call({ pool }),
+  })
 }
 
 export namespace baseToken {
@@ -78,6 +83,8 @@ export namespace baseToken {
       functionName: 'baseToken',
     })
   }
+
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -103,7 +110,10 @@ export async function quoteToken<chain extends Chain | undefined>(
   parameters: quoteToken.Parameters,
 ): Promise<quoteToken.ReturnValue> {
   const { pool, ...rest } = parameters
-  return readContract(client, { ...rest, ...quoteToken.call({ pool }) })
+  return withExecutionError(readContract)(client, {
+    ...rest,
+    ...quoteToken.call({ pool }),
+  })
 }
 
 export namespace quoteToken {
@@ -129,6 +139,8 @@ export namespace quoteToken {
       functionName: 'quoteToken',
     })
   }
+
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -154,7 +166,10 @@ export async function paused<chain extends Chain | undefined>(
   parameters: paused.Parameters,
 ): Promise<paused.ReturnValue> {
   const { pool, ...rest } = parameters
-  return readContract(client, { ...rest, ...paused.call({ pool }) })
+  return withExecutionError(readContract)(client, {
+    ...rest,
+    ...paused.call({ pool }),
+  })
 }
 
 export namespace paused {
@@ -180,6 +195,8 @@ export namespace paused {
       functionName: 'paused',
     })
   }
+
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -205,7 +222,7 @@ export async function takerAllowed<chain extends Chain | undefined>(
   parameters: takerAllowed.Parameters,
 ): Promise<takerAllowed.ReturnValue> {
   const { pool, taker, ...rest } = parameters
-  return readContract(client, {
+  return withExecutionError(readContract)(client, {
     ...rest,
     ...takerAllowed.call({ pool, taker }),
   })
@@ -237,6 +254,8 @@ export namespace takerAllowed {
       functionName: 'takerAllowed',
     })
   }
+
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -262,7 +281,7 @@ export async function recipientAllowed<chain extends Chain | undefined>(
   parameters: recipientAllowed.Parameters,
 ): Promise<recipientAllowed.ReturnValue> {
   const { pool, recipient, ...rest } = parameters
-  return readContract(client, {
+  return withExecutionError(readContract)(client, {
     ...rest,
     ...recipientAllowed.call({ pool, recipient }),
   })
@@ -294,6 +313,8 @@ export namespace recipientAllowed {
       functionName: 'recipientAllowed',
     })
   }
+
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -319,7 +340,7 @@ export async function resolveRecipient<chain extends Chain | undefined>(
   parameters: resolveRecipient.Parameters,
 ): Promise<resolveRecipient.ReturnValue> {
   const { pool, recipient, ...rest } = parameters
-  return readContract(client, {
+  return withExecutionError(readContract)(client, {
     ...rest,
     ...resolveRecipient.call({ pool, recipient }),
   })
@@ -351,6 +372,8 @@ export namespace resolveRecipient {
       functionName: 'resolveRecipient',
     })
   }
+
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -396,7 +419,9 @@ export async function getSwapQuote(
   if (!recipient) throw new AccountNotFoundError()
   const baseToQuote = parameters.baseToQuote ?? true
   const customerId = parameters.customerId ?? pad(taker, { size: 32 })
-  const [amount, price, updatedAt, creditAfter] = await (readContract(client, {
+  const [amount, price, updatedAt, creditAfter] = await (withExecutionError(
+    readContract,
+  )(client, {
     ...parameters,
     ...getSwapQuote.call({
       ...parameters,
@@ -766,7 +791,7 @@ export namespace swap {
 
   export type ReturnValue = SendTransactionReturnType
 
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 
   /** @internal */
   export async function inner<
@@ -778,7 +803,7 @@ export namespace swap {
     client: Client<Transport, chain, account>,
     parameters: Parameters<chain, account>,
   ): Promise<ReturnType<action>> {
-    return (await action(client, {
+    return (await withExecutionError(action)(client, {
       ...parameters,
       calls: await getCalls(client, parameters),
     } as never)) as never
@@ -995,4 +1020,6 @@ export namespace swapSync {
       receipt: TransactionReceipt
     }
   >
+
+  export type ErrorType = swap.ErrorType
 }

package/tempo/actions/receivePolicy.ts

@@ -22,6 +22,8 @@ import { parseEventLogs } from '../../utils/abi/parseEventLogs.js'
 import { isAddressEqual } from '../../utils/index.js'
 import * as Abis from '../Abis.js'
 import * as Addresses from '../Addresses.js'
+import type * as Errors from '../errors.js'
+import { withExecutionError } from '../internal/errors.js'
 import type {
   GetAccountParameter,
   ReadParameters,
@@ -138,7 +140,7 @@ export namespace burn {
   export type ReturnValue = WriteContractReturnType
 
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 
   /** @internal */
   export async function inner<
@@ -160,7 +162,7 @@ export namespace burn {
     if (!account) throw new Error('`account` is required')
 
     const call = burn.call({ receipt })
-    return action(client, {
+    return withExecutionError(action)(client, {
       ...rest,
       account,
       chain,
@@ -267,7 +269,7 @@ export namespace burnSync {
   >
 
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -322,7 +324,7 @@ export namespace claim {
   export type ReturnValue = WriteContractReturnType
 
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 
   /** @internal */
   export async function inner<
@@ -345,7 +347,7 @@ export namespace claim {
     if (!account) throw new Error('`account` is required')
 
     const call = claim.call({ to, receipt })
-    return action(client, {
+    return withExecutionError(action)(client, {
       ...rest,
       account,
       chain,
@@ -453,7 +455,7 @@ export namespace claimSync {
   >
 
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -496,7 +498,7 @@ export async function get<
     tokenPolicyId,
     tokenPolicyType,
     recoveryAuthority,
-  ] = await readContract(client, {
+  ] = await withExecutionError(readContract)(client, {
     ...rest,
     account: null as never,
     ...get.call({ account: account.address }),
@@ -554,6 +556,8 @@ export namespace get {
       args: [account],
     })
   }
+
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -584,7 +588,7 @@ export async function getBlockedBalance<chain extends Chain | undefined>(
   parameters: getBlockedBalance.Parameters,
 ): Promise<getBlockedBalance.ReturnValue> {
   const { receipt, ...rest } = parameters
-  return readContract(client, {
+  return withExecutionError(readContract)(client, {
     ...rest,
     ...getBlockedBalance.call({ receipt }),
   })
@@ -619,6 +623,8 @@ export namespace getBlockedBalance {
       args: [receipt],
     })
   }
+
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -690,7 +696,7 @@ export namespace set {
   export type ReturnValue = WriteContractReturnType
 
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 
   /** @internal */
   export async function inner<
@@ -721,7 +727,7 @@ export namespace set {
       tokenFilterId: resolvePolicyRef(tokenPolicyId),
       recoveryAuthority,
     })
-    return action(client, {
+    return withExecutionError(action)(client, {
       ...rest,
       account,
       chain,
@@ -849,7 +855,7 @@ export namespace setSync {
   >
 
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -886,10 +892,13 @@ export async function validate<chain extends Chain | undefined>(
   parameters: validate.Parameters,
 ): Promise<validate.ReturnValue> {
   const { token, sender, receiver, ...rest } = parameters
-  const [authorized, blockedReason] = await readContract(client, {
-    ...rest,
-    ...validate.call({ token, sender, receiver }),
-  })
+  const [authorized, blockedReason] = await withExecutionError(readContract)(
+    client,
+    {
+      ...rest,
+      ...validate.call({ token, sender, receiver }),
+    },
+  )
   return {
     authorized,
     blockedReason: blockedReasons[blockedReason] ?? 'none',
@@ -930,6 +939,8 @@ export namespace validate {
       args: [token, sender, receiver],
     })
   }
+
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**