balanceofsatoshis 12.26.4 → 12.28.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Versions
 
+## 12.28.0
+
+- `chart-payments-received`: Optimize reporting speed for short times
+- `chart-payments-received`: Add `--count` to report on count of payments
+- `chart-payments-received`: Add `--for` to filter for a matching description
+
+## 12.27.0
+
+- `rebalance`: `--in-filter`, `--out-filter`: add `INBOUND_FEE_RATE` variable
+- `rebalance`: Ignore inbound-disabled peers when specifying `--in-filter`
+
+## 12.26.5
+
+- `telegram`: Optimize /command speed by reducing duplicate wallet info calls
+
 ## 12.26.4
 
 - `telegram`: Fix button push handling and responding to button push queries

package/README.md

@@ -627,6 +627,7 @@ And for `--in-filter` and `--out-filter`:
 
 - `capacity`: The total capacity with the peer
 - `heights`: The set of heights of the channels with the peer
+- `inbound_fee_rate`: The fee rate the peer is charging
 - `inbound_liquidity`: The inbound liquidity with the peer
 - `outbound_liquidity`: The outbound liquidity with the peer
 - `pending_payments`: The number of pending payments

package/bos

@@ -452,8 +452,10 @@ prog
   // Chart earnings from payments received
   .command('chart-payments-received', 'Get a chart of received payments')
   .help('Show chart for settled invoices from external parties')
+  .option('--count', 'Show count of settled instead of amount received')
   .option('--days <days>', 'Chart over the past number of days', INT)
   .option('--end <end_date>', 'Final date for chart as YYYY-MM-DD', STRING)
