@metamask-previews/keyring-controller 19.0.4-preview-f726fb6 → 19.0.4-preview-3da4ce1b

package/dist/KeyringController.cjs

@@ -38,7 +38,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 var _KeyringController_instances, _KeyringController_controllerOperationMutex, _KeyringController_vaultOperationMutex, _KeyringController_keyringBuilders, _KeyringController_keyrings, _KeyringController_unsupportedKeyrings, _KeyringController_password, _KeyringController_encryptor, _KeyringController_cacheEncryptionKey, _KeyringController_qrKeyringStateListener, _KeyringController_registerMessageHandlers, _KeyringController_getKeyringBuilderForType, _KeyringController_addQRKeyring, _KeyringController_subscribeToQRKeyringEvents, _KeyringController_unsubscribeFromQRKeyringsEvents, _KeyringController_createNewVaultWithKeyring, _KeyringController_verifySeedPhrase, _KeyringController_getUpdatedKeyrings, _KeyringController_getSerializedKeyrings, _KeyringController_restoreSerializedKeyrings, _KeyringController_unlockKeyrings, _KeyringController_updateVault, _KeyringController_getAccountsFromKeyrings, _KeyringController_createKeyringWithFirstAccount, _KeyringController_newKeyring, _KeyringController_clearKeyrings, _KeyringController_restoreKeyring, _KeyringController_destroyKeyring, _KeyringController_removeEmptyKeyrings, _KeyringController_checkForDuplicate, _KeyringController_setUnlocked, _KeyringController_persistOrRollback, _KeyringController_withRollback, _KeyringController_assertControllerMutexIsLocked, _KeyringController_withControllerLock, _KeyringController_withVaultLock;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KeyringController = exports.getDefaultKeyringState = exports.keyringBuilderFactory = exports.SignTypedDataVersion = exports.AccountImportStrategy = exports.isCustodyKeyring = exports.KeyringTypes = void 0;
+exports.KeyringController = exports.getKeyringByFingerprint = exports.displayForKeyring = exports.getDefaultKeyringState = exports.keyringBuilderFactory = exports.SignTypedDataVersion = exports.AccountImportStrategy = exports.isCustodyKeyring = exports.KeyringTypes = void 0;
 const util_1 = require("@ethereumjs/util");
 const base_controller_1 = require("@metamask/base-controller");
 const encryptorUtils = __importStar(require("@metamask/browser-passworder"));
@@ -204,8 +204,26 @@ async function displayForKeyring(keyring) {
         // Cast to `string[]` here is safe here because `accounts` has no nullish
         // values, and `normalize` returns `string` unless given a nullish value
         accounts: accounts.map(normalize),
+        // @ts-expect-error TODO: update type in @metamask/utils
+        fingerprint: keyring?.getFingerprint?.(),
     };
 }
+exports.displayForKeyring = displayForKeyring;
+/**
+ * Retrieves a keyring from an array of keyrings based on its fingerprint.
+ *
+ * @param keyrings - Array of keyrings to search through.
+ * @param fingerprint - The fingerprint to match against.
+ * @returns Promise resolving to the matching keyring, or undefined if not found.
+ */
+async function getKeyringByFingerprint(keyrings, fingerprint) {
+    const fingerprints = await Promise.all(
+    // @ts-expect-error TODO: update type in @metamask/utils
+    keyrings.map((kr) => kr?.getFingerprint?.()));
+    const index = fingerprints.indexOf(fingerprint);
+    return keyrings[index];
+}
+exports.getKeyringByFingerprint = getKeyringByFingerprint;
 /**
  * Check if address is an ethereum address
  *
@@ -431,12 +449,27 @@ class KeyringController extends base_controller_1.BaseController {
      * Gets the seed phrase of the HD keyring.
      *
      * @param password - Password of the keyring.
+     * @param keyringId - The keyring identifier.
      * @returns Promise resolving to the seed phrase.
      */
-    async exportSeedPhrase(password) {
+    async exportSeedPhrase(password, keyringId) {
         await this.verifyPassword(password);
-        assertHasUint8ArrayMnemonic(__classPrivateFieldGet(this, _KeyringController_keyrings, "f")[0]);
-        return __classPrivateFieldGet(this, _KeyringController_keyrings, "f")[0].mnemonic;
+        let keyring;
+        if (keyringId) {
+            keyring = await getKeyringByFingerprint(__classPrivateFieldGet(this, _KeyringController_keyrings, "f"), keyringId);
+            if (!keyring) {
+                throw new Error(constants_1.KeyringControllerError.KeyringNotFound);
+            }
+            if (keyring.type !== KeyringTypes.hd) {
+                throw new Error(constants_1.KeyringControllerError.UnsupportedExportSeedPhrase);
+            }
+        }
+        else {
+            // There will always be an HD keyring
+            keyring = this.getKeyringsByType(KeyringTypes.hd)[0];
+        }
+        assertHasUint8ArrayMnemonic(keyring);
+        return keyring.mnemonic;
     }
     /**
      * Gets the private key from the keyring controlling an address.
@@ -850,6 +883,9 @@ class KeyringController extends base_controller_1.BaseController {
             if ('address' in selector) {
                 keyring = (await this.getKeyringForAccount(selector.address));
             }
+            else if ('fingerprint' in selector) {
+                keyring = (await getKeyringByFingerprint(__classPrivateFieldGet(this, _KeyringController_keyrings, "f"), selector.fingerprint));
+            }
             else {
                 keyring = this.getKeyringsByType(selector.type)[selector.index || 0];
                 if (!keyring && options.createIfMissing) {