ln-service 52.14.4 → 53.0.0

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Versions
 
+## 53.0.0
+
+- Removed support for determining the type of channel to support LND 0.14.0.
+
+- `createChainAddress`: Make address format optional and add p2wpkh as default
+- `sendToChainOutputScripts`: Fix specification of `fee_tokens_per_vbyte`
+
+### Breaking Changes
+
+- `getChannels`, `getPendingChannels`, `subscribeToChannels`: Remove
+    attributes `is_anchor`, `is_static_remote_key`, `is_variable_remote_key`.
+
+## 52.16.1
+
+- `subscribeToPayViaDetails`, `subscribeToPayViaRequest`: Add `paying`,  and
+    `routing_failure` events to follow in-flight attempts and encountered routing failures
+
+## 52.15.0
+
+- `getPayment`, `subscribeToPastPayment`: Add `pending` for pending payment details
+
 ## 52.14.4
 
 - `probeForRoute`, `subscribeToProbeForRoute`, `subscribeToPayViaRoutes`,

package/README.md

@@ -490,7 +490,7 @@ Create a new receive address.
 Requires `address:write` permission
 
     {
-      format: <Receive Address Type String> // "np2wpkh" || "p2wpkh"
+      [format]: <Receive Address Type String> // "np2wpkh" || "p2wpkh"
       [is_unused]: <Get As-Yet Unused Address Bool>
       lnd: <Authenticated LND API Object>
     }
@@ -1452,13 +1452,10 @@ Requires `offchain:read` permission
         [cooperative_close_delay_height]: <Prevent Coop Close Until Height Number>
         id: <Standard Format Channel Id String>
         is_active: <Channel Active Bool>
-        is_anchor: <Channel Supports Anchor Outputs Bool>
         is_closing: <Channel Is Closing Bool>
         is_opening: <Channel Is Opening Bool>
         is_partner_initiated: <Channel Partner Opened Channel Bool>
         is_private: <Channel Is Private Bool>
-        is_static_remote_key: <Remote Key Is Static Bool>
-        is_variable_remote_key: <Remote Key Is Variable Bool>
         local_balance: <Local Balance Tokens Number>
         [local_csv]: <Local CSV Blocks Delay Number>
         [local_dust]: <Remote Non-Enforceable Amount Tokens Number>
@@ -2324,6 +2321,30 @@ Requires `offchain:read` permission
         timeout: <Expiration Block Height Number>
         tokens: <Total Tokens Paid Number>
       }
+      [pending]: {
+        created_at: <Payment Created At ISO 8601 Date String>
+        destination: <Payment Destination Hex String>
+        id: <Payment Hash Hex String>
+        mtokens: <Total Millitokens Pending String>
+        paths: [{
+          fee_mtokens: <Total Fee Millitokens Paid String>
+          hops: [{
+            channel: <Standard Format Channel Id String>
+            channel_capacity: <Channel Capacity Tokens Number>
+            fee: <Fee Tokens Rounded Down Number>
+            fee_mtokens: <Fee Millitokens String>
+            forward: <Forwarded Tokens Number>
+            forward_mtokens: <Forward Millitokens String>
+            public_key: <Public Key Hex String>
+            timeout: <Timeout Block Height Number>
+          }]
+          mtokens: <Total Millitokens Pending String>
+        }]
+        [request]: <BOLT 11 Encoded Payment Request String>
+        safe_tokens: <Payment Tokens Rounded Up Number>
+        [timeout]: <Expiration Block Height Number>
+        tokens: <Total Tokens Pending Number>
+      }
     }
 
 Example:
