ln-docker-daemons 2.0.0 → 2.2.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Versions
 
+## 2.2.1
+
+- `spawnLightningCluster`, `spawnLightningDocker`: Add `lnd_configuration` to
+    allow specifying additional LND configuration parameters
+
+## 2.1.1
+
+- `DOCKER_LND_VERSION`: add environment variable to control docker lnd image
+
 ## 2.0.0
 
 - `spawnLightningCluster`: add `socket` to reveal node LN p2p sockets

package/README.md

@@ -18,6 +18,16 @@ const publicKey = (await getIdentity({lnd})).public_key;
 await kill({});
 ```
 
+## Environment Variables
+
+- `DOCKER_LND_VERSION`: set this to use a custom LND docker image
+
+Example:
+
+```shell
+export DOCKER_LND_VERSION="v0.14.0-beta"
+```
+
 ## spawnBitcoindDocker
 
 Spawn a Bitcoin Core Docker image
@@ -59,6 +69,7 @@ await kill({});
 Spawn a cluster of nodes
 
     {
+      [lnd_configuration]: [<LND Configuration Argument String>]
       [size]: <Total Lightning Nodes Number>
     }
 
@@ -83,11 +94,10 @@ const {spawnLightningCluster} = require('ln-docker-daemons');
 const {nodes} = await spawnLightningCluster({});
 const [{lnd, generate, kill}] = nodes;
 
-const pubilcKey = (await getIdentity({lnd})).public_key;
+const publicKey = (await getIdentity({lnd})).public_key;
 
 // Generate some coins for the wallet
-const {address} = await createChainAddress({lnd, format: 'p2wpkh'});
-await generate({address, count: 500});
+await generate({count: 500});
 
 // Stop the image
 await kill({});
@@ -105,6 +115,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>
+      [lnd_configuration]: [<LND Configuration Argument String>]
     }
 
     @returns via cbk or Promise

package/cluster/spawn_lightning_cluster.js

@@ -17,7 +17,7 @@ const count = size => size || 1;
 const endPort = 65000;
 const generateAddress = '2N8hwP1WmJrFF5QWABn38y63uYLhnJYJYTF';
 const interval = 10;
-const makeAddress = ({lnd}) => createChainAddress({lnd, format: 'p2wpkh'});
+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;
@@ -27,6 +27,7 @@ const times = 3000;
 /** Spawn a cluster of nodes
 
   {
+    [lnd_configuration]: [<LND Configuration Argument String>]
     [size]: <Total Lightning Nodes Number>
   }
 
@@ -46,7 +47,7 @@ module.exports = (args, cbk) => {
     return asyncAuto({
       // Spawn nodes
       spawn: async () => {
-        return await asyncRetry({}, async () => {
+        return await asyncRetry({interval, times: 25}, async () => {
           const options = {startPort: between(startPort, endPort)};
 
           // Find ports for the requested daemons
@@ -75,6 +76,7 @@ module.exports = (args, cbk) => {
               generate_address: generateAddress,
               lightning_p2p_port: lightningP2pPort,
               lightning_rpc_port: lightningRpcPort,
+              lnd_configuration: args.lnd_configuration,
             });
 
             const {lnd} = authenticatedLndGrpc({

package/docker/spawn_docker_image.js

@@ -67,6 +67,8 @@ module.exports = ({arguments, expose, image, ports}, cbk) => {
             throw [503, 'CannotConnectToDockerDaemon'];
           }
 
+          console.log("ERR", err);
+
           throw [503, 'UnexpectedErrorGettingDockerImage', {err}];
         }
       }],

package/lnd/constants.json

@@ -1,3 +1,3 @@
 {
-  "dockerLndImage": "lightninglabs/lnd:v0.13.4-beta"
+  "dockerLndImage": "lightninglabs/lnd:v0.14.0-beta"
 }

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>
+    [lnd_configuration]: [<LND Configuration Argument String>]
   }
 
   @returns via cbk or Promise
@@ -99,6 +100,7 @@ module.exports = (args, cbk) => {
         ({spawnChainDaemon}, cbk) =>
       {
         return spawnLndDocker({
+          configuration: args.lnd_configuration,
           bitcoind_rpc_host: spawnChainDaemon.host,
           bitcoind_rpc_pass: spawnChainDaemon.rpc_pass,
           bitcoind_rpc_port: args.chain_rpc_port,

package/lnd/spawn_lnd_docker.js

@@ -8,7 +8,8 @@ const {unauthenticatedLndGrpc} = require('lightning');
 const {dockerLndImage} = require('./constants');
 const {spawnDockerImage} = require('./../docker');
 
-const interval = 50;
+const imageName = ver => !!ver ? `lightninglabs/lnd:${ver}` : dockerLndImage;
+const interval = 100;
 const macaroonPath = '/root/.lnd/data/chain/bitcoin/regtest/admin.macaroon';
 const times = 500;
 const tlsCertPath = '/root/.lnd/tls.cert';
@@ -22,6 +23,7 @@ const tlsCertPath = '/root/.lnd/tls.cert';
     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>
   }
@@ -77,31 +79,33 @@ module.exports = (args, cbk) => {
         const zmqBlockPort = args.bitcoind_zmq_block_port;
         const zmqTxPort = args.bitcoind_zmq_tx_port;
 
+        const arguments = [
+          '--accept-keysend',
+          '--allow-circular-route',
+          '--autopilot.heuristic=externalscore:0.5',
+          '--autopilot.heuristic=preferential:0.5',
+          '--bitcoin.active',
+          '--bitcoin.minhtlc=1000',
+          '--bitcoin.node=bitcoind',
+          '--bitcoin.regtest',
+          `--bitcoind.rpchost=${chainHost}:18443`,
+          `--bitcoind.rpcpass=${args.bitcoind_rpc_pass}`,
+          `--bitcoind.rpcuser=${args.bitcoind_rpc_user}`,
+          `--bitcoind.zmqpubrawblock=tcp://${chainHost}:${zmqBlockPort}`,
+          `--bitcoind.zmqpubrawtx=tcp://${chainHost}:${zmqTxPort}`,
+          '--debuglevel=trace',
+          `--externalip=127.0.0.1:9735`,
+          '--historicalsyncinterval=1s',
+          `--listen=0.0.0.0:9735`,
+          '--nobootstrap',
+          `--rpclisten=0.0.0.0:10009`,
+          '--trickledelay=1',
+          '--unsafe-disconnect',
+        ];
+
         return spawnDockerImage({
-          arguments: [
-            '--accept-keysend',
-            '--allow-circular-route',
-            '--autopilot.heuristic=externalscore:0.5',
-            '--autopilot.heuristic=preferential:0.5',
-            '--bitcoin.active',
-            '--bitcoin.minhtlc=1000',
-            '--bitcoin.node=bitcoind',
-            '--bitcoin.regtest',
-            `--bitcoind.rpchost=${chainHost}:18443`,
-            `--bitcoind.rpcpass=${args.bitcoind_rpc_pass}`,
-            `--bitcoind.rpcuser=${args.bitcoind_rpc_user}`,
-            `--bitcoind.zmqpubrawblock=tcp://${chainHost}:${zmqBlockPort}`,
-            `--bitcoind.zmqpubrawtx=tcp://${chainHost}:${zmqTxPort}`,
-            '--debuglevel=trace',
-            `--externalip=127.0.0.1:9735`,
-            '--historicalsyncinterval=1s',
-            `--listen=0.0.0.0:9735`,
-            '--nobootstrap',
-            `--rpclisten=0.0.0.0:10009`,
-            '--trickledelay=1',
-            '--unsafe-disconnect',
-          ],
-          image: dockerLndImage,
+          arguments: arguments.concat(args.configuration || []),
+          image: imageName(process.env.DOCKER_LND_VERSION),
           ports: {
             '9735/tcp': args.p2p_port,
             '10009/tcp': args.rpc_port,
@@ -135,40 +139,28 @@ module.exports = (args, cbk) => {
               cipher_seed_mnemonic: res.cipher_seed_mnemonic,
               wallet_password: Buffer.from('password', 'utf8'),
             },
-            err => {
+            (err, res) => {
               if (!!err) {
                 return cbk([503, 'UnexpectedErrorInitializingWallet', {err}]);
               }
 
-              return cbk();
+              return cbk(null, res.admin_macaroon);
             });
           });
         },
         cbk);
       }],
 
