viem 1.2.9 → 1.2.11

package/src/clients/createPublicClient.ts

@@ -6,23 +6,25 @@ import { type PublicActions, publicActions } from './decorators/public.js'
 import type { Transport } from './transports/createTransport.js'
 
 export type PublicClientConfig<
-  TTransport extends Transport = Transport,
-  TChain extends Chain | undefined = Chain | undefined,
-> = Pick<
-  ClientConfig<TTransport, TChain>,
-  'batch' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
+> = Prettify<
+  Pick<
+    ClientConfig<transport, chain>,
+    'batch' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
+  >
 >
 
 export type PublicClient<
-  TTransport extends Transport = Transport,
-  TChain extends Chain | undefined = Chain | undefined,
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
 > = Prettify<
   Client<
-    TTransport,
-    TChain,
+    transport,
+    chain,
     undefined,
     PublicRpcSchema,
-    PublicActions<TTransport, TChain>
+    PublicActions<transport, chain>
   >
 >
 
@@ -46,23 +48,21 @@ export type PublicClient<
  * })
  */
 export function createPublicClient<
-  TTransport extends Transport,
-  TChain extends Chain | undefined = undefined,
->({
-  batch,
-  chain,
-  key = 'public',
-  name = 'Public Client',
-  transport,
-  pollingInterval,
-}: PublicClientConfig<TTransport, TChain>): PublicClient<TTransport, TChain> {
-  return createClient({
-    batch,
-    chain,
+  transport extends Transport,
+  chain extends Chain | undefined = undefined,
+>(
+  parameters: PublicClientConfig<transport, chain>,
+): PublicClient<transport, chain>
+
+export function createPublicClient(
+  parameters: PublicClientConfig,
+): PublicClient {
+  const { key = 'public', name = 'Public Client' } = parameters
+  const client = createClient({
+    ...parameters,
     key,
     name,
-    pollingInterval,
-    transport,
     type: 'publicClient',
-  }).extend(publicActions)
+  })
+  return client.extend(publicActions)
 }

package/src/clients/createTestClient.ts

@@ -2,6 +2,7 @@ import type { Account } from '../accounts/types.js'
 import type { ParseAccount } from '../types/account.js'
 import type { Chain } from '../types/chain.js'
 import type { TestRpcSchema } from '../types/eip1193.js'
+import type { Prettify } from '../types/utils.js'
 import { type Client, type ClientConfig, createClient } from './createClient.js'
 import { type TestActions, testActions } from './decorators/test.js'
 import type { Transport } from './transports/createTransport.js'
@@ -10,36 +11,38 @@ import type { Address } from 'abitype'
 export type TestClientMode = 'anvil' | 'hardhat' | 'ganache'
 
 export type TestClientConfig<
-  TMode extends TestClientMode = TestClientMode,
-  TTransport extends Transport = Transport,
-  TChain extends Chain | undefined = Chain | undefined,
-  TAccountOrAddress extends Account | Address | undefined =
+  mode extends TestClientMode = TestClientMode,
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
+  accountOrAddress extends Account | Address | undefined =
     | Account
     | Address
     | undefined,
-> = Pick<
-  ClientConfig<TTransport, TChain, TAccountOrAddress>,
-  'account' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
-> & {
-  /** Mode of the test client. Available: "anvil" | "hardhat" | "ganache" */
-  mode: TMode
-}
+> = Prettify<
+  Pick<
+    ClientConfig<transport, chain, accountOrAddress>,
+    'account' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
+  > & {
+    /** Mode of the test client. */
+    mode: mode | ('anvil' | 'hardhat' | 'ganache') // TODO: Type utility that expands `TestClientMode`
+  }
+>
 
 export type TestClient<
   TMode extends TestClientMode = TestClientMode,
-  TTransport extends Transport = Transport,
-  TChain extends Chain | undefined = Chain | undefined,
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
   TAccount extends Account | undefined = Account | undefined,
   TIncludeActions extends boolean = true,
-> = Client<
-  TTransport,
-  TChain,
-  TAccount,
-  TestRpcSchema<TMode>,
-  TIncludeActions extends true ? TestActions : Record<string, unknown>
-> & {
-  mode: TMode
-}
+> = Prettify<
+  { mode: TMode } & Client<
+    transport,
+    chain,
+    TAccount,
+    TestRpcSchema<TMode>,
+    TIncludeActions extends true ? TestActions : Record<string, unknown>
+  >
+>
 
 /**
  * @description Creates a test client with a given transport.
@@ -65,33 +68,24 @@ export type TestClient<
  * })
  */
 export function createTestClient<
-  TMode extends TestClientMode,
-  TTransport extends Transport,
-  TChain extends Chain | undefined = undefined,
-  TAccountOrAddress extends Account | Address | undefined = undefined,
->({
-  account,
-  chain,
-  key = 'test',
-  name = 'Test Client',
-  mode,
-  pollingInterval,
-  transport,
-}: TestClientConfig<TMode, TTransport, TChain, TAccountOrAddress>): TestClient<
-  TMode,
-  TTransport,
-  TChain,
-  ParseAccount<TAccountOrAddress>
-> {
-  return createClient({
-    account,
-    chain,
+  mode extends 'anvil' | 'hardhat' | 'ganache', // TODO: Type utility that expands `TestClientMode`
+  transport extends Transport,
+  chain extends Chain | undefined = undefined,
+  accountOrAddress extends Account | Address | undefined = undefined,
+>(
+  parameters: TestClientConfig<mode, transport, chain, accountOrAddress>,
+): TestClient<mode, transport, chain, ParseAccount<accountOrAddress>>
+
+export function createTestClient(parameters: TestClientConfig): TestClient {
+  const { key = 'test', name = 'Test Client', mode } = parameters
+  const client = createClient({
+    ...parameters,
     key,
     name,
-    pollingInterval,
-    transport,
     type: 'testClient',
   })
-    .extend(() => ({ mode }))
-    .extend(testActions({ mode }))
+  return client.extend((config) => ({
+    mode,
+    ...testActions({ mode })(config),
+  }))
 }

package/src/clients/createWalletClient.ts

@@ -10,28 +10,30 @@ import { type WalletActions, walletActions } from './decorators/wallet.js'
 import type { Transport } from './transports/createTransport.js'
 
 export type WalletClientConfig<
-  TTransport extends Transport = Transport,
-  TChain extends Chain | undefined = Chain | undefined,
-  TAccountOrAddress extends Account | Address | undefined =
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
+  accountOrAddress extends Account | Address | undefined =
     | Account
     | Address
     | undefined,
-> = Pick<
-  ClientConfig<TTransport, TChain, TAccountOrAddress>,
-  'account' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
+> = Prettify<
+  Pick<
+    ClientConfig<transport, chain, accountOrAddress>,
+    'account' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
+  >
 >
 
 export type WalletClient<
-  TTransport extends Transport = Transport,
-  TChain extends Chain | undefined = Chain | undefined,
-  TAccount extends Account | undefined = Account | undefined,
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
 > = Prettify<
   Client<
-    TTransport,
-    TChain,
-    TAccount,
+    transport,
+    chain,
+    account,
     WalletRpcSchema,
-    WalletActions<TChain, TAccount>
+    WalletActions<chain, account>
   >
 >
 
@@ -72,28 +74,23 @@ export type WalletClient<
  * })
  */
 export function createWalletClient<
-  TTransport extends Transport,
-  TChain extends Chain | undefined = undefined,
-  TAccountOrAddress extends Account | Address | undefined = undefined,
->({
-  account,
-  chain,
-  transport,
-  key = 'wallet',
-  name = 'Wallet Client',
-  pollingInterval,
-}: WalletClientConfig<TTransport, TChain, TAccountOrAddress>): WalletClient<
-  TTransport,
-  TChain,
-  ParseAccount<TAccountOrAddress>
-> {
-  return createClient({
-    account,
-    chain,
+  transport extends Transport,
+  chain extends Chain | undefined = undefined,
+  accountOrAddress extends Account | Address | undefined = undefined,
+>(
+  parameters: WalletClientConfig<transport, chain, accountOrAddress>,
+): WalletClient<transport, chain, ParseAccount<accountOrAddress>>
+
+export function createWalletClient(
+  parameters: WalletClientConfig,
+): WalletClient {
+  const { key = 'wallet', name = 'Wallet Client', transport } = parameters
+  const client = createClient({
+    ...parameters,
     key,
     name,
-    pollingInterval,
     transport: (opts) => transport({ ...opts, retryCount: 0 }),
     type: 'walletClient',
-  }).extend(walletActions)
+  })
+  return client.extend(walletActions)
 }

package/src/clients/decorators/public.ts

@@ -1374,52 +1374,57 @@ export type PublicActions<
   ) => WatchPendingTransactionsReturnType
 }
 
-export const publicActions = <
+export function publicActions<
   TTransport extends Transport = Transport,
   TChain extends Chain | undefined = Chain | undefined,
   TAccount extends Account | undefined = Account | undefined,
 >(
   client: Client<TTransport, TChain, TAccount>,
-): PublicActions<TTransport, TChain, TAccount> => ({
-  call: (args) => call(client, args),
-  createBlockFilter: () => createBlockFilter(client),
-  createContractEventFilter: (args) => createContractEventFilter(client, args),
-  createEventFilter: (args) => createEventFilter(client, args),
-  createPendingTransactionFilter: () => createPendingTransactionFilter(client),
-  estimateContractGas: (args) => estimateContractGas(client, args as any),
-  estimateGas: (args) => estimateGas(client, args),
-  getBalance: (args) => getBalance(client, args),
-  getBlock: (args) => getBlock(client, args),
-  getBlockNumber: (args) => getBlockNumber(client, args),
-  getBlockTransactionCount: (args) => getBlockTransactionCount(client, args),
-  getBytecode: (args) => getBytecode(client, args),
-  getChainId: () => getChainId(client),
-  getEnsAddress: (args) => getEnsAddress(client, args),
-  getEnsAvatar: (args) => getEnsAvatar(client, args),
-  getEnsName: (args) => getEnsName(client, args),
-  getEnsResolver: (args) => getEnsResolver(client, args),
-  getEnsText: (args) => getEnsText(client, args),
-  getFeeHistory: (args) => getFeeHistory(client, args),
-  getFilterChanges: (args) => getFilterChanges(client, args),
-  getFilterLogs: (args) => getFilterLogs(client, args),
-  getGasPrice: () => getGasPrice(client),
-  getLogs: (args) => getLogs(client, args),
-  getStorageAt: (args) => getStorageAt(client, args),
-  getTransaction: (args) => getTransaction(client, args),
-  getTransactionConfirmations: (args) =>
-    getTransactionConfirmations(client, args),
-  getTransactionCount: (args) => getTransactionCount(client, args),
-  getTransactionReceipt: (args) => getTransactionReceipt(client, args),
-  multicall: (args) => multicall(client, args),
-  readContract: (args) => readContract(client, args),
-  simulateContract: (args) => simulateContract(client, args),
-  verifyMessage: (args) => verifyMessage(client, args),
-  verifyTypedData: (args) => verifyTypedData(client, args),
-  uninstallFilter: (args) => uninstallFilter(client, args),
-  waitForTransactionReceipt: (args) => waitForTransactionReceipt(client, args),
-  watchBlocks: (args) => watchBlocks(client, args),
-  watchBlockNumber: (args) => watchBlockNumber(client, args),
-  watchContractEvent: (args) => watchContractEvent(client, args),
-  watchEvent: (args) => watchEvent(client, args),
-  watchPendingTransactions: (args) => watchPendingTransactions(client, args),
-})
+): PublicActions<TTransport, TChain, TAccount> {
+  return {
+    call: (args) => call(client, args),
+    createBlockFilter: () => createBlockFilter(client),
+    createContractEventFilter: (args) =>
+      createContractEventFilter(client, args),
+    createEventFilter: (args) => createEventFilter(client, args),
+    createPendingTransactionFilter: () =>
+      createPendingTransactionFilter(client),
+    estimateContractGas: (args) => estimateContractGas(client, args as any),
+    estimateGas: (args) => estimateGas(client, args),
+    getBalance: (args) => getBalance(client, args),
+    getBlock: (args) => getBlock(client, args),
+    getBlockNumber: (args) => getBlockNumber(client, args),
+    getBlockTransactionCount: (args) => getBlockTransactionCount(client, args),
+    getBytecode: (args) => getBytecode(client, args),
+    getChainId: () => getChainId(client),
+    getEnsAddress: (args) => getEnsAddress(client, args),
+    getEnsAvatar: (args) => getEnsAvatar(client, args),
+    getEnsName: (args) => getEnsName(client, args),
+    getEnsResolver: (args) => getEnsResolver(client, args),
+    getEnsText: (args) => getEnsText(client, args),
+    getFeeHistory: (args) => getFeeHistory(client, args),
+    getFilterChanges: (args) => getFilterChanges(client, args),
+    getFilterLogs: (args) => getFilterLogs(client, args),
+    getGasPrice: () => getGasPrice(client),
+    getLogs: (args) => getLogs(client, args),
+    getStorageAt: (args) => getStorageAt(client, args),
+    getTransaction: (args) => getTransaction(client, args),
+    getTransactionConfirmations: (args) =>
+      getTransactionConfirmations(client, args),
+    getTransactionCount: (args) => getTransactionCount(client, args),
+    getTransactionReceipt: (args) => getTransactionReceipt(client, args),
+    multicall: (args) => multicall(client, args),
+    readContract: (args) => readContract(client, args),
+    simulateContract: (args) => simulateContract(client, args),
+    verifyMessage: (args) => verifyMessage(client, args),
+    verifyTypedData: (args) => verifyTypedData(client, args),
+    uninstallFilter: (args) => uninstallFilter(client, args),
+    waitForTransactionReceipt: (args) =>
+      waitForTransactionReceipt(client, args),
+    watchBlocks: (args) => watchBlocks(client, args),
+    watchBlockNumber: (args) => watchBlockNumber(client, args),
+    watchContractEvent: (args) => watchContractEvent(client, args),
+    watchEvent: (args) => watchEvent(client, args),
+    watchPendingTransactions: (args) => watchPendingTransactions(client, args),
+  }
+}

