viem 2.13.9 → 2.14.0

package/actions/public/getEip712Domain.ts

@@ -0,0 +1,134 @@
+import type { Address, TypedDataDomain } from 'abitype'
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import {
+  Eip712DomainNotFoundError,
+  type Eip712DomainNotFoundErrorType,
+} from '../../errors/eip712.js'
+import type { ErrorType } from '../../errors/utils.js'
+import type { Hex } from '../../types/misc.js'
+import type { RequiredBy } from '../../types/utils.js'
+import { getAction } from '../../utils/getAction.js'
+import {
+  type ReadContractErrorType,
+  type ReadContractParameters,
+  readContract,
+} from './readContract.js'
+
+export type GetEip712DomainParameters = {
+  address: Address
+} & Pick<ReadContractParameters, 'factory' | 'factoryData'>
+
+export type GetEip712DomainReturnType = {
+  domain: RequiredBy<
+    TypedDataDomain,
+    'chainId' | 'name' | 'verifyingContract' | 'version'
+  >
+  fields: Hex
+  extensions: readonly bigint[]
+}
+
+export type GetEip712DomainErrorType =
+  | Eip712DomainNotFoundErrorType
+  | ReadContractErrorType
+  | ErrorType
+
+/**
+ * Reads the EIP-712 domain from a contract, based on the ERC-5267 specification.
+ *
+ * @param client - A {@link Client} instance.
+ * @param parameters - The parameters of the action. {@link GetEip712DomainParameters}
+ * @returns The EIP-712 domain, fields, and extensions. {@link GetEip712DomainReturnType}
+ *
+ * @example
+ * ```ts
+ * import { createPublicClient, http, getEip712Domain } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ *
+ * const domain = await getEip712Domain(client, {
+ *   address: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
+ * })
+ * // {
+ * //   domain: {
+ * //     name: 'ExampleContract',
+ * //     version: '1',
+ * //     chainId: 1,
+ * //     verifyingContract: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
+ * //   },
+ * //   fields: '0x0f',
+ * //   extensions: [],
+ * // }
+ * ```
+ */
+export async function getEip712Domain(
+  client: Client<Transport>,
+  parameters: GetEip712DomainParameters,
+): Promise<GetEip712DomainReturnType> {
+  const { address, factory, factoryData } = parameters
+
+  try {
+    const [
+      fields,
+      name,
+      version,
+      chainId,
+      verifyingContract,
+      salt,
+      extensions,
+    ] = await getAction(
+      client,
+      readContract,
+      'readContract',
+    )({
+      abi,
+      address,
+      functionName: 'eip712Domain',
+      factory,
+      factoryData,
+    })
+
+    return {
+      domain: {
+        name,
+        version,
+        chainId: Number(chainId),
+        verifyingContract,
+        salt,
+      },
+      extensions,
+      fields,
+    }
+  } catch (e) {
+    const error = e as ReadContractErrorType
+    if (
+      error.name === 'ContractFunctionExecutionError' &&
+      error.cause.name === 'ContractFunctionZeroDataError'
+    ) {
+      throw new Eip712DomainNotFoundError({ address })
+    }
+    throw error
+  }
+}
+
+const abi = [
+  {
+    inputs: [],
+    name: 'eip712Domain',
+    outputs: [
+      { name: 'fields', type: 'bytes1' },
+      { name: 'name', type: 'string' },
+      { name: 'version', type: 'string' },
+      { name: 'chainId', type: 'uint256' },
+      { name: 'verifyingContract', type: 'address' },
+      { name: 'salt', type: 'bytes32' },
+      { name: 'extensions', type: 'uint256[]' },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+] as const

package/actions/public/readContract.ts

@@ -40,7 +40,15 @@ export type ReadContractParameters<
     functionName
   > = ContractFunctionArgs<abi, 'pure' | 'view', functionName>,
 > = UnionEvaluate<
-  Pick<CallParameters, 'account' | 'blockNumber' | 'blockTag' | 'stateOverride'>
+  Pick<
+    CallParameters,
+    | 'account'
+    | 'blockNumber'
+    | 'blockTag'
+    | 'factory'
+    | 'factoryData'
+    | 'stateOverride'
+  >
 > &
   ContractFunctionParameters<abi, 'pure' | 'view', functionName, args>
 

package/actions/public/simulateContract.ts

@@ -66,7 +66,7 @@ export type SimulateContractParameters<
 > &
   UnionOmit<
     CallParameters<derivedChain>,
-    'account' | 'batch' | 'to' | 'data' | 'value'
+    'account' | 'batch' | 'to' | 'data' | 'factory' | 'factoryData' | 'value'
   > &
   GetValue<
     abi,

package/clients/decorators/public.ts

@@ -106,6 +106,11 @@ import {
   type GetContractEventsReturnType,
   getContractEvents,
 } from '../../actions/public/getContractEvents.js'
+import {
+  type GetEip712DomainParameters,
+  type GetEip712DomainReturnType,
+  getEip712Domain,
+} from '../../actions/public/getEip712Domain.js'
 import {
   type GetFeeHistoryParameters,
   type GetFeeHistoryReturnType,
@@ -703,6 +708,41 @@ export type PublicActions<
   ) => Promise<
     GetContractEventsReturnType<abi, eventName, strict, fromBlock, toBlock>
   >
+  /**
+   * Reads the EIP-712 domain from a contract, based on the ERC-5267 specification.
+   *
+   * @param client - A {@link Client} instance.
+   * @param parameters - The parameters of the action. {@link GetEip712DomainParameters}
+   * @returns The EIP-712 domain, fields, and extensions. {@link GetEip712DomainReturnType}
+   *
+   * @example
+   * ```ts
+   * import { createPublicClient, http } from 'viem'
+   * import { mainnet } from 'viem/chains'
+   *
+   * const client = createPublicClient({
+   *   chain: mainnet,
+   *   transport: http(),
+   * })
+   *
+   * const domain = await client.getEip712Domain({
+   *   address: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
+   * })
+   * // {
+   * //   domain: {
+   * //     name: 'ExampleContract',
+   * //     version: '1',
+   * //     chainId: 1,
+   * //     verifyingContract: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
+   * //   },
+   * //   fields: '0x0f',
+   * //   extensions: [],
+   * // }
+   * ```
+   */
+  getEip712Domain: (
+    args: GetEip712DomainParameters,
+  ) => Promise<GetEip712DomainReturnType>
   /**
    * Gets address for ENS name.
    *
@@ -1816,6 +1856,7 @@ export function publicActions<
     getBytecode: (args) => getBytecode(client, args),
     getChainId: () => getChainId(client),
     getContractEvents: (args) => getContractEvents(client, args),
+    getEip712Domain: (args) => getEip712Domain(client, args),
     getEnsAddress: (args) => getEnsAddress(client, args),
     getEnsAvatar: (args) => getEnsAvatar(client, args),
     getEnsName: (args) => getEnsName(client, args),

package/constants/contracts.ts

@@ -1,2 +1,5 @@
+export const counterfactualContractCallByteCode =
+  '0x608060405234801561001057600080fd5b506040516102c03803806102c083398101604081905261002f916101e6565b836001600160a01b03163b6000036100e457600080836001600160a01b03168360405161005c9190610270565b6000604051808303816000865af19150503d8060008114610099576040519150601f19603f3d011682016040523d82523d6000602084013e61009e565b606091505b50915091508115806100b857506001600160a01b0386163b155b156100e1578060405163101bb98d60e01b81526004016100d8919061028c565b60405180910390fd5b50505b6000808451602086016000885af16040513d6000823e81610103573d81fd5b3d81f35b80516001600160a01b038116811461011e57600080fd5b919050565b634e487b7160e01b600052604160045260246000fd5b60005b8381101561015457818101518382015260200161013c565b50506000910152565b600082601f83011261016e57600080fd5b81516001600160401b0381111561018757610187610123565b604051601f8201601f19908116603f011681016001600160401b03811182821017156101b5576101b5610123565b6040528181528382016020018510156101cd57600080fd5b6101de826020830160208701610139565b949350505050565b600080600080608085870312156101fc57600080fd5b61020585610107565b60208601519094506001600160401b0381111561022157600080fd5b61022d8782880161015d565b93505061023c60408601610107565b60608601519092506001600160401b0381111561025857600080fd5b6102648782880161015d565b91505092959194509250565b60008251610282818460208701610139565b9190910192915050565b60208152600082518060208401526102ab816040850160208701610139565b601f01601f1916919091016040019291505056fe'
+
 export const universalSignatureValidatorByteCode =
   '0x60806040523480156200001157600080fd5b50604051620007003803806200070083398101604081905262000034916200056f565b6000620000438484846200004f565b9050806000526001601ff35b600080846001600160a01b0316803b806020016040519081016040528181526000908060200190933c90507f6492649264926492649264926492649264926492649264926492649264926492620000a68462000451565b036200021f57600060608085806020019051810190620000c79190620005ce565b8651929550909350915060000362000192576000836001600160a01b031683604051620000f5919062000643565b6000604051808303816000865af19150503d806000811462000134576040519150601f19603f3d011682016040523d82523d6000602084013e62000139565b606091505b5050905080620001905760405162461bcd60e51b815260206004820152601e60248201527f5369676e617475726556616c696461746f723a206465706c6f796d656e74000060448201526064015b60405180910390fd5b505b604051630b135d3f60e11b808252906001600160a01b038a1690631626ba7e90620001c4908b90869060040162000661565b602060405180830381865afa158015620001e2573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906200020891906200069d565b6001600160e01b031916149450505050506200044a565b805115620002b157604051630b135d3f60e11b808252906001600160a01b03871690631626ba7e9062000259908890889060040162000661565b602060405180830381865afa15801562000277573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906200029d91906200069d565b6001600160e01b031916149150506200044a565b8251604114620003195760405162461bcd60e51b815260206004820152603a6024820152600080516020620006e083398151915260448201527f3a20696e76616c6964207369676e6174757265206c656e677468000000000000606482015260840162000187565b620003236200046b565b506020830151604080850151855186939260009185919081106200034b576200034b620006c9565b016020015160f81c9050601b81148015906200036b57508060ff16601c14155b15620003cf5760405162461bcd60e51b815260206004820152603b6024820152600080516020620006e083398151915260448201527f3a20696e76616c6964207369676e617475726520762076616c75650000000000606482015260840162000187565b6040805160008152602081018083528a905260ff83169181019190915260608101849052608081018390526001600160a01b038a169060019060a0016020604051602081039080840390855afa1580156200042e573d6000803e3d6000fd5b505050602060405103516001600160a01b031614955050505050505b9392505050565b60006020825110156200046357600080fd5b508051015190565b60405180606001604052806003906020820280368337509192915050565b6001600160a01b03811681146200049f57600080fd5b50565b634e487b7160e01b600052604160045260246000fd5b60005b83811015620004d5578181015183820152602001620004bb565b50506000910152565b600082601f830112620004f057600080fd5b81516001600160401b03808211156200050d576200050d620004a2565b604051601f8301601f19908116603f01168101908282118183101715620005385762000538620004a2565b816040528381528660208588010111156200055257600080fd5b62000565846020830160208901620004b8565b9695505050505050565b6000806000606084860312156200058557600080fd5b8351620005928162000489565b6020850151604086015191945092506001600160401b03811115620005b657600080fd5b620005c486828701620004de565b9150509250925092565b600080600060608486031215620005e457600080fd5b8351620005f18162000489565b60208501519093506001600160401b03808211156200060f57600080fd5b6200061d87838801620004de565b935060408601519150808211156200063457600080fd5b50620005c486828701620004de565b6000825162000657818460208701620004b8565b9190910192915050565b828152604060208201526000825180604084015262000688816060850160208701620004b8565b601f01601f1916919091016060019392505050565b600060208284031215620006b057600080fd5b81516001600160e01b0319811681146200044a57600080fd5b634e487b7160e01b600052603260045260246000fdfe5369676e617475726556616c696461746f72237265636f7665725369676e6572'

package/errors/contract.ts

@@ -278,6 +278,26 @@ export class ContractFunctionZeroDataError extends BaseError {
   }
 }
 
+export type CounterfactualDeploymentFailedErrorType =
+  CounterfactualDeploymentFailedError & {
+    name: 'CounterfactualDeploymentFailedError'
+  }
+export class CounterfactualDeploymentFailedError extends BaseError {
+  override name = 'CounterfactualDeploymentFailedError'
+  constructor({ factory }: { factory: Address }) {
+    super(
+      `Deployment for counterfactual contract call failed for factory "${factory}".`,
+      {
+        metaMessages: [
+          'Please ensure:',
+          '- The `factory` is a valid contract deployment factory (ie. Create2 Factory, ERC-4337 Factory, etc).',
+          '- The `factoryData` is a valid encoded function call for contract deployment function on the factory.',
+        ],
+      },
+    )
+  }
+}
+
 export type RawContractErrorType = RawContractError & {
   name: 'RawContractError'
 }

package/errors/eip712.ts

@@ -0,0 +1,19 @@
+import type { Address } from 'abitype'
+import { BaseError } from './base.js'
+
+export type Eip712DomainNotFoundErrorType = Eip712DomainNotFoundError & {
+  name: 'Eip712DomainNotFoundError'
+}
+export class Eip712DomainNotFoundError extends BaseError {
+  override name = 'Eip712DomainNotFoundError'
+  constructor({ address }: { address: Address }) {
+    super(`No EIP-712 domain found on contract "${address}".`, {
+      metaMessages: [
+        'Ensure that:',
+        `- The contract is deployed at the address "${address}".`,
+        '- `eip712Domain()` function exists on the contract.',
+        '- `eip712Domain()` function matches signature to ERC-5267 specification.',
+      ],
+    })
+  }
+}

package/errors/version.ts

@@ -1 +1 @@
-export const version = '2.13.9'
+export const version = '2.14.0'

package/index.ts

@@ -48,6 +48,11 @@ export {
   type GetContractEventsParameters,
   type GetContractEventsReturnType,
 } from './actions/public/getContractEvents.js'
+export {
+  type GetEip712DomainErrorType,
+  type GetEip712DomainParameters,
+  type GetEip712DomainReturnType,
+} from './actions/public/getEip712Domain.js'
 export {
   type AddChainErrorType,
   type AddChainParameters,
@@ -715,6 +720,8 @@ export {
   type ContractFunctionZeroDataErrorType,
   RawContractError,
   type RawContractErrorType,
+  CounterfactualDeploymentFailedError,
+  type CounterfactualDeploymentFailedErrorType,
 } from './errors/contract.js'
 export {
   BaseFeeScalarError,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "2.13.9",
+  "version": "2.14.0",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",