ln-docker-daemons 3.1.6 → 4.0.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Versions
 
+## 4.0.0
+
+- `spawnLightningCluster`: Return `tower` for the watchtower server socket
+- `spawnLightningDocker`: Add `tower_port` to specify watchtower server port
+- `spawnLightningDocker`: Return `tower_socket` for the watchtower socket
+
+### Breaking Changes
+
+- `spawnLightningDocker`: `tower_port` is now a required argument
+
 ## 3.1.6
 
 - Change default LND version to v0.15.5-beta

package/README.md

@@ -139,6 +139,7 @@ Spawn a cluster of nodes
         lnd: <Authenticated LND API Object>
         rpc: <RPC Connection Function> ({macaroon}) => {}
         socket: <Node Socket String>
+        tower: <LND Tower Socket Host:Port Network Address String>
       }]
     }
 
@@ -173,6 +174,7 @@ Spawn an LND Docker
       generate_address: <Generate Blocks to Address String>
       lightning_p2p_port: <Lightning Network P2P Listen Port Number>
       lightning_rpc_port: <Lightning Node RPC Port Number>
+      lightning_tower_port: <Lightning Tower Port Number>
       [lnd_configuration]: [<LND Configuration Argument String>]
       [seed]: <Mnemonic Seed String>
     }
@@ -187,4 +189,5 @@ Spawn an LND Docker
       macaroon: <LND Base64 Serialized Macaroon String>
       public_key: <Identity Public Key Hex String>
       socket: <LND RPC Host:Port Network Address String>
+      tower_socket: <LND Tower Socket Host:Port Network Address String>
     }

package/cluster/spawn_lightning_cluster.js

@@ -20,7 +20,7 @@ const interval = 10;
 const makeAddress = ({lnd}) => createChainAddress({lnd});
 const maturity = 100;
 const pairs = n => n.map((x, i) => n.slice(i + 1).map(y => [x, y])).flat();
-const portsPerLnd = 6;
+const portsPerLnd = 7;
 const startPort = 1025;
 const times = 3000;
 
@@ -40,6 +40,7 @@ const times = 3000;
       lnd: <Authenticated LND API Object>
       rpc: <RPC Connection Function> ({macaroon}) => {}
       socket: <Node Socket String>
+      tower: <LND Tower Socket Host:Port Network Address String>
     }]
   }
 */
@@ -67,6 +68,7 @@ module.exports = (args, cbk) => {
               chainZmqTxPort,
               lightningP2pPort,
               lightningRpcPort,
+              lightningTowerPort,
             ] = ports;
 
             const lightningDocker = await spawnLightningDocker({
@@ -77,6 +79,7 @@ module.exports = (args, cbk) => {
               generate_address: generateAddress,
               lightning_p2p_port: lightningP2pPort,
               lightning_rpc_port: lightningRpcPort,
+              lightning_tower_port: lightningTowerPort,
               lnd_configuration: args.lnd_configuration,
             });
 
@@ -133,6 +136,7 @@ module.exports = (args, cbk) => {
                 return {lnd};
               },
               socket: lightningDocker.ln_socket,
+              tower: lightningDocker.tower_socket,
             };
           });
         });
@@ -158,6 +162,7 @@ module.exports = (args, cbk) => {
             lnd: node.lnd,
             rpc: node.rpc,
             socket: node.socket,
+            tower: node.tower,
           })),
         };
       }],

package/lnd/spawn_lightning_docker.js

@@ -18,6 +18,7 @@ const spawnLndDocker = require('./spawn_lnd_docker');
     generate_address: <Generate Blocks to Address String>
     lightning_p2p_port: <Lightning Network P2P Listen Port Number>
     lightning_rpc_port: <Lightning Node RPC Port Number>
+    lightning_tower_port: <Lightning Tower Port Number>
     [lnd_configuration]: [<LND Configuration Argument String>]
     [seed]: <Mnemonic Seed String>
   }
@@ -34,6 +35,7 @@ const spawnLndDocker = require('./spawn_lnd_docker');
     macaroon: <LND Base64 Serialized Macaroon String>
     public_key: <Identity Public Key Hex String>
     socket: <LND RPC Host:Port Network Address String>
