ln-service 56.13.0 → 57.0.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Versions
 
+## 57.0.0
+
+- Add support for LND 0.17.0
+
+### Breaking Changes
+
+- End support for node.js 16, require 18 or higher
+- Remove method `grpcProxyServer`
+
+## 56.14.0
+
+- `openChannel`: Add `is_allowing_minimal_reserve` to allow no reserve on peer
+
 ## 56.13.0
 
 - `openChannels`: Add `is_simplified_taproot` to make a simplified taproot chan

package/README.md

@@ -9,6 +9,7 @@ through npm.
 
 Supported LND versions:
 
+- v0.17.0-beta
 - v0.16.0-beta to v0.16.4-beta
 - v0.15.2-beta to v0.15.5-beta
 - v0.14.4-beta to v0.14.5-beta
@@ -3606,59 +3607,6 @@ const createInvoices = authenticatedLndGrpc({cert, macaroon, socket});
 const {request} = await createInvoice({lnd: createInvoices.lnd, tokens: 1});
 ```
 
-### grpcProxyServer
-
-Get a gRPC proxy server
-
-    {
-      [bind]: <Bind to Address String>
-      [cert]: <LND Cert Base64 String>
-      log: <Log Function>
-      path: <Router Path String>
-      port: <Listen Port Number>
-      socket: <LND Socket String>
-      stream: <Log Write Stream Object>
-    }
-
-    @returns
-    {
-      app: <Express Application Object>
-      server: <Web Server Object>
-      wss: <WebSocket Server Object>
-    }
-
-```node
-const {getWalletInfo} = require('ln-service');
-const {lndGateway} = require('lightning');
-const request = require('@alexbosworth/request');
-const websocket = require('ws');
-const {Writable} = require('stream');
-
-const log = output => log(output);
-const path = '/lnd/';
-const port = 8050;
-
-const {app, server, wss} = grpcProxyServer({
-  log,
-  path,
-  port,
-  cert: base64Encoded64TlsCertFileString,
-  socket: 'localhost:10009',
-  stream: new Writable({write: (chunk, encoding, cbk) => cbk()}),
-});
-
-// Create an authenticated LND for the gRPC REST gateway
-const {lnd} = lndGateway({
-  request,
-  websocket,
-  macaroon: base64EncodedMacaroonFileString,
-  url: `http://localhost:${port}${path}`,
-});
-
-// Make a request to a gRPC method through the REST proxy
-const nodeInfo = await getWalletInfo({lnd});
-```
-
 ### isDestinationPayable
 
 Determine if a payment destination is actually payable by probing it
@@ -3758,6 +3706,8 @@ 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_allowing_minimal_reserve` is not supported on LND 0.15.0 and below
+
 `is_max_funding` is not supported on LND 0.16.4 and below
 
 `description` is not supported on LND 0.16.4 and below
@@ -3778,6 +3728,7 @@ Requires `offchain:write`, `onchain:write`, `peers:write` permissions
         transaction_id: <Fund With Unspent Transaction Id Hex String>
         transaction_vout: <Fund With Unspent Transaction Output Index Number>
       }]
+      [is_allowing_minimal_reserve]: <Allow Peer to Have Minimal Reserve Bool>
       [is_max_funding]: <Use Maximal Chain Funds For Local Funding Bool>
       [is_private]: <Channel is Private Bool> // Defaults to false
       [is_simplified_taproot]: <Channel is Simplified Taproot Type Bool>

package/package.json

