viem 2.17.11 → 2.18.0

package/errors/account.ts

@@ -9,7 +9,7 @@ export class AccountNotFoundError extends BaseError {
     super(
       [
         'Could not find an Account to execute with this Action.',
-        'Please provide an Account with the `account` argument on the Action, or by supplying an `account` to the WalletClient.',
+        'Please provide an Account with the `account` argument on the Action, or by supplying an `account` to the Client.',
       ].join('\n'),
       {
         docsPath,
@@ -18,3 +18,24 @@ export class AccountNotFoundError extends BaseError {
     )
   }
 }
+
+export type AccountTypeNotSupportedErrorType = AccountTypeNotSupportedError & {
+  name: 'AccountTypeNotSupportedError'
+}
+export class AccountTypeNotSupportedError extends BaseError {
+  override name = 'AccountTypeNotSupportedError'
+  constructor({
+    docsPath,
+    metaMessages,
+    type,
+  }: {
+    docsPath?: string | undefined
+    metaMessages?: string[] | undefined
+    type: string
+  }) {
+    super(`Account type "${type}" is not supported.`, {
+      docsPath,
+      metaMessages,
+    })
+  }
+}

package/errors/contract.ts

@@ -152,7 +152,7 @@ export class ContractFunctionExecutionError extends BaseError {
         docsPath,
         metaMessages: [
           ...(cause.metaMessages ? [...cause.metaMessages, ' '] : []),
-          'Contract Call:',
+          prettyArgs && 'Contract Call:',
           prettyArgs,
         ].filter(Boolean) as string[],
       },

package/errors/rpc.ts

@@ -148,10 +148,10 @@ export class MethodNotFoundRpcError extends RpcError {
   override name = 'MethodNotFoundRpcError'
   static code = -32601 as const
 
-  constructor(cause: Error) {
+  constructor(cause: Error, { method }: { method?: string } = {}) {
     super(cause, {
       code: MethodNotFoundRpcError.code,
-      shortMessage: 'The method does not exist / is not available.',
+      shortMessage: `The method${method ? ` "${method}"` : ''} does not exist / is not available.`,
     })
   }
 }
@@ -301,10 +301,10 @@ export class MethodNotSupportedRpcError extends RpcError {
   override name = 'MethodNotSupportedRpcError'
   static code = -32004 as const
 
-  constructor(cause: Error) {
+  constructor(cause: Error, { method }: { method?: string } = {}) {
     super(cause, {
       code: MethodNotSupportedRpcError.code,
-      shortMessage: 'Method is not implemented.',
+      shortMessage: `Method${method ? ` "${method}"` : ''} is not implemented.`,
     })
   }
 }
@@ -409,10 +409,10 @@ export class UnsupportedProviderMethodError extends ProviderRpcError {
   override name = 'UnsupportedProviderMethodError'
   static code = 4200 as const
 
-  constructor(cause: Error) {
+  constructor(cause: Error, { method }: { method?: string } = {}) {
     super(cause, {
       code: UnsupportedProviderMethodError.code,
-      shortMessage: 'The Provider does not support the requested method.',
+      shortMessage: `The Provider does not support the requested method${method ? ` " ${method}"` : ''}.`,
     })
   }
 }

package/errors/version.ts

@@ -1 +1 @@
-export const version = '2.17.11'
+export const version = '2.18.0'

package/index.ts

@@ -439,9 +439,9 @@ export type {
   WatchAssetReturnType,
 } from './actions/wallet/watchAsset.js'
 export type {
-  VerifyHashErrorType,
-  VerifyHashParameters,
-  VerifyHashReturnType,
+  VerifyHashErrorType as VerifyHashActionErrorType,
+  VerifyHashParameters as VerifyHashActionParameters,
+  VerifyHashReturnType as VerifyHashActionReturnType,
 } from './actions/public/verifyHash.js'
 export type {
   VerifyTypedDataErrorType as VerifyTypedDataActionErrorType,
@@ -1004,6 +1004,8 @@ export type {
 } from './types/misc.js'
 export type {
   AddEthereumChainParameter,
+  BundlerRpcSchema,
+  DebugBundlerRpcSchema,
   EIP1193EventMap,
   EIP1193Events,
   EIP1193Parameters,
@@ -1294,6 +1296,8 @@ export {
   type SerializeSignatureErrorType as SignatureToHexErrorType,
   /** @deprecated Use `serializeSignature` instead. */
   serializeSignature as signatureToHex,
+  type SerializeSignatureParameters,
+  type SerializeSignatureReturnType,
   type SerializeSignatureErrorType,
   serializeSignature,
 } from './utils/signature/serializeSignature.js'
@@ -1306,6 +1310,12 @@ export {
   type ToRlpErrorType,
   type ToRlpReturnType,
 } from './utils/encoding/toRlp.js'
+export {
+  type VerifyHashErrorType,
+  type VerifyHashParameters,
+  type VerifyHashReturnType,
+  verifyHash,
+} from './utils/signature/verifyHash.js'
 export {
   type VerifyMessageErrorType,
   type VerifyMessageParameters,
@@ -1686,3 +1696,10 @@ export {
   createNonceManager,
   nonceManager,
 } from './utils/nonceManager.js'
+export type {
+  RpcEstimateUserOperationGasReturnType,
+  RpcGetUserOperationByHashReturnType,
+  RpcUserOperation,
+  RpcUserOperationReceipt,
+  RpcUserOperationRequest,
+} from './account-abstraction/types/rpc.js'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "2.17.11",
+  "version": "2.18.0",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",
@@ -24,6 +24,11 @@
       "import": "./_esm/index.js",
       "default": "./_cjs/index.js"
     },
+    "./account-abstraction": {
+      "types": "./_types/account-abstraction/index.d.ts",
+      "import": "./_esm/account-abstraction/index.js",
+      "default": "./_cjs/account-abstraction/index.js"
+    },
     "./accounts": {
       "types": "./_types/accounts/index.d.ts",
       "import": "./_esm/accounts/index.js",
@@ -163,6 +168,7 @@
     "@scure/bip39": "1.3.0",
     "abitype": "1.0.5",
     "isows": "1.0.4",
+    "webauthn-p256": "0.0.5",
     "ws": "8.17.1"
   },
   "license": "MIT",

package/types/eip1193.ts

@@ -1,5 +1,11 @@
 import type { Address } from 'abitype'
 
+import type {
+  RpcEstimateUserOperationGasReturnType,
+  RpcGetUserOperationByHashReturnType,
+  RpcUserOperation,
+  RpcUserOperationReceipt,
+} from '../account-abstraction/types/rpc.js'
 import type { BlockTag } from './block.js'
 import type { Hash, Hex, LogTopic } from './misc.js'
 import type { RpcStateOverride } from './rpc.js'
@@ -16,12 +22,17 @@ import type {
   RpcTransactionRequest as TransactionRequest,
   RpcUncle as Uncle,
 } from './rpc.js'
-import type { ExactPartial, OneOf, Prettify } from './utils.js'
+import type { ExactPartial, OneOf, PartialBy, Prettify } from './utils.js'
 
 //////////////////////////////////////////////////
 // Provider
 
-export type EIP1474Methods = [...PublicRpcSchema, ...WalletRpcSchema]
+export type EIP1474Methods = [
+  ...PublicRpcSchema,
+  ...WalletRpcSchema,
+  ...BundlerRpcSchema,
+  ...PaymasterRpcSchema,
+]
 
 export type EIP1193Provider = Prettify<
   EIP1193Events & {
@@ -228,6 +239,307 @@ export type WatchAssetParams = {
   }
 }
 
+export type BundlerRpcSchema = [
+  /**
+   * @description Returns the chain ID associated with the current network
+   *
+   * @link https://eips.ethereum.org/EIPS/eip-4337#-eth_chainid
+   */
+  {
+    Method: 'eth_chainId'
+    Parameters?: undefined
+    ReturnType: Hex
+  },
+  /**
+   * @description Estimate the gas values for a UserOperation.
+   *
+   * @link https://eips.ethereum.org/EIPS/eip-4337#-eth_estimateuseroperationgas
+   *
+   * @example
+   * provider.request({
+   *  method: 'eth_estimateUserOperationGas',
+   *  params: [{ ... }]
+   * })
+   * // => { ... }
+   */
+  {
+    Method: 'eth_estimateUserOperationGas'
+    Parameters:
+      | [userOperation: RpcUserOperation, entrypoint: Address]
+      | [
+          userOperation: RpcUserOperation,
+          entrypoint: Address,
+          stateOverrideSet: RpcStateOverride,
+        ]
+    ReturnType: RpcEstimateUserOperationGasReturnType
+  },
+  /**
+   * @description Return a UserOperation based on a hash.
+   *
+   * @link https://eips.ethereum.org/EIPS/eip-4337#-eth_getuseroperationbyhash
+   *
+   * @example
+   * provider.request({
+   *  method: 'eth_getUserOperationByHash',
+   *  params: ['0x...']
+   * })
+   * // => { ... }
+   */
+  {
+    Method: 'eth_getUserOperationByHash'
+    Parameters: [hash: Hash]
+    ReturnType: RpcGetUserOperationByHashReturnType | null
+  },
+  /**
+   * @description Return a UserOperation receipt based on a hash.
+   *
+   * @link https://eips.ethereum.org/EIPS/eip-4337#-eth_getuseroperationreceipt
+   *
+   * @example
+   * provider.request({
+   *  method: 'eth_getUserOperationReceipt',
+   *  params: ['0x...']
+   * })
+   * // => { ... }
+   */
+  {
+    Method: 'eth_getUserOperationReceipt'
+    Parameters: [hash: Hash]
+    ReturnType: RpcUserOperationReceipt | null
+  },
+  /**
+   * @description Submits a User Operation object to the User Operation pool of the client.
+   *
+   * @link https://eips.ethereum.org/EIPS/eip-4337#-eth_senduseroperation
+   *
+   * @example
+   * provider.request({
+   *  method: 'eth_sendUserOperation',
+   *  params: [{ ... }]
+   * })
+   * // => '0x...'
+   */
+  {
+    Method: 'eth_sendUserOperation'
+    Parameters: [userOperation: RpcUserOperation, entrypoint: Address]
+    ReturnType: Hash
+  },
+  /**
+   * @description Return the list of supported entry points by the client.
+   *
+   * @link https://eips.ethereum.org/EIPS/eip-4337#-eth_supportedentrypoints
+   */
+  {
+    Method: 'eth_supportedEntryPoints'
+    Parameters?: undefined
+    ReturnType: readonly Address[]
+  },
+]
+
+export type DebugBundlerRpcSchema = [
+  /**
+   * @description Clears the bundler mempool and reputation data of paymasters/accounts/factories/aggregators.
+   *
+   * @link https://github.com/eth-infinitism/bundler-spec/blob/a247b5de59a702063ea5b09d6136f119a061642b/src/debug/debug.yaml#L1
+   */
+  {
+    Method: 'debug_bundler_clearState'
+    Parameters?: undefined
+    ReturnType: undefined
+  },
+  /**
+   * @description Returns the current mempool
+   *
+   * @link https://github.com/eth-infinitism/bundler-spec/blob/a247b5de59a702063ea5b09d6136f119a061642b/src/debug/debug.yaml#L8
+   */
+  {
+    Method: 'debug_bundler_dumpMempool'
+    Parameters: [entryPoint: Address]
+    ReturnType: readonly { userOp: RpcUserOperation }[]
+  },
+  /**
+   * @description Forces the bundler to execute the entire current mempool.
+   *
+   * @link https://github.com/eth-infinitism/bundler-spec/blob/a247b5de59a702063ea5b09d6136f119a061642b/src/debug/debug.yaml#L19
+   */
+  {
+    Method: 'debug_bundler_sendBundleNow'
+    Parameters?: undefined
+    ReturnType: Hash
+  },
+  /**
+   * @description Toggles bundling mode between 'auto' and 'manual'
+   *
+   * @link https://github.com/eth-infinitism/bundler-spec/blob/a247b5de59a702063ea5b09d6136f119a061642b/src/debug/debug.yaml#L26
+   */
+  {
+    Method: 'debug_bundler_setBundlingMode'
+    Parameters: [mode: 'auto' | 'manual']
+    ReturnType: undefined
+  },
+  /**
+   * @description Sets reputation of given addresses.
+   *
+   * @link https://github.com/eth-infinitism/bundler-spec/blob/a247b5de59a702063ea5b09d6136f119a061642b/src/debug/debug.yaml#L37
+   */
+  {
+    Method: 'debug_bundler_setReputation'
+    Parameters: [
+      reputations: readonly {
+        address: Address
+        opsSeen: Hex
+        opsIncluded: Hex
+      }[],
+      entryPoint: Address,
+    ]
+    ReturnType: undefined
+  },
+  /**
+   * @description Returns the reputation data of all observed addresses.
+   *
+   * @link https://github.com/eth-infinitism/bundler-spec/blob/a247b5de59a702063ea5b09d6136f119a061642b/src/debug/debug.yaml#L52
+   */
+  {
+    Method: 'debug_bundler_dumpReputation'
+    Parameters: [entryPoint: Address]
+    ReturnType: readonly {
+      address: Address
+      opsSeen: Hex
+      opsIncluded: Hex
+    }[]
+  },
+  /**
+   * @description Add a bulk of UserOps into the mempool
+   *
+   * @link https://github.com/eth-infinitism/bundler-spec/blob/a247b5de59a702063ea5b09d6136f119a061642b/src/debug/debug.yaml#L64
+   */
+  {
+    Method: 'debug_bundler_addUserOps'
+    Parameters: [userOps: readonly RpcUserOperation[], entryPoint: Address]
+    ReturnType: undefined
+  },
+]
+
+export type PaymasterRpcSchema = [
+  /**
+   * @description Returns the chain ID associated with the current network
+   *
+   * @link https://eips.ethereum.org/EIPS/eip-4337#-eth_chainid
+   */
+  {
+    Method: 'pm_getPaymasterStubData'
+    Parameters?: [
+      userOperation: OneOf<
+        | PartialBy<
+            Pick<
+              RpcUserOperation<'0.6'>,
+              | 'callData'
+              | 'callGasLimit'
+              | 'initCode'
+              | 'maxFeePerGas'
+              | 'maxPriorityFeePerGas'
+              | 'nonce'
+              | 'sender'
+              | 'preVerificationGas'
+              | 'verificationGasLimit'
+            >,
+            | 'callGasLimit'
+            | 'initCode'
+            | 'maxFeePerGas'
+            | 'maxPriorityFeePerGas'
+            | 'preVerificationGas'
+            | 'verificationGasLimit'
+          >
+        | PartialBy<
+            Pick<
+              RpcUserOperation<'0.7'>,
+              | 'callData'
+              | 'callGasLimit'
+              | 'factory'
+              | 'factoryData'
+              | 'maxFeePerGas'
+              | 'maxPriorityFeePerGas'
+              | 'nonce'
+              | 'sender'
+              | 'preVerificationGas'
+              | 'verificationGasLimit'
+            >,
+            | 'callGasLimit'
+            | 'factory'
+            | 'factoryData'
+            | 'maxFeePerGas'
+            | 'maxPriorityFeePerGas'
+            | 'preVerificationGas'
+            | 'verificationGasLimit'
+          >
+      >,
+      entrypoint: Address,
+      chainId: Hex,
+      context: unknown,
+    ]
+    ReturnType: OneOf<
+      | { paymasterAndData: Hex }
+      | {
+          paymaster: Address
+          paymasterData: Hex
+          paymasterVerificationGasLimit: Hex
+          paymasterPostOpGasLimit: Hex
+        }
+    > & {
+      sponsor?: { name: string; icon?: string | undefined } | undefined
+      isFinal?: boolean | undefined
+    }
+  },
+  /**
+   * @description Returns values to be used in paymaster-related fields of a signed user operation.
+   *
+   * @link https://github.com/ethereum/ERCs/blob/master/ERCS/erc-7677.md#pm_getpaymasterdata
+   */
+  {
+    Method: 'pm_getPaymasterData'
+    Parameters?: [
+      userOperation:
+        | Pick<
+            RpcUserOperation<'0.6'>,
+            | 'callData'
+            | 'callGasLimit'
+            | 'initCode'
+            | 'maxFeePerGas'
+            | 'maxPriorityFeePerGas'
+            | 'nonce'
+            | 'sender'
+            | 'preVerificationGas'
+            | 'verificationGasLimit'
+          >
+        | Pick<
+            RpcUserOperation<'0.7'>,
+            | 'callData'
+            | 'callGasLimit'
+            | 'factory'
+            | 'factoryData'
+            | 'maxFeePerGas'
+            | 'maxPriorityFeePerGas'
+            | 'nonce'
+            | 'sender'
+            | 'preVerificationGas'
+            | 'verificationGasLimit'
+          >,
+      entrypoint: Address,
+      chainId: Hex,
+      context: unknown,
+    ]
+    ReturnType: OneOf<
+      | { paymasterAndData: Hex }
+      | {
+          paymaster: Address
+          paymasterData: Hex
+          paymasterVerificationGasLimit: Hex
+          paymasterPostOpGasLimit: Hex
+        }
+    >
+  },
+]
+
 export type PublicRpcSchema = [
   /**
    * @description Returns the version of the current client

package/types/multicall.ts

@@ -127,7 +127,7 @@ export type MulticallResponse<
   : result
 
 // infer contract parameters from `unknown`
-type GetMulticallContractParameters<
+export type GetMulticallContractParameters<
   contract,
   mutability extends AbiStateMutability,
 > = contract extends { abi: infer abi extends Abi } // 1. Check if `abi` is const-asserted or defined inline

package/utils/buildRequest.ts

@@ -129,7 +129,7 @@ export function buildRequest<request extends (args: any) => Promise<any>>(
                   throw new InvalidRequestRpcError(err)
                 // -32601
                 case MethodNotFoundRpcError.code:
-                  throw new MethodNotFoundRpcError(err)
+                  throw new MethodNotFoundRpcError(err, { method: args.method })
                 // -32602
                 case InvalidParamsRpcError.code:
                   throw new InvalidParamsRpcError(err)
@@ -150,7 +150,9 @@ export function buildRequest<request extends (args: any) => Promise<any>>(
                   throw new TransactionRejectedRpcError(err)
                 // -32004
                 case MethodNotSupportedRpcError.code:
-                  throw new MethodNotSupportedRpcError(err)
+                  throw new MethodNotSupportedRpcError(err, {
+                    method: args.method,
+                  })
                 // -32005
                 case LimitExceededRpcError.code:
                   throw new LimitExceededRpcError(err)

package/utils/errors/getNodeError.ts

@@ -71,12 +71,11 @@ export function getNodeError(
           (e) => (e as { code: number }).code === ExecutionRevertedError.code,
         )
       : err
-  if (executionRevertedError instanceof BaseError) {
+  if (executionRevertedError instanceof BaseError)
     return new ExecutionRevertedError({
       cause: err,
       message: executionRevertedError.details,
     }) as any
-  }
   if (ExecutionRevertedError.nodeMessage.test(message))
     return new ExecutionRevertedError({
       cause: err,

package/utils/index.ts

@@ -434,6 +434,12 @@ export {
   type RecoverTypedDataAddressReturnType,
   recoverTypedDataAddress,
 } from './signature/recoverTypedDataAddress.js'
+export {
+  type VerifyHashErrorType,
+  type VerifyHashParameters,
+  type VerifyHashReturnType,
+  verifyHash,
+} from './signature/verifyHash.js'
 export {
   type VerifyMessageErrorType,
   type VerifyMessageParameters,

package/utils/signature/hashTypedData.ts

@@ -109,7 +109,7 @@ export function hashStruct({
 }: {
   data: Record<string, unknown>
   primaryType: string
-  types: Record<string, MessageTypeProperty[]>
+  types: Record<string, readonly MessageTypeProperty[]>
 }) {
   const encoded = encodeData({
     data,
@@ -132,7 +132,7 @@ function encodeData({
 }: {
   data: Record<string, unknown>
   primaryType: string
-  types: Record<string, MessageTypeProperty[]>
+  types: Record<string, readonly MessageTypeProperty[]>
 }) {
   const encodedTypes: AbiParameter[] = [{ type: 'bytes32' }]
   const encodedValues: unknown[] = [hashType({ primaryType, types })]
@@ -162,7 +162,7 @@ function hashType({
   types,
 }: {
   primaryType: string
-  types: Record<string, MessageTypeProperty[]>
+  types: Record<string, readonly MessageTypeProperty[]>
 }) {
   const encodedHashType = toHex(encodeType({ primaryType, types }))
   return keccak256(encodedHashType)
@@ -175,7 +175,7 @@ export function encodeType({
   types,
 }: {
   primaryType: string
-  types: Record<string, MessageTypeProperty[]>
+  types: Record<string, readonly MessageTypeProperty[]>
 }) {
   let result = ''
   const unsortedDeps = findTypeDependencies({ primaryType, types })
@@ -199,7 +199,7 @@ function findTypeDependencies(
     types,
   }: {
     primaryType: string
-    types: Record<string, MessageTypeProperty[]>
+    types: Record<string, readonly MessageTypeProperty[]>
   },
   results: Set<string> = new Set(),
 ): Set<string> {
@@ -229,7 +229,7 @@ function encodeField({
   type,
   value,
 }: {
-  types: Record<string, MessageTypeProperty[]>
+  types: Record<string, readonly MessageTypeProperty[]>
   name: string
   type: string
   value: any

package/utils/signature/serializeErc6492Signature.ts

@@ -1,20 +1,26 @@
 import type { Address } from 'abitype'
 import { erc6492MagicBytes } from '../../constants/bytes.js'
 import type { ErrorType } from '../../errors/utils.js'
-import type { Hex } from '../../types/misc.js'
+import type { ByteArray, Hex } from '../../types/misc.js'
 import { encodeAbiParameters } from '../abi/encodeAbiParameters.js'
 import { concatHex } from '../data/concat.js'
+import { hexToBytes } from '../encoding/toBytes.js'
 
-export type SerializeErc6492SignatureParameters = {
+type To = 'bytes' | 'hex'
+
+export type SerializeErc6492SignatureParameters<to extends To = 'hex'> = {
   /** The ERC-4337 Account Factory address to use for counterfactual verification. */
   address: Address
   /** Calldata to pass to deploy account (if not deployed) for counterfactual verification. */
   data: Hex
   /** The original signature. */
   signature: Hex
+  to?: to | To | undefined
 }
 
-export type SerializeErc6492SignatureReturnType = Hex
+export type SerializeErc6492SignatureReturnType<to extends To = 'hex'> =
+  | (to extends 'hex' ? Hex : never)
+  | (to extends 'bytes' ? ByteArray : never)
 
 export type SerializeErc6492SignatureErrorType = ErrorType
 
@@ -28,15 +34,18 @@ export type SerializeErc6492SignatureErrorType = ErrorType
  * serializeSignature({ address: '0x...', data: '0x...', signature: '0x...' })
  * // '0x000000000000000000000000cafebabecafebabecafebabecafebabecafebabe000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000004deadbeef000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000041a461f509887bd19e312c0c58467ce8ff8e300d3c1a90b608a760c5b80318eaf15fe57c96f9175d6cd4daad4663763baa7e78836e067d0163e9a2ccf2ff753f5b1b000000000000000000000000000000000000000000000000000000000000006492649264926492649264926492649264926492649264926492649264926492'
  */
-export function serializeErc6492Signature(
-  parameters: SerializeErc6492SignatureParameters,
-): SerializeErc6492SignatureReturnType {
-  const { address, data, signature } = parameters
-  return concatHex([
+export function serializeErc6492Signature<to extends To = 'hex'>(
+  parameters: SerializeErc6492SignatureParameters<to>,
+): SerializeErc6492SignatureReturnType<to> {
+  const { address, data, signature, to = 'hex' } = parameters
+  const signature_ = concatHex([
     encodeAbiParameters(
       [{ type: 'address' }, { type: 'bytes' }, { type: 'bytes' }],
       [address, data, signature],
     ),
     erc6492MagicBytes,
   ])
+
+  if (to === 'hex') return signature_ as SerializeErc6492SignatureReturnType<to>
+  return hexToBytes(signature_) as SerializeErc6492SignatureReturnType<to>
 }