viem 1.6.6 → 1.7.0

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

@@ -0,0 +1,449 @@
+import type { Abi, TypedData } from 'abitype';
+import type { Account } from '../../accounts/types.js';
+import { type GetChainIdReturnType } from '../../actions/public/getChainId.js';
+import { type AddChainParameters } from '../../actions/wallet/addChain.js';
+import { type DeployContractParameters, type DeployContractReturnType } from '../../actions/wallet/deployContract.js';
+import { type GetAddressesReturnType } from '../../actions/wallet/getAddresses.js';
+import { type GetPermissionsReturnType } from '../../actions/wallet/getPermissions.js';
+import { type RequestAddressesReturnType } from '../../actions/wallet/requestAddresses.js';
+import { type RequestPermissionsParameters, type RequestPermissionsReturnType } from '../../actions/wallet/requestPermissions.js';
+import { type SendTransactionParameters, type SendTransactionReturnType } from '../../actions/wallet/sendTransaction.js';
+import { type SignMessageParameters, type SignMessageReturnType } from '../../actions/wallet/signMessage.js';
+import { type SignTypedDataParameters, type SignTypedDataReturnType } from '../../actions/wallet/signTypedData.js';
+import { type SwitchChainParameters } from '../../actions/wallet/switchChain.js';
+import { type WatchAssetParameters, type WatchAssetReturnType } from '../../actions/wallet/watchAsset.js';
+import { type WriteContractParameters, type WriteContractReturnType } from '../../actions/wallet/writeContract.js';
+import type { Chain } from '../../types/chain.js';
+import type { Client } from '../createClient.js';
+import type { Transport } from '../transports/createTransport.js';
+export type WalletActions<TChain extends Chain | undefined = Chain | undefined, TAccount extends Account | undefined = Account | undefined> = {
+    /**
+     * Adds an EVM chain to the wallet.
+     *
+     * - Docs: https://viem.sh/docs/actions/wallet/addChain.html
+     * - JSON-RPC Methods: [`eth_addEthereumChain`](https://eips.ethereum.org/EIPS/eip-3085)
+     *
+     * @param args - {@link AddChainParameters}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { optimism } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   transport: custom(window.ethereum),
+     * })
+     * await client.addChain({ chain: optimism })
+     */
+    addChain: (args: AddChainParameters) => Promise<void>;
+    /**
+     * Deploys a contract to the network, given bytecode and constructor arguments.
+     *
+     * - Docs: https://viem.sh/docs/contract/deployContract.html
+     * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/contracts/deploying-contracts
+     *
+     * @param args - {@link DeployContractParameters}
+     * @returns The [Transaction](https://viem.sh/docs/glossary/terms.html#transaction) hash. {@link DeployContractReturnType}
+     *
+     * @example
+     * import { createWalletClient, http } from 'viem'
+     * import { privateKeyToAccount } from 'viem/accounts'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   account: privateKeyToAccount('0x…'),
+     *   chain: mainnet,
+     *   transport: http(),
+     * })
+     * const hash = await client.deployContract({
+     *   abi: [],
+     *   account: '0x…,
+     *   bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
+     * })
+     */
+    deployContract: <const TAbi extends Abi | readonly unknown[], TChainOverride extends Chain | undefined>(args: DeployContractParameters<TAbi, TChain, TAccount, TChainOverride>) => Promise<DeployContractReturnType>;
+    /**
+     * Returns a list of account addresses owned by the wallet or client.
+     *
+     * - Docs: https://viem.sh/docs/actions/wallet/getAddresses.html
+     * - JSON-RPC Methods: [`eth_accounts`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_accounts)
+     *
+     * @returns List of account addresses owned by the wallet or client. {@link GetAddressesReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const accounts = await client.getAddresses()
+     */
+    getAddresses: () => Promise<GetAddressesReturnType>;
+    /**
+     * Returns the chain ID associated with the current network.
+     *
+     * - Docs: https://viem.sh/docs/actions/public/getChainId.html
+     * - JSON-RPC Methods: [`eth_chainId`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_chainid)
+     *
+     * @returns The current chain ID. {@link GetChainIdReturnType}
+     *
+     * @example
+     * import { createWalletClient, http } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const chainId = await client.getChainId()
+     * // 1
+     */
+    getChainId: () => Promise<GetChainIdReturnType>;
+    /**
+     * Gets the wallets current permissions.
+     *
+     * - Docs: https://viem.sh/docs/actions/wallet/getPermissions.html
+     * - JSON-RPC Methods: [`wallet_getPermissions`](https://eips.ethereum.org/EIPS/eip-2255)
+     *
+     * @returns The wallet permissions. {@link GetPermissionsReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const permissions = await client.getPermissions()
+     */
+    getPermissions: () => Promise<GetPermissionsReturnType>;
+    /**
+     * Requests a list of accounts managed by a wallet.
+     *
+     * - Docs: https://viem.sh/docs/actions/wallet/requestAddresses.html
+     * - JSON-RPC Methods: [`eth_requestAccounts`](https://eips.ethereum.org/EIPS/eip-1102)
+     *
+     * Sends a request to the wallet, asking for permission to access the user's accounts. After the user accepts the request, it will return a list of accounts (addresses).
+     *
+     * This API can be useful for dapps that need to access the user's accounts in order to execute transactions or interact with smart contracts.
+     *
+     * @returns List of accounts managed by a wallet {@link RequestAddressesReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const accounts = await client.requestAddresses()
+     */
+    requestAddresses: () => Promise<RequestAddressesReturnType>;
+    /**
+     * Requests permissions for a wallet.
+     *
+     * - Docs: https://viem.sh/docs/actions/wallet/requestPermissions.html
+     * - JSON-RPC Methods: [`wallet_requestPermissions`](https://eips.ethereum.org/EIPS/eip-2255)
+     *
+     * @param args - {@link RequestPermissionsParameters}
+     * @returns The wallet permissions. {@link RequestPermissionsReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const permissions = await client.requestPermissions({
+     *   eth_accounts: {}
+     * })
+     */
+    requestPermissions: (args: RequestPermissionsParameters) => Promise<RequestPermissionsReturnType>;
+    /**
+     * Creates, signs, and sends a new transaction to the network.
+     *
+     * - Docs: https://viem.sh/docs/actions/wallet/sendTransaction.html
+     * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/transactions/sending-transactions
+     * - JSON-RPC Methods:
+     *   - JSON-RPC Accounts: [`eth_sendTransaction`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sendtransaction)
+     *   - Local Accounts: [`eth_sendRawTransaction`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sendrawtransaction)
+     *
+     * @param args - {@link SendTransactionParameters}
+     * @returns The [Transaction](https://viem.sh/docs/glossary/terms.html#transaction) hash. {@link SendTransactionReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const hash = await client.sendTransaction({
+     *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+     *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+     *   value: 1000000000000000000n,
+     * })
+     *
+     * @example
+     * // Account Hoisting
+     * import { createWalletClient, http } from 'viem'
+     * import { privateKeyToAccount } from 'viem/accounts'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   account: privateKeyToAccount('0x…'),
+     *   chain: mainnet,
+     *   transport: http(),
+     * })
+     * const hash = await client.sendTransaction({
+     *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+     *   value: 1000000000000000000n,
+     * })
+     */
+    sendTransaction: <TChainOverride extends Chain | undefined>(args: SendTransactionParameters<TChain, TAccount, TChainOverride>) => Promise<SendTransactionReturnType>;
+    /**
+     * Calculates an Ethereum-specific signature in [EIP-191 format](https://eips.ethereum.org/EIPS/eip-191): `keccak256("\x19Ethereum Signed Message:\n" + len(message) + message))`.
+     *
+     * - Docs: https://viem.sh/docs/actions/wallet/signMessage.html
+     * - JSON-RPC Methods:
+     *   - JSON-RPC Accounts: [`personal_sign`](https://docs.metamask.io/guide/signing-data.html#personal-sign)
+     *   - Local Accounts: Signs locally. No JSON-RPC request.
+     *
+     * With the calculated signature, you can:
+     * - use [`verifyMessage`](https://viem.sh/docs/utilities/verifyMessage.html) to verify the signature,
+     * - use [`recoverMessageAddress`](https://viem.sh/docs/utilities/recoverMessageAddress.html) to recover the signing address from a signature.
+     *
+     * @param args - {@link SignMessageParameters}
+     * @returns The signed message. {@link SignMessageReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const signature = await client.signMessage({
+     *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+     *   message: 'hello world',
+     * })
+     *
+     * @example
+     * // Account Hoisting
+     * import { createWalletClient, http } from 'viem'
+     * import { privateKeyToAccount } from 'viem/accounts'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   account: privateKeyToAccount('0x…'),
+     *   chain: mainnet,
+     *   transport: http(),
+     * })
+     * const signature = await client.signMessage({
+     *   message: 'hello world',
+     * })
+     */
+    signMessage: (args: SignMessageParameters<TAccount>) => Promise<SignMessageReturnType>;
+    /**
+     * Signs typed data and calculates an Ethereum-specific signature in [EIP-191 format](https://eips.ethereum.org/EIPS/eip-191): `keccak256("\x19Ethereum Signed Message:\n" + len(message) + message))`.
+     *
+     * - Docs: https://viem.sh/docs/actions/wallet/signTypedData.html
+     * - JSON-RPC Methods:
+     *   - JSON-RPC Accounts: [`eth_signTypedData_v4`](https://docs.metamask.io/guide/signing-data.html#signtypeddata-v4)
+     *   - Local Accounts: Signs locally. No JSON-RPC request.
+     *
+     * @param client - Client to use
+     * @param args - {@link SignTypedDataParameters}
+     * @returns The signed data. {@link SignTypedDataReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const signature = await client.signTypedData({
+     *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+     *   domain: {
+     *     name: 'Ether Mail',
+     *     version: '1',
+     *     chainId: 1,
+     *     verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
+     *   },
+     *   types: {
+     *     Person: [
+     *       { name: 'name', type: 'string' },
+     *       { name: 'wallet', type: 'address' },
+     *     ],
+     *     Mail: [
+     *       { name: 'from', type: 'Person' },
+     *       { name: 'to', type: 'Person' },
+     *       { name: 'contents', type: 'string' },
+     *     ],
+     *   },
+     *   primaryType: 'Mail',
+     *   message: {
+     *     from: {
+     *       name: 'Cow',
+     *       wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
+     *     },
+     *     to: {
+     *       name: 'Bob',
+     *       wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
+     *     },
+     *     contents: 'Hello, Bob!',
+     *   },
+     * })
+     *
+     * @example
+     * // Account Hoisting
+     * import { createWalletClient, http } from 'viem'
+     * import { privateKeyToAccount } from 'viem/accounts'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   account: privateKeyToAccount('0x…'),
+     *   chain: mainnet,
+     *   transport: http(),
+     * })
+     * const signature = await client.signTypedData({
+     *   domain: {
+     *     name: 'Ether Mail',
+     *     version: '1',
+     *     chainId: 1,
+     *     verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
+     *   },
+     *   types: {
+     *     Person: [
+     *       { name: 'name', type: 'string' },
+     *       { name: 'wallet', type: 'address' },
+     *     ],
+     *     Mail: [
+     *       { name: 'from', type: 'Person' },
+     *       { name: 'to', type: 'Person' },
+     *       { name: 'contents', type: 'string' },
+     *     ],
+     *   },
+     *   primaryType: 'Mail',
+     *   message: {
+     *     from: {
+     *       name: 'Cow',
+     *       wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
+     *     },
+     *     to: {
+     *       name: 'Bob',
+     *       wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
+     *     },
+     *     contents: 'Hello, Bob!',
+     *   },
+     * })
+     */
+    signTypedData: <const TTypedData extends TypedData | {
+        [key: string]: unknown;
+    }, TPrimaryType extends string>(args: SignTypedDataParameters<TTypedData, TPrimaryType, TAccount>) => Promise<SignTypedDataReturnType>;
+    /**
+     * Switch the target chain in a wallet.
+     *
+     * - Docs: https://viem.sh/docs/actions/wallet/switchChain.html
+     * - JSON-RPC Methods: [`eth_switchEthereumChain`](https://eips.ethereum.org/EIPS/eip-3326)
+     *
+     * @param args - {@link SwitchChainParameters}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet, optimism } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * await client.switchChain({ id: optimism.id })
+     */
+    switchChain: (args: SwitchChainParameters) => Promise<void>;
+    /**
+     * Adds an EVM chain to the wallet.
+     *
+     * - Docs: https://viem.sh/docs/actions/wallet/watchAsset.html
+     * - JSON-RPC Methods: [`eth_switchEthereumChain`](https://eips.ethereum.org/EIPS/eip-747)
+     *
+     * @param args - {@link WatchAssetParameters}
+     * @returns Boolean indicating if the token was successfully added. {@link WatchAssetReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const success = await client.watchAsset({
+     *   type: 'ERC20',
+     *   options: {
+     *     address: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
+     *     decimals: 18,
+     *     symbol: 'WETH',
+     *   },
+     * })
+     */
+    watchAsset: (args: WatchAssetParameters) => Promise<WatchAssetReturnType>;
+    /**
+     * Executes a write function on a contract.
+     *
+     * - Docs: https://viem.sh/docs/contract/writeContract.html
+     * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/contracts/writing-to-contracts
+     *
+     * A "write" function on a Solidity contract modifies the state of the blockchain. These types of functions require gas to be executed, and hence a [Transaction](https://viem.sh/docs/glossary/terms.html) is needed to be broadcast in order to change the state.
+     *
+     * Internally, uses a [Wallet Client](https://viem.sh/docs/clients/wallet.html) to call the [`sendTransaction` action](https://viem.sh/docs/actions/wallet/sendTransaction.html) with [ABI-encoded `data`](https://viem.sh/docs/contract/encodeFunctionData.html).
+     *
+     * __Warning: The `write` internally sends a transaction – it does not validate if the contract write will succeed (the contract may throw an error). It is highly recommended to [simulate the contract write with `contract.simulate`](https://viem.sh/docs/contract/writeContract.html#usage) before you execute it.__
+     *
+     * @param args - {@link WriteContractParameters}
+     * @returns A [Transaction Hash](https://viem.sh/docs/glossary/terms.html#hash). {@link WriteContractReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom, parseAbi } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const hash = await client.writeContract({
+     *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+     *   abi: parseAbi(['function mint(uint32 tokenId) nonpayable']),
+     *   functionName: 'mint',
+     *   args: [69420],
+     * })
+     *
+     * @example
+     * // With Validation
+     * import { createWalletClient, custom, parseAbi } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: mainnet,
+     *   transport: custom(window.ethereum),
+     * })
+     * const { request } = await client.simulateContract({
+     *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+     *   abi: parseAbi(['function mint(uint32 tokenId) nonpayable']),
+     *   functionName: 'mint',
+     *   args: [69420],
+     * }
+     * const hash = await client.writeContract(request)
+     */
+    writeContract: <const TAbi extends Abi | readonly unknown[], TFunctionName extends string, TChainOverride extends Chain | undefined>(args: WriteContractParameters<TAbi, TFunctionName, TChain, TAccount, TChainOverride>) => Promise<WriteContractReturnType>;
+};
+export declare function walletActions<TTransport extends Transport, TChain extends Chain | undefined = Chain | undefined, TAccount extends Account | undefined = Account | undefined>(client: Client<TTransport, TChain, TAccount>): WalletActions<TChain, TAccount>;
+//# sourceMappingURL=wallet.d.ts.map

