Merge branch 'develop' into developer-settings

MetaMask · Jul 19, 2024 · 5cac014 · 5cac014
2 parents 5fcc2a2 + 9ad686b
commit 5cac014
Show file tree

Hide file tree

Showing 17 changed files with 802 additions and 81 deletions.
diff --git a/app/scripts/lib/accounts/BalancesController.test.ts b/app/scripts/lib/accounts/BalancesController.test.ts
@@ -14,7 +14,7 @@ import {
   defaultState,
   BalancesControllerMessenger,
 } from './BalancesController';
-import { Poller } from './Poller';
+import { BalancesTracker } from './BalancesTracker';
 
 const mockBtcAccount = createMockInternalAccount({
   address: '',
@@ -54,8 +54,14 @@ const setupController = ({
   const balancesControllerMessenger: BalancesControllerMessenger =
     controllerMessenger.getRestricted({
       name: 'BalancesController',
-      allowedActions: ['SnapController:handleRequest'],
-      allowedEvents: ['AccountsController:stateChange'],
+      allowedActions: [
+        'SnapController:handleRequest',
+        'AccountsController:listMultichainAccounts',
+      ],
+      allowedEvents: [
+        'AccountsController:accountAdded',
+        'AccountsController:accountRemoved',
+      ],
     });
 
   const mockSnapHandleRequest = jest.fn();
@@ -66,20 +72,22 @@ const setupController = ({
     ),
   );
 
-  // TODO: remove when listMultichainAccounts action is available
-  const mockListMultichainAccounts = jest
-    .fn()
-    .mockReturnValue(mocks?.listMultichainAccounts ?? [mockBtcAccount]);
+  const mockListMultichainAccounts = jest.fn();
+  controllerMessenger.registerActionHandler(
+    'AccountsController:listMultichainAccounts',
+    mockListMultichainAccounts.mockReturnValue(
+      mocks?.listMultichainAccounts ?? [mockBtcAccount],
+    ),
+  );
 
   const controller = new BalancesController({
     messenger: balancesControllerMessenger,
     state,
-    // TODO: remove when listMultichainAccounts action is available
-    listMultichainAccounts: mockListMultichainAccounts,
   });
 
   return {
     controller,
+    messenger: controllerMessenger,
     mockSnapHandleRequest,
     mockListMultichainAccounts,
   };
@@ -91,19 +99,19 @@ describe('BalancesController', () => {
     expect(controller.state).toEqual({ balances: {} });
   });
 
-  it('starts polling when calling start', async () => {
-    const spyPoller = jest.spyOn(Poller.prototype, 'start');
+  it('starts tracking when calling start', async () => {
+    const spyTracker = jest.spyOn(BalancesTracker.prototype, 'start');
     const { controller } = setupController();
     await controller.start();
-    expect(spyPoller).toHaveBeenCalledTimes(1);
+    expect(spyTracker).toHaveBeenCalledTimes(1);
   });
 
-  it('stops polling when calling stop', async () => {
-    const spyPoller = jest.spyOn(Poller.prototype, 'stop');
+  it('stops tracking when calling stop', async () => {
+    const spyTracker = jest.spyOn(BalancesTracker.prototype, 'stop');
     const { controller } = setupController();
     await controller.start();
     await controller.stop();
-    expect(spyPoller).toHaveBeenCalledTimes(1);
+    expect(spyTracker).toHaveBeenCalledTimes(1);
   });
 
   it('update balances when calling updateBalances', async () => {
@@ -113,13 +121,49 @@ describe('BalancesController', () => {
 
     expect(controller.state).toEqual({
       balances: {
-        [mockBtcAccount.id]: {
-          'bip122:000000000933ea01ad0ee984209779ba/slip44:0': {
-            amount: '0.00000000',
-            unit: 'BTC',
-          },
+        [mockBtcAccount.id]: mockBalanceResult,
+      },
+    });
+  });
+
+  it('update balances when "AccountsController:accountAdded" is fired', async () => {
+    const { controller, messenger, mockListMultichainAccounts } =
+      setupController({
+        mocks: {
+          listMultichainAccounts: [],
         },
+      });
+
+    controller.start();
+    mockListMultichainAccounts.mockReturnValue([mockBtcAccount]);
+    messenger.publish('AccountsController:accountAdded', mockBtcAccount);
+    await controller.updateBalances();
+
+    expect(controller.state).toEqual({
+      balances: {
+        [mockBtcAccount.id]: mockBalanceResult,
       },
     });
   });
+
+  it('update balances when "AccountsController:accountRemoved" is fired', async () => {
+    const { controller, messenger, mockListMultichainAccounts } =
+      setupController();
+
+    controller.start();
+    await controller.updateBalances();
+    expect(controller.state).toEqual({
+      balances: {
+        [mockBtcAccount.id]: mockBalanceResult,
+      },
+    });
+
+    messenger.publish('AccountsController:accountRemoved', mockBtcAccount.id);
+    mockListMultichainAccounts.mockReturnValue([]);
+    await controller.updateBalances();
+
+    expect(controller.state).toEqual({
+      balances: {},
+    });
+  });
 });