paid-services 3.8.0 → 3.11.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Versions
 
+## Version 3.11.0
+
+- `changeChannelCapacity`: Add `nodes` to allow moving channel to another node
+
+## Version 3.10.0
+
+- `createAnchoredTrade`: Add method to create an anchored open trade
+- `getAnchoredTrade`: Add method to get an anchored open trade
+
+## Version 3.9.1
+
+- `decodeTrade`: Add method to decode a trade-secret
+
 ## Version 3.8.0
 
 - `encodeTrade`: Add method to encode a trade-secret

package/capacity/accept_capacity_change.js

@@ -32,6 +32,7 @@ const openTxType = '1';
     [increase]: <Increase Tokens Number>
     lnd: <Authenticated LND API Object>
     logger: <Winston Logger Object>
+    to: <Expect Channel from Public Key Hex String>
   }
 
   @returns via cbk or Promise
@@ -43,7 +44,7 @@ const openTxType = '1';
     transaction_vout: <Replacement Channel Transaction Output Index Number>
   }
 */
-module.exports = ({channel, from, id, increase, lnd, logger}, cbk) => {
+module.exports = ({channel, from, id, increase, lnd, logger, to}, cbk) => {
   return new Promise((resolve, reject) => {
     return asyncAuto({
       // Check arguments
@@ -68,6 +69,10 @@ module.exports = ({channel, from, id, increase, lnd, logger}, cbk) => {
           return cbk([400, 'ExpectedLoggerObjectToAcceptCapacityChange']);
         }
 
+        if (!to) {
+          return cbk([400, 'ExpectedToPublicKeyToAcceptCapacityChange']);
+        }
+
         return cbk();
       },
 
@@ -219,6 +224,7 @@ module.exports = ({channel, from, id, increase, lnd, logger}, cbk) => {
             channel,
             lnd,
             output,
+            to,
             id: parameters.id,
             unsigned: parseSignCapacityRequest(parameters).unsigned,
             vout: parameters.vout,

package/capacity/ask_for_change_details.js

@@ -1,10 +1,12 @@
 const asyncAuto = require('async/auto');
 const asyncUntil = require('async/until');
+const {connectPeer} = require('ln-sync');
 const {findKey} = require('ln-sync');
 const {getChainFeeRate} = require('ln-service');
 const {getChainTransactions} = require('ln-service');
 const {getChannel} = require('ln-service');
 const {getChannels} = require('ln-service');
+const {getNodeAlias} = require('ln-sync');
 const {getPeers} = require('ln-service');
 const {returnResult} = require('asyncjs-util');
 const {sendMessageToPeer} = require('ln-service');
@@ -16,6 +18,7 @@ const feeForReplacement = require('./fee_for_replacement');
 const {ceil} = Math;
 const dust = 550;
 const dustBuffer = 750;
+const {isArray} = Array;
 const isNumber = n => !isNaN(n);
 const largeChannelsBit = 19;
 const maxSats = 21e6 * 1e8;
@@ -40,6 +43,11 @@ const weightBuffer = 150;
     ask: <Ask Function>
     id: <Request Identifier Hex String>
     lnd: <Authenticated LND API Object>
+    nodes: [{
+      lnd: <Potential Move Node LND API Object>
+      node_name: <Potential Move Node Name String>
+      public_key: <Potential Move Node Public Key Hex String>
+    }]
   }
 
   @returns via cbk or Promise
@@ -59,6 +67,8 @@ const weightBuffer = 150;
     id: <Standard Format Channel Id String>
     increase: <Channel Capacity Increase Tokens Number>
     is_private: <Channel is Private Bool>
+    [open_from]: <Open Replacement Channel From Node with Public Key String>
+    open_lnd: <Open Replacement Channel with LND API Object>
     [open_transaction]: <Channel Open Transaction Hex String>
     partner_csv_delay: <Peer CSV Delay Number>
     partner_public_key: <Node to Ask For Capacity Change Public Key Hex String>
@@ -70,7 +80,7 @@ const weightBuffer = 150;
     transaction_id: <Channel Funding Transaction Id Hex String>
   }
 */
-module.exports = ({ask, id, lnd}, cbk) => {
+module.exports = ({ask, id, lnd, nodes}, cbk) => {
   return new Promise((resolve, reject) => {
     return asyncAuto({
       // Check arguments
@@ -87,6 +97,10 @@ module.exports = ({ask, id, lnd}, cbk) => {
           return cbk([400, 'ExpectedLndToAskForChangeDetails']);
         }
 
+        if (!isArray(nodes)) {
+          return cbk([400, 'ExpectedArrayOfPotentialMoveNodesToAskForChange']);
+        }
+
         return cbk();
       },
 
@@ -112,7 +126,7 @@ module.exports = ({ask, id, lnd}, cbk) => {
         return getChainFeeRate({lnd, confirmation_target: slowTarget}, cbk);
       }],
 
-      // Find the public key or alias entered
+      // Find the node with the public key or alias entered
       findKey: [
         'askForPeer',
         'getChannels',
@@ -126,6 +140,11 @@ module.exports = ({ask, id, lnd}, cbk) => {
         cbk);
       }],
 
+      // Get the alias of the peer
+      getAlias: ['findKey', ({findKey}, cbk) => {
+        return getNodeAlias({lnd, id: findKey.public_key}, cbk);
+      }],
+
       // Send a test message to the selected peer to confirm they are connected
       testPeer: ['findKey', 'getChannels', ({findKey, getChannels}, cbk) => {
         const hasPeer = !!getChannels.channels.find(channel => {
@@ -190,7 +209,7 @@ module.exports = ({ask, id, lnd}, cbk) => {
         return ask({
           choices,
           loop: false,
-          message: 'Channel to change capacity?',
+          message: 'Channel to change?',
           name: 'id',
           type: 'list',
         },
@@ -294,20 +313,32 @@ module.exports = ({ask, id, lnd}, cbk) => {
       }],
 
       // Choose whether to add or remove coins
-      askForDirection: ['channel', ({channel}, cbk) => {
+      askForDirection: ['channel', 'getAlias', ({channel, getAlias}, cbk) => {
+        const {alias} = getAlias;
+
+        const choices = [
+          {
+            disabled: !channel.max_increase_tokens,
+            name: `Increase capacity (currently ${channel.capacity})`,
+            value: 'increase',
+          },
+          {
+            disabled: !channel.max_decrease_tokens,
+            name: `Decrease capacity (limit ${channel.max_decrease_tokens})`,
+            value: 'decrease',
+          },
+        ];
+
+        if (!!nodes.filter(n => n.public_key !== getAlias.id).length) {
+          choices.push({
+            disabled: !channel.max_decrease_tokens,
+            name: `Move the channel with ${alias} to another of your nodes?`,
+            value: 'migrate',
+          });
+        }
+
         return ask({
-          choices: [
-            {
-              disabled: !channel.max_increase_tokens,
-              name: `Increase capacity (currently ${channel.capacity})`,
-              value: 'increase',
-            },
-            {
-              disabled: !channel.max_decrease_tokens,
-              name: `Decrease capacity (limit ${channel.max_decrease_tokens})`,
-              value: 'decrease',
-            },
-          ],
+          choices,
           message: 'How do you want to change the channel capacity?',
           name: 'direction',
           type: 'list',
@@ -315,6 +346,51 @@ module.exports = ({ask, id, lnd}, cbk) => {
         ({direction}) => cbk(null, direction));
       }],
 
+      // Ask for migration
+      askForMigration: [
+        'askForDirection',
+        'channel',
+        ({askForDirection, channel}, cbk) =>
+      {
+        // Exit early if not decrease or no saved nodes
+        if (askForDirection !== 'migrate') {
+          return cbk();
+        }
+
+        const peer = channel.partner_public_key;
+
+        const potentialNodes = nodes.filter(n => n.public_key !== peer);
+
+        return ask({
+          choices: potentialNodes.map((node, i) => ({
+            name: `${node.node_name} ${node.public_key}`,
+            value: i,
+          })),
+          message: 'Move channel to?',
+          name: 'migration',
+          type: 'list',
+        },
+        ({migration}) => cbk(null, potentialNodes[migration]));
+      }],
+
+      // Add peer from migrating node
+      connect: [
+        'askForMigration',
+        'findKey',
+        ({askForMigration, findKey}, cbk) =>
+      {
+        // Exit early if its there is no migration
+        if (!askForMigration) {
+          return cbk();
+        }
+
+        return connectPeer({
+          id: findKey.public_key,
+          lnd: askForMigration.lnd,
+        },
+        cbk);
+      }],
+
       // Ask for how much to decrease
       askForDecrease: [
         'askForDirection',
@@ -400,6 +476,7 @@ module.exports = ({ask, id, lnd}, cbk) => {
       askForPublicPrivate: [
         'askForDecrease',
         'askForIncrease',
+        'askForMigration',
         'channel',
         ({channel}, cbk) =>
       {
@@ -452,12 +529,10 @@ module.exports = ({ask, id, lnd}, cbk) => {
       {
         const {fee} = estimateChainFee;
 
-        const pay = `Pay estimated on-chain channel replacement fee: ${fee}`;
-
         return ask({
           type: 'confirm',
           name: 'proceed',
-          message: `${pay} for capacity change?`,
+          message: `Pay estimated channel replacement chain-fee: ${fee}?`,
         },
         ({proceed}) => cbk(null, proceed));
       }],
@@ -466,16 +541,20 @@ module.exports = ({ask, id, lnd}, cbk) => {
       details: [
         'askForDecrease',
         'askForIncrease',
+        'askForMigration',
         'askForPublicPrivate',
         'channel',
+        'connect',
         'confirmFeeEstimate',
         'estimateChainFee',
         'getTx',
         ({
           askForDecrease,
           askForIncrease,
+          askForMigration,
           askForPublicPrivate,
           channel,
+          connect,
           confirmFeeEstimate,
           estimateChainFee,
           getTx,
@@ -509,6 +588,7 @@ module.exports = ({ask, id, lnd}, cbk) => {
           channel: channel.id,
           decrease: !!askForDecrease ? sumOfTokens(askForDecrease) : undefined,
           increase: askForIncrease,
+          to: !!askForMigration ? askForMigration.public_key : undefined,
           type: askForPublicPrivate.is_private ? privateType : publicType,
         });
 
@@ -524,6 +604,8 @@ module.exports = ({ask, id, lnd}, cbk) => {
           id: channel.id,
           increase: askForIncrease,
           is_private: askForPublicPrivate.is_private,
+          open_from: !!askForMigration ? askForMigration.public_key : null,
+          open_lnd: !!askForMigration ? askForMigration.lnd : lnd,
           open_transaction: channel.open_transaction,
           partner_csv_delay: channel.partner_csv_delay,
           partner_public_key: channel.partner_public_key,

package/capacity/ask_to_select_change.js

@@ -0,0 +1,109 @@
+const asyncAuto = require('async/auto');
+const {getNodeAlias} = require('ln-sync');
+const {returnResult} = require('asyncjs-util');
+
+const describeCapacityChange = require('./describe_capacity_change');
+
+/** Ask to select a change
+
+  {
+    ask: <Inquirer Ask Function>
+    [address]: <Cooperative Close Address String>
+    capacity: <Channel Capacity Tokens Number>
+    channel: <Change Channel Id String>
+    [decrease]: <Capacity Change Decrease Tokens Number>
+    from_id: <Peer Public Key Hex String>
+    [increase]: <Capacity Change Increase Tokens Number>
+    lnd: <Authenticated LND API Object>
+    [to_id]: <Node Public Key Hex String>
+    [type]: <Channel Type String>
+  }
+
+  @returns via cbk or Promise
+  {
+    is_selected: <Request to Change Channel is Selected Bool>
+  }
+*/
+module.exports = (args, cbk) => {
+  return new Promise((resolve, reject) => {
+    return asyncAuto({
+      // Check arguments
+      validate: cbk => {
+        if (!args.ask) {
+          return cbk([400, 'ExpectedAskFunctionToAskToSelectChange']);
+        }
+
+        if (!args.capacity) {
+          return cbk([400, 'ExpectedChannelCapacityToAskToSelectChange']);
+        }
+
+        if (!args.channel) {
+          return cbk([400, 'ExpectedChannelIdToAskToSelectAChangeFor']);
+        }
+
+        if (!args.from_id) {
+          return cbk([400, 'ExpectedChannelPartnerPublicKeyToSelectChange']);
+        }
+
+        if (!args.lnd) {
+          return cbk([400, 'ExpectedLndApiToAskToSelectChange']);
+        }
+
+        return cbk();
+      },
+
+      // Get the peer alias
+      getPeerAlias: ['validate', ({}, cbk) => {
+        return getNodeAlias({id: args.from_id, lnd: args.lnd}, cbk);
+      }],
+
+      // Get the alias of the node to move to
+      getNodeAlias: ['validate', ({}, cbk) => {
+        // Exit early when there is no new node to move to
+        if (!args.to_id) {
+          return cbk(null, {});
+        }
+
+        return getNodeAlias({id: args.to_id, lnd: args.lnd}, cbk);
+      }],
+
+      // Confirm acceptance of the change
+      confirm: [
+        'getNodeAlias',
+        'getPeerAlias',
+        ({getNodeAlias, getPeerAlias}, cbk) =>
+      {
+        const message = describeCapacityChange({
+          capacity: args.capacity,
+          channel: args.channel,
+          decrease: args.decrease,
+          from_alias: getPeerAlias.alias,
+          from_id: args.from_id,
+          increase: args.increase,
+          to_alias: getNodeAlias.alias,
+          to_id: args.to_id,
+          type: args.type,
+        });
+
+        return args.ask({
+          message,
+          name: 'accept',
+          type: 'confirm',
+        },
+        ({accept}) => {
+          if (!accept) {
+            return cbk(null, {is_selected: false});
+          }
+
+          // Fail changing when cooperative_close_address is set
+          if (!!args.address && !args.increase) {
+            return cbk([400, 'ChannelHasLockedCoopCloseAddressSet']);
+          }
+
+          return cbk(null, {is_selected: true});
+        });
+      }],
+    },
+    returnResult({reject, resolve, of: 'confirm'}, cbk));
+  });
+};

package/capacity/capacity_change_requests.js

@@ -29,6 +29,7 @@ const privateAsType = isPrivate => isPrivate ? 1 : 0;
       from: <From Node Public Key Id Hex String>
       id: <Change Request Id Hex String>
       [increase]: <Add Capacity Tokens Number>
+      [to]: <Switch Channel to Node with Identity Public Key Hex String>
       [type]: <Change Channel Channel Type Flags Number>
     }]
   }
@@ -77,6 +78,7 @@ module.exports = ({channels, requests}) => {
         from: channel.partner_public_key,
         id: request.id,
         increase: request.increase,
+        to: request.to,
         type: type ? request.type : undefined,
       };
     });

package/capacity/change_channel_capacity.js

@@ -2,20 +2,17 @@ const asyncAuto = require('async/auto');
 const asyncDetectSeries = require('async/detectSeries');
 const asyncRetry = require('async/retry');
 const {getIdentity} = require('ln-service');
-const {getNodeAlias} = require('ln-sync');
 const {returnResult} = require('asyncjs-util');
 const {updateChannelFee} = require('ln-sync');
 
 const acceptCapacityChange = require('./accept_capacity_change');
+const askToSelectChange = require('./ask_to_select_change');
 const getCapacityChangeRequests = require('./get_capacity_change_requests');
 const initiateCapacityChange = require('./initiate_capacity_change');
 
-const describeType = type => !(type & 0) ? 'private' : 'public';
-const interval = 10 * 1000;
-const peerName = ({alias, id}) => `${alias} ${id.substring(0, 8)}`.trim();
+const interval = 1000 * 10;
+const {isArray} = Array;
 const times = 6 * 60 * 6;
-const tokensAsBigUnit = tokens => (tokens / 1e8).toFixed(8);
-const waitForCloseInterval = 1000 * 3;
 
 /** Change a channel's capacity
 
@@ -24,9 +21,14 @@ const waitForCloseInterval = 1000 * 3;
     [delay]: <Wait Time For Incoming Capacity Requests Milliseconds Number>
     lnd: <Authenticated LND API Object>
     logger: <Winston Logger Object>
+    [nodes]: [{
+      lnd: <Authenticated LND API Object>
+      named: <Node Named String.
+      public_key: <Node Identity Public Key Hex String>
+    }]
   }
 */
-module.exports = ({ask, delay, lnd, logger}, cbk) => {
+module.exports = ({ask, delay, lnd, logger, nodes}, cbk) => {
   return new Promise((resolve, reject) => {
     return asyncAuto({
       // Check arguments
@@ -43,6 +45,10 @@ module.exports = ({ask, delay, lnd, logger}, cbk) => {
           return cbk([400, 'ExpectedLoggerObjectToChangeCapacity']);
         }
 
+        if (!!nodes && !isArray(nodes)) {
+          return cbk([400, 'ExpectedArrayOfControlledNodesToChangeCapacity']);
+        }
+
         return cbk();
       },
 
@@ -83,42 +89,24 @@ module.exports = ({ask, delay, lnd, logger}, cbk) => {
         ({waitForProposal}, cbk) =>
       {
         return asyncDetectSeries(waitForProposal.requests, (request, cbk) => {
-          return getNodeAlias({lnd, id: request.from}, (err, res) => {
+          return askToSelectChange({
+            ask,
+            lnd,
+            address: request.address,
+            capacity: request.capacity,
+            channel: request.channel,
+            decrease: request.decrease,
+            from_id: request.from,
+            increase: request.increase,
+            to_id: request.to,
+            type: request.type,
+          },
+          (err, res) => {
             if (!!err) {
               return cbk(err);
             }
 
-            const change = !!request.increase ? 'Increase' : 'Decrease';
-            const delta = request.decrease || request.increase;
-            const hasType = request.type !== undefined;
-            const id = request.channel;
-            const peer = peerName(res);
-            const size = tokensAsBigUnit(request.capacity);
-
-
-            const action = `${change} capacity ${size} channel ${id}`;
-            const by = !!delta ? ` by ${tokensAsBigUnit(delta)}` : '';
-            const type = hasType ? describeType(request.type) : '';
-
-            const changeType = hasType ? ` and make channel ${type}` : '';
-
-            return ask({
-              type: 'confirm',
-              name: 'accept',
-              message: `${action} with ${peer}${by}${changeType}?`,
-            },
-            ({accept}) => {
-              if (!accept) {
-                return cbk(null, false);
-              }
-
-              // Fail changing when cooperative_close_address is set
-              if (!!request.address && !!request.increase) {
-                return cbk([400, 'ChannelHasLockedCoopCloseAddressSet']);
-              }
-
-              return cbk(null, true);
-            });
+            return cbk(null, res.is_selected);
           });
         },
         cbk);
@@ -138,17 +126,30 @@ module.exports = ({ask, delay, lnd, logger}, cbk) => {
           from: askToSelectChange.from,
           id: askToSelectChange.id,
           increase: askToSelectChange.increase,
+          to: askToSelectChange.to || askToSelectChange.from,
         },
         cbk);
       }],
 
       // Initiate a capacity change
-      initiateChange: ['askToSelectChange', ({askToSelectChange}, cbk) => {
+      initiateChange: [
+        'askToSelectChange',
+        'getIdentity',
+        ({askToSelectChange, getIdentity}, cbk) =>
+      {
         if (!!askToSelectChange) {
           return cbk();
         }
 
-        return initiateCapacityChange({ask, lnd, logger}, cbk);
+        return initiateCapacityChange({
+          ask,
+          lnd,
+          logger,
+          nodes: (nodes || []).filter(node => {
+            return node.public_key !== getIdentity.public_key;
+          }),
+        },
+        cbk);
       }],
 
       // Reset the channel routing policies
@@ -164,11 +165,11 @@ module.exports = ({ask, delay, lnd, logger}, cbk) => {
 
         return asyncRetry({interval, times}, cbk => {
           return updateChannelFee({
-            lnd,
             base_fee_mtokens: policy.base_fee_mtokens,
             cltv_delta: policy.cltv_delta,
             fee_rate: policy.fee_rate,
-            from: getIdentity.public_key,
+            from: policy.open_from || getIdentity.public_key,
+            lnd: policy.open_lnd || lnd,
             transaction_id: policy.transaction_id,
             transaction_vout: policy.transaction_vout,
           },

package/capacity/describe_capacity_change.js

@@ -0,0 +1,38 @@
+const describeType = type => !(type & 1) ? 'private' : 'public';
+const peerName = ({alias, id}) => `${alias} ${id.substring(0, 8)}`.trim();
+const tokensAsBigUnit = tokens => (tokens / 1e8).toFixed(8);
+
+/** Describe a capacity change
+
+  {
+    capacity: <Channel Capacity Tokens Number>
+    channel: <Change Channel Id String>
+    [decrease]: <Capacity Change Decrease Tokens Number>
+    from_alias: <Peer Alias String>
+    from_id: <Peer Public Key Hex String>
+    [increase]: <Capacity Change Increase Tokens Number>
+    [to_alias]: <Node Alias String>
+    [to_id]: <Node Public Key Hex String>
+    [type]: <Channel Type String>
+  }
+
+  @returns
+  <Capacity Change Description String>
+*/
+module.exports = args => {
+  const change = !!args.increase ? 'Increase' : 'Decrease';
+  const delta = args.decrease || args.increase;
+  const hasType = args.type !== undefined;
+  const newPeer = peerName({alias: args.to_alias, id: args.to_id || ''});
+  const peer = peerName({alias: args.from_alias, id: args.from_id});
+  const size = tokensAsBigUnit(args.capacity);
+
+  const action = `${change} capacity ${size} channel ${args.channel}`;
+  const by = !!delta ? ` by ${tokensAsBigUnit(delta)}` : '';
+  const move = !!args.to_id ? ` and move channel to ${newPeer}` : '';
+  const type = hasType ? describeType(args.type) : '';
+
+  const changeType = hasType ? ` and make channel ${type}` : '';
+
+  return `${action} with ${peer}${by}${move}${changeType}?`;
+};

package/capacity/encode_change_request.js

@@ -1,12 +1,16 @@
 const {encodeBigSize} = require('bolt01');
+const {encodeTlvRecord} = require('bolt01');
 const {rawChanId} = require('bolt07');
 
 const channelFlagsType = '5';
 const channelIdRecordType = '2';
+const currentVersion = '1';
 const decreaseRecordType = '3';
 const increaseRecordType = '4';
+const migrateRecordType = '6';
 const requestIdRecordType = '1';
 const typeAsHex = type => Buffer.from([type]).toString('hex');
+const versionRecordType = '0';
 
 /** Encode a request to change a channel capacity
 
@@ -15,6 +19,7 @@ const typeAsHex = type => Buffer.from([type]).toString('hex');
     [decrease]: <Remove Channel Funds By Tokens Number>
     id: <Request Id Hex String>
     increase: <Add Channel Funds By Tokens Number>
+    [to]: <Move Channel to Different Node with Public Key Hex String>
     type: <New Channel Type Number>
   }
 
@@ -26,8 +31,12 @@ const typeAsHex = type => Buffer.from([type]).toString('hex');
     }]
   }
 */
-module.exports = ({channel, decrease, id, increase, type}) => {
+module.exports = ({channel, decrease, id, increase, to, type}) => {
   const records = [
+    {
+      type: versionRecordType,
+      value: encodeBigSize({number: currentVersion}).encoded,
+    },
     {
       type: requestIdRecordType,
       value: id,
@@ -42,21 +51,26 @@ module.exports = ({channel, decrease, id, increase, type}) => {
     },
   ];
 
+  // Add a record reflecting the decrease in the capacity
   if (!!decrease) {
-    // Add a record reflecting the decrease in the capacity
     records.push({
       type: decreaseRecordType,
       value: encodeBigSize({number: decrease.toString()}).encoded,
     });
   }
 
+  // Add a record reflecting the increase in the capacity
   if (!!increase) {
-    // Add a record reflecting the increase in the capacity
     records.push({
       type: increaseRecordType,
       value: encodeBigSize({number: increase.toString()}).encoded,
     });
   }
 
+  // Add a record reflecting the migration of channel to a different peer
+  if (!!to) {
+    records.push({type: migrateRecordType, value: to});
+  }
+
   return {records};
 };

package/capacity/get_capacity_change_requests.js

@@ -28,6 +28,7 @@ const waitForRequestsTimeoutMs = 5000;
       from: <From Node Public Key Id Hex String>
       id: <Change Request Id Hex String>
       [increase]: <Add Capacity Tokens Number>
+      [to]: <Switch Channel to Node with Identity Public Key Hex String>
       [type]: <Intended Replacement Channel Channel Type Flags Number>
     }]
   }