@@ -2511,7 +2532,6 @@ Requires `offchain:read` permission
       pending_channels: [{
         [close_transaction_id]: <Channel Closing Transaction Id String>
         is_active: <Channel Is Active Bool>
-        is_anchor: <Channel Is Anchor Channel Type Bool>
         is_closing: <Channel Is Closing Bool>
         is_opening: <Channel Is Opening Bool>
         [is_partner_initiated]: <Channel Partner Initiated Channel Bool>
@@ -4632,13 +4652,10 @@ Requires `offchain:read` permission
       [cooperative_close_delay_height]: <Prevent Coop Close Until Height Number>
       id: <Standard Format Channel Id String>
       is_active: <Channel Active Bool>
-      is_anchor: <Channel Supports Anchor Outputs Bool>
       is_closing: <Channel Is Closing Bool>
       is_opening: <Channel Is Opening Bool>
       is_partner_initiated: <Channel Partner Opened Channel Bool>
       is_private: <Channel Is Private Bool>
-      is_static_remote_key: <Remote Key Is Static Bool>
-      is_variable_remote_key: <Remote Key Is Variable Bool>
       local_balance: <Local Balance Tokens Number>
       [local_given]: <Local Initially Pushed Tokens Number>
       local_reserve: <Local Reserved Tokens Number>
@@ -5138,7 +5155,34 @@ Requires `offchain:read` permission
     }
 
     @event 'paying'
-    {}
+    {
+      created_at: <Payment Created At ISO 8601 Date String>
+      destination: <Payment Destination Hex String>
+      id: <Payment Hash Hex String>
+      mtokens: <Total Millitokens Pending String>
+      paths: [{
+        fee: <Total Fee Tokens Pending Number>
+        fee_mtokens: <Total Fee Millitokens Pending String>
+        hops: [{
+          channel: <Standard Format Channel Id String>
+          channel_capacity: <Channel Capacity Tokens Number>
+          fee: <Fee Tokens Rounded Down Number>
+          fee_mtokens: <Fee Millitokens String>
+          forward: <Forward Tokens Number>
+          forward_mtokens: <Forward Millitokens String>
+          public_key: <Public Key Hex String>
+          timeout: <Timeout Block Height Number>
+        }]
+        mtokens: <Total Millitokens Pending String>
+        safe_fee: <Total Fee Tokens Pending Rounded Up Number>
+        safe_tokens: <Total Tokens Pending, Rounded Up Number>
+        timeout: <Expiration Block Height Number>
+      }]
+      [request]: <BOLT 11 Encoded Payment Request String>
+      safe_tokens: <Total Tokens Pending, Rounded Up Number>
+      [timeout]: <Expiration Block Height Number>
+      tokens: <Total Tokens Pending Rounded Down Number>
+    }
 
 Example:
 
@@ -5309,7 +5353,61 @@ Requires `offchain:write` permission
     }
 
     @event 'paying'
-    {}
+    {
+      created_at: <Payment Created At ISO 8601 Date String>
+      destination: <Payment Destination Hex String>
+      id: <Payment Hash Hex String>
+      mtokens: <Total Millitokens Pending String>
+      paths: [{
+        fee: <Total Fee Tokens Pending Number>
+        fee_mtokens: <Total Fee Millitokens Pending String>
+        hops: [{
+          channel: <Standard Format Channel Id String>
+          channel_capacity: <Channel Capacity Tokens Number>
+          fee: <Fee Tokens Rounded Down Number>
+          fee_mtokens: <Fee Millitokens String>
+          forward: <Forward Tokens Number>
+          forward_mtokens: <Forward Millitokens String>
+          public_key: <Public Key Hex String>
+          timeout: <Timeout Block Height Number>
+        }]
+        mtokens: <Total Millitokens Pending String>
+        safe_fee: <Total Fee Tokens Pending Rounded Up Number>
+        safe_tokens: <Total Tokens Pending, Rounded Up Number>
+        timeout: <Expiration Block Height Number>
+      }]
+      safe_tokens: <Total Tokens Pending, Rounded Up Number>
+      [timeout]: <Expiration Block Height Number>
+      tokens: <Total Tokens Pending Rounded Down Number>
+    }
+
+    @event 'routing_failure'
+    {
+      [channel]: <Standard Format Channel Id String>
+      index: <Failure Index Number>
+      [mtokens]: <Millitokens String>
+      [public_key]: <Public Key Hex String>
+      reason: <Failure Reason String>
+      route: {
+        fee: <Total Route Fee Tokens To Pay Number>
+        fee_mtokens: <Total Route Fee Millitokens To Pay String>
+        hops: [{
+          channel: <Standard Format Channel Id String>
+          channel_capacity: <Channel Capacity Tokens Number>
+          fee: <Fee Number>
+          fee_mtokens: <Fee Millitokens String>
+          forward: <Forward Tokens Number>
+          forward_mtokens: <Forward Millitokens String>
+          public_key: <Public Key Hex String>
+          timeout: <Timeout Block Height Number>
+        }]
+        mtokens: <Total Route Millitokens String>
+        [payment]: <Payment Identifier Hex String>
+        timeout: <Expiration Block Height Number>
+        tokens: <Total Route Tokens Number>
+        [total_mtokens]: <Total Millitokens String>
+      }
+    }
 
 Example:
 
