viem 0.0.0-portable-types-20230523145621 → 0.0.0-refactor-generics-20230831161903

package/dist/esm/actions/getContract.js

@@ -4,6 +4,31 @@ import { readContract, } from './public/readContract.js';
 import { simulateContract, } from './public/simulateContract.js';
 import { watchContractEvent, } from './public/watchContractEvent.js';
 import { writeContract, } from './wallet/writeContract.js';
+/**
+ * Gets type-safe interface for performing contract-related actions with a specific `abi` and `address`.
+ *
+ * - Docs https://viem.sh/docs/contract/getContract.html
+ *
+ * Using Contract Instances can make it easier to work with contracts if you don't want to pass the `abi` and `address` properites every time you perform contract actions, e.g. [`readContract`](https://viem.sh/docs/contract/readContract.html), [`writeContract`](https://viem.sh/docs/contract/writeContract.html), [`estimateContractGas`](https://viem.sh/docs/contract/estimateContractGas.html), etc.
+ *
+ * @example
+ * import { createPublicClient, getContract, http, parseAbi } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ *
+ * const publicClient = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const contract = getContract({
+ *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+ *   abi: parseAbi([
+ *     'function balanceOf(address owner) view returns (uint256)',
+ *     'function ownerOf(uint256 tokenId) view returns (address)',
+ *     'function totalSupply() view returns (uint256)',
+ *   ]),
+ *   publicClient,
+ * })
+ */
 export function getContract({ abi, address, publicClient, walletClient, }) {
     const hasPublicClient = publicClient !== undefined && publicClient !== null;
     const hasWalletClient = walletClient !== undefined && walletClient !== null;
@@ -19,6 +44,7 @@ export function getContract({ abi, address, publicClient, walletClient, }) {
                 hasWriteFunction = true;
         else if (item.type === 'event')
             hasEvent = true;
+        // Exit early if all flags are `true`
         if (hasReadFunction && hasWriteFunction && hasEvent)
             break;
     }
@@ -38,21 +64,7 @@ export function getContract({ abi, address, publicClient, walletClient, }) {
                     };
                 },
             });