@@ -8,13 +8,9 @@
   },
   "dependencies": {
     "bolt07": "1.8.4",
-    "cors": "2.8.5",
-    "express": "4.18.2",
     "invoices": "3.0.0",
-    "lightning": "9.13.0",
-    "macaroon": "3.0.4",
-    "morgan": "1.10.0",
-    "ws": "8.13.0"
+    "lightning": "10.0.0",
+    "macaroon": "3.0.4"
   },
   "description": "Interaction helper for your Lightning Network daemon",
   "devDependencies": {
@@ -24,22 +20,22 @@
     "asyncjs-util": "1.2.12",
     "bip32": "4.0.0",
     "bip66": "1.1.5",
-    "bitcoinjs-lib": "6.1.3",
+    "bitcoinjs-lib": "6.1.5",
     "bn.js": "5.2.1",
     "bs58check": "3.0.1",
     "ecpair": "2.1.0",
-    "ln-docker-daemons": "5.1.3",
+    "ln-docker-daemons": "6.0.1",
     "p2tr": "2.0.0",
     "portfinder": "1.0.32",
     "psbt": "3.0.0",
-    "rimraf": "5.0.1",
+    "rimraf": "5.0.5",
     "secp256k1": "5.0.0",
     "tiny-secp256k1": "2.2.3",
-    "uuid": "9.0.0",
+    "uuid": "9.0.1",
     "varuint-bitcoin": "1.1.2"
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
   "keywords": [
     "bitcoin",
@@ -56,6 +52,7 @@
     "url": "https://github.com/alexbosworth/ln-service.git"
   },
   "scripts": {
+    "integration-test-0.17.0": "DOCKER_LND_VERSION=v0.17.0-beta npm run test",
     "integration-test-0.16.4": "DOCKER_LND_VERSION=v0.16.4-beta npm run test",
     "integration-test-0.16.3": "DOCKER_LND_VERSION=v0.16.3-beta npm run test",
     "integration-test-0.16.2": "DOCKER_LND_VERSION=v0.16.2-beta npm run test",
@@ -69,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": "56.13.0"
+  "version": "57.0.0"
 }

package/test/integration/test_open_low_reserve.js

@@ -0,0 +1,92 @@
+const {equal} = require('node:assert').strict;
+const test = require('node:test');
+
+const asyncRetry = require('async/retry');
+const {spawnLightningCluster} = require('ln-docker-daemons');
+
+const {addPeer} = require('./../../');
+const {getChannels} = require('./../../');
+const {getWalletInfo} = require('./../../');
+const {openChannel} = require('./../../');
+const {subscribeToOpenRequests} = require('./../../');
+
+const channelCapacityTokens = 1e6;
+const confirmationCount = 6;
+const count = 100;
+const dustLimit = 354;
+const interval = 10;
+const size = 2;
+const times = 2000;
+
+// Open a channel with a low channel reserve
+test(`Open channel but allow a minimal channel reserve`, async () => {
+  const {kill, nodes} = await spawnLightningCluster({size});
+
+  const [control, target] = nodes;
+
+  const {id, lnd} = control;
+
+  await target.generate({count});
+
+  await addPeer({lnd, public_key: target.id, socket: target.socket});
+
+  await asyncRetry({interval, times}, async () => {
+    const wallet = await getWalletInfo({lnd: target.lnd});
+
+    if (!wallet.is_synced_to_chain) {
+      throw new Error('ExpectedWalletSyncedToChain');
+    }
+  });
+
+  const acceptSub = subscribeToOpenRequests({lnd});
+
+  acceptSub.on('channel_request', request => {
+    request.accept({
+      min_confirmations: 1,
+      remote_csv: 999,
+      remote_reserve: 354,
+      remote_max_htlcs: 20,
+      remote_max_pending_mtokens: '200000',
+      remote_min_htlc_mtokens: '2000',
+    });
+
+    return;
+  });
+
+  try {
+    await asyncRetry({interval, times}, async () => {
+      return await openChannel({
+        lnd: target.lnd,
+        is_private: true,
+        is_allowing_minimal_reserve: true,
+        local_tokens: channelCapacityTokens,
+        partner_public_key: control.id,
+        socket: control.socket,
+      });
+    });
+  } catch (err) {
+    equal(err, null, 'Expected no error when a channel is accepted');
+  }
+
+  acceptSub.removeAllListeners();
+
+  await target.generate({count: confirmationCount});
+
+  const channel = await asyncRetry({interval, times}, async () => {
+    const [channel] = (await getChannels({lnd})).channels;
+
+    await control.generate({});
+
+    if (!channel) {
+      throw new Error('ExpectedChannelCreation');
+    }
+
+    return channel;
+  });
+
+  equal(channel.remote_reserve, dustLimit, 'Got minimal reserve value');
+
+  await kill({});
+
+  return;
+});

package/routers/grpc_proxy_server.js

@@ -1,76 +0,0 @@
-const {createServer} = require('https');
-
-const cors = require('cors');
-const {emitGrpcEvents} = require('lightning');
-const express = require('express');
-const {grpcRouter} = require('lightning');
-const logger = require('morgan');
-const {Server} = require('ws');
-
-const defaultBind = '127.0.0.1';
-const hexAsBuffer = hex => Buffer.from(hex, 'hex');
-const logFormat = ':method :url :status - :response-time ms - :user-agent';
-const makeServer = (app, cert, key) => createServer({cert, key}, app);
-
-/** Get a gRPC proxy server
-
-  {
-    [bind]: <Bind to Address String>
-    [cert]: <LND Cert Base64 String>
-    log: <Log Function>
-    path: <Router Path String>
-    port: <Listen Port Number>
-    socket: <LND Socket String>
-    stream: <Log Write Stream Object>
-    [tls]: {
-      cert: <Server Cert Hex String>
-      key: <Server Key Hex String>
-      port: <TLS Server Port Number>
-    }
-  }
-
-  @returns
-  {
-    app: <Express Application Object>
-    [secure]: {
-      server: <HTTPS Server Object>
-      wss: <HTTPS WebSocket Server Object>
-    }
-    server: <Web Server Object>
-    wss: <WebSocket Server Object>
-  }
-*/
-module.exports = ({bind, cert, log, path, port, socket, stream, tls}) => {
-  const app = express();
-
-  const server = app
-    .listen(port, () => log(null, `Listening: ${port}`))
-    .on('error', err => log([500, 'ListenError', err]));
-
-  if (!!tls) {
-    const tlsCert = hexAsBuffer(tls.cert);
-    const tlsKey = hexAsBuffer(tls.key);
-
-    const secure = makeServer(app, tlsCert, tlsKey);
-
-    const secureWss = new Server({server: secure});
-
-    secureWss.on('connection', ws => emitGrpcEvents({cert, socket, ws}));
-
-    secure.listen(tls.port);
-
-    log(null, `Listening for TLS: ${tls.port}`);
-  }
-
-  app.use(cors());
-  app.use(logger(logFormat, {stream}));
-
-  app.use(path, grpcRouter({cert, socket}));
-
-  const wss = new Server({server});
-
-  wss.on('connection', ws => emitGrpcEvents({cert, socket, ws}));
-  wss.on('listening', () => {});
-
-  return {app, server, wss};
-};

package/routers/index.js

@@ -1,3 +0,0 @@
-const grpcProxyServer = require('./grpc_proxy_server');
-
-module.exports = {grpcProxyServer};