viem 2.28.3 → 2.29.0

package/experimental/erc7846/actions/connect.ts

@@ -0,0 +1,179 @@
+import type { Address } from 'abitype'
+import {
+  type RequestAddressesErrorType,
+  requestAddresses,
+} from '../../../actions/wallet/requestAddresses.js'
+import type { Client } from '../../../clients/createClient.js'
+import type { Transport } from '../../../clients/transports/createTransport.js'
+import type { BaseError } from '../../../errors/base.js'
+import type { ExtractCapabilities } from '../../../types/capabilities.js'
+import type { Chain } from '../../../types/chain.js'
+import type { Prettify } from '../../../types/utils.js'
+import type { RequestErrorType } from '../../../utils/buildRequest.js'
+import { numberToHex } from '../../../utils/encoding/toHex.js'
+
+export type ConnectParameters = Prettify<{
+  capabilities?: ExtractCapabilities<'connect', 'Request'> | undefined
+}>
+
+export type ConnectReturnType = Prettify<{
+  accounts: readonly {
+    address: Address
+    capabilities?: ExtractCapabilities<'connect', 'ReturnType'> | undefined
+  }[]
+}>
+
+export type ConnectErrorType = RequestErrorType | RequestAddressesErrorType
+
+/**
+ * Requests to connect account(s) with optional capabilities.
+ *
+ * - Docs: https://viem.sh/experimental/erc7846/connect
+ * - JSON-RPC Methods: [`wallet_connect`](https://github.com/ethereum/ERCs/blob/abd1c9f4eda2d6ad06ade0e3af314637a27d1ee7/ERCS/erc-7846.md)
+ *
+ * @param client - Client to use
+ * @param parameters - {@link ConnectParameters}
+ * @returns List of accounts managed by a wallet {@link ConnectReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { connect } from 'viem/experimental/erc7846'
+ *
+ * const client = createWalletClient({
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * })
+ * const response = await connect(client)
+ */
+export async function connect<chain extends Chain | undefined>(
+  client: Client<Transport, chain>,
+  parameters: ConnectParameters = {},
+): Promise<ConnectReturnType> {
+  const capabilities = formatRequestCapabilities(parameters.capabilities)
+
+  const response = await (async () => {
+    try {
+      return await client.request(
+        { method: 'wallet_connect', params: [{ capabilities, version: '1' }] },
+        { dedupe: true, retryCount: 0 },
+      )
+    } catch (e) {
+      const error = e as BaseError
+
+      // If the wallet does not support `wallet_connect`, and has no
+      // capabilities, attempt to use `eth_requestAccounts` instead.
+      if (
+        !parameters.capabilities &&
+        (error.name === 'InvalidInputRpcError' ||
+          error.name === 'InvalidParamsRpcError' ||
+          error.name === 'MethodNotFoundRpcError' ||
+          error.name === 'MethodNotSupportedRpcError' ||
+          error.name === 'UnsupportedProviderMethodError')
+      ) {
+        const addresses = await requestAddresses(client)
+        return {
+          accounts: addresses.map((address) => ({
+            address,
+            capabilities: {},
+          })),
+        }
+      }
+
+      throw error
+    }
+  })()
+
+  return {
+    ...response,
+    accounts: (response.accounts ?? []).map((account) => ({
+      ...account,
+      capabilities: formatResponseCapabilities(account.capabilities),
+    })),
+  }
+}
+
+function formatRequestCapabilities(
+  capabilities: ExtractCapabilities<'connect', 'Request'> | undefined,
+) {
+  const {
+    unstable_addSubAccount,
+    unstable_getSubAccounts: getSubAccounts,
+    unstable_signInWithEthereum,
+    ...rest
+  } = capabilities ?? {}
+
+  const addSubAccount = unstable_addSubAccount
+    ? {
+        ...unstable_addSubAccount,
+        account: {
+          ...unstable_addSubAccount.account,
+          ...(unstable_addSubAccount.account.chainId
+            ? {
+                chainId: numberToHex(unstable_addSubAccount.account.chainId),
+              }
+            : {}),
+        },
+      }
+    : undefined
+
+  const { chainId, expirationTime, issuedAt, notBefore } =
+    unstable_signInWithEthereum ?? {}
+  const signInWithEthereum = unstable_signInWithEthereum
+    ? {
+        ...unstable_signInWithEthereum,
+        chainId: numberToHex(chainId!),
+        ...(expirationTime
+          ? {
+              expirationTime: expirationTime.toISOString(),
+            }
+          : {}),
+        ...(issuedAt
+          ? {
+              issuedAt: issuedAt.toISOString(),
+            }
+          : {}),
+        ...(notBefore
+          ? {
+              notBefore: notBefore.toISOString(),
+            }
+          : {}),
+      }
+    : undefined
+
+  return {
+    ...rest,
+    ...(addSubAccount
+      ? {
+          addSubAccount,
+        }
+      : {}),
+    ...(getSubAccounts
+      ? {
+          getSubAccounts,
+        }
+      : {}),
+    ...(signInWithEthereum
+      ? {
+          signInWithEthereum,
+        }
+      : {}),
+  }
+}
+
+function formatResponseCapabilities(
+  capabilities: ExtractCapabilities<'connect', 'ReturnType'> | undefined,
+) {
+  return Object.entries(capabilities ?? {}).reduce(
+    (capabilities, [key, value]) => {
+      const k = (() => {
+        if (key === 'signInWithEthereum') return 'unstable_signInWithEthereum'
+        if (key === 'subAccounts') return 'unstable_subAccounts'
+        return key
+      })()
+      capabilities[k] = value
+      return capabilities
+    },
+    {} as Record<string, unknown>,
+  )
+}

