opstack-kit-chains
Version:
Support your OP-Stack network with 'opstack-kit'
39 lines • 2.05 kB
TypeScript
import type { Client } from '../../../clients/createClient.js';
import type { Transport } from '../../../clients/transports/createTransport.js';
import type { ErrorType } from '../../../errors/utils.js';
import type { Account, GetAccountParameter } from '../../../types/account.js';
import type { Chain } from '../../../types/chain.js';
import type { WalletCapabilities, WalletCapabilitiesRecord } from '../../../types/eip1193.js';
import type { Prettify } from '../../../types/utils.js';
import type { RequestErrorType } from '../../../utils/buildRequest.js';
export type GetCapabilitiesParameters<account extends Account | undefined = Account | undefined> = GetAccountParameter<account>;
export type GetCapabilitiesReturnType = Prettify<WalletCapabilitiesRecord<WalletCapabilities, number>>;
export type GetCapabilitiesErrorType = RequestErrorType | ErrorType;
/**
* Extract capabilities that a connected wallet supports (e.g. paymasters, session keys, etc).
*
* - Docs: https://viem.sh/experimental/eip5792/getCapabilities
* - JSON-RPC Methods: [`wallet_getCapabilities`](https://eips.ethereum.org/EIPS/eip-5792)
*
* @param client - Client to use
* @returns The wallet's capabilities. {@link GetCapabilitiesReturnType}
*
* @example
* import { createWalletClient, custom } from 'viem'
* import { mainnet } from 'viem/chains'
* import { getCapabilities } from 'viem/wallet'
*
* const client = createWalletClient({
* chain: mainnet,
* transport: custom(window.ethereum),
* })
* const capabilities = await getCapabilities(client)
*/
export declare function getCapabilities<chain extends Chain | undefined, account extends Account | undefined = undefined>(...parameters: account extends Account ? [client: Client<Transport, chain, account>] | [
client: Client<Transport, chain, account>,
parameters: GetCapabilitiesParameters<account>
] : [
client: Client<Transport, chain, account>,
parameters: GetCapabilitiesParameters<account>
]): Promise<GetCapabilitiesReturnType>;
//# sourceMappingURL=getCapabilities.d.ts.map