viem 1.0.2 → 1.0.5

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,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"}

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

@@ -2,6 +2,30 @@ 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';
+/**
+ * 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;

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,MAAO,MAAuB,CAAC,OAAO,CAAC;YAC7C,MAAM,EAAE,oBAAoB;YAC5B,MAAM,EAAE,CAAC,SAAS,EAAE,mBAAmB,CAAC;SACzC,CAAC,CAAA;KACH;SAAM;QACL,KAAK,GAAG,MAAO,MAAuB,CAAC,OAAO,CAAC;YAC7C,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":"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;AAiCzD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,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,MAAO,MAAuB,CAAC,OAAO,CAAC;YAC7C,MAAM,EAAE,oBAAoB;YAC5B,MAAM,EAAE,CAAC,SAAS,EAAE,mBAAmB,CAAC;SACzC,CAAC,CAAA;KACH;SAAM;QACL,KAAK,GAAG,MAAO,MAAuB,CAAC,OAAO,CAAC;YAC7C,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"}

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

@@ -3,6 +3,29 @@ const cacheKey = (id) => `blockNumber.${id}`;
 export function getBlockNumberCache(id) {
     return getCache(cacheKey(id));
 }
+/**
+ * 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, { maxAge = client.pollingInterval } = {}) {
     const blockNumberHex = await withCache(() => client.request({
         method: 'eth_blockNumber',

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;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;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,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"}

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

@@ -1,5 +1,28 @@
 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;

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,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"}
+{"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,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,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,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"}

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

@@ -1,4 +1,25 @@
 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',

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,MAAO,MAAuB,CAAC,OAAO,CAAC;QACxD,MAAM,EAAE,aAAa;KACtB,CAAC,CAAA;IACF,OAAO,WAAW,CAAC,UAAU,CAAC,CAAA;AAChC,CAAC"}
+{"version":3,"file":"getChainId.js","sourceRoot":"","sources":["../../../../src/actions/public/getChainId.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAA;AAI7D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAI9B,MAE6C;IAE7C,MAAM,UAAU,GAAG,MAAO,MAAuB,CAAC,OAAO,CAAC;QACxD,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,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"}

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

@@ -1,6 +1,88 @@
 import { DecodeLogDataMismatch, DecodeLogTopicsMismatch, } from '../../errors/abi.js';
 import { decodeEventLog } from '../../utils/abi/decodeEventLog.js';
 import { formatLog } from '../../utils/formatters/log.js';
+/**
+ * Returns a list of logs or hashes based on a [Filter](/docs/glossary/terms#filter) since the last time it was called.
+ *
+ * - Docs: https://viem.sh/docs/actions/public/getFilterChanges.html
+ * - JSON-RPC Methods: [`eth_getFilterChanges`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterchanges)
+ *
+ * A Filter can be created from the following actions:
+ *
+ * - [`createBlockFilter`](https://viem.sh/docs/actions/public/createBlockFilter.html)
+ * - [`createContractEventFilter`](https://viem.sh/docs/contract/createContractEventFilter.html)
+ * - [`createEventFilter`](https://viem.sh/docs/actions/public/createEventFilter.html)
+ * - [`createPendingTransactionFilter`](https://viem.sh/docs/actions/public/createPendingTransactionFilter.html)
+ *
+ * Depending on the type of filter, the return value will be different:
+ *
+ * - If the filter was created with `createContractEventFilter` or `createEventFilter`, it returns a list of logs.
+ * - If the filter was created with `createPendingTransactionFilter`, it returns a list of transaction hashes.
+ * - If the filter was created with `createBlockFilter`, it returns a list of block hashes.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetFilterChangesParameters}
+ * @returns Logs or hashes. {@link GetFilterChangesReturnType}
+ *
+ * @example
+ * // Blocks
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { createBlockFilter, getFilterChanges } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const filter = await createBlockFilter(client)
+ * const hashes = await getFilterChanges(client, { filter })
+ *
+ * @example
+ * // Contract Events
+ * import { createPublicClient, http, parseAbi } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { createContractEventFilter, getFilterChanges } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const filter = await createContractEventFilter(client, {
+ *   address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
+ *   abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']),
+ *   eventName: 'Transfer',
+ * })
+ * const logs = await getFilterChanges(client, { filter })
+ *
+ * @example
+ * // Raw Events
+ * import { createPublicClient, http, parseAbiItem } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { createEventFilter, getFilterChanges } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const filter = await createEventFilter(client, {
+ *   address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
+ *   event: parseAbiItem('event Transfer(address indexed, address indexed, uint256)'),
+ * })
+ * const logs = await getFilterChanges(client, { filter })
+ *
+ * @example
+ * // Transactions
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { createPendingTransactionFilter, getFilterChanges } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const filter = await createPendingTransactionFilter(client)
+ * const hashes = await getFilterChanges(client, { filter })
+ */
 export async function getFilterChanges(_client, { filter, }) {
     const strict = 'strict' in filter && filter.strict;
     const logs = await filter.request({
@@ -27,11 +109,13 @@ export async function getFilterChanges(_client, { filter, }) {
             let isUnnamed;
             if (err instanceof DecodeLogDataMismatch ||
                 err instanceof DecodeLogTopicsMismatch) {
+                // If strict mode is on, and log data/topics do not match event definition, skip.
                 if ('strict' in filter && filter.strict)
                     return;
                 eventName = err.abiItem.name;
                 isUnnamed = err.abiItem.inputs?.some((x) => !('name' in x && x.name));
             }
+            // Set args undefined if there is an error decoding (e.g. indexed/non-indexed params mismatch).
             return formatLog(log, { args: isUnnamed ? [] : {}, eventName });
         }
     })

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

@@ -1 +1 @@
-{"version":3,"file":"getFilterChanges.js","sourceRoot":"","sources":["../../../../src/actions/public/getFilterChanges.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,qBAAqB,EACrB,uBAAuB,GACxB,MAAM,qBAAqB,CAAA;AAK5B,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAA;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAA;AA2GzD,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAQpC,OAAyC,EACzC,EACE,MAAM,GAC6D;IAErE,MAAM,MAAM,GAAG,QAAQ,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,CAAA;IAElD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAChC,MAAM,EAAE,sBAAsB;QAC9B,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;KACpB,CAAC,CAAA;IACF,OAAO,IAAI;SACR,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,IAAI,OAAO,GAAG,KAAK,QAAQ;YAAE,OAAO,GAAG,CAAA;QACvC,IAAI;YACF,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GACvB,KAAK,IAAI,MAAM,IAAI,MAAM,CAAC,GAAG;gBAC3B,CAAC,CAAC,cAAc,CAAC;oBACb,GAAG,EAAE,MAAM,CAAC,GAAG;oBACf,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,MAAM,EAAE,GAAG,CAAC,MAAa;oBACzB,MAAM;iBACP,CAAC;gBACJ,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAA;YAC/C,OAAO,SAAS,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAA;SAC3C;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,SAAS,CAAA;YACb,IAAI,SAAS,CAAA;YACb,IACE,GAAG,YAAY,qBAAqB;gBACpC,GAAG,YAAY,uBAAuB,EACtC;gBAEA,IAAI,QAAQ,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM;oBAAE,OAAM;gBAC/C,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAA;gBAC5B,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;aACtE;YAGD,OAAO,SAAS,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,CAAC,CAAA;SAChE;IACH,CAAC,CAAC;SACD,MAAM,CAAC,OAAO,CAKhB,CAAA;AACH,CAAC"}
+{"version":3,"file":"getFilterChanges.js","sourceRoot":"","sources":["../../../../src/actions/public/getFilterChanges.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,qBAAqB,EACrB,uBAAuB,GACxB,MAAM,qBAAqB,CAAA;AAK5B,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAA;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAA;AAyBzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiFG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAQpC,OAAyC,EACzC,EACE,MAAM,GAC6D;IAErE,MAAM,MAAM,GAAG,QAAQ,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,CAAA;IAElD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAChC,MAAM,EAAE,sBAAsB;QAC9B,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;KACpB,CAAC,CAAA;IACF,OAAO,IAAI;SACR,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,IAAI,OAAO,GAAG,KAAK,QAAQ;YAAE,OAAO,GAAG,CAAA;QACvC,IAAI;YACF,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GACvB,KAAK,IAAI,MAAM,IAAI,MAAM,CAAC,GAAG;gBAC3B,CAAC,CAAC,cAAc,CAAC;oBACb,GAAG,EAAE,MAAM,CAAC,GAAG;oBACf,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,MAAM,EAAE,GAAG,CAAC,MAAa;oBACzB,MAAM;iBACP,CAAC;gBACJ,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAA;YAC/C,OAAO,SAAS,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAA;SAC3C;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,SAAS,CAAA;YACb,IAAI,SAAS,CAAA;YACb,IACE,GAAG,YAAY,qBAAqB;gBACpC,GAAG,YAAY,uBAAuB,EACtC;gBACA,iFAAiF;gBACjF,IAAI,QAAQ,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM;oBAAE,OAAM;gBAC/C,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAA;gBAC5B,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;aACtE;YAED,+FAA+F;YAC/F,OAAO,SAAS,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,CAAC,CAAA;SAChE;IACH,CAAC,CAAC;SACD,MAAM,CAAC,OAAO,CAKhB,CAAA;AACH,CAAC"}

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

@@ -1,6 +1,33 @@
 import { DecodeLogDataMismatch, DecodeLogTopicsMismatch, } from '../../errors/abi.js';
 import { decodeEventLog } from '../../utils/abi/decodeEventLog.js';
 import { formatLog } from '../../utils/formatters/log.js';
+/**
+ * Returns a list of event logs since the filter was created.
+ *
+ * - Docs: https://viem.sh/docs/actions/public/getFilterLogs.html
+ * - JSON-RPC Methods: [`eth_getFilterLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterlogs)
+ *
+ * `getFilterLogs` is only compatible with **event filters**.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetFilterLogsParameters}
+ * @returns A list of event logs. {@link GetFilterLogsReturnType}
+ *
+ * @example
+ * import { createPublicClient, http, parseAbiItem } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { createEventFilter, getFilterLogs } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const filter = await createEventFilter(client, {
+ *   address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
+ *   event: parseAbiItem('event Transfer(address indexed, address indexed, uint256)'),
+ * })
+ * const logs = await getFilterLogs(client, { filter })
+ */
 export async function getFilterLogs(_client, { filter }) {
     const strict = filter.strict ?? false;
     const logs = await filter.request({
@@ -25,11 +52,13 @@ export async function getFilterLogs(_client, { filter }) {
             let isUnnamed;
             if (err instanceof DecodeLogDataMismatch ||
                 err instanceof DecodeLogTopicsMismatch) {
+                // If strict mode is on, and log data/topics do not match event definition, skip.
                 if ('strict' in filter && filter.strict)
                     return;
                 eventName = err.abiItem.name;
                 isUnnamed = err.abiItem.inputs?.some((x) => !('name' in x && x.name));
             }
+            // Set args to empty if there is an error decoding (e.g. indexed/non-indexed params mismatch).
             return formatLog(log, { args: isUnnamed ? [] : {}, eventName });
         }
     })

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

@@ -1 +1 @@
-{"version":3,"file":"getFilterLogs.js","sourceRoot":"","sources":["../../../../src/actions/public/getFilterLogs.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,qBAAqB,EACrB,uBAAuB,GACxB,MAAM,qBAAqB,CAAA;AAI5B,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAA;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAA;AA+CzD,MAAM,CAAC,KAAK,UAAU,aAAa,CAMjC,OAAwC,EACxC,EAAE,MAAM,EAAsD;IAE9D,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,KAAK,CAAA;IAErC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAChC,MAAM,EAAE,mBAAmB;QAC3B,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;KACpB,CAAC,CAAA;IACF,OAAO,IAAI;SACR,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,IAAI;YACF,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GACvB,KAAK,IAAI,MAAM,IAAI,MAAM,CAAC,GAAG;gBAC3B,CAAC,CAAC,cAAc,CAAC;oBACb,GAAG,EAAE,MAAM,CAAC,GAAG;oBACf,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,MAAM,EAAE,GAAG,CAAC,MAAa;oBACzB,MAAM;iBACP,CAAC;gBACJ,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAA;YAC/C,OAAO,SAAS,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAA;SAC3C;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,SAAS,CAAA;YACb,IAAI,SAAS,CAAA;YACb,IACE,GAAG,YAAY,qBAAqB;gBACpC,GAAG,YAAY,uBAAuB,EACtC;gBAEA,IAAI,QAAQ,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM;oBAAE,OAAM;gBAC/C,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAA;gBAC5B,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;aACtE;YAGD,OAAO,SAAS,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,CAAC,CAAA;SAChE;IACH,CAAC,CAAC;SACD,MAAM,CAAC,OAAO,CAIhB,CAAA;AACH,CAAC"}
+{"version":3,"file":"getFilterLogs.js","sourceRoot":"","sources":["../../../../src/actions/public/getFilterLogs.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,qBAAqB,EACrB,uBAAuB,GACxB,MAAM,qBAAqB,CAAA;AAI5B,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAA;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAA;AAoBzD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAMjC,OAAwC,EACxC,EAAE,MAAM,EAAsD;IAE9D,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,KAAK,CAAA;IAErC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAChC,MAAM,EAAE,mBAAmB;QAC3B,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;KACpB,CAAC,CAAA;IACF,OAAO,IAAI;SACR,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,IAAI;YACF,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GACvB,KAAK,IAAI,MAAM,IAAI,MAAM,CAAC,GAAG;gBAC3B,CAAC,CAAC,cAAc,CAAC;oBACb,GAAG,EAAE,MAAM,CAAC,GAAG;oBACf,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,MAAM,EAAE,GAAG,CAAC,MAAa;oBACzB,MAAM;iBACP,CAAC;gBACJ,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAA;YAC/C,OAAO,SAAS,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAA;SAC3C;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,SAAS,CAAA;YACb,IAAI,SAAS,CAAA;YACb,IACE,GAAG,YAAY,qBAAqB;gBACpC,GAAG,YAAY,uBAAuB,EACtC;gBACA,iFAAiF;gBACjF,IAAI,QAAQ,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM;oBAAE,OAAM;gBAC/C,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAA;gBAC5B,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;aACtE;YAED,8FAA8F;YAC9F,OAAO,SAAS,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,CAAC,CAAA;SAChE;IACH,CAAC,CAAC;SACD,MAAM,CAAC,OAAO,CAIhB,CAAA;AACH,CAAC"}

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

@@ -1,3 +1,23 @@
+/**
+ * Returns the current price of gas (in wei).
+ *
+ * - Docs: https://viem.sh/docs/actions/public/getGasPrice.html
+ * - JSON-RPC Methods: [`eth_gasPrice`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gasprice)
+ *
+ * @param client - Client to use
+ * @returns The gas price (in wei). {@link GetGasPriceReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getGasPrice } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const gasPrice = await getGasPrice(client)
+ */
 export async function getGasPrice(client) {
     const gasPrice = await client.request({
         method: 'eth_gasPrice',

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

@@ -1 +1 @@
-{"version":3,"file":"getGasPrice.js","sourceRoot":"","sources":["../../../../src/actions/public/getGasPrice.ts"],"names":[],"mappings":"AA4BA,MAAM,CAAC,KAAK,UAAU,WAAW,CAI/B,MAE6C;IAE7C,MAAM,QAAQ,GAAG,MAAO,MAAuB,CAAC,OAAO,CAAC;QACtD,MAAM,EAAE,cAAc;KACvB,CAAC,CAAA;IACF,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAA;AACzB,CAAC"}
+{"version":3,"file":"getGasPrice.js","sourceRoot":"","sources":["../../../../src/actions/public/getGasPrice.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAI/B,MAE6C;IAE7C,MAAM,QAAQ,GAAG,MAAO,MAAuB,CAAC,OAAO,CAAC;QACtD,MAAM,EAAE,cAAc;KACvB,CAAC,CAAA;IACF,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAA;AACzB,CAAC"}

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

@@ -3,6 +3,28 @@ import { decodeEventLog } from '../../utils/abi/decodeEventLog.js';
 import { encodeEventTopics, } from '../../utils/abi/encodeEventTopics.js';
 import { numberToHex } from '../../utils/encoding/toHex.js';
 import { formatLog } from '../../utils/formatters/log.js';
+/**
+ * Returns a list of event logs matching the provided parameters.
+ *
+ * - Docs: https://viem.sh/docs/actions/public/getLogs.html
+ * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/filters-and-logs/event-logs
+ * - JSON-RPC Methods: [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs)
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetLogsParameters}
+ * @returns A list of event logs. {@link GetLogsReturnType}
+ *
+ * @example
+ * import { createPublicClient, http, parseAbiItem } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getLogs } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const logs = await getLogs(client)
+ */
 export async function getLogs(client, { address, blockHash, fromBlock, toBlock, event, args, strict: strict_, } = {}) {
     const strict = strict_ ?? false;
     let topics = [];
@@ -50,11 +72,13 @@ export async function getLogs(client, { address, blockHash, fromBlock, toBlock,
             let isUnnamed;
             if (err instanceof DecodeLogDataMismatch ||
                 err instanceof DecodeLogTopicsMismatch) {
+                // If strict mode is on, and log data/topics do not match event definition, skip.
                 if (strict)
                     return;
                 eventName = err.abiItem.name;
                 isUnnamed = err.abiItem.inputs?.some((x) => !('name' in x && x.name));
             }
+            // Set args to empty if there is an error decoding (e.g. indexed/non-indexed params mismatch).
             return formatLog(log, { args: isUnnamed ? [] : {}, eventName });
         }
     })

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

@@ -1 +1 @@
-{"version":3,"file":"getLogs.js","sourceRoot":"","sources":["../../../../src/actions/public/getLogs.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,qBAAqB,EACrB,uBAAuB,GACxB,MAAM,qBAAqB,CAAA;AAU5B,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAA;AAClE,OAAO,EAEL,iBAAiB,GAClB,MAAM,sCAAsC,CAAA;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAA;AAqEzD,MAAM,CAAC,KAAK,UAAU,OAAO,CAK3B,MAAuC,EACvC,EACE,OAAO,EACP,SAAS,EACT,SAAS,EACT,OAAO,EACP,KAAK,EACL,IAAI,EACJ,MAAM,EAAE,OAAO,MAC0B,EAAE;IAE7C,MAAM,MAAM,GAAG,OAAO,IAAI,KAAK,CAAA;IAE/B,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,IAAI,IAAc,CAAA;IAClB,IAAI,SAAS,EAAE;QACb,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YAC1B,MAAM,EAAE,aAAa;YACrB,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;SACzC,CAAC,CAAA;KACH;SAAM;QACL,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YAC1B,MAAM,EAAE,aAAa;YACrB,MAAM,EAAE;gBACN;oBACE,OAAO;oBACP,MAAM;oBACN,SAAS,EACP,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;oBACpE,OAAO,EAAE,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO;iBACtE;aACF;SACF,CAAC,CAAA;KACH;IAED,OAAO,IAAI;SACR,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,IAAI;YACF,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,KAAK;gBAC/B,CAAC,CAAC,cAAc,CAAC;oBACb,GAAG,EAAE,CAAC,KAAK,CAAe;oBAC1B,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,MAAM,EAAE,GAAG,CAAC,MAAa;oBACzB,MAAM;iBACP,CAAC;gBACJ,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAA;YAC7C,OAAO,SAAS,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAA;SAC3C;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,SAAS,CAAA;YACb,IAAI,SAAS,CAAA;YACb,IACE,GAAG,YAAY,qBAAqB;gBACpC,GAAG,YAAY,uBAAuB,EACtC;gBAEA,IAAI,MAAM;oBAAE,OAAM;gBAClB,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAA;gBAC5B,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;aACtE;YAGD,OAAO,SAAS,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,CAAC,CAAA;SAChE;IACH,CAAC,CAAC;SACD,MAAM,CAAC,OAAO,CAAqD,CAAA;AACxE,CAAC"}
+{"version":3,"file":"getLogs.js","sourceRoot":"","sources":["../../../../src/actions/public/getLogs.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,qBAAqB,EACrB,uBAAuB,GACxB,MAAM,qBAAqB,CAAA;AAU5B,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAA;AAClE,OAAO,EAEL,iBAAiB,GAClB,MAAM,sCAAsC,CAAA;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAA;AA+CzD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAK3B,MAAuC,EACvC,EACE,OAAO,EACP,SAAS,EACT,SAAS,EACT,OAAO,EACP,KAAK,EACL,IAAI,EACJ,MAAM,EAAE,OAAO,MAC0B,EAAE;IAE7C,MAAM,MAAM,GAAG,OAAO,IAAI,KAAK,CAAA;IAE/B,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,IAAI,IAAc,CAAA;IAClB,IAAI,SAAS,EAAE;QACb,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YAC1B,MAAM,EAAE,aAAa;YACrB,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;SACzC,CAAC,CAAA;KACH;SAAM;QACL,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YAC1B,MAAM,EAAE,aAAa;YACrB,MAAM,EAAE;gBACN;oBACE,OAAO;oBACP,MAAM;oBACN,SAAS,EACP,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;oBACpE,OAAO,EAAE,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO;iBACtE;aACF;SACF,CAAC,CAAA;KACH;IAED,OAAO,IAAI;SACR,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,IAAI;YACF,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,KAAK;gBAC/B,CAAC,CAAC,cAAc,CAAC;oBACb,GAAG,EAAE,CAAC,KAAK,CAAe;oBAC1B,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,MAAM,EAAE,GAAG,CAAC,MAAa;oBACzB,MAAM;iBACP,CAAC;gBACJ,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAA;YAC7C,OAAO,SAAS,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAA;SAC3C;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,SAAS,CAAA;YACb,IAAI,SAAS,CAAA;YACb,IACE,GAAG,YAAY,qBAAqB;gBACpC,GAAG,YAAY,uBAAuB,EACtC;gBACA,iFAAiF;gBACjF,IAAI,MAAM;oBAAE,OAAM;gBAClB,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAA;gBAC5B,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;aACtE;YAED,8FAA8F;YAC9F,OAAO,SAAS,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,CAAC,CAAA;SAChE;IACH,CAAC,CAAC;SACD,MAAM,CAAC,OAAO,CAAqD,CAAA;AACxE,CAAC"}

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

@@ -1,4 +1,28 @@
 import { numberToHex } from '../../utils/encoding/toHex.js';
+/**
+ * Returns the value from a storage slot at a given address.
+ *
+ * - Docs: https://viem.sh/docs/contract/getStorageAt.html
+ * - JSON-RPC Methods: [`eth_getStorageAt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getstorageat)
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetStorageAtParameters}
+ * @returns The value of the storage slot. {@link GetStorageAtReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getStorageAt } from 'viem/contract'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const code = await getStorageAt(client, {
+ *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+ *   slot: toHex(0),
+ * })
+ */
 export async function getStorageAt(client, { address, blockNumber, blockTag = 'latest', slot }) {
     const blockNumberHex = blockNumber !== undefined ? numberToHex(blockNumber) : undefined;
     const data = await client.request({

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

@@ -1 +1 @@
-{"version":3,"file":"getStorageAt.js","sourceRoot":"","sources":["../../../../src/actions/public/getStorageAt.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AA0C3D,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAuC,EACvC,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,GAAG,QAAQ,EAAE,IAAI,EAA0B;IAE3E,MAAM,cAAc,GAClB,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAClE,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAChC,MAAM,EAAE,kBAAkB;QAC1B,MAAM,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,cAAc,IAAI,QAAQ,CAAC;KACpD,CAAC,CAAA;IACF,OAAO,IAAI,CAAA;AACb,CAAC"}
+{"version":3,"file":"getStorageAt.js","sourceRoot":"","sources":["../../../../src/actions/public/getStorageAt.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAkB3D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAuC,EACvC,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,GAAG,QAAQ,EAAE,IAAI,EAA0B;IAE3E,MAAM,cAAc,GAClB,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAClE,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAChC,MAAM,EAAE,kBAAkB;QAC1B,MAAM,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,cAAc,IAAI,QAAQ,CAAC;KACpD,CAAC,CAAA;IACF,OAAO,IAAI,CAAA;AACb,CAAC"}

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

@@ -2,6 +2,30 @@ import { TransactionNotFoundError } from '../../errors/transaction.js';
 import { numberToHex } from '../../utils/encoding/toHex.js';
 import { format } from '../../utils/formatters/format.js';
 import { formatTransaction, } from '../../utils/formatters/transaction.js';
+/**
+ * Returns information about a [Transaction](https://viem.sh/docs/glossary/terms.html#transaction) given a hash or block identifier.
+ *
+ * - Docs: https://viem.sh/docs/actions/public/getTransaction.html
+ * - Example: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/transactions/fetching-transactions
+ * - JSON-RPC Methods: [`eth_getTransactionByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionByHash)
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetTransactionParameters}
+ * @returns The transaction information. {@link GetTransactionReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getTransaction } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const transaction = await getTransaction(client, {
+ *   hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
+ * })
+ */
 export async function getTransaction(client, { blockHash, blockNumber, blockTag = 'latest', hash, index, }) {
     const blockNumberHex = blockNumber !== undefined ? numberToHex(blockNumber) : undefined;
     let transaction = null;

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

@@ -1 +1 @@
-{"version":3,"file":"getTransaction.js","sourceRoot":"","sources":["../../../../src/actions/public/getTransaction.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAA;AAKtE,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAA;AACzD,OAAO,EAGL,iBAAiB,GAClB,MAAM,uCAAuC,CAAA;AAkE9C,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,MAAuC,EACvC,EACE,SAAS,EACT,WAAW,EACX,QAAQ,GAAG,QAAQ,EACnB,IAAI,EACJ,KAAK,GACoB;IAE3B,MAAM,cAAc,GAClB,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAElE,IAAI,WAAW,GAA0B,IAAI,CAAA;IAC7C,IAAI,IAAI,EAAE;QACR,WAAW,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YACjC,MAAM,EAAE,0BAA0B;YAClC,MAAM,EAAE,CAAC,IAAI,CAAC;SACf,CAAC,CAAA;KACH;SAAM,IAAI,SAAS,EAAE;QACpB,WAAW,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YACjC,MAAM,EAAE,uCAAuC;YAC/C,MAAM,EAAE,CAAC,SAAS,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;SACxC,CAAC,CAAA;KACH;SAAM,IAAI,cAAc,IAAI,QAAQ,EAAE;QACrC,WAAW,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YACjC,MAAM,EAAE,yCAAyC;YACjD,MAAM,EAAE,CAAC,cAAc,IAAI,QAAQ,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;SACzD,CAAC,CAAA;KACH;IAED,IAAI,CAAC,WAAW;QACd,MAAM,IAAI,wBAAwB,CAAC;YACjC,SAAS;YACT,WAAW;YACX,QAAQ;YACR,IAAI;YACJ,KAAK;SACN,CAAC,CAAA;IAEJ,OAAO,MAAM,CAAC,WAAW,EAAE;QACzB,SAAS,EAAE,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,WAAW,IAAI,iBAAiB;KACtE,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"getTransaction.js","sourceRoot":"","sources":["../../../../src/actions/public/getTransaction.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAA;AAKtE,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAA;AACzD,OAAO,EAGL,iBAAiB,GAClB,MAAM,uCAAuC,CAAA;AA0C9C;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,MAAuC,EACvC,EACE,SAAS,EACT,WAAW,EACX,QAAQ,GAAG,QAAQ,EACnB,IAAI,EACJ,KAAK,GACoB;IAE3B,MAAM,cAAc,GAClB,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAElE,IAAI,WAAW,GAA0B,IAAI,CAAA;IAC7C,IAAI,IAAI,EAAE;QACR,WAAW,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YACjC,MAAM,EAAE,0BAA0B;YAClC,MAAM,EAAE,CAAC,IAAI,CAAC;SACf,CAAC,CAAA;KACH;SAAM,IAAI,SAAS,EAAE;QACpB,WAAW,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YACjC,MAAM,EAAE,uCAAuC;YAC/C,MAAM,EAAE,CAAC,SAAS,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;SACxC,CAAC,CAAA;KACH;SAAM,IAAI,cAAc,IAAI,QAAQ,EAAE;QACrC,WAAW,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YACjC,MAAM,EAAE,yCAAyC;YACjD,MAAM,EAAE,CAAC,cAAc,IAAI,QAAQ,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;SACzD,CAAC,CAAA;KACH;IAED,IAAI,CAAC,WAAW;QACd,MAAM,IAAI,wBAAwB,CAAC;YACjC,SAAS;YACT,WAAW;YACX,QAAQ;YACR,IAAI;YACJ,KAAK;SACN,CAAC,CAAA;IAEJ,OAAO,MAAM,CAAC,WAAW,EAAE;QACzB,SAAS,EAAE,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,WAAW,IAAI,iBAAiB;KACtE,CAAC,CAAA;AACJ,CAAC"}

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

@@ -1,5 +1,29 @@
 import { getBlockNumber } from './getBlockNumber.js';
 import { getTransaction } from './getTransaction.js';
+/**
+ * Returns the number of blocks passed (confirmations) since the transaction was processed on a block.
+ *
+ * - Docs: https://viem.sh/docs/actions/public/getTransactionConfirmations.html
+ * - Example: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/transactions/fetching-transactions
+ * - JSON-RPC Methods: [`eth_getTransactionConfirmations`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionConfirmations)
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetTransactionConfirmationsParameters}
+ * @returns The number of blocks passed since the transaction was processed. If confirmations is 0, then the Transaction has not been confirmed & processed yet. {@link GetTransactionConfirmationsReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getTransactionConfirmations } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const confirmations = await getTransactionConfirmations(client, {
+ *   hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
+ * })
+ */
 export async function getTransactionConfirmations(client, { hash, transactionReceipt }) {
     const [blockNumber, transaction] = await Promise.all([
         getBlockNumber(client),