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

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

@@ -0,0 +1,78 @@
+import { BaseFeeScalarError, Eip1559FeesNotSupportedError, } from '../../errors/fee.js';
+import { internal_estimateMaxPriorityFeePerGas } from './estimateMaxPriorityFeePerGas.js';
+import { getBlock } from './getBlock.js';
+import { getGasPrice } from './getGasPrice.js';
+/**
+ * Returns an estimate for the fees per gas (in wei) for a
+ * transaction to be likely included in the next block.
+ * Defaults to [`chain.fees.estimateFeesPerGas`](/docs/clients/chains.html#fees-estimatefeespergas) if set.
+ *
+ * - Docs: https://viem.sh/docs/actions/public/estimateFeesPerGas.html
+ *
+ * @param client - Client to use
+ * @param parameters - {@link EstimateFeesPerGasParameters}
+ * @returns An estimate (in wei) for the fees per gas. {@link EstimateFeesPerGasReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { estimateFeesPerGas } from 'viem/actions'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const maxPriorityFeePerGas = await estimateFeesPerGas(client)
+ * // { maxFeePerGas: ..., maxPriorityFeePerGas: ... }
+ */
+export async function estimateFeesPerGas(client, args) {
+    return internal_estimateFeesPerGas(client, args);
+}
+export async function internal_estimateFeesPerGas(client, args) {
+    const { block: block_, chain = client.chain, request, type = 'eip1559', } = args || {};
+    const baseFeeMultiplier = await (async () => {
+        if (typeof chain?.fees?.baseFeeMultiplier === 'function')
+            return chain.fees.baseFeeMultiplier({
+                block: block_,
+                client,
+                request,
+            });
+        return chain?.fees?.baseFeeMultiplier ?? 1.2;
+    })();
+    if (baseFeeMultiplier < 1)
+        throw new BaseFeeScalarError();
+    const decimals = baseFeeMultiplier.toString().split('.')[1].length;
+    const denominator = 10 ** decimals;
+    const multiply = (base) => (base * BigInt(baseFeeMultiplier * denominator)) / BigInt(denominator);
+    const block = block_ ? block_ : await getBlock(client);
+    if (typeof chain?.fees?.estimateFeesPerGas === 'function')
+        return chain.fees.estimateFeesPerGas({
+            block: block_,
+            client,
+            multiply,
+            request,
+            type,
+        });
+    if (type === 'eip1559') {
+        if (typeof block.baseFeePerGas !== 'bigint')
+            throw new Eip1559FeesNotSupportedError();
+        const maxPriorityFeePerGas = request?.maxPriorityFeePerGas
+            ? request.maxPriorityFeePerGas
+            : await internal_estimateMaxPriorityFeePerGas(client, {
+                block,
+                chain,
+                request,
+            });
+        const baseFeePerGas = multiply(block.baseFeePerGas);
+        const maxFeePerGas = request?.maxFeePerGas ?? baseFeePerGas + maxPriorityFeePerGas;
+        return {
+            maxFeePerGas,
+            maxPriorityFeePerGas,
+        };
+    }
+    const gasPrice = request?.gasPrice ?? multiply(await getGasPrice(client));
+    return {
+        gasPrice,
+    };
+}
+//# sourceMappingURL=estimateFeesPerGas.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"estimateFeesPerGas.js","sourceRoot":"","sources":["../../../../src/actions/public/estimateFeesPerGas.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,kBAAkB,EAClB,4BAA4B,GAC7B,MAAM,qBAAqB,CAAA;AAc5B,OAAO,EAAE,qCAAqC,EAAE,MAAM,mCAAmC,CAAA;AACzF,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAwB9C;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAKtC,MAAgC,EAChC,IAA+D;IAE/D,OAAO,2BAA2B,CAAC,MAAM,EAAE,IAAW,CAAC,CAAA;AACzD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAK/C,MAAgC,EAChC,IAGC;IAED,MAAM,EACJ,KAAK,EAAE,MAAM,EACb,KAAK,GAAG,MAAM,CAAC,KAAK,EACpB,OAAO,EACP,IAAI,GAAG,SAAS,GACjB,GAAG,IAAI,IAAI,EAAE,CAAA;IAEd,MAAM,iBAAiB,GAAG,MAAM,CAAC,KAAK,IAAI,EAAE;QAC1C,IAAI,OAAO,KAAK,EAAE,IAAI,EAAE,iBAAiB,KAAK,UAAU;YACtD,OAAO,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC;gBAClC,KAAK,EAAE,MAAe;gBACtB,MAAM;gBACN,OAAO;aACiB,CAAC,CAAA;QAC7B,OAAO,KAAK,EAAE,IAAI,EAAE,iBAAiB,IAAI,GAAG,CAAA;IAC9C,CAAC,CAAC,EAAE,CAAA;IACJ,IAAI,iBAAiB,GAAG,CAAC;QAAE,MAAM,IAAI,kBAAkB,EAAE,CAAA;IAEzD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;IAClE,MAAM,WAAW,GAAG,EAAE,IAAI,QAAQ,CAAA;IAClC,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,EAAE,CAChC,CAAC,IAAI,GAAG,MAAM,CAAC,iBAAiB,GAAG,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC,CAAA;IAExE,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAA;IAEtD,IAAI,OAAO,KAAK,EAAE,IAAI,EAAE,kBAAkB,KAAK,UAAU;QACvD,OAAO,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC;YACnC,KAAK,EAAE,MAAe;YACtB,MAAM;YACN,QAAQ;YACR,OAAO;YACP,IAAI;SACkC,CAAkD,CAAA;IAE5F,IAAI,IAAI,KAAK,SAAS,EAAE;QACtB,IAAI,OAAO,KAAK,CAAC,aAAa,KAAK,QAAQ;YACzC,MAAM,IAAI,4BAA4B,EAAE,CAAA;QAE1C,MAAM,oBAAoB,GAAG,OAAO,EAAE,oBAAoB;YACxD,CAAC,CAAC,OAAO,CAAC,oBAAoB;YAC9B,CAAC,CAAC,MAAM,qCAAqC,CACzC,MAAkC,EAClC;gBACE,KAAK;gBACL,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QAEL,MAAM,aAAa,GAAG,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;QACnD,MAAM,YAAY,GAChB,OAAO,EAAE,YAAY,IAAI,aAAa,GAAG,oBAAoB,CAAA;QAE/D,OAAO;YACL,YAAY;YACZ,oBAAoB;SACiB,CAAA;KACxC;IAED,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,IAAI,QAAQ,CAAC,MAAM,WAAW,CAAC,MAAM,CAAC,CAAC,CAAA;IACzE,OAAO;QACL,QAAQ;KAC6B,CAAA;AACzC,CAAC"}

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