package/dist/types/clients/decorators/wallet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wallet.d.ts","sourceRoot":"","sources":["../../../../src/clients/decorators/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAE7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACtD,OAAO,EACL,KAAK,oBAAoB,EAE1B,MAAM,oCAAoC,CAAA;AAC3C,OAAO,EACL,KAAK,kBAAkB,EAExB,MAAM,kCAAkC,CAAA;AACzC,OAAO,EACL,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAE9B,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EACL,KAAK,sBAAsB,EAE5B,MAAM,sCAAsC,CAAA;AAC7C,OAAO,EACL,KAAK,wBAAwB,EAE9B,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EACL,KAAK,0BAA0B,EAEhC,MAAM,0CAA0C,CAAA;AACjD,OAAO,EACL,KAAK,4BAA4B,EACjC,KAAK,4BAA4B,EAElC,MAAM,4CAA4C,CAAA;AACnD,OAAO,EACL,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAE/B,MAAM,yCAAyC,CAAA;AAChD,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAE3B,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EACL,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAE7B,MAAM,uCAAuC,CAAA;AAC9C,OAAO,EACL,KAAK,qBAAqB,EAE3B,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EACL,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EAE1B,MAAM,oCAAoC,CAAA;AAC3C,OAAO,EACL,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAE7B,MAAM,uCAAuC,CAAA;AAC9C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAA;AAEjE,MAAM,MAAM,aAAa,CACvB,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,IACxD;IACF;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,EAAE,CAAC,IAAI,EAAE,kBAAkB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACrD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,EAAE,CACd,KAAK,CAAC,IAAI,SAAS,GAAG,GAAG,SAAS,OAAO,EAAE,EAC3C,cAAc,SAAS,KAAK,GAAG,SAAS,EAExC,IAAI,EAAE,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC,KACnE,OAAO,CAAC,wBAAwB,CAAC,CAAA;IACtC;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,EAAE,MAAM,OAAO,CAAC,sBAAsB,CAAC,CAAA;IACnD;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,EAAE,MAAM,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAC/C;;;;;;;;;;;;;;;;;OAiBG;IACH,cAAc,EAAE,MAAM,OAAO,CAAC,wBAAwB,CAAC,CAAA;IACvD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,gBAAgB,EAAE,MAAM,OAAO,CAAC,0BAA0B,CAAC,CAAA;IAC3D;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,kBAAkB,EAAE,CAClB,IAAI,EAAE,4BAA4B,KAC/B,OAAO,CAAC,4BAA4B,CAAC,CAAA;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,eAAe,EAAE,CAAC,cAAc,SAAS,KAAK,GAAG,SAAS,EACxD,IAAI,EAAE,yBAAyB,CAAC,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC,KAC9D,OAAO,CAAC,yBAAyB,CAAC,CAAA;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,WAAW,EAAE,CACX,IAAI,EAAE,qBAAqB,CAAC,QAAQ,CAAC,KAClC,OAAO,CAAC,qBAAqB,CAAC,CAAA;IACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+FG;IACH,aAAa,EAAE,CACb,KAAK,CAAC,UAAU,SAAS,SAAS,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,EAC/D,YAAY,SAAS,MAAM,EAE3B,IAAI,EAAE,uBAAuB,CAAC,UAAU,EAAE,YAAY,EAAE,QAAQ,CAAC,KAC9D,OAAO,CAAC,uBAAuB,CAAC,CAAA;IACrC;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,EAAE,CAAC,IAAI,EAAE,qBAAqB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC3D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,UAAU,EAAE,CAAC,IAAI,EAAE,oBAAoB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAA;IACzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,aAAa,EAAE,CACb,KAAK,CAAC,IAAI,SAAS,GAAG,GAAG,SAAS,OAAO,EAAE,EAC3C,aAAa,SAAS,MAAM,EAC5B,cAAc,SAAS,KAAK,GAAG,SAAS,EAExC,IAAI,EAAE,uBAAuB,CAC3B,IAAI,EACJ,aAAa,EACb,MAAM,EACN,QAAQ,EACR,cAAc,CACf,KACE,OAAO,CAAC,uBAAuB,CAAC,CAAA;CACtC,CAAA;AAED,wBAAgB,aAAa,CAC3B,UAAU,SAAS,SAAS,EAC5B,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,EAE1D,MAAM,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,GAC3C,aAAa,CAAC,MAAM,EAAE,QAAQ,CAAC,CAgBjC"}

