viem 2.0.0-beta.6 → 2.0.0-beta.9

package/actions/public/getTransaction.ts

@@ -54,7 +54,7 @@ export type GetTransactionParameters<TBlockTag extends BlockTag = 'latest'> =
     }
 
 export type GetTransactionReturnType<
-  TChain extends Chain | undefined = Chain,
+  TChain extends Chain | undefined = undefined,
   TBlockTag extends BlockTag = 'latest',
 > = FormattedTransaction<TChain, TBlockTag>
 
@@ -67,7 +67,7 @@ export type GetTransactionErrorType =
  * Returns information about a [Transaction](https://viem.sh/docs/glossary/terms.html#transaction) given a hash or block identifier.
  *
  * - Docs: https://viem.sh/docs/actions/public/getTransaction.html
- * - Example: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/transactions/fetching-transactions
+ * - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions
  * - JSON-RPC Methods: [`eth_getTransactionByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionByHash)
  *
  * @param client - Client to use

package/actions/public/getTransactionConfirmations.ts

@@ -40,7 +40,7 @@ export type GetTransactionConfirmationsErrorType =
  * Returns the number of blocks passed (confirmations) since the transaction was processed on a block.
  *
  * - Docs: https://viem.sh/docs/actions/public/getTransactionConfirmations.html
- * - Example: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/transactions/fetching-transactions
+ * - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions
  * - JSON-RPC Methods: [`eth_getTransactionConfirmations`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionConfirmations)
  *
  * @param client - Client to use
@@ -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/getTransactionReceipt.ts

@@ -19,7 +19,7 @@ export type GetTransactionReceiptParameters = {
 }
 
 export type GetTransactionReceiptReturnType<
-  TChain extends Chain | undefined = Chain | undefined,
+  TChain extends Chain | undefined = undefined,
 > = FormattedTransactionReceipt<TChain>
 
 export type GetTransactionReceiptErrorType =
@@ -31,7 +31,7 @@ export type GetTransactionReceiptErrorType =
  * Returns the [Transaction Receipt](https://viem.sh/docs/glossary/terms.html#transaction-receipt) given a [Transaction](https://viem.sh/docs/glossary/terms.html#transaction) hash.
  *
  * - Docs: https://viem.sh/docs/actions/public/getTransactionReceipt.html
- * - Example: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/transactions/fetching-transactions
+ * - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions
  * - JSON-RPC Methods: [`eth_getTransactionReceipt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gettransactionreceipt)
  *
  * @param client - Client to use

package/actions/public/multicall.ts

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

package/actions/public/readContract.ts

@@ -65,7 +65,7 @@ export type ReadContractErrorType = GetContractErrorReturnType<
  * Calls a read-only function on a contract, and returns the response.
  *
  * - Docs: https://viem.sh/docs/contract/readContract.html
- * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/contracts/reading-contracts
+ * - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/reading-contracts
  *
  * A "read-only" function (constant function) on a Solidity contract is denoted by a `view` or `pure` keyword. They can only read the state of the contract, and cannot make any changes to it. Since read-only methods do not change the state of the contract, they do not require any gas to be executed, and can be called by any user without the need to pay for gas.
  *
@@ -112,6 +112,7 @@ export async function readContract<
     const { data } = await getAction(
       client,
       call,
+      'call',
     )({
       ...(rest as CallParameters),
       data: calldata,

package/actions/public/simulateContract.ts

@@ -9,7 +9,7 @@ import type { Transport } from '../../clients/transports/createTransport.js'
 import type { BaseError } from '../../errors/base.js'
 import type { ErrorType } from '../../errors/utils.js'
 import type { Account, ParseAccount } from '../../types/account.js'
-import type { Chain } from '../../types/chain.js'
+import type { Chain, DeriveChain } from '../../types/chain.js'
 import type {
   ContractFunctionArgs,
   ContractFunctionName,
@@ -51,6 +51,8 @@ export type SimulateContractParameters<
   chain extends Chain | undefined = Chain | undefined,
   chainOverride extends Chain | undefined = Chain | undefined,
   accountOverride extends Account | Address | undefined = undefined,
+  ///
+  derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>,
 > = {
   account?: accountOverride
   chain?: chainOverride
@@ -63,14 +65,14 @@ export type SimulateContractParameters<
   args
 > &
   UnionOmit<
-    CallParameters<chainOverride extends Chain ? chainOverride : chain>,
+    CallParameters<derivedChain>,
     'account' | 'batch' | 'to' | 'data' | 'value'
   > &
   GetValue<
     abi,
     functionName,
-    CallParameters<chain> extends CallParameters
-      ? CallParameters<chain>['value']
+    CallParameters<derivedChain> extends CallParameters
+      ? CallParameters<derivedChain>['value']
       : CallParameters['value']
   >
 
@@ -150,7 +152,7 @@ export type SimulateContractErrorType =
  * Simulates/validates a contract interaction. This is useful for retrieving **return data** and **revert reasons** of contract write functions.
  *
  * - Docs: https://viem.sh/docs/contract/simulateContract.html
- * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/contracts/writing-to-contracts
+ * - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/writing-to-contracts
  *
  * This function does not require gas to execute and _**does not**_ change the state of the blockchain. It is almost identical to [`readContract`](https://viem.sh/docs/contract/readContract.html), but also supports contract write functions.
  *
@@ -221,6 +223,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

@@ -1,5 +1,6 @@
 import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
+import { BlockNotFoundError } from '../../errors/block.js'
 import {
   TransactionNotFoundError,
   TransactionReceiptNotFoundError,
@@ -77,7 +78,7 @@ export type WaitForTransactionReceiptErrorType =
  * Waits for the [Transaction](https://viem.sh/docs/glossary/terms.html#transaction) to be included on a [Block](https://viem.sh/docs/glossary/terms.html#block) (one confirmation), and then returns the [Transaction Receipt](https://viem.sh/docs/glossary/terms.html#transaction-receipt). If the Transaction reverts, then the action will throw an error.
  *
  * - Docs: https://viem.sh/docs/actions/public/waitForTransactionReceipt.html
- * - Example: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/transactions/sending-transactions
+ * - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/sending-transactions
  * - JSON-RPC Methods:
  *   - Polls [`eth_getTransactionReceipt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionReceipt) on each block until it has been processed.
  *   - If a Transaction has been replaced:
@@ -144,6 +145,7 @@ export async function waitForTransactionReceipt<
         const _unwatch = getAction(
           client,
           watchBlockNumber,
+          'watchBlockNumber',
         )({
           emitMissed: true,
           emitOnBegin: true,
@@ -185,6 +187,7 @@ export async function waitForTransactionReceipt<
                     transaction = (await getAction(
                       client,
                       getTransaction,
+                      'getTransaction',
                     )({ hash })) as GetTransactionReturnType<TChain>
                     if (transaction.blockNumber)
                       blockNumber = transaction.blockNumber
@@ -199,7 +202,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 (
@@ -214,21 +221,40 @@ export async function waitForTransactionReceipt<
               // If the receipt is not found, the transaction will be pending.
               // We need to check if it has potentially been replaced.
               if (
-                transaction &&
-                (err instanceof TransactionNotFoundError ||
-                  err instanceof TransactionReceiptNotFoundError)
+                err instanceof TransactionNotFoundError ||
+                err instanceof TransactionReceiptNotFoundError
               ) {
+                if (!transaction) {
+                  retrying = false
+                  return
+                }
+
                 try {
                   replacedTransaction = transaction
 
                   // Let's retrieve the transactions from the current block.
-                  const block = await getAction(
-                    client,
-                    getBlock,
-                  )({
-                    blockNumber,
-                    includeTransactions: true,
-                  })
+                  // We need to retry as some RPC Providers may be slow to sync
+                  // up mined blocks.
+                  retrying = true
+                  const block = await withRetry(
+                    () =>
+                      getAction(
+                        client,
+                        getBlock,
+                        'getBlock',
+                      )({
+                        blockNumber,
+                        includeTransactions: true,
+                      }),
+                    {
+                      // exponential backoff
+                      delay: ({ count }) => ~~(1 << count) * 200,
+                      retryCount: 6,
+                      shouldRetry: ({ error }) =>
+                        error instanceof BlockNotFoundError,
+                    },
+                  )
+                  retrying = false
 
                   const replacementTransaction = (
                     block.transactions as {} as Transaction[]
@@ -245,6 +271,7 @@ export async function waitForTransactionReceipt<
                   receipt = await getAction(
                     client,
                     getTransactionReceipt,
+                    'getTransactionReceipt',
                   )({
                     hash: replacementTransaction.hash,
                   })
@@ -273,7 +300,7 @@ export async function waitForTransactionReceipt<
                   done(() => {
                     emit.onReplaced?.({
                       reason,
-                      replacedTransaction: replacedTransaction!,
+                      replacedTransaction: replacedTransaction! as any,
                       transaction: replacementTransaction,
                       transactionReceipt: receipt,
                     })

package/actions/public/watchBlockNumber.ts

@@ -56,7 +56,7 @@ export type WatchBlockNumberErrorType = PollErrorType | ErrorType
  * Watches and returns incoming block numbers.
  *
  * - Docs: https://viem.sh/docs/actions/public/watchBlockNumber.html
- * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/blocks/watching-blocks
+ * - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/watching-blocks
  * - JSON-RPC Methods:
  *   - When `poll: true`, calls [`eth_blockNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_blocknumber) on a polling interval.
  *   - When `poll: false` & WebSocket Transport, uses a WebSocket subscription via [`eth_subscribe`](https://docs.alchemy.com/reference/eth-subscribe-polygon) and the `"newHeads"` event.
@@ -112,6 +112,7 @@ export function watchBlockNumber<
             const blockNumber = await getAction(
               client,
               getBlockNumber,
+              'getBlockNumber',
             )({ cacheTime: 0 })
 
             if (prevBlockNumber) {

package/actions/public/watchBlocks.ts

@@ -77,7 +77,7 @@ export type WatchBlocksErrorType =
  * Watches and returns information for incoming blocks.
  *
  * - Docs: https://viem.sh/docs/actions/public/watchBlocks.html
- * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/blocks/watching-blocks
+ * - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/watching-blocks
  * - JSON-RPC Methods:
  *   - When `poll: true`, calls [`eth_getBlockByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getBlockByNumber) on a polling interval.
  *   - When `poll: false` & WebSocket Transport, uses a WebSocket subscription via [`eth_subscribe`](https://docs.alchemy.com/reference/eth-subscribe-polygon) and the `"newHeads"` event.
@@ -141,6 +141,7 @@ export function watchBlocks<
             const block = await getAction(
               client,
               getBlock,
+              'getBlock',
             )({
               blockTag,
               includeTransactions,
@@ -157,6 +158,7 @@ export function watchBlocks<
                   const block = (await getAction(
                     client,
                     getBlock,
+                    'getBlock',
                   )({
                     blockNumber: i,
                     includeTransactions,

package/actions/public/watchContractEvent.ts

@@ -177,6 +177,7 @@ export function watchContractEvent<
               filter = (await getAction(
                 client,
                 createContractEventFilter,
+                'createContractEventFilter',
               )({
                 abi,
                 address,
@@ -192,13 +193,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,
@@ -207,6 +216,7 @@ export function watchContractEvent<
                 logs = await getAction(
                   client,
                   getContractEvents,
+                  'getContractEvents',
                 )({
                   abi,
                   address,
@@ -224,7 +234,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
@@ -240,7 +250,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

@@ -195,6 +195,7 @@ export function watchEvent<
               filter = (await getAction(
                 client,
                 createEventFilter as any,
+                'createEventFilter',
               )({
                 address,
                 args,
@@ -214,13 +215,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,
@@ -229,6 +238,7 @@ export function watchEvent<
                 logs = await getAction(
                   client,
                   getLogs,
+                  'getLogs',
                 )({
                   address,
                   args,
@@ -245,7 +255,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
@@ -261,7 +271,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

@@ -96,6 +96,7 @@ export function watchPendingTransactions<
                 filter = await getAction(
                   client,
                   createPendingTransactionFilter,
+                  'createPendingTransactionFilter',
                 )({})
                 return
               } catch (err) {
@@ -104,10 +105,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)
           }
@@ -119,7 +124,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/addChain.ts

@@ -43,18 +43,21 @@ export async function addChain<
   TAccount extends Account | undefined,
 >(client: Client<Transport, TChain, TAccount>, { chain }: AddChainParameters) {
   const { id, name, nativeCurrency, rpcUrls, blockExplorers } = chain
-  await client.request({
-    method: 'wallet_addEthereumChain',
-    params: [
-      {
-        chainId: numberToHex(id),
-        chainName: name,
-        nativeCurrency,
-        rpcUrls: rpcUrls.default.http,
-        blockExplorerUrls: blockExplorers
-          ? Object.values(blockExplorers).map(({ url }) => url)
-          : undefined,
-      },
-    ],
-  })
+  await client.request(
+    {
+      method: 'wallet_addEthereumChain',
+      params: [
+        {
+          chainId: numberToHex(id),
+          chainName: name,
+          nativeCurrency,
+          rpcUrls: rpcUrls.default.http,
+          blockExplorerUrls: blockExplorers
+            ? Object.values(blockExplorers).map(({ url }) => url)
+            : undefined,
+        },
+      ],
+    },
+    { retryCount: 0 },
+  )
 }

package/actions/wallet/deployContract.ts

@@ -4,7 +4,7 @@ import type { Account } from '../../accounts/types.js'
 import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import type { Chain } from '../../types/chain.js'
-import type { GetChain } from '../../types/chain.js'
+import type { GetChainParameter } from '../../types/chain.js'
 import type { ContractConstructorArgs } from '../../types/contract.js'
 import type { Hex } from '../../types/misc.js'
 import type { UnionEvaluate, UnionOmit } from '../../types/utils.js'
@@ -29,7 +29,7 @@ export type DeployContractParameters<
   SendTransactionParameters<chain, account, chainOverride>,
   'accessList' | 'chain' | 'to' | 'data'
 > &
-  GetChain<chain, chainOverride> &
+  GetChainParameter<chain, chainOverride> &
   UnionEvaluate<
     readonly [] extends allArgs
       ? { args?: allArgs | undefined }
@@ -47,7 +47,7 @@ export type DeployContractErrorType = SendTransactionErrorType | ErrorType
  * Deploys a contract to the network, given bytecode and constructor arguments.
  *
  * - Docs: https://viem.sh/docs/contract/deployContract.html
- * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/contracts/deploying-contracts
+ * - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/deploying-contracts
  *
  * @param client - Client to use
  * @param parameters - {@link DeployContractParameters}