@@ -3,23 +3,53 @@ 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 { format } from '../../utils/formatters/format.js';
 import { formatTransactionRequest, } from '../../utils/formatters/transactionRequest.js';
-import { assertRequest } from '../../utils/transaction/assertRequest.js';
-import { prepareRequest } from '../../utils/transaction/prepareRequest.js';
+import { assertRequest, } from '../../utils/transaction/assertRequest.js';
+import { prepareTransactionRequest, } from '../wallet/prepareTransactionRequest.js';
+/**
+ * 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, 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 prepareTransactionRequest(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,
@@ -30,9 +60,6 @@ export async function estimateGas(client, args) {
             nonce,
             to,
             value,
-            ...extract(rest, { formatter }),
-        }, {
-            formatter: formatter || formatTransactionRequest,
         });
         const balance = await client.request({
             method: 'eth_estimateGas',

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

@@ -1 +1 @@
-{"version":3,"file":"estimateGas.js","sourceRoot":"","sources":["../../../../src/actions/public/estimateGas.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAA;AAInE,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAQ9D,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,EAAkB,MAAM,EAAE,MAAM,kCAAkC,CAAA;AACzE,OAAO,EAEL,wBAAwB,GACzB,MAAM,8CAA8C,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,0CAA0C,CAAA;AACxE,OAAO,EAAE,cAAc,EAAE,MAAM,2CAA2C,CAAA;AAyD1E,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,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,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;YAEL,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,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"}
+{"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,EAEL,yBAAyB,GAC1B,MAAM,wCAAwC,CAAA;AA6B/C;;;;;;;;;;;;;;;;;;;;;;;;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,GACC,OAAO,CAAC,IAAI,KAAK,OAAO;YACtB,CAAC,CAAE,CAAC,MAAM,yBAAyB,CAC/B,MAAM,EACN,IAA2C,CAC5C,CAA2B;YAC9B,CAAC,CAAC,IAAI,CAAA;QAEV,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/estimateMaxPriorityFeePerGas.js

@@ -0,0 +1,64 @@
+import { Eip1559FeesNotSupportedError } from '../../errors/fee.js';
+import { hexToBigInt } from '../../utils/encoding/fromHex.js';
+import { getBlock } from './getBlock.js';
+import { getGasPrice } from './getGasPrice.js';
+/**
+ * Returns an estimate for the max priority fee per gas (in wei) for a
+ * transaction to be likely included in the next block.
+ * Defaults to [`chain.fees.defaultPriorityFee`](/docs/clients/chains.html#fees-defaultpriorityfee) if set.
+ *
+ * - Docs: https://viem.sh/docs/actions/public/estimateMaxPriorityFeePerGas.html
+ *
+ * @param client - Client to use
+ * @returns An estimate (in wei) for the max priority fee per gas. {@link EstimateMaxPriorityFeePerGasReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { estimateMaxPriorityFeePerGas } from 'viem/actions'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const maxPriorityFeePerGas = await estimateMaxPriorityFeePerGas(client)
+ * // 10000000n
+ */
+export async function estimateMaxPriorityFeePerGas(client, args) {
+    return internal_estimateMaxPriorityFeePerGas(client, args);
+}
+export async function internal_estimateMaxPriorityFeePerGas(client, args) {
+    const { block: block_, chain = client.chain, request } = args || {};
+    if (typeof chain?.fees?.defaultPriorityFee === 'function') {
+        const block = block_ || (await getBlock(client));
+        return chain.fees.defaultPriorityFee({
+            block,
+            client,
+            request,
+        });
+    }
+    else if (chain?.fees?.defaultPriorityFee)
+        return chain?.fees?.defaultPriorityFee;
+    try {
+        const maxPriorityFeePerGasHex = await client.request({
+            method: 'eth_maxPriorityFeePerGas',
+        });
+        return hexToBigInt(maxPriorityFeePerGasHex);
+    }
+    catch {
+        // If the RPC Provider does not support `eth_maxPriorityFeePerGas`
+        // fall back to calculating it manually via `gasPrice - baseFeePerGas`.
+        // See: https://github.com/ethereum/pm/issues/328#:~:text=eth_maxPriorityFeePerGas%20after%20London%20will%20effectively%20return%20eth_gasPrice%20%2D%20baseFee
+        const [block, gasPrice] = await Promise.all([
+            block_ ? Promise.resolve(block_) : getBlock(client),
+            getGasPrice(client),
+        ]);
+        if (typeof block.baseFeePerGas !== 'bigint')
+            throw new Eip1559FeesNotSupportedError();
+        const maxPriorityFeePerGas = gasPrice - block.baseFeePerGas;
+        if (maxPriorityFeePerGas < 0n)
+            return 0n;
+        return maxPriorityFeePerGas;
+    }
+}
+//# sourceMappingURL=estimateMaxPriorityFeePerGas.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"estimateMaxPriorityFeePerGas.js","sourceRoot":"","sources":["../../../../src/actions/public/estimateMaxPriorityFeePerGas.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,4BAA4B,EAAE,MAAM,qBAAqB,CAAA;AAKlE,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAA;AAE7D,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAQ9C;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAIhD,MAAgC,EAChC,IAAmE;IAEnE,OAAO,qCAAqC,CAAC,MAAM,EAAE,IAAW,CAAC,CAAA;AACnE,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,qCAAqC,CAIzD,MAAgC,EAChC,IAOC;IAED,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,GAAG,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,IAAI,EAAE,CAAA;IACnE,IAAI,OAAO,KAAK,EAAE,IAAI,EAAE,kBAAkB,KAAK,UAAU,EAAE;QACzD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAA;QAChD,OAAO,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC;YACnC,KAAK;YACL,MAAM;YACN,OAAO;SACiB,CAAC,CAAA;KAC5B;SAAM,IAAI,KAAK,EAAE,IAAI,EAAE,kBAAkB;QACxC,OAAO,KAAK,EAAE,IAAI,EAAE,kBAAkB,CAAA;IAExC,IAAI;QACF,MAAM,uBAAuB,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YACnD,MAAM,EAAE,0BAA0B;SACnC,CAAC,CAAA;QACF,OAAO,WAAW,CAAC,uBAAuB,CAAC,CAAA;KAC5C;IAAC,MAAM;QACN,kEAAkE;QAClE,uEAAuE;QACvE,gKAAgK;QAChK,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC1C,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;YACnD,WAAW,CAAC,MAAM,CAAC;SACpB,CAAC,CAAA;QAEF,IAAI,OAAO,KAAK,CAAC,aAAa,KAAK,QAAQ;YACzC,MAAM,IAAI,4BAA4B,EAAE,CAAA;QAE1C,MAAM,oBAAoB,GAAG,QAAQ,GAAG,KAAK,CAAC,aAAa,CAAA;QAE3D,IAAI,oBAAoB,GAAG,EAAE;YAAE,OAAO,EAAE,CAAA;QACxC,OAAO,oBAAoB,CAAA;KAC5B;AACH,CAAC"}

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