package/src/clients/decorators/wallet.ts

@@ -523,24 +523,26 @@ export type WalletActions<
   ) => Promise<WriteContractReturnType>
 }
 
-export const walletActions = <
+export function walletActions<
   TTransport extends Transport,
   TChain extends Chain | undefined = Chain | undefined,
   TAccount extends Account | undefined = Account | undefined,
 >(
   client: Client<TTransport, TChain, TAccount>,
-): WalletActions<TChain, TAccount> => ({
-  addChain: (args) => addChain(client, args),
-  deployContract: (args) => deployContract(client, args),
-  getAddresses: () => getAddresses(client),
-  getChainId: () => getChainId(client),
-  getPermissions: () => getPermissions(client),
-  requestAddresses: () => requestAddresses(client),
-  requestPermissions: (args) => requestPermissions(client, args),
-  sendTransaction: (args) => sendTransaction(client, args),
-  signMessage: (args) => signMessage(client, args),
-  signTypedData: (args) => signTypedData(client, args),
-  switchChain: (args) => switchChain(client, args),
-  watchAsset: (args) => watchAsset(client, args),
-  writeContract: (args) => writeContract(client, args),
-})
+): WalletActions<TChain, TAccount> {
+  return {
+    addChain: (args) => addChain(client, args),
+    deployContract: (args) => deployContract(client, args),
+    getAddresses: () => getAddresses(client),
+    getChainId: () => getChainId(client),
+    getPermissions: () => getPermissions(client),
+    requestAddresses: () => requestAddresses(client),
+    requestPermissions: (args) => requestPermissions(client, args),
+    sendTransaction: (args) => sendTransaction(client, args),
+    signMessage: (args) => signMessage(client, args),
+    signTypedData: (args) => signTypedData(client, args),
+    switchChain: (args) => switchChain(client, args),
+    watchAsset: (args) => watchAsset(client, args),
+    writeContract: (args) => writeContract(client, args),
+  }
+}

