balanceofsatoshis 11.3.0 → 11.6.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Versions
 
+## Version 11.6.0
+
+- `clean-failed-payments`: Add method to clean out failed past payments
+
+## Version 11.5.1
+
+- `--avoid`: Correct naming`OUT_FEE_RATE`/`IN_FEE_RATE` to `OPPOSITE_FEE_RATE`
+
+## Version 11.5.0
+
+- `--avoid` Add `IN_FEE_RATE` and `OUT_FEE_RATE` to formulas
+- `find`: Correct socket output for peer node lookups
+- `telegram`: Correct week summary chain fee costs in `/costs`
+
+## Version 11.4.0
+
+- `call`: Add `--param` flag to pass arguments directly instead of interactively
+
 ## Version 11.3.0
 
 - `credentials`: Allow specifying specific methods to allow in a credential

package/README.md

@@ -533,6 +533,22 @@ functions and reference variables.
 There is a dynamic playground here where you can play with expressions:
 https://formulajs.info/functions/
 
+### `--avoid`
+
+In `--avoid` flag commands like rebalance, a formula can be applied directionally:
+
+`--avoid "fee_rate < 100/<PUBKEY>"` to avoid channels forwarding to the public key that
+charge a fee rate under 100 PPM.
+
+Available variables:
+
+- `age`: Age of the channel vs the current height
+- `base_fee`: Base fee to be charged to route
+- `capacity`: Capacity of the channel
+- `fee_rate`: PPM fee to be charged to route
+- `height`: Absolute height of the channel
+- `opposite_fee_rate`: PPM fee that is charged in the non-routing direction
+
 ### `amount`
 
 Formula amounts are supported in the following commands:

package/bos

@@ -212,6 +212,7 @@ prog
   .help('If you do not specify a method it will list the supported methods')
   .argument('[method]', 'Method to call')
   .option('--node <node_name>', 'Saved node to use for call')
+  .option('--param <param>', 'query encoded name=value', REPEATABLE)
   .action((args, options, logger) => {
     return new Promise(async (resolve, reject) => {
       try {
@@ -220,6 +221,7 @@ prog
           ask: (n, cbk) => inquirer.prompt([n]).then(n => cbk(null, n)),
           lnd: (await lndForNode(logger, options.node)).lnd,
           method: args.method,
+          params: flatten([options.param].filter(n => !!n)),
         },
         responses.returnObject({logger, reject, resolve}));
       } catch (err) {
@@ -393,6 +395,26 @@ prog
     });
   })
 
+  // Clean out failed payments
+  .command('clean-failed-payments', 'Clean out past failed payment data')
+  .help('Remove old failed payment data for probes and other failed payments')
+  .option('--dryrun', 'Avoid actually deleting the failed payment record')
+  .option('--node <node_name>', 'Clean failed payments on a saved node')
+  .action((args, options, logger) => {
+    return new Promise(async (resolve, reject) => {
+      try {
+        return wallets.cleanFailedPayments({
+          logger,
+          is_dry_run: !!options.dryrun,
+          lnd: (await lnd.authenticatedLnd({logger, node: options.node})).lnd,
+        },
+        responses.returnObject({logger, reject, resolve}));
+      } catch (err) {
+        return reject(err);
+      }
+    });
+  })
+
   // Determine the outcomes of channel closings
   .command('closed', 'Get the status of a channel closings')
   .help('Channel closes with chain-transaction derived resolution details')
@@ -1191,7 +1213,7 @@ prog
   .option('--max-fee-rate <max_fee_rate>', 'Max fee rate to pay')
   .option('--minutes <minutes>', 'Time-out route search after N minutes', INT)
   .option('--no-color', 'Mute all colors')
-  .option('--node <node_name>', 'Node to use for rebalance')
+  .option('--node <node_name>', 'Saved node to use for rebalance')
   .option('--out <pubkey_or_alias>', 'Route out through a specific peer')
   .option('--out-filter <out_filter>', 'Filter outbound tag nodes', REPEATABLE)
   .option('--out-target-inbound <amount>', 'Balance up to inbound amount')

package/commands/api.json

