balanceofsatoshis 11.22.4 → 11.23.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 11.23.0
+
+- `balance`:  `--detailed`: Support unconfirmed/invalid/conflicting balances
+
 ## 11.22.4
 
 - `telegram`: Fix issue when moving a created invoice to a saved node

package/balances/conflicting_balances.js

@@ -0,0 +1,93 @@
+const {Transaction} = require('bitcoinjs-lib');
+
+const inputAsOutpoint = (txId, outputIndex) => `${txId}:${outputIndex}`;
+const {fromHex} = Transaction;
+const sumOf = arr => arr.reduce((sum, n) => sum + n, Number());
+const txIdFromHash = hash => hash.slice().reverse().toString('hex');
+const uniq = arr => Array.from(new Set(arr));
+
+/** Derive conflicted on-chain pending balances where funds are double spent or
+  multiple versions of the spend exist
+
+  {
+    transactions: [{
+      is_confirmed: <Transaction is Confirmed Bool>
+      transaction: <Raw Transaction Hex String>
+    }]
+    utxos: [{
+      confirmation_count: <UTXO Confirmation Count Number>
+      tokens: <UTXO Tokens Number>
+      transaction_id: <Outpoint Transaction Id Hex String>
+    }]
+  }
+
+  @returns
+  {
+    conflicting_pending_balance: <Conflicting Pending Balance Tokens Number>
+    invalid_pending_balance: <Invalid Pending Balance Tokens Number>
+  }
+*/
+module.exports = ({transactions, utxos}) => {
+  const conflictingUtxos = [];
+  const invalidUtxos = [];
+  const spends = {}
+
+  // Look at unconfirmed UTXOs and collect spends of outpoints
+  utxos.filter(n => !n.confirmation_count).forEach((utxo, i) => {
+    const tx = transactions.find(n => n.id === utxo.transaction_id);
+
+    // Exit early when the raw transaction is not known
+    if (!tx || !tx.transaction) {
+      return;
+    }
+
+    // Register all the inputs into the spends map
+    return fromHex(tx.transaction).ins.forEach(input => {
+      const outpoint = inputAsOutpoint(txIdFromHash(input.hash), input.index);
+
+      const existing = spends[outpoint];
+
+      // When existing UTXO spends the same input this is a conflict
+      if (!!existing) {
+        conflictingUtxos.push(i);
+      }
+
+      // Collect spends of the outpoint
+      const spending = !existing ? [i] : [].concat(existing).concat(i);
+
+      return spends[outpoint] = spending;
+    });
+  });
+
+  // Look at confirmed txs and see if any unspents spend a confirmed outpoint
+  transactions.forEach(tx => {
+    // Exit early when there is no confirmed tx
+    if (!tx.transaction || !tx.is_confirmed) {
+      return;
+    }
+
+    // Look for pending inputs that are conflicted with a confirmed tx
+    return fromHex(tx.transaction).ins.forEach(input => {
+      const outpoint = inputAsOutpoint(txIdFromHash(input.hash), input.index);
+
+      // Exit early when nothing pending spends this outpoint
+      if (!spends[outpoint]) {
+        return;
+      }
+
+      // Pending things that spend a confirmed input are invalid
+      return spends[outpoint].forEach(n => invalidUtxos.push(n));
+    });
+  });
+
+  const conflictingTokens = uniq(conflictingUtxos)
+    .filter(utxoIndex => !invalidUtxos.includes(utxoIndex))
+    .map(n => utxos[n].tokens);
+
+  const invalidTokens = uniq(invalidUtxos).map(n => utxos[n].tokens);
+
+  return {
+    conflicting_pending_balance: sumOf(conflictingTokens),
+    invalid_pending_balance: sumOf(invalidTokens),
+  };
+};

package/balances/detailed_balances.js

@@ -1,3 +1,5 @@
+const conflictingBalances = require('./conflicting_balances');
+
 const {ceil} = Math;
 const flatten = arr => [].concat(...arr);
 const inputsCounterVBytesLength = 3;
