balanceofsatoshis 11.40.0 → 11.41.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 11.41.0
+
+- `remove-peer`: Add interactive mode to select channels to close
+
 ## 11.40.0
 
 - `peers`: Add `DISK_USAGE_MB` filter to `--filter` formulas for est disk usage

package/bos

@@ -1396,6 +1396,7 @@ prog
   .option('--outpoint', 'Only remove specific channel with funding txid:vout')
   .option('--private', 'Peer is privately connected')
   .option('--public', 'Peer is publicly connected')
+  .option('--select-channels', 'Select channels to remove interactively')
   .action((args, options, logger) => {
     return new Promise(async (resolve, reject) => {
       try {
@@ -1405,6 +1406,7 @@ prog
           lnd,
           logger,
           address: options.address,
+          ask: (n, cbk) => inquirer.prompt([n]).then(n => cbk(n)),
           chain_fee_rate: options.feeRate || undefined,
           fs: {getFile: readFile},
           idle_days: options.idleDays,
@@ -1415,6 +1417,7 @@ prog
           is_offline: !!options.offline,
           is_private: !!options.private,
           is_public: !!options.public,
+          is_selecting_channels: options.selectChannels || undefined,
           omit: flatten([options.omit].filter(n => !!n)),
           outbound_liquidity_below: options.outboundBelow,
           outpoints: flatten([options.outpoint].filter(n => !!n)),

package/lnd/find_record.js

@@ -236,6 +236,7 @@ module.exports = ({lnd, query}, cbk) => {
                 .map(chan => {
                   const [height] = chan.id.split('x');
                   const local = formatTokens({tokens: chan.local_balance});
+                  const pending = chan.pending_payments;
                   const remote = formatTokens({tokens: chan.remote_balance});
 
                   const inbound = `in: ${balance(remote)}`;
@@ -248,6 +249,7 @@ module.exports = ({lnd, query}, cbk) => {
                     capacity: formatTokens({tokens: chan.capacity}).display,
                     funding: `${chan.transaction_id} ${chan.transaction_vout}`,
                     peer_created: chan.is_partner_initiated || undefined,
+                    pending_payments: !!pending.length ? pending : undefined,
                   };
                 }),
             }

package/network/remove_peer.js

@@ -1,6 +1,7 @@
 const asyncAuto = require('async/auto');
 const asyncEachSeries = require('async/eachSeries');
 const {closeChannel} = require('ln-service');
+const {decodeChanId} = require('bolt07');
 const {getChainFeeRate} = require('ln-service');
 const {getChannels} = require('ln-service');
 const {getNetwork} = require('ln-sync');
@@ -11,20 +12,25 @@ const getPeers = require('./get_peers');
 
 const arrayWithEntries = arr => !!arr.length ? arr : undefined;
 const asOutpoint = n => `${n.transaction_id}:${n.transaction_vout}`;
+const estimateDisk = n => Math.round(n * 500 / 1e6 * 10) / 10;
 const fastConf = 6;
 const {floor} = Math;
 const defaultDays = 365 * 2;
 const getMempoolRetries = 10;
+const iconDisabled = channel => !channel.is_active ? '💀 ' : '';
+const iconPending = channel => channel.pending_payments.length ? '💸 ' : ''
 const {isArray} = Array;
 const isPublicKey = n => !!n && /^0[2-3][0-9A-F]{64}$/i.test(n);
 const maxMempoolSize = 2e6;
 const regularConf = 72;
 const slowConf = 144;
+const tokensAsBigUnit = tokens => (tokens / 1e8).toFixed(8);
 
 /** Close out channels with a peer and disconnect them
 
   {
     [address]: <Close Out Funds to On-Chain Address String>
+    ask: <Ask Function>
     [chain_fee_rate]: <Chain Fee Per VByte Number>
     fs: {
       getFile: <Read File Contents Function> (path, cbk) => {}
@@ -37,6 +43,7 @@ const slowConf = 144;
     [is_offline]: <Peer Is Disconnected Bool>
     [is_private]: <Peer is Privately Connected Bool>
     [is_public]: <Peer is Publicly Connected Bool>
+    [is_selecting_channels]: <Interactively Select Channels to Remove Bool>
     lnd: <Authenticated LND API Object>
     logger: <Winston Logger Object>
     [omit]: [<Avoid Peer With Public Key String>]
@@ -53,10 +60,18 @@ module.exports = (args, cbk) => {
     return asyncAuto({
       // Check arguments
       validate: cbk => {
+        if (!args.ask) {
+          return cbk([400, 'ExpectedAskFunctionToRemovePeer']);
+        }
+
         if (!args.fs) {
           return cbk([400, 'ExpectedFsMethodsToRemovePeer']);
         }
 
+        if (!!args.is_selecting_channels && !args.public_key) {
+          return cbk([400, 'ExpectedPeerToRemoveWhenSelectingChannels']);
+        }
+
         if (!args.lnd) {
           return cbk([400, 'LndIsRequiredToRemovePeer']);
         }
@@ -69,6 +84,10 @@ module.exports = (args, cbk) => {
           return cbk([400, 'ExpectedSpecificOutpointsToRemoveFromPeer']);
         }
 
+        if (!!args.outpoints.length && !args.public_key) {
+          return cbk([400, 'ExpectedPeerToRemoteWhenOutpointsSpecified']);
+        }
+
         if (!!args.public_key && !isPublicKey(args.public_key)) {
           return cbk([400, 'ExpectedPublicKeyOfPeerToRemove']);
         }
@@ -137,8 +156,94 @@ module.exports = (args, cbk) => {
         cbk);
       }],
 
+      // Determine outpoints to use
+      outpoints: ['getChannels', ({getChannels}, cbk) => {
+        // Exit early when a peer is not specified
+        if (!args.public_key) {
+          return cbk(null, []);
+        }
+
+        const channelsWithPeer = getChannels.channels
+          .filter(channel => {
+            // Ignore channels that are not the specified public key
+            if (channel.partner_public_key !== args.public_key) {
+              return false;
+            }
+
+            //Return channels with the peer
+            return true;
+          })
+          .sort((a, b) => {
+            const heightA = decodeChanId({channel: a.id}).block_height;
+            const heightB = decodeChanId({channel: b.id}).block_height;
+
+            // Sort channels by oldest to newest
+            return heightA - heightB;
+          });
+
+        // Exit early when no channels are available
+        if (!channelsWithPeer.length) {
+          return cbk([404, 'NoChannelsToCloseWithSpecifiedPeer']);
+        }
+
+        // Collect any outpoints that are unable to be cooperatively closed
+        const blocked = channelsWithPeer
+          .filter(channel => {
+            // Channels that are inactive or have HTLCs cannot be coop-closed
+            return !channel.is_active || !!channel.pending_payments.length;
+          })
+          .map(channel => asOutpoint(channel));
+
+        // Find a directly referenced outpoint that is in the blocked list
+        const blockedOutpoint = args.outpoints.find(n => blocked.includes(n));
+
+        // Make sure we aren't trying to coop close a channel that can't be
+        if (!args.is_forced && !!blockedOutpoint) {
+          return cbk([400, 'CannotCoopClose', {outpoint: blockedOutpoint}]);
+        }
+
+        // Exit early if not selecting a channel
+        if (!args.is_selecting_channels) {
+          return cbk(null, args.outpoints);
+        }
+
+        // Interactively select outpoints to close
+        return args.ask({
+          choices: channelsWithPeer.map(channel => {
+            // In closing, channels are identified by their funding outpoint
+            const value = asOutpoint(channel);
+
+            // Channels that are inactive or have HTLCs cannot be coop-closed
+            const isBlocked = blocked.includes(value);
+
+            const disk = `Est disk mb: ${estimateDisk(channel.past_states)}`;
+            const icon = iconDisabled(channel) || iconPending(channel);
+            const {id} = channel;
+            const inbound = `in: ${tokensAsBigUnit(channel.remote_balance)}`;
+            const outbound = `out: ${tokensAsBigUnit(channel.local_balance)}`;
+
+            return {
+              value,
+              checked: args.outpoints.includes(value),
+              disabled: !args.is_forced ? isBlocked : false,
+              name: `${icon}${id}: ${inbound} | ${outbound}. ${disk}.`,
+            };
+          }),
+          loop: false,
+          message: `Channels to ${!!args.is_forced ? 'force ' : ''}close?`,
+          name: 'outpoints',
+          type: 'checkbox',
+          validate: input => !!input.length,
+        },
+        ({outpoints}) => cbk(null, outpoints));
+      }],
+
       // Check channels for peer to make sure that they can be cleanly closed
-      checkChannels: ['getChannels', ({getChannels}, cbk) => {
+      checkChannels: [
+        'getChannels',
+        'outpoints',
+        ({getChannels, outpoints}, cbk) =>
+      {
         // Exit early when a peer is not specified or force closing is OK
         if (!args.public_key || !!args.is_forced) {
           return cbk();
@@ -151,12 +256,12 @@ module.exports = (args, cbk) => {
           }
 
           // Exit early when there are no outpoints, consider all peer channels
-          if (!args.outpoints.length) {
+          if (!outpoints.length) {
             return true;
           }
 
           // Only include selected channels
-          return args.outpoints.includes(asOutpoint(channel));
+          return outpoints.includes(asOutpoint(channel));
         });
 
         const costToClose = selectedChannels
@@ -279,8 +384,9 @@ module.exports = (args, cbk) => {
         'checkChannels',
         'getChannels',
         'getNormalFee',
+        'outpoints',
         'selectPeer',
-        ({getChannels, getNormalFee, selectPeer}, cbk) =>
+        ({getChannels, getNormalFee, outpoints, selectPeer}, cbk) =>
       {
         // Exit early when there is no peer to close out with
         if (!selectPeer) {
@@ -292,11 +398,12 @@ module.exports = (args, cbk) => {
         const toClose = getChannels.channels
           .filter(chan => chan.partner_public_key === selectPeer.public_key)
           .filter(chan => {
-            if (!args.outpoints.length)  {
+            // When no outpoints are specified, all channels should be closed
+            if (!outpoints.length) {
               return true;
             }
 
-            return args.outpoints.includes(asOutpoint(chan));
+            return !!outpoints.includes(asOutpoint(chan));
           });
 
         // Exit early when there are no channels to close

package/package.json

@@ -81,5 +81,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.40.0"
+  "version": "11.41.0"
 }

package/swaps/rebalance.js

@@ -43,7 +43,6 @@ const isPublicKey = n => /^[0-9A-F]{66}$/i.test(n);
 const legacyMaxRebalanceTokens = 4294967;
 const {max} = Math;
 const maxPaymentSize = 4294967;
-const maxRebalanceTokens = 16777215;
 const {min} = Math;
 const minInboundBalance = 4294967 * 2;
 const minRebalanceAmount = 5e4;
@@ -632,7 +631,7 @@ module.exports = (args, cbk) => {
           lnd,
           cltv_delta: defaultCltvDelta,
           description: 'Rebalance',
-          tokens: min(maxRebalanceTokens, findRoute.route_maximum),
+          tokens: findRoute.route_maximum,
         },
         cbk);
       }],