package/experimental/erc7846/actions/disconnect.ts

@@ -0,0 +1,36 @@
+import type { Client } from '../../../clients/createClient.js'
+import type { Transport } from '../../../clients/transports/createTransport.js'
+import type { Chain } from '../../../types/chain.js'
+import type { RequestErrorType } from '../../../utils/buildRequest.js'
+
+export type DisconnectErrorType = RequestErrorType
+
+/**
+ * Requests to disconnect connected accounts.
+ *
+ * - Docs: https://viem.sh/experimental/erc7846/disconnect
+ * - JSON-RPC Methods: [`wallet_disconnect`](https://github.com/ethereum/ERCs/blob/abd1c9f4eda2d6ad06ade0e3af314637a27d1ee7/ERCS/erc-7846.md)
+ *
+ * @param client - Client to use
+ * @returns void
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { disconnect } from 'viem/experimental/erc7846'
+ *
+ * const client = createWalletClient({
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * })
+ *
+ * await disconnect(client)
+ */
+export async function disconnect<chain extends Chain | undefined>(
+  client: Client<Transport, chain>,
+) {
+  return await client.request(
+    { method: 'wallet_disconnect' },
+    { dedupe: true, retryCount: 0 },
+  )
+}

package/experimental/erc7846/decorators/erc7846.ts

@@ -0,0 +1,88 @@
+import type { Client } from '../../../clients/createClient.js'
+import type { Transport } from '../../../clients/transports/createTransport.js'
+import type { Chain } from '../../../types/chain.js'
+import {
+  type ConnectParameters,
+  type ConnectReturnType,
+  connect,
+} from '../actions/connect.js'
+import { disconnect } from '../actions/disconnect.js'
+
+export type Erc7846Actions = {
+  /**
+   * Requests to connect to a wallet.
+   *
+   * - Docs: https://viem.sh/experimental/erc7846/connect
+   * - JSON-RPC Methods: [`wallet_connect`](https://github.com/ethereum/ERCs/blob/abd1c9f4eda2d6ad06ade0e3af314637a27d1ee7/ERCS/erc-7846.md)
+   *
+   * @param client - Client to use
+   * @param parameters - {@link ConnectParameters}
+   * @returns List of accounts managed by a wallet {@link ConnectReturnType}
+   *
+   * @example
+   * import { createWalletClient, custom } from 'viem'
+   * import { mainnet } from 'viem/chains'
+   * import { erc7846Actions } from 'viem/experimental/erc7846'
+   *
+   * const client = createWalletClient({
+   *   chain: mainnet,
+   *   transport: custom(window.ethereum),
+   * }).extend(erc7846Actions())
+   *
+   * const response = await client.connect()
+   */
+  connect: (
+    parameters?: ConnectParameters | undefined,
+  ) => Promise<ConnectReturnType>
+  /**
+   * Requests to disconnect connected accounts.
+   *
+   * - Docs: https://viem.sh/experimental/erc7846/disconnect
+   * - JSON-RPC Methods: [`wallet_disconnect`](https://github.com/ethereum/ERCs/blob/abd1c9f4eda2d6ad06ade0e3af314637a27d1ee7/ERCS/erc-7846.md)
+   *
+   * @param client - Client to use
+   * @returns void
+   *
+   * @example
+   * import { createWalletClient, custom } from 'viem'
+   * import { mainnet } from 'viem/chains'
+   * import { erc7846Actions } from 'viem/experimental/erc7846'
+   *
+   * const client = createWalletClient({
+   *   chain: mainnet,
+   *   transport: custom(window.ethereum),
+   * }).extend(erc7846Actions())
+   *
+   * await client.disconnect()
+   */
+  disconnect: () => Promise<void>
+}
+
+/**
+ * A suite of ERC-7846 Wallet Actions.
+ *
+ * @example
+ * import { createPublicClient, createWalletClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { erc7846Actions } from 'viem/experimental/erc7846'
+ *
+ * const client = createWalletClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * }).extend(erc7846Actions())
+ *
+ * const response = await client.connect()
+ */
+export function erc7846Actions() {
+  return <
+    transport extends Transport,
+    chain extends Chain | undefined = Chain | undefined,
+  >(
+    client: Client<transport, chain>,
+  ): Erc7846Actions => {
+    return {
+      connect: (parameters) => connect(client, parameters),
+      disconnect: () => disconnect(client),
+    }
+  }
+}