@@ -1,4 +1,39 @@
 import { numberToHex } from '../../utils/encoding/toHex.js';
+/**
+ * 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;
     const balance = await client.request({

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

@@ -1 +1 @@
-{"version":3,"file":"getBalance.js","sourceRoot":"","sources":["../../../../src/actions/public/getBalance.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAuD3D,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,8 +1,33 @@
 import { BlockNotFoundError } from '../../errors/block.js';
 import { numberToHex } from '../../utils/encoding/toHex.js';
 import { formatBlock, } from '../../utils/formatters/block.js';
-import { format } from '../../utils/formatters/format.js';
-export async function getBlock(client, { blockHash, blockNumber, blockTag = 'latest', includeTransactions = false, } = {}) {
+/**
+ * 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: blockTag_, includeTransactions: includeTransactions_, } = {}) {
+    const blockTag = blockTag_ ?? 'latest';
+    const includeTransactions = includeTransactions_ ?? false;
     const blockNumberHex = blockNumber !== undefined ? numberToHex(blockNumber) : undefined;
     let block = null;
     if (blockHash) {
@@ -19,8 +44,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

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

@@ -1 +1 @@
-{"version":3,"file":"getBlock.js","sourceRoot":"","sources":["../../../../src/actions/public/getBlock.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAK1D,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAGL,WAAW,GACZ,MAAM,iCAAiC,CAAA;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAA;AAyDzD,MAAM,CAAC,KAAK,UAAU,QAAQ,CAI5B,MAE6C,EAC7C,EACE,SAAS,EACT,WAAW,EACX,QAAQ,GAAG,QAAQ,EACnB,mBAAmB,GAAG,KAAK,MACL,EAAE;IAE1B,MAAM,cAAc,GAClB,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAElE,IAAI,KAAK,GAAoB,IAAI,CAAA;IACjC,IAAI,SAAS,EAAE;QACb,KAAK,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YAC3B,MAAM,EAAE,oBAAoB;YAC5B,MAAM,EAAE,CAAC,SAAS,EAAE,mBAAmB,CAAC;SACzC,CAAC,CAAA;KACH;SAAM;QACL,KAAK,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YAC3B,MAAM,EAAE,sBAAsB;YAC9B,MAAM,EAAE,CAAC,cAAc,IAAI,QAAQ,EAAE,mBAAmB,CAAC;SAC1D,CAAC,CAAA;KACH;IAED,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,kBAAkB,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,CAAA;IAEpE,OAAO,MAAM,CAAC,KAAK,EAAE;QACnB,SAAS,EAAE,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,KAAK,IAAI,WAAW;KAC1D,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"getBlock.js","sourceRoot":"","sources":["../../../../src/actions/public/getBlock.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAK1D,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAEL,WAAW,GACZ,MAAM,iCAAiC,CAAA;AAsCxC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAM5B,MAA2C,EAC3C,EACE,SAAS,EACT,WAAW,EACX,QAAQ,EAAE,SAAS,EACnB,mBAAmB,EAAE,oBAAoB,MACc,EAAE;IAE3D,MAAM,QAAQ,GAAG,SAAS,IAAI,QAAQ,CAAA;IACtC,MAAM,mBAAmB,GAAG,oBAAoB,IAAI,KAAK,CAAA;IAEzD,MAAM,cAAc,GAClB,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAElE,IAAI,KAAK,GAAoB,IAAI,CAAA;IACjC,IAAI,SAAS,EAAE;QACb,KAAK,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YAC3B,MAAM,EAAE,oBAAoB;YAC5B,MAAM,EAAE,CAAC,SAAS,EAAE,mBAAmB,CAAC;SACzC,CAAC,CAAA;KACH;SAAM;QACL,KAAK,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YAC3B,MAAM,EAAE,sBAAsB;YAC9B,MAAM,EAAE,CAAC,cAAc,IAAI,QAAQ,EAAE,mBAAmB,CAAC;SAC1D,CAAC,CAAA;KACH;IAED,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,kBAAkB,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,CAAA;IAEpE,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,IAAI,WAAW,CAAA;IACrE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;AACtB,CAAC"}

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

@@ -3,10 +3,33 @@ const cacheKey = (id) => `blockNumber.${id}`;
 export function getBlockNumberCache(id) {
     return getCache(cacheKey(id));
 }
-export async function getBlockNumber(client, { maxAge = client.pollingInterval } = {}) {
+/**
+ * Returns the number of the most recent block seen.
+ *
+ * - Docs: https://viem.sh/docs/actions/public/getBlockNumber.html
+ * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/blocks/fetching-blocks
+ * - JSON-RPC Methods: [`eth_blockNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_blocknumber)
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetBlockNumberParameters}
+ * @returns The number of the block. {@link GetBlockNumberReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getBlockNumber } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const blockNumber = await getBlockNumber(client)
+ * // 69420n
+ */
+export async function getBlockNumber(client, { cacheTime = client.cacheTime, maxAge } = {}) {
     const blockNumberHex = await withCache(() => client.request({
         method: 'eth_blockNumber',
-    }), { cacheKey: cacheKey(client.uid), maxAge });
+    }), { cacheKey: cacheKey(client.uid), cacheTime: maxAge ?? cacheTime });
     return BigInt(blockNumberHex);
 }
 //# sourceMappingURL=getBlockNumber.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"getBlockNumber.js","sourceRoot":"","sources":["../../../../src/actions/public/getBlockNumber.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAA;AAStE,MAAM,QAAQ,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,eAAe,EAAE,EAAE,CAAA;AAEpD,MAAM,UAAU,mBAAmB,CAAC,EAAU;IAC5C,OAAO,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAA;AAC/B,CAAC;AAyBD,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,MAAuC,EACvC,EAAE,MAAM,GAAG,MAAM,CAAC,eAAe,KAA+B,EAAE;IAElE,MAAM,cAAc,GAAG,MAAM,SAAS,CACpC,GAAG,EAAE,CACH,MAAM,CAAC,OAAO,CAAC;QACb,MAAM,EAAE,iBAAiB;KAC1B,CAAC,EACJ,EAAE,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,CAC3C,CAAA;IACD,OAAO,MAAM,CAAC,cAAc,CAAC,CAAA;AAC/B,CAAC"}
