paid-services 3.4.0 → 3.5.0

package/.prettierignore

@@ -0,0 +1,2 @@
+bos
+*.js

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## Version 3.5.0
+
+- `changeChannelCapacity`: Allow changing private/public status of channel
+
 ## Version 3.4.0
 
 - `changeChannelCapacity`: Fix broken preservation of channel announce status

package/capacity/ask_for_change_details.js

@@ -24,6 +24,8 @@ const minNewLocalBalance = 0;
 const nonNegative = n => Math.max(0, n);
 const outputSize = 44;
 const positive = n => Math.max(1, n);
+const privateType = 1;
+const publicType = 0;
 const slowTarget = 1000;
 const sumOf = arr => arr.reduce((sum, n) => sum + n, 0);
 const sumOfTokens = arr => arr.reduce((sum, n) => sum + n.tokens, 0);
@@ -395,10 +397,37 @@ module.exports = ({ask, id, lnd}, cbk) => {
         ({amount}) => cbk(null, Number(amount)));
       }],
 
+      // Confirm or change the announce status of the replacement channel
+      askForPublicPrivate: [
+        'askForDecrease',
+        'askForIncrease',
+        'channel',
+        ({channel}, cbk) =>
+      {
+        return ask({
+          choices: ['Public', 'Private'].map(type => {
+            const isPrivate = type === 'Private';
+
+            // Exit early when the type would be different
+            if (isPrivate !== channel.is_private) {
+              return type;
+            }
+
+            return `${type} (Keep Current Status)`;
+          }),
+          default: channel.is_private ? 'Private' : 'Public',
+          message: 'Channel type?',
+          name: 'type',
+          type: 'list',
+        },
+        ({type}) => cbk(null, {is_private: type === 'Private'}));
+      }],
+
       // Estimate the chain fee
       estimateChainFee: [
         'askForDecrease',
         'askForIncrease',
+        'askForPublicPrivate',
         'channel',
         'getFeeRate',
         ({askForDecrease, askForIncrease, channel, getFeeRate}, cbk) =>
@@ -417,6 +446,7 @@ module.exports = ({ask, id, lnd}, cbk) => {
 
       // Confirm chain fee payment estimate
       confirmFeeEstimate: [
+        'askForPublicPrivate',
         'channel',
         'estimateChainFee',
         ({channel, estimateChainFee}, cbk) =>
@@ -437,6 +467,7 @@ module.exports = ({ask, id, lnd}, cbk) => {
       details: [
         'askForDecrease',
         'askForIncrease',
+        'askForPublicPrivate',
         'channel',
         'confirmFeeEstimate',
         'estimateChainFee',
@@ -444,6 +475,7 @@ module.exports = ({ask, id, lnd}, cbk) => {
         ({
           askForDecrease,
           askForIncrease,
+          askForPublicPrivate,
           channel,
           confirmFeeEstimate,
           estimateChainFee,
@@ -478,6 +510,7 @@ module.exports = ({ask, id, lnd}, cbk) => {
           channel: channel.id,
           decrease: !!askForDecrease ? sumOfTokens(askForDecrease) : undefined,
           increase: askForIncrease,
+          type: askForPublicPrivate.is_private ? privateType : publicType,
         });
 
         return cbk(null, {
@@ -491,7 +524,7 @@ module.exports = ({ask, id, lnd}, cbk) => {
           fee_rate: channel.fee_rate,
           id: channel.id,
           increase: askForIncrease,
-          is_private: channel.is_private,
+          is_private: askForPublicPrivate.is_private,
           open_transaction: channel.open_transaction,
           partner_csv_delay: channel.partner_csv_delay,
           partner_public_key: channel.partner_public_key,

package/capacity/capacity_change_requests.js

@@ -1,3 +1,5 @@
+const privateAsType = isPrivate => isPrivate ? 1 : 0;
+
 /** Map change requests to requests considering local channels
 
   {
@@ -13,6 +15,7 @@
       from: <From Node Public Key Id Hex String>
       id: <Change Request Id Hex String>
       [increase]: <Add Capacity Tokens Number>
+      [type]: <Intended Replacement Channel Channel Type Flags Number>
     }]
   }
 
@@ -26,6 +29,7 @@
       from: <From Node Public Key Id Hex String>
       id: <Change Request Id Hex String>
       [increase]: <Add Capacity Tokens Number>
+      [type]: <Change Channel Channel Type Flags Number>
     }]
   }
 */
@@ -61,6 +65,10 @@ module.exports = ({channels, requests}) => {
     .map(request => {
       const channel = channels.find(chan => chan.id === request.channel);
 
+      const currentType = privateAsType(channel.is_private);
+
+      const type = request.type !== undefined && request.type !== currentType;
+
       return {
         address: channel.cooperative_close_address,
         capacity: channel.capacity,
@@ -69,6 +77,7 @@ module.exports = ({channels, requests}) => {
         from: channel.partner_public_key,
         id: request.id,
         increase: request.increase,
+        type: type ? request.type : undefined,
       };
     });
 

package/capacity/change_channel_capacity.js

@@ -10,6 +10,7 @@ const acceptCapacityChange = require('./accept_capacity_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 times = 6 * 60 * 6;
@@ -89,17 +90,22 @@ module.exports = ({ask, delay, lnd, logger}, cbk) => {
 
             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}?`,
+              message: `${action} with ${peer}${by}${changeType}?`,
             },
             ({accept}) => {
               if (!accept) {

package/capacity/encode_change_request.js

@@ -1,10 +1,12 @@
 const {encodeBigSize} = require('bolt01');
 const {rawChanId} = require('bolt07');
 
+const channelFlagsType = '5';
 const channelIdRecordType = '2';
 const decreaseRecordType = '3';
 const increaseRecordType = '4';
 const requestIdRecordType = '1';
+const typeAsHex = type => Buffer.from([type]).toString('hex');
 
 /** Encode a request to change a channel capacity
 
@@ -13,6 +15,7 @@ const requestIdRecordType = '1';
     [decrease]: <Remove Channel Funds By Tokens Number>
     id: <Request Id Hex String>
     increase: <Add Channel Funds By Tokens Number>
+    type: <New Channel Type Number>
   }
 
   @returns
@@ -23,7 +26,7 @@ const requestIdRecordType = '1';
     }]
   }
 */
-module.exports = ({channel, decrease, id, increase}) => {
+module.exports = ({channel, decrease, id, increase, type}) => {
   const records = [
     {
       type: requestIdRecordType,
@@ -33,6 +36,10 @@ module.exports = ({channel, decrease, id, increase}) => {
       type: channelIdRecordType,
       value: rawChanId({channel}).id,
     },
+    {
+      type: channelFlagsType,
+      value: typeAsHex(type),
+    },
   ];
 
   if (!!decrease) {

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>
+      [type]: <Intended Replacement Channel Channel Type Flags Number>
     }]
   }
 */

package/capacity/get_capacity_replacement.js

@@ -266,6 +266,7 @@ module.exports = (args, cbk) => {
             give_tokens: pendingChannel.remote_balance,
             is_private: args.is_private,
             partner_public_key: pendingChannel.partner_public_key,
+            is_private: args.is_private,
           }],
           is_avoiding_broadcast: true,
           lnd: args.lnd,

package/capacity/initiate_capacity_change.js

@@ -438,7 +438,7 @@ module.exports = ({ask, lnd, logger}, cbk) => {
           increase_transaction_id: getFunding.id,
           increase_transaction_vout: getFunding.vout,
           increase_witness_script: getFunding.script,
-          is_private: channel.is_private,
+          is_private: askForChangeDetails.is_private,
           open_transaction: sendBasicRequest,
           partner_public_key: askForChangeDetails.partner_public_key,
           transaction_id: channel.transaction_id,

package/capacity/parse_capacity_change_request.js

@@ -4,6 +4,7 @@ const {decodeBigSize} = require('bolt01');
 const channelIdHexLength = 16;
 const decodeNumber = encoded => BigInt(decodeBigSize({encoded}).decoded);
 const defaultRecord = {value: '00'};
+const hexAsNumber = n => Buffer.from(n, 'hex').readUInt8();
 const idHexLength = 64;
 const tooLarge = BigInt(Number.MAX_SAFE_INTEGER);
 
@@ -11,6 +12,7 @@ const findChannelRecord = records => records.find(n => n.type === '2');
 const findDecreaseRecord = records => records.find(n => n.type === '3');
 const findIncreaseRecord = records => records.find(n => n.type === '4');
 const findRequestIdRecord = records => records.find(n => n.type === '1');
+const findTypeRecord = records => records.find(n => n.type === '5');
 const findVersionRecord = records => records.find(n => n.type === '0');
 
 /** Parse a capacity change request
@@ -31,6 +33,7 @@ const findVersionRecord = records => records.find(n => n.type === '0');
       from: <From Node Public Key Id Hex String>
       id: <Change Request Id Hex String>
       [increase]: <Add Capacity Tokens Number>
+      [type]: <Intended Replacement Channel Channel Type Flags Number>
     }
   }
 */
@@ -52,6 +55,7 @@ module.exports = ({from, records}) => {
     return {};
   }
 
+  // Make sure the channel id is a regular one
   try {
     chanFormat({id: channelRecord.value});
   } catch (err) {
@@ -67,6 +71,7 @@ module.exports = ({from, records}) => {
 
   const decreaseRecord = findDecreaseRecord(records);
   const increaseRecord = findIncreaseRecord(records);
+  const typeRecord = findTypeRecord(records);
 
   // Exit early when there is a change in both directions
   if (!!decreaseRecord && !!increaseRecord) {
@@ -75,10 +80,11 @@ module.exports = ({from, records}) => {
 
   const {channel} = chanFormat({id: channelRecord.value});
   const id = idRecord.value;
+  const type = typeRecord ? hexAsNumber(typeRecord.value) : undefined;
 
   // Exit early when there is no decrease or increase
   if (!decreaseRecord && !increaseRecord) {
-    return {request: {channel, from, id}};
+    return {request: {channel, from, id, type}};
   }
 
   const decrease = decodeNumber((decreaseRecord || defaultRecord).value);
@@ -94,6 +100,7 @@ module.exports = ({from, records}) => {
       channel,
       from,
       id,
+      type,
       decrease: Number(decrease) || undefined,
       increase: Number(increase) || undefined,
     },

package/capacity/propose_capacity_change.js

@@ -122,6 +122,7 @@ module.exports = (args, cbk) => {
           id: args.channel,
           is_private: args.is_private,
           increase: args.increase,
+          is_private: args.is_private,
           lnd: args.lnd,
           open_transaction: args.open_transaction,
           transaction_id: args.transaction_id,

package/package.json

@@ -40,5 +40,5 @@
     "integration-tests": "tap --branches=1 --functions=1 --lines=1 --statements=1 -t 120 test/integration/*.js",
     "test": "tap --branches=1 --functions=1 --lines=1 --statements=1 -t 60 test/actions/*.js test/capacity/*.js test/client/*.js test/config/*.js test/p2p/*.js test/records/*.js test/respond/*.js test/server/*.js test/server/*.js test/services/*.js test/trades/*.js"
   },
-  "version": "3.4.0"
+  "version": "3.5.0"
 }

package/test/capacity/test_capacity_change_requests.js

@@ -34,6 +34,7 @@ const tests = [
         from: Buffer.alloc(33, 3).toString('hex'),
         id: Buffer.alloc(32).toString('hex'),
         increase: undefined,
+        type: undefined,
       }],
     },
   },

package/test/capacity/test_encode_change_request.js

@@ -8,6 +8,7 @@ const makeArgs = overrides => {
     decrease: 0,
     id: Buffer.alloc(32).toString('hex'),
     increase: undefined,
+    type: 1,
   };
 
   Object.keys(overrides).forEach(k => args[k] = overrides[k]);
@@ -29,6 +30,10 @@ const tests = [
           type: '2',
           value: '0000000000000000',
         },
+        {
+          type: '5',
+          value: '01',
+        },
       ],
     },
   },

package/test/capacity/test_parse_capacity_change_request.js

@@ -31,6 +31,7 @@ const tests = [
         channel: '102x1x0',
         from: '0218819f4e0dbab6c6bc434913bace0b69f20d832f68934acd72fc610a9b76fe30',
         id: '2bf4a6bf1b97aff5bbb760f1aa7a5705c885194b4e29d42e5576498107f02361',
+        type: undefined,
       },
     },
   },

package/test/integration/test_change_channel_capacity.js

@@ -104,6 +104,10 @@ test(`Accept capacity replacement`, async ({end, equal, strictSame}) => {
               return cbk({query: target.id});
             }
 
+            if (args.name === 'type') {
+              return cbk({type: args.default});
+            }
+
             throw new Error('UnknownQueryNameForInitiator');
           },
           logger: {error: log, info: log},

package/test/integration/test_decrease_channel_capacity.js

@@ -47,11 +47,13 @@ test(`Decrease capacity replacement`, async ({end, equal, strictSame}) => {
 
   try {
     // Open up a new channel
-    const channelOpen = await openChannel({
-      lnd,
-      local_tokens: capacity,
-      partner_public_key: target.id,
-      partner_socket: target.socket,
+    const channelOpen = await asyncRetry({interval, times}, async () => {
+      return await openChannel({
+        lnd,
+        local_tokens: capacity,
+        partner_public_key: target.id,
+        partner_socket: target.socket,
+      });
     });
 
     // Wait for the channel to be active
@@ -116,6 +118,10 @@ test(`Decrease capacity replacement`, async ({end, equal, strictSame}) => {
               return cbk({query: target.id});
             }
 
+            if (args.name === 'type') {
+              return cbk({type: 'Private'});
+            }
+
             throw new Error('UnexpectedQueryNameForProposingSide');
           },
         });
@@ -159,7 +165,9 @@ test(`Decrease capacity replacement`, async ({end, equal, strictSame}) => {
           interval: slow,
         },
         async () => {
-          const [channel] = (await getChannels({lnd, is_active: true})).channels.filter(n => n.capacity < capacity);
+          const {channels} = await getChannels({lnd, is_active: true});
+
+          const [channel] = channels.filter(n => n.capacity < capacity);
 
           await generate({});
 
@@ -167,6 +175,8 @@ test(`Decrease capacity replacement`, async ({end, equal, strictSame}) => {
             throw new Error('ExpectedChannelActivation');
           }
 
+          equal(channel.is_private, true, 'Channel is changed to private');
+
           {
             const {policies} = await getChannel({lnd, id: channel.id});
 

package/test/integration/test_increase_channel_capacity.js

@@ -111,6 +111,10 @@ test(`Accept capacity replacement`, async ({end, equal, strictSame}) => {
               return cbk({query: target.id});
             }
 
+            if (args.name === 'type') {
+              return cbk({type: args.default});
+            }
+
             throw new Error('UnexpectedQueryNameForProposingSide');
           },
         });