@@ -5406,7 +5504,61 @@ Requires `offchain:write` permission
     }
 
     @event 'paying'
-    {}
+    {
+      created_at: <Payment Created At ISO 8601 Date String>
+      destination: <Payment Destination Hex String>
+      id: <Payment Hash Hex String>
+      mtokens: <Total Millitokens Pending String>
+      paths: [{
+        fee: <Total Fee Tokens Pending Number>
+        fee_mtokens: <Total Fee Millitokens Pending String>
+        hops: [{
+          channel: <Standard Format Channel Id String>
+          channel_capacity: <Channel Capacity Tokens Number>
+          fee: <Fee Tokens Rounded Down Number>
+          fee_mtokens: <Fee Millitokens String>
+          forward: <Forward Tokens Number>
+          forward_mtokens: <Forward Millitokens String>
+          public_key: <Public Key Hex String>
+          timeout: <Timeout Block Height Number>
+        }]
+        mtokens: <Total Millitokens Pending String>
+        safe_fee: <Total Fee Tokens Pending Rounded Up Number>
+        safe_tokens: <Total Tokens Pending, Rounded Up Number>
+        timeout: <Expiration Block Height Number>
+      }]
+      safe_tokens: <Total Tokens Pending, Rounded Up Number>
+      [timeout]: <Expiration Block Height Number>
+      tokens: <Total Tokens Pending Rounded Down Number>
+    }
+
+    @event 'routing_failure'
+    {
+      [channel]: <Standard Format Channel Id String>
+      index: <Failure Index Number>
+      [mtokens]: <Millitokens String>
+      [public_key]: <Public Key Hex String>
+      reason: <Failure Reason String>
+      route: {
+        fee: <Total Route Fee Tokens To Pay Number>
+        fee_mtokens: <Total Route Fee Millitokens To Pay String>
+        hops: [{
+          channel: <Standard Format Channel Id String>
+          channel_capacity: <Channel Capacity Tokens Number>
+          fee: <Fee Number>
+          fee_mtokens: <Fee Millitokens String>
+          forward: <Forward Tokens Number>
+          forward_mtokens: <Forward Millitokens String>
+          public_key: <Public Key Hex String>
+          timeout: <Timeout Block Height Number>
+        }]
+        mtokens: <Total Route Millitokens String>
+        [payment]: <Payment Identifier Hex String>
+        timeout: <Expiration Block Height Number>
+        tokens: <Total Route Tokens Number>
+        [total_mtokens]: <Total Millitokens String>
+      }
+    }
 
 Example:
 

package/package.json

@@ -10,8 +10,8 @@
     "bolt07": "1.7.4",
     "cors": "2.8.5",
     "express": "4.17.1",
-    "invoices": "2.0.1",
-    "lightning": "4.13.3",
+    "invoices": "2.0.2",
+    "lightning": "5.0.0",
     "macaroon": "3.0.4",
     "morgan": "1.10.0",
     "ws": "8.2.3"
@@ -23,8 +23,10 @@
     "async": "3.2.2",
     "asyncjs-util": "1.2.7",
     "bip66": "1.1.5",
-    "bitcoinjs-lib": "5.2.0",
+    "bitcoinjs-lib": "6.0.0",
     "bn.js": "5.2.0",
+    "ecpair": "1.0.1",
+    "ln-docker-daemons": "2.1.0",
     "portfinder": "1.0.28",
     "psbt": "1.1.10",
     "rimraf": "3.0.2",