@@ -287,6 +287,22 @@
     {
       "method": "getConnectedWatchtowers"
     },
+    {
+      "arguments": [
+        {
+          "description": "Results limit",
+          "named": "limit",
+          "optional": true,
+          "type": "number"
+        },
+        {
+          "description": "Paging token",
+          "named": "token",
+          "optional": true
+        }
+      ],
+      "method": "getFailedPayments"
+    },
     {
       "method": "getFeeRates"
     },

package/commands/call_raw_api.js

@@ -1,3 +1,5 @@
+const {parse} = require('querystring');
+
 const asyncAuto = require('async/auto');
 const asyncMapSeries = require('async/mapSeries');
 const lnService = require('ln-service');
@@ -5,6 +7,7 @@ const {returnResult} = require('asyncjs-util');
 
 const {calls} = require('./api');
 
+const {assign} = Object;
 const isChannel = n => !!n && /^\d*x\d*x\d*$/.test(n);
 const isHash = n => !!n && /^[0-9A-F]{64}$/i.test(n);
 const isPublicKey = n => !!n && /^0[2-3][0-9A-F]{64}$/i.test(n);
@@ -19,12 +22,13 @@ const methodDetails = (calls, method) => calls.find(n => n.method === method);
     lnd: <Authenticated LND API Object>
     logger: <Winston Logger Object>
     [method]: <Method to Call String>
+    [params]: [<Querystring Encoded Parameter String>]
   }
 
   @returns via cbk or Promise
   <Result Object>
 */
