lightning 10.14.3 → 10.15.0

package/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Versions
 
-## 10.14.3
+## 10.15.0
+
+- `authenticatedLndGrpc`, `unauthenticatedLndGrpc`: Add `path` to specify the
+    protos directory
+
+## 10.14.4
 
 - `getChannel`: Add support for specifying `transaction_id` and
     `transaction_vout` instead of `id`

package/grpc/protos/invoices.proto

@@ -55,10 +55,19 @@ service Invoices {
     rpc SettleInvoice (SettleInvoiceMsg) returns (SettleInvoiceResp);
 
     /*
-    LookupInvoiceV2 attempts to look up at invoice. An invoice can be refrenced
+    LookupInvoiceV2 attempts to look up at invoice. An invoice can be referenced
     using either its payment hash, payment address, or set ID.
     */
     rpc LookupInvoiceV2 (LookupInvoiceMsg) returns (lnrpc.Invoice);
+
+    /*
+    HtlcModifier is a bidirectional streaming RPC that allows a client to
+    intercept and modify the HTLCs that attempt to settle the given invoice. The
+    server will send HTLCs of invoices to the client and the client can modify
+    some aspects of the HTLC in order to pass the invoice acceptance tests.
+    */
+    rpc HtlcModifier (stream HtlcModifyResponse)
+        returns (stream HtlcModifyRequest);
 }
 
 message CancelInvoiceMsg {
@@ -191,4 +200,46 @@ message LookupInvoiceMsg {
     }
 
     LookupModifier lookup_modifier = 4;
+}
+
+// CircuitKey is a unique identifier for an HTLC.
+message CircuitKey {
+    /// The id of the channel that the is part of this circuit.
+    uint64 chan_id = 1;
+
+    /// The index of the incoming htlc in the incoming channel.
+    uint64 htlc_id = 2;
+}
+
+message HtlcModifyRequest {
+    // The invoice the intercepted HTLC is attempting to settle. The HTLCs in
+    // the invoice are only HTLCs that have already been accepted or settled,
+    // not including the current intercepted HTLC.
+    lnrpc.Invoice invoice = 1;
+
+    // The unique identifier of the HTLC of this intercepted HTLC.
+    CircuitKey exit_htlc_circuit_key = 2;
+
+    // The amount in milli-satoshi that the exit HTLC is attempting to pay.
+    uint64 exit_htlc_amt = 3;
+
+    // The absolute expiry height of the exit HTLC.
+    uint32 exit_htlc_expiry = 4;
+
+    // The current block height.
+    uint32 current_height = 5;
+
+    // The wire message custom records of the exit HTLC.
+    map<uint64, bytes> exit_htlc_wire_custom_records = 6;
+}
+
+message HtlcModifyResponse {
+    // The circuit key of the HTLC that the client wants to modify.
+    CircuitKey circuit_key = 1;
+
+    // The modified amount in milli-satoshi that the exit HTLC is paying. This
+    // value can be different from the actual on-chain HTLC amount, in case the
+    // HTLC carries other valuable items, as can be the case with custom channel
+    // types. In order to not modify this value, the client should set it zero.
+    uint64 amt_paid = 2;
 }

package/grpc/protos/router.proto

@@ -330,6 +330,15 @@ message SendPaymentRequest {
     only, to 1 to optimize for reliability only or a value inbetween for a mix.
     */
     double time_pref = 23;
+
+    /*
+    If set, the payment loop can be interrupted by manually canceling the
+    payment context, even before the payment timeout is reached. Note that the
+    payment may still succeed after cancellation, as in-flight attempts can
+    still settle afterwards. Canceling will only prevent further attempts from
+    being sent.
+    */
+    bool cancelable = 24;
 }
 
 message TrackPaymentRequest {

package/lnd_grpc/authenticated_lnd_grpc.js

@@ -24,6 +24,7 @@ const pathForProto = proto => join(__dirname, protosDir, proto);
   {
     [cert]: <Base64 or Hex Serialized LND TLS Cert>
     [macaroon]: <Base64 or Hex Serialized Macaroon String>
+    [path]: <Path to Proto Files Directory String>
     [socket]: <Host:Port Network Address String>
   }
 
@@ -47,7 +48,7 @@ const pathForProto = proto => join(__dirname, protosDir, proto);
     }
   }
 */
