viem 0.0.0 → 0.0.1-alpha.1

package/dist/clients/index.d.ts

@@ -0,0 +1,8 @@
+export { C as Client, a as ClientConfig, P as PublicClient, b as PublicClientConfig, T as TestClient, c as TestClientConfig, d as Transport, e as TransportConfig, W as WalletClient, f as WalletClientConfig, g as createClient, h as createPublicClient, i as createTestClient, j as createTransport, k as createWalletClient } from '../createWalletClient-915223f3.js';
+export { C as CustomTransport, a as CustomTransportConfig, F as FallbackTransport, b as FallbackTransportConfig, H as HttpTransport, c as HttpTransportConfig, U as UrlRequiredError, W as WebSocketTransport, d as WebSocketTransportConfig, e as custom, f as fallback, h as http, w as webSocket } from '../webSocket-c6e0d26f.js';
+import '../chains.js';
+import '../rpc-655c0ba4.js';
+import '@wagmi/chains';
+import '../eip1193-8f7c22ce.js';
+import '../BaseError-7688f84e.js';
+import '../rpc-3c0e3985.js';

package/dist/clients/index.js

@@ -0,0 +1,25 @@
+import {
+  UrlRequiredError,
+  createClient,
+  createPublicClient,
+  createTestClient,
+  createTransport,
+  createWalletClient,
+  custom,
+  fallback,
+  http,
+  webSocket
+} from "../chunk-OQTFTQTO.js";
+import "../chunk-Z6LRV6XI.js";
+export {
+  UrlRequiredError,
+  createClient,
+  createPublicClient,
+  createTestClient,
+  createTransport,
+  createWalletClient,
+  custom,
+  fallback,
+  http,
+  webSocket
+};

package/dist/createWalletClient-915223f3.d.ts

