feat(multi-srp): add keyringId to getMnemonic fn

Author: PatrykLucka

packages/snaps-controllers/src/snaps/SnapController.ts

@@ -700,11 +700,12 @@ type SnapControllerArgs = {
   encryptor: ExportableKeyEncryptor;
 
   /**
-   * A hook to access the mnemonic of the user's primary keyring.
+   * A hook to access the mnemonic of the user's keyring, if the keyringId is not provided, it will return the mnemonic of the primary keyring.
    *
+   * @param keyringId - The ID of the keyring to get the mnemonic for.
    * @returns The mnemonic as bytes.
    */
-  getMnemonic: () => Promise<Uint8Array>;
+  getMnemonic: (keyringId?: string) => Promise<Uint8Array>;
 
   /**
    * A hook to get dynamic feature flags at runtime.
@@ -803,7 +804,7 @@ export class SnapController extends BaseController<
 
   #encryptor: ExportableKeyEncryptor;
 
-  #getMnemonic: () => Promise<Uint8Array>;
+  #getMnemonic: (keyringId?: string) => Promise<Uint8Array>;
 
   #getFeatureFlags: () => DynamicFeatureFlags;
 

packages/snaps-rpc-methods/src/restricted/getBip32Entropy.ts

@@ -22,9 +22,10 @@ const targetName = 'snap_getBip32Entropy';
 
 export type GetBip32EntropyMethodHooks = {
   /**
-   * @returns The mnemonic of the user's primary keyring.
+   * @param keyringId - The ID of the keyring to get the mnemonic for.
+   * @returns The mnemonic of the user's keyring, if the keyringId is not provided, it will return the mnemonic of the primary keyring.
    */
-  getMnemonic: () => Promise<Uint8Array>;
+  getMnemonic: (keyringId?: string) => Promise<Uint8Array>;
 
   /**
    * Waits for the extension to be unlocked.
@@ -128,7 +129,7 @@ export function getBip32EntropyImplementation({
     const node = await getNode({
       curve: params.curve,
       path: params.path,
-      secretRecoveryPhrase: await getMnemonic(),
+      secretRecoveryPhrase: await getMnemonic(params.keyringId),
       cryptographicFunctions: getClientCryptography(),
     });
 

packages/snaps-rpc-methods/src/restricted/getBip32PublicKey.ts

@@ -28,9 +28,10 @@ const targetName = 'snap_getBip32PublicKey';
 
 export type GetBip32PublicKeyMethodHooks = {
   /**
-   * @returns The mnemonic of the user's primary keyring.
+   * @param keyringId - The ID of the keyring to get the mnemonic for.
+   * @returns The mnemonic of the user's keyring, if the keyringId is not provided, it will return the mnemonic of the primary keyring.
    */
-  getMnemonic: () => Promise<Uint8Array>;
+  getMnemonic: (keyringId?: string) => Promise<Uint8Array>;
 
   /**
    * Waits for the extension to be unlocked.
@@ -147,7 +148,7 @@ export function getBip32PublicKeyImplementation({
     const node = await getNode({
       curve: params.curve,
       path: params.path,
-      secretRecoveryPhrase: await getMnemonic(),
+      secretRecoveryPhrase: await getMnemonic(params.keyringId),
       cryptographicFunctions: getClientCryptography(),
     });
 

packages/snaps-rpc-methods/src/restricted/getBip44Entropy.ts

@@ -21,9 +21,10 @@ const targetName = 'snap_getBip44Entropy';
 
 export type GetBip44EntropyMethodHooks = {
   /**
-   * @returns The mnemonic of the user's primary keyring.
+   * @param keyringId - The ID of the keyring to get the mnemonic for.
+   * @returns The mnemonic of the user's keyring, if the keyringId is not provided, it will return the mnemonic of the primary keyring.
    */
-  getMnemonic: () => Promise<Uint8Array>;
+  getMnemonic: (keyringId?: string) => Promise<Uint8Array>;
 
   /**
    * Waits for the extension to be unlocked.
@@ -128,7 +129,11 @@ export function getBip44EntropyImplementation({
     const params = args.params as GetBip44EntropyParams;
 
     const node = await BIP44CoinTypeNode.fromDerivationPath(
-      [await getMnemonic(), `bip32:44'`, `bip32:${params.coinType}'`],
+      [
+        await getMnemonic(params.keyringId),
+        `bip32:44'`,
+        `bip32:${params.coinType}'`,
+      ],
       'mainnet',
       getClientCryptography(),
     );

packages/snaps-rpc-methods/src/restricted/getEntropy.ts

@@ -74,9 +74,10 @@ export const getEntropyBuilder = Object.freeze({
 
 export type GetEntropyHooks = {
   /**
-   * @returns The mnemonic of the user's primary keyring.
+   * @param keyringId - The ID of the keyring to get the mnemonic for.
+   * @returns The mnemonic of the user's keyring, if the keyringId is not provided, it will return the mnemonic of the primary keyring.
    */
-  getMnemonic: () => Promise<Uint8Array>;
+  getMnemonic: (keyringId?: string) => Promise<Uint8Array>;
 
   /**
    * Waits for the extension to be unlocked.
@@ -130,7 +131,7 @@ function getEntropyImplementation({
     );
 
     await getUnlockPromise(true);
-    const mnemonicPhrase = await getMnemonic();
+    const mnemonicPhrase = await getMnemonic(params.keyringId);
 
     return deriveEntropy({
       input: origin,

packages/snaps-sdk/src/types/methods/get-bip32-public-key.ts

@@ -9,6 +9,7 @@ import type { Bip32Entropy } from '../permissions';
  * to `false`.
  */
 export type GetBip32PublicKeyParams = Bip32Entropy & {
+  keyringId?: string;
   compressed?: boolean;
 };
 

packages/snaps-sdk/src/types/methods/get-entropy.ts

@@ -6,10 +6,12 @@ import type { Hex } from '@metamask/utils';
  * @property version - The version of the entropy to retrieve. This is used for
  * backwards compatibility. As of now, only version 1 is supported.
  * @property salt - The optional salt to use when deriving the entropy.
+ * @property keyringId - The ID of the keyring to get the mnemonic for.
  */
 export type GetEntropyParams = {
   version: 1;
   salt?: string;
+  keyringId?: string;
 };
 
 /**

packages/snaps-sdk/src/types/permissions.ts

@@ -25,10 +25,12 @@ export type NameLookupMatchers =
 export type Bip32Entropy = {
   curve: SupportedCurve;
   path: string[];
+  keyringId?: string;
 };
 
 export type Bip44Entropy = {
   coinType: number;
+  keyringId?: string;
 };
 
 export type RequestedSnap = {

packages/snaps-simulation/src/methods/specifications.ts

@@ -30,9 +30,10 @@ export type PermissionSpecificationsHooks = {
   /**
    * A hook that returns the user's secret recovery phrase.
    *
+   * @param keyringId - The ID of the keyring to get the mnemonic for.
    * @returns The user's secret recovery phrase.
    */
-  getMnemonic: () => Promise<Uint8Array>;
+  getMnemonic: (keyringId?: string) => Promise<Uint8Array>;
 };
 
 export type GetPermissionSpecificationsOptions = {

packages/snaps-simulation/src/middleware/internal-methods/accounts.ts

@@ -10,7 +10,7 @@ import type {
 } from '@metamask/utils';
 
 export type GetAccountsHandlerHooks = {
-  getMnemonic: () => Promise<Uint8Array>;
+  getMnemonic: (keyringId?: string) => Promise<Uint8Array>;
 };
 
 /**