+{"version":3,"file":"getBlockNumber.js","sourceRoot":"","sources":["../../../../src/actions/public/getBlockNumber.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAA;AAWtE,MAAM,QAAQ,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,eAAe,EAAE,EAAE,CAAA;AAEpD,MAAM,UAAU,mBAAmB,CAAC,EAAU;IAC5C,OAAO,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAA;AAC/B,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,MAAiC,EACjC,EAAE,SAAS,GAAG,MAAM,CAAC,SAAS,EAAE,MAAM,KAA+B,EAAE;IAEvE,MAAM,cAAc,GAAG,MAAM,SAAS,CACpC,GAAG,EAAE,CACH,MAAM,CAAC,OAAO,CAAC;QACb,MAAM,EAAE,iBAAiB;KAC1B,CAAC,EACJ,EAAE,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,MAAM,IAAI,SAAS,EAAE,CACnE,CAAA;IACD,OAAO,MAAM,CAAC,cAAc,CAAC,CAAA;AAC/B,CAAC"}

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

@@ -1,8 +1,31 @@
 import { hexToNumber } from '../../utils/encoding/fromHex.js';
 import { numberToHex } from '../../utils/encoding/toHex.js';
+/**
+ * Returns the number of Transactions at a block number, hash, or tag.
+ *
+ * - Docs: https://viem.sh/docs/actions/public/getBlockTransactionCount.html
+ * - JSON-RPC Methods:
+ *   - Calls [`eth_getBlockTransactionCountByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblocktransactioncountbynumber) for `blockNumber` & `blockTag`.
+ *   - Calls [`eth_getBlockTransactionCountByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblocktransactioncountbyhash) for `blockHash`.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetBlockTransactionCountParameters}
+ * @returns The block transaction count. {@link GetBlockTransactionCountReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getBlockTransactionCount } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const count = await getBlockTransactionCount(client)
+ */
 export async function getBlockTransactionCount(client, { blockHash, blockNumber, blockTag = 'latest', } = {}) {
     const blockNumberHex = blockNumber !== undefined ? numberToHex(blockNumber) : undefined;
-    let count = null;
+    let count;
     if (blockHash) {
         count = await client.request({
             method: 'eth_getBlockTransactionCountByHash',

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

@@ -1 +1 @@
-{"version":3,"file":"getBlockTransactionCount.js","sourceRoot":"","sources":["../../../../src/actions/public/getBlockTransactionCount.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAA;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AA+C3D,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAG5C,MAAuC,EACvC,EACE,SAAS,EACT,WAAW,EACX,QAAQ,GAAG,QAAQ,MACmB,EAAE;IAE1C,MAAM,cAAc,GAClB,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAElE,IAAI,KAAK,GAAoB,IAAI,CAAA;IACjC,IAAI,SAAS,EAAE;QACb,KAAK,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YAC3B,MAAM,EAAE,oCAAoC;YAC5C,MAAM,EAAE,CAAC,SAAS,CAAC;SACpB,CAAC,CAAA;KACH;SAAM;QACL,KAAK,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YAC3B,MAAM,EAAE,sCAAsC;YAC9C,MAAM,EAAE,CAAC,cAAc,IAAI,QAAQ,CAAC;SACrC,CAAC,CAAA;KACH;IAED,OAAO,WAAW,CAAC,KAAK,CAAC,CAAA;AAC3B,CAAC"}
+{"version":3,"file":"getBlockTransactionCount.js","sourceRoot":"","sources":["../../../../src/actions/public/getBlockTransactionCount.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAA;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAwB3D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAG5C,MAAiC,EACjC,EACE,SAAS,EACT,WAAW,EACX,QAAQ,GAAG,QAAQ,MACmB,EAAE;IAE1C,MAAM,cAAc,GAClB,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAElE,IAAI,KAAe,CAAA;IACnB,IAAI,SAAS,EAAE;QACb,KAAK,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YAC3B,MAAM,EAAE,oCAAoC;YAC5C,MAAM,EAAE,CAAC,SAAS,CAAC;SACpB,CAAC,CAAA;KACH;SAAM;QACL,KAAK,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YAC3B,MAAM,EAAE,sCAAsC;YAC9C,MAAM,EAAE,CAAC,cAAc,IAAI,QAAQ,CAAC;SACrC,CAAC,CAAA;KACH;IAED,OAAO,WAAW,CAAC,KAAK,CAAC,CAAA;AAC3B,CAAC"}

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

@@ -1,4 +1,27 @@
 import { numberToHex } from '../../utils/encoding/toHex.js';
+/**
+ * Retrieves the bytecode at an address.
+ *
+ * - Docs: https://viem.sh/docs/contract/getBytecode.html
+ * - JSON-RPC Methods: [`eth_getCode`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getcode)
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetBytecodeParameters}
+ * @returns The contract's bytecode. {@link GetBytecodeReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getBytecode } from 'viem/contract'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const code = await getBytecode(client, {
+ *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+ * })
+ */
 export async function getBytecode(client, { address, blockNumber, blockTag = 'latest' }) {
     const blockNumberHex = blockNumber !== undefined ? numberToHex(blockNumber) : undefined;
     const hex = await client.request({

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

@@ -1 +1 @@
-{"version":3,"file":"getBytecode.js","sourceRoot":"","sources":["../../../../src/actions/public/getBytecode.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAwC3D,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAuC,EACvC,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,GAAG,QAAQ,EAAyB;IAEpE,MAAM,cAAc,GAClB,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAClE,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAC/B,MAAM,EAAE,aAAa;QACrB,MAAM,EAAE,CAAC,OAAO,EAAE,cAAc,IAAI,QAAQ,CAAC;KAC9C,CAAC,CAAA;IACF,IAAI,GAAG,KAAK,IAAI;QAAE,OAAO,SAAS,CAAA;IAClC,OAAO,GAAG,CAAA;AACZ,CAAC"}
+{"version":3,"file":"getBytecode.js","sourceRoot":"","sources":["../../../../src/actions/public/getBytecode.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAiB3D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAiC,EACjC,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,GAAG,QAAQ,EAAyB;IAEpE,MAAM,cAAc,GAClB,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAClE,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAC/B,MAAM,EAAE,aAAa;QACrB,MAAM,EAAE,CAAC,OAAO,EAAE,cAAc,IAAI,QAAQ,CAAC;KAC9C,CAAC,CAAA;IACF,IAAI,GAAG,KAAK,IAAI;QAAE,OAAO,SAAS,CAAA;IAClC,OAAO,GAAG,CAAA;AACZ,CAAC"}

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

@@ -1,6 +1,29 @@
 import { hexToNumber } from '../../utils/encoding/fromHex.js';
+/**
+ * Returns the chain ID associated with the current network.
+ *
+ * - Docs: https://viem.sh/docs/actions/public/getChainId.html
+ * - JSON-RPC Methods: [`eth_chainId`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_chainid)
+ *
+ * @param client - Client to use
+ * @returns The current chain ID. {@link GetChainIdReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getChainId } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const chainId = await getChainId(client)
+ * // 1
+ */
 export async function getChainId(client) {
-    const chainIdHex = await client.request({ method: 'eth_chainId' });
+    const chainIdHex = await client.request({
+        method: 'eth_chainId',
+    });
     return hexToNumber(chainIdHex);
 }
 //# sourceMappingURL=getChainId.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"getChainId.js","sourceRoot":"","sources":["../../../../src/actions/public/getChainId.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAA;AAyB7D,MAAM,CAAC,KAAK,UAAU,UAAU,CAI9B,MAE6C;IAE7C,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAA;IAClE,OAAO,WAAW,CAAC,UAAU,CAAC,CAAA;AAChC,CAAC"}
+{"version":3,"file":"getChainId.js","sourceRoot":"","sources":["../../../../src/actions/public/getChainId.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAA;AAI7D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAG9B,MAA2C;IAC3C,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QACtC,MAAM,EAAE,aAAa;KACtB,CAAC,CAAA;IACF,OAAO,WAAW,CAAC,UAAU,CAAC,CAAA;AAChC,CAAC"}

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

@@ -1,5 +1,29 @@
 import { numberToHex } from '../../utils/encoding/toHex.js';
 import { formatFeeHistory } from '../../utils/formatters/feeHistory.js';
+/**
+ * Returns a collection of historical gas information.
+ *
+ * - Docs: https://viem.sh/docs/actions/public/getFeeHistory.html
+ * - JSON-RPC Methods: [`eth_feeHistory`](https://docs.alchemy.com/reference/eth-feehistory)
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetFeeHistoryParameters}
+ * @returns The gas estimate (in wei). {@link GetFeeHistoryReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getFeeHistory } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const feeHistory = await getFeeHistory(client, {
+ *   blockCount: 4,
+ *   rewardPercentiles: [25, 75],
+ * })
+ */
 export async function getFeeHistory(client, { blockCount, blockNumber, blockTag = 'latest', rewardPercentiles, }) {
     const blockNumberHex = blockNumber ? numberToHex(blockNumber) : undefined;
     const feeHistory = await client.request({

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

@@ -1 +1 @@
-{"version":3,"file":"getFeeHistory.js","sourceRoot":"","sources":["../../../../src/actions/public/getFeeHistory.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAA;AAoDvE,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAuC,EACvC,EACE,UAAU,EACV,WAAW,EACX,QAAQ,GAAG,QAAQ,EACnB,iBAAiB,GACO;IAE1B,MAAM,cAAc,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACzE,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QACtC,MAAM,EAAE,gBAAgB;QACxB,MAAM,EAAE;YACN,WAAW,CAAC,UAAU,CAAC;YACvB,cAAc,IAAI,QAAQ;YAC1B,iBAAiB;SAClB;KACF,CAAC,CAAA;IACF,OAAO,gBAAgB,CAAC,UAAU,CAAC,CAAA;AACrC,CAAC"}
+{"version":3,"file":"getFeeHistory.js","sourceRoot":"","sources":["../../../../src/actions/public/getFeeHistory.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAA;AA4BvE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAiC,EACjC,EACE,UAAU,EACV,WAAW,EACX,QAAQ,GAAG,QAAQ,EACnB,iBAAiB,GACO;IAE1B,MAAM,cAAc,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACzE,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QACtC,MAAM,EAAE,gBAAgB;QACxB,MAAM,EAAE;YACN,WAAW,CAAC,UAAU,CAAC;YACvB,cAAc,IAAI,QAAQ;YAC1B,iBAAiB;SAClB;KACF,CAAC,CAAA;IACF,OAAO,gBAAgB,CAAC,UAAU,CAAC,CAAA;AACrC,CAAC"}