viem 0.4.0-main.20230430T213120 → 1.0.1

package/src/actions/public/watchEvent.ts

@@ -1,17 +1,22 @@
-import type { AbiEvent } from 'abitype'
-import type { PublicClient, Transport } from '../../clients/index.js'
+import type { AbiEvent, Address } from 'abitype'
+
+import type { PublicClient } from '../../clients/createPublicClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
 import type {
-  Address,
-  Chain,
-  Filter,
-  Log,
   MaybeAbiEventName,
   MaybeExtractEventArgsFromAbi,
-} from '../../types/index.js'
+} from '../../types/contract.js'
+import type { Filter } from '../../types/filter.js'
+import type { Log } from '../../types/log.js'
 import { observe } from '../../utils/observe.js'
 import { poll } from '../../utils/poll.js'
-import { createEventFilter } from './createEventFilter.js'
-import type { CreateEventFilterParameters } from './createEventFilter.js'
+import { stringify } from '../../utils/stringify.js'
+
+import {
+  type CreateEventFilterParameters,
+  createEventFilter,
+} from './createEventFilter.js'
 import { getBlockNumber } from './getBlockNumber.js'
 import { getFilterChanges } from './getFilterChanges.js'
 import { getLogs } from './getLogs.js'
@@ -19,15 +24,18 @@ import { uninstallFilter } from './uninstallFilter.js'
 
 export type OnLogsParameter<
   TAbiEvent extends AbiEvent | undefined = undefined,
+  TStrict extends boolean | undefined = undefined,
   TEventName extends string | undefined = MaybeAbiEventName<TAbiEvent>,
-> = Log<bigint, number, TAbiEvent, [TAbiEvent], TEventName>[]
+> = Log<bigint, number, TAbiEvent, TStrict, [TAbiEvent], TEventName>[]
 export type OnLogsFn<
   TAbiEvent extends AbiEvent | undefined = undefined,
+  TStrict extends boolean | undefined = undefined,
   TEventName extends string | undefined = MaybeAbiEventName<TAbiEvent>,
-> = (logs: OnLogsParameter<TAbiEvent, TEventName>) => void
+> = (logs: OnLogsParameter<TAbiEvent, TStrict, TEventName>) => void
 
 export type WatchEventParameters<
   TAbiEvent extends AbiEvent | undefined = undefined,