@@ -50,16 +52,7 @@
     "url": "https://github.com/alexbosworth/ln-service.git"
   },
   "scripts": {
-    "autopilot-integration-tests": "tap --no-coverage -t 90 test/autopilotrpc-integration/*.js",
-    "chain-integration-tests": "tap --no-coverage -t 90 test/chainrpc-integration/*.js",
-    "integration-tests": "tap --no-coverage -t 120 -j 1 test/grpc-integration/*.js test/integration/*.js",
-    "invoices-integration-tests": "tap --no-coverage -t 90 test/invoicesrpc-integration/*.js",
-    "router-integration-tests": "tap --no-coverage -j 2 -t 90 test/routerrpc-integration/*.js",
-    "signer-integration-tests": "tap --no-coverage test/signerrpc-integration/*.js",
-    "test": "tap --branches=1 --functions=1 --lines=1 --statements=1 -j 1 -t 150 test/autopilotrpc-integration/*.js test/chainrpc-integration/*.js test/integration/*.js test/invoicesrpc-integration/*.js test/routerrpc-integration/*.js test/routers-integration/*.js test/signerrpc-integration/*.js test/tower_clientrpc-integration/*.js test/tower_serverrpc-integration/*.js test/walletrpc-integration/*.js",
-    "tower_client-integration-tests": "tap --no-coverage test/tower_clientrpc-integration/*.js",
-    "tower_server-integration-tests": "tap --no-coverage test/tower_serverrpc-integration/*.js",
-    "wallet-integration-tests": "tap --no-coverage test/walletrpc-integration/*.js"
+    "test": "echo $DOCKER_LND_VERSION && tap -j 2 --branches=1 --functions=1 --lines=1 --statements=1 -t 200 test/autopilotrpc-integration/*.js test/chainrpc-integration/*.js test/integration/*.js test/invoicesrpc-integration/*.js test/routerrpc-integration/*.js test/signerrpc-integration/*.js test/tower_clientrpc-integration/*.js test/tower_serverrpc-integration/*.js test/walletrpc-integration/*.js"
   },
-  "version": "52.14.4"
+  "version": "53.0.0"
 }

package/test/autopilotrpc-integration/test_autopilot.js

@@ -1,35 +1,29 @@
+const {spawnLightningCluster} = require('ln-docker-daemons');
 const {test} = require('@alexbosworth/tap');
 
 const {addPeer} = require('./../../');
-const {createChainAddress} = require('./../../');
-const {createCluster} = require('./../macros');
 const {delay} = require('./../macros');
-const {generateBlocks} = require('./../macros');
-const {getNetworkGraph} = require('./../../');
 const {getAutopilot} = require('./../../');
-const {openChannel} = require('./../../');
 const {setAutopilot} = require('./../../');
 const {setupChannel} = require('./../macros');
-const {spawnLnd} = require('./../macros');
-const {waitForChannel} = require('./../macros');
-const {waitForPendingChannel} = require('./../macros');
 
 const avg = array => array.reduce((a, b) => a + b) / array.length;
-const channelCapacityTokens = 1e6;
 const confirmationCount = 6;
-const defaultFee = 1e3;
 const maxScore = 1e8;
 const score = 50000000;