package/dist/types/clients/transports/createTransport.d.ts

@@ -0,0 +1,34 @@
+import type { Chain } from '../../types/chain.js';
+import type { EIP1193RequestFn } from '../../types/eip1193.js';
+import type { ClientConfig } from '../createClient.js';
+export type TransportConfig<TType extends string = string, TEIP1193RequestFn extends EIP1193RequestFn = EIP1193RequestFn> = {
+    /** 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: TEIP1193RequestFn;
+    /** The base delay (in ms) between retries. */
+    retryDelay?: number;
+    /** The max number of times to retry. */
+    retryCount?: number;
+    /** The timeout (in ms) for requests. */
+    timeout?: number;
+    /** The type of the transport. */
+    type: TType;
+};
+export type Transport<TType extends string = string, TRpcAttributes = Record<string, any>, TEIP1193RequestFn extends EIP1193RequestFn = EIP1193RequestFn> = <TChain extends Chain | undefined = Chain>({ chain, }: {
+    chain?: TChain;
+    pollingInterval?: ClientConfig['pollingInterval'];
+    retryCount?: TransportConfig['retryCount'];
+    timeout?: TransportConfig['timeout'];
+}) => {
+    config: TransportConfig<TType>;
+    request: TEIP1193RequestFn;
+    value?: TRpcAttributes;
+};
+/**
+ * @description Creates an transport intended to be used with a client.
+ */
+export declare function createTransport<TType extends string, TRpcAttributes extends Record<string, any>>({ key, name, request, retryCount, retryDelay, timeout, type, }: TransportConfig<TType>, value?: TRpcAttributes): ReturnType<Transport<TType, TRpcAttributes>>;
+//# sourceMappingURL=createTransport.d.ts.map

