Include limbo balance in Home screen balance.

Author: valentinewallace

src/action/wallet.js

@@ -144,7 +144,11 @@ class WalletAction {
    * @return {Promise<undefined>}
    */
   async update() {
-    await Promise.all([this.getBalance(), this.getChannelBalance()]);
+    await Promise.all([
+      this.getBalance(),
+      this.getChannelBalance(),
+      this.getLimboBalance(),
+    ]);
   }
 
   /**
@@ -449,6 +453,20 @@ class WalletAction {
     }
   }
 
+  /**
+   * Fetch the limbo balance using the lnd grpc api and set the
+   * corresponding value on the global store.
+   * @return {Promise<undefined>}
+   */
+  async getLimboBalance() {
+    try {
+      const r = await this._grpc.sendCommand('PendingChannels');
+      this._store.limboBalanceSatoshis = r.totalLimboBalance;
+    } catch (err) {
+      log.error('Getting limbo balance failed', err);
+    }
+  }
+
   /**
    * Ensure that the wallet address is non-null before navigating to the
    * NewAddress view during onboarding.

src/computed/wallet.js

@@ -21,8 +21,14 @@ const ComputedWallet = store => {
         balanceSatoshis,
         pendingBalanceSatoshis,
         channelBalanceSatoshis,
+        limboBalanceSatoshis,
       } = store;
-      return balanceSatoshis + pendingBalanceSatoshis + channelBalanceSatoshis;
+      return (
+        balanceSatoshis +
+        pendingBalanceSatoshis +
+        channelBalanceSatoshis +
+        limboBalanceSatoshis
+      );
     },
     get totalBalanceLabel() {
       return toAmountLabel(store.totalBalanceSatoshis, store.settings);

src/store.js

@@ -34,6 +34,7 @@ export class Store {
       unconfirmedBalanceSatoshis: 0,
       pendingBalanceSatoshis: 0,
       channelBalanceSatoshis: 0,
+      limboBalanceSatoshis: 0,
       pubKey: null,
       walletAddress: null,
       displayCopied: false,

test/unit/action/wallet.spec.js

@@ -138,7 +138,7 @@ describe('Action Wallet Unit Tests', () => {
     it('should refresh wallet balances', async () => {
       sandbox.stub(wallet, 'pollExchangeRate');
       await wallet.update();
-      expect(grpc.sendCommand, 'was called twice');
+      expect(grpc.sendCommand, 'was called thrice');
       expect(wallet.pollExchangeRate, 'was not called');
     });
   });
@@ -571,6 +571,22 @@ describe('Action Wallet Unit Tests', () => {
     });
   });
 
+  describe('getLimboBalance()', () => {
+    it('should get limbo balance', async () => {
+      grpc.sendCommand.withArgs('PendingChannels').resolves({
+        totalLimboBalance: 1,
+      });
+      await wallet.getLimboBalance();
+      expect(store.limboBalanceSatoshis, 'to equal', 1);
+    });
+
+    it('should log error on failure', async () => {
+      grpc.sendCommand.rejects();
+      await wallet.getLimboBalance();
+      expect(logger.error, 'was called once');
+    });
+  });
+
   describe('getNewAddress()', () => {
     it('should get new address', async () => {
       grpc.sendCommand.withArgs('NewAddress').resolves({

test/unit/computed/wallet.spec.js

@@ -37,9 +37,10 @@ describe('Computed Wallet Unit Tests', () => {
       store.balanceSatoshis = 50000000;
       store.pendingBalanceSatoshis = 50000000;
       store.channelBalanceSatoshis = 10000;
+      store.limboBalanceSatoshis = 100;
       ComputedWallet(store);
-      expect(store.totalBalanceSatoshis, 'to equal', 100010000);
-      expect(store.totalBalanceLabel, 'to match', /6[,.]895[,.]81/);
+      expect(store.totalBalanceSatoshis, 'to equal', 100010100);
+      expect(store.totalBalanceLabel, 'to match', /6[,.]895[,.]82/);
       expect(store.unitFiatLabel, 'to equal', '$');
       expect(store.unitLabel, 'to equal', null);
       expect(store.channelPercentageLabel, 'to equal', '50% on Lightning');
@@ -51,10 +52,11 @@ describe('Computed Wallet Unit Tests', () => {
       store.balanceSatoshis = 50000001;
       store.pendingBalanceSatoshis = 50000000;
       store.channelBalanceSatoshis = 10000;
+      store.limboBalanceSatoshis = 100;
       store.settings.unit = 'bit';
       ComputedWallet(store);
-      expect(store.totalBalanceSatoshis, 'to equal', 100010001);
-      expect(store.totalBalanceLabel, 'to match', /1[,.]000[,.]100[,.]01/);
+      expect(store.totalBalanceSatoshis, 'to equal', 100010101);
+      expect(store.totalBalanceLabel, 'to match', /1[,.]000[,.]101[,.]01/);
       expect(store.unitFiatLabel, 'to equal', 'bits');
       expect(store.unitLabel, 'to equal', 'bits');
     });