cleanup

Author: matthiasgeihs

packages/keyring-controller/src/KeyringController.test.ts

@@ -39,7 +39,6 @@ import {
 import MockEncryptor, {
   DECRYPTION_ERROR,
   MOCK_ENCRYPTION_KEY,
-  PASSWORD,
 } from '../tests/mocks/mockEncryptor';
 import { MockErc4337Keyring } from '../tests/mocks/mockErc4337Keyring';
 import { MockKeyring } from '../tests/mocks/mockKeyring';
@@ -557,20 +556,13 @@ describe('KeyringController', () => {
           await withController(
             { cacheEncryptionKey },
             async ({ controller, initialState }) => {
-              // const initialVault = controller.state.vault;
               const initialKeyrings = controller.state.keyrings;
               await controller.createNewVaultAndRestore(
                 password,
                 uint8ArraySeed,
               );
               expect(controller.state).not.toBe(initialState);
               expect(controller.state.vault).toBeDefined();
-              // TODO
-              // This test is nonsensical!? Why would a new vault be identical
-              // to the first one? (Considering that the initial seed phrase is
-              // randomly generated.) This only worked before because the
-              // encryptor returned a constant value.
-              // expect(controller.state.vault).toStrictEqual(initialVault);
               expect(controller.state.keyrings).toHaveLength(
                 initialKeyrings.length,
               );
@@ -599,7 +591,8 @@ describe('KeyringController', () => {
                 currentSeedWord,
               );
 
-              expect(encryptSpy).toHaveBeenCalledWith(expect.any(Object), [
+              const key = JSON.parse(MOCK_ENCRYPTION_KEY);
+              expect(encryptSpy).toHaveBeenCalledWith(key, [
                 {
                   data: serializedKeyring,
                   type: 'HD Key Tree',
@@ -646,10 +639,6 @@ describe('KeyringController', () => {
             await withController(
               { cacheEncryptionKey },
               async ({ controller }) => {
-                // await controller.createNewVaultAndRestore(
-                //   password,
-                //   uint8ArraySeed,
-                // );
                 expect(controller.state.encryptionKey).toBeDefined();
                 expect(controller.state.encryptionSalt).toBeDefined();
               },
@@ -2702,8 +2691,6 @@ describe('KeyringController', () => {
           await withController(
             {
               cacheEncryptionKey,
-              // skipVaultCreation: true,
-              // state: { vault: 'my vault' },
             },
             async ({ controller, encryptor }) => {
               jest.spyOn(encryptor, 'decryptWithKey').mockResolvedValueOnce([
@@ -2724,8 +2711,6 @@ describe('KeyringController', () => {
           await withController(
             {
               cacheEncryptionKey,
-              // skipVaultCreation: true,
-              // state: { vault: 'my vault' },
             },
             async ({ controller, encryptor }) => {
               jest.spyOn(encryptor, 'decryptWithKey').mockResolvedValueOnce([
@@ -2758,8 +2743,6 @@ describe('KeyringController', () => {
           await withController(
             {
               cacheEncryptionKey,
-              // state: { vault: 'my vault' },
-              // skipVaultCreation: true,
             },
             async ({ controller, encryptor }) => {
               jest.spyOn(encryptor, 'decryptWithKey').mockResolvedValueOnce([
@@ -2800,10 +2783,6 @@ describe('KeyringController', () => {
             await withController(
               {
                 cacheEncryptionKey: true,
-                // state: {
-                //   vault: 'my vault',
-                // },
-                // skipVaultCreation: true,
               },
               async ({ controller, encryptor }) => {
                 const encryptWithKeySpy = jest.spyOn(
@@ -2863,10 +2842,6 @@ describe('KeyringController', () => {
             await withController(
               {
                 cacheEncryptionKey: false,
-                state: {
-                  vault: 'my vault',
-                },
-                skipVaultCreation: true,
               },
               async ({ controller, encryptor }) => {
                 const encryptSpy = jest.spyOn(encryptor, 'encrypt');
@@ -2917,9 +2892,7 @@ describe('KeyringController', () => {
           stubKeyringClassWithAccount(HdKeyring, '0x123');
           await withController(
             {
-              // skipVaultCreation: true,
               cacheEncryptionKey,
-              // state: { vault: 'my vault' },
               keyringBuilders: [keyringBuilderFactory(MockKeyring)],
             },
             async ({ controller, encryptor, messenger }) => {
@@ -2948,9 +2921,7 @@ describe('KeyringController', () => {
         it('should unlock the wallet also if encryption parameters are outdated and the vault upgrade fails', async () => {
           await withController(
             {
-              // skipVaultCreation: true,
               cacheEncryptionKey,
-              // state: { vault: 'my vault' },
             },
             async ({ controller, encryptor }) => {
               jest.spyOn(encryptor, 'isVaultUpdated').mockReturnValue(false);
@@ -2977,9 +2948,7 @@ describe('KeyringController', () => {
           stubKeyringClassWithAccount(HdKeyring, '0x123');
           await withController(
             {
-              // skipVaultCreation: true,
               cacheEncryptionKey,
-              // state: { vault: 'my vault' },
               keyringBuilders: [keyringBuilderFactory(MockKeyring)],
             },
             async ({ controller, encryptor, messenger }) => {
@@ -3008,9 +2977,7 @@ describe('KeyringController', () => {
           it('should upgrade the vault encryption if the key encryptor has different parameters', async () => {
             await withController(
               {
-                // skipVaultCreation: true,
                 cacheEncryptionKey,
-                // state: { vault: 'my vault' },
               },
               async ({ controller, encryptor }) => {
                 jest.spyOn(encryptor, 'isVaultUpdated').mockReturnValue(false);
@@ -3035,9 +3002,7 @@ describe('KeyringController', () => {
           it('should not upgrade the vault encryption if the key encryptor has the same parameters', async () => {
             await withController(
               {
-                // skipVaultCreation: true,
                 cacheEncryptionKey,
-                // state: { vault: 'my vault' },
               },
               async ({ controller, encryptor }) => {
                 jest.spyOn(encryptor, 'isVaultUpdated').mockReturnValue(true);
@@ -3066,9 +3031,7 @@ describe('KeyringController', () => {
           it('should upgrade the vault encryption if the generic encryptor has different parameters', async () => {
             await withController(
               {
-                skipVaultCreation: true,
                 cacheEncryptionKey,
-                state: { vault: 'my vault' },
               },
               async ({ controller, encryptor }) => {
                 jest.spyOn(encryptor, 'isVaultUpdated').mockReturnValue(false);
@@ -3092,9 +3055,7 @@ describe('KeyringController', () => {
         it('should not upgrade the vault encryption if the encryptor has the same parameters and the keyring has metadata', async () => {
           await withController(
             {
-              // skipVaultCreation: true,
               cacheEncryptionKey,
-              // state: { vault: 'my vault' },
             },
             async ({ controller, encryptor }) => {
               jest.spyOn(encryptor, 'isVaultUpdated').mockReturnValue(true);
@@ -3147,9 +3108,7 @@ describe('KeyringController', () => {
         it('should throw error when using the wrong password', async () => {
           await withController(
             {
-              // skipVaultCreation: true,
               cacheEncryptionKey,
-              // state: { vault: 'my vault' },
             },
             async ({ controller }) => {
               await expect(
@@ -3180,13 +3139,6 @@ describe('KeyringController', () => {
       await withController(
         {
           cacheEncryptionKey: true,
-          // skipVaultCreation: true,
-          // state: {
-          //   vault: JSON.stringify({ data: '0x123', salt: 'my salt' }),
-          //   // @ts-expect-error we want to force the controller to have an
-          //   // encryption salt equal to the one in the vault
-          //   encryptionSalt: 'my salt',
-          // },
         },
         async ({ controller, initialState, encryptor }) => {
           jest.spyOn(encryptor, 'decryptWithKey').mockResolvedValueOnce([
@@ -3214,13 +3166,6 @@ describe('KeyringController', () => {
       await withController(
         {
           cacheEncryptionKey: true,
-          // skipVaultCreation: true,
-          // state: {
-          //   vault: JSON.stringify({ data: '0x123', salt: 'my salt' }),
-          //   // @ts-expect-error we want to force the controller to have an
-          //   // encryption salt equal to the one in the vault
-          //   encryptionSalt: 'my salt',
-          // },
         },
         async ({ controller, initialState, encryptor }) => {
           const encryptWithKeySpy = jest.spyOn(encryptor, 'encryptWithKey');