Merge pull request #474 from lightninglabs/fix-pending-deposit

Fix pending deposit

Author: tanx

src/action/wallet.js

@@ -158,8 +158,9 @@ class WalletAction {
 
   async getChannelBalance() {
     try {
-      const response = await this._grpc.sendCommand('ChannelBalance');
-      this._store.channelBalanceSatoshis = parseSat(response.balance);
+      const r = await this._grpc.sendCommand('ChannelBalance');
+      this._store.channelBalanceSatoshis = parseSat(r.balance);
+      this._store.pendingBalanceSatoshis = parseSat(r.pending_open_balance);
     } catch (err) {
       log.error('Getting channel balance failed', err);
     }

src/computed/wallet.js

@@ -7,9 +7,10 @@ const ComputedWallet = store => {
     walletAddressUri: computed(
       () => (store.walletAddress ? `bitcoin:${store.walletAddress}` : '')
     ),
-    balanceLabel: computed(() =>
-      toAmountLabel(store.balanceSatoshis, store.settings)
-    ),
+    depositLabel: computed(() => {
+      const { balanceSatoshis, pendingBalanceSatoshis, settings } = store;
+      return toAmountLabel(balanceSatoshis + pendingBalanceSatoshis, settings);
+    }),
     channelBalanceLabel: computed(() =>
       toAmountLabel(store.channelBalanceSatoshis, store.settings)
     ),

src/store.js

@@ -24,6 +24,7 @@ export class Store {
       balanceSatoshis: 0,
       confirmedBalanceSatoshis: 0,
       unconfirmedBalanceSatoshis: 0,
+      pendingBalanceSatoshis: 0,
       channelBalanceSatoshis: 0,
       pubKey: null,
       walletAddress: null,

src/view/home.js

@@ -45,7 +45,7 @@ const HomeView = ({
   transaction,
   nav,
 }) => {
-  const { balanceLabel, channelBalanceLabel, unitLabel } = store;
+  const { depositLabel, channelBalanceLabel, unitLabel } = store;
   return (
     <Background image="purple-gradient-bg">
       <HomeHeader
@@ -56,7 +56,7 @@ const HomeView = ({
       <QrCodeSeparator goDeposit={() => nav.goDeposit()} />
       <MainContent style={styles.content}>
         <BalanceDisplay
-          balanceLabel={balanceLabel}
+          depositLabel={depositLabel}
           channelBalanceLabel={channelBalanceLabel}
           unitLabel={unitLabel}
           toggleDisplayFiat={() => wallet.toggleDisplayFiat()}
@@ -99,7 +99,7 @@ const balanceStyles = StyleSheet.create({
 });
 
 const BalanceDisplay = ({
-  balanceLabel,
+  depositLabel,
   channelBalanceLabel,
   unitLabel,
   toggleDisplayFiat,
@@ -111,13 +111,13 @@ const BalanceDisplay = ({
         <BalanceLabelUnit>{unitLabel}</BalanceLabelUnit>
       </BalanceLabel>
       <H4Text style={balanceStyles.smallLabel}>Pending Deposit</H4Text>
-      <SmallBalanceLabel unit={unitLabel}>{balanceLabel}</SmallBalanceLabel>
+      <SmallBalanceLabel unit={unitLabel}>{depositLabel}</SmallBalanceLabel>
     </Button>
   </View>
 );
 
 BalanceDisplay.propTypes = {
-  balanceLabel: PropTypes.string.isRequired,
+  depositLabel: PropTypes.string.isRequired,
   channelBalanceLabel: PropTypes.string.isRequired,
   unitLabel: PropTypes.string,
   toggleDisplayFiat: PropTypes.func.isRequired,

stories/screen.js

@@ -158,6 +158,7 @@ storiesOf('Screens', module)
 // set some dummy data
 store.walletAddress = 'ra2XT898gWTp9q2DwMgtwMJsUEh3oMeS4K';
 store.balanceSatoshis = 798765432;
+store.pendingBalanceSatoshis = 100000000;
 store.channelBalanceSatoshis = 59876000;
 store.settings.exchangeRate.usd = 0.00016341;
 store.settings.exchangeRate.eur = 0.0001896;

test/integration/action/action-integration.spec.js

@@ -273,6 +273,8 @@ describe('Action Integration Tests', function() {
       expect(store2.balanceSatoshis, 'to be positive');
       expect(store1.channelBalanceSatoshis, 'to be', 0);
       expect(store2.channelBalanceSatoshis, 'to be', 0);
+      expect(store1.pendingBalanceSatoshis, 'to be', 0);
+      expect(store2.pendingBalanceSatoshis, 'to be', 0);
     });
   });
 
@@ -305,6 +307,14 @@ describe('Action Integration Tests', function() {
       expect(store1.computedChannels[0].status, 'to be', 'pending-open');
     });
 
+    it('should have enough satoshis in pending balance', async () => {
+      await updateBalances();
+      expect(store1.pendingBalanceSatoshis, 'to be positive');
+      expect(store2.pendingBalanceSatoshis, 'to be', 0);
+      expect(store1.channelBalanceSatoshis, 'to be', 0);
+      expect(store2.channelBalanceSatoshis, 'to be', 0);
+    });
+
     it('should list open channel after mining 6 blocks', async () => {
       await mineAndSync({ blocks: 6 });
       while (store1.pendingChannels.length) await nap(100);
@@ -315,6 +325,8 @@ describe('Action Integration Tests', function() {
 
     it('should have enough satoshis in channel balance', async () => {
       await updateBalances();
+      expect(store1.pendingBalanceSatoshis, 'to be', 0);
+      expect(store2.pendingBalanceSatoshis, 'to be', 0);
       expect(store1.channelBalanceSatoshis, 'to be positive');
       expect(store2.channelBalanceSatoshis, 'to be', 0);
     });

test/unit/action/wallet.spec.js

@@ -292,9 +292,13 @@ describe('Action Wallet Unit Tests', () => {
 
   describe('getChannelBalance()', () => {
     it('should get channel balance', async () => {
-      grpc.sendCommand.withArgs('ChannelBalance').resolves({ balance: '1' });
+      grpc.sendCommand.withArgs('ChannelBalance').resolves({
+        balance: '1',
+        pending_open_balance: '2',
+      });
       await wallet.getChannelBalance();
       expect(store.channelBalanceSatoshis, 'to equal', 1);
+      expect(store.pendingBalanceSatoshis, 'to equal', 2);
     });
 
     it('should log error on failure', async () => {

test/unit/computed/wallet.spec.js

@@ -12,7 +12,7 @@ describe('Computed Wallet Unit Tests', () => {
     it('should work with initial store', () => {
       ComputedWallet(store);
       expect(store.walletAddressUri, 'to equal', '');
-      expect(store.balanceLabel, 'to equal', '0');
+      expect(store.depositLabel, 'to equal', '0');
       expect(store.channelBalanceLabel, 'to equal', '0');
       expect(store.unitFiatLabel, 'to equal', 'BTC');
       expect(store.unitLabel, 'to equal', 'BTC');
@@ -32,23 +32,25 @@ describe('Computed Wallet Unit Tests', () => {
     it('should display channel balance in usd', () => {
       store.settings.displayFiat = true;
       store.settings.exchangeRate.usd = 0.00014503;
-      store.balanceSatoshis = 100000000;
+      store.balanceSatoshis = 50000000;
+      store.pendingBalanceSatoshis = 50000000;
       store.channelBalanceSatoshis = 10000;
       ComputedWallet(store);
-      expect(store.balanceLabel, 'to match', /6[,.]895[,.]13/);
+      expect(store.depositLabel, 'to match', /6[,.]895[,.]13/);
       expect(store.channelBalanceLabel, 'to match', /0[,.]69/);
       expect(store.unitFiatLabel, 'to equal', '$');
       expect(store.unitLabel, 'to equal', null);
     });
 
     it('should display channel balance in sat', () => {
       store.settings.exchangeRate.usd = 0.00014503;
-      store.balanceSatoshis = 100000001;
+      store.balanceSatoshis = 50000001;
+      store.pendingBalanceSatoshis = 50000000;
       store.channelBalanceSatoshis = 10000;
       store.settings.unit = 'bit';
       ComputedWallet(store);
       expect(
-        store.balanceLabel,
+        store.depositLabel,
         'to match',
         /^1{1}[,.]0{3}[,.]0{3}[,.]0{1}1{1}$/
       );