viem 2.57.5 → 2.57.6

package/tempo/actions/earn/deployment.ts

@@ -29,6 +29,8 @@ import { isAddressEqual } from '../../../utils/address/isAddressEqual.js'
 import { getChainContractAddress } from '../../../utils/chain/getChainContractAddress.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 {
   WriteParameters,
   WriteSyncParameters,
@@ -195,7 +197,7 @@ export namespace createErc4626Engine {
   export type ReturnValue = WriteContractReturnType
 
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 
   /** @internal */
   export async function inner<
@@ -221,7 +223,7 @@ export namespace createErc4626Engine {
     if (!account) throw new AccountNotFoundError()
     if (!owner_) throw new Error('`owner` is required.')
     const owner = parseAccount(owner_).address
-    return (await action(client, {
+    return (await withExecutionError(action)(client, {
       ...rest,
       account,
       chain,
@@ -389,7 +391,7 @@ export namespace createErc4626EngineSync {
     > & { receipt: TransactionReceipt }
   >
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -462,7 +464,7 @@ export namespace createStack {
   export type ReturnValue = WriteContractReturnType
 
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 
   /** @internal */
   export async function inner<
@@ -489,7 +491,7 @@ export namespace createStack {
     } = parameters
     if (!account) throw new AccountNotFoundError()
     if (!owner_) throw new Error('`owner` is required.')
-    return (await action(client, {
+    return (await withExecutionError(action)(client, {
       ...rest,
       account,
       chain,
@@ -657,7 +659,7 @@ export namespace createStackSync {
     > & { receipt: TransactionReceipt }
   >
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -713,7 +715,7 @@ export namespace bindEngine {
   > = WriteParameters<chain, account> & Args
   export type ReturnValue = WriteContractReturnType
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 
   /** @internal */
   export async function inner<
@@ -726,7 +728,7 @@ export namespace bindEngine {
     parameters: Parameters<chain, account>,
   ): Promise<ReturnType<action>> {
     const { engine, finalOwner, vault, ...rest } = parameters
-    return (await action(client, {
+    return (await withExecutionError(action)(client, {
       ...rest,
       ...bindEngine.call({ engine, finalOwner, vault }),
     } as never)) as never
@@ -860,7 +862,7 @@ export namespace bindEngineSync {
     vault: Address
   }
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 export type DeployErc4626StackErrorType = DeployErc4626StackError & {

package/tempo/actions/earn.ts

@@ -40,6 +40,7 @@ import { withResolvers } from '../../utils/promise/withResolvers.js'
 import { stringify } from '../../utils/stringify.js'
 import * as Abis from '../Abis.js'
 import * as Addresses from '../Addresses.js'
+import type * as Errors from '../errors.js'
 import {
   GetVaultEngineChangedError,
   type GetVaultEngineChangedErrorType,
@@ -48,6 +49,7 @@ import {
   WaitForPrivateRedeemTimeoutError,
   type WaitForPrivateRedeemTimeoutErrorType,
 } from '../errors.js'
+import { withExecutionError } from '../internal/errors.js'
 import type {
   GetAccountParameter,
   ReadParameters,
@@ -277,20 +279,20 @@ export async function validateExitSafePolicy<chain extends Chain | undefined>(
     parameters
   const [tokenPolicyId, compound, simplePolicy, memberResults] =
     await Promise.all([
-      readContract(client, {
+      withExecutionError(readContract)(client, {
         ...rest,
         abi: Abis.tip20,
         address: shareToken,
         functionName: 'transferPolicyId',
       }),
-      readContract(client, {
+      withExecutionError(readContract)(client, {
         ...rest,
         abi: Abis.tip403Registry,
         address: Addresses.tip403Registry,
         args: [policy.transferPolicyId],
         functionName: 'compoundPolicyData',
       }),
-      readContract(client, {
+      withExecutionError(readContract)(client, {
         ...rest,
         abi: Abis.tip403Registry,
         address: Addresses.tip403Registry,
@@ -300,14 +302,14 @@ export async function validateExitSafePolicy<chain extends Chain | undefined>(
       Promise.all(
         requiredMembers.map(async (member) => {
           const [recipient, mintRecipient] = await Promise.all([
-            readContract(client, {
+            withExecutionError(readContract)(client, {
               ...rest,
               abi: Abis.tip403Registry,
               address: Addresses.tip403Registry,
               args: [policy.transferPolicyId, member],
               functionName: 'isAuthorizedRecipient',
             }),
-            readContract(client, {
+            withExecutionError(readContract)(client, {
               ...rest,
               abi: Abis.tip403Registry,
               address: Addresses.tip403Registry,
@@ -359,7 +361,7 @@ export namespace validateExitSafePolicy {
   export type Parameters = Omit<ReadParameters, 'account'> & Args
   export type ReturnValue = void
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -427,7 +429,7 @@ export namespace deposit {
   > = WriteParameters<chain, account> & Args
   export type ReturnValue = SendTransactionReturnType
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 
   /** @internal Shared dispatch; reads the asset for the approval. */
   export async function inner<
@@ -441,13 +443,13 @@ export namespace deposit {
   ): Promise<ReturnType<action>> {
     const [args, assetToken] = await Promise.all([
       toDepositArgs(client, parameters as never),
-      readContract(client, {
+      withExecutionError(readContract)(client, {
         abi: Abis.earnVault,
         address: parameters.vault,
         functionName: 'asset',
       }),
     ])
-    return (await action(client, {
+    return (await withExecutionError(action)(client, {
       ...parameters,
       calls: deposit.calls({ ...args, assetToken }),
     } as never)) as never
@@ -659,7 +661,7 @@ export namespace depositSync {
     shareAmount: bigint
   }>
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -730,7 +732,7 @@ export namespace depositShares {
   > = WriteParameters<chain, account> & Args
   export type ReturnValue = SendTransactionReturnType
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 
   /** @internal Shared dispatch; reads the engine for the approval. */
   export async function inner<
@@ -742,12 +744,12 @@ export namespace depositShares {
     client: Client<Transport, chain, account>,
     parameters: depositShares.Parameters<chain, account>,
   ): Promise<ReturnType<action>> {
-    const engine = await readContract(client, {
+    const engine = await withExecutionError(readContract)(client, {
       abi: Abis.earnVault,
       address: parameters.vault,
       functionName: 'engine',
     })
-    return (await action(client, {
+    return (await withExecutionError(action)(client, {
       ...parameters,
       calls: depositShares.calls({
         ...toDepositSharesArgs(client, parameters as never),
@@ -968,7 +970,7 @@ export namespace depositSharesSync {
     venueShareAmount: bigint
   }>
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -1326,7 +1328,7 @@ export async function getFeeState<chain extends Chain | undefined>(
   parameters: getFeeState.Parameters,
 ): Promise<getFeeState.ReturnValue> {
   const { recipient, vault, ...rest } = parameters
-  const fees = await readContract(client, {
+  const fees = await withExecutionError(readContract)(client, {
     ...rest,
     abi: Abis.earnVault,
     address: vault,
@@ -1363,7 +1365,7 @@ export async function getFeeState<chain extends Chain | undefined>(
   // consistent with the batched id.
   const feeConfig = async (configId: bigint) =>
     toFeeConfig(
-      await readContract(client, {
+      await withExecutionError(readContract)(client, {
         ...rest,
         abi: Abis.earnFees,
         address: fees,
@@ -1439,7 +1441,7 @@ export namespace getFeeState {
     targetBase: bigint
   }
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /** Vault fee configuration. */
@@ -1571,7 +1573,7 @@ export async function getPosition<
       ],
       deployless: true,
     })
-  const value = await readContract(client, {
+  const value = await withExecutionError(readContract)(client, {
     ...rest,
     abi: Abis.earnVault,
     address: vault,
@@ -1615,7 +1617,7 @@ export namespace getPosition {
     value: bigint
   }
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -1647,7 +1649,7 @@ export async function getRedeemQuote<chain extends Chain | undefined>(
   parameters: getRedeemQuote.Parameters,
 ): Promise<getRedeemQuote.ReturnValue> {
   const { shareAmount, vault, ...rest } = parameters
-  return readContract(client, {
+  return withExecutionError(readContract)(client, {
     ...rest,
     ...getRedeemQuote.call({ shareAmount, vault }),
   })
@@ -1668,7 +1670,7 @@ export namespace getRedeemQuote {
     never
   >
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 
   /**
    * Defines a call to the vault's `previewRedeem` function.
@@ -1732,13 +1734,13 @@ export async function getVault<chain extends Chain | undefined>(
 ): Promise<getVault.ReturnValue> {
   const { vault, ...rest } = parameters
   const [engine, fees] = await Promise.all([
-    readContract(client, {
+    withExecutionError(readContract)(client, {
       ...rest,
       abi: Abis.earnVault,
       address: vault,
       functionName: 'engine',
     }),
-    readContract(client, {
+    withExecutionError(readContract)(client, {
       ...rest,
       abi: Abis.earnVault,
       address: vault,
@@ -1849,7 +1851,10 @@ export namespace getVault {
     shareToken: Address
   }
   // TODO: exhaustive error type
-  export type ErrorType = GetVaultEngineChangedErrorType | BaseErrorType
+  export type ErrorType =
+    | Errors.ExecutionErrorType
+    | GetVaultEngineChangedErrorType
+    | BaseErrorType
 
   /**
    * Defines the reads used by {@link getVault}. Pass the current engine and
@@ -1999,7 +2004,7 @@ export async function getWithdrawQuote<chain extends Chain | undefined>(
   parameters: getWithdrawQuote.Parameters,
 ): Promise<getWithdrawQuote.ReturnValue> {
   const { assetAmount, vault, ...rest } = parameters
-  return readContract(client, {
+  return withExecutionError(readContract)(client, {
     ...rest,
     ...getWithdrawQuote.call({ assetAmount, vault }),
   })
@@ -2020,7 +2025,7 @@ export namespace getWithdrawQuote {
     never
   >
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 
   /**
    * Defines a call to the vault's `previewWithdraw` function.
@@ -2122,7 +2127,7 @@ export namespace redeem {
   > = WriteParameters<chain, account> & Args
   export type ReturnValue = SendTransactionReturnType
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 
   /** @internal Shared dispatch; reads the Earn share token for the approval. */
   export async function inner<
@@ -2136,13 +2141,13 @@ export namespace redeem {
   ): Promise<ReturnType<action>> {
     const [args, shareToken] = await Promise.all([
       toRedeemArgs(client, parameters as never),
-      readContract(client, {
+      withExecutionError(readContract)(client, {
         abi: Abis.earnVault,
         address: parameters.vault,
         functionName: 'earnShare',
       }),
     ])
-    return (await action(client, {
+    return (await withExecutionError(action)(client, {
       ...parameters,
       calls: redeem.calls({ ...args, shareToken }),
     } as never)) as never
@@ -2354,7 +2359,7 @@ export namespace redeemSync {
     shareAmount: bigint
   }>
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -2780,7 +2785,7 @@ export namespace withdrawExact {
   > = WriteParameters<chain, account> & Args
   export type ReturnValue = SendTransactionReturnType
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 
   /** @internal Shared dispatch; reads the Earn share token for the approval. */
   export async function inner<
@@ -2794,13 +2799,13 @@ export namespace withdrawExact {
   ): Promise<ReturnType<action>> {
     const [args, shareToken] = await Promise.all([
       toWithdrawExactArgs(client, parameters as never),
-      readContract(client, {
+      withExecutionError(readContract)(client, {
         abi: Abis.earnVault,
         address: parameters.vault,
         functionName: 'earnShare',
       }),
     ])
-    return (await action(client, {
+    return (await withExecutionError(action)(client, {
       ...parameters,
       calls: withdrawExact.calls({ ...args, shareToken }),
     } as never)) as never
@@ -3021,7 +3026,7 @@ export namespace withdrawExactSync {
     shareAmount: bigint
   }>
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 type MinimumShareAmountParameters = OneOf<
@@ -3402,7 +3407,7 @@ async function toBaseUnitsLive(
   if (typeof amount === 'bigint') return amount
   if (amount.decimals !== undefined)
     return internal_Token.toBaseUnits(amount, amount.decimals)
-  const address = await readContract(client, {
+  const address = await withExecutionError(readContract)(client, {
     abi: Abis.earnVault,
     address: vault,
     functionName: token === 'asset' ? 'asset' : 'earnShare',

package/tempo/actions/fee.ts

@@ -19,12 +19,20 @@ 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 {
   FeeTokenNotTip20Error,
   FeeTokenNotUsdError,
   FeeTokenPausedError,
   InvalidFeeTokenError,
+  TempoExecutionError,
 } from '../errors.js'
+import {
+  formatAmount,
+  getFeeToken,
+  type Resolvers,
+  withExecutionError,
+} from '../internal/errors.js'
 import type {
   GetAccountParameter,
   ReadParameters,
@@ -81,7 +89,7 @@ export async function validateToken<chain extends Chain | undefined>(
 
   const isPathUsd = address.toLowerCase() === Addresses.pathUsd.toLowerCase()
   if (!isPathUsd) {
-    const isTip20 = await readContract(client, {
+    const isTip20 = await withExecutionError(readContract)(client, {
       ...rest,
       address: Addresses.tip20Factory,
       abi: Abis.tip20Factory,
@@ -136,6 +144,7 @@ export declare namespace validateToken {
   }>
 
   export type ErrorType =
+    | Errors.ExecutionErrorType
     | FeeTokenNotTip20Error
     | FeeTokenNotUsdError
     | FeeTokenPausedError
@@ -178,7 +187,7 @@ export async function getUserToken<
   const { account: account_ = client.account, ...rest } = parameters[0] ?? {}
   if (!account_) throw new Error('account is required.')
   const account = parseAccount(account_)
-  const address = await readContract(client, {
+  const address = await withExecutionError(readContract)(client, {
     ...rest,
     ...getUserToken.call({ account: account.address }),
   })
@@ -219,6 +228,8 @@ export namespace getUserToken {
       functionName: 'userTokens',
     })
   }
+
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -270,7 +281,7 @@ export namespace setUserToken {
   export type ReturnValue = WriteContractReturnType
 
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 
   /** @internal */
   export async function inner<
@@ -284,7 +295,7 @@ export namespace setUserToken {
   ): Promise<ReturnType<action>> {
     const { token, ...rest } = parameters
     const call = setUserToken.call({ token })
-    return (await action(client, {
+    return (await withExecutionError(action)(client, {
       ...rest,
       ...call,
     } as never)) as never
@@ -411,7 +422,7 @@ export namespace setUserTokenSync {
   >
 
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -514,7 +525,7 @@ export async function getValidatorToken<
   parameters: getValidatorToken.Parameters,
 ): Promise<getValidatorToken.ReturnValue> {
   const { validator, ...rest } = parameters
-  const address = await readContract(client, {
+  const address = await withExecutionError(readContract)(client, {
     ...rest,
     ...getValidatorToken.call({ validator }),
   })
@@ -553,6 +564,8 @@ export namespace getValidatorToken {
       functionName: 'validatorTokens',
     })
   }
+
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -604,7 +617,7 @@ export namespace setValidatorToken {
   export type ReturnValue = WriteContractReturnType
 
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 
   /** @internal */
   export async function inner<
@@ -618,7 +631,7 @@ export namespace setValidatorToken {
   ): Promise<ReturnType<action>> {
     const { token, ...rest } = parameters
     const call = setValidatorToken.call({ token })
-    return (await action(client, {
+    return (await withExecutionError(action)(client, {
       ...rest,
       ...call,
     } as never)) as never
@@ -745,7 +758,7 @@ export namespace setValidatorTokenSync {
   >
 
   // TODO: exhaustive error type
-  export type ErrorType = BaseErrorType
+  export type ErrorType = Errors.ExecutionErrorType | BaseErrorType
 }
 
 /**
@@ -820,3 +833,92 @@ export declare namespace watchSetValidatorToken {
     onValidatorTokenSet: (args: Args, log: Log) => void
   }
 }
+
+// Errors
+
+/** Errors this module throws for decoded Tempo errors. Narrow with `error.name`. */
+export type ExecutionErrorType = FeeInsufficientBalanceErrorType
+
+/** `FeeInsufficientBalanceError` with a literal `name`, for narrowing. */
+export type FeeInsufficientBalanceErrorType = FeeInsufficientBalanceError & {
+  name: 'FeeInsufficientBalanceError'
+}
+
+/** Thrown when an account cannot pay transaction fees in its fee token. */
+export class FeeInsufficientBalanceError extends TempoExecutionError<
+  Errors.TempoExecutionError.Decoded<'InsufficientFeeTokenBalance'>
+> {
+  /** Fee token balance, when known. */
+  balance: bigint | undefined
+  /** Token decimals, when known. */
+  decimals: number | undefined
+  /** Fee token, when known. */
+  feeToken: Address | undefined
+
+  constructor(
+    parameters: Errors.TempoExecutionError.Parameters & {
+      balance?: bigint | undefined
+      decimals?: number | undefined
+      feeToken?: Address | undefined
+    },
+  ) {
+    const { balance, decimals, feeToken } = parameters
+    super(parameters, {
+      details: {
+        'fee token': feeToken,
+        balance: formatAmount(balance, decimals),
+      },
+      name: 'FeeInsufficientBalanceError',
+      shortMessage: `Insufficient balance to pay fees${feeToken ? ` in token "${feeToken}"` : ''}.`,
+    })
+    this.balance = balance
+    this.decimals = decimals
+    this.feeToken = feeToken
+  }
+}
+
+/** @internal */
+export const errorResolvers: Resolvers = {
+  'InsufficientFeeTokenBalance()': async (context) => {
+    const { feePayer } = context.parameters
+    // A local fee payer pays instead of the sender. External fee payers cannot be read.
+    const payer =
+      typeof feePayer === 'object'
+        ? parseAccount(feePayer).address
+        : feePayer
+          ? undefined
+          : context.signer?.address
+    if (!payer) return new FeeInsufficientBalanceError(context.base)
+    const [userToken] = getFeeToken(context)
+      ? []
+      : await context.read([
+          {
+            address: Addresses.feeManager,
+            abi: Abis.feeManager,
+            functionName: 'userTokens',
+            args: [payer],
+          },
+        ])
+    const feeToken =
+      getFeeToken(context) ??
+      (userToken?.result && userToken.result !== zeroAddress
+        ? userToken.result
+        : undefined)
+    if (!feeToken) return new FeeInsufficientBalanceError(context.base)
+    const [balance, decimals] = await context.read([
+      {
+        address: feeToken,
+        abi: Abis.tip20,
+        functionName: 'balanceOf',
+        args: [payer],
+      },
+      { address: feeToken, abi: Abis.tip20, functionName: 'decimals' },
+    ])
+    return new FeeInsufficientBalanceError({
+      ...context.base,
+      balance: balance?.result,
+      decimals: decimals?.result,
+      feeToken,
+    })
+  },
+}