feat: add createAccounts

Author: ccharly

packages/keyring-api/CHANGELOG.md

@@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Add `Keyring.createAccounts` optional method ([#448](https://github.com/MetaMask/accounts/pull/448))
+  - This method is part of the keyring v2 specification and set as optional for backwards compatibility.
+  - This method can be used to create one or more accounts using the new keyring v2 account creation typed options.
 - Add support for account derivations using range of indices in `KeyringV2` ([#451](https://github.com/MetaMask/accounts/pull/451))
   - Add `bip44:derive-index-range` capability to `KeyringCapabilities`.
   - Add `AccountCreationType.Bip44DeriveIndexRange` and `CreateAccountBip44DeriveIndexRangeOptions`.

packages/keyring-api/src/api/keyring.ts

@@ -13,6 +13,7 @@ import type { Paginated, Pagination } from './pagination';
 import type { KeyringRequest } from './request';
 import type { KeyringResponse } from './response';
 import type { Transaction } from './transaction';
+import type { CreateAccountOptions } from './v2';
 
 /**
  * Keyring interface.
@@ -56,6 +57,19 @@ export type Keyring = {
     options?: Record<string, Json> & MetaMaskOptions,
   ): Promise<KeyringAccount>;
 
+  /**
+   * Creates one or more new accounts according to the provided options.
+   *
+   * Deterministic account creation MUST be idempotent, meaning that for
+   * deterministic algorithms, like BIP-44, calling this method with the same
+   * options should always return the same accounts, even if the accounts
+   * already exist in the keyring.
+   *
+   * @param options - Options describing how to create the account(s).
+   * @returns A promise that resolves to an array of the created account objects.
+   */
+  createAccounts?(options: CreateAccountOptions): Promise<KeyringAccount[]>;
+
   /**
    * Lists the assets of an account (fungibles and non-fungibles) represented
    * by their respective CAIP-19:

packages/keyring-api/src/rpc.ts

@@ -36,6 +36,7 @@ import {
 export enum KeyringRpcMethod {
   // Account management
   CreateAccount = 'keyring_createAccount',
+  CreateAccounts = 'keyring_createAccounts',
   DeleteAccount = 'keyring_deleteAccount',
   DiscoverAccounts = 'keyring_discoverAccounts',
   ExportAccount = 'keyring_exportAccount',
@@ -126,6 +127,23 @@ export const CreateAccountResponseStruct = KeyringAccountStruct;
 
 export type CreateAccountResponse = Infer<typeof CreateAccountResponseStruct>;
 
+// ----------------------------------------------------------------------------
+// Create accounts
+
+export const CreateAccountsRequestStruct = object({
+  ...CommonHeader,
+  method: literal('keyring_createAccounts'),
+  params: object({
+    options: record(string(), JsonStruct),
+  }),
+});
+
+export type CreateAccountsRequest = Infer<typeof CreateAccountsRequestStruct>;
+
+export const CreateAccountsResponseStruct = array(KeyringAccountStruct);
+
+export type CreateAccountsResponse = Infer<typeof CreateAccountsResponseStruct>;
+
 // ----------------------------------------------------------------------------
 // Set selected accounts
 

packages/keyring-snap-bridge/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add `SnapKeyring.createAccounts` method ([#448](https://github.com/MetaMask/accounts/pull/448))
+  - This method can be used to create one or more accounts using the new keyring v2 account creation typed options.
+
 ### Changed
 
 - Bump `@metamask/snaps-controllers` from `^14.0.1` to `^17.2.0` ([#422](https://github.com/MetaMask/accounts/pull/422))

packages/keyring-snap-bridge/src/SnapKeyring.ts

@@ -14,6 +14,7 @@ import type {
   CaipChainId,
   MetaMaskOptions,
   KeyringResponse,
+  CreateAccountOptions,
 } from '@metamask/keyring-api';
 import {
   EthBytesStruct,
@@ -891,6 +892,39 @@ export class SnapKeyring {
     });
   }
 
+  /**
+   * Create one or more accounts according to the provided options.
+   *
+   * This method supports batch account creation for BIP-44 derivation paths,
+   * allowing the creation of multiple accounts up to a specified maximum index.
+   *
+   * @param snapId - Snap ID to create the accounts for.
+   * @param options - Account creation options.
+   * @returns A promise that resolves to an array of the created account objects.
+   */
+  async createAccounts(
+    snapId: SnapId,
+    options: CreateAccountOptions,
+  ): Promise<KeyringAccount[]> {
+    const client = new KeyringInternalSnapClient({
+      messenger: this.#messenger,
+      snapId,
+    });
+
+    // Add each returned account to the internal accounts map.
+    // NOTE: This method DOES NOT rely on the `AccountCreated` event to add
+    // accounts to the keyring, since those accounts are created in batch.
+    const accounts = await client.createAccounts(options);
+    for (const account of accounts) {
+      this.#accounts.set(account.id, { account, snapId });
+    }
+
+    // Save the state after adding all accounts.
+    await this.#callbacks.saveState();
+
+    return accounts;
+  }
+
   /**
    * Checks if a Snap ID is known from the keyring.
    *

packages/keyring-snap-client/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add `KeyringClient.createAccounts` method ([#448](https://github.com/MetaMask/accounts/pull/448))
+  - This method can be used to create one or more accounts using the new keyring v2 account creation typed options.
+
 ## [8.1.1]
 
 ### Changed

packages/keyring-snap-client/src/KeyringClient.ts

@@ -1,6 +1,7 @@
 import {
   ApproveRequestResponseStruct,
   CreateAccountResponseStruct,
+  CreateAccountsResponseStruct,
   DeleteAccountResponseStruct,
   ExportAccountResponseStruct,
   FilterAccountChainsResponseStruct,
@@ -34,6 +35,7 @@ import type {
   CaipAssetTypeOrId,
   EntropySourceId,
   DiscoveredAccount,
+  CreateAccountOptions,
 } from '@metamask/keyring-api';
 import type { AccountId, JsonRpcRequest } from '@metamask/keyring-utils';
 import { strictMask } from '@metamask/keyring-utils';
@@ -117,6 +119,18 @@ export class KeyringClient implements Keyring {
     );
   }
 
+  async createAccounts(
+    options: CreateAccountOptions,
+  ): Promise<KeyringAccount[]> {
+    return strictMask(
+      await this.send({
+        method: KeyringRpcMethod.CreateAccounts,
+        params: options,
+      }),
+      CreateAccountsResponseStruct,
+    );
+  }
+
   async discoverAccounts(
     scopes: CaipChainId[],
     entropySource: EntropySourceId,