ln-docker-daemons 4.0.4 → 4.1.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 4.1.0
+
+- `spawnLndDocker`: Add method to spawn an LND docker
+
 ## 4.0.4
 
 - `spawnLightningCluster`: Return `tower` for the watchtower server socket

package/README.md

@@ -191,3 +191,31 @@ Spawn an LND Docker
       socket: <LND RPC Host:Port Network Address String>
       tower_socket: <LND Tower Socket Host:Port Network Address String>
     }
+
+## `spawnLndDocker`
+
+Spawn a new Docker image running LND
+
+    {
+      bitcoind_rpc_host: <Bitcoin Core RPC Host String>
+      bitcoind_rpc_pass: <Bitcoin Core RPC Password String>
+      bitcoind_rpc_port: <Bitcoin Core RPC Port Number>
+      bitcoind_rpc_user: <Bitcoin Core RPC Username String>
+      [bitcoind_zmq_block_port]: <Bitcoin Core ZMQ Block Port Number>
+      [bitcoind_zmq_tx_port]: <Bitcoin Core ZMQ Transaction Port Number>
+      [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>
+    }
+
+    @returns via cbk or Promise
+    {
+      cert: <LND Base64 Serialized TLS Cert Base64 String>
+      kill: ({}, [cbk]) => <Kill LND Docker Promise>
+      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>
+    }

package/bitcoind/spawn_bitcoind_docker.js

@@ -24,8 +24,8 @@ const trim = string => string.replace(/=+$/g, '');
   {
     p2p_port: <P2P Port Number>
     rpc_port: <RPC Port Number>
-    zmq_block_port: <ZMQ Blocks Port Number>
-    zmq_tx_port: <ZMQ Transactions Port Number>
+    [zmq_block_port]: <ZMQ Blocks Port Number>
+    [zmq_tx_port]: <ZMQ Transactions Port Number>
   }
 
   @returns via cbk or Promise
@@ -49,14 +49,6 @@ module.exports = (args, cbk) => {
           return cbk([400, 'ExpectedRpcListenPortToSpawnBitcoindDocker']);
         }
 
-        if (!args.zmq_block_port) {
-          return cbk([400, 'ExpectedZmqBlocksPortToSpawnBitcoindDocker']);
-        }
-
-        if (!args.zmq_tx_port) {
-          return cbk([400, 'ExpectedZmqTxPortToSpawnBitcoindDocker']);
-        }
-
         return cbk();
       },
 
