ln-service 54.4.1 → 54.6.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Versions
 
+## 54.6.0
+
+- `getBlock`: Add method to retrieve the raw bytes of a block in the chain
+
+## 54.5.0
+
+- `getFailedPayments`, `getInvoices`, `getPayments`, `getPendingPayments`: add
+    support for date based filtering with `created_after` and `created_before`
+    arguments
+
 ## 54.4.1
 
 - `subscribeToRpcRequests`: `open_channel_request` add support for

package/README.md

@@ -139,6 +139,7 @@ for `unlocker` methods.
 - [getAutopilot](#getautopilot) - Get autopilot status or node scores
 - [getBackup](#getbackup) - Get a backup of a channel
 - [getBackups](#getbackups) - Get a backup for all channels
+- [getBlock](#getblock) - Get the raw block data given a block id in the chain
 - [getChainBalance](#getchainbalance) - Get the confirmed chain balance
 - [getChainFeeEstimate](#getchainfeeestimate) - Get a chain fee estimate
 - [getChainFeeRate](#getchainfeerate) - Get the fee rate for a conf target
@@ -1408,6 +1409,38 @@ const {getBackups} = require('ln-service');
 const {backup} = await getBackups({lnd});
 ```
 
+### getBlock
+
+Get a block in the chain
+
+This method requires LND built with `chainkit` build tag
+
+Requires `onchain:read` permission
+
+This method is not supported on LND 0.15.5 and below
+
+    {
+      id: <Block Hash Hex String>
+      lnd: <Authenticated LND API Object>
+    }
+
+    @returns via cbk or Promise
+    {
+      block: <Raw Block Bytes Hex String>
+    }
+
+Example:
+
+```node
+const {getBlock, getHeight} = require('ln-service');
+
+const chain = await getHeight({lnd});
+
+const {block} = await getBlock({lnd, id: chain.current_block_hash});
+
+const lastBlockSize = Buffer.from(block, 'hex').byteLength();
+```
+
 ### getChainBalance
 
 Get balance on the chain.
@@ -1832,7 +1865,12 @@ Get failed payments made through channels.
 
 Requires `offchain:read` permission
 
+`created_after` is not supported on LND 0.15.5 and below
+`created_before` is not supported on LND 0.15.5 and below
+
     {
+      [created_after]: <Creation Date After or Equal to ISO 8601 Date String>
+      [created_before]: <Creation Date Before or Equal to ISO 8601 Date String>
       [limit]: <Page Result Limit Number>
       lnd: <Authenticated LND API Object>
       [token]: <Opaque Paging Token String>
@@ -2176,7 +2214,12 @@ Requires `invoices:read` permission
 
 Invoice `payment` is not supported on LND 0.11.1 and below
 
+`created_after` is not supported on LND 0.15.5 and below
+`created_before` is not supported on LND 0.15.5 and below
+
     {
+      [created_after]: <Creation Date After or Equal to ISO 8601 Date String>
+      [created_before]: <Creation Date Before or Equal to ISO 8601 Date String>
       [is_unconfirmed]: <Omit Canceled and Settled Invoices Bool>
       [limit]: <Page Result Limit Number>
       lnd: <Authenticated LND API Object>
@@ -2631,7 +2674,12 @@ Get payments made through channels.
 
 Requires `offchain:read` permission
 
+`created_after` is not supported on LND 0.15.5 and below
+`created_before` is not supported on LND 0.15.5 and below
+
     {
+      [created_after]: <Creation Date After or Equal to ISO 8601 Date String>
+      [created_before]: <Creation Date Before or Equal to ISO 8601 Date String>
       [limit]: <Page Result Limit Number>
       lnd: <Authenticated LND API Object>
       [token]: <Opaque Paging Token String>
@@ -2848,7 +2896,12 @@ Get pending payments made through channels.
 
 Requires `offchain:read` permission
 
+`created_after` is not supported on LND 0.15.5 and below
+`created_before` is not supported on LND 0.15.5 and below
+
     {
+      [created_after]: <Creation Date After or Equal to ISO 8601 Date String>
+      [created_before]: <Creation Date Before or Equal to ISO 8601 Date String>
       [limit]: <Page Result Limit Number>
       lnd: <Authenticated LND API Object>
       [token]: <Opaque Paging Token String>

package/index.js

@@ -33,6 +33,7 @@ const {getAccessIds} = require('lightning');
 const {getAutopilot} = require('lightning');
 const {getBackup} = require('lightning');
 const {getBackups} = require('lightning');
+const {getBlock} = require('lightning');
 const {getChainBalance} = require('lightning');
 const {getChainFeeEstimate} = require('lightning');
 const {getChainFeeRate} = require('lightning');
@@ -185,6 +186,7 @@ module.exports = {
   getAutopilot,
   getBackup,
   getBackups,
+  getBlock,
   getChainBalance,
   getChainFeeEstimate,
   getChainFeeRate,

package/package.json

@@ -11,7 +11,7 @@
     "cors": "2.8.5",
     "express": "4.18.2",
     "invoices": "2.2.2",
-    "lightning": "6.4.1",
+    "lightning": "6.6.0",
     "macaroon": "3.0.4",
     "morgan": "1.10.0",
     "ws": "8.11.0"
@@ -28,7 +28,7 @@
     "bn.js": "5.2.1",
     "bs58check": "2.1.2",
     "ecpair": "2.1.0",
-    "ln-docker-daemons": "4.0.0",
+    "ln-docker-daemons": "4.0.2",
     "p2tr": "1.3.2",
     "portfinder": "1.0.32",
     "psbt": "2.7.1",
@@ -64,5 +64,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": "54.4.1"
+  "version": "54.6.0"
 }

package/test/chainrpc-integration/test_get_block.js

@@ -0,0 +1,35 @@
+const asyncRetry = require('async/retry');
+const {Block} = require('bitcoinjs-lib');
+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({});
+
+  const [{chain, generate, kill, lnd}] = nodes;
+
+  const blockchain = await getHeight({lnd});
+
+  try {
+    const {block} = await getBlock({lnd, id: blockchain.current_block_hash});
+
+    equal(fromHex(block).getId(), blockchain.current_block_hash, 'Got block');
+  } catch (err) {
+    const [code, message] = err;
+
+    equal(code, 501, 'Got expected code');
+    equal(message, 'GetBlockMethodNotSupported', 'Got expected message');
+  }
+
+  await kill({});
+
+  return end();
+});

package/test/integration/test_subscribe_to_rpc_requests.js

@@ -185,23 +185,29 @@ test(`Subscribe to RPC requests`, async ({end, equal, fail, strictSame}) => {
       }
     });
 
-    try {
-      // Attempt a channel close with an address
-      await closeChannel({
-        lnd,
-        address: 'address',
-        transaction_id: Buffer.alloc(32).toString('hex'),
-        transaction_vout: 0,
-      });
+    await asyncRetry({interval, times}, async () => {
+      try {
+        // Attempt a channel close with an address
+        await closeChannel({
+          lnd,
+          address: 'address',
+          transaction_id: Buffer.alloc(32).toString('hex'),
+          transaction_vout: 0,
+        });
 
-      fail('ExpectedChannelCloseRejected');
-    } catch (err) {
-      const [code, message, raw] = err;
+        fail('ExpectedChannelCloseRejected');
+      } catch (err) {
+        const [code, message, raw] = err;
 
-      strictSame(code, 503, 'Close fails with server error');
-      strictSame(message, 'UnexpectedCloseChannelError', 'Close err message');
-      strictSame(raw.err.details, 'message', 'Custom message received');
-    }
+        if (raw.err.details !== 'message') {
+          throw err;
+        }
+
+        strictSame(code, 503, 'Close fails with server error');
+        strictSame(message, 'UnexpectedCloseChannelError', 'Close err message');
+        strictSame(raw.err.details, 'message', 'Custom message received');
+      }
+    });
 
     subscription.removeAllListeners();
   }