viem 0.3.0 → 0.3.2

package/dist/types/clients/createPublicClient.d.ts

@@ -6,7 +6,23 @@ import type { Chain, Prettify } from '../types/index.js';
 export type PublicClientConfig<TTransport extends Transport = Transport, TChain extends Chain | undefined = Chain | undefined> = Pick<ClientConfig<TTransport, TChain>, 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'>;
 export type PublicClient<TTransport extends Transport = Transport, TChain extends Chain | undefined = Chain | undefined, TIncludeActions extends boolean = true> = Prettify<Client<TTransport, PublicRequests, TChain> & (TIncludeActions extends true ? PublicActions<TTransport, TChain> : unknown)>;
 /**
- * @description Creates a public client with a given transport.
+ * Creates a Public Client with a given [Transport](https://viem.sh/docs/clients/intro) configured for a [Chain](https://viem.sh/docs/clients/chains).
+ *
+ * - Docs: https://viem.sh/docs/clients/public.html
+ *
+ * A Public Client is an interface to "public" [JSON-RPC API](https://ethereum.org/en/developers/docs/apis/json-rpc/) methods such as retrieving block numbers, transactions, reading from smart contracts, etc through [Public Actions](/docs/actions/public/introduction).
+ *
+ * @param config - {@link PublicClientConfig}
+ * @returns A Public Client. {@link PublicClient}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
  */
 export declare function createPublicClient<TTransport extends Transport, TChain extends Chain | undefined = undefined>({ chain, key, name, transport, pollingInterval, }: PublicClientConfig<TTransport, TChain>): PublicClient<TTransport, TChain, true>;
 //# sourceMappingURL=createPublicClient.d.ts.map