-module.exports = ({ask, lnd, logger, method}, cbk) => {
+module.exports = ({ask, lnd, logger, method, params}, cbk) => {
   return new Promise((resolve, reject) => {
     return asyncAuto({
       // Check arguments
@@ -76,12 +80,36 @@ module.exports = ({ask, lnd, logger, method}, cbk) => {
           return cbk(null, []);
         }
 
+        const parameters = (params || [])
+          .map(encoded => parse(encoded))
+          .reduce((sum, n) => assign(sum, n), {});
+
+        // Parameters must all match method parameters
+        const unknown = keys(parameters).find(param => {
+          return !arguments.find(({named}) => named === param);
+        });
+
+        if (!!unknown) {
+          return cbk([400, 'UnknownParameterProvided', {unknown}]);
+        }
+
         return asyncMapSeries(arguments, (argument, cbk) => {
+          const {named} = argument;
+
+          if (!!parameters[named] && argument.type === 'boolean') {
+            return cbk(null, {[named]: parameters[named] === 'true'});
+          }
+
+          if (parameters[named] !== undefined) {
+            return cbk(null, {[named]: parameters[named]});
+          }
+
           if (argument.type === 'boolean') {
             return ask({
               default: false,
-              name: argument.named,
+              name: named,
               message: argument.description,
+              prefix: `[${named}]`,
               type: 'confirm',
             },
             cbk);
@@ -90,7 +118,8 @@ module.exports = ({ask, lnd, logger, method}, cbk) => {
           return ask({
             default: () => !!argument.optional ? String() : undefined,
             message: argument.description,
-            name: argument.named,
+            name: named,
+            prefix: `[${named}]`,
             suffix: !!argument.optional ? ' (Optional)' : String(),
             type: argument.type || 'input',
             validate: input => {

package/lnd/find_record.js

@@ -114,7 +114,7 @@ module.exports = ({lnd, query}, cbk) => {
                 color: res.color,
                 features: res.features,
                 public_key: getKey.value.public_key,
-                sockets: res.sockets,
+                sockets: res.sockets.map(n => n.socket),
                 updated_at: res.last_updated,
               }],
             });

package/package.json

@@ -25,19 +25,19 @@
     "caporal": "1.4.0",
     "cbor": "8.0.2",
     "cert-info": "1.5.1",
-    "colorette": "2.0.14",
+    "colorette": "2.0.16",
     "crypto-js": "4.1.1",
     "csv-parse": "4.16.3",
     "goldengate": "10.4.0",
     "hot-formula-parser": "4.0.0",
     "import-lazy": "4.0.0",
     "ini": "2.0.0",
-    "inquirer": "8.1.5",
+    "inquirer": "8.2.0",
     "invoices": "2.0.0",
     "ln-accounting": "5.0.3",
-    "ln-service": "52.10.2",
+    "ln-service": "52.12.0",
     "ln-sync": "2.0.2",
-    "ln-telegram": "3.3.0",
+    "ln-telegram": "3.3.1",
     "moment": "2.29.1",
     "paid-services": "3.0.0",
     "probing": "1.3.6",
@@ -80,5 +80,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/fiat/*.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.3.0"
+  "version": "11.6.0"
 }

package/routing/get_ignores.js

@@ -223,6 +223,7 @@ module.exports = (args, cbk) => {
                   age: getHeight.current_block_height - height,
                   base_fee: Number(outPolicy.base_fee_mtokens) || Number(),
                   fee_rate: outPolicy.fee_rate || Number(),
+                  opposite_fee_rate: peerPolicy.fee_rate || Number(),
                 });
 
                 keys(variables).forEach(key => {
@@ -283,8 +284,9 @@ module.exports = (args, cbk) => {
               .map(({capacity, id, policies}) => {
                 const height = heightFromId(id);
                 const inPolicy = policies.find(n => n.public_key !== key);
+                const outPolicy = policies.find(n => n.public_key === key);
 
-                if (!inPolicy) {
+                if (!inPolicy || !outPolicy) {
                   return;
                 }
 
@@ -299,6 +301,7 @@ module.exports = (args, cbk) => {
                   age: getHeight.current_block_height - height,
                   base_fee: Number(inPolicy.base_fee_mtokens) || Number(),
                   fee_rate: inPolicy.fee_rate || Number(),
+                  opposite_fee_rate: outPolicy.fee_rate || Number(),
                 });
 
                 keys(variables).forEach(key => {

package/telegram/start_telegram_bot.js

@@ -323,7 +323,7 @@ module.exports = ({fs, id, limits, lnds, logger, payments, request}, cbk) => {
           });
         });
 
-        bot.command('liquidity', async ({message, reply}) => {
+        bot.command('liquidity', async ctx => {
           try {
             await asyncRetry({
               errorFilter: err => {
@@ -335,13 +335,14 @@ module.exports = ({fs, id, limits, lnds, logger, payments, request}, cbk) => {
               },
             }, async () => {
               await handleLiquidityCommand({
-                reply,
                 request,
-                from: message.from.id,
+                from: ctx.message.from.id,
                 id: connectedId,
                 key: apiKey.key,
                 nodes: allNodes,
-                text: message.text,
+                reply: ctx.reply,
+                text: ctx.message.text,
+                working: () => ctx.replyWithChatAction('typing'),
               });
             });
           } catch (err) {
@@ -392,6 +393,7 @@ module.exports = ({fs, id, limits, lnds, logger, payments, request}, cbk) => {
               id: connectedId,
               nodes: allNodes,
               reply: n => ctx.reply(n),
+              working: () => ctx.replyWithChatAction('typing'),
             });
           } catch (err) {
             logger.error({err});

package/wallets/clean_failed_payments.js

@@ -0,0 +1,153 @@
+const asyncAuto = require('async/auto');
+const asyncEachSeries = require('async/eachSeries');
+const asyncWhilst = require('async/whilst');
+const {deletePayment} = require('ln-service');
+const {getFailedPayments} = require('ln-service');
+const {getWalletVersion} = require('ln-service');
+const {returnResult} = require('asyncjs-util');
+
+const defaultPagingLimit = 500;
+const {isArray} = Array;
+const unsupported = 501;
+
+/** Clean out failed payments from the wallet
+
+  {
+    is_dry_run: <Avoid Actually Deleting Payments>
+    lnd: <Authenticated LND API Object>
+    logger: <Winston Logger Object>
+  }
+
+  @returns via cbk or Promise
+*/
+module.exports = (args, cbk) => {
+  return new Promise((resolve, reject) => {
+    return asyncAuto({
+      // Check arguments
+      validate: cbk => {
+        if (!args.lnd) {
+          return cbk([400, 'ExpectedAuthenticatedLndApiToCleanPayments']);
+        }
+
+        if (!args.logger) {
+          return cbk([400, 'ExpectedWinstonLoggerToCleanFailedPayments']);
+        }
+
+        return cbk();
+      },
+
+      // Try and determine what wallet version this is
+      getWalletVersion: ['validate', ({}, cbk) => {
+        return getWalletVersion({lnd: args.lnd}, cbk);
+      }],
+
+      // Deny known unsupported versions
+      checkWalletVersion: ['getWalletVersion', ({getWalletVersion}, cbk) => {
+        // Exit early when not actually deleting
+        if (!!args.is_dry_run) {
+          return cbk();
+        }
+
+        switch (getWalletVersion.version) {
+        case '0.11.0-beta':
+        case '0.11.1-beta':
+        case '0.12.0-beta':
+        case '0.12.1-beta':
+        case '0.13.0-beta':
+        case '0.13.1-beta':
+        case '0.13.2-beta':
+        case '0.13.3-beta':
+          return cbk([501, 'CleanFailedPaymentsUnsupportedOnThisLndVersion']);
+
+        default:
+          return cbk();
+        }
+      }],
+
+      // Delete failed payments
+      fetchAndDelete: ['checkWalletVersion', ({}, cbk) => {
+        const ids = [];
+        let token;
+
+        if (!!args.is_dry_run) {
+          args.logger.info({finding_failed_payments: true});
+        } else {
+          args.logger.info({deleting_failed_payments: true});
+        }
+
+        return asyncWhilst(
+          cbk => cbk(null, token !== false),
+          cbk => {
+            return getFailedPayments({
+              token,
+              limit: !token ? defaultPagingLimit : undefined,
+              lnd: args.lnd,
+            },
+            (err, res) => {
+              if (!!err) {
+                return cbk([503, 'UnexpectedErrorGettingPayFailures', {err}]);
+              }
+
+              // Setting token to false will signal the end of paging
+              token = res.next || false;
+
+              // Exit early when there
+              if (!res.payments.length) {
+                const date = new Date().toISOString();
+
+                args.logger.info({searching_for_failed_payments: date});
+
+                return cbk();
+              }
+
+              res.payments.forEach(({id}) => ids.push(id));
+
+              // Delete each payment
+              return asyncEachSeries(res.payments, ({id}, cbk) => {
+                // Exit early when doing a dry run
+                if (!!args.is_dry_run) {
+                  return cbk();
+                }
+
+                return deletePayment({id, lnd: args.lnd}, err => {
+                  // LND 0.13.3 and below do not support deleting payments
+                  if (!!isArray(err) && err.slice().shift() === unsupported) {
+                    return cbk([501, 'LndVersionDoesNotSupportFailDeletion']);
+                  }
+
+                  if (!!err) {
+                    return cbk([503, 'UnexpectedErrorDeletingPayment', {err}]);
+                  }
+
+                  return cbk();
+                });
+              },
+              err => {
+                if (!!err) {
+                  return cbk(err);
+                }
+
+                args.logger.info({failed_payments: ids.length});
+
+                return cbk();
+              });
+            });
+          },
+          err => {
+            if (!!err) {
+              return cbk(err);
+            }
+
+            // Exit early when this is a test
+            if (!!args.is_dry_run) {
+              return cbk(null, {total_failed_payments_found: ids.length});
+            }
+
+            return cbk(null, {total_failed_payments_deleted: ids.length});
+          }
+        );
+      }],
+    },
+    returnResult({reject, resolve, of: 'fetchAndDelete'}, cbk));
+  });
+};

package/wallets/index.js

@@ -1,5 +1,11 @@
+const cleanFailedPayments = require('./clean_failed_payments');
 const getReceivedChart = require('./get_received_chart');
 const getReport = require('./get_report');
 const unlockWallet = require('./unlock_wallet');
 
-module.exports = {getReceivedChart, getReport, unlockWallet};
+module.exports = {
+  cleanFailedPayments,
+  getReceivedChart,
+  getReport,
+  unlockWallet,
+};