@@ -73,30 +65,33 @@ module.exports = (args, cbk) => {
 
       // Spawn the docker image
       spawnDocker: ['generateAuth', ({generateAuth}, cbk) => {
-        return spawnDockerImage({
-          arguments: [
-            '--disablewallet',
-            '--listen=1',
-            '--persistmempool=false',
-            '--printtoconsole',
-            '--regtest',
-            '--rpcallowip=172.17.0.0/16',
-            `--rpcauth=${generateAuth.rpc_auth}`,
-            '--rpcbind=0.0.0.0',
-            '--server',
-            '--txindex',
-            `--zmqpubrawblock=tcp://*:${args.zmq_block_port}`,
-            `--zmqpubrawtx=tcp://*:${args.zmq_tx_port}`,
-          ],
-          image: dockerBitcoindImage,
-          ports: {
-            '18443/tcp': args.rpc_port,
-            '18444/tcp': args.p2p_port,
-            [`${args.zmq_block_port}/tcp`]: args.zmq_block_port,
-            [`${args.zmq_tx_port}/tcp`]: args.zmq_tx_port,
-          },
-        },
-        cbk);
+        const arguments = [
+          '--disablewallet',
+          '--listen=1',
+          '--persistmempool=false',
+          '--printtoconsole',
+          '--regtest',
+          '--rpcallowip=172.17.0.0/16',
+          `--rpcauth=${generateAuth.rpc_auth}`,
+          '--rpcbind=0.0.0.0',
+          '--server',
+          '--txindex',
+        ];
+
+        const image = dockerBitcoindImage;
+        const ports = {'18443/tcp': args.rpc_port, '18444/tcp': args.p2p_port};
+
+        if (!!args.zmq_block_port) {
+          arguments.push('--zmqpubrawblock=tcp://*:' + args.zmq_block_port);
+          ports[`${args.zmq_block_port}/tcp`] = args.zmq_block_port;
+        }
+
+        if (!!args.zmq_tx_port) {
+          arguments.push('--zmqpubrawtx=tcp://*:' + args.zmq_tx_port);
+          ports[`${args.zmq_tx_port}/tcp`] = args.zmq_tx_port;
+        }
+
+        return spawnDockerImage({arguments, image, ports}, cbk);
       }],
 
       // Wait for the image to respond to a query

package/index.js

@@ -2,10 +2,12 @@ const {setupChannel} = require('./setup');
 const {spawnBitcoindDocker} = require('./bitcoind');
 const {spawnLightningCluster} = require('./cluster');
 const {spawnLightningDocker} =  require('./lnd');
+const {spawnLndDocker} =  require('./lnd');
 
 module.exports = {
   setupChannel,
   spawnBitcoindDocker,
   spawnLightningCluster,
   spawnLightningDocker,
+  spawnLndDocker,
 };

package/lnd/index.js

@@ -1,3 +1,4 @@
 const spawnLightningDocker = require('./spawn_lightning_docker');
+const spawnLndDocker = require('./spawn_lnd_docker');
 
-module.exports = {spawnLightningDocker};
+module.exports = {spawnLightningDocker, spawnLndDocker};

package/lnd/spawn_lnd_docker.js

@@ -10,6 +10,7 @@ const {spawnDockerImage} = require('./../docker');
 
 const imageName = ver => !!ver ? `lightninglabs/lnd:${ver}` : dockerLndImage;
 const interval = 100;
+const join = n => n.join('');
 const macaroonPath = '/root/.lnd/data/chain/bitcoin/regtest/admin.macaroon';
 const times = 500;
 const tlsCertPath = '/root/.lnd/tls.cert';
@@ -21,8 +22,8 @@ const tlsCertPath = '/root/.lnd/tls.cert';
     bitcoind_rpc_pass: <Bitcoin Core RPC Password String>
     bitcoind_rpc_port: <Bitcoin Core RPC Port Number>
     bitcoind_rpc_user: <Bitcoin Core RPC Username String>
-    bitcoind_zmq_block_port: <Bitcoin Core ZMQ Block Port Number>
-    bitcoind_zmq_tx_port: <Bitcoin Core ZMQ Transaction Port Number>
+    [bitcoind_zmq_block_port]: <Bitcoin Core ZMQ Block Port Number>
+    [bitcoind_zmq_tx_port]: <Bitcoin Core ZMQ Transaction Port Number>
     [configuration]: [<LND Configuration Argument String>]
     p2p_port: <LND Peer to Peer Listen Port Number>
     rpc_port: <LND RPC Port Number>
@@ -32,8 +33,8 @@ const tlsCertPath = '/root/.lnd/tls.cert';
 
   @returns via cbk or Promise
   {
-    cert: <LND Base64 Serialized TLS Cert>
-    kill: ({}, [cbk]) => <Kill LND and Bitcoind Dockers Promise>
+    cert: <LND Base64 Serialized TLS Cert Base64 String>
+    kill: ({}, [cbk]) => <Kill LND Dockers Promise>
     macaroon: <LND Base64 Serialized Macaroon String>
     public_key: <LND Public Key Hex String>
     socket: <LND RPC Host:Port Network Address String>
@@ -57,14 +58,6 @@ module.exports = (args, cbk) => {
           return cbk([400, 'ExpectedBitcoinCoreRpcUserToSpawnLndDocker']);
         }
 
-        if (!args.bitcoind_zmq_block_port) {
-          return cbk([400, 'ExpectedBitcoinCoreZmqBlockPortToSpawnLndDocker']);
-        }
-
-        if (!args.bitcoind_zmq_tx_port) {
-          return cbk([400, 'ExpectedBitcoinCoreZmqTxPortToSpawnLndDocker']);
-        }
-
         if (!args.p2p_port) {
           return cbk([400, 'ExpectedLndPeer2PeerNetworkPortToSpawnLndDocker']);
         }
@@ -112,6 +105,26 @@ module.exports = (args, cbk) => {
           '--watchtower.listen', `127.0.0.1:9911`,
         ];
 
+        if (!!zmqBlockPort) {
+          arguments.push(join([
+            '--bitcoind.zmqpubrawblock=tcp://',
+            chainHost,
+            ':',
+            zmqBlockPort,
+          ]));
+
+          arguments.push(join([
+            '--bitcoind.zmqpubrawtx=tcp://',
+            chainHost,
+            ':',
+            zmqTxPort
+          ]));
+        } else {
+          arguments.push('--bitcoind.rpcpolling');
+          arguments.push('--bitcoind.blockpollinginterval=1s');
+          arguments.push('--bitcoind.txpollinginterval=1s');
+        }
+
         return spawnDockerImage({
           arguments: arguments.concat(args.configuration || []),
           image: imageName(process.env.DOCKER_LND_VERSION),

package/package.json

@@ -12,7 +12,7 @@
     "asyncjs-util": "1.2.11",
     "dockerode": "3.3.4",
     "find-free-ports": "3.0.0",
-    "lightning": "7.0.3",
+    "lightning": "7.0.6",
     "tar-stream": "3.0.0"
   },
   "description": "Spawn and control LN Docker daemons",
@@ -35,5 +35,5 @@
   "scripts": {
     "test": "tap --branches=1 --functions=1 --lines=1 --statements=1 -j 1 test/bitcoind/*.js test/lnd/*.js"
   },
-  "version": "4.0.4"
+  "version": "4.1.0"
 }