feat: Bump @metamask/keyring-controller to v6.0.0

app/components/Views/ChoosePassword/index.js

@@ -551,10 +551,7 @@ class ChoosePassword extends PureComponent {
     const { KeyringController } = Engine.context;
     const { password } = this.state;
     const keychainPassword = this.keyringControllerPasswordSet ? password : '';
-    const mnemonic = await KeyringController.exportSeedPhrase(
-      keychainPassword,
-    ).toString();
-    return JSON.stringify(mnemonic).replace(/"/g, '');
+    return await KeyringController.exportSeedPhrase(keychainPassword);
   };
 
   jumpToConfirmPassword = () => {

app/components/Views/ConnectQRHardware/index.tsx

@@ -252,17 +252,12 @@ const ConnectQRHardware = ({ navigation }: IConnectQRHardwareProps) => {
   );
 
   const onUnlock = useCallback(async () => {
-    const { PreferencesController } = Engine.context as any;
     resetError();
     setBlockingModalVisible(true);
-    const importedAccountAddresses = [];
     try {
       for (const account of checkedAccounts) {
-        const accountAddress =
-          await KeyringController.unlockQRHardwareWalletAccount(account);
-        importedAccountAddresses.push(accountAddress);
+        await KeyringController.unlockQRHardwareWalletAccount(account);
       }
-      PreferencesController.setSelectedAddress(importedAccountAddresses[0]);
     } catch (err) {
       Logger.log('Error: Connecting QR hardware wallet', err);
     }

app/components/Views/ManualBackupStep1/index.js

@@ -14,6 +14,7 @@ import { connect } from 'react-redux';
 import { KeyboardAwareScrollView } from 'react-native-keyboard-aware-scroll-view';
 import FeatherIcons from 'react-native-vector-icons/Feather';
 import { BlurView } from '@react-native-community/blur';
+import { wordlist } from '@metamask/scure-bip39/dist/wordlists/english';
 import { baseStyles } from '../../../styles/common';
 import StyledButton from '../../UI/StyledButton';
 import OnboardingProgress from '../../UI/OnboardingProgress';
@@ -29,6 +30,7 @@ import {
   WRONG_PASSWORD_ERROR,
 } from '../../../constants/onboarding';
 import { useTheme } from '../../../util/theme';
+import { uint8ArrayToMnemonic } from '../../../util/mnemonic';
 import { createStyles } from './styles';
 
 import { CONFIRM_CHANGE_PASSWORD_INPUT_BOX_ID } from '../../../constants/test-ids';
@@ -63,10 +65,10 @@ const ManualBackupStep1 = ({ route, navigation, appTheme }) => {
 
   const tryExportSeedPhrase = async (password) => {
     const { KeyringController } = Engine.context;
-    const mnemonic = await KeyringController.exportSeedPhrase(
+    const uint8ArrayMnemonic = await KeyringController.exportSeedPhrase(
       password,
-    ).toString();
-    return JSON.stringify(mnemonic).replace(/"/g, '').split(' ');
+    );
+    return uint8ArrayToMnemonic(uint8ArrayMnemonic, wordlist).split(' ');
   };
 
   useEffect(() => {

app/components/Views/ManualBackupStep2/index.js

@@ -16,7 +16,7 @@ import { connect } from 'react-redux';
 import { seedphraseBackedUp } from '../../../actions/user';
 import MaterialIcon from 'react-native-vector-icons/MaterialCommunityIcons';
 import { getOnboardingNavbarOptions } from '../../UI/Navbar';
-import { shuffle, compareSRPs } from '../../../util/SRP';
+import { shuffle, compareMnemonics } from '../../../util/mnemonic';
 import { MetaMetricsEvents } from '../../../core/Analytics';
 import AnalyticsV2 from '../../../util/analyticsV2';
 import { useTheme } from '../../../util/theme';
@@ -120,7 +120,7 @@ const ManualBackupStep2 = ({ navigation, seedphraseBackedUp, route }) => {
       (confirmedWord) => confirmedWord.word,
     );
 
-    return compareSRPs(validWords, proposedWords);
+    return compareMnemonics(validWords, proposedWords);
   }, [confirmedWords, route.params?.words]);
 
   const goNext = () => {

app/components/Views/ResetPassword/index.js

@@ -461,21 +461,6 @@ class ResetPassword extends PureComponent {
     );
   };
 
-  /**
-   * Returns current vault seed phrase
-   * It does it using an empty password or a password set by the user
-   * depending on the state the app is currently in
-   */
-  getSeedPhrase = async () => {
-    const { KeyringController } = Engine.context;
-    const { originalPassword } = this.state;
-    const keychainPassword = originalPassword;
-    const mnemonic = await KeyringController.exportSeedPhrase(
-      keychainPassword,
-    ).toString();
-    return JSON.stringify(mnemonic).replace(/"/g, '');
-  };
-
   jumpToConfirmPassword = () => {
     const { current } = this.confirmPasswordInput;
     current && current.focus();

app/components/Views/RevealPrivateCredential/RevealPrivateCredential.tsx

@@ -10,13 +10,14 @@ import {
   View,
 } from 'react-native';
 import { useDispatch, useSelector } from 'react-redux';
-import AsyncStorage from '../../../store/async-storage-wrapper';
+import { wordlist } from '@metamask/scure-bip39/dist/wordlists/english';
 import QRCode from 'react-native-qrcode-svg';
 import ScrollableTabView, {
   DefaultTabBar,
 } from 'react-native-scrollable-tab-view';
 const CustomTabView = View as any;
 import Icon from 'react-native-vector-icons/FontAwesome5';
+import AsyncStorage from '../../../store/async-storage-wrapper';
 import ActionView from '../../UI/ActionView';
 import ButtonReveal from '../../UI/ButtonReveal';
 import Button, {
@@ -39,6 +40,7 @@ import Engine from '../../../core/Engine';
 import { BIOMETRY_CHOICE } from '../../../constants/storage';
 import { MetaMetricsEvents } from '../../../core/Analytics';
 import AnalyticsV2 from '../../../util/analyticsV2';
+import { uint8ArrayToMnemonic } from '../../../util/mnemonic';
 import { Authentication } from '../../../core/';
 
 import Device from '../../../util/device';
@@ -123,10 +125,8 @@ const RevealPrivateCredential = ({
     try {
       let privateCredential;
       if (!isPrivateKeyReveal) {
-        const mnemonic = await KeyringController.exportSeedPhrase(
-          pswd,
-        ).toString();
-        privateCredential = JSON.stringify(mnemonic).replace(/"/g, '');
+        const uint8ArraySeed = await KeyringController.exportSeedPhrase(pswd);
+        privateCredential = uint8ArrayToMnemonic(uint8ArraySeed, wordlist);
       } else {
         privateCredential = await KeyringController.exportAccount(
           pswd,
@@ -204,20 +204,23 @@ const RevealPrivateCredential = ({
     navigateBack();
   };
 
-  const tryUnlock = () => {
+  const tryUnlock = async () => {
     const { KeyringController } = Engine.context as any;
-    if (KeyringController.validatePassword(password)) {
-      if (!isPrivateKey) {
-        const currentDate = new Date();
-        dispatch(recordSRPRevealTimestamp(currentDate.toString()));
-        AnalyticsV2.trackEvent(MetaMetricsEvents.NEXT_REVEAL_SRP_CTA, {});
-      }
-      setIsModalVisible(true);
-      setWarningIncorrectPassword('');
-    } else {
+    try {
+      await KeyringController.verifyPassword(password);
+    } catch {
       const msg = strings('reveal_credential.warning_incorrect_password');
       setWarningIncorrectPassword(msg);
+      return;
     }
+
+    if (!isPrivateKey) {
+      const currentDate = new Date();
+      dispatch(recordSRPRevealTimestamp(currentDate.toString()));
+      AnalyticsV2.trackEvent(MetaMetricsEvents.NEXT_REVEAL_SRP_CTA, {});
+    }
+    setIsModalVisible(true);
+    setWarningIncorrectPassword('');
   };
 
   const onPasswordChange = (pswd: string) => {
@@ -410,11 +413,6 @@ const RevealPrivateCredential = ({
     setIsModalVisible(false);
   };
 
-  const enableNextButton = () => {
-    const { KeyringController } = Engine.context as any;
-    return KeyringController.validatePassword(password);
-  };
-
   const renderModal = (
     isPrivateKeyReveal: boolean,
     privCredentialName: string,
@@ -533,7 +531,7 @@ const RevealPrivateCredential = ({
         onCancelPress={unlocked ? done : cancelReveal}
         onConfirmPress={() => tryUnlock()}
         showConfirmButton={!unlocked}
-        confirmDisabled={!enableNextButton()}
+        confirmDisabled={password.length < 8}
         cancelTestID={SECRET_RECOVERY_PHRASE_CANCEL_BUTTON_ID}
         confirmTestID={SECRET_RECOVERY_PHRASE_NEXT_BUTTON_ID}
       >

app/core/AppConstants.ts

@@ -151,6 +151,7 @@ export default {
   CANCEL_RATE: 'Transactions (Cancel)',
   SPEED_UP_RATE: 'Transactions (Speed Up)',
   NETWORK_STATE_CHANGE_EVENT: 'NetworkController:stateChange',
+  KEYRING_STATE_CHANGE_EVENT: 'KeyringController:stateChange',
   ETH_SIGN_ERROR: 'eth_sign requires 32 byte message hash',
   TERMS_OF_USE: {
     TERMS_DISPLAYED: 'ToU Displayed',

app/core/BackgroundBridge/BackgroundBridge.js

@@ -92,8 +92,14 @@ export class BackgroundBridge extends EventEmitter {
     );
     Engine.context.PreferencesController.subscribe(this.sendStateUpdate);
 
-    Engine.context.KeyringController.onLock(this.onLock.bind(this));
-    Engine.context.KeyringController.onUnlock(this.onUnlock.bind(this));
+    Engine.controllerMessenger.subscribe(
+      'KeyringController:lock',
+      this.onLock.bind(this),
+    );
+    Engine.controllerMessenger.subscribe(
+      'KeyringController:unlock',
+      this.onUnlock.bind(this),
+    );
 
     this.on('update', this.onStateUpdate);
 

app/core/BackupVault/backupVault.ts

@@ -1,4 +1,4 @@
-import { KeyringState } from '@metamask/keyring-controller';
+import { KeyringControllerState } from '@metamask/keyring-controller';
 import Logger from '../../util/Logger';
 import {
   getInternetCredentials,
@@ -35,7 +35,7 @@ interface KeyringBackupResponse {
   }
  */
 export async function backupVault(
-  keyringState: KeyringState,
+  keyringState: KeyringControllerState,
 ): Promise<KeyringBackupResponse> {
   if (keyringState.vault) {
     const backupResult = await setInternetCredentials(

app/core/Engine.ts

@@ -30,8 +30,10 @@ import { BaseState, ControllerMessenger } from '@metamask/base-controller';
 import { ComposableController } from '@metamask/composable-controller';
 import {
   KeyringController,
-  KeyringState,
   SignTypedDataVersion,
+  KeyringControllerState,
+  KeyringControllerActions,
+  KeyringControllerEvents,
 } from '@metamask/keyring-controller';
 import {
   NetworkController,
@@ -125,15 +127,17 @@ type GlobalActions =
   | GetTokenListState
   | NetworkControllerActions
   | PermissionControllerActions
-  | SignatureControllerActions;
+  | SignatureControllerActions
+  | KeyringControllerActions;
 type GlobalEvents =
   | ApprovalControllerEvents
   | CurrencyRateStateChange
   | GasFeeStateChange
   | TokenListStateChange
   | NetworkControllerEvents
   | PermissionControllerEvents
-  | SignatureControllerEvents;
+  | SignatureControllerEvents
+  | KeyringControllerEvents;
 
 type PermissionsByRpcMethod = ReturnType<typeof getPermissionSpecifications>;
 type Permissions = PermissionsByRpcMethod[keyof PermissionsByRpcMethod];
@@ -145,7 +149,7 @@ export interface EngineState {
   NftController: NftState;
   TokenListController: TokenListState;
   CurrencyRateController: CurrencyRateState;
-  KeyringController: KeyringState;
+  KeyringController: KeyringControllerState;
   NetworkController: NetworkState;
   PreferencesController: PreferencesState;
   PhishingController: PhishingState;
@@ -221,7 +225,7 @@ class Engine {
   // eslint-disable-next-line @typescript-eslint/default-param-last
   constructor(
     initialState: Partial<EngineState> = {},
-    initialKeyringState?: KeyringState | null,
+    initialKeyringState?: KeyringControllerState | null,
   ) {
     this.controllerMessenger = new ControllerMessenger();
 
@@ -391,8 +395,6 @@ class Engine {
     const phishingController = new PhishingController();
     phishingController.maybeUpdateState();
 
-    const additionalKeyrings = [QRHardwareKeyring];
-
     const getIdentities = () => {
       const identities = preferencesController.state.identities;
       const lowerCasedIdentities: PreferencesState['identities'] = {};
@@ -402,29 +404,40 @@ class Engine {
       return lowerCasedIdentities;
     };
 
-    const keyringState = initialKeyringState || initialState.KeyringController;
+    const qrKeyringBuilder = () => new QRHardwareKeyring();
+    qrKeyringBuilder.type = QRHardwareKeyring.type;
 
-    const keyringController = new KeyringController(
-      {
-        removeIdentity: preferencesController.removeIdentity.bind(
-          preferencesController,
-        ),
-        syncIdentities: preferencesController.syncIdentities.bind(
-          preferencesController,
-        ),
-        updateIdentities: preferencesController.updateIdentities.bind(
-          preferencesController,
-        ),
-        setSelectedAddress: preferencesController.setSelectedAddress.bind(
-          preferencesController,
-        ),
-        setAccountLabel: preferencesController.setAccountLabel.bind(
-          preferencesController,
-        ),
-      },
-      { encryptor, keyringTypes: additionalKeyrings },
-      keyringState,
-    );
+    const keyringController = new KeyringController({
+      removeIdentity: preferencesController.removeIdentity.bind(
+        preferencesController,
+      ),
+      syncIdentities: preferencesController.syncIdentities.bind(
+        preferencesController,
+      ),
+      updateIdentities: preferencesController.updateIdentities.bind(
+        preferencesController,
+      ),
+      setSelectedAddress: preferencesController.setSelectedAddress.bind(
+        preferencesController,
+      ),
+      setAccountLabel: preferencesController.setAccountLabel.bind(
+        preferencesController,
+      ),
+      encryptor,
+      // @ts-expect-error Error might be caused by base controller version mismatch
+      messenger: this.controllerMessenger.getRestricted({
+        name: 'KeyringController',
+        allowedEvents: [
+          'KeyringController:lock',
+          'KeyringController:unlock',
+          'KeyringController:stateChange',
+          'KeyringController:accountRemoved',
+        ],
+        allowedActions: ['KeyringController:getState'],
+      }),
+      state: initialKeyringState || initialState.KeyringController,
+      keyringBuilders: [qrKeyringBuilder],
+    });
 
     const controllers = [
       keyringController,
@@ -618,7 +631,6 @@ class Engine {
             keyringController.signPersonalMessage.bind(keyringController),
           signTypedMessage: (msgParams, { version }) =>
             keyringController.signTypedMessage(
-              // @ts-expect-error Error might be caused by base controller version mismatch
               msgParams,
               version as SignTypedDataVersion,
             ),
@@ -729,19 +741,20 @@ class Engine {
   }
 
   handleVaultBackup() {
-    const { KeyringController } = this.context;
-    KeyringController.subscribe((state: any) =>
-      backupVault(state)
-        .then((result) => {
-          if (result.success) {
-            Logger.log('Engine', 'Vault back up successful');
-          } else {
-            Logger.log('Engine', 'Vault backup failed', result.error);
-          }
-        })
-        .catch((error) => {
-          Logger.error(error, 'Engine Vault backup failed');
-        }),
+    this.controllerMessenger.subscribe(
+      AppConstants.KEYRING_STATE_CHANGE_EVENT,
+      (state: KeyringControllerState) =>
+        backupVault(state)
+          .then((result) => {
+            if (result.success) {
+              Logger.log('Engine', 'Vault back up successful');
+            } else {
+              Logger.log('Engine', 'Vault backup failed', result.error);
+            }
+          })
+          .catch((error) => {
+            Logger.error(error, 'Engine Vault backup failed');
+          }),
     );
   }