viem 0.0.0-tsc-and-nodenext-20230405154910 → 0.0.0-w-20230711200108

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

@@ -1,12 +1,55 @@
-import { assertRequest, extract, format, formatTransactionRequest, getCallError, numberToHex, parseAccount, } from '../../utils/index.js';
+import { parseAccount } from '../../accounts/utils/parseAccount.js';
+import { multicall3Abi } from '../../constants/abis.js';
+import { aggregate3Signature } from '../../constants/contract.js';
+import { BaseError } from '../../errors/base.js';
+import { ChainDoesNotSupportContract, ClientChainNotConfiguredError, } from '../../errors/chain.js';
+import { RawContractError } from '../../errors/contract.js';
+import { decodeFunctionResult } from '../../utils/abi/decodeFunctionResult.js';
+import { encodeFunctionData } from '../../utils/abi/encodeFunctionData.js';
+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 { 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_, blockNumber, blockTag = 'latest', accessList, data, gas, gasPrice, maxFeePerGas, maxPriorityFeePerGas, nonce, to, value, ...rest } = 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_ ? parseAccount(account_) : undefined;
     try {
         assertRequest(args);
         const blockNumberHex = blockNumber ? numberToHex(blockNumber) : undefined;
-        const formatter = client.chain?.formatters?.transactionRequest;
-        const request_ = format({
+        const block = blockNumberHex || blockTag;
+        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,
@@ -17,20 +60,37 @@ export async function call(client, args) {
             nonce,
             to,
             value,
-            // Pick out extra data that might exist on the chain's transaction request type.
-            ...extract(rest, { formatter }),
-        }, {
-            formatter: formatter || formatTransactionRequest,
         });
+        if (batch && shouldPerformMulticall({ request })) {
+            try {
+                return await scheduleMulticall(client, {
+                    ...request,
+                    blockNumber,
+                    blockTag,
+                });
+            }
+            catch (err) {
+                if (!(err instanceof ClientChainNotConfiguredError) &&
+                    !(err instanceof ChainDoesNotSupportContract))
+                    throw err;
+            }
+        }
         const response = await client.request({
             method: 'eth_call',
-            params: [request_, blockNumberHex || blockTag],
+            params: block
+                ? [request, block]
+                : [request],
         });
         if (response === '0x')
             return { data: undefined };
         return { data: response };
     }
     catch (err) {
+        const data = getRevertErrorData(err);
+        const { offchainLookup, offchainLookupSignature } = await import('../../utils/ccip.js');
+        if (data?.slice(0, 10) === offchainLookupSignature && to) {
+            return { data: await offchainLookup(client, { data, to }) };
+        }
         throw getCallError(err, {
             ...args,
             account,
@@ -38,4 +98,85 @@ 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)
+        return false;
+    if (data.startsWith(aggregate3Signature))
+        return false;
+    if (!to)
+        return false;
+    if (Object.values(request_).filter((x) => typeof x !== 'undefined').length > 0)
+        return false;
+    return true;
+}
+async function scheduleMulticall(client, args) {
+    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) {
+        if (!client.chain)
+            throw new ClientChainNotConfiguredError();
+        multicallAddress = getChainContractAddress({
+            blockNumber,
+            chain: client.chain,
+            contract: 'multicall3',
+        });
+    }
+    const blockNumberHex = blockNumber ? numberToHex(blockNumber) : undefined;
+    const block = blockNumberHex || blockTag;
+    const { schedule } = createBatchScheduler({
+        id: `${client.uid}.${block}`,
+        wait,
+        shouldSplitBatch(args) {
+            const size = args.reduce((size, { data }) => size + (data.length - 2), 0);
+            return size > batchSize * 2;
+        },
+        fn: async (requests) => {
+            const calls = requests.map((request) => ({
+                allowFailure: true,
+                callData: request.data,
+                target: request.to,
+            }));
+            const calldata = encodeFunctionData({
+                abi: multicall3Abi,
+                args: [calls],
+                functionName: 'aggregate3',
+            });
+            const data = await client.request({
+                method: 'eth_call',
+                params: [
+                    {
+                        data: calldata,
+                        to: multicallAddress,
+                    },
+                    block,
+                ],
+            });
+            return decodeFunctionResult({
+                abi: multicall3Abi,
+                args: [calls],
+                functionName: 'aggregate3',
+                data: data || '0x',
+            });
+        },
+    });
+    const [{ returnData, success }] = await schedule({ data, to });
+    if (!success)
+        throw new RawContractError({ data: returnData });
+    if (returnData === '0x')
+        return { data: undefined };
+    return { data: returnData };
+}
+export function getRevertErrorData(err) {
+    if (!(err instanceof BaseError))
+        return undefined;
+    const error = err.walk();
+    return typeof error.data === 'object' ? error.data.data : error.data;
+}
 //# sourceMappingURL=call.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"call.js","sourceRoot":"","sources":["../../../../src/actions/public/call.ts"],"names":[],"mappings":"AAYA,OAAO,EACL,aAAa,EACb,OAAO,EACP,MAAM,EACN,wBAAwB,EACxB,YAAY,EACZ,WAAW,EACX,YAAY,GACb,MAAM,sBAAsB,CAAA;AAgC7B,MAAM,CAAC,KAAK,UAAU,IAAI,CACxB,MAAuC,EACvC,IAA4B;IAE5B,MAAM,EACJ,OAAO,EAAE,QAAQ,EACjB,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,SAAS,GAAG,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,kBAAkB,CAAA;QAC9D,MAAM,QAAQ,GAAG,MAAM,CACrB;YACE,IAAI,EAAE,OAAO,EAAE,OAAO;YACtB,UAAU;YACV,IAAI;YACJ,GAAG;YACH,QAAQ;YACR,YAAY;YACZ,oBAAoB;YACpB,KAAK;YACL,EAAE;YACF,KAAK;YACL,gFAAgF;YAChF,GAAG,OAAO,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,CAAC;SACV,EACvB;YACE,SAAS,EAAE,SAAS,IAAI,wBAAwB;SACjD,CACF,CAAA;QAED,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YACpC,MAAM,EAAE,UAAU;YAClB,MAAM,EAAE,CAAC,QAAQ,EAAE,cAAc,IAAI,QAAQ,CAAC;SAC/C,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,YAAY,CAAC,GAAgB,EAAE;YACnC,GAAG,IAAI;YACP,OAAO;YACP,KAAK,EAAE,MAAM,CAAC,KAAK;SACpB,CAAC,CAAA;KACH;AACH,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,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,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,7 +1,32 @@
+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',
+    });
     const id = await client.request({
         method: 'eth_newBlockFilter',
     });
