ln-service 54.8.0 → 54.9.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 54.9.0
+
+- `getChainAddresses`: Add method to get the list of chain addresses
+
 ## 54.8.0
 
 - `subscribeToRpcRequests`: add `max_tokens_per_vbyte` to RPC close requests

package/README.md

@@ -140,6 +140,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
+- [getChainAddresses](#getchainaddresses) - Get created chain addresses
 - [getChainBalance](#getchainbalance) - Get the confirmed chain balance
 - [getChainFeeEstimate](#getchainfeeestimate) - Get a chain fee estimate
 - [getChainFeeRate](#getchainfeerate) - Get the fee rate for a conf target
@@ -1442,6 +1443,34 @@ const {block} = await getBlock({lnd, id: chain.current_block_hash});
 const lastBlockSize = Buffer.from(block, 'hex').byteLength();
 ```
 
+### getChainAddresses
+
+Get the wallet chain addresses
+
+Requires `onchain:read` permission
+
+This method is not supported on LND 0.15.5 and below
+
+    {
+      lnd: <Authenticated LND API Object>
+    }
+
+    @returns via cbk or Promise
+    {
+      addresses: [{
+        address: <Chain Address String>
+        is_change: <Is Internal Change Address Bool>
+        tokens: <Balance of Funds Controlled by Output Script Tokens Number>
+      }]
+    }
+
+```node
+const {getChainAddresses} = require('ln-service');
+
+// How many chain addresses have been created
+const numberOfChainAddresses = (await getChainAddresses({lnd})).addresses;
+```
+
 ### getChainBalance
 
 Get balance on the chain.
@@ -4285,7 +4314,7 @@ Preferred `confidence` is not supported on LND 0.14.5 and below
       [payment]: <Payment Identifier Hex String>
       [probe_timeout_ms]: <Probe Timeout Milliseconds Number>
       [routes]: [[{
-        [base_fee_mtokens]: <Base Routing Fee In Millitokens Number>
+        [base_fee_mtokens]: <Base Routing Fee In Millitokens Number String>
         [channel_capacity]: <Channel Capacity Tokens Number>
         [channel]: <Standard Format Channel Id String>
         [cltv_delta]: <CLTV Blocks Delta Number>
@@ -5526,13 +5555,6 @@ Requires `invoices:read` permission
       received: <Received Tokens Number>
       received_mtokens: <Received Millitokens String>
       request: <Bolt 11 Invoice String>
-      routes: [[{
-        base_fee_mtokens: <Base Routing Fee In Millitokens Number>
-        channel: <Standard Format Channel Id String>
-        cltv_delta: <CLTV Blocks Delta Number>
-        fee_rate: <Fee Rate In Millitokens Per Million Number>
-        public_key: <Public Key Hex String>
-      }]]
       secret: <Secret Preimage Hex String>
       tokens: <Tokens Number>
     }

package/index.js

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

package/package.json

@@ -7,33 +7,33 @@
     "url": "https://github.com/alexbosworth/ln-service/issues"
   },
   "dependencies": {
-    "bolt07": "1.8.2",
+    "bolt07": "1.8.3",
     "cors": "2.8.5",
     "express": "4.18.2",
-    "invoices": "2.2.2",
-    "lightning": "6.8.0",
+    "invoices": "2.2.3",
+    "lightning": "7.0.3",
     "macaroon": "3.0.4",
     "morgan": "1.10.0",
     "ws": "8.11.0"
   },
   "description": "Interaction helper for your Lightning Network daemon",
   "devDependencies": {
-    "@alexbosworth/tap": "15.0.11",
+    "@alexbosworth/tap": "15.0.12",
     "@alexbosworth/node-fetch": "2.6.2",
     "async": "3.2.4",
-    "asyncjs-util": "1.2.10",
+    "asyncjs-util": "1.2.11",
     "bip32": "3.1.0",
     "bip66": "1.1.5",
     "bitcoinjs-lib": "6.1.0",
     "bn.js": "5.2.1",
     "bs58check": "2.1.2",
     "ecpair": "2.1.0",
-    "ln-docker-daemons": "4.0.2",
-    "p2tr": "1.3.2",
+    "ln-docker-daemons": "4.0.3",
+    "p2tr": "1.3.3",
     "portfinder": "1.0.32",
-    "psbt": "2.7.1",
+    "psbt": "2.7.2",
     "rimraf": "3.0.2",
-    "secp256k1": "4.0.3",
+    "secp256k1": "5.0.0",
     "tiny-secp256k1": "2.2.1",
     "uuid": "9.0.0",
     "varuint-bitcoin": "1.1.2"
@@ -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.8.0"
+  "version": "54.9.0"
 }

package/test/walletrpc-integration/test_get_chain_addresses.js

@@ -0,0 +1,58 @@
+const {spawnLightningCluster} = require('ln-docker-daemons');
+const {test} = require('@alexbosworth/tap');
+
+const {createChainAddress} = require('./../../');
+const {getChainAddresses} = require('./../../');
+
+const count = 100;
+const expiry = () => new Date(Date.now() + (1000 * 60 * 5)).toISOString();
+
+// Getting chain addresses should return a list of addresses
+test(`Get chain addresses`, async ({end, equal, rejects, strictSame}) => {
+  const [{generate, kill, lnd}] = (await spawnLightningCluster({})).nodes;
+
+  try {
+    await getChainAddresses({lnd});
+  } catch (err) {
+    // LND 0.12.1 does not support getting locked UTXOs
+    strictSame(
+      err,
+      [501, 'BackingLndDoesNotSupportGettingChainAddresses'],
+      'Got unsupported error'
+    );
+
+    await kill({});
+
+    return end();
+  }
+
+  try {
+    const expected = [
+      {
+        address: (await createChainAddress({lnd, format: 'np2wpkh'})).address,
+        is_change: false,
+        tokens: 0,
+      },
+      {
+        address: (await createChainAddress({lnd})).address,
+        is_change: false,
+        tokens: 0,
+      },
+      {
+        address: (await createChainAddress({lnd, format: 'p2tr'})).address,
+        is_change: false,
+        tokens: 0,
+      },
+    ];
+
+    const {addresses} = await getChainAddresses({lnd});
+
+    strictSame(addresses, expected, 'Got created chain addresses');
+  } catch (err) {
+    strictSame(err, null, 'Expected no error');
+  }
+
+  await kill({});
+
+  return end();
+});

package/test/walletrpc-integration/test_get_locked_utxos.js

@@ -8,8 +8,8 @@ const {lockUtxo} = require('./../../');
 const count = 100;
 const expiry = () => new Date(Date.now() + (1000 * 60 * 5)).toISOString();
 
-// Locking a UTXO should result in the UTXO being unspendable
-test(`Lock UTXO`, async ({end, equal, rejects, strictSame}) => {
+// Getting locked UTXOs should result in a list of locked UTXOs
+test(`Get locked UTXOs`, async ({end, equal, rejects, strictSame}) => {
   const [{generate, kill, lnd}] = (await spawnLightningCluster({})).nodes;
 
   try {