package/experimental/erc7846/index.ts

@@ -0,0 +1,13 @@
+// biome-ignore lint/performance/noBarrelFile: entrypoint
+export {
+  type ConnectErrorType,
+  type ConnectParameters,
+  type ConnectReturnType,
+  connect,
+} from './actions/connect.js'
+export {
+  type DisconnectErrorType,
+  disconnect,
+} from './actions/disconnect.js'
+
+export { type Erc7846Actions, erc7846Actions } from './decorators/erc7846.js'

package/experimental/erc7846/package.json

@@ -0,0 +1,6 @@
+{
+  "type": "module",
+  "types": "../../_types/experimental/erc7846/index.d.ts",
+  "module": "../../_esm/experimental/erc7846/index.js",
+  "main": "../../_cjs/experimental/erc7846/index.js"
+}

package/experimental/erc7895/actions/addSubAccount.ts

@@ -0,0 +1,84 @@
+import type { Address } from 'abitype'
+import type { Client } from '../../../clients/createClient.js'
+import type { Transport } from '../../../clients/transports/createTransport.js'
+import type { Chain } from '../../../types/chain.js'
+import type { Hex } from '../../../types/misc.js'
+import type { OneOf, Prettify } from '../../../types/utils.js'
+import type { RequestErrorType } from '../../../utils/buildRequest.js'
+import { numberToHex } from '../../../utils/index.js'
+
+export type AddSubAccountParameters = Prettify<
+  OneOf<
+    | {
+        keys: readonly {
+          publicKey: Hex
+          type: 'address' | 'p256' | 'webcrypto-p256' | 'webauthn-p256'
+        }[]
+        type: 'create'
+      }
+    | {
+        address: Address
+        chainId?: number | undefined
+        type: 'deployed'
+      }
+    | {
+        address: Address
+        chainId?: number | undefined
+        factory: Address
+        factoryData: Hex
+        type: 'undeployed'
+      }
+  >
+>
+
+export type AddSubAccountReturnType = Prettify<{
+  address: Address
+  factory?: Address | undefined
+  factoryData?: Hex | undefined
+}>
+
+export type AddSubAccountErrorType = RequestErrorType
+
+/**
+ * Requests to add a Sub Account.
+ *
+ * - Docs: https://viem.sh/experimental/erc7895/addSubAccount
+ * - JSON-RPC Methods: [`wallet_addSubAccount`](https://github.com/ethereum/ERCs/blob/abd1c9f4eda2d6ad06ade0e3af314637a27d1ee7/ERCS/erc-7895.md)
+ *
+ * @param client - Client to use
+ * @param parameters - {@link AddSubAccountParameters}
+ * @returns Sub Account. {@link AddSubAccountReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addSubAccount } from 'viem/experimental/erc7895'
+ *
+ * const client = createWalletClient({
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * })
+ * const response = await addSubAccount(client, {
+ *   keys: [{ key: '0x0000000000000000000000000000000000000000', type: 'address' }],
+ *   type: 'create',
+ * })
+ */
+export async function addSubAccount<chain extends Chain | undefined>(
+  client: Client<Transport, chain>,
+  parameters: AddSubAccountParameters,
+): Promise<AddSubAccountReturnType> {
+  return client.request({
+    method: 'wallet_addSubAccount',
+    params: [
+      {
+        account: {
+          ...parameters,
+          ...(parameters.chainId
+            ? { chainId: numberToHex(parameters.chainId) }
+            : {}),
+        } as never,
+        version: '1',
+      },
+    ],
+  })
+}