-    return { id, type: 'block' };
+    return { id, request: getRequest(id), type: 'block' };
 }
 //# sourceMappingURL=createBlockFilter.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"createBlockFilter.js","sourceRoot":"","sources":["../../../../src/actions/public/createBlockFilter.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,MAAuC;IAEvC,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAC9B,MAAM,EAAE,oBAAoB;KAC7B,CAAC,CAAA;IACF,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAA;AAC9B,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,5 +1,32 @@
-import { encodeEventTopics, numberToHex } from '../../utils/index.js';
-export async function createContractEventFilter(client, { address, abi, args, eventName, fromBlock, toBlock, }) {
+import { encodeEventTopics, } from '../../utils/abi/encodeEventTopics.js';
+import { numberToHex } from '../../utils/encoding/toHex.js';
+import { createFilterRequestScope } from '../../utils/filters/createFilterRequestScope.js';
+/**
+ * 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',
+    });
     const topics = eventName
         ? encodeEventTopics({
             abi,
@@ -23,6 +50,8 @@ export async function createContractEventFilter(client, { address, abi, args, ev
         args,
         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":"AAYA,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAsCrE,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAM7C,MAAuC,EACvC,EACE,OAAO,EACP,GAAG,EACH,IAAI,EACJ,SAAS,EACT,SAAS,EACT,OAAO,GACsD;IAE/D,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;IACF,OAAO;QACL,GAAG;QACH,IAAI;QACJ,SAAS;QACT,EAAE;QACF,IAAI,EAAE,OAAO;KAC6D,CAAA;AAC9E,CAAC"}
+{"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;AA4C1F;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAO7C,MAAiC,EACjC,EACE,OAAO,EACP,GAAG,EACH,IAAI,EACJ,SAAS,EACT,SAAS,EACT,MAAM,EACN,OAAO,GAC+D;IAIxE,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,MAAM;QACN,IAAI,EAAE,OAAO;KAMd,CAAA;AACH,CAAC"}

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

@@ -1,5 +1,33 @@
-import { encodeEventTopics, numberToHex } from '../../utils/index.js';
-export async function createEventFilter(client, { address, args, event, fromBlock, toBlock, } = {}) {
+import { encodeEventTopics, } from '../../utils/abi/encodeEventTopics.js';
+import { numberToHex } from '../../utils/encoding/toHex.js';
+import { createFilterRequestScope } from '../../utils/filters/createFilterRequestScope.js';
+/**
+ * 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, fromBlock, strict, toBlock, } = {}) {
+    const getRequest = createFilterRequestScope(client, {
+        method: 'eth_newFilter',
+    });
     let topics = [];
     if (event)
         topics = encodeEventTopics({
@@ -23,6 +51,8 @@ export async function createEventFilter(client, { address, args, event, fromBloc
         args,
         eventName: event ? event.name : undefined,
         id,
+        request: getRequest(id),
+        strict,
         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":"AAcA,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AA+CrE,MAAM,CAAC,KAAK,UAAU,iBAAiB,CASrC,MAAuC,EACvC,EACE,OAAO,EACP,IAAI,EACJ,KAAK,EACL,SAAS,EACT,OAAO,MAML,EAAS;IAEb,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;IACF,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,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;AA4D1F;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAUrC,MAAiC,EACjC,EACE,OAAO,EACP,IAAI,EACJ,KAAK,EACL,SAAS,EACT,MAAM,EACN,OAAO,MAOL,EAAS;IAIb,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,MAAM;QACN,IAAI,EAAE,OAAO;KAOd,CAAA;AACH,CAAC"}

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

@@ -1,7 +1,32 @@
+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',
+    });
     const id = await client.request({
         method: 'eth_newPendingTransactionFilter',
     });
-    return { id, type: 'transaction' };
+    return { id, request: getRequest(id), type: 'transaction' };
 }
 //# sourceMappingURL=createPendingTransactionFilter.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"createPendingTransactionFilter.js","sourceRoot":"","sources":["../../../../src/actions/public/createPendingTransactionFilter.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,KAAK,UAAU,8BAA8B,CAIlD,MAAwC;IAExC,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAC9B,MAAM,EAAE,iCAAiC;KAC1C,CAAC,CAAA;IACF,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,CAAA;AACpC,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

@@ -1,7 +1,35 @@
-import { encodeFunctionData, getContractError, parseAccount, } from '../../utils/index.js';
+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,
@@ -16,6 +44,7 @@ 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,

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

@@ -1 +1 @@
-{"version":3,"file":"estimateContractGas.js","sourceRoot":"","sources":["../../../../src/actions/public/estimateContractGas.ts"],"names":[],"mappings":"AASA,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAChB,YAAY,GACb,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAa9C,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,iCAAiC;YAC3C,YAAY;YACZ,MAAM,EAAE,OAAO,EAAE,OAAO;SACzB,CAAC,CAAA;KACH;AACH,CAAC"}

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

@@ -1,20 +1,53 @@
-import { AccountNotFoundError } from '../../errors/index.js';
-import { assertRequest, extract, format, formatTransactionRequest, getEstimateGasError, numberToHex, parseAccount, prepareRequest, } from '../../utils/index.js';
+import { parseAccount } from '../../accounts/utils/parseAccount.js';
+import { AccountNotFoundError } from '../../errors/account.js';
+import { numberToHex } from '../../utils/encoding/toHex.js';
+import { getEstimateGasError } from '../../utils/errors/getEstimateGasError.js';
+import { extract } from '../../utils/formatters/extract.js';
+import { formatTransactionRequest, } from '../../utils/formatters/transactionRequest.js';
+import { assertRequest, } from '../../utils/transaction/assertRequest.js';
+import { prepareRequest } from '../../utils/transaction/prepareRequest.js';
 /**
- * @description Estimates the gas necessary to complete a transaction without submitting it to the network.
+ * Estimates the gas necessary to complete a transaction without submitting it to the network.
+ *
+ * - Docs: https://viem.sh/docs/actions/public/estimateGas.html
+ * - JSON-RPC Methods: [`eth_estimateGas`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_estimategas)
+ *
+ * @param client - Client to use
+ * @param parameters - {@link EstimateGasParameters}
+ * @returns The gas estimate (in wei). {@link EstimateGasReturnType}
+ *
+ * @example
+ * import { createPublicClient, http, parseEther } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { estimateGas } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const gasEstimate = await estimateGas(client, {
+ *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *   value: parseEther('1'),
+ * })
  */
 export async function estimateGas(client, args) {
-    if (!args.account)
+    const account_ = args.account ?? client.account;
+    if (!account_)
         throw new AccountNotFoundError({
             docsPath: '/docs/actions/public/estimateGas',
         });
-    const account = parseAccount(args.account);
+    const account = parseAccount(account_);
     try {
-        const { accessList, blockNumber, blockTag = 'latest', data, gas, gasPrice, maxFeePerGas, maxPriorityFeePerGas, nonce, to, value, ...rest } = account.type === 'local' ? await prepareRequest(client, args) : args;
+        const { accessList, blockNumber, blockTag, data, gas, gasPrice, maxFeePerGas, maxPriorityFeePerGas, nonce, to, value, ...rest } = account.type === 'local' ? await prepareRequest(client, args) : args;
         const blockNumberHex = blockNumber ? numberToHex(blockNumber) : undefined;
+        const block = blockNumberHex || blockTag;
         assertRequest(args);
-        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,
@@ -25,14 +58,10 @@ export async function estimateGas(client, args) {
             nonce,
             to,
             value,
-            // Pick out extra data that might exist on the chain's transaction request type.
-            ...extract(rest, { formatter }),
-        }, {
-            formatter: formatter || formatTransactionRequest,
         });
         const balance = await client.request({
             method: 'eth_estimateGas',
-            params: [request, blockNumberHex || blockTag],
+            params: block ? [request, block] : [request],
         });
         return BigInt(balance);
     }

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

@@ -1 +1 @@
-{"version":3,"file":"estimateGas.js","sourceRoot":"","sources":["../../../../src/actions/public/estimateGas.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAA;AAU5D,OAAO,EACL,aAAa,EACb,OAAO,EACP,MAAM,EACN,wBAAwB,EACxB,mBAAmB,EACnB,WAAW,EACX,YAAY,EACZ,cAAc,GACf,MAAM,sBAAsB,CAAA;AAiC7B;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAI/B,MAE6C,EAC7C,IAA6C;IAE7C,IAAI,CAAC,IAAI,CAAC,OAAO;QACf,MAAM,IAAI,oBAAoB,CAAC;YAC7B,QAAQ,EAAE,kCAAkC;SAC7C,CAAC,CAAA;IACJ,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAE1C,IAAI;QACF,MAAM,EACJ,UAAU,EACV,WAAW,EACX,QAAQ,GAAG,QAAQ,EACnB,IAAI,EACJ,GAAG,EACH,QAAQ,EACR,YAAY,EACZ,oBAAoB,EACpB,KAAK,EACL,EAAE,EACF,KAAK,EACL,GAAG,IAAI,EACR,GAAG,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,MAAM,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QAExE,MAAM,cAAc,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QAEzE,aAAa,CAAC,IAAI,CAAC,CAAA;QAEnB,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,kBAAkB,CAAA;QAC9D,MAAM,OAAO,GAAG,MAAM,CACpB;YACE,IAAI,EAAE,OAAO,CAAC,OAAO;YACrB,UAAU;YACV,IAAI;YACJ,GAAG;YACH,QAAQ;YACR,YAAY;YACZ,oBAAoB;YACpB,KAAK;YACL,EAAE;YACF,KAAK;YACL,gFAAgF;YAChF,GAAG,OAAO,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,CAAC;SACV,EACvB;YACE,SAAS,EAAE,SAAS,IAAI,wBAAwB;SACjD,CACF,CAAA;QAED,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YACnC,MAAM,EAAE,iBAAiB;YACzB,MAAM,EAAE,CAAC,OAAO,EAAE,cAAc,IAAI,QAAQ,CAAC;SAC9C,CAAC,CAAA;QACF,OAAO,MAAM,CAAC,OAAO,CAAC,CAAA;KACvB;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,mBAAmB,CAAC,GAAgB,EAAE;YAC1C,GAAG,IAAI;YACP,OAAO;YACP,KAAK,EAAE,MAAM,CAAC,KAAK;SACpB,CAAC,CAAA;KACH;AACH,CAAC"}
+{"version":3,"file":"estimateGas.js","sourceRoot":"","sources":["../../../../src/actions/public/estimateGas.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAA;AAGnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAO9D,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,2CAA2C,CAAA;AAC/E,OAAO,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAA;AAC3D,OAAO,EAEL,wBAAwB,GACzB,MAAM,8CAA8C,CAAA;AACrD,OAAO,EAEL,aAAa,GACd,MAAM,0CAA0C,CAAA;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,2CAA2C,CAAA;AA6B1E;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAI/B,MAA2C,EAC3C,IAA6C;IAE7C,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,CAAA;IAC/C,IAAI,CAAC,QAAQ;QACX,MAAM,IAAI,oBAAoB,CAAC;YAC7B,QAAQ,EAAE,kCAAkC;SAC7C,CAAC,CAAA;IACJ,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAA;IAEtC,IAAI;QACF,MAAM,EACJ,UAAU,EACV,WAAW,EACX,QAAQ,EACR,IAAI,EACJ,GAAG,EACH,QAAQ,EACR,YAAY,EACZ,oBAAoB,EACpB,KAAK,EACL,EAAE,EACF,KAAK,EACL,GAAG,IAAI,EACR,GAAG,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,MAAM,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QAExE,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,aAAa,CAAC,IAA+B,CAAC,CAAA;QAE9C,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,CAAC,OAAO;YACrB,UAAU;YACV,IAAI;YACJ,GAAG;YACH,QAAQ;YACR,YAAY;YACZ,oBAAoB;YACpB,KAAK;YACL,EAAE;YACF,KAAK;SACgB,CAAC,CAAA;QAExB,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YACnC,MAAM,EAAE,iBAAiB;YACzB,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;SAC7C,CAAC,CAAA;QACF,OAAO,MAAM,CAAC,OAAO,CAAC,CAAA;KACvB;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,mBAAmB,CAAC,GAAgB,EAAE;YAC1C,GAAG,IAAI;YACP,OAAO;YACP,KAAK,EAAE,MAAM,CAAC,KAAK;SACpB,CAAC,CAAA;KACH;AACH,CAAC"}

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

@@ -1,6 +1,38 @@
-import { numberToHex } from '../../utils/index.js';
+import { numberToHex } from '../../utils/encoding/toHex.js';
 /**
- * @description Returns the balance of an address in wei.
+ * Returns the balance of an address in wei.
+ *
+ * - Docs: https://viem.sh/docs/actions/public/getBalance.html
+ * - JSON-RPC Methods: [`eth_getBalance`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getbalance)
+ *
+ * You can convert the balance to ether units with [`formatEther`](https://viem.sh/docs/utilities/formatEther.html).
+ *
+ * ```ts
+ * const balance = await getBalance(client, {
+ *   address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ *   blockTag: 'safe'
+ * })
+ * const balanceAsEther = formatEther(balance)
+ * // "6.942"
+ * ```
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetBalanceParameters}
+ * @returns The balance of the address in wei. {@link GetBalanceReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getBalance } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const balance = await getBalance(client, {
+ *   address: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ * })
+ * // 10000000000000000000000n (wei)
  */
 export async function getBalance(client, { address, blockNumber, blockTag = 'latest' }) {
     const blockNumberHex = blockNumber ? numberToHex(blockNumber) : undefined;

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

@@ -1 +1 @@
-{"version":3,"file":"getBalance.js","sourceRoot":"","sources":["../../../../src/actions/public/getBalance.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAoBlD;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAuC,EACvC,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,GAAG,QAAQ,EAAwB;IAEnE,MAAM,cAAc,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAEzE,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QACnC,MAAM,EAAE,gBAAgB;QACxB,MAAM,EAAE,CAAC,OAAO,EAAE,cAAc,IAAI,QAAQ,CAAC;KAC9C,CAAC,CAAA;IACF,OAAO,MAAM,CAAC,OAAO,CAAC,CAAA;AACxB,CAAC"}
+{"version":3,"file":"getBalance.js","sourceRoot":"","sources":["../../../../src/actions/public/getBalance.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAoB3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAiC,EACjC,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,GAAG,QAAQ,EAAwB;IAEnE,MAAM,cAAc,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAEzE,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QACnC,MAAM,EAAE,gBAAgB;QACxB,MAAM,EAAE,CAAC,OAAO,EAAE,cAAc,IAAI,QAAQ,CAAC;KAC9C,CAAC,CAAA;IACF,OAAO,MAAM,CAAC,OAAO,CAAC,CAAA;AACxB,CAAC"}

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

@@ -1,5 +1,30 @@
-import { BlockNotFoundError } from '../../errors/index.js';
-import { format, formatBlock, numberToHex } from '../../utils/index.js';
+import { BlockNotFoundError } from '../../errors/block.js';
+import { numberToHex } from '../../utils/encoding/toHex.js';
+import { formatBlock, } from '../../utils/formatters/block.js';
+/**
+ * Returns information about a block at a block number, hash, or tag.
+ *
+ * - Docs: https://viem.sh/docs/actions/public/getBlock.html
+ * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/blocks/fetching-blocks
+ * - JSON-RPC Methods:
+ *   - Calls [`eth_getBlockByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblockbynumber) for `blockNumber` & `blockTag`.
+ *   - Calls [`eth_getBlockByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblockbyhash) for `blockHash`.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetBlockParameters}
+ * @returns Information about the block. {@link GetBlockReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getBlock } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const block = await getBlock(client)
+ */
 export async function getBlock(client, { blockHash, blockNumber, blockTag = 'latest', includeTransactions = false, } = {}) {
     const blockNumberHex = blockNumber !== undefined ? numberToHex(blockNumber) : undefined;
     let block = null;
@@ -17,8 +42,7 @@ export async function getBlock(client, { blockHash, blockNumber, blockTag = 'lat
     }
     if (!block)
         throw new BlockNotFoundError({ blockHash, blockNumber });
-    return format(block, {
-        formatter: client.chain?.formatters?.block || formatBlock,
-    });
+    const format = client.chain?.formatters?.block?.format || formatBlock;
+    return format(block);
 }
 //# sourceMappingURL=getBlock.js.map