-module.exports = ({cert, macaroon, socket}) => {
+module.exports = ({cert, macaroon, path, socket}) => {
   const {credentials} = grpcCredentials({cert, macaroon});
   const lndSocket = socket || defaultSocket;
 
@@ -65,11 +66,13 @@ module.exports = ({cert, macaroon, socket}) => {
     lnd: keys(serviceTypes).reduce((services, type) => {
       const service = serviceTypes[type];
 
+      const file = protoFiles[service];
+
       services[type] = apiForProto({
         credentials,
         params,
         service,
-        path: pathForProto(protoFiles[service]),
+        path: !!path ? join(path, file) : pathForProto(file),
         socket: lndSocket,
         type: packageTypes[service],
       });

package/lnd_grpc/unauthenticated_lnd_grpc.d.ts

@@ -1,6 +1,8 @@
 export type LndAuthentication = {
   /** Base64 or Hex Serialized LND TLS Cert String */
   cert?: string;
+  /** Path to proto files */
+  path?: string;
   /** Host:Port String */
   socket?: string;
 };

package/lnd_grpc/unauthenticated_lnd_grpc.js

@@ -14,6 +14,7 @@ const {unauthenticatedServiceTypes} = require('./../grpc');
 
 const {GRPC_SSL_CIPHER_SUITES} = process.env;
 const {keys} = Object;
+const pathToProto = file => join(__dirname, protosDir, file);
 
 /** Unauthenticated gRPC interface to the Lightning Network Daemon (lnd).
 
@@ -21,6 +22,7 @@ const {keys} = Object;
 
   {
     [cert]: <Base64 or Hex Serialized LND TLS Cert String>
+    [path]: <Path to Proto Files Directory String>
     [socket]: <Host:Port String>
   }
 
@@ -35,7 +37,7 @@ const {keys} = Object;
     }
   }
 */
-module.exports = ({cert, socket}) => {
+module.exports = ({cert, path, socket}) => {
   const credentials = grpcSsl({cert}).ssl;
   const lndSocket = socket || defaultSocket;
 
@@ -48,7 +50,9 @@ module.exports = ({cert, socket}) => {
     lnd: keys(unauthenticatedServiceTypes).reduce((services, type) => {
       const service = unauthenticatedServiceTypes[type];
 
-      const protoPath = join(__dirname, protosDir, protoFiles[service]);
+      const file = protoFiles[service];
+
+      const protoPath = !!path ? join(path, file) : pathToProto(file);
 
       const rpc = grpc.loadPackageDefinition(loadSync(protoPath, grpcOptions));
 

package/lnd_methods/offchain/subscribe_to_pay.js

@@ -409,6 +409,7 @@ module.exports = args => {
         allow_self_payment: true,
         amt: amounts.tokens,
         amt_msat: amounts.mtokens,
+        cancelable: true,
         cltv_limit: !!args.max_timeout_height ? maxCltvDelta : undefined,
         dest: !args.destination ? undefined : hexToBuf(args.destination),
         dest_custom_records: !messages.length ? undefined : destTlv,

package/package.json

@@ -7,9 +7,9 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.10.10",
+    "@grpc/grpc-js": "1.10.11",
     "@grpc/proto-loader": "0.7.13",
-    "@types/node": "20.14.9",
+    "@types/node": "20.14.10",
     "@types/request": "2.48.12",
     "@types/ws": "8.5.10",
     "async": "3.2.5",
@@ -22,12 +22,12 @@
     "invoices": "3.0.0",
     "psbt": "3.0.0",
     "tiny-secp256k1": "2.2.3",
-    "type-fest": "4.20.1"
+    "type-fest": "4.21.0"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
     "tsd": "0.31.1",
-    "typescript": "5.5.2"
+    "typescript": "5.5.3"
   },
   "engines": {
     "node": ">=18"
@@ -53,5 +53,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "10.14.3"
+  "version": "10.15.0"
 }

package/test/lnd_grpc/test_authenticated_lnd_grpc.js

@@ -1,5 +1,6 @@
 const {deepStrictEqual} = require('node:assert').strict;
 const {equal} = require('node:assert').strict;
+const {join} = require('path');
 const test = require('node:test');
 
 const {authenticatedLndGrpc} = require('./../../');
@@ -30,6 +31,11 @@ const tests = [
     description: 'Passing a cert for the authenticated LND grpc is supported',
     expected: {services: expectedServices},
   },
+  {
+    args: {path: join(__dirname, '../../grpc/protos')},
+    description: 'The path can be specified',
+    expected: {services: expectedServices},
+  },
 ];
 
 tests.forEach(({args, description, expected}) => {

package/test/lnd_grpc/test_unauthenticated_lnd_grpc.js

@@ -1,5 +1,6 @@
 const {deepStrictEqual} = require('node:assert').strict;
 const {equal} = require('node:assert').strict;
+const {join} = require('path');
 const test = require('node:test');
 
 const {unauthenticatedLndGrpc} = require('./../../');
@@ -17,6 +18,11 @@ const tests = [
     description: 'Passing a cert for the authenticated LND grpc is supported',
     expected: {services: expectedServices},
   },
+  {
+    args: {path: join(__dirname, '../../grpc/protos')},
+    description: 'The path can be specified',
+    expected: {services: expectedServices},
+  },
 ];
 
 tests.forEach(({args, description, expected}) => {