package/experimental/erc7895/decorators/erc7895.ts

@@ -0,0 +1,70 @@
+import type { Client } from '../../../clients/createClient.js'
+import type { Transport } from '../../../clients/transports/createTransport.js'
+import type { Chain } from '../../../types/chain.js'
+import {
+  type AddSubAccountParameters,
+  type AddSubAccountReturnType,
+  addSubAccount,
+} from '../actions/addSubAccount.js'
+
+export type Erc7895Actions = {
+  /**
+   * Requests to add a Sub Account.
+   *
+   * - Docs: https://viem.sh/experimental/erc7895/addSubAccount
+   * - JSON-RPC Methods: [`wallet_addSubAccount`](https://github.com/ethereum/ERCs/blob/abd1c9f4eda2d6ad06ade0e3af314637a27d1ee7/ERCS/erc-7895.md)
+   *
+   * @param client - Client to use
+   * @param parameters - {@link AddSubAccountParameters}
+   * @returns Sub Account. {@link AddSubAccountReturnType}
+   *
+   * @example
+   * import { createWalletClient, custom } from 'viem'
+   * import { mainnet } from 'viem/chains'
+   * import { erc7895Actions } from 'viem/experimental'
+   *
+   * const client = createWalletClient({
+   *   chain: mainnet,
+   *   transport: custom(window.ethereum),
+   * }).extend(erc7895Actions())
+   *
+   * const response = await client.addSubAccount({
+   *   keys: [{ key: '0x0000000000000000000000000000000000000000', type: 'address' }],
+   *   type: 'create',
+   * })
+   */
+  addSubAccount: (
+    parameters: AddSubAccountParameters,
+  ) => Promise<AddSubAccountReturnType>
+}
+
+/**
+ * A suite of ERC-7895 Wallet Actions.
+ *
+ * @example
+ * import { createPublicClient, createWalletClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { erc7895Actions } from 'viem/experimental'
+ *
+ * const client = createWalletClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * }).extend(erc7895Actions())
+ *
+ * const response = await client.addSubAccount({
+ *   keys: [{ key: '0x0000000000000000000000000000000000000000', type: 'address' }],
+ *   type: 'create',
+ * })
+ */
+export function erc7895Actions() {
+  return <
+    transport extends Transport,
+    chain extends Chain | undefined = Chain | undefined,
+  >(
+    client: Client<transport, chain>,
+  ): Erc7895Actions => {
+    return {
+      addSubAccount: (parameters) => addSubAccount(client, parameters),
+    }
+  }
+}

package/experimental/erc7895/index.ts

@@ -0,0 +1,9 @@
+// biome-ignore lint/performance/noBarrelFile: entrypoint
+export {
+  type AddSubAccountErrorType,
+  type AddSubAccountParameters,
+  type AddSubAccountReturnType,
+  addSubAccount,
+} from './actions/addSubAccount.js'
+
+export { type Erc7895Actions, erc7895Actions } from './decorators/erc7895.js'

package/experimental/erc7895/package.json

@@ -0,0 +1,6 @@
+{
+  "type": "module",
+  "types": "../../_types/experimental/erc7895/index.d.ts",
+  "module": "../../_esm/experimental/erc7895/index.js",
+  "main": "../../_cjs/experimental/erc7895/index.js"
+}

package/experimental/index.ts

@@ -175,3 +175,13 @@ export {
   type Erc7821Actions,
   erc7821Actions,
 } from './erc7821/decorators/erc7821.js'
+
+export {
+  type Erc7846Actions,
+  erc7846Actions,
+} from './erc7846/decorators/erc7846.js'
+
+export {
+  type Erc7895Actions,
+  erc7895Actions,
+} from './erc7895/decorators/erc7895.js'

package/index.ts