+  TStrict extends boolean | undefined = undefined,
   TEventName extends string | undefined = MaybeAbiEventName<TAbiEvent>,
 > = {
   /** The address of the contract. */
@@ -40,24 +48,30 @@ export type WatchEventParameters<
   /** The callback to call when an error occurred when trying to get for a new block. */
   onError?: (error: Error) => void
   /** The callback to call when new event logs are received. */
-  onLogs: OnLogsFn<TAbiEvent, TEventName>
+  onLogs: OnLogsFn<TAbiEvent, TStrict, TEventName>
   /** Polling frequency (in ms). Defaults to Client's pollingInterval config. */
   pollingInterval?: number
 } & (
   | {
       event: TAbiEvent
       args?: MaybeExtractEventArgsFromAbi<[TAbiEvent], TEventName>
+      /**
+       * Whether or not the logs must match the indexed/non-indexed arguments on `event`.
+       * @default false
+       */
+      strict?: TStrict
     }
   | {
       event?: never
       args?: never
+      strict?: never
     }
 )
 
 export type WatchEventReturnType = () => void
 
 /**
- * Watches and returns emitted [Event Logs](https://viem.sh/docs/glossary/terms#event-log).
+ * Watches and returns emitted [Event Logs](https://viem.sh/docs/glossary/terms.html#event-log).
  *
  * - Docs: https://viem.sh/docs/actions/public/watchEvent.html
  * - JSON-RPC Methods:
@@ -69,7 +83,7 @@ export type WatchEventReturnType = () => void
  *
  * This Action will batch up all the Event Logs found within the [`pollingInterval`](https://viem.sh/docs/actions/public/watchEvent.html#pollinginterval-optional), and invoke them via [`onLogs`](https://viem.sh/docs/actions/public/watchEvent.html#onLogs).
  *
- * `watchEvent` will attempt to create an [Event Filter](https://viem.sh/docs/actions/public/createEventFilter.html) and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. `eth_newFilter`), then `watchEvent` will fall back to using [`getLogs`](https://viem.sh/docs/actions/public/getLogs) instead.
+ * `watchEvent` will attempt to create an [Event Filter](https://viem.sh/docs/actions/public/createEventFilter.html) and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. `eth_newFilter`), then `watchEvent` will fall back to using [`getLogs`](https://viem.sh/docs/actions/public/getLogs.html) instead.
  *
  * @param client - Client to use
  * @param parameters - {@link WatchEventParameters}
@@ -92,6 +106,7 @@ export function watchEvent<
   TChain extends Chain | undefined,
   TAbiEvent extends AbiEvent | undefined,
   TEventName extends string | undefined,
+  TStrict extends boolean | undefined = undefined,
 >(
   client: PublicClient<Transport, TChain>,
   {
@@ -102,9 +117,10 @@ export function watchEvent<
     onError,
     onLogs,
     pollingInterval = client.pollingInterval,
-  }: WatchEventParameters<TAbiEvent>,
+    strict: strict_,
+  }: WatchEventParameters<TAbiEvent, TStrict>,
 ): WatchEventReturnType {
-  const observerId = JSON.stringify([
+  const observerId = stringify([
     'watchEvent',
     address,
     args,
@@ -113,6 +129,7 @@ export function watchEvent<
     event,
     pollingInterval,
   ])
+  const strict = strict_ ?? false
 
   return observe(observerId, { onLogs, onError }, (emit) => {
     let previousBlockNumber: bigint
@@ -127,6 +144,7 @@ export function watchEvent<
               address,
               args,
               event: event!,
+              strict,
             } as unknown as CreateEventFilterParameters)) as unknown as Filter<
               'event',
               [TAbiEvent],

package/src/actions/public/watchPendingTransactions.ts

@@ -1,12 +1,13 @@
-import type { PublicClient, Transport } from '../../clients/index.js'
-import type {
-  Chain,
-  Filter,
-  GetTransportConfig,
-  Hash,
-} from '../../types/index.js'
+import type { PublicClient } from '../../clients/createPublicClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
+import type { Filter } from '../../types/filter.js'
+import type { Hash } from '../../types/misc.js'
+import type { GetTransportConfig } from '../../types/transport.js'
 import { observe } from '../../utils/observe.js'
 import { poll } from '../../utils/poll.js'
+import { stringify } from '../../utils/stringify.js'
+
 import { createPendingTransactionFilter } from './createPendingTransactionFilter.js'
 import { getFilterChanges } from './getFilterChanges.js'
 import { uninstallFilter } from './uninstallFilter.js'
@@ -104,7 +105,7 @@ export function watchPendingTransactions<
     typeof poll_ !== 'undefined' ? poll_ : client.transport.type !== 'webSocket'
 
   const pollPendingTransactions = () => {
-    const observerId = JSON.stringify([
+    const observerId = stringify([
       'watchPendingTransactions',
       client.uid,
       batch,

package/src/actions/test/dropTransaction.ts

@@ -1,9 +1,10 @@
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Chain, Hash } from '../../types/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
+import type { Hash } from '../../types/misc.js'
 
 export type DropTransactionParameters = {
   /** The hash of the transaction to drop. */

package/src/actions/test/getAutomine.ts

@@ -1,9 +1,9 @@
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Chain } from '../../types/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
 
 export type GetAutomineReturnType = boolean
 