+    tower_socket: <LND Tower Socket Host:Port Network Address String>
   }
 */
 module.exports = (args, cbk) => {
@@ -69,6 +71,10 @@ module.exports = (args, cbk) => {
           return cbk([400, 'ExpectedLnRpcPortToSpawnLightningDocker']);
         }
 
+        if (!args.lightning_tower_port) {
+          return cbk([400, 'ExpectedLnTowerPortToSpawnLightningDocker']);
+        }
+
         return cbk();
       },
 
@@ -110,6 +116,7 @@ module.exports = (args, cbk) => {
           bitcoind_zmq_tx_port: args.chain_zmq_tx_port,
           p2p_port: args.lightning_p2p_port,
           rpc_port: args.lightning_rpc_port,
+          tower_port: args.lightning_tower_port,
           seed: args.seed,
         },
         cbk);
@@ -150,6 +157,7 @@ module.exports = (args, cbk) => {
           ln_socket: `${spawnLightningDaemon.host}:9735`,
           public_key: spawnLightningDaemon.public_key,
           socket: spawnLightningDaemon.socket,
+          tower_socket: spawnLightningDaemon.tower_socket,
         });
       }],
     },

package/lnd/spawn_lnd_docker.js

@@ -26,6 +26,7 @@ const tlsCertPath = '/root/.lnd/tls.cert';
     [configuration]: [<LND Configuration Argument String>]
     p2p_port: <LND Peer to Peer Listen Port Number>
     rpc_port: <LND RPC Port Number>
+    tower_port: <LND Tower Port Number>
     [seed]: <Mnemonic Seed String>
   }
 
@@ -36,6 +37,7 @@ const tlsCertPath = '/root/.lnd/tls.cert';
     macaroon: <LND Base64 Serialized Macaroon String>
     public_key: <LND Public Key Hex String>
     socket: <LND RPC Host:Port Network Address String>
+    tower_socket: <LND Tower Socket Host:Port Network Address String>
   }
 */
 module.exports = (args, cbk) => {
@@ -71,6 +73,10 @@ module.exports = (args, cbk) => {
           return cbk([400, 'ExpectedRpcPortToSpawnLndDocker']);
         }
 
+        if (!args.tower_port) {
+          return cbk([400, 'ExpectedTowerPortToSpawnLndDocker']);
+        }
+
         return cbk();
       },
 
@@ -102,6 +108,8 @@ module.exports = (args, cbk) => {
           `--rpclisten=0.0.0.0:10009`,
           '--trickledelay=1',
           '--unsafe-disconnect',
+          '--watchtower.externalip', `127.0.0.1:9911`,
+          '--watchtower.listen', `127.0.0.1:9911`,
         ];
 
         return spawnDockerImage({
@@ -109,6 +117,7 @@ module.exports = (args, cbk) => {
           image: imageName(process.env.DOCKER_LND_VERSION),
           ports: {
             '9735/tcp': args.p2p_port,
+            '9911/tcp': args.tower_port,
             '10009/tcp': args.rpc_port,
           },
         },
@@ -188,6 +197,7 @@ module.exports = (args, cbk) => {
           macaroon: createWallet.toString('hex'),
           public_key: waitForRpc.public_key,
           socket: `localhost:${args.rpc_port}`,
+          tower_socket: `localhost:${args.tower_port}`,
         });
       }],
     },

package/package.json

@@ -35,5 +35,5 @@
   "scripts": {
     "test": "tap --branches=1 --functions=1 --lines=1 --statements=1 -j 1 test/bitcoind/*.js test/lnd/*.js"
   },
-  "version": "3.1.6"
+  "version": "4.0.0"
 }

package/test/lnd/test_spawn_lightning_docker.js

@@ -11,7 +11,8 @@ test('Spawn Lightning node image', async ({end}) => {
     chain_zmq_tx_port: 18461,
     generate_address: '2N8hwP1WmJrFF5QWABn38y63uYLhnJYJYTF',
     lightning_p2p_port: 18462,
-    lightning_rpc_port: 1863,
+    lightning_rpc_port: 18463,
+    lightning_tower_port: 18464,
   });
 
   await kill({});