-      // Get the macaroon out of the docker image
-      getMacaroon: [
-        'createWallet',
-        'spawnDocker',
-        ({createWallet, spawnDocker}, cbk) =>
-      {
-        return asyncRetry({interval, times}, cbk => {
-          return spawnDocker.getFile({path: macaroonPath}, cbk);
-        },
-        cbk);
-      }],
-
       // Wait for gRPC to respond
       waitForRpc: [
+        'createWallet',
         'getCertificate',
-        'getMacaroon',
         'spawnDocker',
-        ({getCertificate, getMacaroon, spawnDocker}, cbk) =>
+        ({createWallet, getCertificate, spawnDocker}, cbk) =>
       {
         const {lnd} = authenticatedLndGrpc({
           cert: getCertificate.file.toString('hex'),
-          macaroon: getMacaroon.file.toString('hex'),
+          macaroon: createWallet.toString('hex'),
           socket: `localhost:${args.rpc_port}`,
         });
 
@@ -180,17 +172,17 @@ module.exports = (args, cbk) => {
 
       // LND fully spawned
       spawned: [
+        'createWallet',
         'getCertificate',
-        'getMacaroon',
         'spawnDocker',
         'waitForRpc',
-        ({getCertificate, getMacaroon, spawnDocker, waitForRpc}, cbk) =>
+        ({createWallet, getCertificate, spawnDocker, waitForRpc}, cbk) =>
       {
         return cbk(null, {
           cert: getCertificate.file.toString('base64'),
           host: spawnDocker.host,
           kill: spawnDocker.kill,
-          macaroon: getMacaroon.file.toString('base64'),
+          macaroon: createWallet.toString('hex'),
           public_key: waitForRpc.public_key,
           socket: `localhost:${args.rpc_port}`,
         });

package/package.json

@@ -8,11 +8,11 @@
   },
   "dependencies": {
     "@alexbosworth/node-fetch": "2.6.2",
-    "async": "3.2.2",
-    "asyncjs-util": "1.2.7",
+    "async": "3.2.3",
+    "asyncjs-util": "1.2.8",
     "dockerode": "3.3.1",
     "find-free-ports": "3.0.0",
-    "lightning": "4.14.4",
+    "lightning": "5.4.1",
     "tar-stream": "2.2.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": "2.0.0"
+  "version": "2.2.1"
 }