+const size = 2;
 
 // Adjusting autopilot should result in changed autopilot status
 test(`Autopilot`, async ({end, equal}) => {
-  const cluster = await createCluster({is_remote_skipped: true});
+  const {kill, nodes} = await spawnLightningCluster({size});
 
-  const {kill} = cluster;
+  const [control, target] = nodes;
+
+  const cluster = {control, target};
 
   const {lnd} = cluster.control;
 
-  await setupChannel({lnd, generate: cluster.generate, to: cluster.target});
+  await setupChannel({lnd, generate: control.generate, to: cluster.target});
 
   equal((await getAutopilot({lnd})).is_enabled, false, 'Autopilot starts off');
 
@@ -41,7 +35,7 @@ test(`Autopilot`, async ({end, equal}) => {
 
   await addPeer({
     lnd,
-    public_key: cluster.target.public_key,
+    public_key: cluster.target.id,
     socket: cluster.target.socket,
   });
 
@@ -51,7 +45,7 @@ test(`Autopilot`, async ({end, equal}) => {
 
   equal((await getAutopilot({lnd})).is_enabled, false, 'Autopilot turned off');
 
-  const pubKey = cluster.control.public_key;
+  const pubKey = cluster.control.id;
 
   await setAutopilot({
     lnd,

package/test/chainrpc-integration/test_get_height.js

@@ -1,24 +1,23 @@
 const asyncRetry = require('async/retry');
+const {spawnLightningCluster} = require('ln-docker-daemons');
 const {test} = require('@alexbosworth/tap');
 
-const {generateBlocks} = require('./../macros');
 const {getHeight} = require('./../../');
-const {spawnLnd} = require('./../macros');
-const {waitForTermination} = require('./../macros');
 
 const confirmationCount = 6;
+const times = 100;
 
 // Get height should return height
 test(`Get height`, async ({end, equal, fail}) => {
-  const spawned = await spawnLnd({});
+  const {nodes} = await spawnLightningCluster({});
 
-  const {generate, kill, lnd} = spawned;
+  const [{chain, generate, kill, lnd}] = nodes;
 
   const startHeight = (await getHeight({lnd})).current_block_height;
 
-  await generate({count: confirmationCount});
+  await asyncRetry({times}, async () => {
+    await generate({});
 
-  await asyncRetry({}, async () => {
     const endHeight = (await getHeight({lnd})).current_block_height;
 
     if (endHeight - startHeight < confirmationCount) {
@@ -30,9 +29,7 @@ test(`Get height`, async ({end, equal, fail}) => {
     return;
   });
 
-  kill();
-
-  await waitForTermination({lnd});
+  await kill({});
 
   return end();
 });

package/test/chainrpc-integration/test_subscribe_to_blocks.js

@@ -1,63 +1,84 @@
 const EventEmitter = require('events');
+const {once} = require('events');
 
 const asyncRetry = require('async/retry');
+const {spawnLightningCluster} = require('ln-docker-daemons');
 const {test} = require('@alexbosworth/tap');
 
+const {createChainAddress} = require('./../../');
 const {delay} = require('./../macros');
 const {generateBlocks} = require('./../macros');
 const {getHeight} = require('./../../');
+const {getChainBalance} = require('./../../');
 const {spawnLnd} = require('./../macros');
 const {subscribeToBlocks} = require('./../../');
 const {waitForTermination} = require('./../macros');
 
 const confirmationCount = 6;
-const interval = 200;
-const times = 400;
+const interval = 1;
+const race = promises => Promise.race(promises);
+const times = 4000;
 
 // Subscribers to blocks should receive block notifications
 test(`Subscribe to blocks`, async ({end, equal, fail}) => {
-  const spawned = await spawnLnd({});
-
-  const {kill, lnd} = spawned;
-
   const blocks = [];
+  const {kill, nodes} = await spawnLightningCluster({});
+
+  const [{generate, lnd}] = nodes;
 
-  // Wait for chainrpc to be active
   await asyncRetry({interval, times}, async () => {
-    const height = (await getHeight({lnd})).current_block_height;
+    const subBlocks = subscribeToBlocks({lnd});
 
-    if (!height) {
-      throw new Error('ExpectedCurrentHeight');
-    }
+    const [event] = await race([
+      once(subBlocks, 'block'),
+      once(subBlocks, 'error'),
+    ]);
 
-    return;
+    if (!event.height) {
+      throw new Error('ExpectedBlockEvent');
+    }
   });
 
-  const sub = subscribeToBlocks({lnd});
-  const startHeight = (await getHeight({lnd})).current_block_height;
+  try {
+    // Wait for chainrpc to be active
+    await asyncRetry({interval, times}, async () => {
+      if (!!(await getChainBalance({lnd})).chain_balance) {
+        return;
+      }
 
-  sub.on('block', async data => blocks.push(data));
-  sub.on('error', err => {});
+      await generate({});
 
-  await spawned.generate({count: confirmationCount});
+      await getHeight({lnd});
 
-  await asyncRetry({interval, times}, async () => {
-    if (blocks.length < confirmationCount) {
-      throw new Error('ExpectedAdditionalBlocks');
-    }
-  });
+      throw new Error('ExpectedChainBalance');
+    });
 
-  blocks.forEach(({height, id}) => {
-    equal(!!height, true, 'Got expected block height');
-    equal(id.length, 64, 'Got expected block hash length');
-    return;
-  });
+    const sub = subscribeToBlocks({lnd});
+    const startHeight = (await getHeight({lnd})).current_block_height;
+
+    sub.on('block', data => blocks.push(data));
+    sub.on('error', err => {});
+
+    const {address} = await createChainAddress({lnd});
 
-  kill();
+    await asyncRetry({interval, times}, async () => {
+      await generate({});
 
-  await waitForTermination({lnd});
+      if (blocks.length < confirmationCount) {
+        throw new Error('ExpectedAdditionalBlocks');
+      }
+    });
 
-  return end();
+    blocks.forEach(({height, id}) => {
+      equal(!!height, true, 'Got expected block height');
+      equal(id.length, 64, 'Got expected block hash length');
+      return;
+    });
+  } catch (err) {
+    equal(err, null, 'Expected no error');
+  } finally {
+    await kill({});
 
-  return;
+    return end();
+  }
 });