@@ -0,0 +1,130 @@
+import { Chain } from './chains.js';
+import { R as Requests, P as PublicRequests, T as TestRequests, S as SignableRequests, b as WalletRequests } from './eip1193-8f7c22ce.js';
+
+type BaseRpcRequests = {
+    request(...args: any): Promise<any>;
+};
+type TransportConfig<TType extends string = string, TRequests extends BaseRpcRequests['request'] = Requests['request']> = {
+    /** The name of the transport. */
+    name: string;
+    /** The key of the transport. */
+    key: string;
+    /** The JSON-RPC request function that matches the EIP-1193 request spec. */
+    request: TRequests;
+    /** The type of the transport. */
+    type: TType;
+};
+type Transport<TType extends string = string, TRpcAttributes = Record<string, any>> = <TChain extends Chain = Chain>({ chain, }: {
+    chain?: TChain;
+}) => {
+    config: TransportConfig<TType>;
+    value?: TRpcAttributes;
+};
+/**
+ * @description Creates an transport intended to be used with a client.
+ */
+declare function createTransport<TType extends string = string, TRpcAttributes = any>(config: TransportConfig<TType>, value?: TRpcAttributes): ReturnType<Transport<TType, TRpcAttributes>>;
+
+type Client<TTransport extends Transport = Transport, TChain extends Chain = Chain, TRequests extends BaseRpcRequests = Requests> = {
+    /** Chain for the client. */
+    chain?: TChain;
+    /** A key for the client. */
+    key: string;
+    /** A name for the client. */
+    name: string;
+    /** Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. */
+    pollingInterval: number;
+    /** Request function wrapped with friendly error handling */
+    request: TRequests['request'];
+    /** The RPC transport (http, webSocket, custom, etc) */
+    transport: ReturnType<TTransport>['config'] & ReturnType<TTransport>['value'];
+    /** The type of client. */
+    type: string;
+    /** A unique ID for the client. */
+    uid: string;
+};
+type ClientConfig<TTransport extends Transport = Transport, TChain extends Chain = Chain, TRequests extends BaseRpcRequests = Requests> = Partial<Pick<Client<TTransport, TChain, TRequests>, 'chain' | 'key' | 'name' | 'pollingInterval' | 'type'>> & {
+    transport: TTransport;
+};
+/**
+ * @description Creates a base RPC client with the given transport.
+ *
+ * - Intended to be used as a base for other RPC clients.
+ * - Has access to _all_ EIP-1474 RPC methods.
+ *
+ * @example
+ * import { mainnet } from 'viem/chains'
+ * import { createClient, http } from 'viem/clients'
+ * const client = createClient(http({ chain: mainnet }))
+ */
+declare function createClient<TTransport extends Transport, TChain extends Chain, TRequests extends BaseRpcRequests>({ chain, key, name, pollingInterval, transport, type, }: ClientConfig<TTransport, TChain, TRequests>): Client<TTransport, TChain, TRequests>;
+
+type PublicClientConfig<TTransport extends Transport = Transport, TChain extends Chain = Chain> = Pick<ClientConfig<TTransport, TChain>, 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'>;
+type PublicClient<TTransport extends Transport = Transport, TChain extends Chain = Chain> = Client<TTransport, TChain, PublicRequests>;
+/**
+ * @description Creates a public client with a given transport.
+ *
+ * - Only has access to "public" EIP-1474 RPC methods (ie. `eth_blockNumber`, etc).
+ *
+ * @example
+ * import { mainnet } from 'viem/chains'
+ * import { createPublicClient, http } from 'viem/clients'
+ * const client = createPublicClient(http({ chain: mainnet }))
+ */
+declare function createPublicClient<TTransport extends Transport, TChain extends Chain>({ chain, key, name, transport, pollingInterval, }: PublicClientConfig<TTransport, TChain>): PublicClient<TTransport, TChain>;
+
+type TestClientModes = 'anvil' | 'hardhat';
+type TestClientConfig<TTransport extends Transport = Transport, TChain extends Chain = Chain, TMode extends TestClientModes = TestClientModes> = {
+    chain?: ClientConfig<TTransport, TChain>['chain'];
+    /** The key of the client. */
+    key?: ClientConfig['key'];
+    /** Mode of the test client. Available: "anvil" | "hardhat" */
+    mode: TMode;
+    /** The name of the client. */
+    name?: ClientConfig['name'];
+    /** Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. */
+    pollingInterval?: ClientConfig['pollingInterval'];
+    transport: ClientConfig<TTransport, TChain>['transport'];
+};
+type TestClient<TTransport extends Transport = Transport, TChain extends Chain = Chain, TMode extends TestClientModes = TestClientModes> = Client<TTransport, TChain, TestRequests<TMode>> & {
+    mode: TMode;
+};
+/**
+ * @description Creates a test client with a given transport.
+ *
+ * - Only has access to "test" RPC methods (ie. `anvil_setBalance`,
+ * `evm_mine`, etc).
+ *
+ * @example
+ * import { createTestClient, http } from 'viem'
+ * import { local } from 'viem/chains'
+ * const client = createTestClient({ chain: local, mode: 'anvil', transport: http() })
+ */
+declare function createTestClient<TTransport extends Transport, TChain extends Chain, TMode extends TestClientModes>({ chain, key, name, mode, pollingInterval, transport, }: TestClientConfig<TTransport, TChain, TMode>): TestClient<TTransport, TChain, TMode>;
+
+type WalletClientConfig<TTransport extends Transport = Transport, TChain extends Chain = Chain> = {
+    chain?: ClientConfig<TTransport, TChain>['chain'];
+    /** The key of the Wallet Client. */
+    key?: ClientConfig['key'];
+    /** The name of the Wallet Client. */
+    name?: ClientConfig['name'];
+    /** Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. */
+    pollingInterval?: ClientConfig['pollingInterval'];
+    transport: ClientConfig<TTransport, TChain>['transport'];
+};
+type WalletClient<TTransport extends Transport = Transport, TChain extends Chain = Chain> = Client<TTransport, TChain, SignableRequests & WalletRequests>;
+/**
+ * @description Creates a wallet client with a given transport.
+ *
+ * - Only has access to "wallet" & "signable" EIP-1474 RPC methods
+ * (ie. `eth_sendTransaction`, `eth_requestAccounts`, etc).
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * const client = createWalletClient(
+ *  custom(window.ethereum)
+ * )
+ */
+declare function createWalletClient<TTransport extends Transport, TChain extends Chain>({ transport, key, name, pollingInterval, }: WalletClientConfig<TTransport, TChain>): WalletClient<TTransport, TChain>;
+
+export { BaseRpcRequests as B, Client as C, PublicClient as P, TestClient as T, WalletClient as W, ClientConfig as a, PublicClientConfig as b, TestClientConfig as c, Transport as d, TransportConfig as e, WalletClientConfig as f, createClient as g, createPublicClient as h, createTestClient as i, createTransport as j, createWalletClient as k };