lightning 10.14.4 → 10.15.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Versions
 
+## 10.15.0
+
+- `authenticatedLndGrpc`, `unauthenticatedLndGrpc`: Add `path` to specify the
+    protos directory
+
 ## 10.14.4
 
 - `getChannel`: Add support for specifying `transaction_id` and

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/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",
@@ -53,5 +53,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "10.14.4"
+  "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}) => {