package/dist/types/clients/transports/createTransport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createTransport.d.ts","sourceRoot":"","sources":["../../../../src/clients/transports/createTransport.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AAE9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAEtD,MAAM,MAAM,eAAe,CACzB,KAAK,SAAS,MAAM,GAAG,MAAM,EAC7B,iBAAiB,SAAS,gBAAgB,GAAG,gBAAgB,IAC3D;IACF,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,gCAAgC;IAChC,GAAG,EAAE,MAAM,CAAA;IACX,4EAA4E;IAC5E,OAAO,EAAE,iBAAiB,CAAA;IAC1B,8CAA8C;IAC9C,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,wCAAwC;IACxC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,wCAAwC;IACxC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iCAAiC;IACjC,IAAI,EAAE,KAAK,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,SAAS,CACnB,KAAK,SAAS,MAAM,GAAG,MAAM,EAC7B,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACpC,iBAAiB,SAAS,gBAAgB,GAAG,gBAAgB,IAC3D,CAAC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,EAAE,EAC7C,KAAK,GACN,EAAE;IACD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,eAAe,CAAC,EAAE,YAAY,CAAC,iBAAiB,CAAC,CAAA;IACjD,UAAU,CAAC,EAAE,eAAe,CAAC,YAAY,CAAC,CAAA;IAC1C,OAAO,CAAC,EAAE,eAAe,CAAC,SAAS,CAAC,CAAA;CACrC,KAAK;IACJ,MAAM,EAAE,eAAe,CAAC,KAAK,CAAC,CAAA;IAC9B,OAAO,EAAE,iBAAiB,CAAA;IAC1B,KAAK,CAAC,EAAE,cAAc,CAAA;CACvB,CAAA;AAED;;GAEG;AACH,wBAAgB,eAAe,CAC7B,KAAK,SAAS,MAAM,EACpB,cAAc,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAE1C,EACE,GAAG,EACH,IAAI,EACJ,OAAO,EACP,UAAc,EACd,UAAgB,EAChB,OAAO,EACP,IAAI,GACL,EAAE,eAAe,CAAC,KAAK,CAAC,EACzB,KAAK,CAAC,EAAE,cAAc,GACrB,UAAU,CAAC,SAAS,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC,CAM9C"}