+  .option('--for <query>', 'Only consider payments including a specific query')
   .option('--node <node_name>', 'Get payments from saved node(s)', REPEATABLE)
   .option('--start <start_date>', 'Start date for chart as YYYY-MM-DD', STRING)
   .action((args, options, logger) => {
@@ -462,7 +464,9 @@ prog
         return wallets.getReceivedChart({
           days: options.days,
           end_date: options.end,
+          is_count: options.count,
           lnds: (await lnd.getLnds({logger, nodes: options.node})).lnds,
+          query: options.for,
           start_date: options.start,
         },
         responses.returnChart({logger, reject, resolve, data: 'data'}));
@@ -1395,6 +1399,7 @@ prog
   .help('--in decreases the inbound liquidity with a specific peer/tag')
   .help('--in-filter/--out-filter vars: CAPACITY/HEIGHTS/INBOUND_LIQUIDITY')
   .help('--in-filter/--out-filter vars: OUTBOUND_LIQUIDITY/PENDING_PAYMENTS')
+  .help('--in-filter/--out-filter vars: INBOUND_FEE_RATE')
   .help('--out increases the inbound liquidity with a specific peer/tag')
   .option('--amount <amount>', 'Maximum amount to rebalance')
   .option('--avoid <pubkey_or_chanid>', 'Avoid forwarding through', REPEATABLE)

package/package.json

@@ -36,7 +36,7 @@
     "ini": "3.0.1",
     "inquirer": "9.1.0",
     "ln-accounting": "5.0.7",
-    "ln-service": "53.20.0",
+    "ln-service": "53.21.0",
     "ln-sync": "3.13.1",
     "ln-telegram": "3.22.3",
     "moment": "2.29.4",
@@ -53,7 +53,7 @@
   "description": "Lightning balance CLI",
   "devDependencies": {
     "@alexbosworth/tap": "15.0.11",
-    "invoices": "2.1.0",
+    "invoices": "2.2.0",
     "ln-docker-daemons": "2.3.5",
     "mock-lnd": "1.4.4",
     "tiny-secp256k1": "2.2.1"
@@ -83,5 +83,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/telegram/*.js test/wallets/*.js"
   },
-  "version": "12.26.4"
+  "version": "12.28.0"
 }

package/peers/find_tag_match.js

@@ -1,8 +1,10 @@
 const {decodeChanId} = require('bolt07');
 
+const flatten = arr => [].concat(...arr);
 const {shuffle} = require('./../arrays');
 const {isMatchingFilters} = require('./../display');
 
+const {max} = Math;
 const sumOf = arr => arr.reduce((sum, n) => sum + n, Number());
 
 /** Find a node for a tag query
@@ -15,6 +17,11 @@ const sumOf = arr => arr.reduce((sum, n) => sum + n, Number());
       remote_balance: <Channel Local Balance Tokens Number>
     }]
     [filters]: [<Filter Expression String>]
+    policies: {
+      [fee_rate]: <Remote Fees Charged in Millitokens Per Million Number>
+      [is_disabled]: <Remote Channel Forwarding Is Disabled Bool>
+      public_key: <Remote Public Key Hex String>
+    }
     query: <Query String>
     tags: [{
       [alias]: <Tag Alias String>
@@ -37,8 +44,12 @@ const sumOf = arr => arr.reduce((sum, n) => sum + n, Number());
     }]
   }
 */
-module.exports = ({channels, filters, tags, query}) => {
-  const peerKeys = channels.map(n => n.partner_public_key);
+module.exports = ({channels, filters, policies, tags, query}) => {
+  const disabled = policies.filter(n => n.is_disabled).map(n => n.public_key);
+
+  const peerKeys = channels
+    .map(n => n.partner_public_key)
+    .filter(n => !disabled.includes(n));
 
   // Find tags that match on id or on alias, and also have relevant nodes
   const matches = tags.filter(tag => {
@@ -78,8 +89,10 @@ module.exports = ({channels, filters, tags, query}) => {
         return {match: key};
       }
 
+      const peerPolicies = policies.filter(n => n.public_key === key);
       const withPeer = channels.filter(n => n.partner_public_key === key);
 
+      const feeRates = peerPolicies.filter(n => n.fee_rate !== undefined);
       const pendingPayments = withPeer.map(n => n.pending_payments.length);
 
       const matching = isMatchingFilters({
@@ -89,6 +102,7 @@ module.exports = ({channels, filters, tags, query}) => {
           heights: withPeer.map(n => {
             return decodeChanId({channel: n.id}).block_height;
           }),
+          inbound_fee_rate: max(...feeRates.map(n => n.fee_rate)),
           inbound_liquidity: sumOf(withPeer.map(n => n.remote_balance)),
           outbound_liquidity: sumOf(withPeer.map(n => n.local_balance)),
           pending_payments: sumOf(pendingPayments),

package/swaps/rebalance.js

@@ -212,13 +212,26 @@ module.exports = (args, cbk) => {
 
       // Find inbound tag public key
       findInTag: [
+        'getFees',
         'getInitialLiquidity',
+        'getPublicKey',
         'getTags',
-        ({getInitialLiquidity, getTags}, cbk) =>
+        ({getFees, getInitialLiquidity, getPublicKey, getTags}, cbk) =>
       {
+        const id = getPublicKey.public_key;
+
         const {failure, match, matches} = findTagMatch({
           channels: getInitialLiquidity.channels.filter(n => n.is_active),
           filters: args.in_filters,
+          policies: getFees.channels.map(channel => {
+            const policy = channel.policies.find(n => n.public_key !== id);
+
+            return {
+              fee_rate: policy.fee_rate,
+              is_disabled: policy.is_disabled,
+              public_key: policy.public_key,
+            };
+          }),
           tags: getTags.tags,
           query: args.in_through,
         });
@@ -267,14 +280,31 @@ module.exports = (args, cbk) => {
       // Find outbound peer key if a name is specified
       findOutKey: [
         'findInTag',
+        'getFees',
         'getInitialLiquidity',
+        'getPublicKey',
         'getTags',
         'lnd',
-        ({findInTag, getInitialLiquidity, getTags, lnd}, cbk) =>
+        ({
+          findInTag,
+          getFees,
+          getInitialLiquidity,
+          getPublicKey,
+          getTags,
+          lnd,
+        },
+        cbk) =>
       {
+        const id = getPublicKey.public_key;
+
         const {failure, match, matches} = findTagMatch({
           channels: getInitialLiquidity.channels.filter(n => n.is_active),
           filters: args.out_filters,
+          policies: getFees.channels.map(channel => {
+            const policy = channel.policies.find(n => n.public_key !== id);
+
+            return {fee_rate: policy.fee_rate, public_key: policy.public_key};
+          }),
           tags: getTags.tags,
           query: args.out_through,
         });

package/telegram/get_node_details.js

@@ -1,18 +1,19 @@
 const asyncAuto = require('async/auto');
-const asyncMap = require('async/map');
 const {returnResult} = require('asyncjs-util');
-const {getWalletInfo} = require('ln-service');
 
 const {getLnds} = require('./../lnd');
 
-const fromName = node => `${node.alias} ${node.public_key.substring(0, 8)}`;
 const {isArray} = Array;
-const sanitize = n => (n || '').replace(/_/g, '\\_').replace(/[*~`]/g, '');
 
 /** Get node details for telegram commands
 
   {
     logger: <Winston Logger Object>
+    names: [{
+      alias: <Node Alias String>
+      from: <Node Name String>
+      public_key: <Node Identity Public Key Hex String>
+    }]
     nodes: [<Saved Node Name String>]
   }
 
@@ -26,7 +27,7 @@ const sanitize = n => (n || '').replace(/_/g, '\\_').replace(/[*~`]/g, '');
     }]
   }
 */
-module.exports = ({logger, nodes}, cbk) => {
+module.exports = ({logger, names, nodes}, cbk) => {
   return new Promise((resolve, reject) => {
     return asyncAuto({
       // Check arguments
@@ -45,32 +46,19 @@ module.exports = ({logger, nodes}, cbk) => {
       // Get associated LNDs
       getLnds: ['validate', ({}, cbk) => getLnds({logger, nodes}, cbk)],
 
-      // Get node info for the nodes
-      getNodes: ['getLnds', ({getLnds}, cbk) => {
-        return asyncMap(getLnds.lnds, (lnd, cbk) => {
-          return getWalletInfo({lnd}, (err, res) => {
-            if (!!err) {
-              return cbk([503, 'FailedToGetNodeInfoForTelegramNode', {err}]);
-            }
-
-            const named = fromName({
-              alias: res.alias,
-              public_key: res.public_key,
-            });
+      // Merge node info for the nodes
+      nodes: ['getLnds', ({getLnds}, cbk) => {
+        const nodes = getLnds.lnds.map((lnd, i) => {
+          return {
+            lnd,
+            alias: names[i].alias,
+            from: names[i].from,
+            public_key: names[i].public_key,
+          };
+        });
 
-            return cbk(null, {
-              lnd,
-              alias: res.alias,
-              from: sanitize(named),
-              public_key: res.public_key,
-            });
-          });
-        },
-        cbk);
+        return cbk(null, {nodes});
       }],
-
-      // List of nodes with details
-      nodes: ['getNodes', ({getNodes}, cbk) => cbk(null, {nodes: getNodes})],
     },
     returnResult({reject, resolve, of: 'nodes'}, cbk));
   });

package/telegram/start_telegram_bot.js

@@ -56,7 +56,7 @@ const {version} = require('./../package');
 
 const fileAsDoc = file => new InputFile(file.source, file.filename);
 const fromName = node => `${node.alias} ${node.public_key.substring(0, 8)}`;
-const getDetails = (logger, nodes) => getNodeDetails({logger, nodes});
+const getLnds = (x, y, z) => getNodeDetails({logger: x, names: y, nodes: z});
 const {isArray} = Array;
 const isHash = n => /^[0-9A-F]{64}$/i.test(n);
 let isBotInit = false;
@@ -164,6 +164,12 @@ module.exports = (args, cbk) => {
           return cbk();
         }
 
+        const names = getNodes.map(node => ({
+          alias: node.alias,
+          from: node.from,
+          public_key: node.public_key,
+        }));
+
         args.bot.catch(err => args.logger.error({telegram_error: err}));
 
         // Catch message editing
@@ -183,7 +189,7 @@ module.exports = (args, cbk) => {
             await handleBackupCommand({
               from: ctx.message.from.id,
               id: connectedId,
-              nodes: (await getDetails(args.logger, args.nodes)).nodes,
+              nodes: (await getLnds(args.logger, names, args.nodes)).nodes,
               reply: ctx.reply,
               send: (n, opts) => ctx.replyWithDocument(fileAsDoc(n), opts),
             });
@@ -218,7 +224,7 @@ module.exports = (args, cbk) => {
             await handleCostsCommand({
               from: ctx.message.from.id,
               id: connectedId,
-              nodes: (await getDetails(args.logger, args.nodes)).nodes,
+              nodes: (await getLnds(args.logger, names, args.nodes)).nodes,
               reply: n => ctx.reply(n, markdown),
               request: args.request,
               working: () => ctx.replyWithChatAction('typing'),
@@ -234,7 +240,7 @@ module.exports = (args, cbk) => {
             await handleEarningsCommand({
               from: ctx.message.from.id,
               id: connectedId,
-              nodes: (await getDetails(args.logger, args.nodes)).nodes,
+              nodes: (await getLnds(args.logger, names, args.nodes)).nodes,
               reply: n => ctx.reply(n, markdown),
               working: () => ctx.replyWithChatAction('typing'),
             });
@@ -249,7 +255,7 @@ module.exports = (args, cbk) => {
             await handleGraphCommand({
               from: ctx.message.from.id,
               id: connectedId,
-              nodes: (await getDetails(args.logger, args.nodes)).nodes,
+              nodes: (await getLnds(args.logger, names, args.nodes)).nodes,
               remove: () => ctx.deleteMessage(),
               reply: (message, options) => ctx.reply(message, options),
               text: ctx.message.text,
@@ -266,7 +272,7 @@ module.exports = (args, cbk) => {
             await handleInfoCommand({
               from: ctx.message.from.id,
               id: connectedId,
-              nodes: (await getDetails(args.logger, args.nodes)).nodes,
+              nodes: (await getLnds(args.logger, names, args.nodes)).nodes,
               remove: () => ctx.deleteMessage(),
               reply: (message, options) => ctx.reply(message, options),
             });
@@ -281,7 +287,7 @@ module.exports = (args, cbk) => {
             await handleInvoiceCommand({
               ctx,
               id: connectedId,
-              nodes: (await getDetails(args.logger, args.nodes)).nodes,
+              nodes: (await getLnds(args.logger, names, args.nodes)).nodes,
             });
           } catch (err) {
             args.logger.error({err});
@@ -317,7 +323,7 @@ module.exports = (args, cbk) => {
               await handleLiquidityCommand({
                 from: ctx.message.from.id,
                 id: connectedId,
-                nodes: (await getDetails(args.logger, args.nodes)).nodes,
+                nodes: (await getLnds(args.logger, names, args.nodes)).nodes,
                 reply: (n, opt) => ctx.reply(n, opt),
                 text: ctx.message.text,
                 working: () => ctx.replyWithChatAction('typing'),
@@ -346,7 +352,7 @@ module.exports = (args, cbk) => {
               budget,
               from: ctx.message.from.id,
               id: connectedId,
-              nodes: (await getDetails(args.logger, args.nodes)).nodes,
+              nodes: (await getLnds(args.logger, names, args.nodes)).nodes,
               reply: message => ctx.reply(message, markdown),
               request: args.request,
               text: ctx.message.text,
@@ -365,7 +371,7 @@ module.exports = (args, cbk) => {
             await handlePendingCommand({
               from: ctx.message.from.id,
               id: connectedId,
-              nodes: (await getDetails(args.logger, args.nodes)).nodes,
+              nodes: (await getLnds(args.logger, names, args.nodes)).nodes,
               reply: (message, options) => ctx.reply(message, options),
               working: () => ctx.replyWithChatAction('typing'),
             });
@@ -444,7 +450,7 @@ module.exports = (args, cbk) => {
               ctx,
               bot: args.bot,
               id: connectedId,
-              nodes: (await getDetails(args.logger, args.nodes)).nodes,
+              nodes: (await getLnds(args.logger, names, args.nodes)).nodes,
             });
           } catch (err) {
             args.logger.error({err});
@@ -460,7 +466,7 @@ module.exports = (args, cbk) => {
                 ctx,
                 api: args.bot.api,
                 id: connectedId,
-                nodes: (await getDetails(args.logger, args.nodes)).nodes,
+                nodes: (await getLnds(args.logger, names, args.nodes)).nodes,
               });
             } catch (err) {
               args.logger.error({err});

package/test/peers/test_find_tag_match.js

@@ -11,6 +11,7 @@ const makeArgs = overrides => {
       pending_payments: [],
       remote_balance: 2,
     }],
+    policies: [],
     query: '0000',
     tags: [{
       id: Buffer.alloc(32).toString('hex'),

package/wallets/get_received_chart.js

@@ -28,6 +28,7 @@ const parseDate = n => Date.parse(n);
     [days]: <Received Over Days Count Number>
     [end_date]: <End Date YYYY-MM-DD String>
     lnds: [<Authenticated LND API Object>]
+    [query]: <Match Description String>
     [start_date]: <Start Date YYYY-MM-DD String>
   }
 
@@ -140,6 +141,7 @@ module.exports = (args, cbk) => {
           return getAllInvoices({
             lnd,
             confirmed_after: start.toISOString(),
+            created_after: start.toISOString(),
           },
           cbk);
         },
@@ -149,6 +151,10 @@ module.exports = (args, cbk) => {
           }
 
           const settled = flatten(res.map(n => n.invoices)).filter(invoice => {
+            if (!!args.query && !invoice.description.includes(args.query)) {
+              return false;
+            }
+
             // Exit early when considering all invoices without an end point
             if (!args.end_date) {
               return true;
@@ -240,10 +246,16 @@ module.exports = (args, cbk) => {
 
       // Total activity
       data: ['description', 'sum', ({description, sum}, cbk) => {
+        const title = [
+          !!args.is_count ? 'Received' : 'Payments',
+          !!args.query ? `for “${args.query}”` : '',
+          !!args.is_count ? 'count' : 'received',
+        ];
+
         return cbk(null, {
           description,
           data: !args.is_count ? sum.sum : sum.count,
-          title: !args.is_count ? 'Payments received' : 'Received count',
+          title: title.filter(n => !!n).join(' '),
         });
       }],
     },