test(multichain): add tests for BalancesTracker

app/scripts/lib/accounts/BalancesTracker.test.ts

@@ -0,0 +1,128 @@
+import { BtcAccountType } from '@metamask/keyring-api';
+import { createMockInternalAccount } from '../../../../test/jest/mocks';
+import { Poller } from './Poller';
+import { BalancesTracker } from './BalancesTracker';
+
+const mockBtcAccount = createMockInternalAccount({
+  address: '',
+  name: 'Btc Account',
+  // @ts-expect-error - account type may be btc or eth, mock file is not typed
+  type: BtcAccountType.P2wpkh,
+  // @ts-expect-error - snap options is not typed and defaults to undefined
+  snapOptions: {
+    id: 'mock-btc-snap',
+    name: 'mock-btc-snap',
+    enabled: true,
+  },
+});
+
+const mockBalanceResult = {
+  'bip122:000000000933ea01ad0ee984209779ba/slip44:0': {
+    amount: '0.00000000',
+    unit: 'BTC',
+  },
+};
+
+const MOCK_TIMESTAMP = 1709983353;
+
+function setupTracker() {
+  const mockUpdateBalance = jest.fn();
+  const tracker = new BalancesTracker(mockUpdateBalance);
+
+  return {
+    tracker,
+    mockUpdateBalance,
+  };
+}
+
+describe('BalancesTracker', () => {
+  it('starts polling when calling start', async () => {
+    const { tracker } = setupTracker();
+    const spyPoller = jest.spyOn(Poller.prototype, 'start');
+
+    await tracker.start();
+    expect(spyPoller).toHaveBeenCalledTimes(1);
+  });
+
+  it('stops polling when calling stop', async () => {
+    const { tracker } = setupTracker();
+    const spyPoller = jest.spyOn(Poller.prototype, 'stop');
+
+    await tracker.start();
+    await tracker.stop();
+    expect(spyPoller).toHaveBeenCalledTimes(1);
+  });
+
+  it('is not tracking if none accounts have been registered', async () => {
+    const { tracker, mockUpdateBalance } = setupTracker();
+
+    await tracker.start();
+    await tracker.updateBalances();
+
+    expect(mockUpdateBalance).not.toHaveBeenCalled();
+  });
+
+  it('tracks account balances', async () => {
+    const { tracker, mockUpdateBalance } = setupTracker();
+
+    await tracker.start();
+    // We must track account IDs explicitly
+    tracker.track(mockBtcAccount.id, 0);
+    // Trigger balances refresh (not waiting for the Poller here)
+    await tracker.updateBalances();
+
+    expect(mockUpdateBalance).toHaveBeenCalledWith(mockBtcAccount.id);
+  });
+
+  it('untracks account balances', async () => {
+    const { tracker, mockUpdateBalance } = setupTracker();
+
+    await tracker.start();
+    tracker.track(mockBtcAccount.id, 0);
+    await tracker.updateBalances();
+    expect(mockUpdateBalance).toHaveBeenCalledWith(mockBtcAccount.id);
+
+    tracker.untrack(mockBtcAccount.id);
+    await tracker.updateBalances();
+    expect(mockUpdateBalance).toHaveBeenCalledTimes(1); // No second call after untracking
+  });
+
+  it('tracks account after being registered', async () => {
+    const { tracker } = setupTracker();
+
+    await tracker.start();
+    tracker.track(mockBtcAccount.id, 0);
+    expect(tracker.isTracked(mockBtcAccount.id)).toBe(true);
+  });
+
+  it('does not track account if not registered', async () => {
+    const { tracker } = setupTracker();
+
+    await tracker.start();
+    expect(tracker.isTracked(mockBtcAccount.id)).toBe(false);
+  });
+
+  it('does not refresh balance if they are considered up-to-date', async () => {
+    const { tracker, mockUpdateBalance } = setupTracker();
+
+    const blockTime = 10 * 60 * 1000; // 10 minutes in milliseconds.
+    jest
+      .spyOn(global.Date, 'now')
+      .mockImplementation(() => new Date(MOCK_TIMESTAMP).getTime());
+
+    await tracker.start();
+    tracker.track(mockBtcAccount.id, blockTime);
+    await tracker.updateBalances();
+    expect(mockUpdateBalance).toHaveBeenCalledTimes(1);
+
+    await tracker.updateBalances();
+    expect(mockUpdateBalance).toHaveBeenCalledTimes(1); // No second call since the balances is already still up-to-date
+
+    jest
+      .spyOn(global.Date, 'now')
+      .mockImplementation(() => new Date(MOCK_TIMESTAMP + blockTime).getTime());
+
+    await tracker.updateBalances();
+    expect(mockUpdateBalance).toHaveBeenCalledTimes(2); // Now the balance will update
+  });
+});