viem 2.13.8 → 2.13.10

package/chains/definitions/ham.ts

@@ -0,0 +1,24 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const ham = /*#__PURE__*/ defineChain({
+  id: 5112,
+  name: 'Ham',
+  nativeCurrency: {
+    decimals: 18,
+    name: 'Ham',
+    symbol: 'ETH',
+  },
+  rpcUrls: {
+    default: {
+      http: ['https://rpc.ham.fun'],
+      webSocket: ['wss://rpc.ham.fun'],
+    },
+  },
+  blockExplorers: {
+    default: {
+      name: 'Ham Chain Explorer',
+      url: 'https://explorer.ham.fun',
+      apiUrl: 'https://explorer.ham.fun/api/v2',
+    },
+  },
+})

package/chains/definitions/kakarotSepolia.ts

@@ -1,7 +1,7 @@
 import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const kakarotSepolia = /*#__PURE__*/ defineChain({
-  id: 107107114116,
+  id: 1802203764,
   name: 'Kakarot Sepolia',
   nativeCurrency: {
     name: 'Ether',

package/chains/definitions/redbellyTestnet.ts

@@ -0,0 +1,24 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const redbellyTestnet = /*#__PURE__*/ defineChain({
+  id: 153,
+  name: 'Redbelly Network Testnet',
+  nativeCurrency: {
+    name: 'Redbelly Native Coin',
+    symbol: 'RBNT',
+    decimals: 18,
+  },
+  rpcUrls: {
+    default: {
+      http: ['https://governors.testnet.redbelly.network'],
+    },
+  },
+  blockExplorers: {
+    default: {
+      name: 'Ethernal',
+      url: 'https://explorer.testnet.redbelly.network',
+      apiUrl: 'https://ethernal.fly.dev/api',
+    },
+  },
+  testnet: true,
+})

package/chains/definitions/xai.ts

@@ -0,0 +1,25 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const xai = /*#__PURE__*/ defineChain({
+  id: 660279,
+  name: 'Xai Mainnet',
+  nativeCurrency: { name: 'Xai', symbol: 'XAI', decimals: 18 },
+  rpcUrls: {
+    default: {
+      http: ['https://xai-chain.net/rpc'],
+    },
+  },
+  blockExplorers: {
+    default: {
+      name: 'Blockscout',
+      url: 'https://explorer.xai-chain.net',
+    },
+  },
+  contracts: {
+    multicall3: {
+      address: '0xca11bde05977b3631167028862be2a173976ca11',
+      blockCreated: 222549,
+    },
+  },
+  testnet: false,
+})

package/chains/definitions/xaiTestnet.ts

@@ -0,0 +1,19 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const xaiTestnet = /*#__PURE__*/ defineChain({
+  id: 37714555429,
+  name: 'Xai Testnet',
+  nativeCurrency: { name: 'sXai', symbol: 'sXAI', decimals: 18 },
+  rpcUrls: {
+    default: {
+      http: ['https://testnet-v2.xai-chain.net/rpc'],
+    },
+  },
+  blockExplorers: {
+    default: {
+      name: 'Blockscout',
+      url: 'https://testnet-explorer-v2.xai-chain.net',
+    },
+  },
+  testnet: true,
+})

package/chains/index.ts

@@ -108,6 +108,7 @@ export { gobi } from './definitions/gobi.js'
 export { goerli } from './definitions/goerli.js'
 export { gnosis } from './definitions/gnosis.js'
 export { gnosisChiado } from './definitions/gnosisChiado.js'
+export { ham } from './definitions/ham.js'
 export { hardhat } from './definitions/hardhat.js'
 export { harmonyOne } from './definitions/harmonyOne.js'
 export { haqqMainnet } from './definitions/haqqMainnet.js'
@@ -202,6 +203,7 @@ export { pulsechain } from './definitions/pulsechain.js'
 export { pulsechainV4 } from './definitions/pulsechainV4.js'
 export { qMainnet } from './definitions/qMainnet.js'
 export { qTestnet } from './definitions/qTestnet.js'
+export { redbellyTestnet } from './definitions/redbellyTestnet.js'
 export { redstone } from './definitions/redstone.js'
 export { reyaNetwork } from './definitions/reyaNetwork.js'
 export { rollux } from './definitions/rollux.js'
@@ -269,6 +271,8 @@ export {
   x1Testnet,
 } from './definitions/xLayerTestnet.js'
 export { xLayer } from './definitions/xLayer.js'
+export { xai } from './definitions/xai.js'
+export { xaiTestnet } from './definitions/xaiTestnet.js'
 export { xdc } from './definitions/xdc.js'
 export { xdcTestnet } from './definitions/xdcTestnet.js'
 export { yooldoVerse } from './definitions/yooldoVerse.js'

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),
@@ -1838,7 +1879,7 @@ export function publicActions<
     getTransactionReceipt: (args) => getTransactionReceipt(client, args),
     multicall: (args) => multicall(client, args),
     prepareTransactionRequest: (args) =>
-      prepareTransactionRequest(client as any, args as any),
+      prepareTransactionRequest(client as any, args as any) as any,
     readContract: (args) => readContract(client, args),
     sendRawTransaction: (args) => sendRawTransaction(client, args),
     simulateContract: (args) => simulateContract(client, args),

package/clients/decorators/wallet.ts

@@ -703,7 +703,7 @@ export function walletActions<
     getChainId: () => getChainId(client),
     getPermissions: () => getPermissions(client),
     prepareTransactionRequest: (args) =>
-      prepareTransactionRequest(client as any, args as any),
+      prepareTransactionRequest(client as any, args as any) as any,
     requestAddresses: () => requestAddresses(client),
     requestPermissions: (args) => requestPermissions(client, args),
     sendRawTransaction: (args) => sendRawTransaction(client, args),

package/errors/base.ts

@@ -1,6 +1,7 @@
 import { getVersion } from './utils.js'
 
 type BaseErrorParameters = {
+  docsBaseUrl?: string | undefined
   docsPath?: string | undefined
   docsSlug?: string | undefined
   metaMessages?: string[] | undefined
@@ -45,7 +46,7 @@ export class BaseError extends Error {
       ...(args.metaMessages ? [...args.metaMessages, ''] : []),
       ...(docsPath
         ? [
-            `Docs: https://viem.sh${docsPath}${
+            `Docs: ${args.docsBaseUrl ?? 'https://viem.sh'}${docsPath}${
               args.docsSlug ? `#${args.docsSlug}` : ''
             }`,
           ]

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.8'
+export const version = '2.13.10'

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,

package/op-stack/actions/estimateDepositTransactionGas.ts

@@ -1,4 +1,5 @@
 import type { Address } from 'abitype'
+
 import {
   type EstimateContractGasErrorType,
   type EstimateContractGasParameters,
@@ -24,10 +25,11 @@ export type EstimateDepositTransactionGasParameters<
   chain extends Chain | undefined = Chain | undefined,
   account extends Account | undefined = Account | undefined,
   chainOverride extends Chain | undefined = Chain | undefined,
-  _derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>,
+  ///
+  derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>,
 > = UnionEvaluate<
   UnionOmit<
-    FormattedTransactionRequest<_derivedChain>,
+    FormattedTransactionRequest<derivedChain>,
     | 'accessList'
     | 'data'
     | 'from'
@@ -40,13 +42,15 @@ export type EstimateDepositTransactionGasParameters<
 > &
   GetAccountParameter<account, Account | Address> &
   GetChainParameter<chain, chainOverride> &
-  GetContractAddressParameter<_derivedChain, 'portal'> & {
+  GetContractAddressParameter<derivedChain, 'portal'> & {
     /** L2 transaction request. */
     request: DepositRequest
     /** Gas limit for transaction execution on the L1. */
-    gas?: bigint | null | undefined
+    gas?: bigint | undefined
   }
+
 export type EstimateDepositTransactionGasReturnType = bigint
+
 export type EstimateDepositTransactionGasErrorType =
   | EstimateContractGasErrorType
   | ErrorType
@@ -116,11 +120,10 @@ export async function estimateDepositTransactionGas<
     return Object.values(targetChain!.contracts.portal)[0].address
   })()
 
-  return estimateContractGas(client, {
+  const params = {
     account,
     abi: portalAbi,
     address: portalAddress,
-    chain,
     functionName: 'depositTransaction',
     args: [
       isCreation ? zeroAddress : to,
@@ -134,5 +137,13 @@ export async function estimateDepositTransactionGas<
     maxPriorityFeePerGas,
     nonce,
     value: mint,
-  } as EstimateContractGasParameters)
+    // TODO: Not sure `chain` is necessary since it's not used downstream
+    // in `estimateContractGas` or `estimateGas`
+    // @ts-ignore
+    chain,
+  } satisfies EstimateContractGasParameters<
+    typeof portalAbi,
+    'depositTransaction'
+  >
+  return estimateContractGas(client, params as any)
 }

package/op-stack/actions/estimateFinalizeWithdrawalGas.ts

@@ -41,7 +41,7 @@ export type EstimateFinalizeWithdrawalGasParameters<
   GetChainParameter<chain, chainOverride> &
   GetContractAddressParameter<_derivedChain, 'portal'> & {
     /** Gas limit for transaction execution on the L2. */
-    gas?: bigint | null | undefined
+    gas?: bigint | undefined
     withdrawal: Withdrawal
   }
 export type EstimateFinalizeWithdrawalGasReturnType = bigint
@@ -103,16 +103,23 @@ export async function estimateFinalizeWithdrawalGas<
     return Object.values(targetChain!.contracts.portal)[0].address
   })()
 
-  return estimateContractGas(client, {
+  const params = {
     account,
     abi: portalAbi,
     address: portalAddress,
-    chain,
     functionName: 'finalizeWithdrawalTransaction',
     args: [withdrawal],
     gas,
     maxFeePerGas,
     maxPriorityFeePerGas,
     nonce,
-  } as EstimateContractGasParameters)
+    // TODO: Not sure `chain` is necessary since it's not used downstream
+    // in `estimateContractGas` or `estimateGas`
+    // @ts-ignore
+    chain,
+  } satisfies EstimateContractGasParameters<
+    typeof portalAbi,
+    'finalizeWithdrawalTransaction'
+  >
+  return estimateContractGas(client, params as any)
 }

package/op-stack/actions/estimateInitiateWithdrawalGas.ts

@@ -40,7 +40,7 @@ export type EstimateInitiateWithdrawalGasParameters<
   GetAccountParameter<account, Account | Address> &
   GetChainParameter<chain, chainOverride> & {
     /** Gas limit for transaction execution on the L2. */
-    gas?: bigint | null | undefined
+    gas?: bigint | undefined
     /**
      * Withdrawal request.
      * Supplied to the L2ToL1MessagePasser `initiateWithdrawal` method.
@@ -102,11 +102,10 @@ export async function estimateInitiateWithdrawalGas<
     request: { data = '0x', gas: l1Gas, to, value },
   } = parameters
 
-  return estimateContractGas(client, {
+  const params = {
     account,
     abi: l2ToL1MessagePasserAbi,
     address: contracts.l2ToL1MessagePasser.address,
-    chain,
     functionName: 'initiateWithdrawal',
     args: [to, l1Gas, data],
     gas,
@@ -114,5 +113,13 @@ export async function estimateInitiateWithdrawalGas<
     maxPriorityFeePerGas,
     nonce,
     value,
-  } as EstimateContractGasParameters)
+    // TODO: Not sure `chain` is necessary since it's not used downstream
+    // in `estimateContractGas` or `estimateGas`
+    // @ts-ignore
+    chain,
+  } satisfies EstimateContractGasParameters<
+    typeof l2ToL1MessagePasserAbi,
+    'initiateWithdrawal'
+  >
+  return estimateContractGas(client, params as any)
 }

package/op-stack/actions/estimateProveWithdrawalGas.ts

@@ -41,7 +41,7 @@ export type EstimateProveWithdrawalGasParameters<
   GetChainParameter<chain, chainOverride> &
   GetContractAddressParameter<_derivedChain, 'portal'> & {
     /** Gas limit for transaction execution on the L2. */
-    gas?: bigint | null | undefined
+    gas?: bigint | undefined
     l2OutputIndex: bigint
     outputRootProof: {
       version: Hex
@@ -124,16 +124,23 @@ export async function estimateProveWithdrawalGas<
     return Object.values(targetChain!.contracts.portal)[0].address
   })()
 
-  return estimateContractGas(client, {
+  const params = {
     account,
     abi: portalAbi,
     address: portalAddress,
-    chain,
     functionName: 'proveWithdrawalTransaction',
     args: [withdrawal, l2OutputIndex, outputRootProof, withdrawalProof],
     gas,
     maxFeePerGas,
     maxPriorityFeePerGas,
     nonce,
-  } as EstimateContractGasParameters)
+    // TODO: Not sure `chain` is necessary since it's not used downstream
+    // in `estimateContractGas` or `estimateGas`
+    // @ts-ignore
+    chain,
+  } satisfies EstimateContractGasParameters<
+    typeof portalAbi,
+    'proveWithdrawalTransaction'
+  >
+  return estimateContractGas(client, params as any)
 }

package/package.json

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

package/types/chain.ts

@@ -169,7 +169,7 @@ export type ChainEstimateFeesPerGasFnParameters<
   formatters extends ChainFormatters | undefined = ChainFormatters | undefined,
 > = {
   /** A function to multiply the base fee based on the `baseFeeMultiplier` value. */
-  multiply(x: bigint): bigint
+  multiply: (x: bigint) => bigint
   /** The type of fees to return. */
   type: FeeValuesType
 } & ChainFeesFnParameters<formatters>
@@ -180,9 +180,9 @@ export type ChainEstimateFeesPerGasFnParameters<
 export type ExtractChainFormatterExclude<
   chain extends Chain | undefined,
   type extends keyof ChainFormatters,
-> = chain extends { formatters?: infer _Formatters extends ChainFormatters }
-  ? _Formatters[type] extends { exclude: infer Exclude }
-    ? Extract<Exclude, string[]>[number]
+> = chain extends { formatters?: infer formatters extends ChainFormatters }
+  ? formatters[type] extends { exclude: infer exclude }
+    ? Extract<exclude, readonly string[]>[number]
     : ''
   : ''
 
@@ -190,9 +190,9 @@ export type ExtractChainFormatterParameters<
   chain extends Chain | undefined,
   type extends keyof ChainFormatters,
   fallback,
-> = chain extends { formatters?: infer _Formatters extends ChainFormatters }
-  ? _Formatters[type] extends ChainFormatter
-    ? Parameters<_Formatters[type]['format']>[0]
+> = chain extends { formatters?: infer formatters extends ChainFormatters }
+  ? formatters[type] extends ChainFormatter
+    ? Parameters<formatters[type]['format']>[0]
     : fallback
   : fallback
 

package/utils/abi/encodeDeployData.ts

@@ -32,11 +32,12 @@ export type EncodeDeployDataParameters<
   abi: abi
   bytecode: Hex
 } & UnionEvaluate<
-  readonly [] extends allArgs
-    ? { args?: allArgs | undefined }
-    : { args: allArgs }
-> &
-  (hasConstructor extends true ? unknown : never)
+  hasConstructor extends false
+    ? { args?: undefined }
+    : readonly [] extends allArgs
+      ? { args?: allArgs | undefined }
+      : { args: allArgs }
+>
 
 export type EncodeDeployDataReturnType = Hex
 

package/utils/transaction/serializeTransaction.ts

@@ -370,13 +370,18 @@ function serializeTransactionLegacy(
 
 export function toYParitySignatureArray(
   transaction: TransactionSerializableGeneric,
-  signature?: Signature | undefined,
+  signature_?: Signature | undefined,
 ) {
-  const { r, s, v, yParity } = signature ?? transaction
-  if (typeof r === 'undefined') return []
-  if (typeof s === 'undefined') return []
+  const signature = signature_ ?? transaction
+  const { v, yParity } = signature
+
+  if (typeof signature.r === 'undefined') return []
+  if (typeof signature.s === 'undefined') return []
   if (typeof v === 'undefined' && typeof yParity === 'undefined') return []
 
+  const r = trim(signature.r)
+  const s = trim(signature.s)
+
   const yParity_ = (() => {
     if (typeof yParity === 'number') return yParity ? toHex(1) : '0x'
     if (v === 0n) return '0x'
@@ -384,5 +389,6 @@ export function toYParitySignatureArray(
 
     return v === 27n ? '0x' : toHex(1)
   })()
-  return [yParity_, trim(r), trim(s)]
+
+  return [yParity_, r === '0x00' ? '0x' : r, s === '0x00' ? '0x' : s]
 }

package/zksync/actions/sendEip712Transaction.ts

@@ -5,7 +5,8 @@ import { prepareTransactionRequest } from '../../actions/wallet/prepareTransacti
 import { sendRawTransaction } from '../../actions/wallet/sendRawTransaction.js'
 import type {
   SendTransactionErrorType,
-  SendTransactionParameters as SendTransactionParameters_,
+  SendTransactionParameters,
+  SendTransactionRequest,
   SendTransactionReturnType,
 } from '../../actions/wallet/sendTransaction.js'
 import type { Client } from '../../clients/createClient.js'
@@ -24,10 +25,14 @@ import { assertEip712Request } from '../utils/assertEip712Request.js'
 import { signTransaction } from './signTransaction.js'
 
 export type SendEip712TransactionParameters<
-  TChain extends ChainEIP712 | undefined = ChainEIP712 | undefined,
-  TAccount extends Account | undefined = Account | undefined,
-  TChainOverride extends ChainEIP712 | undefined = ChainEIP712 | undefined,
-> = SendTransactionParameters_<TChain, TAccount, TChainOverride>
+  chain extends ChainEIP712 | undefined = ChainEIP712 | undefined,
+  account extends Account | undefined = Account | undefined,
+  chainOverride extends ChainEIP712 | undefined = ChainEIP712 | undefined,
+  request extends SendTransactionRequest<
+    chain,
+    chainOverride
+  > = SendTransactionRequest<chain, chainOverride>,
+> = SendTransactionParameters<chain, account, chainOverride, request>
 
 export type SendEip712TransactionReturnType = SendTransactionReturnType
 
@@ -74,27 +79,33 @@ export type SendEip712TransactionErrorType = SendTransactionErrorType
  * })
  */
 export async function sendEip712Transaction<
-  TChain extends ChainEIP712 | undefined,
-  TAccount extends Account | undefined,
-  TChainOverride extends ChainEIP712 | undefined = undefined,
+  chain extends ChainEIP712 | undefined,
+  account extends Account | undefined,
+  const request extends SendTransactionRequest<chain, chainOverride>,
+  chainOverride extends ChainEIP712 | undefined = undefined,
 >(
-  client: Client<Transport, TChain, TAccount>,
-  args: SendEip712TransactionParameters<TChain, TAccount, TChainOverride>,
+  client: Client<Transport, chain, account>,
+  parameters: SendEip712TransactionParameters<
+    chain,
+    account,
+    chainOverride,
+    request
+  >,
 ): Promise<SendEip712TransactionReturnType> {
-  const { chain = client.chain } = args
+  const { chain = client.chain } = parameters
 
-  if (!args.account)
+  if (!parameters.account)
     throw new AccountNotFoundError({
       docsPath: '/docs/actions/wallet/sendTransaction',
     })
-  const account = parseAccount(args.account)
+  const account = parseAccount(parameters.account)
 
   try {
-    assertEip712Request(args)
+    assertEip712Request(parameters)
 
     // Prepare the request for signing (assign appropriate fees, etc.)
     const request = await prepareTransactionRequest(client, {
-      ...args,
+      ...parameters,
       parameters: ['gas', 'nonce', 'fees'],
     } as any)
 
@@ -121,7 +132,7 @@ export async function sendEip712Transaction<
     })
   } catch (err) {
     throw getTransactionError(err as BaseError, {
-      ...(args as GetTransactionErrorParameters),
+      ...(parameters as GetTransactionErrorParameters),
       account,
       chain: chain as Chain,
     })