package/src/errors/version.ts

@@ -1 +1 @@
-export const version = '1.2.9'
+export const version = '1.2.10'

package/src/types/chain.ts

@@ -1,4 +1,3 @@
-import type { Chain as Chain_ } from '@wagmi/chains'
 import type { Address } from 'abitype'
 
 import type { Formatters } from './formatter.js'
@@ -6,13 +5,13 @@ import type { Serializers } from './serializer.js'
 import type { IsUndefined } from './utils.js'
 
 export type Chain<
-  TFormatters extends Formatters | undefined = Formatters | undefined,
-  TSerializers extends Serializers<TFormatters> | undefined =
-    | Serializers<TFormatters>
+  formatters extends Formatters | undefined = Formatters | undefined,
+  serializers extends Serializers<formatters> | undefined =
+    | Serializers<formatters>
     | undefined,
-> = Chain_ & {
-  formatters?: TFormatters
-  serializers?: TSerializers
+> = import('@wagmi/chains').Chain & {
+  formatters?: formatters | undefined
+  serializers?: serializers | undefined
 }
 
 export type ChainContract = {

package/src/types/transaction.ts

@@ -35,7 +35,7 @@ export type TransactionReceipt<
   logs: Log<TQuantity, TIndex>[]
   /** Logs bloom filter */
   logsBloom: Hex
-  /** `1` if this transaction was successful or `0` if it failed */
+  /** `success` if this transaction was successful or `reverted` if it failed */
   status: TStatus
   /** Transaction recipient or `null` if deploying a contract */
   to: Address | null

package/src/types/typedData.ts

@@ -15,11 +15,11 @@ export type TypedDataDefinition<
   GetTypedDataDomain<TTypedData, TPrimaryType>
 
 export type GetTypedDataDomain<
-  TTypedData extends TypedData | { [key: string]: unknown } = TypedData,
+  TTypedData extends TypedData | { [key_1: string]: unknown } = TypedData,
   TPrimaryType extends string = string,
   TSchema = TTypedData extends TypedData
     ? TypedDataToPrimitiveTypes<TTypedData>
-    : { [key: string]: any },
+    : { [key_2: string]: any },
   TDomain = TSchema extends { EIP712Domain: infer Domain }
     ? Domain
     : TypedDataDomain,
@@ -32,24 +32,24 @@ export type GetTypedDataDomain<
     }
 
 export type GetTypedDataMessage<
-  TTypedData extends TypedData | { [key: string]: unknown } = TypedData,
+  TTypedData extends TypedData | { [key_1: string]: unknown } = TypedData,
   TPrimaryType extends string = string,
   TSchema = TTypedData extends TypedData
     ? TypedDataToPrimitiveTypes<TTypedData>
-    : { [key: string]: any },
+    : { [key_2: string]: any },
   TMessage = TSchema[TPrimaryType extends keyof TSchema
     ? TPrimaryType
     : keyof TSchema],
 > = TPrimaryType extends 'EIP712Domain'
   ? {}
-  : { [key: string]: any } extends TMessage // Check if we were able to infer the shape of typed data
+  : { [key_3: string]: any } extends TMessage // Check if we were able to infer the shape of typed data
   ? {
       /**
        * Data to sign
        *
        * Use a [const assertion](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html#const-assertions) on {@link types} for type inference.
        */
-      message: { [key: string]: unknown }
+      message: { [key_4: string]: unknown }
     }
   : {
       /** Data to sign */

package/src/utils/abi/encodePacked.ts

@@ -62,7 +62,7 @@ export function encodePacked<
 function encode<TPackedAbiType extends PackedAbiType | unknown>(
   type: TPackedAbiType,
   value: EncodePackedValues<[TPackedAbiType]>[0],
-  isArray: boolean = false,
+  isArray = false,
 ): Hex {
   if (type === 'address') {
     const address = value as Address

package/src/utils/ens/avatar/utils.ts

@@ -40,6 +40,7 @@ export async function isImageUri(uri: string) {
       return false
     }
     // fail in NodeJS, since the error is not cors but any other network issue
+    // rome-ignore lint/suspicious/noPrototypeBuiltins:
     if (!globalThis.hasOwnProperty('Image')) return false
     // in case of cors, use image api to validate if given url is an actual image
     return new Promise((resolve) => {
@@ -179,7 +180,8 @@ type ParsedNft = {
   tokenID: string
 }
 
-export function parseNftUri(uri: string): ParsedNft {
+export function parseNftUri(uri_: string): ParsedNft {
+  let uri = uri_
   // parse valid nft spec (CAIP-22/CAIP-29)
   // @see: https://github.com/ChainAgnostic/CAIPs/tree/master/CAIPs
   if (uri.startsWith('did:nft:')) {

package/src/utils/formatters/extract.ts

@@ -9,9 +9,10 @@ export function extract(
 ) {
   if (!format) return {}
   const keys = Object.keys(format({}))
-  return keys.reduce((data, key) => {
+  return keys.reduce((data: Record<string, unknown>, key) => {
+    // rome-ignore lint/suspicious/noPrototypeBuiltins:
     if (value?.hasOwnProperty(key)) {
-      ;(data as any)[key] = value[key]
+      data[key] = value[key]
     }
     return data
   }, {})

package/src/utils/transaction/prepareRequest.ts

@@ -72,7 +72,7 @@ export async function prepareRequest<
       blockTag: 'pending',
     })
 
-  if (block.baseFeePerGas) {
+  if (typeof block.baseFeePerGas === 'bigint') {
     if (typeof gasPrice !== 'undefined')
       throw new BaseError('Chain does not support legacy `gasPrice`.')