package/dist/types/clients/transports/custom.d.ts

@@ -0,0 +1,21 @@
+import { type Transport, type TransportConfig } from './createTransport.js';
+type EthereumProvider = {
+    request(...args: any): Promise<any>;
+};
+export type CustomTransportConfig = {
+    /** The key of the transport. */
+    key?: TransportConfig['key'];
+    /** The name of the transport. */
+    name?: TransportConfig['name'];
+    /** The max number of times to retry. */
+    retryCount?: TransportConfig['retryCount'];
+    /** The base delay (in ms) between retries. */
+    retryDelay?: TransportConfig['retryDelay'];
+};
+export type CustomTransport = Transport<'custom', {}, EthereumProvider['request']>;
+/**
+ * @description Creates a custom transport given an EIP-1193 compliant `request` attribute.
+ */
+export declare function custom<TProvider extends EthereumProvider>(provider: TProvider, config?: CustomTransportConfig): CustomTransport;
+export {};
+//# sourceMappingURL=custom.d.ts.map

package/dist/types/clients/transports/custom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom.d.ts","sourceRoot":"","sources":["../../../../src/clients/transports/custom.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,SAAS,EACd,KAAK,eAAe,EAErB,MAAM,sBAAsB,CAAA;AAE7B,KAAK,gBAAgB,GAAG;IAAE,OAAO,CAAC,GAAG,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;CAAE,CAAA;AAE/D,MAAM,MAAM,qBAAqB,GAAG;IAClC,gCAAgC;IAChC,GAAG,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAA;IAC5B,iCAAiC;IACjC,IAAI,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC,CAAA;IAC9B,wCAAwC;IACxC,UAAU,CAAC,EAAE,eAAe,CAAC,YAAY,CAAC,CAAA;IAC1C,8CAA8C;IAC9C,UAAU,CAAC,EAAE,eAAe,CAAC,YAAY,CAAC,CAAA;CAC3C,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,SAAS,CACrC,QAAQ,EACR,EAAE,EACF,gBAAgB,CAAC,SAAS,CAAC,CAC5B,CAAA;AAED;;GAEG;AACH,wBAAgB,MAAM,CAAC,SAAS,SAAS,gBAAgB,EACvD,QAAQ,EAAE,SAAS,EACnB,MAAM,GAAE,qBAA0B,GACjC,eAAe,CAWjB"}

