lightning 9.13.4 → 10.0.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Versions
 
+## 10.0.0
+
+- Add support for LND 0.17.0-beta
+
+### Breaking Changes
+
+- End support for node.js 16, require 18 or higher
+- `emitGrpcEvents`, `grpcRouter`, `lndGateway`: Remove gRPC gateway methods
+
+## 9.14.0
+
+- `openChannel`: Add `is_allowing_minimal_reserve` to allow no reserve on peer
+
 ## 9.13.4
 
 - `openChannels`: Add `is_simplified_taproot` to make a simplified taproot chan

package/grpc/protos/lightning.proto

@@ -2453,6 +2453,11 @@ message ChanPointShim {
     the value is less than 500,000, or as an absolute height otherwise.
     */
     uint32 thaw_height = 6;
+
+    /*
+    Indicates that the funding output is using a MuSig2 multi-sig output.
+    */
+    bool musig2 = 7;
 }
 
 message PsbtShim {

package/index.d.ts

@@ -1,4 +1,3 @@
-export * from './lnd_gateway';
 export * from './lnd_grpc';
 export * from './lnd_methods';
 export * from './typescript';

package/index.js

@@ -23,7 +23,6 @@ const {deletePendingChannel} = require('./lnd_methods');
 const {diffieHellmanComputeSecret} = require('./lnd_methods');
 const {disableChannel} = require('./lnd_methods');
 const {disconnectWatchtower} = require('./lnd_methods');
-const {emitGrpcEvents} = require('./lnd_gateway');
 const {enableChannel} = require('./lnd_methods');
 const {endGroupSigningSession} = require('./lnd_methods');
 const {fundPendingChannels} = require('./lnd_methods');
@@ -79,9 +78,7 @@ const {getWalletInfo} = require('./lnd_methods');
 const {getWalletStatus} = require('./lnd_methods');
 const {getWalletVersion} = require('./lnd_methods');
 const {grantAccess} = require('./lnd_methods');
-const {grpcRouter} = require('./lnd_gateway');
 const {isDestinationPayable} = require('./lnd_methods');
-const {lndGateway} = require('./lnd_gateway');
 const {lockUtxo} = require('./lnd_methods');
 const {openChannel} = require('./lnd_methods');
 const {openChannels} = require('./lnd_methods');
@@ -179,7 +176,6 @@ module.exports = {
   enableChannel,
   endGroupSigningSession,
   diffieHellmanComputeSecret,
-  emitGrpcEvents,
   fundPendingChannels,
   fundPsbt,
   getAccessIds,
@@ -233,9 +229,7 @@ module.exports = {
   getWalletStatus,
   getWalletVersion,
   grantAccess,
-  grpcRouter,
   isDestinationPayable,
-  lndGateway,
   lockUtxo,
   openChannel,
   openChannels,

package/lnd_methods/info/constants.json

@@ -22,6 +22,7 @@
     "15c1eb13972f86a7c1e8cb084aa6d52700d685ff": "0.14.5-beta",
     "1a3194d302f33bb52823297d9d7f75cd37516053": "0.10.0-beta",
     "1e511be523eb8e97c4e2d9c89a7a263963a3929f": "0.14.2-beta",
+    "2fb150c8fe827df9df0520ef9916b3afb7b03a8d": "0.17.0-beta",
     "3ae46d81f4a2edad06ef778b2940d9b06386d93b": "0.11.0-beta",
     "47483f1c66ae6fbb2e03ff29f9bc9b80c611c027": "0.16.3-beta",
     "4f567577db9d85b6f392f960b3aabddcad3cd02c": "0.13.3-beta",

package/lnd_methods/onchain/open_channel.d.ts

@@ -24,6 +24,8 @@ export type ChannelOpenOptions = {
   /** Tokens to Gift To Partner */
   give_tokens?: number;
   inputs?: ChannelOpenOptionsInput[]
+  /** Allow Peer to Have Minimal Reserve Bool */
+  is_allowing_minimal_reserve?: boolean;
   /** Use Maximal Chain Funds For Local Funding Bool */
   is_max_funding?: boolean;
   /** Channel is Private */

package/lnd_methods/onchain/open_channel.js

@@ -11,6 +11,7 @@ const errMemoLength = /^provided memo \(.*\) is of length \d*, exceeds (\d*)$/;
 const {isArray} = Array;
 const minChannelTokens = 20000;
 const method = 'openChannel';
+const reserve = isDust => isDust ? 354 : undefined;
 const simplifiedTaprootChannelType = 'SIMPLE_TAPROOT';
 const type = 'default';
 
@@ -28,6 +29,8 @@ const type = 'default';
   `--protocol.option-scid-alias` and `--protocol.zero-conf` set on both sides
   as well as a channel open request listener to accept the trusted funding.
 
+  `is_allowing_minimal_reserve` is not supported on LND 0.15.0 and below
+
   `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
 
@@ -51,6 +54,7 @@ const type = 'default';
       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>
@@ -157,6 +161,7 @@ module.exports = (args, cbk) => {
           node_pubkey: Buffer.from(args.partner_public_key, 'hex'),
           outpoints: outpoints || undefined,
           private: !!args.is_private,
+          remote_chan_reserve_sat: reserve(!!args.is_allowing_minimal_reserve),
           remote_csv_delay: args.partner_csv_delay || undefined,
           spend_unconfirmed: !minConfs,
           use_base_fee: args.base_fee_mtokens !== undefined,

package/package.json

@@ -7,36 +7,30 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.9.4",
+    "@grpc/grpc-js": "1.9.5",
     "@grpc/proto-loader": "0.7.10",
-    "@types/express": "4.17.18",
-    "@types/node": "20.7.0",
+    "@types/node": "20.8.2",
     "@types/request": "2.48.9",
     "@types/ws": "8.5.6",
     "async": "3.2.4",
     "asyncjs-util": "1.2.12",
     "bitcoinjs-lib": "6.1.5",
     "bn.js": "5.2.1",
-    "body-parser": "1.20.2",
     "bolt07": "1.8.4",
     "bolt09": "1.0.0",
-    "cbor": "9.0.1",
     "ecpair": "2.1.0",
-    "express": "4.18.2",
     "invoices": "3.0.0",
     "psbt": "3.0.0",
     "tiny-secp256k1": "2.2.3",
-    "type-fest": "4.3.2"
+    "type-fest": "4.3.3"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
-    "@alexbosworth/node-fetch": "2.6.2",
     "tsd": "0.29.0",
-    "typescript": "5.2.2",
-    "ws": "8.14.2"
+    "typescript": "5.2.2"
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
   "keywords": [
     "grpc",
@@ -59,5 +53,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "9.13.4"
+  "version": "10.0.0"
 }

package/test/lnd_methods/onchain/test_open_channel.js

@@ -76,6 +76,7 @@ const makeArgs = overrides => {
     lnd: makeLnd({}),
     give_tokens: 1,
     local_tokens: 1e6,
+    is_allowing_minimal_reserve: true,
     partner_public_key: Buffer.alloc(33).toString('hex'),
   };
 

package/lnd_gateway/bearer_token.js

@@ -1,30 +0,0 @@
-const authHeaderName = 'authorization';
-const bearerTokenRegex = /Bearer\s(\S+)/;
-
-/** Parse out bearer token
-
-  {}
-
-  @returns
-  {
-    middleware: <Parse Bearer Token Express Middleware Function>
-  }
-*/
-module.exports = ({}) => {
-  const middleware = (req, res, next) => {
-    const authHeaderValue = req.get(authHeaderName);
-
-    // Exit early when there is no bearer token
-    if (!authHeaderValue) {
-      return next();
-    }
-
-    const [, bearer] = authHeaderValue.match(bearerTokenRegex);
-
-    res.locals.auth = {bearer};
-
-    return next();
-  };
-
-  return {middleware};
-};

package/lnd_gateway/decode_cbor_body.js

@@ -1,30 +0,0 @@
-const {decodeFirst} = require('cbor');
-
-const badArgumentsCode = 400;
-
-/** Create express middleware to decode a CBOR body
-
-  {}
-
-  @returns
-  {
-    middleware: <Middleware Function>
-  }
-*/
-module.exports = ({}) => {
-  const middleware = (req, res, next) => {
-    decodeFirst(req.body, (err, decoded) => {
-      if (!!err) {
-        return next([badArgumentsCode, 'ExpectedCborRequestArgs']);
-      }
-
-      req.body = decoded;
-
-      return next();
-    });
-
-    return;
-  };
-
-  return {middleware};
-};

package/lnd_gateway/emit_event.js

@@ -1,18 +0,0 @@
-const {decodeFirst} = require('cbor');
-
-/** Emit an proxy response
-
-  {
-    emitter: <Emit Response EventEmitter Object>
-    message: <CBOR Encoded gRPC Event and Data Message>
-  }
-*/
-module.exports = ({emitter, message}) => {
-  return decodeFirst(message, (err, decoded) => {
-    if (!!err) {
-      return emitter.emit('error', new Error('FailedToDecodeGatewayResponse'));
-    }
-
-    return emitter.emit(decoded.event, decoded.data);
-  });
-};

package/lnd_gateway/emit_grpc_events.d.ts

@@ -1,17 +0,0 @@
-export type GrpcConnection = {
-  /** Base64 or Hex Serialized LND TLS Cert String */
-  cert?: string;
-  /** Host:Port Network Address String */
-  socket?: string;
-  ws: {
-    /** Add Event Listener Function */
-    on: (event: string, listener: (...args: any[]) => void) => void;
-    /** Send Data Function */
-    send: (message: any) => void;
-  };
-};
-
-/**
- * Emit events from a gRPC call
- */
-export function emitGrpcEvents(connection: GrpcConnection): void;

package/lnd_gateway/emit_grpc_events.js

@@ -1,50 +0,0 @@
-const {decodeFirst} = require('cbor');
-
-const {authenticatedLndGrpc} = require('./../lnd_grpc');
-const encodeResponse = require('./encode_response');
-const subscribeToResponse = require('./subscribe_to_response');
-
-const encodeType = 'blob';
-const invalidMessageErr = 'ExpectedValidCborWsMessage';
-
-/** Emit events from a gRPC call
-
-  {
-    [cert]: <Base64 or Hex Serialized LND TLS Cert String>
-    [socket]: <Host:Port Network Address String>
-    ws: {
-      on: <Add Event Listener Function>
-      send: <Send Data Function>
-    }
-  }
-*/
-module.exports = ({cert, socket, ws}) => {
-  let cancel = () => {};
-
-  ws.binaryType = encodeType;
-
-  ws.on('close', () => cancel());
-
-  ws.on('message', message => {
-    return decodeFirst(message, async (err, decoded) => {
-      if (!!err) {
-        const {response} = await encodeResponse({
-          data: {details: invalidMessageErr},
-          event: 'error',
-        });
-
-        return ws.send(response);
-      }
-
-      const {macaroon, method, params, server} = decoded;
-
-      const {lnd} = authenticatedLndGrpc({cert, macaroon, socket});
-
-      const sub = subscribeToResponse({lnd, method, params, server, ws});
-
-      cancel = sub.cancel;
-
-      return;
-    });
-  });
-};

package/lnd_gateway/encode_response.js

@@ -1,42 +0,0 @@
-const asyncAuto = require('async/auto');
-const {encodeAsync} = require('cbor');
-const {returnResult} = require('asyncjs-util');
-
-/** Encode a CBOR response
-
-  {
-    data: <Data Object>
-    event: <Event String>
-  }
-
-  @returns via cbk or Promise
-  {
-    response: <Response Buffer>
-  }
-*/
-module.exports = ({data, event}, cbk) => {
-  return new Promise((resolve, reject) => {
-    return asyncAuto({
-      // Check arguments
-      validate: cbk => {
-        if (!data) {
-          return cbk([400, 'ExpectedDataToEncodeResponse']);
-        }
-
-        if (!event) {
-          return cbk([400, 'ExpectedEventToEncodeResponse']);
-        }
-
-        return cbk();
-      },
-
-      // Encode the response to CBOR
-      encode: ['validate', ({}, cbk) => {
-        (async () => {
-          return cbk(null, {response: await encodeAsync({data, event})});
-        })();
-      }],
-    },
-    returnResult({reject, resolve, of: 'encode'}, cbk));
-  });
-};

package/lnd_gateway/execute_request.js

@@ -1,74 +0,0 @@
-const asyncAuto = require('async/auto');
-const {returnResult} = require('asyncjs-util');
-
-/** Execute an LND request and get the CBOR encoded result
-
-  {
-    lnd: <gRPC LND Object>
-    method: <Method Name String>
-    params: <gRPC API Arguments Object>
-    service: <Service Name String>
-  }
-
-  @returns via cbk or Promise
-  {
-    [err]: {
-      details: <Error Details String>
-      message: <Error Message String>
-    }
-    [res]: <Response Object>
-  }
-*/
-module.exports = ({lnd, method, params, service}, cbk) => {
-  return new Promise((resolve, reject) => {
-    return asyncAuto({
-      // Check arguments
-      validate: cbk => {
-        if (!lnd) {
-          return cbk([400, 'ExpectedLndToExecuteGatewayRequest']);
-        }
-
-        if (!method) {
-          return cbk([400, 'ExpectedMethodToExecuteGatewayRequest']);
-        }
-
-        if (!params) {
-          return cbk([400, 'ExpectedArgumentsToExecuteGatewayRequest']);
-        }
-
-        if (!service) {
-          return cbk([400, 'ExpectedServiceToExecuteGatewayRequest']);
-        }
-
-        return cbk();
-      },
-
-      // Execute request
-      execute: ['validate', ({}, cbk) => {
-        try {
-          return lnd[service][method](params, (err, res) => {
-            if (!!err) {
-              return cbk(null, {err});
-            }
-
-            return cbk(null, {res});
-          });
-        } catch (err) {
-          return cbk(null, {err});
-        }
-      }],
-
-      // Result of execution
-      result: ['execute', ({execute}, cbk) => {
-        if (!!execute.err) {
-          return cbk(null, {
-            err: {details: execute.err.details, message: execute.err.details},
-          });
-        }
-
-        return cbk(null, {res: execute.res});
-      }],
-    },
-    returnResult({reject, resolve, of: 'result'}, cbk));
-  });
-};

package/lnd_gateway/gateway_request.js

@@ -1,143 +0,0 @@
-const asyncAuto = require('async/auto');
-const {decodeFirst} = require('cbor');
-const {encodeAsync} = require('cbor');
-const {returnResult} = require('asyncjs-util');
-
-const cborContentType = 'application/cbor';
-const defaultRequestTimeoutMs = 1000 * 25;
-const errKey = 'err';
-const gatewayGrpcMethod = 'POST';
-const {keys} = Object;
-const okStatusCode = 200;
-const pathSeparator = '/';
-const resKey = 'res';
-const timeoutCode = 'ETIMEDOUT';
-
-/** Make a request to the gateway
-
-  {
-    [bearer]: <Bearer Authentication Token String>
-    call: {
-      method: <Call Method String>
-      params: <Call Arguments Object>
-      server: <Call Server String>
-    }
-    request: <Request Function>
-    url: <LND Gateway URL String>
-  }
-
-  @returns via cbk or Promise
-  <gRPC Result Object>
-*/
-module.exports = ({bearer, call, request, url}, cbk) => {
-  return new Promise((resolve, reject) => {
-    return asyncAuto({
-      // Check arguments
-      validate: cbk => {
-        if (!call) {
-          return cbk([400, 'ExpectedCallToMakeGatewayRequest']);
-        }
-
-        if (!call.params) {
-          return cbk([400, 'ExpectedCallArgumentsToMakeGatewayRequest']);
-        }
-
-        if (!call.method) {
-          return cbk([400, 'ExpectedCallMethodToMakeGatewayRequest']);
-        }
-
-        if (!call.server) {
-          return cbk([400, 'ExpectedCallServerToMakeGatewayRequest']);
-        }
-
-        if (!request) {
-          return cbk([400, 'ExpectedRequestFunctionToMakeGatewayRequest']);
-        }
-
-        if (!url) {
-          return cbk([400, 'ExpectedUrlToMakeGatewayRequest']);
-        }
-
-        return cbk();
-      },
-
-      // Request body CBOR encoded
-      encoded: ['validate', ({}, cbk) => {
-        return (async () => {
-          let encoded;
-
-          try { encoded = await encodeAsync(call.params); } catch (err) {}
-
-          if (!encoded) {
-            return cbk([400, 'FailedToEncodeCborForGatewayRequest']);
-          }
-
-          return cbk(null, encoded);
-        })();
-      }],
-
-      // Make request
-      makeRequest: ['encoded', ({encoded}, cbk) => {
-        return request({
-          auth: {bearer},
-          body: encoded,
-          encoding: null,
-          forever: true,
-          headers: {'content-type': cborContentType},
-          method: gatewayGrpcMethod,
-          timeout: defaultRequestTimeoutMs,
-          uri: [url, call.server, call.method].join(pathSeparator),
-        },
-        (err, response, encoded) => {
-          if (!!err && err.code === timeoutCode && !!err.connect) {
-            return cbk([503, 'FailedToConnectToLndGatewayServer']);
-          }
-
-          if (!!err && err.code === timeoutCode) {
-            return cbk([503, 'LndGatewayServerFailedToRespondBeforeTimeout']);
-          }
-
-          if (!!err) {
-            return cbk([503, 'UnexpectedErrorFromLndGatewayServer', {err}]);
-          }
-
-          if (!response) {
-            return cbk([503, 'UnexpectedEmptyResponseFromLndGatewayServer']);
-          }
-
-          const {statusCode} = response;
-
-          if (statusCode !== okStatusCode) {
-            return cbk([503, 'UnexpectedGatewayStatus', {code: statusCode}]);
-          }
-
-          if (!Buffer.isBuffer(encoded)) {
-            return cbk([503, 'UnexpectedNontBufferResponseFromLndGateway']);
-          }
-
-          return cbk(null, encoded);
-        });
-      }],
-
-      // Decode result
-      decodeResult: ['makeRequest', ({makeRequest}, cbk) => {
-        return decodeFirst(makeRequest, (err, decoded) => {
-          if (!!err) {
-            return cbk([503, 'UnexpectedErrDecodingGatewayResponse']);
-          }
-
-          if (!keys(decoded).find(n => n === errKey)) {
-            return cbk([503, 'ExpectedErrorAttributeInGatewayResponse']);
-          }
-
-          if (!keys(decoded).find(n => n === resKey)) {
-            return cbk([503, 'ExpectedResponseAttributeInGatewayResponse']);
-          }
-
-          return cbk(decoded.err, decoded.res);
-        });
-      }],
-    },
-    returnResult({reject, resolve, of: 'decodeResult'}, cbk));
-  });
-};

package/lnd_gateway/gateway_subscribe.js

@@ -1,53 +0,0 @@
-const EventEmitter = require('events');
-
-const {encodeAsync} = require('cbor');
-
-const emitEvent = require('./emit_event');
-const wsUrl = require('./ws_url');
-
-/** Subscribe to a gateway stream response
-
-  {
-    bearer: <Bearer Authentication Token String>
-    call: {
-      method: <Call Method String>
-      params: <Call Arguments Object>
-      server: <Call Server String>
-    }
-    websocket: <WebSocket Constructor Function>
-    url: <LND Gateway URL String>
-  }
-
-  @throws
-  <Error>
-
-  @returns
-  {
-    cancel: <Terminate Subscription Function>
-    on: <Event Listener Function>
-  }
-*/
-module.exports = ({bearer, call, websocket, url}) => {
-  const emitter = new EventEmitter();
-
-  const ws = new websocket(wsUrl({url}).url);
-
-  ws.on('close', () => {});
-  ws.on('error', err => emitter.emit('error', err));
-  ws.on('message', message => emitEvent({emitter, message}))
-
-  ws.on('open', async () => {
-    const bytes = await encodeAsync({
-      macaroon: bearer,
-      method: call.method,
-      params: call.params,
-      server: call.server,
-    });
-
-    return ws.send(new Uint8Array(bytes));
-  });
-
-  emitter.cancel = () => ws.close();
-
-  return emitter;
-};

package/lnd_gateway/grpc_response.js

@@ -1,42 +0,0 @@
-const {authenticatedLndGrpc} = require('./../lnd_grpc');
-const executeRequest = require('./execute_request');
-const returnResponse = require('./return_response');
-const {unauthenticatedLndGrpc} = require('./../lnd_grpc');
-
-const defaultSocket = '127.0.0.1:10009';
-
-/** Send response to call from gRPC
-
-  {
-    credentials: {
-      [cert]: <Base64 or Hex Serialized LND TLS Cert String>
-      [socket]: <Host:Port Network Address String>
-    }
-  }
-
-  @returns
-  {
-    middleware: <Middleware Function>
-  }
-*/
-module.exports = ({credentials}) => {
-  const middleware = ({body, params}, res) => {
-    const {cert} = credentials;
-    const macaroon = !!res.locals.auth ? res.locals.auth.bearer : undefined;
-    const socket = credentials.socket || defaultSocket;
-
-    const makeLnd = !!macaroon ? authenticatedLndGrpc: unauthenticatedLndGrpc;
-
-    const {lnd} = makeLnd({cert, macaroon, socket});
-
-    return executeRequest({
-      lnd,
-      method: params.method,
-      params: body,
-      service: params.service,
-    },
-    returnResponse({res}).responder);
-  };
-
-  return {middleware};
-};