@@ -30,6 +30,10 @@ export type GetAutomineReturnType = boolean
 export async function getAutomine<TChain extends Chain | undefined>(
   client: TestClient<TestClientMode, Transport, TChain>,
 ): Promise<GetAutomineReturnType> {
+  if (client.mode === 'ganache')
+    return await client.request({
+      method: 'eth_mining',
+    })
   return await client.request({
     method: `${client.mode}_getAutomine`,
   })

package/src/actions/test/getTxpoolContent.ts

@@ -1,10 +1,12 @@
 import type { Address } from 'abitype'
+
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Chain, RpcTransaction } from '../../types/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
+import type { RpcTransaction } from '../../types/rpc.js'
 
 export type GetTxpoolContentReturnType = {
   /** Pending transactions in the pool */

package/src/actions/test/getTxpoolStatus.ts

@@ -1,10 +1,10 @@
-import type { Chain } from '@wagmi/chains'
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import { hexToNumber } from '../../utils/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
+import { hexToNumber } from '../../utils/encoding/fromHex.js'
 
 export type GetTxpoolStatusReturnType = {
   pending: number

package/src/actions/test/impersonateAccount.ts

@@ -1,9 +1,11 @@
+import type { Address } from 'abitype'
+
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Address, Chain } from '../../types/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
 
 export type ImpersonateAccountParameters = {
   /** The account to impersonate. */

package/src/actions/test/increaseTime.ts

@@ -1,10 +1,10 @@
-import type { Chain } from '@wagmi/chains'
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import { numberToHex } from '../../utils/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
+import { numberToHex } from '../../utils/encoding/toHex.js'
 
 export type IncreaseTimeParameters = {
   /** The amount of seconds to jump forward in time. */

package/src/actions/test/inspectTxpool.ts

@@ -1,9 +1,11 @@
+import type { Address } from 'abitype'
+
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Address, Chain } from '../../types/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
 
 export type InspectTxpoolReturnType = {
   pending: Record<Address, Record<string, string>>

package/src/actions/test/mine.ts

@@ -1,10 +1,10 @@
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Chain } from '../../types/index.js'
-import { numberToHex } from '../../utils/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
+import { numberToHex } from '../../utils/encoding/toHex.js'
 
 export type MineParameters = {
   /** Number of blocks to mine. */
@@ -37,8 +37,14 @@ export async function mine<TChain extends Chain | undefined>(
   client: TestClient<TestClientMode, Transport, TChain>,
   { blocks, interval }: MineParameters,
 ) {
-  await client.request({
-    method: `${client.mode}_mine`,
-    params: [numberToHex(blocks), numberToHex(interval || 0)],
-  })
+  if (client.mode === 'ganache')
+    await client.request({
+      method: 'evm_mine',
+      params: [{ blocks: numberToHex(blocks) }],
+    })
+  else
+    await client.request({
+      method: `${client.mode}_mine`,
+      params: [numberToHex(blocks), numberToHex(interval || 0)],
+    })
 }

package/src/actions/test/removeBlockTimestampInterval.ts

@@ -1,9 +1,9 @@
-import type { Chain } from '@wagmi/chains'
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
 
 /**
  * Removes [`setBlockTimestampInterval`](https://viem.sh/docs/actions/test/setBlockTimestampInterval.html) if it exists.

package/src/actions/test/reset.ts

@@ -1,9 +1,9 @@
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Chain } from '../../types/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
 
 export type ResetParameters = {
   /** The block number to reset from. */

package/src/actions/test/revert.ts

@@ -1,9 +1,10 @@
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Chain, Quantity } from '../../types/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
+import type { Quantity } from '../../types/rpc.js'
 
 export type RevertParameters = {
   /** The snapshot ID to revert to. */

package/src/actions/test/sendUnsignedTransaction.ts

@@ -1,10 +1,12 @@
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Chain, Hash, TransactionRequest } from '../../types/index.js'
-import { formatTransactionRequest } from '../../utils/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
+import type { Hash } from '../../types/misc.js'
+import type { TransactionRequest } from '../../types/transaction.js'
+import { formatTransactionRequest } from '../../utils/formatters/transactionRequest.js'
 
 export type SendUnsignedTransactionParameters = TransactionRequest
 

package/src/actions/test/setAutomine.ts

@@ -1,9 +1,9 @@
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Chain } from '../../types/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
 
 /**
  * Enables or disables the automatic mining of new blocks with each new transaction submitted to the network.
@@ -28,8 +28,12 @@ export async function setAutomine<TChain extends Chain | undefined>(
   client: TestClient<TestClientMode, Transport, TChain>,
   enabled: boolean,
 ) {
-  await client.request({
-    method: 'evm_setAutomine',
-    params: [enabled],
-  })
+  if (client.mode === 'ganache') {
+    if (enabled) await client.request({ method: 'miner_start' })
+    else await client.request({ method: 'miner_stop' })
+  } else
+    await client.request({
+      method: 'evm_setAutomine',
+      params: [enabled],
+    })
 }

package/src/actions/test/setBalance.ts

@@ -1,10 +1,12 @@
+import type { Address } from 'abitype'
+
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Address, Chain } from '../../types/index.js'
-import { numberToHex } from '../../utils/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
+import { numberToHex } from '../../utils/encoding/toHex.js'
 
 export type SetBalanceParameters = {
   /** The account address. */
@@ -40,8 +42,14 @@ export async function setBalance<TChain extends Chain | undefined>(
   client: TestClient<TestClientMode, Transport, TChain>,
   { address, value }: SetBalanceParameters,
 ) {
-  await client.request({
-    method: `${client.mode}_setBalance`,
-    params: [address, numberToHex(value)],
-  })
+  if (client.mode === 'ganache')
+    await client.request({
+      method: 'evm_setAccountBalance',
+      params: [address, numberToHex(value)],
+    })
+  else
+    await client.request({
+      method: `${client.mode}_setBalance`,
+      params: [address, numberToHex(value)],
+    })
 }

package/src/actions/test/setBlockGasLimit.ts

@@ -1,10 +1,10 @@
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Chain } from '../../types/index.js'
-import { numberToHex } from '../../utils/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
+import { numberToHex } from '../../utils/encoding/toHex.js'
 
 export type SetBlockGasLimitParameters = {
   /** Gas limit (in wei). */

package/src/actions/test/setBlockTimestampInterval.ts

@@ -1,9 +1,9 @@
-import type { Chain } from '@wagmi/chains'
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
 
 export type SetBlockTimestampIntervalParameters = {
   /** The interval (in seconds). */
@@ -11,7 +11,7 @@ export type SetBlockTimestampIntervalParameters = {
 }
 
 /**
- * Similar to [`increaseTime`](https://viem.sh/docs/actions/test/increaseTime), but sets a block timestamp `interval`. The timestamp of future blocks will be computed as `lastBlock_timestamp` + `interval`.
+ * Similar to [`increaseTime`](https://viem.sh/docs/actions/test/increaseTime.html), but sets a block timestamp `interval`. The timestamp of future blocks will be computed as `lastBlock_timestamp` + `interval`.
  *
  * - Docs: https://viem.sh/docs/actions/test/setBlockTimestampInterval.html
  *

package/src/actions/test/setCode.ts

@@ -1,9 +1,12 @@
+import type { Address } from 'abitype'
+
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Address, Chain, Hex } from '../../types/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
+import type { Hex } from '../../types/misc.js'
 
 export type SetCodeParameters = {
   /** The account address. */

package/src/actions/test/setCoinbase.ts

@@ -1,9 +1,11 @@
+import type { Address } from 'abitype'
+
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Address, Chain } from '../../types/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
 
 export type SetCoinbaseParameters = {
   /** The coinbase address. */

package/src/actions/test/setIntervalMining.ts

@@ -1,9 +1,9 @@
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Chain } from '../../types/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
 
 export type SetIntervalMiningParameters = {
   /** The mining interval. */

package/src/actions/test/setLoggingEnabled.ts

@@ -1,9 +1,9 @@
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Chain } from '../../types/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
 
 /**
  * Enable or disable logging on the test node network.

package/src/actions/test/setMinGasPrice.ts

@@ -1,10 +1,10 @@
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Chain } from '../../types/index.js'
-import { numberToHex } from '../../utils/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
+import { numberToHex } from '../../utils/encoding/toHex.js'
 
 export type SetMinGasPriceParameters = {
   /** The gas price. */

package/src/actions/test/setNextBlockBaseFeePerGas.ts

@@ -1,10 +1,10 @@
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Chain } from '../../types/index.js'
-import { numberToHex } from '../../utils/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
+import { numberToHex } from '../../utils/encoding/toHex.js'
 
 export type SetNextBlockBaseFeePerGasParameters = {
   /** Base fee per gas (in wei). */

package/src/actions/test/setNextBlockTimestamp.ts

@@ -1,10 +1,10 @@
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Chain } from '../../types/index.js'
-import { numberToHex } from '../../utils/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
+import { numberToHex } from '../../utils/encoding/toHex.js'
 
 export type SetNextBlockTimestampParameters = {
   /** The timestamp (in seconds). */

package/src/actions/test/setNonce.ts

@@ -1,10 +1,12 @@
+import type { Address } from 'abitype'
+
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Address, Chain } from '../../types/index.js'
-import { numberToHex } from '../../utils/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
+import { numberToHex } from '../../utils/encoding/toHex.js'
 
 export type SetNonceParameters = {
   /** The account address. */

package/src/actions/test/setRpcUrl.ts

@@ -1,9 +1,9 @@
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Chain } from '../../types/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
 
 /**
  * Sets the backend RPC URL.

package/src/actions/test/setStorageAt.ts

@@ -1,10 +1,13 @@
+import type { Address } from 'abitype'
+
 import type {
   TestClient,
   TestClientMode,
-  Transport,
-} from '../../clients/index.js'
-import type { Address, Chain, Hash, Hex } from '../../types/index.js'
-import { numberToHex } from '../../utils/index.js'
+} from '../../clients/createTestClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
+import type { Hash, Hex } from '../../types/misc.js'
+import { numberToHex } from '../../utils/encoding/toHex.js'
 
 export type SetStorageAtParameters = {
   /** The account address. */