package/dist/types/clients/transports/fallback.d.ts

@@ -0,0 +1,75 @@
+import type { Chain } from '../../types/chain.js';
+import { type Transport, type TransportConfig } from './createTransport.js';
+export type OnResponseFn = (args: {
+    method: string;
+    params: unknown[];
+    transport: ReturnType<Transport>;
+} & ({
+    error?: never;
+    response: unknown;
+    status: 'success';
+} | {
+    error: Error;
+    response?: never;
+    status: 'error';
+})) => void;
+type RankOptions = {
+    /**
+     * The polling interval (in ms) at which the ranker should ping the RPC URL.
+     * @default client.pollingInterval
+     */
+    interval?: number;
+    /**
+     * The number of previous samples to perform ranking on.
+     * @default 10
+     */
+    sampleCount?: number;
+    /**
+     * Timeout when sampling transports.
+     * @default 1_000
+     */
+    timeout?: number;
+    /**
+     * Weights to apply to the scores. Weight values are proportional.
+     */
+    weights?: {
+        /**
+         * The weight to apply to the latency score.
+         * @default 0.3
+         */
+        latency?: number;
+        /**
+         * The weight to apply to the stability score.
+         * @default 0.7
+         */
+        stability?: number;
+    };
+};
+export type FallbackTransportConfig = {
+    /** The key of the Fallback transport. */
+    key?: TransportConfig['key'];
+    /** The name of the Fallback transport. */
+    name?: TransportConfig['name'];
+    /** Toggle to enable ranking, or rank options. */
+    rank?: boolean | RankOptions;
+    /** The max number of times to retry. */
+    retryCount?: TransportConfig['retryCount'];
+    /** The base delay (in ms) between retries. */
+    retryDelay?: TransportConfig['retryDelay'];
+};
+export type FallbackTransport = Transport<'fallback', {
+    onResponse: (fn: OnResponseFn) => void;
+    transports: ReturnType<Transport>[];
+}>;
+export declare function fallback(transports_: Transport[], config?: FallbackTransportConfig): FallbackTransport;
+export declare function rankTransports({ chain, interval, onTransports, sampleCount, timeout, transports, weights, }: {
+    chain?: Chain;
+    interval: RankOptions['interval'];
+    onTransports: (transports: Transport[]) => void;
+    sampleCount?: RankOptions['sampleCount'];
+    timeout?: RankOptions['timeout'];
+    transports: Transport[];
+    weights?: RankOptions['weights'];
+}): void;
+export {};
+//# sourceMappingURL=fallback.d.ts.map

