paid-services 6.1.6 → 6.2.0

package/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Versions
 
-## Version 6.1.6
+## Version 6.2.0
+
+- `createGroupFanout`, `joinGroupFanout`: Add methods to make and join fanouts
+
+## Version 6.1.7
 
 - `manageSwap`: Add support for Loop Out to external address
 

package/groups/fanout/coordinate_fanout.js

@@ -208,7 +208,7 @@ module.exports = ({capacity, count, ecp, identity, lnd, members, rate}) => {
     return res.success({records});
   });
 
-  // Listen for and respond to pending open registrations
+  // Listen for and respond to fanout proposal registrations
   service.request({type: serviceTypeRegisterPendingFanout}, (req, res) => {
     if (!isArray(req.records)) {
       return res.failure([400, 'ExpectedArrayOfRecordsForPendingFanout']);

package/groups/fanout/create_group_fanout.js

@@ -121,12 +121,14 @@ module.exports = (args, cbk) => {
         return getChainBalance({lnd: args.lnd}, cbk);
       }],
 
+      // Get identity public key to include self in the group
+      getIdentity: ['validate', ({}, cbk) => {
+        return getIdentity({lnd: args.lnd}, cbk);
+      }],
+
       // Get UTXOs to use for input selection and final fee rate calculation
       getUtxos: ['validate', ({}, cbk) => getUtxos({lnd: args.lnd}, cbk)],
 
-      // Get identity public key
-      getIdentity: ['validate', ({}, cbk) => getIdentity({lnd: args.lnd}, cbk)],
-
       // Get methods to confim partial signing is supported
       getMethods: ['validate', ({}, cbk) => getMethods({lnd: args.lnd}, cbk)],
 
@@ -150,7 +152,7 @@ module.exports = (args, cbk) => {
         return cbk();
       }],
 
-      // Select inputs to spend
+      // Interactively select inputs to spend
       utxos: ['getUtxos', ({getUtxos}, cbk) => {
         // Exit early when UTXOs are all specified already
         if (!!args.inputs.length) {
@@ -162,7 +164,7 @@ module.exports = (args, cbk) => {
           return cbk(null, []);
         }
 
-        // Only selecting confirmed utxos is supported
+        // Only selecting confirmed P2TR or P2WPKH UTXOs is supported
         const utxos = getUtxos.utxos
           .filter(n => !!n.confirmation_count)
           .filter(n => allowedAddressFormats.includes(n.address_format));
@@ -178,6 +180,7 @@ module.exports = (args, cbk) => {
             value: asOutpoint(utxo),
           })),
           loop: false,
+          message: 'Select UTXOs to spend',
           name: 'inputs',
           type: 'checkbox',
           validate: input => {

package/groups/fanout/get_fanout_funding.js

@@ -128,6 +128,7 @@ module.exports = ({capacity, inputs, lnd, outputs, rate}, cbk) => {
       fund: ['getAddresses', 'spend', ({getAddresses, spend}, cbk) => {
         return fundPsbt({
           lnd,
+          change_format: format,
           inputs: spend.map(input => ({
             transaction_id: input.transaction_id,
             transaction_vout: input.transaction_vout,

package/groups/fanout/join_group_fanout.js

@@ -89,8 +89,23 @@ module.exports = (args, cbk) => {
         return cbk();
       }],
 
+      // Decode the group invite code and get group details
+      getJoinDetails: ['confirmSigner', ({}, cbk) => {
+        return confirmFanoutJoin({
+          code: args.code,
+          count: args.output_count,
+          lnd: args.lnd,
+          logger: args.logger,
+        },
+        cbk);
+      }],
+
       // Select inputs to spend
-      utxos: ['getUtxos', ({getUtxos}, cbk) => {
+      utxos: [
+        'getJoinDetails',
+        'getUtxos',
+        ({getJoinDetails, getUtxos}, cbk) =>
+      {
         // Exit early when UTXOs are all specified already
         if (!!args.inputs.length) {
           return cbk(null, args.inputs);
@@ -117,6 +132,7 @@ module.exports = (args, cbk) => {
             value: asOutpoint(utxo),
           })),
           loop: false,
+          message: 'Select UTXOs to spend',
           name: 'inputs',
           type: 'checkbox',
           validate: input => {
@@ -129,7 +145,7 @@ module.exports = (args, cbk) => {
               return utxos.find(n => asOutpoint(n) === utxo.value).tokens;
             }));
 
-            const capacity = args.capacity * args.output_count;
+            const capacity = getJoinDetails.capacity * args.output_count;
 
             const missingTok = asBigUnit(capacity - tokens);
 
@@ -143,17 +159,6 @@ module.exports = (args, cbk) => {
         ({inputs}) => cbk(null, inputs));
       }],
 
-      // Decode the group invite code and get group details
-      getJoinDetails: ['confirmSigner', 'utxos', ({}, cbk) => {
-        return confirmFanoutJoin({
-          code: args.code,
-          count: args.output_count,
-          lnd: args.lnd,
-          logger: args.logger,
-        },
-        cbk);
-      }],
-
       // Join the fanout group
       join: [
         'confirmSigner',

package/groups/index.js

@@ -1,5 +1,13 @@
 const createGroupChannel = require('./create_group_channel');
+const {createGroupFanout} = require('./fanout');
 const joinGroupChannel = require('./join_group_channel');
+const {joinGroupFanout} = require('./fanout');
 const manageGroupJoin = require('./manage_group_join');
 
-module.exports = {createGroupChannel, joinGroupChannel, manageGroupJoin};
+module.exports = {
+  createGroupChannel,
+  createGroupFanout,
+  joinGroupChannel,
+  joinGroupFanout,
+  manageGroupJoin,
+};

package/package.json

@@ -15,9 +15,9 @@
     "bolt01": "2.0.0",
     "bolt07": "1.9.4",
     "ecpair": "2.1.0",
-    "goldengate": "14.0.8",
+    "goldengate": "14.0.9",
     "invoices": "3.0.0",
-    "ln-service": "57.20.2",
+    "ln-service": "57.22.0",
     "ln-sync": "6.4.0",
     "psbt": "3.0.0",
     "p2tr": "2.0.0",
@@ -48,5 +48,5 @@
     "integration-tests": "tap -j 2 --branches=1 --functions=1 --lines=1 --statements=1 -t 2700 test/integration/*.js",
     "test": "tap --branches=1 --functions=1 --lines=1 --statements=1 -t 60 test/actions/*.js test/balanced/*.js test/capacity/*.js test/client/*.js test/config/*.js test/p2p/*.js test/records/*.js test/respond/*.js test/server/*.js test/swaps/*.js test/services/*.js test/trades/*.js"
   },
-  "version": "6.1.6"
+  "version": "6.2.0"
 }

package/test/integration/test_fanout.js

@@ -1,8 +1,10 @@
 const {once} = require('events');
 
 const {addPeer} = require('ln-service');
+const asyncEach = require('async/each');
 const asyncMap = require('async/map');
 const asyncRetry = require('async/retry');
+const {componentsOfTransaction} = require('@alexbosworth/blockchain');
 const {createChainAddress} = require('ln-service');
 const {getChainTransactions} = require('ln-service');
 const {getNetwork} = require('ln-sync');
@@ -21,11 +23,14 @@ const asOutpoint = utxo => `${utxo.transaction_id}:${utxo.transaction_vout}`;
 const capacity = 1e5;
 const count = 101;
 const feeRate = 1;
+const format = 'p2tr';
 const interval = 10;
 const outputCount = 2;
+const outputCountControl = 4;
 const size = 3;
 const tokens = 1e6;
 const times = 2000;
+const uniq = arr => Array.from(new Set(arr));
 
 // Make a joint transaction fanout group
 test(`Setup joint fanout group`, async ({end, equal, strictSame}) => {
@@ -52,10 +57,7 @@ test(`Setup joint fanout group`, async ({end, equal, strictSame}) => {
     await sendToChainAddress({lnd, tokens, address: targetAddress.address});
 
     // Create a remote chain address
-    const remoteAddress = await createChainAddress({
-      format: 'p2tr',
-      lnd: remote.lnd,
-    });
+    const remoteAddress = await createChainAddress({format, lnd: remote.lnd});
 
     // Send coins to remote
     await sendToChainAddress({lnd, tokens, address: remoteAddress.address});
@@ -102,15 +104,17 @@ test(`Setup joint fanout group`, async ({end, equal, strictSame}) => {
     // Get utxos of the coordinator
     const controlUtxos = await getUtxos({lnd: control.lnd});
 
+    const [utxoForControl] = controlUtxos.utxos.map(asOutpoint).reverse();
+
     // Start the coordination
     const assemble = assembleGroup({
       capacity,
       ecp,
       count: nodes.length,
       identity: control.id,
-      inputs: controlUtxos.utxos.map(n => asOutpoint(n)),
+      inputs: [utxoForControl],
       lnd: control.lnd,
-      outputs: outputCount,
+      outputs: outputCountControl,
       rate: feeRate,
     });
 
@@ -148,22 +152,60 @@ test(`Setup joint fanout group`, async ({end, equal, strictSame}) => {
     // Transaction ids of the open should be returned
     const ids = joins.map(n => n.id);
 
+    strictSame(uniq(ids).length, 1, 'Only one transaction id');
+
     // Finished, wait for confirmations on fanout utxos
     await generate({count});
 
+    const expected = [
+      {
+        lnd: control.lnd,
+        count: outputCountControl,
+      },
+      {
+        lnd: target.lnd,
+        count: outputCount,
+      },
+      {
+        lnd: remote.lnd,
+        count: outputCount,
+      },
+    ];
+
     // Check if the expected utxos are confirmed
     await asyncRetry({interval, times}, async () => {
-      await Promise.all(nodes.map(async ({lnd}) => {
+      await asyncEach(expected, async ({count, lnd}) => {
+        const [txId] = ids;
         const {utxos} = await getUtxos({lnd, min_confirmations: 1});
 
-        const utxosCount = utxos.filter(n => n.tokens === capacity).length;
+        const utxosCount = utxos
+          .filter(n => n.transaction_id === txId)
+          .filter(n => n.tokens === capacity)
+          .length;
 
-        if (outputCount !== utxosCount) {
-          throw new Error('ExpectedCorrectFanoutUtxoCount');
-        }
-      }));
+        strictSame(utxosCount, count, 'Got expected UTXOs count');
+      });
     });
 
+    const components = componentsOfTransaction({
+      transaction: events.broadcast.transaction,
+    });
+
+    const controlExtra = components.outputs.find(n => n.tokens === 4999599712);
+    const fundedOuts = components.outputs.filter(n => n.tokens === capacity);
+
+    const changeOutput1 = components.outputs
+      .find(n => n.tokens === 799798 || n.tokens === 799799);
+
+    const changeOutput2 = components.outputs
+      .find(n => n.tokens === 799809 || n.tokens === 799810);
+
+    strictSame(components.inputs.length, 3, 'Got expected inputs count');
+    strictSame(components.outputs.length, 11, 'Got expected outputs count');
+    strictSame(fundedOuts.length, 8, 'Got expected funded outputs count');
+    strictSame(!!changeOutput1, true, 'Got change output 1');
+    strictSame(!!changeOutput2, true, 'Got change output 2');
+    strictSame(!!controlExtra, true, 'Got control change output');
     strictSame(ids, [events.broadcast.id, events.broadcast.id], 'Got tx ids');
     strictSame(events.broadcast.id.length, 64, 'Got broadcast tx id');
     strictSame(!!events.broadcast.transaction, true, 'Got broadcast tx');