viem 1.19.1 → 1.19.4

package/actions/public/estimateMaxPriorityFeePerGas.ts

@@ -83,7 +83,7 @@ export async function internal_estimateMaxPriorityFeePerGas<
 ): Promise<EstimateMaxPriorityFeePerGasReturnType> {
   const { block: block_, chain = client.chain, request } = args || {}
   if (typeof chain?.fees?.defaultPriorityFee === 'function') {
-    const block = block_ || (await getAction(client, getBlock)({}))
+    const block = block_ || (await getAction(client, getBlock, 'getBlock')({}))
     return chain.fees.defaultPriorityFee({
       block,
       client,
@@ -102,8 +102,10 @@ export async function internal_estimateMaxPriorityFeePerGas<
     // fall back to calculating it manually via `gasPrice - baseFeePerGas`.
     // See: https://github.com/ethereum/pm/issues/328#:~:text=eth_maxPriorityFeePerGas%20after%20London%20will%20effectively%20return%20eth_gasPrice%20%2D%20baseFee
     const [block, gasPrice] = await Promise.all([
-      block_ ? Promise.resolve(block_) : getAction(client, getBlock)({}),
-      getAction(client, getGasPrice)({}),
+      block_
+        ? Promise.resolve(block_)
+        : getAction(client, getBlock, 'getBlock')({}),
+      getAction(client, getGasPrice, 'getGasPrice')({}),
     ])
 
     if (typeof block.baseFeePerGas !== 'bigint')

package/actions/public/getContractEvents.ts

@@ -134,6 +134,7 @@ export async function getContractEvents<
   return getAction(
     client,
     getLogs,
+    'getLogs',
   )({
     address,
     args,

package/actions/public/getTransactionConfirmations.ts

@@ -67,8 +67,10 @@ export async function getTransactionConfirmations<
   { hash, transactionReceipt }: GetTransactionConfirmationsParameters<TChain>,
 ): Promise<GetTransactionConfirmationsReturnType> {
   const [blockNumber, transaction] = await Promise.all([
-    getAction(client, getBlockNumber)({}),
-    hash ? getAction(client, getTransaction)({ hash }) : undefined,
+    getAction(client, getBlockNumber, 'getBlockNumber')({}),
+    hash
+      ? getAction(client, getTransaction, 'getBlockNumber')({ hash })
+      : undefined,
   ])
   const transactionBlockNumber =
     transactionReceipt?.blockNumber || transaction?.blockNumber

package/actions/public/multicall.ts

@@ -204,6 +204,7 @@ export async function multicall<
       getAction(
         client,
         readContract,
+        'readContract',
       )({
         abi: multicall3Abi,
         address: multicallAddress!,

package/actions/public/readContract.ts

@@ -95,6 +95,7 @@ export async function readContract<
     const { data } = await getAction(
       client,
       call,
+      'call',
     )({
       data: calldata,
       to: address,

package/actions/public/simulateContract.ts

@@ -146,6 +146,7 @@ export async function simulateContract<
     const { data } = await getAction(
       client,
       call,
+      'call',
     )({
       batch: false,
       data: `${calldata}${dataSuffix ? dataSuffix.replace('0x', '') : ''}`,

package/actions/public/verifyHash.ts

@@ -58,6 +58,7 @@ export async function verifyHash<TChain extends Chain | undefined,>(
     const { data } = await getAction(
       client,
       call,
+      'call',
     )({
       data: encodeDeployData({
         abi: universalSignatureValidatorAbi,

package/actions/public/waitForTransactionReceipt.ts

@@ -144,6 +144,7 @@ export async function waitForTransactionReceipt<
         const _unwatch = getAction(
           client,
           watchBlockNumber,
+          'watchBlockNumber',
         )({
           emitMissed: true,
           emitOnBegin: true,
@@ -185,6 +186,7 @@ export async function waitForTransactionReceipt<
                     transaction = (await getAction(
                       client,
                       getTransaction,
+                      'getTransaction',
                     )({ hash })) as GetTransactionReturnType<TChain>
                     if (transaction.blockNumber)
                       blockNumber = transaction.blockNumber
@@ -199,7 +201,11 @@ export async function waitForTransactionReceipt<
               }
 
               // Get the receipt to check if it's been processed.
-              receipt = await getAction(client, getTransactionReceipt)({ hash })
+              receipt = await getAction(
+                client,
+                getTransactionReceipt,
+                'getTransactionReceipt',
+              )({ hash })
 
               // Check if we have enough confirmations. If not, continue polling.
               if (
@@ -225,6 +231,7 @@ export async function waitForTransactionReceipt<
                   const block = await getAction(
                     client,
                     getBlock,
+                    'getBlock',
                   )({
                     blockNumber,
                     includeTransactions: true,
@@ -245,6 +252,7 @@ export async function waitForTransactionReceipt<
                   receipt = await getAction(
                     client,
                     getTransactionReceipt,
+                    'getTransactionReceipt',
                   )({
                     hash: replacementTransaction.hash,
                   })

package/actions/public/watchBlockNumber.ts

@@ -112,6 +112,7 @@ export function watchBlockNumber<
             const blockNumber = await getAction(
               client,
               getBlockNumber,
+              'getBlockNumber',
             )({ cacheTime: 0 })
 
             if (prevBlockNumber) {

package/actions/public/watchBlocks.ts

@@ -144,6 +144,7 @@ export function watchBlocks<
             const block = await getAction(
               client,
               getBlock,
+              'getBlock',
             )({
               blockTag,
               includeTransactions,
@@ -160,6 +161,7 @@ export function watchBlocks<
                   const block = (await getAction(
                     client,
                     getBlock,
+                    'getBlock',
                   )({
                     blockNumber: i,
                     includeTransactions,

package/actions/public/watchContractEvent.ts

@@ -191,6 +191,7 @@ export function watchContractEvent<
               filter = (await getAction(
                 client,
                 createContractEventFilter,
+                'createContractEventFilter',
               )({
                 abi,
                 address,
@@ -210,13 +211,21 @@ export function watchContractEvent<
           try {
             let logs: Log[]
             if (filter) {
-              logs = await getAction(client, getFilterChanges)({ filter })
+              logs = await getAction(
+                client,
+                getFilterChanges,
+                'getFilterChanges',
+              )({ filter })
             } else {
               // If the filter doesn't exist, we will fall back to use `getLogs`.
               // The fall back exists because some RPC Providers do not support filters.
 
               // Fetch the block number to use for `getLogs`.
-              const blockNumber = await getAction(client, getBlockNumber)({})
+              const blockNumber = await getAction(
+                client,
+                getBlockNumber,
+                'getBlockNumber',
+              )({})
 
               // If the block number has changed, we will need to fetch the logs.
               // If the block number doesn't exist, we are yet to reach the first poll interval,
@@ -225,6 +234,7 @@ export function watchContractEvent<
                 logs = await getAction(
                   client,
                   getContractEvents,
+                  'getContractEvents',
                 )({
                   abi,
                   address,
@@ -242,7 +252,7 @@ export function watchContractEvent<
 
             if (logs.length === 0) return
             if (batch) emit.onLogs(logs as any)
-            else logs.forEach((log) => emit.onLogs([log] as any))
+            else for (const log of logs) emit.onLogs([log] as any)
           } catch (err) {
             // If a filter has been set and gets uninstalled, providers will throw an InvalidInput error.
             // Reinitalize the filter when this occurs
@@ -258,7 +268,12 @@ export function watchContractEvent<
       )
 
       return async () => {
-        if (filter) await getAction(client, uninstallFilter)({ filter })
+        if (filter)
+          await getAction(
+            client,
+            uninstallFilter,
+            'uninstallFilter',
+          )({ filter })
         unwatch()
       }
     })

package/actions/public/watchEvent.ts

@@ -226,6 +226,7 @@ export function watchEvent<
               filter = (await getAction(
                 client,
                 createEventFilter as any,
+                'createEventFilter',
               )({
                 address,
                 args,
@@ -245,13 +246,21 @@ export function watchEvent<
           try {
             let logs: Log[]
             if (filter) {
-              logs = await getAction(client, getFilterChanges)({ filter })
+              logs = await getAction(
+                client,
+                getFilterChanges,
+                'getFilterChanges',
+              )({ filter })
             } else {
               // If the filter doesn't exist, we will fall back to use `getLogs`.
               // The fall back exists because some RPC Providers do not support filters.
 
               // Fetch the block number to use for `getLogs`.
-              const blockNumber = await getAction(client, getBlockNumber)({})
+              const blockNumber = await getAction(
+                client,
+                getBlockNumber,
+                'getBlockNumber',
+              )({})
 
               // If the block number has changed, we will need to fetch the logs.
               // If the block number doesn't exist, we are yet to reach the first poll interval,
@@ -260,6 +269,7 @@ export function watchEvent<
                 logs = await getAction(
                   client,
                   getLogs,
+                  'getLogs',
                 )({
                   address,
                   args,
@@ -276,7 +286,7 @@ export function watchEvent<
 
             if (logs.length === 0) return
             if (batch) emit.onLogs(logs as any)
-            else logs.forEach((log) => emit.onLogs([log] as any))
+            else for (const log of logs) emit.onLogs([log] as any)
           } catch (err) {
             // If a filter has been set and gets uninstalled, providers will throw an InvalidInput error.
             // Reinitalize the filter when this occurs
@@ -292,7 +302,12 @@ export function watchEvent<
       )
 
       return async () => {
-        if (filter) await getAction(client, uninstallFilter)({ filter })
+        if (filter)
+          await getAction(
+            client,
+            uninstallFilter,
+            'uninstallFilter',
+          )({ filter })
         unwatch()
       }
     })

package/actions/public/watchPendingTransactions.ts

@@ -129,6 +129,7 @@ export function watchPendingTransactions<
                 filter = await getAction(
                   client,
                   createPendingTransactionFilter,
+                  'createPendingTransactionFilter',
                 )({})
                 return
               } catch (err) {
@@ -137,10 +138,14 @@ export function watchPendingTransactions<
               }
             }
 
-            const hashes = await getAction(client, getFilterChanges)({ filter })
+            const hashes = await getAction(
+              client,
+              getFilterChanges,
+              'getFilterChanges',
+            )({ filter })
             if (hashes.length === 0) return
             if (batch) emit.onTransactions(hashes)
-            else hashes.forEach((hash) => emit.onTransactions([hash]))
+            else for (const hash of hashes) emit.onTransactions([hash])
           } catch (err) {
             emit.onError?.(err as Error)
           }
@@ -152,7 +157,12 @@ export function watchPendingTransactions<
       )
 
       return async () => {
-        if (filter) await getAction(client, uninstallFilter)({ filter })
+        if (filter)
+          await getAction(
+            client,
+            uninstallFilter,
+            'uninstallFilter',
+          )({ filter })
         unwatch()
       }
     })

package/actions/wallet/prepareTransactionRequest.ts

@@ -130,7 +130,11 @@ export async function prepareTransactionRequest<
   if (!account_) throw new AccountNotFoundError()
   const account = parseAccount(account_)
 
-  const block = await getAction(client, getBlock)({ blockTag: 'latest' })
+  const block = await getAction(
+    client,
+    getBlock,
+    'getBlock',
+  )({ blockTag: 'latest' })
 
   const request = { ...args, from: account.address }
 
@@ -138,6 +142,7 @@ export async function prepareTransactionRequest<
     request.nonce = await getAction(
       client,
       getTransactionCount,
+      'getTransactionCount',
     )({
       address: account.address,
       blockTag: 'pending',
@@ -196,6 +201,7 @@ export async function prepareTransactionRequest<
     request.gas = await getAction(
       client,
       estimateGas,
+      'estimateGas',
     )({
       ...request,
       account: { address: account.address, type: 'json-rpc' },

package/actions/wallet/sendTransaction.ts

@@ -155,7 +155,7 @@ export async function sendTransaction<
 
     let chainId
     if (chain !== null) {
-      chainId = await getAction(client, getChainId)({})
+      chainId = await getAction(client, getChainId, 'getChainId')({})
       assertCurrentChain({
         currentChainId: chainId,
         chain,
@@ -167,6 +167,7 @@ export async function sendTransaction<
       const request = await getAction(
         client,
         prepareTransactionRequest,
+        'prepareTransactionRequest',
       )({
         account,
         accessList,
@@ -182,7 +183,8 @@ export async function sendTransaction<
         ...rest,
       } as any)
 
-      if (!chainId) chainId = await getAction(client, getChainId)({})
+      if (!chainId)
+        chainId = await getAction(client, getChainId, 'getChainId')({})
 
       const serializer = chain?.serializers?.transaction
       const serializedTransaction = (await account.signTransaction(
@@ -195,6 +197,7 @@ export async function sendTransaction<
       return await getAction(
         client,
         sendRawTransaction,
+        'sendRawTransaction',
       )({
         serializedTransaction,
       })

package/actions/wallet/signTransaction.ts

@@ -128,7 +128,7 @@ export async function signTransaction<
     ...args,
   })
 
-  const chainId = await getAction(client, getChainId)({})
+  const chainId = await getAction(client, getChainId, 'getChainId')({})
   if (chain !== null)
     assertCurrentChain({
       currentChainId: chainId,

package/actions/wallet/writeContract.ts

@@ -138,6 +138,7 @@ export async function writeContract<
   const hash = await getAction(
     client,
     sendTransaction,
+    'sendTransaction',
   )({
     data: `${data}${dataSuffix ? dataSuffix.replace('0x', '') : ''}`,
     to: address,

package/chains/definitions/aurora.ts

@@ -18,4 +18,10 @@ export const aurora = /*#__PURE__*/ defineChain({
     etherscan: { name: 'Aurorascan', url: 'https://aurorascan.dev' },
     default: { name: 'Aurorascan', url: 'https://aurorascan.dev' },
   },
+  contracts: {
+    multicall3: {
+      address: '0xca11bde05977b3631167028862be2a173976ca11',
+      blockCreated: 62907816,
+    },
+  },
 })

package/chains/definitions/bscTestnet.ts

@@ -10,8 +10,8 @@ export const bscTestnet = /*#__PURE__*/ defineChain({
     symbol: 'tBNB',
   },
   rpcUrls: {
-    default: { http: ['https://data-seed-prebsc-1-s1.binance.org:8545'] },
-    public: { http: ['https://data-seed-prebsc-1-s1.binance.org:8545'] },
+    default: { http: ['https://data-seed-prebsc-1-s1.bnbchain.org:8545'] },
+    public: { http: ['https://data-seed-prebsc-1-s1.bnbchain.org:8545'] },
   },
   blockExplorers: {
     etherscan: { name: 'BscScan', url: 'https://testnet.bscscan.com' },

package/chains/definitions/shibarium.ts

@@ -0,0 +1,32 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const shibarium = /*#__PURE__*/ defineChain({
+  id: 109,
+  name: 'Shibarium',
+  network: 'shibarium',
+  nativeCurrency: { name: 'Bone', symbol: 'BONE', decimals: 18 },
+  rpcUrls: {
+    default: {
+      http: ['https://rpc.shibrpc.com'],
+    },
+    public: {
+      http: ['https://rpc.shibrpc.com'],
+    },
+  },
+  blockExplorers: {
+    etherscan: {
+      name: 'Blockscout',
+      url: 'https://shibariumscan.io',
+    },
+    default: {
+      name: 'Blockscout',
+      url: 'https://shibariumscan.io',
+    },
+  },
+  contracts: {
+    multicall3: {
+      address: '0x864Bf681ADD6052395188A89101A1B37d3B4C961',
+      blockCreated: 265900,
+    },
+  },
+})

package/chains/index.ts

@@ -137,6 +137,7 @@ export { songbird } from './definitions/songbird.js'
 export { songbirdTestnet } from './definitions/songbirdTestnet.js'
 export { spicy } from './definitions/spicy.js'
 export { shardeumSphinx } from './definitions/shardeumSphinx.js'
+export { shibarium } from './definitions/shibarium.js'
 export { syscoin } from './definitions/syscoin.js'
 export { syscoinTestnet } from './definitions/syscoinTestnet.js'
 export { taraxa } from './definitions/taraxa.js'

package/clients/createClient.ts

@@ -147,7 +147,7 @@ type Client_Base<
 
 type Extended = Prettify<
   // disallow redefining base properties
-  { [K in keyof Client_Base]?: undefined } & {
+  { [_ in keyof Client_Base]?: undefined } & {
     [key: string]: unknown
   }
 >

package/errors/version.ts

@@ -1 +1 @@
-export const version = '1.19.1'
+export const version = '1.19.2'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "1.19.1",
+  "version": "1.19.4",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",
@@ -133,7 +133,7 @@
     }
   },
   "dependencies": {
-    "@adraffy/ens-normalize": "1.9.4",
+    "@adraffy/ens-normalize": "1.10.0",
     "@noble/curves": "1.2.0",
     "@noble/hashes": "1.3.2",
     "@scure/bip32": "1.3.2",

package/types/ens.ts

@@ -1,5 +1,5 @@
 export type AssetGateway = 'ipfs' | 'arweave'
 
 export type AssetGatewayUrls = {
-  [key in AssetGateway]?: string
+  [_key in AssetGateway]?: string
 }

package/utils/encoding/toRlp.ts

@@ -88,7 +88,9 @@ function getEncodableList(list: Encodable[]): Encodable {
         else if (sizeOfBodyLength === 3) cursor.pushUint24(bodyLength)
         else cursor.pushUint32(bodyLength)
       }
-      list.forEach((x) => x.encode(cursor))
+      for (const { encode } of list) {
+        encode(cursor)
+      }
     },
   }
 }

package/utils/formatters/block.ts

@@ -28,7 +28,7 @@ export type FormattedBlock<
   _ExcludedPendingDependencies extends string = BlockPendingDependencies &
     ExtractChainFormatterExclude<TChain, 'block'>,
   _Formatted = Omit<_FormatterReturnType, BlockPendingDependencies> & {
-    [K in _ExcludedPendingDependencies]: never
+    [_key in _ExcludedPendingDependencies]: never
   } & Pick<
       Block<bigint, TIncludeTransactions, TBlockTag>,
       BlockPendingDependencies

package/utils/formatters/formatter.ts

@@ -31,7 +31,7 @@ export function defineFormatter<TType extends string, TParameters, TReturnType>(
           ...formatted,
           ...overrides(args),
         } as Prettify<Assign<TReturnType, TOverrideReturnType>> & {
-          [K in TExclude[number]]: never
+          [_key in TExclude[number]]: never
         }
       },
       type,

package/utils/formatters/transaction.ts

@@ -29,7 +29,7 @@ export type FormattedTransaction<
   _ExcludedPendingDependencies extends string = TransactionPendingDependencies &
     ExtractChainFormatterExclude<TChain, 'transaction'>,
 > = UnionOmit<_FormatterReturnType, TransactionPendingDependencies> & {
-  [K in _ExcludedPendingDependencies]: never
+  [_key in _ExcludedPendingDependencies]: never
 } & Pick<
     Transaction<bigint, number, TBlockTag extends 'pending' ? true : false>,
     TransactionPendingDependencies

package/utils/getAction.ts

@@ -1,13 +1,23 @@
 import type { Client } from '../clients/createClient.js'
 
+/**
+ * Retrieves and returns an action from the client (if exists), and falls
+ * back to the tree-shakable action.
+ *
+ * Useful for extracting overridden actions from a client (ie. if a consumer
+ * wants to override the `sendTransaction` implementation).
+ */
 export function getAction<params extends {}, returnType extends {}>(
   client: Client,
   action: (_: any, params: params) => returnType,
+  // Some minifiers drop `Function.prototype.name`, meaning that `action.name`
+  // will not work. For that case, the consumer needs to pass the name explicitly.
+  name: string,
 ) {
   return (params: params): returnType =>
     (
       client as Client & {
         [key: string]: (params: params) => returnType
       }
-    )[action.name]?.(params) ?? action(client, params)
+    )[action.name || name]?.(params) ?? action(client, params)
 }

package/utils/observe.ts

@@ -61,7 +61,7 @@ export function observe<TCallbacks extends Callbacks>(
     ) => {
       const listeners = getListeners()
       if (listeners.length === 0) return
-      listeners.forEach((listener) => listener.fns[key]?.(...args))
+      for (const listener of listeners) listener.fns[key]?.(...args)
     }) as TCallbacks[Extract<keyof TCallbacks, string>]
   }
 

package/utils/promise/createBatchScheduler.ts

@@ -66,12 +66,16 @@ export function createBatchScheduler<
     fn(args as TParameters[])
       .then((data) => {
         if (sort && Array.isArray(data)) data.sort(sort)
-        scheduler.forEach(({ pendingPromise }, i) =>
-          pendingPromise.resolve?.([data[i], data]),
-        )
+        for (let i = 0; i < scheduler.length; i++) {
+          const { pendingPromise } = scheduler[i]
+          pendingPromise.resolve?.([data[i], data])
+        }
       })
       .catch((err) => {
-        scheduler.forEach(({ pendingPromise }) => pendingPromise.reject?.(err))
+        for (let i = 0; i < scheduler.length; i++) {
+          const { pendingPromise } = scheduler[i]
+          pendingPromise.reject?.(err)
+        }
       })
   }
 

package/utils/unit/formatEther.ts

@@ -4,6 +4,17 @@ import { type FormatUnitsErrorType, formatUnits } from './formatUnits.js'
 
 export type FormatEtherErrorType = FormatUnitsErrorType
 
+/**
+ * Converts numerical wei to a string representation of ether.
+ *
+ * - Docs: https://viem.sh/docs/utilities/formatEther.html
+ *
+ * @example
+ * import { formatEther } from 'viem'
+ *
+ * formatEther(1000000000000000000n)
+ * // '1'
+ */
 export function formatEther(wei: bigint, unit: 'wei' | 'gwei' = 'wei') {
   return formatUnits(wei, etherUnits[unit])
 }

package/utils/unit/formatGwei.ts

@@ -4,6 +4,17 @@ import { type FormatUnitsErrorType, formatUnits } from './formatUnits.js'
 
 export type FormatGweiErrorType = FormatUnitsErrorType
 
+/**
+ * Converts numerical wei to a string representation of gwei.
+ *
+ * - Docs: https://viem.sh/docs/utilities/formatGwei.html
+ *
+ * @example
+ * import { formatGwei } from 'viem'
+ *
+ * formatGwei(1000000000n)
+ * // '1'
+ */
 export function formatGwei(wei: bigint, unit: 'wei' = 'wei') {
   return formatUnits(wei, gweiUnits[unit])
 }