package/dist/types/clients/createPublicClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createPublicClient.d.ts","sourceRoot":"","sources":["../../../src/clients/createPublicClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACzD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAA;AAChE,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAG7D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAC1D,OAAO,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAExD,MAAM,MAAM,kBAAkB,CAC5B,UAAU,SAAS,SAAS,GAAG,SAAS,EACxC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,IAClD,IAAI,CACN,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,EAChC,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,iBAAiB,GAAG,WAAW,CAC3D,CAAA;AAED,MAAM,MAAM,YAAY,CACtB,UAAU,SAAS,SAAS,GAAG,SAAS,EACxC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,eAAe,SAAS,OAAO,GAAG,IAAI,IACpC,QAAQ,CACV,MAAM,CAAC,UAAU,EAAE,cAAc,EAAE,MAAM,CAAC,GACxC,CAAC,eAAe,SAAS,IAAI,GAAG,aAAa,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,CAC/E,CAAA;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,SAAS,SAAS,EAC5B,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAC5C,EACA,KAAK,EACL,GAAc,EACd,IAAsB,EACtB,SAAS,EACT,eAAe,GAChB,EAAE,kBAAkB,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,YAAY,CACtD,UAAU,EACV,MAAM,EACN,IAAI,CACL,CAaA"}
+{"version":3,"file":"createPublicClient.d.ts","sourceRoot":"","sources":["../../../src/clients/createPublicClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACzD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAA;AAChE,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAG7D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAC1D,OAAO,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAExD,MAAM,MAAM,kBAAkB,CAC5B,UAAU,SAAS,SAAS,GAAG,SAAS,EACxC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,IAClD,IAAI,CACN,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,EAChC,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,iBAAiB,GAAG,WAAW,CAC3D,CAAA;AAED,MAAM,MAAM,YAAY,CACtB,UAAU,SAAS,SAAS,GAAG,SAAS,EACxC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,eAAe,SAAS,OAAO,GAAG,IAAI,IACpC,QAAQ,CACV,MAAM,CAAC,UAAU,EAAE,cAAc,EAAE,MAAM,CAAC,GACxC,CAAC,eAAe,SAAS,IAAI,GAAG,aAAa,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,CAC/E,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,SAAS,SAAS,EAC5B,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAC5C,EACA,KAAK,EACL,GAAc,EACd,IAAsB,EACtB,SAAS,EACT,eAAe,GAChB,EAAE,kBAAkB,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,YAAY,CACtD,UAAU,EACV,MAAM,EACN,IAAI,CACL,CAaA"}

package/dist/types/clients/createTestClient.d.ts

@@ -14,5 +14,25 @@ export type TestClient<TMode extends TestClientMode = TestClientMode, TTransport
 /**
  * @description Creates a test client with a given transport.
  */
+/**
+ * Creates a Test Client with a given [Transport](https://viem.sh/docs/clients/intro) configured for a [Chain](https://viem.sh/docs/clients/chains).
+ *
+ * - Docs: https://viem.sh/docs/clients/test.html
+ *
+ * A Test Client is an interface to "test" JSON-RPC API methods accessible through a local Ethereum test node such as [Anvil](https://book.getfoundry.sh/anvil/) or [Hardhat](https://hardhat.org/) such as mining blocks, impersonating accounts, setting fees, etc through [Test Actions](https://viem.sh/docs/actions/test/introduction).
+ *
+ * @param config - {@link TestClientConfig}
+ * @returns A Test Client. {@link TestClient}
+ *
+ * @example
+ * import { createTestClient, custom } from 'viem'
+ * import { foundry } from 'viem/chains'
+ *
+ * const client = createTestClient({
+ *   mode: 'anvil',
+ *   chain: foundry,
+ *   transport: http(),
+ * })
+ */
 export declare function createTestClient<TMode extends TestClientMode, TTransport extends Transport, TChain extends Chain | undefined = undefined>({ chain, key, name, mode, pollingInterval, transport, }: TestClientConfig<TMode, TTransport, TChain>): TestClient<TMode, TTransport, TChain, true>;
 //# sourceMappingURL=createTestClient.d.ts.map

package/dist/types/clients/createTestClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createTestClient.d.ts","sourceRoot":"","sources":["../../../src/clients/createTestClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAG7D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAA;AAEhE,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,SAAS,CAAA;AAEhD,MAAM,MAAM,gBAAgB,CAC1B,KAAK,SAAS,cAAc,GAAG,cAAc,EAC7C,UAAU,SAAS,SAAS,GAAG,SAAS,EACxC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,IAClD,IAAI,CACN,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,EAChC,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,iBAAiB,GAAG,WAAW,CAC3D,GAAG;IACF,8DAA8D;IAC9D,IAAI,EAAE,KAAK,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,UAAU,CACpB,KAAK,SAAS,cAAc,GAAG,cAAc,EAC7C,UAAU,SAAS,SAAS,GAAG,SAAS,EACxC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,eAAe,SAAS,OAAO,GAAG,IAAI,IACpC,MAAM,CAAC,UAAU,EAAE,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,GACjD,CAAC,eAAe,SAAS,IAAI,GAAG,WAAW,GAAG,OAAO,CAAC,GAAG;IACvD,IAAI,EAAE,KAAK,CAAA;CACZ,CAAA;AAEH;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,SAAS,cAAc,EAC5B,UAAU,SAAS,SAAS,EAC5B,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAC5C,EACA,KAAK,EACL,GAAY,EACZ,IAAoB,EACpB,IAAI,EACJ,eAAe,EACf,SAAS,GACV,EAAE,gBAAgB,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,CAAC,GAAG,UAAU,CACzD,KAAK,EACL,UAAU,EACV,MAAM,EACN,IAAI,CACL,CAgBA"}
+{"version":3,"file":"createTestClient.d.ts","sourceRoot":"","sources":["../../../src/clients/createTestClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAG7D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAA;AAEhE,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,SAAS,CAAA;AAEhD,MAAM,MAAM,gBAAgB,CAC1B,KAAK,SAAS,cAAc,GAAG,cAAc,EAC7C,UAAU,SAAS,SAAS,GAAG,SAAS,EACxC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,IAClD,IAAI,CACN,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,EAChC,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,iBAAiB,GAAG,WAAW,CAC3D,GAAG;IACF,8DAA8D;IAC9D,IAAI,EAAE,KAAK,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,UAAU,CACpB,KAAK,SAAS,cAAc,GAAG,cAAc,EAC7C,UAAU,SAAS,SAAS,GAAG,SAAS,EACxC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,eAAe,SAAS,OAAO,GAAG,IAAI,IACpC,MAAM,CAAC,UAAU,EAAE,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,GACjD,CAAC,eAAe,SAAS,IAAI,GAAG,WAAW,GAAG,OAAO,CAAC,GAAG;IACvD,IAAI,EAAE,KAAK,CAAA;CACZ,CAAA;AAEH;;GAEG;AACH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,SAAS,cAAc,EAC5B,UAAU,SAAS,SAAS,EAC5B,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAC5C,EACA,KAAK,EACL,GAAY,EACZ,IAAoB,EACpB,IAAI,EACJ,eAAe,EACf,SAAS,GACV,EAAE,gBAAgB,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,CAAC,GAAG,UAAU,CACzD,KAAK,EACL,UAAU,EACV,MAAM,EACN,IAAI,CACL,CAgBA"}

package/dist/types/clients/createWalletClient.d.ts

@@ -12,7 +12,40 @@ export type WalletClient<TTransport extends Transport = Transport, TChain extend
     account: TAccount;
 }>;
 /**
- * @description Creates a wallet client with a given transport.
+ * Creates a Wallet Client with a given [Transport](https://viem.sh/docs/clients/intro) configured for a [Chain](https://viem.sh/docs/clients/chains).
+ *
+ * - Docs: https://viem.sh/docs/clients/wallet.html
+ *
+ * A Wallet Client is an interface to interact with [Ethereum Account(s)](https://ethereum.org/en/glossary/#account) and provides the ability to retrieve accounts, execute transactions, sign messages, etc. through [Wallet Actions](https://viem.sh/docs/actions/wallet/introduction).
+ *
+ * The Wallet Client supports signing over:
+ * - [JSON-RPC Accounts](https://viem.sh/docs/clients/wallet.html#json-rpc-accounts) (e.g. Browser Extension Wallets, WalletConnect, etc).
+ * - [Local Accounts](https://viem.sh/docs/clients/wallet.html#local-accounts-private-key-mnemonic-etc) (e.g. private key/mnemonic wallets).
+ *
+ * @param config - {@link WalletClientConfig}
+ * @returns A Wallet Client. {@link WalletClient}
+ *
+ * @example
+ * // JSON-RPC Account
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ *
+ * const client = createWalletClient({
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * })
+ *
+ * @example
+ * // Local Account
+ * import { createWalletClient, custom } from 'viem'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ * import { mainnet } from 'viem/chains'
+ *
+ * const client = createWalletClient({
+ *   account: privateKeyToAccount('0x…')
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
  */
 export declare function createWalletClient<TTransport extends Transport, TChain extends Chain | undefined = undefined, TAccountOrAddress extends Account | Address | undefined = undefined>({ account, chain, transport, key, name, pollingInterval, }: WalletClientConfig<TTransport, TChain, TAccountOrAddress>): WalletClient<TTransport, TChain, TAccountOrAddress extends Address ? Prettify<JsonRpcAccount<TAccountOrAddress>> : TAccountOrAddress, true>;
 //# sourceMappingURL=createWalletClient.d.ts.map

package/dist/types/clients/createWalletClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createWalletClient.d.ts","sourceRoot":"","sources":["../../../src/clients/createWalletClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAE7D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAA;AAChE,OAAO,KAAK,EACV,OAAO,EACP,OAAO,EACP,KAAK,EACL,cAAc,EACd,QAAQ,EACT,MAAM,mBAAmB,CAAA;AAE1B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAE1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AAEnD,MAAM,MAAM,kBAAkB,CAC5B,UAAU,SAAS,SAAS,GAAG,SAAS,EACxC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,iBAAiB,SAAS,OAAO,GAAG,OAAO,GAAG,SAAS,GACnD,OAAO,GACP,OAAO,GACP,SAAS,IACX,IAAI,CACN,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,EAChC,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,iBAAiB,GAAG,WAAW,CAC3D,GAAG;IACF,sHAAsH;IACtH,OAAO,CAAC,EAAE,iBAAiB,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,YAAY,CACtB,UAAU,SAAS,SAAS,GAAG,SAAS,EACxC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,EAC1D,eAAe,SAAS,OAAO,GAAG,IAAI,IACpC,QAAQ,CACV,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,CAAC,GAClC,CAAC,eAAe,SAAS,IAAI,GACzB,aAAa,CAAC,MAAM,EAAE,QAAQ,CAAC,GAC/B,OAAO,CAAC,GAAG;IACb,gDAAgD;IAChD,OAAO,EAAE,QAAQ,CAAA;CAClB,CACJ,CAAA;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,SAAS,SAAS,EAC5B,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAC5C,iBAAiB,SAAS,OAAO,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,EACnE,EACA,OAAO,EACP,KAAK,EACL,SAAS,EACT,GAAc,EACd,IAAsB,EACtB,eAAe,GAChB,EAAE,kBAAkB,CAAC,UAAU,EAAE,MAAM,EAAE,iBAAiB,CAAC,GAAG,YAAY,CACzE,UAAU,EACV,MAAM,EACN,iBAAiB,SAAS,OAAO,GAC7B,QAAQ,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC,GAC3C,iBAAiB,EACrB,IAAI,CACL,CAsBA"}
+{"version":3,"file":"createWalletClient.d.ts","sourceRoot":"","sources":["../../../src/clients/createWalletClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAE7D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAA;AAChE,OAAO,KAAK,EACV,OAAO,EACP,OAAO,EACP,KAAK,EACL,cAAc,EACd,QAAQ,EACT,MAAM,mBAAmB,CAAA;AAE1B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAE1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AAEnD,MAAM,MAAM,kBAAkB,CAC5B,UAAU,SAAS,SAAS,GAAG,SAAS,EACxC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,iBAAiB,SAAS,OAAO,GAAG,OAAO,GAAG,SAAS,GACnD,OAAO,GACP,OAAO,GACP,SAAS,IACX,IAAI,CACN,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,EAChC,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,iBAAiB,GAAG,WAAW,CAC3D,GAAG;IACF,sHAAsH;IACtH,OAAO,CAAC,EAAE,iBAAiB,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,YAAY,CACtB,UAAU,SAAS,SAAS,GAAG,SAAS,EACxC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,EAC1D,eAAe,SAAS,OAAO,GAAG,IAAI,IACpC,QAAQ,CACV,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,CAAC,GAClC,CAAC,eAAe,SAAS,IAAI,GACzB,aAAa,CAAC,MAAM,EAAE,QAAQ,CAAC,GAC/B,OAAO,CAAC,GAAG;IACb,gDAAgD;IAChD,OAAO,EAAE,QAAQ,CAAA;CAClB,CACJ,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,SAAS,SAAS,EAC5B,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAC5C,iBAAiB,SAAS,OAAO,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,EACnE,EACA,OAAO,EACP,KAAK,EACL,SAAS,EACT,GAAc,EACd,IAAsB,EACtB,eAAe,GAChB,EAAE,kBAAkB,CAAC,UAAU,EAAE,MAAM,EAAE,iBAAiB,CAAC,GAAG,YAAY,CACzE,UAAU,EACV,MAAM,EACN,iBAAiB,SAAS,OAAO,GAC7B,QAAQ,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC,GAC3C,iBAAiB,EACrB,IAAI,CACL,CAsBA"}

package/dist/types/clients/decorators/public.d.ts

@@ -11,7 +11,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      * - 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 parameters - {@link CallParameters}
+     * @param args - {@link CallParameters}
      * @returns The call data. {@link CallReturnType}
      *
      * @example
@@ -54,7 +54,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      *
      * - Docs: https://viem.sh/docs/contract/createContractEventFilter.html
      *
-     * @param parameters - {@link CreateContractEventFilterParameters}
+     * @param args - {@link CreateContractEventFilterParameters}
      * @returns [`Filter`](https://viem.sh/docs/glossary/types.html#filter). {@link CreateContractEventFilterReturnType}
      *
      * @example
@@ -76,7 +76,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      * - 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 parameters - {@link CreateEventFilterParameters}
+     * @param args - {@link CreateEventFilterParameters}
      * @returns [`Filter`](https://viem.sh/docs/glossary/types.html#filter). {@link CreateEventFilterReturnType}
      *
      * @example
@@ -120,7 +120,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      * @remarks
      * Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`estimateGas` action](https://viem.sh/docs/actions/public/estimateGas) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData).
      *
-     * @param parameters - {@link EstimateContractGasParameters}
+     * @param args - {@link EstimateContractGasParameters}
      * @returns The gas estimate (in wei). {@link EstimateContractGasReturnType}
      *
      * @example
@@ -145,7 +145,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      * - 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 parameters - {@link EstimateGasParameters}
+     * @param args - {@link EstimateGasParameters}
      * @returns The gas estimate (in wei). {@link EstimateGasReturnType}
      *
      * @example
@@ -181,7 +181,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      * // "6.942"
      * ```
      *
-     * @param parameters - {@link GetBalanceParameters}
+     * @param args - {@link GetBalanceParameters}
      * @returns The balance of the address in wei. {@link GetBalanceReturnType}
      *
      * @example
@@ -207,7 +207,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      *   - 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 parameters - {@link GetBlockParameters}
+     * @param args - {@link GetBlockParameters}
      * @returns Information about the block. {@link GetBlockReturnType}
      *
      * @example
@@ -228,7 +228,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      * - 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 parameters - {@link GetBlockNumberParameters}
+     * @param args - {@link GetBlockNumberParameters}
      * @returns The number of the block. {@link GetBlockNumberReturnType}
      *
      * @example
@@ -251,7 +251,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      *   - 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 parameters - {@link GetBlockTransactionCountParameters}
+     * @param args - {@link GetBlockTransactionCountParameters}
      * @returns The block transaction count. {@link GetBlockTransactionCountReturnType}
      *
      * @example
@@ -271,7 +271,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      * - 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 parameters - {@link GetBytecodeParameters}
+     * @param args - {@link GetBytecodeParameters}
      * @returns The contract's bytecode. {@link GetBytecodeReturnType}
      *
      * @example
@@ -318,7 +318,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      *
      * 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 parameters - {@link GetEnsAddressParameters}
+     * @param args - {@link GetEnsAddressParameters}
      * @returns Address for ENS name or `null` if not found. {@link GetEnsAddressReturnType}
      *
      * @example
@@ -347,7 +347,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      *
      * 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 parameters - {@link GetEnsAvatarParameters}
+     * @param args - {@link GetEnsAvatarParameters}
      * @returns Avatar URI or `null` if not found. {@link GetEnsAvatarReturnType}
      *
      * @example
@@ -374,7 +374,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      * @remarks
      * Calls `reverse(bytes)` on ENS Universal Resolver Contract to "reverse resolve" the address to the primary ENS name.
      *
-     * @param parameters - {@link GetEnsNameParameters}
+     * @param args - {@link GetEnsNameParameters}
      * @returns Name or `null` if not found. {@link GetEnsNameReturnType}
      *
      * @example
@@ -402,7 +402,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      *
      * 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 parameters - {@link GetEnsResolverParameters}
+     * @param args - {@link GetEnsResolverParameters}
      * @returns Address for ENS resolver. {@link GetEnsResolverReturnType}
      *
      * @example
@@ -431,7 +431,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      *
      * 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 parameters - {@link GetEnsTextParameters}
+     * @param args - {@link GetEnsTextParameters}
      * @returns Address for ENS resolver. {@link GetEnsTextReturnType}
      *
      * @example
@@ -456,7 +456,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      * - Docs: https://viem.sh/docs/actions/public/getFeeHistory.html
      * - JSON-RPC Methods: [`eth_feeHistory`](https://docs.alchemy.com/reference/eth-feehistory)
      *
-     * @param parameters - {@link GetFeeHistoryParameters}
+     * @param args - {@link GetFeeHistoryParameters}
      * @returns The gas estimate (in wei). {@link GetFeeHistoryReturnType}
      *
      * @example
@@ -493,7 +493,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      * - 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 parameters - {@link GetFilterChangesParameters}
+     * @param args - {@link GetFilterChangesParameters}
      * @returns Logs or hashes. {@link GetFilterChangesReturnType}
      *
      * @example
@@ -561,7 +561,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      * @remarks
      * `getFilterLogs` is only compatible with **event filters**.
      *
-     * @param parameters - {@link GetFilterLogsParameters}
+     * @param args - {@link GetFilterLogsParameters}
      * @returns A list of event logs. {@link GetFilterLogsReturnType}
      *
      * @example
@@ -605,7 +605,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      * - 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 parameters - {@link GetLogsParameters}
+     * @param args - {@link GetLogsParameters}
      * @returns A list of event logs. {@link GetLogsReturnType}
      *
      * @example
@@ -625,7 +625,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      * - 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 parameters - {@link GetStorageAtParameters}
+     * @param args - {@link GetStorageAtParameters}
      * @returns The value of the storage slot. {@link GetStorageAtReturnType}
      *
      * @example
@@ -650,7 +650,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      * - 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 parameters - {@link GetTransactionParameters}
+     * @param args - {@link GetTransactionParameters}
      * @returns The transaction information. {@link GetTransactionReturnType}
      *
      * @example
@@ -673,7 +673,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      * - 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 parameters - {@link GetTransactionConfirmationsParameters}
+     * @param args - {@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
@@ -695,7 +695,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      * - Docs: https://viem.sh/docs/actions/public/getTransactionCount.html
      * - JSON-RPC Methods: [`eth_getTransactionCount`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gettransactioncount)
      *
-     * @param parameters - {@link GetTransactionCountParameters}
+     * @param args - {@link GetTransactionCountParameters}
      * @returns The number of transactions an account has sent. {@link GetTransactionCountReturnType}
      *
      * @example
@@ -718,7 +718,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      * - Example: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/transactions/fetching-transactions
      * - JSON-RPC Methods: [`eth_getTransactionReceipt`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionReceipt)
      *
-     * @param parameters - {@link GetTransactionReceiptParameters}
+     * @param args - {@link GetTransactionReceiptParameters}
      * @returns The transaction receipt. {@link GetTransactionReceiptReturnType}
      *
      * @example
@@ -739,7 +739,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      *
      * - Docs: https://viem.sh/docs/contract/multicall.html
      *
-     * @param parameters - {@link MulticallParameters}
+     * @param args - {@link MulticallParameters}
      * @returns An array of results with accompanying status. {@link MulticallReturnType}
      *
      * @example
@@ -754,7 +754,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      *   'function balanceOf(address) view returns (uint256)',
      *   'function totalSupply() view returns (uint256)',
      * ])
-     * const results = await client.multicall({
+     * const result = await client.multicall({
      *   contracts: [
      *     {
      *       address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
@@ -783,7 +783,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      *
      * Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`call` action](https://viem.sh/docs/actions/public/call) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData).
      *
-     * @param parameters - {@link ReadContractParameters}
+     * @param args - {@link ReadContractParameters}
      * @returns The response from the contract. Type is inferred. {@link ReadContractReturnType}
      *
      * @example
@@ -795,7 +795,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      *   chain: mainnet,
      *   transport: http(),
      * })
-     * const results = await client.readContract({
+     * const result = await client.readContract({
      *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
      *   abi: parseAbi(['function balanceOf(address) view returns (uint256)']),
      *   functionName: 'balanceOf',
@@ -815,7 +815,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      *
      * Internally, uses a [Public Client](https://viem.sh/docs/clients/public) to call the [`call` action](https://viem.sh/docs/actions/public/call) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData).
      *
-     * @param parameters - {@link SimulateContractParameters}
+     * @param args - {@link SimulateContractParameters}
      * @returns The simulation result and write request. {@link SimulateContractReturnType}
      *
      * @example
@@ -826,7 +826,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      *   chain: mainnet,
      *   transport: http(),
      * })
-     * const results = await client.simulateContract({
+     * const result = await client.simulateContract({
      *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
      *   abi: parseAbi(['function mint(uint32) view returns (uint32)']),
      *   functionName: 'mint',
@@ -845,7 +845,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      * - Docs: https://viem.sh/docs/actions/public/uninstallFilter.html
      * - JSON-RPC Methods: [`eth_uninstallFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_uninstallFilter)
      *
-     * @param parameters - {@link UninstallFilterParameters}
+     * @param args - {@link UninstallFilterParameters}
      * @returns A boolean indicating if the Filter was successfully uninstalled. {@link UninstallFilterReturnType}
      *
      * @example
@@ -881,7 +881,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      * - `cancelled`: The Transaction has been cancelled (e.g. `value === 0n`)
      * - `replaced`: The Transaction has been replaced (e.g. different `value` or `data`)
      *
-     * @param parameters - {@link WaitForTransactionReceiptParameters}
+     * @param args - {@link WaitForTransactionReceiptParameters}
      * @returns The transaction receipt. {@link WaitForTransactionReceiptReturnType}
      *
      * @example
@@ -906,7 +906,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      *   - When `poll: true`, calls [`eth_blockNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_blocknumber) on a polling interval.
      *   - When `poll: false` & WebSocket Transport, uses a WebSocket subscription via [`eth_subscribe`](https://docs.alchemy.com/reference/eth-subscribe-polygon) and the `"newHeads"` event.
      *
-     * @param parameters - {@link WatchBlockNumberParameters}
+     * @param args - {@link WatchBlockNumberParameters}
      * @returns A function that can be invoked to stop watching for new block numbers. {@link WatchBlockNumberReturnType}
      *
      * @example
@@ -931,7 +931,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      *   - When `poll: true`, calls [`eth_getBlockByNumber`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getBlockByNumber) on a polling interval.
      *   - When `poll: false` & WebSocket Transport, uses a WebSocket subscription via [`eth_subscribe`](https://docs.alchemy.com/reference/eth-subscribe-polygon) and the `"newHeads"` event.
      *
-     * @param parameters - {@link WatchBlocksParameters}
+     * @param args - {@link WatchBlocksParameters}
      * @returns A function that can be invoked to stop watching for new block numbers. {@link WatchBlocksReturnType}
      *
      * @example
@@ -957,7 +957,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      *
      * `watchContractEvent` will attempt to create an [Event Filter](https://viem.sh/docs/contract/createContractEventFilter) and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. `eth_newFilter`), then `watchContractEvent` will fall back to using [`getLogs`](https://viem.sh/docs/actions/public/getLogs) instead.
      *
-     * @param parameters - {@link WatchContractEventParameters}
+     * @param args - {@link WatchContractEventParameters}
      * @returns A function that can be invoked to stop watching for new event logs. {@link WatchContractEventReturnType}
      *
      * @example
@@ -993,7 +993,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      *
      * `watchEvent` will attempt to create an [Event Filter](https://viem.sh/docs/actions/public/createEventFilter.html) and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. `eth_newFilter`), then `watchEvent` will fall back to using [`getLogs`](https://viem.sh/docs/actions/public/getLogs) instead.
      *
-     * @param parameters - {@link WatchEventParameters}
+     * @param args - {@link WatchEventParameters}
      * @returns A function that can be invoked to stop watching for new Event Logs. {@link WatchEventReturnType}
      *
      * @example
@@ -1022,7 +1022,7 @@ export type PublicActions<TTransport extends Transport = Transport, TChain exten
      * @remarks
      * This Action will batch up all the pending transactions found within the [`pollingInterval`](https://viem.sh/docs/actions/public/watchPendingTransactions.html#pollinginterval-optional), and invoke them via [`onTransactions`](https://viem.sh/docs/actions/public/watchPendingTransactions.html#ontransactions).
      *
-     * @param parameters - {@link WatchPendingTransactionsParameters}
+     * @param args - {@link WatchPendingTransactionsParameters}
      * @returns A function that can be invoked to stop watching for new pending transaction hashes. {@link WatchPendingTransactionsReturnType}
      *
      * @example