viem 1.0.2 → 1.0.3

package/dist/esm/actions/public/watchContractEvent.js

@@ -7,6 +7,36 @@ import { getBlockNumber } from './getBlockNumber.js';
 import { getFilterChanges } from './getFilterChanges.js';
 import { getLogs } from './getLogs.js';
 import { uninstallFilter } from './uninstallFilter.js';
+/**
+ * Watches and returns emitted contract event logs.
+ *
+ * - Docs: https://viem.sh/docs/contract/watchContractEvent.html
+ *
+ * This Action will batch up all the event logs found within the [`pollingInterval`](https://viem.sh/docs/contract/watchContractEvent.html#pollinginterval-optional), and invoke them via [`onLogs`](https://viem.sh/docs/contract/watchContractEvent.html#onLogs).
+ *
+ * `watchContractEvent` will attempt to create an [Event Filter](https://viem.sh/docs/contract/createContractEventFilter.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 `watchContractEvent` will fall back to using [`getLogs`](https://viem.sh/docs/actions/public/getLogs) instead.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link WatchContractEventParameters}
+ * @returns A function that can be invoked to stop watching for new event logs. {@link WatchContractEventReturnType}
+ *
+ * @example
+ * import { createPublicClient, http, parseAbi } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { watchContractEvent } from 'viem/contract'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const unwatch = watchContractEvent(client, {
+ *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+ *   abi: parseAbi(['event Transfer(address indexed from, address indexed to, uint256 value)']),
+ *   eventName: 'Transfer',
+ *   args: { from: '0xc961145a54C96E3aE9bAA048c4F4D6b04C13916b' },
+ *   onLogs: (logs) => console.log(logs),
+ * })
+ */
 export function watchContractEvent(client, { abi, address, args, batch = true, eventName, onError, onLogs, pollingInterval = client.pollingInterval, strict: strict_, }) {
     const observerId = stringify([
         'watchContractEvent',
@@ -43,7 +73,13 @@ export function watchContractEvent(client, { abi, address, args, batch = true, e
                     logs = await getFilterChanges(client, { 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 getBlockNumber(client);
+                    // 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,
+                    // so do not emit any logs.
                     if (previousBlockNumber && previousBlockNumber !== blockNumber) {
                         logs = await getLogs(client, {
                             address,

package/dist/esm/actions/public/watchContractEvent.js.map

@@ -1 +1 @@
-{"version":3,"file":"watchContractEvent.js","sourceRoot":"","sources":["../../../../src/actions/public/watchContractEvent.ts"],"names":[],"mappings":"AAQA,OAAO,EAEL,UAAU,GACX,MAAM,+BAA+B,CAAA;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAChD,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAA;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAEpD,OAAO,EAEL,yBAAyB,GAC1B,MAAM,gCAAgC,CAAA;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAA0B,OAAO,EAAE,MAAM,cAAc,CAAA;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AA0EtD,MAAM,UAAU,kBAAkB,CAMhC,MAAuC,EACvC,EACE,GAAG,EACH,OAAO,EACP,IAAI,EACJ,KAAK,GAAG,IAAI,EACZ,SAAS,EACT,OAAO,EACP,MAAM,EACN,eAAe,GAAG,MAAM,CAAC,eAAe,EACxC,MAAM,EAAE,OAAO,GACyC;IAE1D,MAAM,UAAU,GAAG,SAAS,CAAC;QAC3B,oBAAoB;QACpB,OAAO;QACP,IAAI;QACJ,KAAK;QACL,MAAM,CAAC,GAAG;QACV,SAAS;QACT,eAAe;KAChB,CAAC,CAAA;IACF,MAAM,MAAM,GAAG,OAAO,IAAI,KAAK,CAAA;IAE/B,OAAO,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;QACvD,IAAI,mBAA2B,CAAA;QAC/B,IAAI,MAAqD,CAAA;QACzD,IAAI,WAAW,GAAG,KAAK,CAAA;QAEvB,MAAM,OAAO,GAAG,IAAI,CAClB,KAAK,IAAI,EAAE;YACT,IAAI,CAAC,WAAW,EAAE;gBAChB,IAAI;oBACF,MAAM,GAAG,CAAC,MAAM,yBAAyB,CAAC,MAAM,EAAE;wBAChD,GAAG;wBACH,OAAO;wBACP,IAAI;wBACJ,SAAS;wBACT,MAAM;qBAC2C,CAAC,CAInD,CAAA;iBACF;gBAAC,MAAM,GAAE;gBACV,WAAW,GAAG,IAAI,CAAA;gBAClB,OAAM;aACP;YAED,IAAI;gBACF,IAAI,IAAW,CAAA;gBACf,IAAI,MAAM,EAAE;oBACV,IAAI,GAAG,MAAM,gBAAgB,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;iBAClD;qBAAM;oBAKL,MAAM,WAAW,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAA;oBAKhD,IAAI,mBAAmB,IAAI,mBAAmB,KAAK,WAAW,EAAE;wBAC9D,IAAI,GAAG,MAAM,OAAO,CAAC,MAAM,EAAE;4BAC3B,OAAO;4BACP,IAAI;4BACJ,SAAS,EAAE,mBAAmB,GAAG,EAAE;4BACnC,OAAO,EAAE,WAAW;4BACpB,KAAK,EAAE,UAAU,CAAC;gCAChB,GAAG;gCACH,IAAI,EAAE,SAAS;6BACmB,CAAC;yBACN,CAAC,CAAA;qBACnC;yBAAM;wBACL,IAAI,GAAG,EAAE,CAAA;qBACV;oBACD,mBAAmB,GAAG,WAAW,CAAA;iBAClC;gBAED,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;oBAAE,OAAM;gBAC7B,IAAI,KAAK;oBAAE,IAAI,CAAC,MAAM,CAAC,IAAW,CAAC,CAAA;;oBAC9B,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAQ,CAAC,CAAC,CAAA;aACtD;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAI,CAAC,OAAO,EAAE,CAAC,GAAY,CAAC,CAAA;aAC7B;QACH,CAAC,EACD;YACE,WAAW,EAAE,IAAI;YACjB,QAAQ,EAAE,eAAe;SAC1B,CACF,CAAA;QAED,OAAO,KAAK,IAAI,EAAE;YAChB,IAAI,MAAM;gBAAE,MAAM,eAAe,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;YACrD,OAAO,EAAE,CAAA;QACX,CAAC,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"watchContractEvent.js","sourceRoot":"","sources":["../../../../src/actions/public/watchContractEvent.ts"],"names":[],"mappings":"AAQA,OAAO,EAEL,UAAU,GACX,MAAM,+BAA+B,CAAA;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAChD,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAA;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAEpD,OAAO,EAEL,yBAAyB,GAC1B,MAAM,gCAAgC,CAAA;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAA0B,OAAO,EAAE,MAAM,cAAc,CAAA;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AA4CtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,UAAU,kBAAkB,CAMhC,MAAuC,EACvC,EACE,GAAG,EACH,OAAO,EACP,IAAI,EACJ,KAAK,GAAG,IAAI,EACZ,SAAS,EACT,OAAO,EACP,MAAM,EACN,eAAe,GAAG,MAAM,CAAC,eAAe,EACxC,MAAM,EAAE,OAAO,GACyC;IAE1D,MAAM,UAAU,GAAG,SAAS,CAAC;QAC3B,oBAAoB;QACpB,OAAO;QACP,IAAI;QACJ,KAAK;QACL,MAAM,CAAC,GAAG;QACV,SAAS;QACT,eAAe;KAChB,CAAC,CAAA;IACF,MAAM,MAAM,GAAG,OAAO,IAAI,KAAK,CAAA;IAE/B,OAAO,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;QACvD,IAAI,mBAA2B,CAAA;QAC/B,IAAI,MAAqD,CAAA;QACzD,IAAI,WAAW,GAAG,KAAK,CAAA;QAEvB,MAAM,OAAO,GAAG,IAAI,CAClB,KAAK,IAAI,EAAE;YACT,IAAI,CAAC,WAAW,EAAE;gBAChB,IAAI;oBACF,MAAM,GAAG,CAAC,MAAM,yBAAyB,CAAC,MAAM,EAAE;wBAChD,GAAG;wBACH,OAAO;wBACP,IAAI;wBACJ,SAAS;wBACT,MAAM;qBAC2C,CAAC,CAInD,CAAA;iBACF;gBAAC,MAAM,GAAE;gBACV,WAAW,GAAG,IAAI,CAAA;gBAClB,OAAM;aACP;YAED,IAAI;gBACF,IAAI,IAAW,CAAA;gBACf,IAAI,MAAM,EAAE;oBACV,IAAI,GAAG,MAAM,gBAAgB,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;iBAClD;qBAAM;oBACL,mEAAmE;oBACnE,0EAA0E;oBAE1E,+CAA+C;oBAC/C,MAAM,WAAW,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAA;oBAEhD,mEAAmE;oBACnE,kFAAkF;oBAClF,2BAA2B;oBAC3B,IAAI,mBAAmB,IAAI,mBAAmB,KAAK,WAAW,EAAE;wBAC9D,IAAI,GAAG,MAAM,OAAO,CAAC,MAAM,EAAE;4BAC3B,OAAO;4BACP,IAAI;4BACJ,SAAS,EAAE,mBAAmB,GAAG,EAAE;4BACnC,OAAO,EAAE,WAAW;4BACpB,KAAK,EAAE,UAAU,CAAC;gCAChB,GAAG;gCACH,IAAI,EAAE,SAAS;6BACmB,CAAC;yBACN,CAAC,CAAA;qBACnC;yBAAM;wBACL,IAAI,GAAG,EAAE,CAAA;qBACV;oBACD,mBAAmB,GAAG,WAAW,CAAA;iBAClC;gBAED,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;oBAAE,OAAM;gBAC7B,IAAI,KAAK;oBAAE,IAAI,CAAC,MAAM,CAAC,IAAW,CAAC,CAAA;;oBAC9B,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAQ,CAAC,CAAC,CAAA;aACtD;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAI,CAAC,OAAO,EAAE,CAAC,GAAY,CAAC,CAAA;aAC7B;QACH,CAAC,EACD;YACE,WAAW,EAAE,IAAI;YACjB,QAAQ,EAAE,eAAe;SAC1B,CACF,CAAA;QAED,OAAO,KAAK,IAAI,EAAE;YAChB,IAAI,MAAM;gBAAE,MAAM,eAAe,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;YACrD,OAAO,EAAE,CAAA;QACX,CAAC,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/dist/esm/actions/public/watchEvent.js

@@ -6,6 +6,38 @@ import { getBlockNumber } from './getBlockNumber.js';
 import { getFilterChanges } from './getFilterChanges.js';
 import { getLogs } from './getLogs.js';
 import { uninstallFilter } from './uninstallFilter.js';
+/**
+ * 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:
+ *   - **RPC Provider supports `eth_newFilter`:**
+ *     - Calls [`eth_newFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newfilter) to create a filter (called on initialize).
+ *     - On a polling interval, it will call [`eth_getFilterChanges`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterchanges).
+ *   - **RPC Provider does not support `eth_newFilter`:**
+ *     - Calls [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs) for each block between the polling interval.
+ *
+ * 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.html) instead.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link WatchEventParameters}
+ * @returns A function that can be invoked to stop watching for new Event Logs. {@link WatchEventReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { watchEvent } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const unwatch = watchEvent(client, {
+ *   onLogs: (logs) => console.log(logs),
+ * })
+ */
 export function watchEvent(client, { address, args, batch = true, event, onError, onLogs, pollingInterval = client.pollingInterval, strict: strict_, }) {
     const observerId = stringify([
         'watchEvent',
@@ -41,7 +73,13 @@ export function watchEvent(client, { address, args, batch = true, event, onError
                     logs = await getFilterChanges(client, { 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 getBlockNumber(client);
+                    // 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,
+                    // so do not emit any logs.
                     if (previousBlockNumber && previousBlockNumber !== blockNumber) {
                         logs = await getLogs(client, {
                             address,

package/dist/esm/actions/public/watchEvent.js.map

@@ -1 +1 @@
-{"version":3,"file":"watchEvent.js","sourceRoot":"","sources":["../../../../src/actions/public/watchEvent.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAChD,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAA;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAEpD,OAAO,EAEL,iBAAiB,GAClB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAkFtD,MAAM,UAAU,UAAU,CAMxB,MAAuC,EACvC,EACE,OAAO,EACP,IAAI,EACJ,KAAK,GAAG,IAAI,EACZ,KAAK,EACL,OAAO,EACP,MAAM,EACN,eAAe,GAAG,MAAM,CAAC,eAAe,EACxC,MAAM,EAAE,OAAO,GAC0B;IAE3C,MAAM,UAAU,GAAG,SAAS,CAAC;QAC3B,YAAY;QACZ,OAAO;QACP,IAAI;QACJ,KAAK;QACL,MAAM,CAAC,GAAG;QACV,KAAK;QACL,eAAe;KAChB,CAAC,CAAA;IACF,MAAM,MAAM,GAAG,OAAO,IAAI,KAAK,CAAA;IAE/B,OAAO,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;QACvD,IAAI,mBAA2B,CAAA;QAC/B,IAAI,MAAqD,CAAA;QACzD,IAAI,WAAW,GAAG,KAAK,CAAA;QAEvB,MAAM,OAAO,GAAG,IAAI,CAClB,KAAK,IAAI,EAAE;YACT,IAAI,CAAC,WAAW,EAAE;gBAChB,IAAI;oBACF,MAAM,GAAG,CAAC,MAAM,iBAAiB,CAAC,MAAM,EAAE;wBACxC,OAAO;wBACP,IAAI;wBACJ,KAAK,EAAE,KAAM;wBACb,MAAM;qBACmC,CAAC,CAI3C,CAAA;iBACF;gBAAC,MAAM,GAAE;gBACV,WAAW,GAAG,IAAI,CAAA;gBAClB,OAAM;aACP;YAED,IAAI;gBACF,IAAI,IAAW,CAAA;gBACf,IAAI,MAAM,EAAE;oBACV,IAAI,GAAG,MAAM,gBAAgB,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;iBAClD;qBAAM;oBAKL,MAAM,WAAW,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAA;oBAKhD,IAAI,mBAAmB,IAAI,mBAAmB,KAAK,WAAW,EAAE;wBAC9D,IAAI,GAAG,MAAM,OAAO,CAAC,MAAM,EAAE;4BAC3B,OAAO;4BACP,IAAI;4BACJ,SAAS,EAAE,mBAAmB,GAAG,EAAE;4BACnC,OAAO,EAAE,WAAW;4BACpB,KAAK,EAAE,KAAM;yBACd,CAAC,CAAA;qBACH;yBAAM;wBACL,IAAI,GAAG,EAAE,CAAA;qBACV;oBACD,mBAAmB,GAAG,WAAW,CAAA;iBAClC;gBAED,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;oBAAE,OAAM;gBAC7B,IAAI,KAAK;oBAAE,IAAI,CAAC,MAAM,CAAC,IAAW,CAAC,CAAA;;oBAC9B,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAQ,CAAC,CAAC,CAAA;aACtD;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAI,CAAC,OAAO,EAAE,CAAC,GAAY,CAAC,CAAA;aAC7B;QACH,CAAC,EACD;YACE,WAAW,EAAE,IAAI;YACjB,QAAQ,EAAE,eAAe;SAC1B,CACF,CAAA;QAED,OAAO,KAAK,IAAI,EAAE;YAChB,IAAI,MAAM;gBAAE,MAAM,eAAe,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;YACrD,OAAO,EAAE,CAAA;QACX,CAAC,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"watchEvent.js","sourceRoot":"","sources":["../../../../src/actions/public/watchEvent.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAChD,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAA;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAEpD,OAAO,EAEL,iBAAiB,GAClB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAkDtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,UAAU,UAAU,CAMxB,MAAuC,EACvC,EACE,OAAO,EACP,IAAI,EACJ,KAAK,GAAG,IAAI,EACZ,KAAK,EACL,OAAO,EACP,MAAM,EACN,eAAe,GAAG,MAAM,CAAC,eAAe,EACxC,MAAM,EAAE,OAAO,GAC0B;IAE3C,MAAM,UAAU,GAAG,SAAS,CAAC;QAC3B,YAAY;QACZ,OAAO;QACP,IAAI;QACJ,KAAK;QACL,MAAM,CAAC,GAAG;QACV,KAAK;QACL,eAAe;KAChB,CAAC,CAAA;IACF,MAAM,MAAM,GAAG,OAAO,IAAI,KAAK,CAAA;IAE/B,OAAO,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;QACvD,IAAI,mBAA2B,CAAA;QAC/B,IAAI,MAAqD,CAAA;QACzD,IAAI,WAAW,GAAG,KAAK,CAAA;QAEvB,MAAM,OAAO,GAAG,IAAI,CAClB,KAAK,IAAI,EAAE;YACT,IAAI,CAAC,WAAW,EAAE;gBAChB,IAAI;oBACF,MAAM,GAAG,CAAC,MAAM,iBAAiB,CAAC,MAAM,EAAE;wBACxC,OAAO;wBACP,IAAI;wBACJ,KAAK,EAAE,KAAM;wBACb,MAAM;qBACmC,CAAC,CAI3C,CAAA;iBACF;gBAAC,MAAM,GAAE;gBACV,WAAW,GAAG,IAAI,CAAA;gBAClB,OAAM;aACP;YAED,IAAI;gBACF,IAAI,IAAW,CAAA;gBACf,IAAI,MAAM,EAAE;oBACV,IAAI,GAAG,MAAM,gBAAgB,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;iBAClD;qBAAM;oBACL,mEAAmE;oBACnE,0EAA0E;oBAE1E,+CAA+C;oBAC/C,MAAM,WAAW,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAA;oBAEhD,mEAAmE;oBACnE,kFAAkF;oBAClF,2BAA2B;oBAC3B,IAAI,mBAAmB,IAAI,mBAAmB,KAAK,WAAW,EAAE;wBAC9D,IAAI,GAAG,MAAM,OAAO,CAAC,MAAM,EAAE;4BAC3B,OAAO;4BACP,IAAI;4BACJ,SAAS,EAAE,mBAAmB,GAAG,EAAE;4BACnC,OAAO,EAAE,WAAW;4BACpB,KAAK,EAAE,KAAM;yBACd,CAAC,CAAA;qBACH;yBAAM;wBACL,IAAI,GAAG,EAAE,CAAA;qBACV;oBACD,mBAAmB,GAAG,WAAW,CAAA;iBAClC;gBAED,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;oBAAE,OAAM;gBAC7B,IAAI,KAAK;oBAAE,IAAI,CAAC,MAAM,CAAC,IAAW,CAAC,CAAA;;oBAC9B,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAQ,CAAC,CAAC,CAAA;aACtD;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAI,CAAC,OAAO,EAAE,CAAC,GAAY,CAAC,CAAA;aAC7B;QACH,CAAC,EACD;YACE,WAAW,EAAE,IAAI;YACjB,QAAQ,EAAE,eAAe;SAC1B,CACF,CAAA;QAED,OAAO,KAAK,IAAI,EAAE;YAChB,IAAI,MAAM;gBAAE,MAAM,eAAe,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;YACrD,OAAO,EAAE,CAAA;QACX,CAAC,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/dist/esm/actions/public/watchPendingTransactions.js

@@ -4,6 +4,35 @@ import { stringify } from '../../utils/stringify.js';
 import { createPendingTransactionFilter } from './createPendingTransactionFilter.js';
 import { getFilterChanges } from './getFilterChanges.js';
 import { uninstallFilter } from './uninstallFilter.js';
+/**
+ * Watches and returns pending transaction hashes.
+ *
+ * - Docs: https://viem.sh/docs/actions/public/watchPendingTransactions.html
+ * - JSON-RPC Methods:
+ *   - When `poll: true`
+ *     - Calls [`eth_newPendingTransactionFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newpendingtransactionfilter) to initialize the filter.
+ *     - Calls [`eth_getFilterChanges`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getFilterChanges) 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 `"newPendingTransactions"` event.
+ *
+ * This Action will batch up all the pending transactions found within the [`pollingInterval`](https://viem.sh/docs/actions/public/watchPendingTransactions.html#pollinginterval-optional), and invoke them via [`onTransactions`](https://viem.sh/docs/actions/public/watchPendingTransactions.html#ontransactions).
+ *
+ * @param client - Client to use
+ * @param parameters - {@link WatchPendingTransactionsParameters}
+ * @returns A function that can be invoked to stop watching for new pending transaction hashes. {@link WatchPendingTransactionsReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { watchPendingTransactions } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const unwatch = await watchPendingTransactions(client, {
+ *   onTransactions: (hashes) => console.log(hashes),
+ * })
+ */
 export function watchPendingTransactions(client, { batch = true, onError, onTransactions, poll: poll_, pollingInterval = client.pollingInterval, }) {
     const enablePolling = typeof poll_ !== 'undefined' ? poll_ : client.transport.type !== 'webSocket';
     const pollPendingTransactions = () => {

package/dist/esm/actions/public/watchPendingTransactions.js.map

@@ -1 +1 @@
-{"version":3,"file":"watchPendingTransactions.js","sourceRoot":"","sources":["../../../../src/actions/public/watchPendingTransactions.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAChD,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAA;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAEpD,OAAO,EAAE,8BAA8B,EAAE,MAAM,qCAAqC,CAAA;AACpF,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AA8EtD,MAAM,UAAU,wBAAwB,CAItC,MAAwC,EACxC,EACE,KAAK,GAAG,IAAI,EACZ,OAAO,EACP,cAAc,EACd,IAAI,EAAE,KAAK,EACX,eAAe,GAAG,MAAM,CAAC,eAAe,GACO;IAEjD,MAAM,aAAa,GACjB,OAAO,KAAK,KAAK,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,KAAK,WAAW,CAAA;IAE9E,MAAM,uBAAuB,GAAG,GAAG,EAAE;QACnC,MAAM,UAAU,GAAG,SAAS,CAAC;YAC3B,0BAA0B;YAC1B,MAAM,CAAC,GAAG;YACV,KAAK;YACL,eAAe;SAChB,CAAC,CAAA;QACF,OAAO,OAAO,CAAC,UAAU,EAAE,EAAE,cAAc,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;YAC/D,IAAI,MAA6B,CAAA;YAEjC,MAAM,OAAO,GAAG,IAAI,CAClB,KAAK,IAAI,EAAE;gBACT,IAAI;oBACF,IAAI,CAAC,MAAM,EAAE;wBACX,IAAI;4BACF,MAAM,GAAG,MAAM,8BAA8B,CAAC,MAAM,CAAC,CAAA;4BACrD,OAAM;yBACP;wBAAC,OAAO,GAAG,EAAE;4BACZ,OAAO,EAAE,CAAA;4BACT,MAAM,GAAG,CAAA;yBACV;qBACF;oBAED,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;oBACzD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;wBAAE,OAAM;oBAC/B,IAAI,KAAK;wBAAE,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAA;;wBACjC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;iBAC3D;gBAAC,OAAO,GAAG,EAAE;oBACZ,IAAI,CAAC,OAAO,EAAE,CAAC,GAAY,CAAC,CAAA;iBAC7B;YACH,CAAC,EACD;gBACE,WAAW,EAAE,IAAI;gBACjB,QAAQ,EAAE,eAAe;aAC1B,CACF,CAAA;YAED,OAAO,KAAK,IAAI,EAAE;gBAChB,IAAI,MAAM;oBAAE,MAAM,eAAe,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;gBACrD,OAAO,EAAE,CAAA;YACX,CAAC,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC,CAAA;IAED,MAAM,4BAA4B,GAAG,GAAG,EAAE;QACxC,IAAI,MAAM,GAAG,IAAI,CAAA;QACjB,IAAI,WAAW,GAAG,GAAG,EAAE,CAAC,CAAC,MAAM,GAAG,KAAK,CAAC,CACvC;QAAA,CAAC,KAAK,IAAI,EAAE;YACX,IAAI;gBACF,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC;oBACrE,MAAM,EAAE,CAAC,wBAAwB,CAAC;oBAClC,MAAM,CAAC,IAAS;wBACd,IAAI,CAAC,MAAM;4BAAE,OAAM;wBACnB,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAA;wBAC/B,cAAc,CAAC,CAAC,WAAW,CAAC,CAAC,CAAA;oBAC/B,CAAC;oBACD,OAAO,CAAC,KAAY;wBAClB,OAAO,EAAE,CAAC,KAAK,CAAC,CAAA;oBAClB,CAAC;iBACF,CAAC,CAAA;gBACF,WAAW,GAAG,YAAY,CAAA;gBAC1B,IAAI,CAAC,MAAM;oBAAE,WAAW,EAAE,CAAA;aAC3B;YAAC,OAAO,GAAG,EAAE;gBACZ,OAAO,EAAE,CAAC,GAAY,CAAC,CAAA;aACxB;QACH,CAAC,CAAC,EAAE,CAAA;QACJ,OAAO,WAAW,CAAA;IACpB,CAAC,CAAA;IAED,OAAO,aAAa;QAClB,CAAC,CAAC,uBAAuB,EAAE;QAC3B,CAAC,CAAC,4BAA4B,EAAE,CAAA;AACpC,CAAC"}
+{"version":3,"file":"watchPendingTransactions.js","sourceRoot":"","sources":["../../../../src/actions/public/watchPendingTransactions.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAChD,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAA;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAEpD,OAAO,EAAE,8BAA8B,EAAE,MAAM,qCAAqC,CAAA;AACpF,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAiDtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,UAAU,wBAAwB,CAItC,MAAwC,EACxC,EACE,KAAK,GAAG,IAAI,EACZ,OAAO,EACP,cAAc,EACd,IAAI,EAAE,KAAK,EACX,eAAe,GAAG,MAAM,CAAC,eAAe,GACO;IAEjD,MAAM,aAAa,GACjB,OAAO,KAAK,KAAK,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,KAAK,WAAW,CAAA;IAE9E,MAAM,uBAAuB,GAAG,GAAG,EAAE;QACnC,MAAM,UAAU,GAAG,SAAS,CAAC;YAC3B,0BAA0B;YAC1B,MAAM,CAAC,GAAG;YACV,KAAK;YACL,eAAe;SAChB,CAAC,CAAA;QACF,OAAO,OAAO,CAAC,UAAU,EAAE,EAAE,cAAc,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;YAC/D,IAAI,MAA6B,CAAA;YAEjC,MAAM,OAAO,GAAG,IAAI,CAClB,KAAK,IAAI,EAAE;gBACT,IAAI;oBACF,IAAI,CAAC,MAAM,EAAE;wBACX,IAAI;4BACF,MAAM,GAAG,MAAM,8BAA8B,CAAC,MAAM,CAAC,CAAA;4BACrD,OAAM;yBACP;wBAAC,OAAO,GAAG,EAAE;4BACZ,OAAO,EAAE,CAAA;4BACT,MAAM,GAAG,CAAA;yBACV;qBACF;oBAED,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;oBACzD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;wBAAE,OAAM;oBAC/B,IAAI,KAAK;wBAAE,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAA;;wBACjC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;iBAC3D;gBAAC,OAAO,GAAG,EAAE;oBACZ,IAAI,CAAC,OAAO,EAAE,CAAC,GAAY,CAAC,CAAA;iBAC7B;YACH,CAAC,EACD;gBACE,WAAW,EAAE,IAAI;gBACjB,QAAQ,EAAE,eAAe;aAC1B,CACF,CAAA;YAED,OAAO,KAAK,IAAI,EAAE;gBAChB,IAAI,MAAM;oBAAE,MAAM,eAAe,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;gBACrD,OAAO,EAAE,CAAA;YACX,CAAC,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC,CAAA;IAED,MAAM,4BAA4B,GAAG,GAAG,EAAE;QACxC,IAAI,MAAM,GAAG,IAAI,CAAA;QACjB,IAAI,WAAW,GAAG,GAAG,EAAE,CAAC,CAAC,MAAM,GAAG,KAAK,CAAC,CACvC;QAAA,CAAC,KAAK,IAAI,EAAE;YACX,IAAI;gBACF,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC;oBACrE,MAAM,EAAE,CAAC,wBAAwB,CAAC;oBAClC,MAAM,CAAC,IAAS;wBACd,IAAI,CAAC,MAAM;4BAAE,OAAM;wBACnB,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAA;wBAC/B,cAAc,CAAC,CAAC,WAAW,CAAC,CAAC,CAAA;oBAC/B,CAAC;oBACD,OAAO,CAAC,KAAY;wBAClB,OAAO,EAAE,CAAC,KAAK,CAAC,CAAA;oBAClB,CAAC;iBACF,CAAC,CAAA;gBACF,WAAW,GAAG,YAAY,CAAA;gBAC1B,IAAI,CAAC,MAAM;oBAAE,WAAW,EAAE,CAAA;aAC3B;YAAC,OAAO,GAAG,EAAE;gBACZ,OAAO,EAAE,CAAC,GAAY,CAAC,CAAA;aACxB;QACH,CAAC,CAAC,EAAE,CAAA;QACJ,OAAO,WAAW,CAAA;IACpB,CAAC,CAAA;IAED,OAAO,aAAa;QAClB,CAAC,CAAC,uBAAuB,EAAE;QAC3B,CAAC,CAAC,4BAA4B,EAAE,CAAA;AACpC,CAAC"}

package/dist/esm/actions/test/dropTransaction.js

@@ -1,3 +1,25 @@
+/**
+ * Removes a transaction from the mempool.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/dropTransaction.html
+ *
+ * @param client - Client to use
+ * @param parameters - {@link DropTransactionParameters}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { dropTransaction } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * await dropTransaction(client, {
+ *   hash: '0xe58dceb6b20b03965bb678e27d141e151d7d4efc2334c2d6a49b9fac523f7364'
+ * })
+ */
 export async function dropTransaction(client, { hash }) {
     await client.request({
         method: `${client.mode}_dropTransaction`,

package/dist/esm/actions/test/dropTransaction.js.map

@@ -1 +1 @@
-{"version":3,"file":"dropTransaction.js","sourceRoot":"","sources":["../../../../src/actions/test/dropTransaction.ts"],"names":[],"mappings":"AAmCA,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAAqD,EACrD,EAAE,IAAI,EAA6B;IAEnC,MAAM,MAAM,CAAC,OAAO,CAAC;QACnB,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,kBAAkB;QACxC,MAAM,EAAE,CAAC,IAAI,CAAC;KACf,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"dropTransaction.js","sourceRoot":"","sources":["../../../../src/actions/test/dropTransaction.ts"],"names":[],"mappings":"AAaA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAAqD,EACrD,EAAE,IAAI,EAA6B;IAEnC,MAAM,MAAM,CAAC,OAAO,CAAC;QACnB,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,kBAAkB;QACxC,MAAM,EAAE,CAAC,IAAI,CAAC;KACf,CAAC,CAAA;AACJ,CAAC"}

package/dist/esm/actions/test/getAutomine.js

@@ -1,3 +1,23 @@
+/**
+ * Returns the automatic mining status of the node.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/getAutomine.html
+ *
+ * @param client - Client to use
+ * @returns Whether or not the node is auto mining. {@link GetAutomineReturnType}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { getAutomine } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * const isAutomining = await getAutomine(client)
+ */
 export async function getAutomine(client) {
     if (client.mode === 'ganache')
         return await client.request({

package/dist/esm/actions/test/getAutomine.js.map

@@ -1 +1 @@
-{"version":3,"file":"getAutomine.js","sourceRoot":"","sources":["../../../../src/actions/test/getAutomine.ts"],"names":[],"mappings":"AA6BA,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAqD;IAErD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS;QAC3B,OAAO,MAAM,MAAM,CAAC,OAAO,CAAC;YAC1B,MAAM,EAAE,YAAY;SACrB,CAAC,CAAA;IACJ,OAAO,MAAM,MAAM,CAAC,OAAO,CAAC;QAC1B,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,cAAc;KACrC,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"getAutomine.js","sourceRoot":"","sources":["../../../../src/actions/test/getAutomine.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAqD;IAErD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS;QAC3B,OAAO,MAAM,MAAM,CAAC,OAAO,CAAC;YAC1B,MAAM,EAAE,YAAY;SACrB,CAAC,CAAA;IACJ,OAAO,MAAM,MAAM,CAAC,OAAO,CAAC;QAC1B,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,cAAc;KACrC,CAAC,CAAA;AACJ,CAAC"}

package/dist/esm/actions/test/getTxpoolContent.js

@@ -1,3 +1,23 @@
+/**
+ * Returns the details of all transactions currently pending for inclusion in the next block(s), as well as the ones that are being scheduled for future execution only.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/getTxpoolContent.html
+ *
+ * @param client - Client to use
+ * @returns Transaction pool content. {@link GetTxpoolContentReturnType}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { getTxpoolContent } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * const content = await getTxpoolContent(client)
+ */
 export async function getTxpoolContent(client) {
     return await client.request({
         method: 'txpool_content',

package/dist/esm/actions/test/getTxpoolContent.js.map

@@ -1 +1 @@
-{"version":3,"file":"getTxpoolContent.js","sourceRoot":"","sources":["../../../../src/actions/test/getTxpoolContent.ts"],"names":[],"mappings":"AAqCA,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,MAAqD;IAErD,OAAO,MAAM,MAAM,CAAC,OAAO,CAAC;QAC1B,MAAM,EAAE,gBAAgB;KACzB,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"getTxpoolContent.js","sourceRoot":"","sources":["../../../../src/actions/test/getTxpoolContent.ts"],"names":[],"mappings":"AAiBA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,MAAqD;IAErD,OAAO,MAAM,MAAM,CAAC,OAAO,CAAC;QAC1B,MAAM,EAAE,gBAAgB;KACzB,CAAC,CAAA;AACJ,CAAC"}

package/dist/esm/actions/test/getTxpoolStatus.js

@@ -1,4 +1,24 @@
 import { hexToNumber } from '../../utils/encoding/fromHex.js';
+/**
+ * Returns a summary of all the transactions currently pending for inclusion in the next block(s), as well as the ones that are being scheduled for future execution only.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/getTxpoolStatus.html
+ *
+ * @param client - Client to use
+ * @returns Transaction pool status. {@link GetTxpoolStatusReturnType}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { getTxpoolStatus } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * const status = await getTxpoolStatus(client)
+ */
 export async function getTxpoolStatus(client) {
     const { pending, queued } = await client.request({
         method: 'txpool_status',

package/dist/esm/actions/test/getTxpoolStatus.js.map

@@ -1 +1 @@
-{"version":3,"file":"getTxpoolStatus.js","sourceRoot":"","sources":["../../../../src/actions/test/getTxpoolStatus.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAA;AA2B7D,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAAqD;IAErD,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAC/C,MAAM,EAAE,eAAe;KACxB,CAAC,CAAA;IACF,OAAO;QACL,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC;QAC7B,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC;KAC5B,CAAA;AACH,CAAC"}
+{"version":3,"file":"getTxpoolStatus.js","sourceRoot":"","sources":["../../../../src/actions/test/getTxpoolStatus.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAA;AAO7D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAAqD;IAErD,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAC/C,MAAM,EAAE,eAAe;KACxB,CAAC,CAAA;IACF,OAAO;QACL,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC;QAC7B,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC;KAC5B,CAAA;AACH,CAAC"}

package/dist/esm/actions/test/impersonateAccount.js

@@ -1,3 +1,25 @@
+/**
+ * Impersonate an account or contract address. This lets you send transactions from that account even if you don't have access to its private key.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/impersonateAccount.html
+ *
+ * @param client - Client to use
+ * @param parameters - {@link ImpersonateAccountParameters}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { impersonateAccount } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * const content = await impersonateAccount(client, {
+ *   address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ * })
+ */
 export async function impersonateAccount(client, { address }) {
     await client.request({
         method: `${client.mode}_impersonateAccount`,

package/dist/esm/actions/test/impersonateAccount.js.map

@@ -1 +1 @@
-{"version":3,"file":"impersonateAccount.js","sourceRoot":"","sources":["../../../../src/actions/test/impersonateAccount.ts"],"names":[],"mappings":"AAoCA,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,MAAqD,EACrD,EAAE,OAAO,EAAgC;IAEzC,MAAM,MAAM,CAAC,OAAO,CAAC;QACnB,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,qBAAqB;QAC3C,MAAM,EAAE,CAAC,OAAO,CAAC;KAClB,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"impersonateAccount.js","sourceRoot":"","sources":["../../../../src/actions/test/impersonateAccount.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,MAAqD,EACrD,EAAE,OAAO,EAAgC;IAEzC,MAAM,MAAM,CAAC,OAAO,CAAC;QACnB,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,qBAAqB;QAC3C,MAAM,EAAE,CAAC,OAAO,CAAC;KAClB,CAAC,CAAA;AACJ,CAAC"}

package/dist/esm/actions/test/increaseTime.js

@@ -1,4 +1,26 @@
 import { numberToHex } from '../../utils/encoding/toHex.js';
+/**
+ * Jump forward in time by the given amount of time, in seconds.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/increaseTime.html
+ *
+ * @param client - Client to use
+ * @param parameters – {@link IncreaseTimeParameters}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { increaseTime } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * await increaseTime(client, {
+ *   seconds: 420,
+ * })
+ */
 export async function increaseTime(client, { seconds }) {
     return await client.request({
         method: 'evm_increaseTime',

package/dist/esm/actions/test/increaseTime.js.map

@@ -1 +1 @@
-{"version":3,"file":"increaseTime.js","sourceRoot":"","sources":["../../../../src/actions/test/increaseTime.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AA6B3D,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAqD,EACrD,EAAE,OAAO,EAA0B;IAEnC,OAAO,MAAM,MAAM,CAAC,OAAO,CAAC;QAC1B,MAAM,EAAE,kBAAkB;QAC1B,MAAM,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;KAC/B,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"increaseTime.js","sourceRoot":"","sources":["../../../../src/actions/test/increaseTime.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAO3D;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAqD,EACrD,EAAE,OAAO,EAA0B;IAEnC,OAAO,MAAM,MAAM,CAAC,OAAO,CAAC;QAC1B,MAAM,EAAE,kBAAkB;QAC1B,MAAM,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;KAC/B,CAAC,CAAA;AACJ,CAAC"}

package/dist/esm/actions/test/inspectTxpool.js

@@ -1,3 +1,23 @@
+/**
+ * Returns a summary of all the transactions currently pending for inclusion in the next block(s), as well as the ones that are being scheduled for future execution only.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/inspectTxpool.html
+ *
+ * @param client - Client to use
+ * @returns Transaction pool inspection data. {@link InspectTxpoolReturnType}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { inspectTxpool } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * const data = await inspectTxpool(client)
+ */
 export async function inspectTxpool(client) {
     return await client.request({
         method: 'txpool_inspect',

package/dist/esm/actions/test/inspectTxpool.js.map

@@ -1 +1 @@
-{"version":3,"file":"inspectTxpool.js","sourceRoot":"","sources":["../../../../src/actions/test/inspectTxpool.ts"],"names":[],"mappings":"AAkCA,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAqD;IAErD,OAAO,MAAM,MAAM,CAAC,OAAO,CAAC;QAC1B,MAAM,EAAE,gBAAgB;KACzB,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"inspectTxpool.js","sourceRoot":"","sources":["../../../../src/actions/test/inspectTxpool.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAqD;IAErD,OAAO,MAAM,MAAM,CAAC,OAAO,CAAC;QAC1B,MAAM,EAAE,gBAAgB;KACzB,CAAC,CAAA;AACJ,CAAC"}

package/dist/esm/actions/test/mine.js

@@ -1,4 +1,24 @@
 import { numberToHex } from '../../utils/encoding/toHex.js';
+/**
+ * Mine a specified number of blocks.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/mine.html
+ *
+ * @param client - Client to use
+ * @param parameters – {@link MineParameters}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { mine } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * await mine(client, { blocks: 1 })
+ */
 export async function mine(client, { blocks, interval }) {
     if (client.mode === 'ganache')
         await client.request({

package/dist/esm/actions/test/mine.js.map

@@ -1 +1 @@
-{"version":3,"file":"mine.js","sourceRoot":"","sources":["../../../../src/actions/test/mine.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AA6B3D,MAAM,CAAC,KAAK,UAAU,IAAI,CACxB,MAAqD,EACrD,EAAE,MAAM,EAAE,QAAQ,EAAkB;IAEpC,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS;QAC3B,MAAM,MAAM,CAAC,OAAO,CAAC;YACnB,MAAM,EAAE,UAAU;YAClB,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;SAC1C,CAAC,CAAA;;QAEF,MAAM,MAAM,CAAC,OAAO,CAAC;YACnB,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,OAAO;YAC7B,MAAM,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC;SAC1D,CAAC,CAAA;AACN,CAAC"}
+{"version":3,"file":"mine.js","sourceRoot":"","sources":["../../../../src/actions/test/mine.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAS3D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CACxB,MAAqD,EACrD,EAAE,MAAM,EAAE,QAAQ,EAAkB;IAEpC,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS;QAC3B,MAAM,MAAM,CAAC,OAAO,CAAC;YACnB,MAAM,EAAE,UAAU;YAClB,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;SAC1C,CAAC,CAAA;;QAEF,MAAM,MAAM,CAAC,OAAO,CAAC;YACnB,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,OAAO;YAC7B,MAAM,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC;SAC1D,CAAC,CAAA;AACN,CAAC"}

package/dist/esm/actions/test/removeBlockTimestampInterval.js

@@ -1,3 +1,22 @@
+/**
+ * Removes [`setBlockTimestampInterval`](https://viem.sh/docs/actions/test/setBlockTimestampInterval.html) if it exists.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/removeBlockTimestampInterval.html
+ *
+ * @param client - Client to use
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { removeBlockTimestampInterval } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * await removeBlockTimestampInterval(client)
+ */
 export async function removeBlockTimestampInterval(client) {
     await client.request({
         method: `${client.mode}_removeBlockTimestampInterval`,

package/dist/esm/actions/test/removeBlockTimestampInterval.js.map

@@ -1 +1 @@
-{"version":3,"file":"removeBlockTimestampInterval.js","sourceRoot":"","sources":["../../../../src/actions/test/removeBlockTimestampInterval.ts"],"names":[],"mappings":"AA0BA,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAEhD,MAAqD;IACrD,MAAM,MAAM,CAAC,OAAO,CAAC;QACnB,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,+BAA+B;KACtD,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"removeBlockTimestampInterval.js","sourceRoot":"","sources":["../../../../src/actions/test/removeBlockTimestampInterval.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAEhD,MAAqD;IACrD,MAAM,MAAM,CAAC,OAAO,CAAC;QACnB,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,+BAA+B;KACtD,CAAC,CAAA;AACJ,CAAC"}

package/dist/esm/actions/test/reset.js

@@ -1,3 +1,23 @@
+/**
+ * Resets fork back to its original state.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/reset.html
+ *
+ * @param client - Client to use
+ * @param parameters – {@link ResetParameters}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { reset } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * await reset(client, { blockNumber: 69420n })
+ */
 export async function reset(client, { blockNumber, jsonRpcUrl } = {}) {
     await client.request({
         method: `${client.mode}_reset`,

package/dist/esm/actions/test/reset.js.map

@@ -1 +1 @@
-{"version":3,"file":"reset.js","sourceRoot":"","sources":["../../../../src/actions/test/reset.ts"],"names":[],"mappings":"AAkCA,MAAM,CAAC,KAAK,UAAU,KAAK,CACzB,MAAqD,EACrD,EAAE,WAAW,EAAE,UAAU,KAAsB,EAAE;IAEjD,MAAM,MAAM,CAAC,OAAO,CAAC;QACnB,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,QAAQ;QAC9B,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC,EAAE,UAAU,EAAE,EAAE,CAAC;KACxE,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"reset.js","sourceRoot":"","sources":["../../../../src/actions/test/reset.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CACzB,MAAqD,EACrD,EAAE,WAAW,EAAE,UAAU,KAAsB,EAAE;IAEjD,MAAM,MAAM,CAAC,OAAO,CAAC;QACnB,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,QAAQ;QAC9B,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC,EAAE,UAAU,EAAE,EAAE,CAAC;KACxE,CAAC,CAAA;AACJ,CAAC"}

package/dist/esm/actions/test/revert.js

@@ -1,3 +1,23 @@
+/**
+ * Revert the state of the blockchain at the current block.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/revert.html
+ *
+ * @param client - Client to use
+ * @param parameters – {@link RevertParameters}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { revert } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * await revert(client, { id: '0x…' })
+ */
 export async function revert(client, { id }) {
     await client.request({
         method: 'evm_revert',

package/dist/esm/actions/test/revert.js.map

@@ -1 +1 @@
-{"version":3,"file":"revert.js","sourceRoot":"","sources":["../../../../src/actions/test/revert.ts"],"names":[],"mappings":"AAiCA,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,MAAqD,EACrD,EAAE,EAAE,EAAoB;IAExB,MAAM,MAAM,CAAC,OAAO,CAAC;QACnB,MAAM,EAAE,YAAY;QACpB,MAAM,EAAE,CAAC,EAAE,CAAC;KACb,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"revert.js","sourceRoot":"","sources":["../../../../src/actions/test/revert.ts"],"names":[],"mappings":"AAaA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,MAAqD,EACrD,EAAE,EAAE,EAAoB;IAExB,MAAM,MAAM,CAAC,OAAO,CAAC;QACnB,MAAM,EAAE,YAAY;QACpB,MAAM,EAAE,CAAC,EAAE,CAAC;KACb,CAAC,CAAA;AACJ,CAAC"}

package/dist/esm/actions/test/sendUnsignedTransaction.js

@@ -1,4 +1,29 @@
 import { formatTransactionRequest } from '../../utils/formatters/transactionRequest.js';
+/**
+ * Returns the details of all transactions currently pending for inclusion in the next block(s), as well as the ones that are being scheduled for future execution only.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/getTxpoolContent.html
+ *
+ * @param client - Client to use
+ * @param parameters – {@link SendUnsignedTransactionParameters}
+ * @returns The transaction hash. {@link SendUnsignedTransactionReturnType}
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { sendUnsignedTransaction } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * const hash = await sendUnsignedTransaction(client, {
+ *   from: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+ *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *   value: 1000000000000000000n,
+ * })
+ */
 export async function sendUnsignedTransaction(client, request) {
     const request_ = formatTransactionRequest(request);
     const hash = await client.request({

package/dist/esm/actions/test/sendUnsignedTransaction.js.map

@@ -1 +1 @@
-{"version":3,"file":"sendUnsignedTransaction.js","sourceRoot":"","sources":["../../../../src/actions/test/sendUnsignedTransaction.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,wBAAwB,EAAE,MAAM,8CAA8C,CAAA;AA+BvF,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAG3C,MAAqD,EACrD,OAA0C;IAE1C,MAAM,QAAQ,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAA;IAClD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAChC,MAAM,EAAE,6BAA6B;QACrC,MAAM,EAAE,CAAC,QAAQ,CAAC;KACnB,CAAC,CAAA;IACF,OAAO,IAAI,CAAA;AACb,CAAC"}
+{"version":3,"file":"sendUnsignedTransaction.js","sourceRoot":"","sources":["../../../../src/actions/test/sendUnsignedTransaction.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,wBAAwB,EAAE,MAAM,8CAA8C,CAAA;AAMvF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAG3C,MAAqD,EACrD,OAA0C;IAE1C,MAAM,QAAQ,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAA;IAClD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAChC,MAAM,EAAE,6BAA6B;QACrC,MAAM,EAAE,CAAC,QAAQ,CAAC;KACnB,CAAC,CAAA;IACF,OAAO,IAAI,CAAA;AACb,CAAC"}

package/dist/esm/actions/test/setAutomine.js

@@ -1,3 +1,22 @@
+/**
+ * Enables or disables the automatic mining of new blocks with each new transaction submitted to the network.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/setAutomine.html
+ *
+ * @param client - Client to use
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { setAutomine } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * await setAutomine(client)
+ */
 export async function setAutomine(client, enabled) {
     if (client.mode === 'ganache') {
         if (enabled)

package/dist/esm/actions/test/setAutomine.js.map

@@ -1 +1 @@
-{"version":3,"file":"setAutomine.js","sourceRoot":"","sources":["../../../../src/actions/test/setAutomine.ts"],"names":[],"mappings":"AA0BA,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAqD,EACrD,OAAgB;IAEhB,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE;QAC7B,IAAI,OAAO;YAAE,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAA;;YACvD,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAA;KACpD;;QACC,MAAM,MAAM,CAAC,OAAO,CAAC;YACnB,MAAM,EAAE,iBAAiB;YACzB,MAAM,EAAE,CAAC,OAAO,CAAC;SAClB,CAAC,CAAA;AACN,CAAC"}
+{"version":3,"file":"setAutomine.js","sourceRoot":"","sources":["../../../../src/actions/test/setAutomine.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAqD,EACrD,OAAgB;IAEhB,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE;QAC7B,IAAI,OAAO;YAAE,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAA;;YACvD,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAA;KACpD;;QACC,MAAM,MAAM,CAAC,OAAO,CAAC;YACnB,MAAM,EAAE,iBAAiB;YACzB,MAAM,EAAE,CAAC,OAAO,CAAC;SAClB,CAAC,CAAA;AACN,CAAC"}

package/dist/esm/actions/test/setBalance.js

@@ -1,4 +1,27 @@
 import { numberToHex } from '../../utils/encoding/toHex.js';
+/**
+ * Modifies the balance of an account.
+ *
+ * - Docs: https://viem.sh/docs/actions/test/setBalance.html
+ *
+ * @param client - Client to use
+ * @param parameters – {@link SetBalanceParameters}
+ *
+ * @example
+ * import { createTestClient, http, parseEther } from 'viem'
+ * import { foundry } from 'viem/chains'
+ * import { setBalance } from 'viem/test'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: 'foundry',
+ *   transport: http(),
+ * })
+ * await setBalance(client, {
+ *   address: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
+ *   value: parseEther('1'),
+ * })
+ */
 export async function setBalance(client, { address, value }) {
     if (client.mode === 'ganache')
         await client.request({

package/dist/esm/actions/test/setBalance.js.map

@@ -1 +1 @@
-{"version":3,"file":"setBalance.js","sourceRoot":"","sources":["../../../../src/actions/test/setBalance.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAgC3D,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAqD,EACrD,EAAE,OAAO,EAAE,KAAK,EAAwB;IAExC,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS;QAC3B,MAAM,MAAM,CAAC,OAAO,CAAC;YACnB,MAAM,EAAE,uBAAuB;YAC/B,MAAM,EAAE,CAAC,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;SACtC,CAAC,CAAA;;QAEF,MAAM,MAAM,CAAC,OAAO,CAAC;YACnB,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,aAAa;YACnC,MAAM,EAAE,CAAC,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;SACtC,CAAC,CAAA;AACN,CAAC"}
+{"version":3,"file":"setBalance.js","sourceRoot":"","sources":["../../../../src/actions/test/setBalance.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAS3D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAqD,EACrD,EAAE,OAAO,EAAE,KAAK,EAAwB;IAExC,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS;QAC3B,MAAM,MAAM,CAAC,OAAO,CAAC;YACnB,MAAM,EAAE,uBAAuB;YAC/B,MAAM,EAAE,CAAC,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;SACtC,CAAC,CAAA;;QAEF,MAAM,MAAM,CAAC,OAAO,CAAC;YACnB,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,aAAa;YACnC,MAAM,EAAE,CAAC,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;SACtC,CAAC,CAAA;AACN,CAAC"}