@@ -13,7 +13,6 @@ export {
   type ParseAbiItem,
   type ParseAbiParameter,
   type ParseAbiParameters,
-  type ResolvedRegister,
   type TypedData,
   type TypedDataDomain,
   type TypedDataParameter,
@@ -1105,6 +1104,16 @@ export type {
   BlockTag,
   Uncle,
 } from './types/block.js'
+export type {
+  Capabilities,
+  /** @deprecated Use `Capabilities` instead. */
+  Capabilities as WalletCapabilities,
+  CapabilitiesSchema,
+  /** @deprecated Use `ChainIdToCapabilities` instead. */
+  ChainIdToCapabilities as WalletCapabilitiesRecord,
+  ChainIdToCapabilities,
+  ExtractCapabilities,
+} from './types/capabilities.js'
 export type {
   ByteArray,
   Hash,
@@ -1133,8 +1142,6 @@ export type {
   RpcSchema,
   RpcSchemaOverride,
   TestRpcSchema,
-  WalletCapabilities,
-  WalletCapabilitiesRecord,
   WalletCallReceipt,
   WalletGetCallsStatusReturnType,
   WalletGrantPermissionsParameters,
@@ -1178,6 +1185,7 @@ export type {
   SignedAuthorization,
   SignedAuthorizationList,
 } from './types/authorization.js'
+export type { Register, ResolvedRegister } from './types/register.js'
 export type {
   Index,
   Quantity,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "2.28.3",
+  "version": "2.29.0",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",
@@ -74,6 +74,11 @@
       "import": "./_esm/experimental/erc7821/index.js",
       "default": "./_cjs/experimental/erc7821/index.js"
     },
+    "./experimental/erc7846": {
+      "types": "./_types/experimental/erc7846/index.d.ts",
+      "import": "./_esm/experimental/erc7846/index.js",
+      "default": "./_cjs/experimental/erc7846/index.js"
+    },
     "./linea": {
       "types": "./_types/linea/index.d.ts",
       "import": "./_esm/linea/index.js",
@@ -145,6 +150,9 @@
       "experimental/erc7821": [
         "./_types/experimental/erc7821/index.d.ts"
       ],
+      "experimental/erc7846": [
+        "./_types/experimental/erc7846/index.d.ts"
+      ],
       "node": [
         "./_types/node/index.d.ts"
       ],

package/types/capabilities.ts

@@ -0,0 +1,96 @@
+import type {
+  AddSubAccountParameters,
+  AddSubAccountReturnType,
+} from '../experimental/erc7895/actions/addSubAccount.js'
+import type { SiweMessage } from '../utils/siwe/types.js'
+import type { Hex } from './misc.js'
+import type { ResolvedRegister } from './register.js'
+import type { Prettify, RequiredBy } from './utils.js'
+
+export type CapabilitiesSchema = ResolvedRegister['CapabilitiesSchema']
+
+export type DefaultCapabilitiesSchema = {
+  connect: {
+    Request: {
+      unstable_addSubAccount?:
+        | {
+            account: AddSubAccountParameters
+          }
+        | undefined
+      unstable_signInWithEthereum?:
+        | RequiredBy<Partial<SiweMessage>, 'chainId' | 'nonce'>
+        | undefined
+    }
+    ReturnType: {
+      unstable_signInWithEthereum?:
+        | {
+            message: string
+            signature: Hex
+          }
+        | undefined
+      unstable_subAccounts?: readonly AddSubAccountReturnType[] | undefined
+    }
+  }
+  getCapabilities: {
+    ReturnType: {
+      atomic?:
+        | {
+            status: 'supported' | 'ready' | 'unsupported'
+          }
+        | undefined
+      unstable_addSubAccount?:
+        | {
+            keyTypes: (
+              | 'address'
+              | 'p256'
+              | 'webcrypto-p256'
+              | 'webauthn-p256'
+            )[]
+            supported: boolean
+          }
+        | undefined
+      paymasterService?:
+        | {
+            supported: boolean
+          }
+        | undefined
+    }
+  }
+  sendCalls: {
+    Request: {
+      paymasterService?:
+        | {
+            [chainId: number]: {
+              context?: Record<string, any> | undefined
+              optional?: boolean | undefined
+              url: string
+            }
+          }
+        | undefined
+    }
+  }
+}
+
+export type Capabilities<capabilities extends Record<string, any> = {}> = {
+  [key: string]: any
+} & capabilities
+
+export type ChainIdToCapabilities<
+  capabilities extends Capabilities = Capabilities,
+  id extends string | number = Hex,
+> = {
+  [chainId in id]: capabilities
+}
+
+export type ExtractCapabilities<
+  method extends string,
+  key extends 'Request' | 'ReturnType',
+> = Prettify<
+  method extends keyof CapabilitiesSchema
+    ? CapabilitiesSchema[method] extends {
+        [k in key]: infer value extends Record<string, any>
+      }
+      ? Capabilities<value>
+      : Capabilities
+    : Capabilities
+>