ln-service 56.3.1 → 56.4.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Versions
 
+## 56.4.0
+
+- `getChannels`: Add `description` to show the channel description
+- `openChannel`, `openChannels`, `proposeChannel`: Add `description` to set
+    the channel description
+- `subscribeToChannels`: Add `description` to `channel_opened`
+- `subscribeToRpcRequests`: Add `description` to `open_channel_request`
+
 ## 56.3.1
 
 - `subscribeToPastPayment`, `subscribeToPayViaDetails`,

package/README.md

@@ -1684,6 +1684,8 @@ Requires `offchain:read` permission
 
 `is_trusted_funding` is not supported on LND 0.15.0 and below
 
+`description` is not supported on LND 0.16.3 and below
+
     {
       [is_active]: <Limit Results To Only Active Channels Bool> // false
       [is_offline]: <Limit Results To Only Offline Channels Bool> // false
@@ -1701,6 +1703,7 @@ Requires `offchain:read` permission
         commit_transaction_weight: <Commit Transaction Weight Number>
         [cooperative_close_address]: <Coop Close Restricted to Address String>
         [cooperative_close_delay_height]: <Prevent Coop Close Until Height Number>
+        [description]: <Channel Description String>
         id: <Standard Format Channel Id String>
         is_active: <Channel Active Bool>
         is_closing: <Channel Is Closing Bool>
@@ -3698,12 +3701,15 @@ Requires `offchain:write`, `onchain:write`, `peers:write` permissions
 `base_fee_mtokens` is not supported on LND 0.15.5 and below
 `fee_rate` is not supported on LND 0.15.5 and below
 
-`is_max_funding` is not supported on LND 0.16.0 and below
+`is_max_funding` is not supported on LND 0.16.3 and below
+
+`description` is not supported on LND 0.16.3 and below
 
     {
       [base_fee_mtokens]: <Routing Base Fee Millitokens Charged String>
       [chain_fee_tokens_per_vbyte]: <Chain Fee Tokens Per VByte Number>
       [cooperative_close_address]: <Restrict Cooperative Close To Address String>
+      [description]: <Immutable Channel Description String>
       [fee_rate]: <Routing Fee Rate In Millitokens Per Million Number>
       [give_tokens]: <Tokens to Gift To Partner Number> // Defaults to zero
       [is_max_funding]: <Use Maximal Chain Funds For Local Funding Bool>
@@ -3754,11 +3760,14 @@ as well as a channel open request listener to accept the trusted funding.
 `base_fee_mtokens` is not supported on LND 0.15.5 and below
 `fee_rate` is not supported on LND 0.15.5 and below
 
+`description` is not supported on LND 0.16.3 and below
+
     {
       channels: [{
         [base_fee_mtokens]: <Routing Base Fee Millitokens Charged String>
         capacity: <Channel Capacity Tokens Number>
         [cooperative_close_address]: <Restrict Coop Close To Address String>
+        [description]: <Immutable Channel Description String>
         [fee_rate]: <Routing Fee Rate In Millitokens Per Million Number>
         [give_tokens]: <Tokens to Gift To Partner Number> // Defaults to zero
         [is_private]: <Channel is Private Bool> // Defaults to false
@@ -4384,10 +4393,13 @@ Requires `address:read`, `offchain:write`, `onchain:write` permissions
 
 Requires LND compiled with `walletrpc` build tag
 
+`description` is not supported on LND 0.16.3 and below
+
     {
       capacity: <Channel Capacity Tokens Number>
       [cooperative_close_address]: <Restrict Cooperative Close To Address String>
       [cooperative_close_delay]: <Cooperative Close Relative Delay Number>
+      [description]: <Immutable Channel Description String>
       [give_tokens]: <Tokens to Gift To Partner Number> // Defaults to zero
       id: <Pending Channel Id Hex String>
       [is_private]: <Channel is Private Bool> // Defaults to false
@@ -5251,6 +5263,8 @@ Requires `offchain:read` permission
 
 `is_trusted_funding`, `other_ids` are not supported on LND 0.15.0 and below
 
+`description` is not supported on LND 0.16.3 and below
+
     {
       lnd: <Authenticated LND API Object>
     }
@@ -5308,6 +5322,7 @@ Requires `offchain:read` permission
       commit_transaction_weight: <Commit Transaction Weight Number>
       [cooperative_close_address]: <Coop Close Restricted to Address String>
       [cooperative_close_delay_height]: <Prevent Coop Close Until Height Number>
+      [description]: <Channel Description String>
       id: <Standard Format Channel Id String>
       is_active: <Channel Active Bool>
       is_closing: <Channel Is Closing Bool>
@@ -6790,6 +6805,8 @@ LND must be running with "RPC middleware" enabled: `rpcmiddleware.enable=1`
 
 This method is not supported in LND 0.13.4 and below
 
+`description` is not supported on LND 0.16.3 and below
+
     {
       [id]: <RPC Middleware Interception Name String>
       [is_intercepting_close_channel_requests]: <Intercept Channel Closes Bool>
@@ -6833,6 +6850,7 @@ This method is not supported in LND 0.13.4 and below
         [base_fee_mtokens]: <Routing Base Fee Millitokens Charged String>
         [chain_fee_tokens_per_vbyte]: <Chain Fee Tokens Per VByte Number>
         [cooperative_close_address]: <Prefer Cooperative Close To Address String>
+        [description]: <Immutable Channel Description String>
         [fee_rate]: <Routing Fee Rate In Millitokens Per Million Number>
         [give_tokens]: <Tokens to Gift To Partner Number>
         [is_private]: <Channel is Private Bool>

package/package.json

@@ -11,13 +11,14 @@
     "cors": "2.8.5",
     "express": "4.18.2",
     "invoices": "2.2.3",
-    "lightning": "9.3.1",
+    "lightning": "9.4.0",
     "macaroon": "3.0.4",
     "morgan": "1.10.0",
     "ws": "8.13.0"
   },
   "description": "Interaction helper for your Lightning Network daemon",
   "devDependencies": {
+    "@alexbosworth/blockchain": "1.3.0",
     "@alexbosworth/tap": "15.0.12",
     "@alexbosworth/node-fetch": "2.6.2",
     "async": "3.2.4",
@@ -28,11 +29,11 @@
     "bn.js": "5.2.1",
     "bs58check": "3.0.1",
     "ecpair": "2.1.0",
-    "ln-docker-daemons": "5.0.3",
+    "ln-docker-daemons": "5.0.4",
     "p2tr": "1.3.3",
     "portfinder": "1.0.32",
     "psbt": "2.7.2",
-    "rimraf": "5.0.0",
+    "rimraf": "5.0.1",
     "secp256k1": "5.0.0",
     "tiny-secp256k1": "2.2.1",
     "uuid": "9.0.0",
@@ -67,5 +68,5 @@
     "integration-test-0.14.4": "DOCKER_LND_VERSION=v0.14.4-beta npm run test",
     "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/peersrpc-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": "56.3.1"
+  "version": "56.4.0"
 }

package/test/chainrpc-integration/test_get_block.js

@@ -1,15 +1,10 @@
-const asyncRetry = require('async/retry');
-const {Block} = require('bitcoinjs-lib');
+const {idForBlock} = require('@alexbosworth/blockchain');
 const {spawnLightningCluster} = require('ln-docker-daemons');
 const {test} = require('@alexbosworth/tap');
 
 const {getBlock} = require('./../../');
 const {getHeight} = require('./../../');
 
-const confirmationCount = 6;
-const {fromHex} = Block;
-const times = 100;
-
 // Get height should return height
 test(`Get height`, async ({end, equal, fail}) => {
   const {nodes} = await spawnLightningCluster({});
@@ -25,7 +20,7 @@ test(`Get height`, async ({end, equal, fail}) => {
   try {
     const {block} = await getBlock({lnd, id: blockchain.current_block_hash});
 
-    equal(fromHex(block).getId(), hash, 'Got block');
+    equal(idForBlock({block}).id, hash, 'Got block');
   } catch (err) {
     const [code, message] = err;
 
@@ -40,8 +35,7 @@ test(`Get height`, async ({end, equal, fail}) => {
   // Try getting a block by the height
   try {
     const {block} = await getBlock({height, lnd});
-
-    equal(fromHex(block).getId(), hash, 'Got block for height');
+    equal(idForBlock({block}).id, hash, 'Got block for height');
   } catch (err) {
     equal(err, null, 'Expected no error');
   }
@@ -50,7 +44,7 @@ test(`Get height`, async ({end, equal, fail}) => {
   try {
     const {block} = await getBlock({lnd});
 
-    equal(fromHex(block).getId(), hash, 'Got chain tip block');
+    equal(idForBlock({block}).id, hash, 'Got chain tip block');
   } catch (err) {
     equal(err, null, 'Expected no error');
   }

package/test/integration/test_open_channel.js

@@ -15,6 +15,7 @@ const count = 100;
 const defaultBaseFee = '1000';
 const defaultFee = 1e3;
 const defaultVout = 0;
+const description = 'description';
 const feeRate = 420;
 const giftTokens = 1000;
 const interval = 250;
@@ -36,6 +37,7 @@ test(`Open channel`, async ({end, equal}) => {
     await addPeer({lnd, public_key: target.id, socket: target.socket});
 
     return await openChannel({
+      description,
       lnd,
       base_fee_mtokens: baseFee,
       chain_fee_tokens_per_vbyte: defaultFee,
@@ -62,6 +64,10 @@ test(`Open channel`, async ({end, equal}) => {
       throw new Error('ExpectedChannelOpened');
     }
 
+    if (!!channel.description) {
+      equal(channel.description, description, 'Description set');
+    }
+
     const {policies} = await getChannel({lnd, id: channel.id});
 
     const policy = policies.find(n => n.public_key === id);

package/test/integration/test_subscribe_to_channels.js

@@ -12,6 +12,7 @@ const {subscribeToChannels} = require('./../../');
 
 const channelCapacityTokens = 1e6;
 const defaultFee = 1e3;
+const description = 'description';
 const giveTokens = 1e5;
 const interval = 100;
 const size = 2;
@@ -56,6 +57,7 @@ test('Subscribe to channels', async ({end, equal, fail}) => {
 
     // Create a channel from the control to the target node
     return await openChannel({
+      description,
       lnd,
       socket,
       chain_fee_tokens_per_vbyte: defaultFee,
@@ -105,6 +107,11 @@ test('Subscribe to channels', async ({end, equal, fail}) => {
     equal(openEvent.local_balance, 890950, 'Channel local balance returned');
   }
 
+  // LND 0.16.3 and below do not support channel descriptions
+  if (!!openEvent.description) {
+    equal(openEvent.description, description, 'Got channel open description');
+  }
+
   equal(openEvent.capacity, channelCapacityTokens, 'Channel open capacity');
   equal(!!openEvent.id, true, 'Channel id is returned');
   equal(openEvent.is_active, true, 'Channel is active');

package/test/walletrpc-integration/test_send_to_chain_output_scripts.js

@@ -1,8 +1,8 @@
 const asyncRetry = require('async/retry');
+const {componentsOfTransaction} = require('@alexbosworth/blockchain');
 const {script} = require('bitcoinjs-lib');
 const {spawnLightningCluster} = require('ln-docker-daemons');
 const {test} = require('@alexbosworth/tap');
-const {Transaction} = require('bitcoinjs-lib');
 
 const {getChainTransactions} = require('./../../');
 const {sendToChainOutputScripts} = require('./../../');
@@ -12,7 +12,6 @@ const asHex = buffer => buffer.toString('hex');
 const {compile} = script;
 const confirmationCount = 6;
 const count = 100;
-const {fromHex} = Transaction;
 const interval = 10;
 const OP_RETURN = 0x6a;
 const size = 2;
@@ -33,9 +32,8 @@ test(`Send to chain output scripts`, async ({end, equal, strictSame}) => {
 
   const sent = await sendToChainOutputScripts({lnd, send_to: sendTo});
 
-  const outs = fromHex(sent.transaction).outs
-    .filter(n => n.value === tokens)
-    .map(({script, value}) => ({script: asHex(script), tokens: value}));
+  const outs = componentsOfTransaction({transaction: sent.transaction}).outputs
+    .filter(n => n.tokens === tokens);
 
   // The OP_RETURN is present in the output
   strictSame(outs, sendTo, 'Got expected outputs');

package/test/walletrpc-integration/test_sign_psbt.js

@@ -1,5 +1,4 @@
 const asyncRetry = require('async/retry');
-const {address} = require('bitcoinjs-lib');
 const {decodePsbt} = require('psbt');
 const {spawnLightningCluster} = require('ln-docker-daemons');
 const {test} = require('@alexbosworth/tap');
@@ -19,7 +18,6 @@ const confirmationCount = 6;
 const count = 100;
 const description = 'description';
 const format = 'p2wpkh';
-const {fromBech32} = address;
 const interval = 10;
 const regtestBech32AddressHrp = 'bcrt';
 const size = 2;