viem 1.10.10 → 1.10.11

package/_types/clients/createPublicClient.d.ts

@@ -0,0 +1,29 @@
+import type { Chain } from '../types/chain.js';
+import type { PublicRpcSchema } from '../types/eip1193.js';
+import type { Prettify } from '../types/utils.js';
+import { type Client, type ClientConfig } from './createClient.js';
+import { type PublicActions } from './decorators/public.js';
+import type { Transport } from './transports/createTransport.js';
+export type PublicClientConfig<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined> = Prettify<Pick<ClientConfig<transport, chain>, 'batch' | 'cacheTime' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'>>;
+export type PublicClient<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined> = Prettify<Client<transport, chain, undefined, PublicRpcSchema, PublicActions<transport, chain>>>;
+/**
+ * Creates a Public Client with a given [Transport](https://viem.sh/docs/clients/intro.html) configured for a [Chain](https://viem.sh/docs/clients/chains.html).
+ *
+ * - 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<transport extends Transport, chain extends Chain | undefined = undefined>(parameters: PublicClientConfig<transport, chain>): PublicClient<transport, chain>;
+//# sourceMappingURL=createPublicClient.d.ts.map

package/_types/clients/createPublicClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createPublicClient.d.ts","sourceRoot":"","sources":["../../clients/createPublicClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAC1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,YAAY,EAAgB,MAAM,mBAAmB,CAAA;AAChF,OAAO,EAAE,KAAK,aAAa,EAAiB,MAAM,wBAAwB,CAAA;AAC1E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAA;AAEhE,MAAM,MAAM,kBAAkB,CAC5B,SAAS,SAAS,SAAS,GAAG,SAAS,EACvC,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,IACjD,QAAQ,CACV,IAAI,CACF,YAAY,CAAC,SAAS,EAAE,KAAK,CAAC,EAC5B,OAAO,GACP,WAAW,GACX,OAAO,GACP,KAAK,GACL,MAAM,GACN,iBAAiB,GACjB,WAAW,CACd,CACF,CAAA;AAED,MAAM,MAAM,YAAY,CACtB,SAAS,SAAS,SAAS,GAAG,SAAS,EACvC,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,IACjD,QAAQ,CACV,MAAM,CACJ,SAAS,EACT,KAAK,EACL,SAAS,EACT,eAAe,EACf,aAAa,CAAC,SAAS,EAAE,KAAK,CAAC,CAChC,CACF,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,kBAAkB,CAChC,SAAS,SAAS,SAAS,EAC3B,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAE3C,UAAU,EAAE,kBAAkB,CAAC,SAAS,EAAE,KAAK,CAAC,GAC/C,YAAY,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA"}

package/_types/clients/createTestClient.d.ts

@@ -0,0 +1,43 @@
+import type { Address } from 'abitype';
+import type { Account } from '../accounts/types.js';
+import type { ParseAccount } from '../types/account.js';
+import type { Chain } from '../types/chain.js';
+import type { TestRpcSchema } from '../types/eip1193.js';
+import type { Prettify } from '../types/utils.js';
+import { type Client, type ClientConfig } from './createClient.js';
+import { type TestActions } from './decorators/test.js';
+import type { Transport } from './transports/createTransport.js';
+export type TestClientMode = 'anvil' | 'hardhat' | 'ganache';
+export type TestClientConfig<mode extends TestClientMode = TestClientMode, transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, accountOrAddress extends Account | Address | undefined = Account | Address | undefined> = Prettify<Pick<ClientConfig<transport, chain, accountOrAddress>, 'account' | 'cacheTime' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'> & {
+    /** Mode of the test client. */
+    mode: mode | ('anvil' | 'hardhat' | 'ganache');
+}>;
+export type TestClient<TMode extends TestClientMode = TestClientMode, transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, TAccount extends Account | undefined = Account | undefined, TIncludeActions extends boolean = true> = Prettify<{
+    mode: TMode;
+} & Client<transport, chain, TAccount, TestRpcSchema<TMode>, TIncludeActions extends true ? TestActions : Record<string, unknown>>>;
+/**
+ * @description Creates a test client with a given transport.
+ */
+/**
+ * Creates a Test Client with a given [Transport](https://viem.sh/docs/clients/intro.html) configured for a [Chain](https://viem.sh/docs/clients/chains.html).
+ *
+ * - 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.html).
+ *
+ * @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<mode extends 'anvil' | 'hardhat' | 'ganache', // TODO: Type utility that expands `TestClientMode`
+transport extends Transport, chain extends Chain | undefined = undefined, accountOrAddress extends Account | Address | undefined = undefined>(parameters: TestClientConfig<mode, transport, chain, accountOrAddress>): TestClient<mode, transport, chain, ParseAccount<accountOrAddress>>;
+//# sourceMappingURL=createTestClient.d.ts.map

package/_types/clients/createTestClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createTestClient.d.ts","sourceRoot":"","sources":["../../clients/createTestClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAEtC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAC9C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACxD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,YAAY,EAAgB,MAAM,mBAAmB,CAAA;AAChF,OAAO,EAAE,KAAK,WAAW,EAAe,MAAM,sBAAsB,CAAA;AACpE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAA;AAEhE,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,CAAA;AAE5D,MAAM,MAAM,gBAAgB,CAC1B,IAAI,SAAS,cAAc,GAAG,cAAc,EAC5C,SAAS,SAAS,SAAS,GAAG,SAAS,EACvC,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,gBAAgB,SAAS,OAAO,GAAG,OAAO,GAAG,SAAS,GAClD,OAAO,GACP,OAAO,GACP,SAAS,IACX,QAAQ,CACV,IAAI,CACF,YAAY,CAAC,SAAS,EAAE,KAAK,EAAE,gBAAgB,CAAC,EAC9C,SAAS,GACT,WAAW,GACX,OAAO,GACP,KAAK,GACL,MAAM,GACN,iBAAiB,GACjB,WAAW,CACd,GAAG;IACF,+BAA+B;IAC/B,IAAI,EAAE,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC,CAAA;CAC/C,CACF,CAAA;AAED,MAAM,MAAM,UAAU,CACpB,KAAK,SAAS,cAAc,GAAG,cAAc,EAC7C,SAAS,SAAS,SAAS,GAAG,SAAS,EACvC,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,EAC1D,eAAe,SAAS,OAAO,GAAG,IAAI,IACpC,QAAQ,CACV;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,GAAG,MAAM,CACtB,SAAS,EACT,KAAK,EACL,QAAQ,EACR,aAAa,CAAC,KAAK,CAAC,EACpB,eAAe,SAAS,IAAI,GAAG,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CACrE,CACF,CAAA;AAED;;GAEG;AACH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,SAAS,OAAO,GAAG,SAAS,GAAG,SAAS,EAAE,mDAAmD;AACjG,SAAS,SAAS,SAAS,EAC3B,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAC3C,gBAAgB,SAAS,OAAO,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,EAElE,UAAU,EAAE,gBAAgB,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,gBAAgB,CAAC,GACrE,UAAU,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAA"}

package/_types/clients/createWalletClient.d.ts

@@ -0,0 +1,49 @@
+import type { Address } from 'abitype';
+import type { Account } from '../accounts/types.js';
+import type { ParseAccount } from '../types/account.js';
+import type { Chain } from '../types/chain.js';
+import type { WalletRpcSchema } from '../types/eip1193.js';
+import type { Prettify } from '../types/utils.js';
+import { type Client, type ClientConfig } from './createClient.js';
+import { type WalletActions } from './decorators/wallet.js';
+import type { Transport } from './transports/createTransport.js';
+export type WalletClientConfig<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, accountOrAddress extends Account | Address | undefined = Account | Address | undefined> = Prettify<Pick<ClientConfig<transport, chain, accountOrAddress>, 'account' | 'cacheTime' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'>>;
+export type WalletClient<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined> = Prettify<Client<transport, chain, account, WalletRpcSchema, WalletActions<chain, account>>>;
+/**
+ * Creates a Wallet Client with a given [Transport](https://viem.sh/docs/clients/intro.html) configured for a [Chain](https://viem.sh/docs/clients/chains.html).
+ *
+ * - 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.html).
+ *
+ * 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<transport extends Transport, chain extends Chain | undefined = undefined, accountOrAddress extends Account | Address | undefined = undefined>(parameters: WalletClientConfig<transport, chain, accountOrAddress>): WalletClient<transport, chain, ParseAccount<accountOrAddress>>;
+//# sourceMappingURL=createWalletClient.d.ts.map

package/_types/clients/createWalletClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createWalletClient.d.ts","sourceRoot":"","sources":["../../clients/createWalletClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAEtC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAC1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,YAAY,EAAgB,MAAM,mBAAmB,CAAA;AAChF,OAAO,EAAE,KAAK,aAAa,EAAiB,MAAM,wBAAwB,CAAA;AAC1E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAA;AAEhE,MAAM,MAAM,kBAAkB,CAC5B,SAAS,SAAS,SAAS,GAAG,SAAS,EACvC,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,gBAAgB,SAAS,OAAO,GAAG,OAAO,GAAG,SAAS,GAClD,OAAO,GACP,OAAO,GACP,SAAS,IACX,QAAQ,CACV,IAAI,CACF,YAAY,CAAC,SAAS,EAAE,KAAK,EAAE,gBAAgB,CAAC,EAC9C,SAAS,GACT,WAAW,GACX,OAAO,GACP,KAAK,GACL,MAAM,GACN,iBAAiB,GACjB,WAAW,CACd,CACF,CAAA;AAED,MAAM,MAAM,YAAY,CACtB,SAAS,SAAS,SAAS,GAAG,SAAS,EACvC,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,IACvD,QAAQ,CACV,MAAM,CACJ,SAAS,EACT,KAAK,EACL,OAAO,EACP,eAAe,EACf,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,CAC9B,CACF,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,kBAAkB,CAChC,SAAS,SAAS,SAAS,EAC3B,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAC3C,gBAAgB,SAAS,OAAO,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,EAElE,UAAU,EAAE,kBAAkB,CAAC,SAAS,EAAE,KAAK,EAAE,gBAAgB,CAAC,GACjE,YAAY,CAAC,SAAS,EAAE,KAAK,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAA"}