-        if (hasWriteFunction) {
-            contract.estimateGas = new Proxy({}, {
-                get(_, functionName) {
-                    return (...parameters) => {
-                        const { args, options } = getFunctionParameters(parameters);
-                        return estimateContractGas(publicClient, {
-                            abi,
-                            address,
-                            functionName,
-                            args,
-                            ...options,
-                        });
-                    };
-                },
-            });
+        if (hasWriteFunction)
             contract.simulate = new Proxy({}, {
                 get(_, functionName) {
                     return (...parameters) => {
@@ -67,7 +79,6 @@ export function getContract({ abi, address, publicClient, walletClient, }) {
                     };
                 },
             });
-        }
         if (hasEvent) {
             contract.createEventFilter = new Proxy({}, {
                 get(_, eventName) {
@@ -118,20 +129,51 @@ export function getContract({ abi, address, publicClient, walletClient, }) {
                 },
             });
     }
+    if (hasPublicClient || hasWalletClient)
+        if (hasWriteFunction)
+            contract.estimateGas = new Proxy({}, {
+                get(_, functionName) {
+                    return (...parameters) => {
+                        const { args, options } = getFunctionParameters(parameters);
+                        const client = (publicClient ?? walletClient);
+                        return estimateContractGas(client, {
+                            abi,
+                            address,
+                            functionName,
+                            args,
+                            ...options,
+                            account: options.account ??
+                                walletClient.account,
+                        });
+                    };
+                },
+            });
+    contract.address = address;
+    contract.abi = abi;
     return contract;
 }
+/**
+ * @internal exporting for testing only
+ */
 export function getFunctionParameters(values) {
     const hasArgs = values.length && Array.isArray(values[0]);
     const args = hasArgs ? values[0] : [];
     const options = (hasArgs ? values[1] : values[0]) ?? {};
     return { args, options };
 }
+/**
+ * @internal exporting for testing only
+ */
 export function getEventParameters(values, abiEvent) {
     let hasArgs = false;
+    // If first item is array, must be `args`
     if (Array.isArray(values[0]))
         hasArgs = true;
+    // Check if first item is `args` or `options`
     else if (values.length === 1) {
+        // if event has indexed inputs, must have `args`
         hasArgs = abiEvent.inputs.some((x) => x.indexed);
+        // If there are two items in array, must have `args`
     }
     else if (values.length === 2) {
         hasArgs = true;

package/dist/esm/actions/getContract.js.map

@@ -1 +1 @@
-{"version":3,"file":"getContract.js","sourceRoot":"","sources":["../../../src/actions/getContract.ts"],"names":[],"mappings":"AA8BA,OAAO,EAGL,yBAAyB,GAC1B,MAAM,uCAAuC,CAAA;AAC9C,OAAO,EAGL,mBAAmB,GACpB,MAAM,iCAAiC,CAAA;AACxC,OAAO,EAGL,YAAY,GACb,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAGL,gBAAgB,GACjB,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAGL,kBAAkB,GACnB,MAAM,gCAAgC,CAAA;AACvC,OAAO,EAGL,aAAa,GACd,MAAM,2BAA2B,CAAA;AA2SlC,MAAM,UAAU,WAAW,CAWzB,EACA,GAAG,EACH,OAAO,EACP,YAAY,EACZ,YAAY,GAQb;IACC,MAAM,eAAe,GAAG,YAAY,KAAK,SAAS,IAAI,YAAY,KAAK,IAAI,CAAA;IAC3E,MAAM,eAAe,GAAG,YAAY,KAAK,SAAS,IAAI,YAAY,KAAK,IAAI,CAAA;IAE3E,MAAM,QAAQ,GAQV,EAAE,CAAA;IAEN,IAAI,eAAe,GAAG,KAAK,CAAA;IAC3B,IAAI,gBAAgB,GAAG,KAAK,CAAA;IAC5B,IAAI,QAAQ,GAAG,KAAK,CAAA;IACpB,KAAK,MAAM,IAAI,IAAI,GAAU,EAAE;QAC7B,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU;YAC1B,IAAI,IAAI,CAAC,eAAe,KAAK,MAAM,IAAI,IAAI,CAAC,eAAe,KAAK,MAAM;gBACpE,eAAe,GAAG,IAAI,CAAA;;gBACnB,gBAAgB,GAAG,IAAI,CAAA;aACzB,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO;YAAE,QAAQ,GAAG,IAAI,CAAA;QAE/C,IAAI,eAAe,IAAI,gBAAgB,IAAI,QAAQ;YAAE,MAAK;KAC3D;IAED,IAAI,eAAe,EAAE;QACnB,IAAI,eAAe;YACjB,QAAQ,CAAC,IAAI,GAAG,IAAI,KAAK,CACvB,EAAE,EACF;gBACE,GAAG,CAAC,CAAC,EAAE,YAAoB;oBACzB,OAAO,CACL,GAAG,UAMF,EACD,EAAE;wBACF,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAA;wBAC3D,OAAO,YAAY,CAAC,YAAY,EAAE;4BAChC,GAAG;4BACH,OAAO;4BACP,YAAY;4BACZ,IAAI;4BACJ,GAAG,OAAO;yBACe,CAAC,CAAA;oBAC9B,CAAC,CAAA;gBACH,CAAC;aACF,CACF,CAAA;QAEH,IAAI,gBAAgB,EAAE;YACpB,QAAQ,CAAC,WAAW,GAAG,IAAI,KAAK,CAC9B,EAAE,EACF;gBACE,GAAG,CAAC,CAAC,EAAE,YAAoB;oBACzB,OAAO,CACL,GAAG,UAMF,EACD,EAAE;wBACF,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAA;wBAC3D,OAAO,mBAAmB,CAAC,YAAY,EAAE;4BACvC,GAAG;4BACH,OAAO;4BACP,YAAY;4BACZ,IAAI;4BACJ,GAAG,OAAO;yBACsB,CAAC,CAAA;oBACrC,CAAC,CAAA;gBACH,CAAC;aACF,CACF,CAAA;YACD,QAAQ,CAAC,QAAQ,GAAG,IAAI,KAAK,CAC3B,EAAE,EACF;gBACE,GAAG,CAAC,CAAC,EAAE,YAAoB;oBACzB,OAAO,CACL,GAAG,UAMF,EACD,EAAE;wBACF,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAA;wBAC3D,OAAO,gBAAgB,CAAC,YAAY,EAAE;4BACpC,GAAG;4BACH,OAAO;4BACP,YAAY;4BACZ,IAAI;4BACJ,GAAG,OAAO;yBACmB,CAAC,CAAA;oBAClC,CAAC,CAAA;gBACH,CAAC;aACF,CACF,CAAA;SACF;QAED,IAAI,QAAQ,EAAE;YACZ,QAAQ,CAAC,iBAAiB,GAAG,IAAI,KAAK,CACpC,EAAE,EACF;gBACE,GAAG,CAAC,CAAC,EAAE,SAAiB;oBACtB,OAAO,CACL,GAAG,UAMF,EACD,EAAE;wBACF,MAAM,QAAQ,GAAI,GAA2B,CAAC,IAAI,CAChD,CAAC,CAAW,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,CAC5D,CAAA;wBACD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,kBAAkB,CAC1C,UAAU,EACV,QAAS,CACV,CAAA;wBACD,OAAO,yBAAyB,CAAC,YAAY,EAAE;4BAC7C,GAAG;4BACH,OAAO;4BACP,SAAS;4BACT,IAAI;4BACJ,GAAG,OAAO;yBAC4B,CAAC,CAAA;oBAC3C,CAAC,CAAA;gBACH,CAAC;aACF,CACF,CAAA;YACD,QAAQ,CAAC,UAAU,GAAG,IAAI,KAAK,CAC7B,EAAE,EACF;gBACE,GAAG,CAAC,CAAC,EAAE,SAAiB;oBACtB,OAAO,CACL,GAAG,UAMF,EACD,EAAE;wBACF,MAAM,QAAQ,GAAI,GAA2B,CAAC,IAAI,CAChD,CAAC,CAAW,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,CAC5D,CAAA;wBACD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,kBAAkB,CAC1C,UAAU,EACV,QAAS,CACV,CAAA;wBACD,OAAO,kBAAkB,CAAC,YAAY,EAAE;4BACtC,GAAG;4BACH,OAAO;4BACP,SAAS;4BACT,IAAI;4BACJ,GAAG,OAAO;yBACqB,CAAC,CAAA;oBACpC,CAAC,CAAA;gBACH,CAAC;aACF,CACF,CAAA;SACF;KACF;IAED,IAAI,eAAe,EAAE;QACnB,IAAI,gBAAgB;YAClB,QAAQ,CAAC,KAAK,GAAG,IAAI,KAAK,CACxB,EAAE,EACF;gBACE,GAAG,CAAC,CAAC,EAAE,YAAoB;oBACzB,OAAO,CACL,GAAG,UAMF,EACD,EAAE;wBACF,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAA;wBAC3D,OAAO,aAAa,CAAC,YAAY,EAAE;4BACjC,GAAG;4BACH,OAAO;4BACP,YAAY;4BACZ,IAAI;4BACJ,GAAG,OAAO;yBAMX,CAAC,CAAA;oBACJ,CAAC,CAAA;gBACH,CAAC;aACF,CACF,CAAA;KACJ;IAED,OAAO,QAIN,CAAA;AACH,CAAC;AAKD,MAAM,UAAU,qBAAqB,CACnC,MAAqD;IAErD,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;IACzD,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,EAAE,CAAA;IACtC,MAAM,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;IACvD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAA;AAC1B,CAAC;AAKD,MAAM,UAAU,kBAAkB,CAChC,MAAqD,EACrD,QAAkB;IAElB,IAAI,OAAO,GAAG,KAAK,CAAA;IAEnB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAAE,OAAO,GAAG,IAAI,CAAA;SAEvC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;QAE5B,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;KAEjD;SAAM,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;QAC9B,OAAO,GAAG,IAAI,CAAA;KACf;IAED,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,SAAS,CAAA;IAC7C,MAAM,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;IACvD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAA;AAC1B,CAAC"}
+{"version":3,"file":"getContract.js","sourceRoot":"","sources":["../../../src/actions/getContract.ts"],"names":[],"mappings":"AAgCA,OAAO,EAGL,yBAAyB,GAC1B,MAAM,uCAAuC,CAAA;AAC9C,OAAO,EAGL,mBAAmB,GACpB,MAAM,iCAAiC,CAAA;AACxC,OAAO,EAGL,YAAY,GACb,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAGL,gBAAgB,GACjB,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAGL,kBAAkB,GACnB,MAAM,gCAAgC,CAAA;AACvC,OAAO,EAGL,aAAa,GACd,MAAM,2BAA2B,CAAA;AA6SlC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,WAAW,CAYzB,EACA,GAAG,EACH,OAAO,EACP,YAAY,EACZ,YAAY,GASb;IACC,MAAM,eAAe,GAAG,YAAY,KAAK,SAAS,IAAI,YAAY,KAAK,IAAI,CAAA;IAC3E,MAAM,eAAe,GAAG,YAAY,KAAK,SAAS,IAAI,YAAY,KAAK,IAAI,CAAA;IAE3E,MAAM,QAAQ,GAUV,EAAE,CAAA;IAEN,IAAI,eAAe,GAAG,KAAK,CAAA;IAC3B,IAAI,gBAAgB,GAAG,KAAK,CAAA;IAC5B,IAAI,QAAQ,GAAG,KAAK,CAAA;IACpB,KAAK,MAAM,IAAI,IAAI,GAAU,EAAE;QAC7B,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU;YAC1B,IAAI,IAAI,CAAC,eAAe,KAAK,MAAM,IAAI,IAAI,CAAC,eAAe,KAAK,MAAM;gBACpE,eAAe,GAAG,IAAI,CAAA;;gBACnB,gBAAgB,GAAG,IAAI,CAAA;aACzB,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO;YAAE,QAAQ,GAAG,IAAI,CAAA;QAC/C,qCAAqC;QACrC,IAAI,eAAe,IAAI,gBAAgB,IAAI,QAAQ;YAAE,MAAK;KAC3D;IAED,IAAI,eAAe,EAAE;QACnB,IAAI,eAAe;YACjB,QAAQ,CAAC,IAAI,GAAG,IAAI,KAAK,CACvB,EAAE,EACF;gBACE,GAAG,CAAC,CAAC,EAAE,YAAoB;oBACzB,OAAO,CACL,GAAG,UAMF,EACD,EAAE;wBACF,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAA;wBAC3D,OAAO,YAAY,CAAC,YAAY,EAAE;4BAChC,GAAG;4BACH,OAAO;4BACP,YAAY;4BACZ,IAAI;4BACJ,GAAG,OAAO;yBACe,CAAC,CAAA;oBAC9B,CAAC,CAAA;gBACH,CAAC;aACF,CACF,CAAA;QAEH,IAAI,gBAAgB;YAClB,QAAQ,CAAC,QAAQ,GAAG,IAAI,KAAK,CAC3B,EAAE,EACF;gBACE,GAAG,CAAC,CAAC,EAAE,YAAoB;oBACzB,OAAO,CACL,GAAG,UAMF,EACD,EAAE;wBACF,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAA;wBAC3D,OAAO,gBAAgB,CAAC,YAAY,EAAE;4BACpC,GAAG;4BACH,OAAO;4BACP,YAAY;4BACZ,IAAI;4BACJ,GAAG,OAAO;yBACmB,CAAC,CAAA;oBAClC,CAAC,CAAA;gBACH,CAAC;aACF,CACF,CAAA;QAEH,IAAI,QAAQ,EAAE;YACZ,QAAQ,CAAC,iBAAiB,GAAG,IAAI,KAAK,CACpC,EAAE,EACF;gBACE,GAAG,CAAC,CAAC,EAAE,SAAiB;oBACtB,OAAO,CACL,GAAG,UAMF,EACD,EAAE;wBACF,MAAM,QAAQ,GAAI,GAA2B,CAAC,IAAI,CAChD,CAAC,CAAW,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,CAC5D,CAAA;wBACD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,kBAAkB,CAC1C,UAAU,EACV,QAAS,CACV,CAAA;wBACD,OAAO,yBAAyB,CAAC,YAAY,EAAE;4BAC7C,GAAG;4BACH,OAAO;4BACP,SAAS;4BACT,IAAI;4BACJ,GAAG,OAAO;yBAC4B,CAAC,CAAA;oBAC3C,CAAC,CAAA;gBACH,CAAC;aACF,CACF,CAAA;YACD,QAAQ,CAAC,UAAU,GAAG,IAAI,KAAK,CAC7B,EAAE,EACF;gBACE,GAAG,CAAC,CAAC,EAAE,SAAiB;oBACtB,OAAO,CACL,GAAG,UAMF,EACD,EAAE;wBACF,MAAM,QAAQ,GAAI,GAA2B,CAAC,IAAI,CAChD,CAAC,CAAW,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,CAC5D,CAAA;wBACD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,kBAAkB,CAC1C,UAAU,EACV,QAAS,CACV,CAAA;wBACD,OAAO,kBAAkB,CAAC,YAAY,EAAE;4BACtC,GAAG;4BACH,OAAO;4BACP,SAAS;4BACT,IAAI;4BACJ,GAAG,OAAO;yBACgC,CAAC,CAAA;oBAC/C,CAAC,CAAA;gBACH,CAAC;aACF,CACF,CAAA;SACF;KACF;IAED,IAAI,eAAe,EAAE;QACnB,IAAI,gBAAgB;YAClB,QAAQ,CAAC,KAAK,GAAG,IAAI,KAAK,CACxB,EAAE,EACF;gBACE,GAAG,CAAC,CAAC,EAAE,YAAoB;oBACzB,OAAO,CACL,GAAG,UAMF,EACD,EAAE;wBACF,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAA;wBAC3D,OAAO,aAAa,CAAC,YAAY,EAAE;4BACjC,GAAG;4BACH,OAAO;4BACP,YAAY;4BACZ,IAAI;4BACJ,GAAG,OAAO;yBAMX,CAAC,CAAA;oBACJ,CAAC,CAAA;gBACH,CAAC;aACF,CACF,CAAA;KACJ;IAED,IAAI,eAAe,IAAI,eAAe;QACpC,IAAI,gBAAgB;YAClB,QAAQ,CAAC,WAAW,GAAG,IAAI,KAAK,CAC9B,EAAE,EACF;gBACE,GAAG,CAAC,CAAC,EAAE,YAAoB;oBACzB,OAAO,CACL,GAAG,UAMF,EACD,EAAE;wBACF,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAA;wBAC3D,MAAM,MAAM,GAAG,CAAC,YAAY,IAAI,YAAY,CAAE,CAAA;wBAC9C,OAAO,mBAAmB,CAAC,MAAM,EAAE;4BACjC,GAAG;4BACH,OAAO;4BACP,YAAY;4BACZ,IAAI;4BACJ,GAAG,OAAO;4BACV,OAAO,EACJ,OAAyC,CAAC,OAAO;gCACjD,YAAwC,CAAC,OAAO;yBAC7C,CAAC,CAAA;oBACX,CAAC,CAAA;gBACH,CAAC;aACF,CACF,CAAA;IACL,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAA;IAC1B,QAAQ,CAAC,GAAG,GAAG,GAAG,CAAA;IAElB,OAAO,QAKN,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CACnC,MAAqD;IAErD,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;IACzD,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,EAAE,CAAA;IACtC,MAAM,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;IACvD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAA;AAC1B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAChC,MAAqD,EACrD,QAAkB;IAElB,IAAI,OAAO,GAAG,KAAK,CAAA;IACnB,yCAAyC;IACzC,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAAE,OAAO,GAAG,IAAI,CAAA;IAC5C,6CAA6C;SACxC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;QAC5B,gDAAgD;QAChD,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;QAChD,oDAAoD;KACrD;SAAM,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;QAC9B,OAAO,GAAG,IAAI,CAAA;KACf;IAED,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,SAAS,CAAA;IAC7C,MAAM,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;IACvD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAA;AAC1B,CAAC"}

package/dist/esm/actions/index.js

@@ -0,0 +1,79 @@
+export { getEnsAddress, } from './ens/getEnsAddress.js';
+export { getEnsAvatar, } from './ens/getEnsAvatar.js';
+export { getEnsName, } from './ens/getEnsName.js';
+export { getEnsResolver, } from './ens/getEnsResolver.js';
+export { getEnsText, } from './ens/getEnsText.js';
+export { call, } from './public/call.js';
+export { createBlockFilter, } from './public/createBlockFilter.js';
+export { createContractEventFilter, } from './public/createContractEventFilter.js';
+export { createEventFilter, } from './public/createEventFilter.js';
+export { createPendingTransactionFilter, } from './public/createPendingTransactionFilter.js';
+export { estimateContractGas, } from './public/estimateContractGas.js';
+export { estimateGas, } from './public/estimateGas.js';
+export { getBalance, } from './public/getBalance.js';
+export { getBlock, } from './public/getBlock.js';
+export { getBlockNumber, } from './public/getBlockNumber.js';
+export { getBlockTransactionCount, } from './public/getBlockTransactionCount.js';
+export { getBytecode, } from './public/getBytecode.js';
+export { getChainId } from './public/getChainId.js';
+export { getFeeHistory, } from './public/getFeeHistory.js';
+export { getFilterChanges, } from './public/getFilterChanges.js';
+export { getFilterLogs, } from './public/getFilterLogs.js';
+export { getGasPrice, } from './public/getGasPrice.js';
+export { getLogs, } from './public/getLogs.js';
+export { getStorageAt, } from './public/getStorageAt.js';
+export { getTransactionConfirmations, } from './public/getTransactionConfirmations.js';
+export { getTransactionCount, } from './public/getTransactionCount.js';
+export { getTransaction, } from './public/getTransaction.js';
+export { getTransactionReceipt, } from './public/getTransactionReceipt.js';
+export { impersonateAccount, } from './test/impersonateAccount.js';
+export { increaseTime, } from './test/increaseTime.js';
+export { mine } from './test/mine.js';
+export { multicall, } from './public/multicall.js';
+export { watchBlocks, } from './public/watchBlocks.js';
+export { watchBlockNumber, } from './public/watchBlockNumber.js';
+export { watchEvent, } from './public/watchEvent.js';
+export { watchPendingTransactions, } from './public/watchPendingTransactions.js';
+export { readContract, } from './public/readContract.js';
+export { getPermissions, } from './wallet/getPermissions.js';
+export { waitForTransactionReceipt, } from './public/waitForTransactionReceipt.js';
+export { requestAddresses, } from './wallet/requestAddresses.js';
+export { requestPermissions, } from './wallet/requestPermissions.js';
+export { dropTransaction, } from './test/dropTransaction.js';
+export { getAutomine, } from './test/getAutomine.js';
+export { getTxpoolContent, } from './test/getTxpoolContent.js';
+export { getTxpoolStatus, } from './test/getTxpoolStatus.js';
+export { inspectTxpool, } from './test/inspectTxpool.js';
+export { reset } from './test/reset.js';
+export { revert } from './test/revert.js';
+export { prepareTransactionRequest, } from './wallet/prepareTransactionRequest.js';
+export { sendTransaction, } from './wallet/sendTransaction.js';
+export { signTransaction, } from './wallet/signTransaction.js';
+export { sendRawTransaction, } from './wallet/sendRawTransaction.js';
+export { sendUnsignedTransaction, } from './test/sendUnsignedTransaction.js';
+export { setBalance } from './test/setBalance.js';
+export { setAutomine } from './test/setAutomine.js';
+export { setBlockGasLimit, } from './test/setBlockGasLimit.js';
+export { setBlockTimestampInterval, } from './test/setBlockTimestampInterval.js';
+export { setCode } from './test/setCode.js';
+export { setCoinbase } from './test/setCoinbase.js';
+export { setIntervalMining, } from './test/setIntervalMining.js';
+export { setMinGasPrice, } from './test/setMinGasPrice.js';
+export { setNextBlockBaseFeePerGas, } from './test/setNextBlockBaseFeePerGas.js';
+export { setNextBlockTimestamp, } from './test/setNextBlockTimestamp.js';
+export { setNonce } from './test/setNonce.js';
+export { setStorageAt, } from './test/setStorageAt.js';
+export { snapshot } from './test/snapshot.js';
+export { signMessage, } from './wallet/signMessage.js';
+export { signTypedData, } from './wallet/signTypedData.js';
+export { simulateContract, } from './public/simulateContract.js';
+export { stopImpersonatingAccount, } from './test/stopImpersonatingAccount.js';
+export { switchChain, } from './wallet/switchChain.js';
+export { uninstallFilter, } from './public/uninstallFilter.js';
+export { verifyHash, } from './public/verifyHash.js';
+export { verifyMessage, } from './public/verifyMessage.js';
+export { verifyTypedData, } from './public/verifyTypedData.js';
+export { watchAsset, } from './wallet/watchAsset.js';
+export { watchContractEvent, } from './public/watchContractEvent.js';
+export { writeContract, } from './wallet/writeContract.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/actions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/actions/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,aAAa,GACd,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAGL,YAAY,GACb,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAGL,UAAU,GACX,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAGL,cAAc,GACf,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAGL,UAAU,GACX,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAGL,IAAI,GACL,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAEL,iBAAiB,GAClB,MAAM,+BAA+B,CAAA;AACtC,OAAO,EAGL,yBAAyB,GAC1B,MAAM,uCAAuC,CAAA;AAC9C,OAAO,EAGL,iBAAiB,GAClB,MAAM,+BAA+B,CAAA;AACtC,OAAO,EAEL,8BAA8B,GAC/B,MAAM,4CAA4C,CAAA;AACnD,OAAO,EAGL,mBAAmB,GACpB,MAAM,iCAAiC,CAAA;AACxC,OAAO,EAGL,WAAW,GACZ,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAGL,UAAU,GACX,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAGL,QAAQ,GACT,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAGL,cAAc,GACf,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAGL,wBAAwB,GACzB,MAAM,sCAAsC,CAAA;AAC7C,OAAO,EAGL,WAAW,GACZ,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAA6B,UAAU,EAAE,MAAM,wBAAwB,CAAA;AAC9E,OAAO,EAGL,aAAa,GACd,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAGL,gBAAgB,GACjB,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAGL,aAAa,GACd,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAEL,WAAW,GACZ,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAGL,OAAO,GACR,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAGL,YAAY,GACb,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAGL,2BAA2B,GAC5B,MAAM,yCAAyC,CAAA;AAChD,OAAO,EAGL,mBAAmB,GACpB,MAAM,iCAAiC,CAAA;AACxC,OAAO,EAGL,cAAc,GACf,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAGL,qBAAqB,GACtB,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAEL,kBAAkB,GACnB,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAEL,YAAY,GACb,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAuB,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAC1D,OAAO,EAGL,SAAS,GACV,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAKL,WAAW,GACZ,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAKL,gBAAgB,GACjB,MAAM,8BAA8B,CAAA;AACrC,OAAO,EASL,UAAU,GACX,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAKL,wBAAwB,GACzB,MAAM,sCAAsC,CAAA;AAC7C,OAAO,EAGL,YAAY,GACb,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAEL,cAAc,GACf,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAKL,yBAAyB,GAC1B,MAAM,uCAAuC,CAAA;AAC9C,OAAO,EAEL,gBAAgB,GACjB,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAGL,kBAAkB,GACnB,MAAM,gCAAgC,CAAA;AACvC,OAAO,EAEL,eAAe,GAChB,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAEL,WAAW,GACZ,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAEL,gBAAgB,GACjB,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAEL,eAAe,GAChB,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAEL,aAAa,GACd,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAwB,KAAK,EAAE,MAAM,iBAAiB,CAAA;AAC7D,OAAO,EAAyB,MAAM,EAAE,MAAM,kBAAkB,CAAA;AAChE,OAAO,EAGL,yBAAyB,GAC1B,MAAM,uCAAuC,CAAA;AAC9C,OAAO,EAGL,eAAe,GAChB,MAAM,6BAA6B,CAAA;AACpC,OAAO,EAGL,eAAe,GAChB,MAAM,6BAA6B,CAAA;AACpC,OAAO,EAGL,kBAAkB,GACnB,MAAM,gCAAgC,CAAA;AACvC,OAAO,EAGL,uBAAuB,GACxB,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAA6B,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,EAEL,gBAAgB,GACjB,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAEL,yBAAyB,GAC1B,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EAA0B,OAAO,EAAE,MAAM,mBAAmB,CAAA;AACnE,OAAO,EAA8B,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAC/E,OAAO,EAEL,iBAAiB,GAClB,MAAM,6BAA6B,CAAA;AACpC,OAAO,EAEL,cAAc,GACf,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAEL,yBAAyB,GAC1B,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EAEL,qBAAqB,GACtB,MAAM,iCAAiC,CAAA;AACxC,OAAO,EAA2B,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,EAEL,YAAY,GACb,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAC7C,OAAO,EAGL,WAAW,GACZ,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAGL,aAAa,GACd,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAGL,gBAAgB,GACjB,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAEL,wBAAwB,GACzB,MAAM,oCAAoC,CAAA;AAC3C,OAAO,EAEL,WAAW,GACZ,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAGL,eAAe,GAChB,MAAM,6BAA6B,CAAA;AACpC,OAAO,EAGL,UAAU,GACX,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAGL,aAAa,GACd,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAGL,eAAe,GAChB,MAAM,6BAA6B,CAAA;AACpC,OAAO,EAGL,UAAU,GACX,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAGL,kBAAkB,GACnB,MAAM,gCAAgC,CAAA;AACvC,OAAO,EAGL,aAAa,GACd,MAAM,2BAA2B,CAAA"}

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

@@ -10,19 +10,46 @@ import { getChainContractAddress } from '../../utils/chain.js';
 import { numberToHex } from '../../utils/encoding/toHex.js';
 import { getCallError } from '../../utils/errors/getCallError.js';
 import { extract } from '../../utils/formatters/extract.js';
-import { format } from '../../utils/formatters/format.js';
 import { formatTransactionRequest, } from '../../utils/formatters/transactionRequest.js';
 import { createBatchScheduler } from '../../utils/promise/createBatchScheduler.js';
 import { assertRequest } from '../../utils/transaction/assertRequest.js';
+/**
+ * Executes a new message call immediately without submitting a transaction to the network.
+ *
+ * - Docs: https://viem.sh/docs/actions/public/call.html
+ * - JSON-RPC Methods: [`eth_call`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_call)
+ *
+ * @param client - Client to use
+ * @param parameters - {@link CallParameters}
+ * @returns The call data. {@link CallReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { call } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const data = await call(client, {
+ *   account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+ *   data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
+ *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ * })
+ */
 export async function call(client, args) {
-    const { account: account_, batch = Boolean(client.batch?.multicall), blockNumber, blockTag = 'latest', accessList, data, gas, gasPrice, maxFeePerGas, maxPriorityFeePerGas, nonce, to, value, ...rest } = args;
+    const { account: account_ = client.account, batch = Boolean(client.batch?.multicall), blockNumber, blockTag = 'latest', accessList, data, gas, gasPrice, maxFeePerGas, maxPriorityFeePerGas, nonce, to, value, ...rest } = args;
     const account = account_ ? parseAccount(account_) : undefined;
     try {
         assertRequest(args);
         const blockNumberHex = blockNumber ? numberToHex(blockNumber) : undefined;
         const block = blockNumberHex || blockTag;
-        const formatter = client.chain?.formatters?.transactionRequest;
+        const format = client.chain?.formatters?.transactionRequest?.format ||
+            formatTransactionRequest;
         const request = format({
+            // Pick out extra data that might exist on the chain's transaction request type.
+            ...extract(rest, { format }),
             from: account?.address,
             accessList,
             data,
@@ -33,9 +60,6 @@ export async function call(client, args) {
             nonce,
             to,
             value,
-            ...extract(rest, { formatter }),
-        }, {
-            formatter: formatter || formatTransactionRequest,
         });
         if (batch && shouldPerformMulticall({ request })) {
             try {
@@ -74,6 +98,11 @@ export async function call(client, args) {
         });
     }
 }
+// We only want to perform a scheduled multicall if:
+// - The request has calldata,
+// - The request has a target address,
+// - The target address is not already the aggregate3 signature,
+// - The request has no other properties (`nonce`, `gas`, etc cannot be sent with a multicall).
 function shouldPerformMulticall({ request }) {
     const { data, to, ...request_ } = request;
     if (!data)
@@ -87,7 +116,7 @@ function shouldPerformMulticall({ request }) {
     return true;
 }
 async function scheduleMulticall(client, args) {
-    const { batchSize = 1024, wait = 0 } = typeof client.batch?.multicall === 'object' ? client.batch?.multicall : {};
+    const { batchSize = 1024, wait = 0 } = typeof client.batch?.multicall === 'object' ? client.batch.multicall : {};
     const { blockNumber, blockTag = 'latest', data, multicallAddress: multicallAddress_, to, } = args;
     let multicallAddress = multicallAddress_;
     if (!multicallAddress) {

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

@@ -1 +1 @@
-{"version":3,"file":"call.js","sourceRoot":"","sources":["../../../../src/actions/public/call.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAA;AAGnE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAA;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,EACL,2BAA2B,EAC3B,6BAA6B,GAC9B,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAQ3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAA;AAC9E,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAA;AAC1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAA;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAA;AAC3D,OAAO,EAAkB,MAAM,EAAE,MAAM,kCAAkC,CAAA;AACzE,OAAO,EAEL,wBAAwB,GACzB,MAAM,8CAA8C,CAAA;AACrD,OAAO,EAAE,oBAAoB,EAAE,MAAM,6CAA6C,CAAA;AAClF,OAAO,EAAE,aAAa,EAAE,MAAM,0CAA0C,CAAA;AAyDxE,MAAM,CAAC,KAAK,UAAU,IAAI,CACxB,MAAuC,EACvC,IAA4B;IAE5B,MAAM,EACJ,OAAO,EAAE,QAAQ,EACjB,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,EACxC,WAAW,EACX,QAAQ,GAAG,QAAQ,EACnB,UAAU,EACV,IAAI,EACJ,GAAG,EACH,QAAQ,EACR,YAAY,EACZ,oBAAoB,EACpB,KAAK,EACL,EAAE,EACF,KAAK,EACL,GAAG,IAAI,EACR,GAAG,IAAI,CAAA;IACR,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAE7D,IAAI;QACF,aAAa,CAAC,IAAI,CAAC,CAAA;QAEnB,MAAM,cAAc,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QACzE,MAAM,KAAK,GAAG,cAAc,IAAI,QAAQ,CAAA;QAExC,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,kBAAkB,CAAA;QAC9D,MAAM,OAAO,GAAG,MAAM,CACpB;YACE,IAAI,EAAE,OAAO,EAAE,OAAO;YACtB,UAAU;YACV,IAAI;YACJ,GAAG;YACH,QAAQ;YACR,YAAY;YACZ,oBAAoB;YACpB,KAAK;YACL,EAAE;YACF,KAAK;YAEL,GAAG,OAAO,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,CAAC;SACV,EACvB;YACE,SAAS,EAAE,SAAS,IAAI,wBAAwB;SACjD,CACoB,CAAA;QAEvB,IAAI,KAAK,IAAI,sBAAsB,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE;YAChD,IAAI;gBACF,OAAO,MAAM,iBAAiB,CAAC,MAAM,EAAE;oBACrC,GAAG,OAAO;oBACV,WAAW;oBACX,QAAQ;iBACyC,CAAC,CAAA;aACrD;YAAC,OAAO,GAAG,EAAE;gBACZ,IACE,CAAC,CAAC,GAAG,YAAY,6BAA6B,CAAC;oBAC/C,CAAC,CAAC,GAAG,YAAY,2BAA2B,CAAC;oBAE7C,MAAM,GAAG,CAAA;aACZ;SACF;QAED,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YACpC,MAAM,EAAE,UAAU;YAClB,MAAM,EAAE,KAAK;gBACX,CAAC,CAAC,CAAC,OAAyC,EAAE,KAAK,CAAC;gBACpD,CAAC,CAAC,CAAC,OAAyC,CAAC;SAChD,CAAC,CAAA;QACF,IAAI,QAAQ,KAAK,IAAI;YAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAA;QACjD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;KAC1B;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAI,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAA;QACpC,MAAM,EAAE,cAAc,EAAE,uBAAuB,EAAE,GAAG,MAAM,MAAM,CAC9D,qBAAqB,CACtB,CAAA;QACD,IAAI,IAAI,EAAE,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,uBAAuB,IAAI,EAAE,EAAE;YACxD,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,EAAE,CAAA;SAC5D;QACD,MAAM,YAAY,CAAC,GAAgB,EAAE;YACnC,GAAG,IAAI;YACP,OAAO;YACP,KAAK,EAAE,MAAM,CAAC,KAAK;SACpB,CAAC,CAAA;KACH;AACH,CAAC;AAOD,SAAS,sBAAsB,CAAC,EAAE,OAAO,EAAmC;IAC1E,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,QAAQ,EAAE,GAAG,OAAO,CAAA;IACzC,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAA;IACvB,IAAI,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;QAAE,OAAO,KAAK,CAAA;IACtD,IAAI,CAAC,EAAE;QAAE,OAAO,KAAK,CAAA;IACrB,IACE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC;QAE1E,OAAO,KAAK,CAAA;IACd,OAAO,IAAI,CAAA;AACb,CAAC;AAWD,KAAK,UAAU,iBAAiB,CAC9B,MAAuC,EACvC,IAAyC;IAEzC,MAAM,EAAE,SAAS,GAAG,IAAI,EAAE,IAAI,GAAG,CAAC,EAAE,GAClC,OAAO,MAAM,CAAC,KAAK,EAAE,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAA;IAC5E,MAAM,EACJ,WAAW,EACX,QAAQ,GAAG,QAAQ,EACnB,IAAI,EACJ,gBAAgB,EAAE,iBAAiB,EACnC,EAAE,GACH,GAAG,IAAI,CAAA;IAER,IAAI,gBAAgB,GAAG,iBAAiB,CAAA;IACxC,IAAI,CAAC,gBAAgB,EAAE;QACrB,IAAI,CAAC,MAAM,CAAC,KAAK;YAAE,MAAM,IAAI,6BAA6B,EAAE,CAAA;QAE5D,gBAAgB,GAAG,uBAAuB,CAAC;YACzC,WAAW;YACX,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,QAAQ,EAAE,YAAY;SACvB,CAAC,CAAA;KACH;IAED,MAAM,cAAc,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACzE,MAAM,KAAK,GAAG,cAAc,IAAI,QAAQ,CAAA;IAExC,MAAM,EAAE,QAAQ,EAAE,GAAG,oBAAoB,CAAC;QACxC,EAAE,EAAE,GAAG,MAAM,CAAC,GAAG,IAAI,KAAK,EAAE;QAC5B,IAAI;QACJ,gBAAgB,CAAC,IAAI;YACnB,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;YACzE,OAAO,IAAI,GAAG,SAAS,GAAG,CAAC,CAAA;QAC7B,CAAC;QACD,EAAE,EAAE,KAAK,EACP,QAGG,EACH,EAAE;YACF,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;gBACvC,YAAY,EAAE,IAAI;gBAClB,QAAQ,EAAE,OAAO,CAAC,IAAI;gBACtB,MAAM,EAAE,OAAO,CAAC,EAAE;aACnB,CAAC,CAAC,CAAA;YAEH,MAAM,QAAQ,GAAG,kBAAkB,CAAC;gBAClC,GAAG,EAAE,aAAa;gBAClB,IAAI,EAAE,CAAC,KAAK,CAAC;gBACb,YAAY,EAAE,YAAY;aAC3B,CAAC,CAAA;YAEF,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;gBAChC,MAAM,EAAE,UAAU;gBAClB,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,QAAQ;wBACd,EAAE,EAAE,gBAAgB;qBACrB;oBACD,KAAK;iBACN;aACF,CAAC,CAAA;YAEF,OAAO,oBAAoB,CAAC;gBAC1B,GAAG,EAAE,aAAa;gBAClB,IAAI,EAAE,CAAC,KAAK,CAAC;gBACb,YAAY,EAAE,YAAY;gBAC1B,IAAI,EAAE,IAAI,IAAI,IAAI;aACnB,CAAC,CAAA;QACJ,CAAC;KACF,CAAC,CAAA;IAEF,MAAM,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC,GAAG,MAAM,QAAQ,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAA;IAE9D,IAAI,CAAC,OAAO;QAAE,MAAM,IAAI,gBAAgB,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAA;IAC9D,IAAI,UAAU,KAAK,IAAI;QAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAA;IACnD,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAA;AAC7B,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,GAAY;IAC7C,IAAI,CAAC,CAAC,GAAG,YAAY,SAAS,CAAC;QAAE,OAAO,SAAS,CAAA;IACjD,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,EAAsB,CAAA;IAC5C,OAAO,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAA;AACtE,CAAC"}
+{"version":3,"file":"call.js","sourceRoot":"","sources":["../../../../src/actions/public/call.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAA;AAGnE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAA;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,EACL,2BAA2B,EAC3B,6BAA6B,GAC9B,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAO3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAA;AAC9E,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAA;AAC1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAA;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAA;AAC3D,OAAO,EAEL,wBAAwB,GACzB,MAAM,8CAA8C,CAAA;AACrD,OAAO,EAAE,oBAAoB,EAAE,MAAM,6CAA6C,CAAA;AAClF,OAAO,EAAE,aAAa,EAAE,MAAM,0CAA0C,CAAA;AA8BxE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CACxB,MAAiC,EACjC,IAA4B;IAE5B,MAAM,EACJ,OAAO,EAAE,QAAQ,GAAG,MAAM,CAAC,OAAO,EAClC,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,EACxC,WAAW,EACX,QAAQ,GAAG,QAAQ,EACnB,UAAU,EACV,IAAI,EACJ,GAAG,EACH,QAAQ,EACR,YAAY,EACZ,oBAAoB,EACpB,KAAK,EACL,EAAE,EACF,KAAK,EACL,GAAG,IAAI,EACR,GAAG,IAAI,CAAA;IACR,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAE7D,IAAI;QACF,aAAa,CAAC,IAA+B,CAAC,CAAA;QAE9C,MAAM,cAAc,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QACzE,MAAM,KAAK,GAAG,cAAc,IAAI,QAAQ,CAAA;QAExC,MAAM,MAAM,GACV,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM;YACpD,wBAAwB,CAAA;QAC1B,MAAM,OAAO,GAAG,MAAM,CAAC;YACrB,gFAAgF;YAChF,GAAG,OAAO,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC;YAC5B,IAAI,EAAE,OAAO,EAAE,OAAO;YACtB,UAAU;YACV,IAAI;YACJ,GAAG;YACH,QAAQ;YACR,YAAY;YACZ,oBAAoB;YACpB,KAAK;YACL,EAAE;YACF,KAAK;SACgB,CAAuB,CAAA;QAE9C,IAAI,KAAK,IAAI,sBAAsB,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE;YAChD,IAAI;gBACF,OAAO,MAAM,iBAAiB,CAAC,MAAM,EAAE;oBACrC,GAAG,OAAO;oBACV,WAAW;oBACX,QAAQ;iBACyC,CAAC,CAAA;aACrD;YAAC,OAAO,GAAG,EAAE;gBACZ,IACE,CAAC,CAAC,GAAG,YAAY,6BAA6B,CAAC;oBAC/C,CAAC,CAAC,GAAG,YAAY,2BAA2B,CAAC;oBAE7C,MAAM,GAAG,CAAA;aACZ;SACF;QAED,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YACpC,MAAM,EAAE,UAAU;YAClB,MAAM,EAAE,KAAK;gBACX,CAAC,CAAC,CAAC,OAAyC,EAAE,KAAK,CAAC;gBACpD,CAAC,CAAC,CAAC,OAAyC,CAAC;SAChD,CAAC,CAAA;QACF,IAAI,QAAQ,KAAK,IAAI;YAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAA;QACjD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;KAC1B;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAI,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAA;QACpC,MAAM,EAAE,cAAc,EAAE,uBAAuB,EAAE,GAAG,MAAM,MAAM,CAC9D,qBAAqB,CACtB,CAAA;QACD,IAAI,IAAI,EAAE,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,uBAAuB,IAAI,EAAE,EAAE;YACxD,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,EAAE,CAAA;SAC5D;QACD,MAAM,YAAY,CAAC,GAAgB,EAAE;YACnC,GAAG,IAAI;YACP,OAAO;YACP,KAAK,EAAE,MAAM,CAAC,KAAK;SACpB,CAAC,CAAA;KACH;AACH,CAAC;AAED,oDAAoD;AACpD,8BAA8B;AAC9B,sCAAsC;AACtC,gEAAgE;AAChE,+FAA+F;AAC/F,SAAS,sBAAsB,CAAC,EAAE,OAAO,EAAmC;IAC1E,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,QAAQ,EAAE,GAAG,OAAO,CAAA;IACzC,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAA;IACvB,IAAI,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;QAAE,OAAO,KAAK,CAAA;IACtD,IAAI,CAAC,EAAE;QAAE,OAAO,KAAK,CAAA;IACrB,IACE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC;QAE1E,OAAO,KAAK,CAAA;IACd,OAAO,IAAI,CAAA;AACb,CAAC;AAWD,KAAK,UAAU,iBAAiB,CAC9B,MAAyB,EACzB,IAAyC;IAEzC,MAAM,EAAE,SAAS,GAAG,IAAI,EAAE,IAAI,GAAG,CAAC,EAAE,GAClC,OAAO,MAAM,CAAC,KAAK,EAAE,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAA;IAC3E,MAAM,EACJ,WAAW,EACX,QAAQ,GAAG,QAAQ,EACnB,IAAI,EACJ,gBAAgB,EAAE,iBAAiB,EACnC,EAAE,GACH,GAAG,IAAI,CAAA;IAER,IAAI,gBAAgB,GAAG,iBAAiB,CAAA;IACxC,IAAI,CAAC,gBAAgB,EAAE;QACrB,IAAI,CAAC,MAAM,CAAC,KAAK;YAAE,MAAM,IAAI,6BAA6B,EAAE,CAAA;QAE5D,gBAAgB,GAAG,uBAAuB,CAAC;YACzC,WAAW;YACX,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,QAAQ,EAAE,YAAY;SACvB,CAAC,CAAA;KACH;IAED,MAAM,cAAc,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACzE,MAAM,KAAK,GAAG,cAAc,IAAI,QAAQ,CAAA;IAExC,MAAM,EAAE,QAAQ,EAAE,GAAG,oBAAoB,CAAC;QACxC,EAAE,EAAE,GAAG,MAAM,CAAC,GAAG,IAAI,KAAK,EAAE;QAC5B,IAAI;QACJ,gBAAgB,CAAC,IAAI;YACnB,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;YACzE,OAAO,IAAI,GAAG,SAAS,GAAG,CAAC,CAAA;QAC7B,CAAC;QACD,EAAE,EAAE,KAAK,EACP,QAGG,EACH,EAAE;YACF,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;gBACvC,YAAY,EAAE,IAAI;gBAClB,QAAQ,EAAE,OAAO,CAAC,IAAI;gBACtB,MAAM,EAAE,OAAO,CAAC,EAAE;aACnB,CAAC,CAAC,CAAA;YAEH,MAAM,QAAQ,GAAG,kBAAkB,CAAC;gBAClC,GAAG,EAAE,aAAa;gBAClB,IAAI,EAAE,CAAC,KAAK,CAAC;gBACb,YAAY,EAAE,YAAY;aAC3B,CAAC,CAAA;YAEF,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;gBAChC,MAAM,EAAE,UAAU;gBAClB,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,QAAQ;wBACd,EAAE,EAAE,gBAAgB;qBACrB;oBACD,KAAK;iBACN;aACF,CAAC,CAAA;YAEF,OAAO,oBAAoB,CAAC;gBAC1B,GAAG,EAAE,aAAa;gBAClB,IAAI,EAAE,CAAC,KAAK,CAAC;gBACb,YAAY,EAAE,YAAY;gBAC1B,IAAI,EAAE,IAAI,IAAI,IAAI;aACnB,CAAC,CAAA;QACJ,CAAC;KACF,CAAC,CAAA;IAEF,MAAM,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC,GAAG,MAAM,QAAQ,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAA;IAE9D,IAAI,CAAC,OAAO;QAAE,MAAM,IAAI,gBAAgB,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAA;IAC9D,IAAI,UAAU,KAAK,IAAI;QAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAA;IACnD,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAA;AAC7B,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,GAAY;IAC7C,IAAI,CAAC,CAAC,GAAG,YAAY,SAAS,CAAC;QAAE,OAAO,SAAS,CAAA;IACjD,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,EAAsB,CAAA;IAC5C,OAAO,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAA;AACtE,CAAC"}

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

@@ -1,4 +1,25 @@
 import { createFilterRequestScope } from '../../utils/filters/createFilterRequestScope.js';
+/**
+ * Creates a [`Filter`](https://viem.sh/docs/glossary/types.html#filter) to listen for new block hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges.html).
+ *
+ * - Docs: https://viem.sh/docs/actions/public/createBlockFilter.html
+ * - JSON-RPC Methods: [`eth_newBlockFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newBlockFilter)
+ *
+ * @param client - Client to use
+ * @returns [`Filter`](https://viem.sh/docs/glossary/types.html#filter). {@link CreateBlockFilterReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { createBlockFilter } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const filter = await createBlockFilter(client)
+ * // { id: "0x345a6572337856574a76364e457a4366", type: 'block' }
+ */
 export async function createBlockFilter(client) {
     const getRequest = createFilterRequestScope(client, {
         method: 'eth_newBlockFilter',

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

@@ -1 +1 @@
-{"version":3,"file":"createBlockFilter.js","sourceRoot":"","sources":["../../../../src/actions/public/createBlockFilter.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,wBAAwB,EAAE,MAAM,iDAAiD,CAAA;AAyB1F,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,MAAuC;IAEvC,MAAM,UAAU,GAAG,wBAAwB,CAAC,MAAM,EAAE;QAClD,MAAM,EAAE,oBAAoB;KAC7B,CAAC,CAAA;IACF,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAC9B,MAAM,EAAE,oBAAoB;KAC7B,CAAC,CAAA;IACF,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAA;AACvD,CAAC"}
+{"version":3,"file":"createBlockFilter.js","sourceRoot":"","sources":["../../../../src/actions/public/createBlockFilter.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,wBAAwB,EAAE,MAAM,iDAAiD,CAAA;AAI1F;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,MAAiC;IAEjC,MAAM,UAAU,GAAG,wBAAwB,CAAC,MAAM,EAAE;QAClD,MAAM,EAAE,oBAAoB;KAC7B,CAAC,CAAA;IACF,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAC9B,MAAM,EAAE,oBAAoB;KAC7B,CAAC,CAAA;IACF,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAA;AACvD,CAAC"}

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

@@ -1,7 +1,29 @@
 import { encodeEventTopics, } from '../../utils/abi/encodeEventTopics.js';
 import { numberToHex } from '../../utils/encoding/toHex.js';
 import { createFilterRequestScope } from '../../utils/filters/createFilterRequestScope.js';
-export async function createContractEventFilter(client, { address, abi, args, eventName, fromBlock, toBlock, }) {
+/**
+ * Creates a Filter to retrieve event logs that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges.html) or [`getFilterLogs`](https://viem.sh/docs/actions/public/getFilterLogs.html).
+ *
+ * - Docs: https://viem.sh/docs/contract/createContractEventFilter.html
+ *
+ * @param client - Client to use
+ * @param parameters - {@link CreateContractEventFilterParameters}
+ * @returns [`Filter`](https://viem.sh/docs/glossary/types.html#filter). {@link CreateContractEventFilterReturnType}
+ *
+ * @example
+ * import { createPublicClient, http, parseAbi } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { createContractEventFilter } from 'viem/contract'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const filter = await createContractEventFilter(client, {
+ *   abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']),
+ * })
+ */
+export async function createContractEventFilter(client, { address, abi, args, eventName, fromBlock, strict, toBlock, }) {
     const getRequest = createFilterRequestScope(client, {
         method: 'eth_newFilter',
     });
@@ -29,6 +51,7 @@ export async function createContractEventFilter(client, { address, abi, args, ev
         eventName,
         id,
         request: getRequest(id),
+        strict,
         type: 'event',
     };
 }

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

@@ -1 +1 @@
-{"version":3,"file":"createContractEventFilter.js","sourceRoot":"","sources":["../../../../src/actions/public/createContractEventFilter.ts"],"names":[],"mappings":"AAWA,OAAO,EAEL,iBAAiB,GAClB,MAAM,sCAAsC,CAAA;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAAE,wBAAwB,EAAE,MAAM,iDAAiD,CAAA;AA2D1F,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAM7C,MAAuC,EACvC,EACE,OAAO,EACP,GAAG,EACH,IAAI,EACJ,SAAS,EACT,SAAS,EACT,OAAO,GACsD;IAE/D,MAAM,UAAU,GAAG,wBAAwB,CAAC,MAAM,EAAE;QAClD,MAAM,EAAE,eAAe;KACxB,CAAC,CAAA;IAEF,MAAM,MAAM,GAAG,SAAS;QACtB,CAAC,CAAC,iBAAiB,CAAC;YAChB,GAAG;YACH,IAAI;YACJ,SAAS;SACgC,CAAC;QAC9C,CAAC,CAAC,SAAS,CAAA;IACb,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAC9B,MAAM,EAAE,eAAe;QACvB,MAAM,EAAE;YACN;gBACE,OAAO;gBACP,SAAS,EACP,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;gBACpE,OAAO,EAAE,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO;gBACrE,MAAM;aACP;SACF;KACF,CAAC,CAAA;IAEF,OAAO;QACL,GAAG;QACH,IAAI;QACJ,SAAS;QACT,EAAE;QACF,OAAO,EAAE,UAAU,CAAC,EAAE,CAAC;QACvB,IAAI,EAAE,OAAO;KAC6D,CAAA;AAC9E,CAAC"}
+{"version":3,"file":"createContractEventFilter.js","sourceRoot":"","sources":["../../../../src/actions/public/createContractEventFilter.ts"],"names":[],"mappings":"AAYA,OAAO,EAEL,iBAAiB,GAClB,MAAM,sCAAsC,CAAA;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAAE,wBAAwB,EAAE,MAAM,iDAAiD,CAAA;AAgD1F;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAS7C,MAAiC,EACjC,EACE,OAAO,EACP,GAAG,EACH,IAAI,EACJ,SAAS,EACT,SAAS,EACT,MAAM,EACN,OAAO,GAQR;IAWD,MAAM,UAAU,GAAG,wBAAwB,CAAC,MAAM,EAAE;QAClD,MAAM,EAAE,eAAe;KACxB,CAAC,CAAA;IAEF,MAAM,MAAM,GAAG,SAAS;QACtB,CAAC,CAAC,iBAAiB,CAAC;YAChB,GAAG;YACH,IAAI;YACJ,SAAS;SACgC,CAAC;QAC9C,CAAC,CAAC,SAAS,CAAA;IACb,MAAM,EAAE,GAAQ,MAAM,MAAM,CAAC,OAAO,CAAC;QACnC,MAAM,EAAE,eAAe;QACvB,MAAM,EAAE;YACN;gBACE,OAAO;gBACP,SAAS,EACP,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;gBACpE,OAAO,EAAE,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO;gBACrE,MAAM;aACP;SACF;KACF,CAAC,CAAA;IAEF,OAAO;QACL,GAAG;QACH,IAAI;QACJ,SAAS;QACT,EAAE;QACF,OAAO,EAAE,UAAU,CAAC,EAAE,CAAC;QACvB,MAAM;QACN,IAAI,EAAE,OAAO;KAQd,CAAA;AACH,CAAC"}

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

@@ -1,17 +1,46 @@
 import { encodeEventTopics, } from '../../utils/abi/encodeEventTopics.js';
 import { numberToHex } from '../../utils/encoding/toHex.js';
 import { createFilterRequestScope } from '../../utils/filters/createFilterRequestScope.js';
-export async function createEventFilter(client, { address, args, event, fromBlock, toBlock, } = {}) {
+/**
+ * Creates a [`Filter`](https://viem.sh/docs/glossary/types.html#filter) to listen for new events that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges.html).
+ *
+ * - Docs: https://viem.sh/docs/actions/public/createEventFilter.html
+ * - JSON-RPC Methods: [`eth_newFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newfilter)
+ *
+ * @param client - Client to use
+ * @param parameters - {@link CreateEventFilterParameters}
+ * @returns [`Filter`](https://viem.sh/docs/glossary/types.html#filter). {@link CreateEventFilterReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { createEventFilter } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const filter = await createEventFilter(client, {
+ *   address: '0xfba3912ca04dd458c843e2ee08967fc04f3579c2',
+ * })
+ */
+export async function createEventFilter(client, { address, args, event, events: events_, fromBlock, strict, toBlock, } = {}) {
+    const events = events_ ?? (event ? [event] : undefined);
     const getRequest = createFilterRequestScope(client, {
         method: 'eth_newFilter',
     });
     let topics = [];
-    if (event)
-        topics = encodeEventTopics({
-            abi: [event],
-            eventName: event.name,
-            args,
-        });
+    if (events) {
+        topics = [
+            events.flatMap((event) => encodeEventTopics({
+                abi: [event],
+                eventName: event.name,
+                args,
+            })),
+        ];
+        if (event)
+            topics = topics[0];
+    }
     const id = await client.request({
         method: 'eth_newFilter',
         params: [
@@ -24,11 +53,14 @@ export async function createEventFilter(client, { address, args, event, fromBloc
         ],
     });
     return {
-        abi: event ? [event] : undefined,
+        abi: events,
         args,
         eventName: event ? event.name : undefined,
+        fromBlock,
         id,
         request: getRequest(id),
+        strict,
+        toBlock,
         type: 'event',
     };
 }

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

@@ -1 +1 @@
-{"version":3,"file":"createEventFilter.js","sourceRoot":"","sources":["../../../../src/actions/public/createEventFilter.ts"],"names":[],"mappings":"AAaA,OAAO,EAEL,iBAAiB,GAClB,MAAM,sCAAsC,CAAA;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAAE,wBAAwB,EAAE,MAAM,iDAAiD,CAAA;AAqE1F,MAAM,CAAC,KAAK,UAAU,iBAAiB,CASrC,MAAuC,EACvC,EACE,OAAO,EACP,IAAI,EACJ,KAAK,EACL,SAAS,EACT,OAAO,MAML,EAAS;IAEb,MAAM,UAAU,GAAG,wBAAwB,CAAC,MAAM,EAAE;QAClD,MAAM,EAAE,eAAe;KACxB,CAAC,CAAA;IAEF,IAAI,MAAM,GAAe,EAAE,CAAA;IAC3B,IAAI,KAAK;QACP,MAAM,GAAG,iBAAiB,CAAC;YACzB,GAAG,EAAE,CAAC,KAAK,CAAC;YACZ,SAAS,EAAG,KAAkB,CAAC,IAAI;YACnC,IAAI;SAC0B,CAAC,CAAA;IAEnC,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAC9B,MAAM,EAAE,eAAe;QACvB,MAAM,EAAE;YACN;gBACE,OAAO;gBACP,SAAS,EACP,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;gBACpE,OAAO,EAAE,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO;gBACrE,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACrC;SACF;KACF,CAAC,CAAA;IAEF,OAAO;QACL,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS;QAChC,IAAI;QACJ,SAAS,EAAE,KAAK,CAAC,CAAC,CAAE,KAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;QACvD,EAAE;QACF,OAAO,EAAE,UAAU,CAAC,EAAE,CAAC;QACvB,IAAI,EAAE,OAAO;KAMd,CAAA;AACH,CAAC"}
+{"version":3,"file":"createEventFilter.js","sourceRoot":"","sources":["../../../../src/actions/public/createEventFilter.ts"],"names":[],"mappings":"AAaA,OAAO,EAEL,iBAAiB,GAClB,MAAM,sCAAsC,CAAA;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAAE,wBAAwB,EAAE,MAAM,iDAAiD,CAAA;AAsF1F;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAerC,MAAiC,EACjC,EACE,OAAO,EACP,IAAI,EACJ,KAAK,EACL,MAAM,EAAE,OAAO,EACf,SAAS,EACT,MAAM,EACN,OAAO,MASL,EAAS;IAYb,MAAM,MAAM,GAAG,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;IAEvD,MAAM,UAAU,GAAG,wBAAwB,CAAC,MAAM,EAAE;QAClD,MAAM,EAAE,eAAe;KACxB,CAAC,CAAA;IAEF,IAAI,MAAM,GAAe,EAAE,CAAA;IAC3B,IAAI,MAAM,EAAE;QACV,MAAM,GAAG;YACN,MAAqB,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CACvC,iBAAiB,CAAC;gBAChB,GAAG,EAAE,CAAC,KAAK,CAAC;gBACZ,SAAS,EAAG,KAAkB,CAAC,IAAI;gBACnC,IAAI;aAC0B,CAAC,CAClC;SACF,CAAA;QACD,IAAI,KAAK;YAAE,MAAM,GAAG,MAAM,CAAC,CAAC,CAAe,CAAA;KAC5C;IAED,MAAM,EAAE,GAAQ,MAAM,MAAM,CAAC,OAAO,CAAC;QACnC,MAAM,EAAE,eAAe;QACvB,MAAM,EAAE;YACN;gBACE,OAAO;gBACP,SAAS,EACP,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;gBACpE,OAAO,EAAE,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO;gBACrE,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACrC;SACF;KACF,CAAC,CAAA;IAEF,OAAO;QACL,GAAG,EAAE,MAAM;QACX,IAAI;QACJ,SAAS,EAAE,KAAK,CAAC,CAAC,CAAE,KAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;QACvD,SAAS;QACT,EAAE;QACF,OAAO,EAAE,UAAU,CAAC,EAAE,CAAC;QACvB,MAAM;QACN,OAAO;QACP,IAAI,EAAE,OAAO;KASd,CAAA;AACH,CAAC"}

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

@@ -1,4 +1,25 @@
 import { createFilterRequestScope } from '../../utils/filters/createFilterRequestScope.js';
+/**
+ * Creates a Filter to listen for new pending transaction hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges.html).
+ *
+ * - Docs: https://viem.sh/docs/actions/public/createPendingTransactionFilter.html
+ * - JSON-RPC Methods: [`eth_newPendingTransactionFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newpendingtransactionfilter)
+ *
+ * @param client - Client to use
+ * @returns [`Filter`](https://viem.sh/docs/glossary/types.html#filter). {@link CreateBlockFilterReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { createPendingTransactionFilter } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const filter = await createPendingTransactionFilter(client)
+ * // { id: "0x345a6572337856574a76364e457a4366", type: 'transaction' }
+ */
 export async function createPendingTransactionFilter(client) {
     const getRequest = createFilterRequestScope(client, {
         method: 'eth_newPendingTransactionFilter',

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

@@ -1 +1 @@
-{"version":3,"file":"createPendingTransactionFilter.js","sourceRoot":"","sources":["../../../../src/actions/public/createPendingTransactionFilter.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,wBAAwB,EAAE,MAAM,iDAAiD,CAAA;AAyB1F,MAAM,CAAC,KAAK,UAAU,8BAA8B,CAIlD,MAAwC;IAExC,MAAM,UAAU,GAAG,wBAAwB,CAAC,MAAM,EAAE;QAClD,MAAM,EAAE,iCAAiC;KAC1C,CAAC,CAAA;IACF,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAC9B,MAAM,EAAE,iCAAiC;KAC1C,CAAC,CAAA;IACF,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAA;AAC7D,CAAC"}
+{"version":3,"file":"createPendingTransactionFilter.js","sourceRoot":"","sources":["../../../../src/actions/public/createPendingTransactionFilter.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,wBAAwB,EAAE,MAAM,iDAAiD,CAAA;AAI1F;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,8BAA8B,CAIlD,MAAkC;IAElC,MAAM,UAAU,GAAG,wBAAwB,CAAC,MAAM,EAAE;QAClD,MAAM,EAAE,iCAAiC;KAC1C,CAAC,CAAA;IACF,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAC9B,MAAM,EAAE,iCAAiC;KAC1C,CAAC,CAAA;IACF,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAA;AAC7D,CAAC"}

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

@@ -2,8 +2,34 @@ import { parseAccount } from '../../accounts/utils/parseAccount.js';
 import { encodeFunctionData, } from '../../utils/abi/encodeFunctionData.js';
 import { getContractError } from '../../utils/errors/getContractError.js';
 import { estimateGas } from './estimateGas.js';
+/**
+ * Estimates the gas required to successfully execute a contract write function call.
+ *
+ * - Docs: https://viem.sh/docs/contract/estimateContractGas.html
+ *
+ * Internally, uses a [Public Client](https://viem.sh/docs/clients/public.html) to call the [`estimateGas` action](https://viem.sh/docs/actions/public/estimateGas.html) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData.html).
+ *
+ * @param client - Client to use
+ * @param parameters - {@link EstimateContractGasParameters}
+ * @returns The gas estimate (in wei). {@link EstimateContractGasReturnType}
+ *
+ * @example
+ * import { createPublicClient, http, parseAbi } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { estimateContractGas } from 'viem/contract'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const gas = await estimateContractGas(client, {
+ *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+ *   abi: parseAbi(['function mint() public']),
+ *   functionName: 'mint',
+ *   account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+ * })
+ */
 export async function estimateContractGas(client, { abi, address, args, functionName, ...request }) {
-    const account = parseAccount(request.account);
     const data = encodeFunctionData({
         abi,
         args,
@@ -18,11 +44,12 @@ export async function estimateContractGas(client, { abi, address, args, function
         return gas;
     }
     catch (err) {
+        const account = request.account ? parseAccount(request.account) : undefined;
         throw getContractError(err, {
             abi: abi,
             address,
             args,
-            docsPath: '/docs/contract/simulateContract',
+            docsPath: '/docs/contract/estimateContractGas',
             functionName,
             sender: account?.address,
         });

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

@@ -1 +1 @@
-{"version":3,"file":"estimateContractGas.js","sourceRoot":"","sources":["../../../../src/actions/public/estimateContractGas.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAA;AAMnE,OAAO,EAEL,kBAAkB,GACnB,MAAM,uCAAuC,CAAA;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAA;AAEzE,OAAO,EAA8B,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAuC1E,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAKvC,MAAuC,EACvC,EACE,GAAG,EACH,OAAO,EACP,IAAI,EACJ,YAAY,EACZ,GAAG,OAAO,EACiD;IAE7D,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IAC7C,MAAM,IAAI,GAAG,kBAAkB,CAAC;QAC9B,GAAG;QACH,IAAI;QACJ,YAAY;KACmD,CAAC,CAAA;IAClE,IAAI;QACF,MAAM,GAAG,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE;YACpC,IAAI;YACJ,EAAE,EAAE,OAAO;YACX,GAAG,OAAO;SACiC,CAAC,CAAA;QAC9C,OAAO,GAAG,CAAA;KACX;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,gBAAgB,CAAC,GAAgB,EAAE;YACvC,GAAG,EAAE,GAAU;YACf,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,iCAAiC;YAC3C,YAAY;YACZ,MAAM,EAAE,OAAO,EAAE,OAAO;SACzB,CAAC,CAAA;KACH;AACH,CAAC"}
+{"version":3,"file":"estimateContractGas.js","sourceRoot":"","sources":["../../../../src/actions/public/estimateContractGas.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAA;AAOnE,OAAO,EAEL,kBAAkB,GACnB,MAAM,uCAAuC,CAAA;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAA;AACzE,OAAO,EAA8B,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAmB1E;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAMvC,MAA2C,EAC3C,EACE,GAAG,EACH,OAAO,EACP,IAAI,EACJ,YAAY,EACZ,GAAG,OAAO,EAC2D;IAEvE,MAAM,IAAI,GAAG,kBAAkB,CAAC;QAC9B,GAAG;QACH,IAAI;QACJ,YAAY;KACmD,CAAC,CAAA;IAClE,IAAI;QACF,MAAM,GAAG,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE;YACpC,IAAI;YACJ,EAAE,EAAE,OAAO;YACX,GAAG,OAAO;SACiC,CAAC,CAAA;QAC9C,OAAO,GAAG,CAAA;KACX;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QAC3E,MAAM,gBAAgB,CAAC,GAAgB,EAAE;YACvC,GAAG,EAAE,GAAU;YACf,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,oCAAoC;YAC9C,YAAY;YACZ,MAAM,EAAE,OAAO,EAAE,OAAO;SACzB,CAAC,CAAA;KACH;AACH,CAAC"}