ln-service 57.0.1 → 57.1.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 57.1.0
+
+- `getBlockHeader`: Add method to get the header portion of a block
+
 ## 57.0.1
 
 - Add support for LND 0.17.0

package/README.md

@@ -175,6 +175,7 @@ for `unlocker` methods.
 - [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
+- [getBlockHeader](#getblockheader) - Get the raw block header for a block
 - [getChainAddresses](#getchainaddresses) - Get created chain addresses
 - [getChainBalance](#getchainbalance) - Get the confirmed chain balance
 - [getChainFeeEstimate](#getchainfeeestimate) - Get a chain fee estimate
@@ -1465,7 +1466,7 @@ const {backup} = await getBackups({lnd});
 
 Get a block in the chain
 
-This method requires LND built with `chainkit` build tag
+This method requires LND built with `chainrpc` build tag
 
 Requires `onchain:read` permission
 
@@ -1494,6 +1495,39 @@ const {block} = await getBlock({lnd, id: chain.current_block_hash});
 const lastBlockSize = Buffer.from(block, 'hex').byteLength();
 ```
 
+### getBlockHeader
+
+Get a block header in the best chain
+
+This method requires LND built with `chainrpc` build tag
+
+Requires `onchain:read` permission
+
+This method is not supported on LND 0.17.0 and below
+
+    {
+      [height]: <Block Height Number>
+      [id]: <Block Hash Hex String>
+      lnd: <Authenticated LND API Object>
+    }
+
+    @returns via cbk or Promise
+    {
+      header: <Raw Block Header Bytes Hex String>
+    }
+
+Example:
+
+```node
+const {getBlockHeader, getHeight} = require('ln-service');
+
+const chain = await getHeight({lnd});
+
+const {header} = await getBlockHeader({lnd, id: chain.current_block_hash});
+
+const lastBlockHeader = Buffer.from(header, 'hex');
+```
+
 ### getChainAddresses
 
 Get the wallet chain addresses

package/index.js

@@ -34,6 +34,7 @@ const {getAutopilot} = require('lightning');
 const {getBackup} = require('lightning');
 const {getBackups} = require('lightning');
 const {getBlock} = require('lightning');
+const {getBlockHeader} = require('lightning');
 const {getChainAddresses} = require('lightning');
 const {getChainBalance} = require('lightning');
 const {getChainFeeEstimate} = require('lightning');
@@ -190,6 +191,7 @@ module.exports = {
   getBackup,
   getBackups,
   getBlock,
+  getBlockHeader,
   getChainAddresses,
   getChainBalance,
   getChainFeeEstimate,

package/package.json

@@ -9,7 +9,7 @@
   "dependencies": {
     "bolt07": "1.8.4",
     "invoices": "3.0.0",
-    "lightning": "10.0.1",
+    "lightning": "10.1.0",
     "macaroon": "3.0.4"
   },
   "description": "Interaction helper for your Lightning Network daemon",
@@ -24,7 +24,7 @@
     "bn.js": "5.2.1",
     "bs58check": "3.0.1",
     "ecpair": "2.1.0",
-    "ln-docker-daemons": "6.0.1",
+    "ln-docker-daemons": "6.0.3",
     "p2tr": "2.0.0",
     "portfinder": "1.0.32",
     "psbt": "3.0.0",
@@ -66,5 +66,5 @@
     "integration-test-0.14.4": "DOCKER_LND_VERSION=v0.14.4-beta npm run test",
     "test": "echo $DOCKER_LND_VERSION && node test/runner"
   },
-  "version": "57.0.1"
+  "version": "57.1.0"
 }

package/test/chainrpc-integration/test_get_block_header.js

@@ -0,0 +1,62 @@
+const {strictEqual} = require('node:assert').strict;
+const test = require('node:test');
+
+const {spawnLightningCluster} = require('ln-docker-daemons');
+
+const {getBlockHeader} = require('./../../');
+const {getHeight} = require('./../../');
+
+const headerHexLength = 80 * 2;
+
+// Get block header should return the block header
+test(`Get block header`, async () => {
+  const {nodes} = await spawnLightningCluster({});
+
+  const [{chain, generate, kill, lnd}] = nodes;
+
+  const blockchain = await getHeight({lnd});
+
+  const hash = blockchain.current_block_hash;
+  const height = blockchain.current_block_height;
+
+  // Try getting a block header by the hash
+  try {
+    const {header} = await getBlockHeader({
+      lnd,
+      id: blockchain.current_block_hash,
+    });
+
+    strictEqual(header.length, headerHexLength, 'Got header');
+  } catch (err) {
+    const [code, message] = err;
+
+    strictEqual(code, 501, 'Got expected code');
+    strictEqual(message, 'GetBlockHeaderMethodNotSupported', 'Got error');
+
+    await kill({});
+
+    return;
+  }
+
+  // Try getting a block header by the height
+  try {
+    const {header} = await getBlockHeader({height, lnd});
+
+    strictEqual(header.length, headerHexLength, 'Got header');
+  } catch (err) {
+    strictEqual(err, null, 'Expected no error');
+  }
+
+  // Try getting the chain tip block header
+  try {
+    const {header} = await getBlockHeader({lnd});
+
+    strictEqual(header.length, headerHexLength, 'Got header');
+  } catch (err) {
+    strictEqual(err, null, 'Expected no error');
+  }
+
+  await kill({});
+
+  return;
+});