viem 2.28.4 → 2.29.0

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

@@ -1185,7 +1185,7 @@ export type {
   SignedAuthorization,
   SignedAuthorizationList,
 } from './types/authorization.js'
-export type { ResolvedRegister } from './types/register.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.4",
+  "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

@@ -1,10 +1,36 @@
+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 } from './utils.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?:
@@ -12,6 +38,17 @@ export type DefaultCapabilitiesSchema = {
             status: 'supported' | 'ready' | 'unsupported'
           }
         | undefined
+      unstable_addSubAccount?:
+        | {
+            keyTypes: (
+              | 'address'
+              | 'p256'
+              | 'webcrypto-p256'
+              | 'webauthn-p256'
+            )[]
+            supported: boolean
+          }
+        | undefined
       paymasterService?:
         | {
             supported: boolean
@@ -24,8 +61,9 @@ export type DefaultCapabilitiesSchema = {
       paymasterService?:
         | {
             [chainId: number]: {
-              url: string
               context?: Record<string, any> | undefined
+              optional?: boolean | undefined
+              url: string
             }
           }
         | undefined

package/types/eip1193.ts

@@ -1764,6 +1764,76 @@ export type WalletRpcSchema = [
     Parameters: [chain: AddEthereumChainParameter]
     ReturnType: null
   },
+  /**
+   *
+   */
+  {
+    Method: 'wallet_addSubAccount'
+    Parameters: [
+      {
+        account: 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'
+            }
+        >
+        version: string
+      },
+    ]
+    ReturnType: {
+      address: Address
+      factory?: Address | undefined
+      factoryData?: Hex | undefined
+    }
+  },
+  /**
+   * @description Requests to connect account(s).
+   * @link https://github.com/ethereum/ERCs/blob/abd1c9f4eda2d6ad06ade0e3af314637a27d1ee7/ERCS/erc-7846.md
+   * @example
+   * provider.request({ method: 'wallet_connect' })
+   * // => { ... }
+   */
+  {
+    Method: 'wallet_connect'
+    Parameters: [
+      {
+        capabilities?: Capabilities | undefined
+        version: string
+      },
+    ]
+    ReturnType: {
+      accounts: readonly {
+        address: Address
+        capabilities?: Capabilities | undefined
+      }[]
+    }
+  },
+  /**
+   * @description Disconnects connected account(s).
+   * @link https://github.com/ethereum/ERCs/blob/abd1c9f4eda2d6ad06ade0e3af314637a27d1ee7/ERCS/erc-7846.md
+   * @example
+   * provider.request({ method: 'wallet_disconnect' })
+   */
+  {
+    Method: 'wallet_disconnect'
+    Parameters?: undefined
+    ReturnType: void
+  },
   /**
    * @description Returns the status of a call batch that was sent via `wallet_sendCalls`.
    * @link https://eips.ethereum.org/EIPS/eip-5792