viem 1.0.2 → 1.0.3

package/dist/esm/actions/ens/getEnsName.js

@@ -4,6 +4,32 @@ import { getChainContractAddress } from '../../utils/chain.js';
 import { toHex } from '../../utils/encoding/toHex.js';
 import { packetToBytes } from '../../utils/ens/packetToBytes.js';
 import { readContract, } from '../public/readContract.js';
+/**
+ * Gets primary name for specified address.
+ *
+ * - Docs: https://viem.sh/docs/ens/actions/getEnsName.html
+ * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
+ *
+ * Calls `reverse(bytes)` on ENS Universal Resolver Contract to "reverse resolve" the address to the primary ENS name.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetEnsNameParameters}
+ * @returns Name or `null` if not found. {@link GetEnsNameReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getEnsName } from 'viem/ens'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const ensName = await getEnsName(client, {
+ *   address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
+ * })
+ * // 'wagmi-dev.eth'
+ */
 export async function getEnsName(client, { address, blockNumber, blockTag, universalResolverAddress: universalResolverAddress_, }) {
     let universalResolverAddress = universalResolverAddress_;
     if (!universalResolverAddress) {
@@ -43,6 +69,7 @@ export async function getEnsName(client, { address, blockNumber, blockTag, unive
     catch (error) {
         if (error instanceof ContractFunctionExecutionError &&
             error.cause.reason === panicReasons[50])
+            // No primary name set for address.
             return null;
         throw error;
     }

package/dist/esm/actions/ens/getEnsName.js.map

@@ -1 +1 @@
-{"version":3,"file":"getEnsName.js","sourceRoot":"","sources":["../../../../src/actions/ens/getEnsName.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EACL,8BAA8B,GAE/B,MAAM,0BAA0B,CAAA;AAGjC,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAA;AAChE,OAAO,EAEL,YAAY,GACb,MAAM,2BAA2B,CAAA;AAuClC,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAuC,EACvC,EACE,OAAO,EACP,WAAW,EACX,QAAQ,EACR,wBAAwB,EAAE,yBAAyB,GAC9B;IAEvB,IAAI,wBAAwB,GAAG,yBAAyB,CAAA;IACxD,IAAI,CAAC,wBAAwB,EAAE;QAC7B,IAAI,CAAC,MAAM,CAAC,KAAK;YACf,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAA;QAEH,wBAAwB,GAAG,uBAAuB,CAAC;YACjD,WAAW;YACX,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,QAAQ,EAAE,sBAAsB;SACjC,CAAC,CAAA;KACH;IAED,MAAM,WAAW,GAAG,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,eAAe,CAAA;IACxE,IAAI;QACF,MAAM,GAAG,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE;YACrC,OAAO,EAAE,wBAAwB;YACjC,GAAG,EAAE;gBACH;oBACE,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE,UAAU;oBAChB,eAAe,EAAE,MAAM;oBACvB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;oBAChD,OAAO,EAAE;wBACP,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,cAAc,EAAE;wBACxC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,iBAAiB,EAAE;wBAC5C,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,iBAAiB,EAAE;wBAC5C,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE;qBACtC;iBACF;aACF;YACD,YAAY,EAAE,SAAS;YACvB,IAAI,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC;YACzC,WAAW;YACX,QAAQ;SACT,CAAC,CAAA;QACF,OAAO,GAAG,CAAC,CAAC,CAAC,CAAA;KACd;IAAC,OAAO,KAAK,EAAE;QACd,IACE,KAAK,YAAY,8BAA8B;YAC9C,KAAK,CAAC,KAAuC,CAAC,MAAM,KAAK,YAAY,CAAC,EAAE,CAAC;YAG1E,OAAO,IAAI,CAAA;QACb,MAAM,KAAK,CAAA;KACZ;AACH,CAAC"}
+{"version":3,"file":"getEnsName.js","sourceRoot":"","sources":["../../../../src/actions/ens/getEnsName.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EACL,8BAA8B,GAE/B,MAAM,0BAA0B,CAAA;AAGjC,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAA;AAChE,OAAO,EAEL,YAAY,GACb,MAAM,2BAA2B,CAAA;AAalC;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAuC,EACvC,EACE,OAAO,EACP,WAAW,EACX,QAAQ,EACR,wBAAwB,EAAE,yBAAyB,GAC9B;IAEvB,IAAI,wBAAwB,GAAG,yBAAyB,CAAA;IACxD,IAAI,CAAC,wBAAwB,EAAE;QAC7B,IAAI,CAAC,MAAM,CAAC,KAAK;YACf,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAA;QAEH,wBAAwB,GAAG,uBAAuB,CAAC;YACjD,WAAW;YACX,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,QAAQ,EAAE,sBAAsB;SACjC,CAAC,CAAA;KACH;IAED,MAAM,WAAW,GAAG,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,eAAe,CAAA;IACxE,IAAI;QACF,MAAM,GAAG,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE;YACrC,OAAO,EAAE,wBAAwB;YACjC,GAAG,EAAE;gBACH;oBACE,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE,UAAU;oBAChB,eAAe,EAAE,MAAM;oBACvB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;oBAChD,OAAO,EAAE;wBACP,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,cAAc,EAAE;wBACxC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,iBAAiB,EAAE;wBAC5C,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,iBAAiB,EAAE;wBAC5C,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE;qBACtC;iBACF;aACF;YACD,YAAY,EAAE,SAAS;YACvB,IAAI,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC;YACzC,WAAW;YACX,QAAQ;SACT,CAAC,CAAA;QACF,OAAO,GAAG,CAAC,CAAC,CAAC,CAAA;KACd;IAAC,OAAO,KAAK,EAAE;QACd,IACE,KAAK,YAAY,8BAA8B;YAC9C,KAAK,CAAC,KAAuC,CAAC,MAAM,KAAK,YAAY,CAAC,EAAE,CAAC;YAE1E,mCAAmC;YACnC,OAAO,IAAI,CAAA;QACb,MAAM,KAAK,CAAA;KACZ;AACH,CAAC"}

package/dist/esm/actions/ens/getEnsResolver.js

@@ -2,6 +2,34 @@ import { getChainContractAddress } from '../../utils/chain.js';
 import { toHex } from '../../utils/encoding/toHex.js';
 import { packetToBytes } from '../../utils/ens/packetToBytes.js';
 import { readContract, } from '../public/readContract.js';
+/**
+ * Gets resolver for ENS name.
+ *
+ * - Docs: https://viem.sh/docs/ens/actions/getEnsResolver.html
+ * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
+ *
+ * Calls `findResolver(bytes)` on ENS Universal Resolver Contract to retrieve the resolver of an ENS name.
+ *
+ * Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize.html) function for this.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetEnsResolverParameters}
+ * @returns Address for ENS resolver. {@link GetEnsResolverReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getEnsResolver, normalize } from 'viem/ens'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const resolverAddress = await getEnsResolver(client, {
+ *   name: normalize('wagmi-dev.eth'),
+ * })
+ * // '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41'
+ */
 export async function getEnsResolver(client, { blockNumber, blockTag, name, universalResolverAddress: universalResolverAddress_, }) {
     let universalResolverAddress = universalResolverAddress_;
     if (!universalResolverAddress) {

package/dist/esm/actions/ens/getEnsResolver.js.map

@@ -1 +1 @@
-{"version":3,"file":"getEnsResolver.js","sourceRoot":"","sources":["../../../../src/actions/ens/getEnsResolver.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAA;AAChE,OAAO,EAEL,YAAY,GACb,MAAM,2BAA2B,CAAA;AAyClC,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,MAAuC,EACvC,EACE,WAAW,EACX,QAAQ,EACR,IAAI,EACJ,wBAAwB,EAAE,yBAAyB,GAC1B;IAE3B,IAAI,wBAAwB,GAAG,yBAAyB,CAAA;IACxD,IAAI,CAAC,wBAAwB,EAAE;QAC7B,IAAI,CAAC,MAAM,CAAC,KAAK;YACf,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAA;QAEH,wBAAwB,GAAG,uBAAuB,CAAC;YACjD,WAAW;YACX,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,QAAQ,EAAE,sBAAsB;SACjC,CAAC,CAAA;KACH;IAED,MAAM,CAAC,eAAe,CAAC,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE;QACnD,OAAO,EAAE,wBAAwB;QACjC,GAAG,EAAE;YACH;gBACE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;gBAC3B,IAAI,EAAE,cAAc;gBACpB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;gBACnD,eAAe,EAAE,MAAM;gBACvB,IAAI,EAAE,UAAU;aACjB;SACF;QACD,YAAY,EAAE,cAAc;QAC5B,IAAI,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;QAClC,WAAW;QACX,QAAQ;KACT,CAAC,CAAA;IACF,OAAO,eAAe,CAAA;AACxB,CAAC"}
+{"version":3,"file":"getEnsResolver.js","sourceRoot":"","sources":["../../../../src/actions/ens/getEnsResolver.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAA;AAChE,OAAO,EAEL,YAAY,GACb,MAAM,2BAA2B,CAAA;AAalC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,MAAuC,EACvC,EACE,WAAW,EACX,QAAQ,EACR,IAAI,EACJ,wBAAwB,EAAE,yBAAyB,GAC1B;IAE3B,IAAI,wBAAwB,GAAG,yBAAyB,CAAA;IACxD,IAAI,CAAC,wBAAwB,EAAE;QAC7B,IAAI,CAAC,MAAM,CAAC,KAAK;YACf,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAA;QAEH,wBAAwB,GAAG,uBAAuB,CAAC;YACjD,WAAW;YACX,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,QAAQ,EAAE,sBAAsB;SACjC,CAAC,CAAA;KACH;IAED,MAAM,CAAC,eAAe,CAAC,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE;QACnD,OAAO,EAAE,wBAAwB;QACjC,GAAG,EAAE;YACH;gBACE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;gBAC3B,IAAI,EAAE,cAAc;gBACpB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;gBACnD,eAAe,EAAE,MAAM;gBACvB,IAAI,EAAE,UAAU;aACjB;SACF;QACD,YAAY,EAAE,cAAc;QAC5B,IAAI,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;QAClC,WAAW;QACX,QAAQ;KACT,CAAC,CAAA;IACF,OAAO,eAAe,CAAA;AACxB,CAAC"}

package/dist/esm/actions/ens/getEnsText.js

@@ -6,6 +6,35 @@ import { toHex } from '../../utils/encoding/toHex.js';
 import { namehash } from '../../utils/ens/namehash.js';
 import { packetToBytes } from '../../utils/ens/packetToBytes.js';
 import { readContract, } from '../public/readContract.js';
+/**
+ * Gets a text record for specified ENS name.
+ *
+ * - Docs: https://viem.sh/docs/ens/actions/getEnsResolver.html
+ * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
+ *
+ * Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract.
+ *
+ * Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize.html) function for this.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetEnsTextParameters}
+ * @returns Address for ENS resolver. {@link GetEnsTextReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getEnsText, normalize } from 'viem/ens'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const twitterRecord = await getEnsText(client, {
+ *   name: normalize('wagmi-dev.eth'),
+ *   key: 'com.twitter',
+ * })
+ * // 'wagmi_sh'
+ */
 export async function getEnsText(client, { blockNumber, blockTag, name, key, universalResolverAddress: universalResolverAddress_, }) {
     let universalResolverAddress = universalResolverAddress_;
     if (!universalResolverAddress) {

package/dist/esm/actions/ens/getEnsText.js.map

@@ -1 +1 @@
-{"version":3,"file":"getEnsText.js","sourceRoot":"","sources":["../../../../src/actions/ens/getEnsText.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAG/E,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,KAAK,EAAE,MAAM,+BAA+B,CAAA;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAA;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAA;AAChE,OAAO,EAEL,YAAY,GACb,MAAM,2BAA2B,CAAA;AA4ClC,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAuC,EACvC,EACE,WAAW,EACX,QAAQ,EACR,IAAI,EACJ,GAAG,EACH,wBAAwB,EAAE,yBAAyB,GAC9B;IAEvB,IAAI,wBAAwB,GAAG,yBAAyB,CAAA;IACxD,IAAI,CAAC,wBAAwB,EAAE;QAC7B,IAAI,CAAC,MAAM,CAAC,KAAK;YACf,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAA;QAEH,wBAAwB,GAAG,uBAAuB,CAAC;YACjD,WAAW;YACX,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,QAAQ,EAAE,sBAAsB;SACjC,CAAC,CAAA;KACH;IAED,MAAM,GAAG,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE;QACrC,OAAO,EAAE,wBAAwB;QACjC,GAAG,EAAE,oBAAoB;QACzB,YAAY,EAAE,SAAS;QACvB,IAAI,EAAE;YACJ,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC1B,kBAAkB,CAAC;gBACjB,GAAG,EAAE,eAAe;gBACpB,YAAY,EAAE,MAAM;gBACpB,IAAI,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC;aAC5B,CAAC;SACH;QACD,WAAW;QACX,QAAQ;KACT,CAAC,CAAA;IAEF,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI;QAAE,OAAO,IAAI,CAAA;IAEhC,MAAM,MAAM,GAAG,oBAAoB,CAAC;QAClC,GAAG,EAAE,eAAe;QACpB,YAAY,EAAE,MAAM;QACpB,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;KACb,CAAC,CAAA;IAEF,OAAO,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAA;AACtC,CAAC"}
+{"version":3,"file":"getEnsText.js","sourceRoot":"","sources":["../../../../src/actions/ens/getEnsText.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAG/E,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,KAAK,EAAE,MAAM,+BAA+B,CAAA;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAA;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAA;AAChE,OAAO,EAEL,YAAY,GACb,MAAM,2BAA2B,CAAA;AAelC;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAuC,EACvC,EACE,WAAW,EACX,QAAQ,EACR,IAAI,EACJ,GAAG,EACH,wBAAwB,EAAE,yBAAyB,GAC9B;IAEvB,IAAI,wBAAwB,GAAG,yBAAyB,CAAA;IACxD,IAAI,CAAC,wBAAwB,EAAE;QAC7B,IAAI,CAAC,MAAM,CAAC,KAAK;YACf,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAA;QAEH,wBAAwB,GAAG,uBAAuB,CAAC;YACjD,WAAW;YACX,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,QAAQ,EAAE,sBAAsB;SACjC,CAAC,CAAA;KACH;IAED,MAAM,GAAG,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE;QACrC,OAAO,EAAE,wBAAwB;QACjC,GAAG,EAAE,oBAAoB;QACzB,YAAY,EAAE,SAAS;QACvB,IAAI,EAAE;YACJ,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC1B,kBAAkB,CAAC;gBACjB,GAAG,EAAE,eAAe;gBACpB,YAAY,EAAE,MAAM;gBACpB,IAAI,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC;aAC5B,CAAC;SACH;QACD,WAAW;QACX,QAAQ;KACT,CAAC,CAAA;IAEF,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI;QAAE,OAAO,IAAI,CAAA;IAEhC,MAAM,MAAM,GAAG,oBAAoB,CAAC;QAClC,GAAG,EAAE,eAAe;QACpB,YAAY,EAAE,MAAM;QACpB,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;KACb,CAAC,CAAA;IAEF,OAAO,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAA;AACtC,CAAC"}

package/dist/esm/actions/getContract.js

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

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

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

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

@@ -14,6 +14,31 @@ import { format } from '../../utils/formatters/format.js';
 import { formatTransactionRequest, } from '../../utils/formatters/transactionRequest.js';
 import { createBatchScheduler } from '../../utils/promise/createBatchScheduler.js';
 import { assertRequest } from '../../utils/transaction/assertRequest.js';
+/**
+ * Executes a new message call immediately without submitting a transaction to the network.
+ *
+ * - Docs: https://viem.sh/docs/actions/public/call.html
+ * - JSON-RPC Methods: [`eth_call`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_call)
+ *
+ * @param client - Client to use
+ * @param parameters - {@link CallParameters}
+ * @returns The call data. {@link CallReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { call } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const data = await call(client, {
+ *   account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+ *   data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
+ *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ * })
+ */
 export async function call(client, args) {
     const { account: account_, batch = Boolean(client.batch?.multicall), blockNumber, blockTag = 'latest', accessList, data, gas, gasPrice, maxFeePerGas, maxPriorityFeePerGas, nonce, to, value, ...rest } = args;
     const account = account_ ? parseAccount(account_) : undefined;
@@ -33,6 +58,7 @@ 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,
@@ -74,6 +100,11 @@ export async function call(client, args) {
         });
     }
 }
+// We only want to perform a scheduled multicall if:
+// - The request has calldata,
+// - The request has a target address,
+// - The target address is not already the aggregate3 signature,
+// - The request has no other properties (`nonce`, `gas`, etc cannot be sent with a multicall).
 function shouldPerformMulticall({ request }) {
     const { data, to, ...request_ } = request;
     if (!data)

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

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

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

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

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

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

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

@@ -1,6 +1,28 @@
 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',

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

@@ -1 +1 @@
-{"version":3,"file":"createContractEventFilter.js","sourceRoot":"","sources":["../../../../src/actions/public/createContractEventFilter.ts"],"names":[],"mappings":"AAWA,OAAO,EAEL,iBAAiB,GAClB,MAAM,sCAAsC,CAAA;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAAE,wBAAwB,EAAE,MAAM,iDAAiD,CAAA;AAkE1F,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAO7C,MAAuC,EACvC,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"}
+{"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,MAAuC,EACvC,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,6 +1,29 @@
 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',

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

@@ -1 +1 @@
-{"version":3,"file":"createEventFilter.js","sourceRoot":"","sources":["../../../../src/actions/public/createEventFilter.ts"],"names":[],"mappings":"AAaA,OAAO,EAEL,iBAAiB,GAClB,MAAM,sCAAsC,CAAA;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAAE,wBAAwB,EAAE,MAAM,iDAAiD,CAAA;AAmF1F,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAUrC,MAAuC,EACvC,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"}
+{"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,MAAuC,EACvC,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,4 +1,25 @@
 import { createFilterRequestScope } from '../../utils/filters/createFilterRequestScope.js';
+/**
+ * Creates a Filter to listen for new pending transaction hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges.html).
+ *
+ * - Docs: https://viem.sh/docs/actions/public/createPendingTransactionFilter.html
+ * - JSON-RPC Methods: [`eth_newPendingTransactionFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newpendingtransactionfilter)
+ *
+ * @param client - Client to use
+ * @returns [`Filter`](https://viem.sh/docs/glossary/types.html#filter). {@link CreateBlockFilterReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { createPendingTransactionFilter } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const filter = await createPendingTransactionFilter(client)
+ * // { id: "0x345a6572337856574a76364e457a4366", type: 'transaction' }
+ */
 export async function createPendingTransactionFilter(client) {
     const getRequest = createFilterRequestScope(client, {
         method: 'eth_newPendingTransactionFilter',

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

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

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

@@ -2,6 +2,33 @@ 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 data = encodeFunctionData({
         abi,

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

@@ -1 +1 @@
-{"version":3,"file":"estimateContractGas.js","sourceRoot":"","sources":["../../../../src/actions/public/estimateContractGas.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAA;AAMnE,OAAO,EAEL,kBAAkB,GACnB,MAAM,uCAAuC,CAAA;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAA;AAGzE,OAAO,EAA8B,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAwC1E,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAMvC,MAE6C,EAC7C,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"}
+{"version":3,"file":"estimateContractGas.js","sourceRoot":"","sources":["../../../../src/actions/public/estimateContractGas.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAA;AAMnE,OAAO,EAEL,kBAAkB,GACnB,MAAM,uCAAuC,CAAA;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAA;AAGzE,OAAO,EAA8B,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAa1E;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAMvC,MAE6C,EAC7C,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

@@ -7,6 +7,31 @@ 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';
+/**
+ * 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) {
     const account_ = args.account ?? client.account;
     if (!account_)
@@ -31,6 +56,7 @@ 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,

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,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,IAAK,MAAuB,CAAC,OAAO,CAAA;IACjE,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,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,MAAO,MAAuB,CAAC,OAAO,CAAC;YACrD,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;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;AAgC1E;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAI/B,MAE6C,EAC7C,IAA6C;IAE7C,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,IAAK,MAAuB,CAAC,OAAO,CAAA;IACjE,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,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,MAAO,MAAuB,CAAC,OAAO,CAAC;YACrD,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,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"}