viem/actions/wallet/getCapabilities.ts

TypeScript Interface for Ethereum

import type { Address } from 'abitype'

import { parseAccount } from '../../accounts/utils/parseAccount.js'
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 } from '../../types/account.js'
import type {
  Capabilities,
  ChainIdToCapabilities,
  ExtractCapabilities,
} from '../../types/capabilities.js'
import type { Prettify } from '../../types/utils.js'
import type { RequestErrorType } from '../../utils/buildRequest.js'
import { numberToHex } from '../../utils/encoding/toHex.js'

export type GetCapabilitiesParameters<
  chainId extends number | undefined = undefined,
> = {
  account?: Account | Address | undefined
  chainId?: chainId | number | undefined
}

export type GetCapabilitiesReturnType<
  chainId extends number | undefined = undefined,
> = Prettify<
  chainId extends number
    ? ExtractCapabilities<'getCapabilities', 'ReturnType'>
    : ChainIdToCapabilities<
        Capabilities<ExtractCapabilities<'getCapabilities', 'ReturnType'>>,
        number
      >
>

export type GetCapabilitiesErrorType = RequestErrorType | ErrorType

/**
 * Extract capabilities that a connected wallet supports (e.g. paymasters, session keys, etc).
 *
 * - Docs: https://viem.sh/docs/actions/wallet/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/actions'
 *
 * const client = createWalletClient({
 *   chain: mainnet,
 *   transport: custom(window.ethereum),
 * })
 * const capabilities = await getCapabilities(client)
 */
export async function getCapabilities<
  chainId extends number | undefined = undefined,
>(
  client: Client<Transport>,
  parameters: GetCapabilitiesParameters<chainId> = {},
): Promise<GetCapabilitiesReturnType<chainId>> {
  const { account = client.account, chainId } = parameters

  const account_ = account ? parseAccount(account) : undefined

  const params = chainId
    ? ([account_?.address, [numberToHex(chainId)]] as const)
    : ([account_?.address] as const)
  const capabilities_raw = await client.request({
    method: 'wallet_getCapabilities',
    params,
  })

  const capabilities = {} as ChainIdToCapabilities<
    ExtractCapabilities<'getCapabilities', 'ReturnType'>,
    number
  >
  for (const [chainId, capabilities_] of Object.entries(capabilities_raw)) {
    capabilities[Number(chainId)] = {}
    for (let [key, value] of Object.entries(capabilities_)) {
      if (key === 'addSubAccount') key = 'unstable_addSubAccount'
      capabilities[Number(chainId)][key] = value
    }
  }
  return (
    typeof chainId === 'number' ? capabilities[chainId] : capabilities
  ) as never
}