feat: CP-9309 account and wallet renaming (#71)

src/background/connections/dAppConnection/models.ts

@@ -39,6 +39,7 @@ export enum DAppProviderRequest {
   AVALANCHE_SIGN_TRANSACTION = 'avalanche_signTransaction',
   AVALANCHE_SIGN_MESSAGE = 'avalanche_signMessage',
   BITCOIN_SEND_TRANSACTION = 'bitcoin_sendTransaction',
+  WALLET_RENAME = 'avalanche_renameWallet',
 }
 
 export enum Web3Event {

src/background/connections/dAppConnection/registry.ts

@@ -30,6 +30,7 @@ import { AvalancheGetAddressesInRangeHandler } from '@src/background/services/ac
 import { AvalancheSignTransactionHandler } from '@src/background/services/wallet/handlers/avalanche_signTransaction';
 import { AvalancheSignMessageHandler } from '@src/background/services/messages/handlers/avalanche_signMessage';
 import { AvalancheRenameAccountHandler } from '@src/background/services/accounts/handlers/avalanche_renameAccount';
+import { AvalancheRenameWalletHandler } from '@src/background/services/secrets/handlers/avalanche_renameWallet';
 
 /**
  * TODO: GENERATE THIS FILE AS PART OF THE BUILD PROCESS
@@ -70,6 +71,7 @@ import { AvalancheRenameAccountHandler } from '@src/background/services/accounts
   { token: 'DAppRequestHandler', useToken: WalletWatchAssetHandler },
   { token: 'DAppRequestHandler', useToken: ConnectRequestHandler },
   { token: 'DAppRequestHandler', useToken: AvalancheGetProviderState },
+  { token: 'DAppRequestHandler', useToken: AvalancheRenameWalletHandler },
   {
     token: 'DAppRequestHandler',
     useToken: AvalancheSendDomainMetadataHandler,

src/background/connections/extensionConnection/registry.ts

@@ -85,7 +85,7 @@ import { KeystoneRequestEvents } from '@src/background/services/keystone/events/
 import { SubmitKeystoneSignature } from '@src/background/services/keystone/handlers/keystoneSubmitSignature';
 import { StoreBtcWalletPolicyDetails } from '@src/background/services/wallet/handlers/storeBtcWalletPolicyDetails';
 import { GetBtcWalletPolicyDetails } from '@src/background/services/wallet/handlers/getBtcWalletPolicyDetails';
-import { WalletUpdatedEvents } from '@src/background/services/wallet/events/WalletUpdatedEvent';
+import { WalletUpdatedEvents } from '@src/background/services/secrets/events/WalletUpdatedEvent';
 import { GetDefiPortfolioHandler } from '@src/background/services/defi/handlers/getDefiPortfolio';
 import { CurrencyRatesUpdatedEvents } from '@src/background/services/currency/events/currencyRatesUpdatedEvent';
 import { GetCurrencyExchangeRatesHandler } from '@src/background/services/currency/handlers/getCurrencyExchangeRates';

src/background/connections/middlewares/PermissionMiddleware.ts

@@ -110,6 +110,7 @@ const CORE_METHODS = Object.freeze([
   DAppProviderRequest.AVALANCHE_GET_ACCOUNT_PUB_KEY,
   DAppProviderRequest.BITCOIN_SEND_TRANSACTION,
   DAppProviderRequest.WALLET_GET_CHAIN,
+  DAppProviderRequest.WALLET_RENAME,
 ]);
 
 export function PermissionMiddleware(

src/background/services/accounts/handlers/avalanche_getAccounts.test.ts

@@ -3,6 +3,7 @@ import { AccountType } from '../models';
 import { AvalancheGetAccountsHandler } from './avalanche_getAccounts';
 import { SecretType } from '../../secrets/models';
 import { buildRpcCall } from '@src/tests/test-utils';
+import { SecretsService } from '../../secrets/SecretsService';
 
 const walletName = 'Wallet-Name-001';
 describe('background/services/accounts/handlers/avalanche_getAccounts.ts', () => {
@@ -36,28 +37,26 @@ describe('background/services/accounts/handlers/avalanche_getAccounts.ts', () =>
     activeAccount: accounts[0],
   } as any;
 
-  const walletServiceMock = {
-    wallets: [
-      {
-        type: SecretType.Mnemonic,
-        name: walletName,
-      },
-    ],
-  } as any;
-
+  const secretsService = new SecretsService({} as any);
   const request = {
     id: '123',
     method: DAppProviderRequest.AVALANCHE_GET_ACCOUNTS,
   } as const;
 
   beforeEach(() => {
     jest.resetAllMocks();
+    secretsService.getPrimaryWalletsDetails = jest.fn().mockResolvedValue([
+      {
+        type: SecretType.Mnemonic,
+        name: walletName,
+      },
+    ]);
   });
 
   it('handleAuthenticated', async () => {
     const handler = new AvalancheGetAccountsHandler(
       accountServiceMock,
-      walletServiceMock
+      secretsService
     );
     const result = await handler.handleAuthenticated(buildRpcCall(request));
 
@@ -101,7 +100,7 @@ describe('background/services/accounts/handlers/avalanche_getAccounts.ts', () =>
   it('handleUnauthenticated', async () => {
     const handler = new AvalancheGetAccountsHandler(
       accountServiceMock,
-      walletServiceMock
+      secretsService
     );
     const result = await handler.handleUnauthenticated(buildRpcCall(request));
 

src/background/services/accounts/handlers/avalanche_getAccounts.ts

@@ -3,26 +3,27 @@ import { DAppProviderRequest } from '@src/background/connections/dAppConnection/
 import { injectable } from 'tsyringe';
 import { AccountsService } from '../AccountsService';
 import { Account, AccountType } from '../models';
-import { WalletService } from '../../wallet/WalletService';
+import { SecretsService } from '../../secrets/SecretsService';
 
 @injectable()
 export class AvalancheGetAccountsHandler extends DAppRequestHandler {
   methods = [DAppProviderRequest.AVALANCHE_GET_ACCOUNTS];
 
   constructor(
     private accountsService: AccountsService,
-    private walletService: WalletService
+    private secretsService: SecretsService
   ) {
     super();
   }
 
   handleAuthenticated = async ({ request }) => {
     const accounts = this.accountsService.getAccountList();
     const activeAccount = this.accountsService.activeAccount;
+    const wallets = await this.secretsService.getPrimaryWalletsDetails();
 
     const getWalletData = (acc: Account) => {
       if (acc.type === AccountType.PRIMARY) {
-        const walletData = this.walletService.wallets.find((wallet) => {
+        const walletData = wallets.find((wallet) => {
           return wallet.id === acc.walletId;
         });
         return {

src/background/services/messages/handlers/signMessage.test.ts

@@ -34,6 +34,7 @@ describe('src/background/services/messages/handlers/signMessage.ts', () => {
   let networkServiceMock;
 
   let blockaidServiceMock;
+  let secretsServiceMock;
 
   beforeEach(() => {
     jest.resetAllMocks();
@@ -55,6 +56,14 @@ describe('src/background/services/messages/handlers/signMessage.ts', () => {
       getNetwork: () => activeNetworkMock,
     } as any;
 
+    secretsServiceMock = {
+      getPrimaryWalletsDetails: jest.fn().mockResolvedValue([
+        {
+          type: SecretType.Mnemonic,
+        },
+      ]),
+    };
+
     jest.mocked(openApprovalWindow).mockResolvedValue({} as any);
     (paramsToMessageParams as jest.Mock).mockReturnValue(displayDataMock);
   });
@@ -63,7 +72,8 @@ describe('src/background/services/messages/handlers/signMessage.ts', () => {
     const handler = new PersonalSignHandler(
       walletServiceMock,
       networkServiceMock,
-      blockaidServiceMock
+      blockaidServiceMock,
+      secretsServiceMock
     );
 
     const request = {
@@ -85,7 +95,8 @@ describe('src/background/services/messages/handlers/signMessage.ts', () => {
     const handler = new PersonalSignHandler(
       walletServiceMock,
       networkServiceMock,
-      blockaidServiceMock
+      blockaidServiceMock,
+      secretsServiceMock
     );
 
     expect(handler.methods).toStrictEqual([
@@ -100,11 +111,12 @@ describe('src/background/services/messages/handlers/signMessage.ts', () => {
 
   describe('handleAuthenticated', () => {
     it('throws if walletType is undefined', async () => {
-      walletServiceMock.wallets = [];
+      secretsServiceMock.getPrimaryWalletsDetails.mockResolvedValueOnce([]);
       const handler = new PersonalSignHandler(
         walletServiceMock,
         networkServiceMock,
-        blockaidServiceMock
+        blockaidServiceMock,
+        secretsServiceMock
       );
 
       const request = {
@@ -128,7 +140,8 @@ describe('src/background/services/messages/handlers/signMessage.ts', () => {
       const handler = new PersonalSignHandler(
         walletServiceMock,
         networkServiceMock,
-        blockaidServiceMock
+        blockaidServiceMock,
+        secretsServiceMock
       );
 
       const request = {
@@ -154,7 +167,8 @@ describe('src/background/services/messages/handlers/signMessage.ts', () => {
       const handler = new PersonalSignHandler(
         walletServiceMock,
         networkServiceMock,
-        blockaidServiceMock
+        blockaidServiceMock,
+        secretsServiceMock
       );
 
       const request = {
@@ -190,7 +204,8 @@ describe('src/background/services/messages/handlers/signMessage.ts', () => {
       const handler = new PersonalSignHandler(
         walletServiceMock,
         networkServiceMock,
-        blockaidServiceMock
+        blockaidServiceMock,
+        secretsServiceMock
       );
 
       const methodsWithoutTypeCheck = [
@@ -245,7 +260,8 @@ describe('src/background/services/messages/handlers/signMessage.ts', () => {
       const handler = new PersonalSignHandler(
         walletServiceMock,
         networkServiceMock,
-        blockaidServiceMock
+        blockaidServiceMock,
+        secretsServiceMock
       );
 
       const messageParamsMock: MessageParams = {
@@ -325,7 +341,8 @@ describe('src/background/services/messages/handlers/signMessage.ts', () => {
       const handler = new PersonalSignHandler(
         walletServiceMock,
         networkServiceMock,
-        blockaidServiceMock
+        blockaidServiceMock,
+        secretsServiceMock
       );
 
       const request = {
@@ -379,7 +396,8 @@ describe('src/background/services/messages/handlers/signMessage.ts', () => {
       const handler = new PersonalSignHandler(
         walletServiceMock,
         networkServiceMock,
-        blockaidServiceMock
+        blockaidServiceMock,
+        secretsServiceMock
       );
 
       (walletServiceMock.signMessage as jest.Mock).mockResolvedValueOnce(
@@ -406,7 +424,8 @@ describe('src/background/services/messages/handlers/signMessage.ts', () => {
       const handler = new PersonalSignHandler(
         walletServiceMock,
         networkServiceMock,
-        blockaidServiceMock
+        blockaidServiceMock,
+        secretsServiceMock
       );
 
       (walletServiceMock.signMessage as jest.Mock).mockRejectedValueOnce(error);

src/background/services/messages/handlers/signMessage.ts

@@ -13,6 +13,7 @@ import { TypedDataEncoder } from 'ethers';
 import { openApprovalWindow } from '@src/background/runtime/openApprovalWindow';
 import { BlockaidService } from '../../blockaid/BlockaidService';
 import { getValidationResultType } from '../../blockaid/utils';
+import { SecretsService } from '../../secrets/SecretsService';
 
 @injectable()
 export class PersonalSignHandler extends DAppRequestHandler {
@@ -28,7 +29,8 @@ export class PersonalSignHandler extends DAppRequestHandler {
   constructor(
     private walletService: WalletService,
     private networkService: NetworkService,
-    private blockaidService: BlockaidService
+    private blockaidService: BlockaidService,
+    private secretsService: SecretsService
   ) {
     super();
   }
@@ -41,7 +43,8 @@ export class PersonalSignHandler extends DAppRequestHandler {
   };
 
   handleAuthenticated = async ({ request, scope }) => {
-    if (this.walletService.wallets.length === 0) {
+    const wallets = await this.secretsService.getPrimaryWalletsDetails();
+    if (wallets.length === 0) {
       return {
         ...request,
         error: 'wallet undefined',

src/background/services/secrets/SecretsService.test.ts

@@ -17,7 +17,7 @@ import {
 } from '../accounts/models';
 import { NetworkService } from '../network/NetworkService';
 import { StorageService } from '../storage/StorageService';
-import { PubKeyType, WALLET_STORAGE_KEY } from '../wallet/models';
+import { PubKeyType, WALLET_STORAGE_KEY, WalletEvents } from '../wallet/models';
 import { SecretType } from './models';
 import { SecretsService } from './SecretsService';
 import { WalletConnectService } from '../walletConnect/WalletConnectService';
@@ -253,6 +253,35 @@ describe('src/background/services/secrets/SecretsService.ts', () => {
     return data;
   };
 
+  describe('onUnlock', () => {
+    it('should emit the `WALLET_STATE_UPDATE` event with an empty array', async () => {
+      const eventListener = jest.fn();
+      secretsService.addListener(
+        WalletEvents.WALLET_STATE_UPDATE,
+        eventListener
+      );
+      await secretsService.onUnlock();
+      expect(eventListener).toHaveBeenCalledWith([]);
+    });
+    it('should emit the `WALLET_STATE_UPDATE` event with the correct data', async () => {
+      mockMnemonicWallet();
+      const eventListener = jest.fn();
+      secretsService.addListener(
+        WalletEvents.WALLET_STATE_UPDATE,
+        eventListener
+      );
+      await secretsService.onUnlock();
+      expect(eventListener).toHaveBeenCalledWith([
+        {
+          derivationPath: DerivationPath.BIP44,
+          id: ACTIVE_WALLET_ID,
+          name: undefined,
+          type: SecretType.Mnemonic,
+        },
+      ]);
+    });
+  });
+
   describe('getPrimaryAccountSecrets', () => {
     it('returns null if no secrets are saved', async () => {
       storageService.load.mockResolvedValue(null);
@@ -293,7 +322,13 @@ describe('src/background/services/secrets/SecretsService.ts', () => {
   });
 
   describe('addSecrets()', () => {
-    it('should save a new wallet to the `wallets` array', async () => {
+    it('should save a new wallet to the `wallets` array and emits the `WALLET_STATE_UPDATE` event', async () => {
+      const eventListener = jest.fn();
+      secretsService.addListener(
+        WalletEvents.WALLET_STATE_UPDATE,
+        eventListener
+      );
+
       const uuid = 'uuid';
       (crypto.randomUUID as jest.Mock).mockReturnValueOnce(uuid);
       const existingWallets = [
@@ -329,6 +364,7 @@ describe('src/background/services/secrets/SecretsService.ts', () => {
           },
         ],
       });
+      expect(eventListener).toHaveBeenCalled();
     });
 
     it('should save a new wallet to the `wallets` array with default name when name is missing', async () => {
@@ -405,7 +441,12 @@ describe('src/background/services/secrets/SecretsService.ts', () => {
   });
 
   describe('updateSecrets', () => {
-    it('does not implicitly remove existing secrets in storage', async () => {
+    it('does not implicitly remove existing secrets in storage and emit `WALLET_STATE_UPDATE` event', async () => {
+      const eventListener = jest.fn();
+      secretsService.addListener(
+        WalletEvents.WALLET_STATE_UPDATE,
+        eventListener
+      );
       const existingSecrets = {
         xpub: 'xpub',
         wallets: [
@@ -425,6 +466,8 @@ describe('src/background/services/secrets/SecretsService.ts', () => {
         ...existingSecrets,
         wallets: [{ ...existingSecrets.wallets[0], xpubXP: 'xpubXP' }],
       });
+
+      expect(eventListener).toHaveBeenCalled();
     });
   });