package/dist/types/clients/transports/fallback.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fallback.d.ts","sourceRoot":"","sources":["../../../../src/clients/transports/fallback.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AAIjD,OAAO,EACL,KAAK,SAAS,EACd,KAAK,eAAe,EAErB,MAAM,sBAAsB,CAAA;AAE7B,MAAM,MAAM,YAAY,GAAG,CACzB,IAAI,EAAE;IACJ,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,OAAO,EAAE,CAAA;IACjB,SAAS,EAAE,UAAU,CAAC,SAAS,CAAC,CAAA;CACjC,GAAG,CACA;IACE,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,QAAQ,EAAE,OAAO,CAAA;IACjB,MAAM,EAAE,SAAS,CAAA;CAClB,GACD;IACE,KAAK,EAAE,KAAK,CAAA;IACZ,QAAQ,CAAC,EAAE,KAAK,CAAA;IAChB,MAAM,EAAE,OAAO,CAAA;CAChB,CACJ,KACE,IAAI,CAAA;AAET,KAAK,WAAW,GAAG;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE;QACR;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,yCAAyC;IACzC,GAAG,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAA;IAC5B,0CAA0C;IAC1C,IAAI,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC,CAAA;IAC9B,iDAAiD;IACjD,IAAI,CAAC,EAAE,OAAO,GAAG,WAAW,CAAA;IAC5B,wCAAwC;IACxC,UAAU,CAAC,EAAE,eAAe,CAAC,YAAY,CAAC,CAAA;IAC1C,8CAA8C;IAC9C,UAAU,CAAC,EAAE,eAAe,CAAC,YAAY,CAAC,CAAA;CAC3C,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,SAAS,CACvC,UAAU,EACV;IACE,UAAU,EAAE,CAAC,EAAE,EAAE,YAAY,KAAK,IAAI,CAAA;IACtC,UAAU,EAAE,UAAU,CAAC,SAAS,CAAC,EAAE,CAAA;CACpC,CACF,CAAA;AAED,wBAAgB,QAAQ,CACtB,WAAW,EAAE,SAAS,EAAE,EACxB,MAAM,GAAE,uBAA4B,GACnC,iBAAiB,CAiFnB;AAED,wBAAgB,cAAc,CAAC,EAC7B,KAAK,EACL,QAAgB,EAChB,YAAY,EACZ,WAAgB,EAChB,OAAe,EACf,UAAU,EACV,OAAY,GACb,EAAE;IACD,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC,CAAA;IACjC,YAAY,EAAE,CAAC,UAAU,EAAE,SAAS,EAAE,KAAK,IAAI,CAAA;IAC/C,WAAW,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAA;IACxC,OAAO,CAAC,EAAE,WAAW,CAAC,SAAS,CAAC,CAAA;IAChC,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB,OAAO,CAAC,EAAE,WAAW,CAAC,SAAS,CAAC,CAAA;CACjC,QAwEA"}