@@ -61,6 +63,8 @@ const witnessSizeCounterVByteLength = 0.25;
   @returns
   {
     closing_balance: <Balance of Tokens Moving Out Of Channels Tokens Number>
+    conflicted_pending: <Conflicting Pending Balance Tokens Number>
+    invalid_pending: <Invalid Pending Balance Tokens Number>
     offchain_balance: <Balance of Owned Tokens In Channels Tokens Number>
     offchain_pending: <Total Pending Local Balance Tokens Number>
     onchain_balance: <Balance of Transaction Outputs Number>
@@ -170,8 +174,12 @@ module.exports = ({channels, locked, pending, transactions, utxos}) => {
     .concat(transactionLockTimeVBytesLength)
     .concat(inputElements));
 
+  const conflicts = conflictingBalances({transactions, utxos});
+
   return {
     closing_balance: sumOf(closing),
+    conflicted_pending: conflicts.conflicting_pending_balance,
+    invalid_pending: conflicts.invalid_pending_balance,
     offchain_balance: channelBalance,
     offchain_pending: pendingBalance,
     onchain_balance: chainBalance,

package/balances/get_detailed_balance.js

@@ -15,6 +15,7 @@ const {fromHex} = Transaction;
 /** Get a detailed balance that categorizes balance of tokens on the node
 
   {
+    [is_confirmed]: <Only Consider Confirmed Transactions Bool>
     lnd: <Authenticated LND API Object>
   }
 
@@ -113,12 +114,26 @@ module.exports = (args, cbk) => {
           locked,
           channels: getChannels.channels,
           pending: getPending.pending_channels,
-          transactions: getTx.transactions,
-          utxos: getUtxos.utxos,
+          transactions: getTx.transactions.filter(tx => {
+            if (!!args.is_confirmed && !tx.is_confirmed) {
+              return false;
+            }
+
+            return true;
+          }),
+          utxos: getUtxos.utxos.filter(utxo => utxo => {
+            if (!!args.is_confirmed && !utxo.confirmation_count) {
+              return false;
+            }
+
+            return true;
+          }),
         });
 
         return cbk(null, {
           closing_balance: format(balances.closing_balance) || undefined,
+          conflicted_pending: format(balances.conflicted_pending) || undefined,
+          invalid_pending: format(balances.invalid_pending) || undefined,
           offchain_balance: format(balances.offchain_balance) || undefined,
           offchain_pending: format(balances.offchain_pending) || undefined,
           onchain_balance: format(balances.onchain_balance) || undefined,

package/bos

@@ -167,11 +167,7 @@ prog
         if (!!options.detailed) {
           return balances.getDetailedBalance({
             lnd,
-            above: options.above,
-            below: options.below,
             is_confirmed: options.confirmed,
-            is_offchain_only: options.offchain,
-            is_onchain_only: options.onchain,
           },
           responses.returnObject({logger, reject, resolve}));
         }
@@ -1627,6 +1623,7 @@ prog
           logger,
           ask: (n, cbk) => inquirer.prompt([n]).then(res => cbk(null, res)),
           lnd: (await lndForNode(logger, options.node)).lnd,
+          separator: () => new inquirer.Separator(),
         },
         responses.returnObject({exit, logger, reject, resolve}));
       } catch (err) {

package/package.json

@@ -11,17 +11,17 @@
   },
   "dependencies": {
     "@alexbosworth/caporal": "1.4.0",
-    "@alexbosworth/fiat": "1.0.0",
+    "@alexbosworth/fiat": "1.0.1",
     "@alexbosworth/html2unicode": "1.1.5",
     "@alexbosworth/node-fetch": "2.6.2",
     "abort-controller": "3.0.0",
     "asciichart": "1.5.25",
-    "async": "3.2.2",
-    "asyncjs-util": "1.2.7",
+    "async": "3.2.3",
+    "asyncjs-util": "1.2.8",
     "bip66": "1.1.5",
     "bitcoinjs-lib": "6.0.1",
     "bolt01": "1.2.3",
-    "bolt03": "1.2.12",
+    "bolt03": "1.2.13",
     "bolt07": "1.8.0",
     "cbor": "8.1.0",
     "colorette": "2.0.16",
@@ -33,14 +33,14 @@
     "import-lazy": "4.0.0",
     "ini": "2.0.0",
     "inquirer": "8.2.0",
-    "invoices": "2.0.2",
+    "invoices": "2.0.3",
     "ln-accounting": "5.0.5",
-    "ln-service": "53.2.0",
+    "ln-service": "53.4.0",
     "ln-sync": "3.6.1",
     "ln-telegram": "3.5.1",
     "moment": "2.29.1",
     "paid-services": "3.5.1",
-    "probing": "2.0.1",
+    "probing": "2.0.2",
     "psbt": "1.1.10",
     "qrcode-terminal": "0.12.0",
     "sanitize-filename": "1.6.3",
@@ -51,7 +51,7 @@
   "description": "Lightning balance CLI",
   "devDependencies": {
     "@alexbosworth/tap": "15.0.10",
-    "ln-docker-daemons": "2.1.0",
+    "ln-docker-daemons": "2.1.1",
     "mock-lnd": "1.4.1",
     "secp256k1": "4.0.3"
   },
@@ -90,5 +90,5 @@
     "postpublish": "docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 -t alexbosworth/balanceofsatoshis --push .",
     "test": "tap --branches=1 --functions=1 --lines=1 --statements=1 -t 60 test/arrays/*.js test/balances/*.js test/chain/*.js test/display/*.js test/encryption/*.js test/lnd/*.js test/network/*.js test/nodes/*.js test/peers/*.js test/responses/*.js test/routing/*.js test/services/*.js test/swaps/*.js test/tags/*.js test/wallets/*.js"
   },
-  "version": "11.22.4"
+  "version": "11.23.0"
 }

package/test/balances/test_detailed_balance.js

@@ -93,6 +93,8 @@ const tests = [
     description: 'Balance totals are calculated',
     expected: {
       closing_balance: 1,
+      conflicted_pending: 0,
+      invalid_pending: 0,
       offchain_balance: 14,
       offchain_pending: 35,
       onchain_balance: 4,
@@ -104,6 +106,8 @@ const tests = [
     description: 'Balance totals are calculated when there are no funds',
     expected: {
       closing_balance: 0,
+      conflicted_pending: 0,
+      invalid_pending: 0,
       offchain_balance: 0,
       offchain_pending: 0,
       onchain_balance: 0,

package/test/balances/test_get_accounting_report.js

@@ -98,6 +98,10 @@ const tests = [
           'income',
         ],
       ],
+      rows_summary: [
+        ['Total', 'Asset', 'Report Date', 'Total Fiat'],
+        [1, 'BTC', '', '0.00'],
+      ],
     },
   },
   {
@@ -114,6 +118,10 @@ tests.forEach(({args, description, error, expected}) => {
     } else {
       const res = await getAccountingReport(args);
 
+      if (!args.is_csv) {
+        res.rows_summary[1][2] = '';
+      }
+
       strictSame(res, expected, 'Got expected response');
     }