package/dist/types/clients/transports/http.d.ts

@@ -0,0 +1,40 @@
+import { type HttpOptions } from '../../utils/rpc.js';
+import { type Transport, type TransportConfig } from './createTransport.js';
+export type BatchOptions = {
+    /** The maximum number of JSON-RPC requests to send in a batch. @default 1_000 */
+    batchSize?: number;
+    /** The maximum number of milliseconds to wait before sending a batch. @default 0 */
+    wait?: number;
+};
+export type HttpTransportConfig = {
+    /**
+     * Whether to enable Batch JSON-RPC.
+     * @link https://www.jsonrpc.org/specification#batch
+     */
+    batch?: boolean | BatchOptions;
+    /**
+     * Request configuration to pass to `fetch`.
+     * @link https://developer.mozilla.org/en-US/docs/Web/API/fetch
+     */
+    fetchOptions?: HttpOptions['fetchOptions'];
+    /** The key of the HTTP transport. */
+    key?: TransportConfig['key'];
+    /** The name of the HTTP transport. */
+    name?: TransportConfig['name'];
+    /** The max number of times to retry. */
+    retryCount?: TransportConfig['retryCount'];
+    /** The base delay (in ms) between retries. */
+    retryDelay?: TransportConfig['retryDelay'];
+    /** The timeout (in ms) for the HTTP request. Default: 10_000 */
+    timeout?: TransportConfig['timeout'];
+};
+export type HttpTransport = Transport<'http', {
+    url?: string;
+}>;
+/**
+ * @description Creates a HTTP transport that connects to a JSON-RPC API.
+ */
+export declare function http(
+/** URL of the JSON-RPC API. Defaults to the chain's public RPC URL. */
+url?: string, config?: HttpTransportConfig): HttpTransport;
+//# sourceMappingURL=http.d.ts.map

package/dist/types/clients/transports/http.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../../../src/clients/transports/http.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,WAAW,EAAwB,MAAM,oBAAoB,CAAA;AAE3E,OAAO,EACL,KAAK,SAAS,EACd,KAAK,eAAe,EAErB,MAAM,sBAAsB,CAAA;AAE7B,MAAM,MAAM,YAAY,GAAG;IACzB,iFAAiF;IACjF,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,oFAAoF;IACpF,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,YAAY,CAAA;IAC9B;;;OAGG;IACH,YAAY,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC,CAAA;IAC1C,qCAAqC;IACrC,GAAG,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAA;IAC5B,sCAAsC;IACtC,IAAI,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC,CAAA;IAC9B,wCAAwC;IACxC,UAAU,CAAC,EAAE,eAAe,CAAC,YAAY,CAAC,CAAA;IAC1C,8CAA8C;IAC9C,UAAU,CAAC,EAAE,eAAe,CAAC,YAAY,CAAC,CAAA;IAC1C,gEAAgE;IAChE,OAAO,CAAC,EAAE,eAAe,CAAC,SAAS,CAAC,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,aAAa,GAAG,SAAS,CACnC,MAAM,EACN;IACE,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CACF,CAAA;AAED;;GAEG;AACH,wBAAgB,IAAI;AAClB,uEAAuE;AACvE,GAAG,CAAC,EAAE,MAAM,EACZ,MAAM,GAAE,mBAAwB,GAC/B,aAAa,CA4Df"}