lightning 10.2.0 → 10.3.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Versions
 
+## 10.3.0
+
+- `getConfiguration`: Add method to get the configuration file options
+
+## 10.2.1
+
+- `deleteChainTransaction`, `getChainTransaction`: Add types
+
 ## 10.2.0
 
 - `deleteChainTransaction`: Add method to delete a chain transaction
@@ -467,7 +475,7 @@
 
 ## 4.2.1
 
-- `getChannelBalance`: Corrrect typescript type for `unsettled_balance_mtokens`
+- `getChannelBalance`: Correct typescript type for `unsettled_balance_mtokens`
 - `subscribeToProbeForRoute`: Correct typescript type for `base_fee_mtokens`
 
 ## 4.2.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019-2023 Alex Bosworth
+Copyright (c) 2019-2024 Alex Bosworth
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -167,6 +167,8 @@ variables set:
     the node.
 - [getClosedChannels](https://github.com/alexbosworth/ln-service#getclosedchannels): List closed
     channels on the node.
+- [getConfiguration](https://github.com/alexbosworth/ln-service#getconfiguration):
+    Get the configuration file settings for the node and the log.
 - [getConnectedWatchtowers](https://github.com/alexbosworth/ln-service#getconnectedwatchtowers):
     List watchtowers that were added
 - [getEphemeralChannelIds](https://github.com/alexbosworth/ln-service#getephemeralchannelids):

package/grpc/protos/lightning.proto

@@ -143,6 +143,13 @@ service Lightning {
     */
     rpc GetInfo (GetInfoRequest) returns (GetInfoResponse);
 
+    /* lncli: 'getdebuginfo'
+    GetDebugInfo returns debug information concerning the state of the daemon
+    and its subsystems. This includes the full configuration and the latest log
+    entries from the log file.
+    */
+    rpc GetDebugInfo (GetDebugInfoRequest) returns (GetDebugInfoResponse);
+
     /** lncli: `getrecoveryinfo`
     GetRecoveryInfo returns information concerning the recovery mode including
     whether it's in a recovery mode, whether the recovery is finished, and the
@@ -322,7 +329,7 @@ service Lightning {
     optionally specify the add_index and/or the settle_index. If the add_index
     is specified, then we'll first start by sending add invoice events for all
     invoices with an add_index greater than the specified value. If the
-    settle_index is specified, the next, we'll send out all settle events for
+    settle_index is specified, then next, we'll send out all settle events for
     invoices with a settle_index greater than the specified value. One or both
     of these fields can be set. If no fields are set, then we'll only send out
     the latest add/settle events.
@@ -1952,6 +1959,14 @@ message GetInfoResponse {
     bool store_final_htlc_resolutions = 22;
 }
 
+message GetDebugInfoRequest {
+}
+
+message GetDebugInfoResponse {
+    map<string, string> config = 1;
+    repeated string log = 2;
+}
+
 message GetRecoveryInfoRequest {
 }
 message GetRecoveryInfoResponse {
@@ -4486,6 +4501,7 @@ message Failure {
         EXPIRY_TOO_FAR = 22;
         MPP_TIMEOUT = 23;
         INVALID_ONION_PAYLOAD = 24;
+        INVALID_ONION_BLINDING = 25;
 
         /*
         An internal error occurred.

package/grpc/protos/walletkit.proto

@@ -1067,6 +1067,8 @@ message BumpFeeRequest {
 }
 
 message BumpFeeResponse {
+    // The status of the bump fee operation.
+    string status = 1;
 }
 
 message ListSweepsRequest {

package/index.js

@@ -44,6 +44,7 @@ const {getChannel} = require('./lnd_methods');
 const {getChannelBalance} = require('./lnd_methods');
 const {getChannels} = require('./lnd_methods');
 const {getClosedChannels} = require('./lnd_methods');
+const {getConfiguration} = require('./lnd_methods');
 const {getConnectedWatchtowers} = require('./lnd_methods');
 const {getEphemeralChannelIds} = require('./lnd_methods');
 const {getFailedPayments} = require('./lnd_methods');
@@ -198,6 +199,7 @@ module.exports = {
   getChannelBalance,
   getChannels,
   getClosedChannels,
+  getConfiguration,
   getConnectedWatchtowers,
   getEphemeralChannelIds,
   getFailedPayments,

package/lnd_methods/index.js

@@ -43,6 +43,7 @@ const {getChannel} = require('./info');
 const {getChannelBalance} = require('./offchain');
 const {getChannels} = require('./offchain');
 const {getClosedChannels} = require('./offchain');
+const {getConfiguration} = require('./info');
 const {getConnectedWatchtowers} = require('./offchain');
 const {getEphemeralChannelIds} = require('./offchain');
 const {getFailedPayments} = require('./offchain');
@@ -196,6 +197,7 @@ module.exports = {
   getChannelBalance,
   getChannels,
   getClosedChannels,
+  getConfiguration,
   getConnectedWatchtowers,
   getEphemeralChannelIds,
   getFailedPayments,

package/lnd_methods/info/get_configuration.js

@@ -0,0 +1,84 @@
+const asyncAuto = require('async/auto');
+const {returnResult} = require('asyncjs-util');
+
+const {isLnd} = require('./../../lnd_requests');
+
+const asOptions = o => Object.keys(o).map(type => ({type, value: o[type]}));
+const errNotFound = 'unknown method GetDebugInfo for service lnrpc.Lightning';
+const {isArray} = Array;
+const isIncluding = (arr, test) => arr.findIndex(test) !== -1;
+const isNotString = n => typeof n !== 'string';
+const method = 'getDebugInfo';
+const type = 'default';
+const {values} = Object;
+
+/** Get the current configuration file settings and the output log
+
+  Requires `info:read`, `offchain:read`, `onchain:read`, `peers:read`
+  permissions
+
+  This method is not supported on LND 0.17.3 and below
+
+  {
+    lnd: <Authenticated LND API Object>
+  }
+
+  @returns via cbk or Promise
+  {
+    log: [<Log Line String>]
+    options: [{
+      type: <Option Type String>
+      value: <Option Value String>
+    }]
+  }
+*/
+module.exports = ({lnd}, cbk) => {
+  return new Promise((resolve, reject) => {
+    return asyncAuto({
+      // Check arguments
+      validate: cbk => {
+        if (!isLnd({lnd, method, type})) {
+          return cbk([400, 'ExpectedAuthenticatedLndGrpcForGetConfigRequest']);
+        }
+
+        return cbk();
+      },
+
+      // Get configuration info
+      getInfo: ['validate', ({}, cbk) => {
+        return lnd[type][method]({}, (err, res) => {
+          if (!!err && err.details === errNotFound) {
+            return cbk([501, 'GetDebugConfigurationInfoNotSupported']);
+          }
+
+          if (!!err) {
+            return cbk([503, 'UnexpectedGetDebugInfoError', {err}]);
+          }
+
+          if (!res) {
+            return cbk([503, 'ExpectedResponseForGetConfigurationRequest']);
+          }
+
+          if (!isArray(res.log)) {
+            return cbk([503, 'ExpectedLogInConfigurationResponse']);
+          }
+
+          if (isIncluding(res.log, isNotString)) {
+            return cbk([503, 'ExpectedAllLogEntriesAsStrings']);
+          }
+
+          if (!res.config) {
+            return cbk([503, 'ExpectedArrayOfConfigurationOptionsInResponse']);
+          }
+
+          if (isIncluding(values(res.config), isNotString)) {
+            return cbk([503, 'ExpectedAllConfigOptionsAsStrings']);
+          }
+
+          return cbk(null, {log: res.log, options: asOptions(res.config)});
+        });
+      }],
+    },
+    returnResult({reject, resolve, of: 'getInfo'}, cbk));
+  });
+};

package/lnd_methods/info/index.js

@@ -1,5 +1,6 @@
 const getAutopilot = require('./get_autopilot');
 const getChannel = require('./get_channel');
+const getConfiguration = require('./get_configuration');
 const getIdentity = require('./get_identity');
 const getMethods = require('./get_methods');
 const getNetworkCentrality = require('./get_network_centrality');
@@ -16,6 +17,7 @@ const subscribeToGraph = require('./subscribe_to_graph');
 module.exports = {
   getAutopilot,
   getChannel,
+  getConfiguration,
   getIdentity,
   getMethods,
   getNetworkCentrality,

package/lnd_methods/macaroon/methods.json

@@ -173,6 +173,10 @@
     "method": "ClosedChannels",
     "type": "default"
   },
+  "getConfiguration": {
+    "method": "GetDebugInfo",
+    "type": "default"
+  },
   "getConnectedWatchtowers": {
     "methods": ["ListTowers", "Policy", "Stats"],
     "type": "tower_client"

package/lnd_methods/offchain/subscribe_to_open_requests.d.ts

@@ -17,7 +17,7 @@ export type SubscribeToOpenRequestsChannelRequestEvent = {
     remote_max_htlcs?: number;
     /** Maximum HTLCs Value Millitokens */
     remote_max_pending_mtokens?: string;
-    /** Minimium HTLC Value Millitokens */
+    /** Minimum HTLC Value Millitokens */
     remote_min_htlc_mtokens?: string;
   }) => void;
   /** Capacity Tokens */

package/lnd_methods/offchain/subscribe_to_open_requests.js

@@ -41,7 +41,7 @@ const type = 'default';
       [remote_reserve]: <Minimum Tokens Peer Must Keep On Their Side Number>
       [remote_max_htlcs]: <Maximum Slots For Attaching HTLCs Number>
       [remote_max_pending_mtokens]: <Maximum HTLCs Value Millitokens String>
-      [remote_min_htlc_mtokens]: <Minimium HTLC Value Millitokens String>
+      [remote_min_htlc_mtokens]: <Minimum HTLC Value Millitokens String>
     }) -> {}
     capacity: <Capacity Tokens Number>
     chain: <Chain Id Hex String>

package/lnd_methods/onchain/delete_chain_transaction.d.ts

@@ -0,0 +1,19 @@
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+} from '../../typescript';
+
+export type DeleteChainTransactionArgs = AuthenticatedLightningArgs<{
+  /** Transaction Id Hex String */
+  id: string;
+}>;
+
+/**
+ *
+ * Remove a chain transaction.
+ *
+ * Requires `onchain:write` permission
+ *
+ * This method is not supported on LND 0.17.3 and below
+ */
+export const deleteChainTransaction: AuthenticatedLightningMethod<DeleteChainTransactionArgs>;

package/lnd_methods/onchain/get_chain_transaction.d.ts

@@ -0,0 +1,24 @@
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+} from '../../typescript';
+import {ChainTransaction} from './get_chain_transactions';
+
+export type GetChainTransactionArgs = AuthenticatedLightningArgs<{
+  /** Transaction Id Hex String */
+  id: string;
+}>;
+
+export type GetChainTransactionResult = ChainTransaction;
+
+/**
+ * Get a chain transaction.
+ *
+ * Requires `onchain:read` permission
+ *
+ * This method is not supported on LND 0.17.3 and below
+ */
+export const getChainTransaction: AuthenticatedLightningMethod<
+  GetChainTransactionArgs,
+  GetChainTransactionResult
+>;

package/lnd_methods/onchain/index.d.ts

@@ -1,6 +1,7 @@
 export * from './broadcast_chain_transaction';
 export * from './cancel_pending_channel';
 export * from './close_channel';
+export * from './delete_chain_transaction';
 export * from './fund_pending_channels';
 export * from './fund_psbt';
 export * from './get_block';
@@ -9,6 +10,7 @@ export * from './get_chain_addresses';
 export * from './get_chain_balance';
 export * from './get_chain_fee_estimate';
 export * from './get_chain_fee_rate';
+export * from './get_chain_transaction';
 export * from './get_chain_transactions';
 export * from './get_locked_utxos';
 export * from './get_master_public_keys';

package/package.json

@@ -7,9 +7,9 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.9.13",
+    "@grpc/grpc-js": "1.9.14",
     "@grpc/proto-loader": "0.7.10",
-    "@types/node": "20.10.4",
+    "@types/node": "20.11.5",
     "@types/request": "2.48.12",
     "@types/ws": "8.5.10",
     "async": "3.2.5",
@@ -22,11 +22,11 @@
     "invoices": "3.0.0",
     "psbt": "3.0.0",
     "tiny-secp256k1": "2.2.3",
-    "type-fest": "4.8.3"
+    "type-fest": "4.9.0"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
-    "tsd": "0.29.0",
+    "tsd": "0.30.4",
     "typescript": "5.3.3"
   },
   "engines": {
@@ -53,5 +53,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "10.2.0"
+  "version": "10.3.0"
 }

package/test/lnd_methods/info/test_get_configuration.js

@@ -0,0 +1,81 @@
+const {deepStrictEqual} = require('node:assert').strict;
+const {rejects} = require('node:assert').strict;
+const test = require('node:test');
+
+const {getConfiguration} = require('./../../../');
+
+const makeLnd = ({custom, err, res}) => {
+  const response = {config: {type: 'value'}, log: ['log']};
+
+  return {
+    default: {
+      getDebugInfo: ({}, cbk) => cbk(err, res !== undefined ? res : response),
+    },
+  };
+};
+
+const tests = [
+  {
+    args: {},
+    description: 'LND is required to get configuration info',
+    error: [400, 'ExpectedAuthenticatedLndGrpcForGetConfigRequest'],
+  },
+  {
+    args: {
+      lnd: makeLnd({
+        err: {
+          details: 'unknown method GetDebugInfo for service lnrpc.Lightning',
+        },
+      }),
+    },
+    description: 'Unknown service returns unsupported info',
+    error: [501, 'GetDebugConfigurationInfoNotSupported'],
+  },
+  {
+    args: {lnd: makeLnd({err: 'err'})},
+    description: 'Generic failure returns back the error',
+    error: [503, 'UnexpectedGetDebugInfoError', {err: 'err'}],
+  },
+  {
+    args: {lnd: makeLnd({res: null})},
+    description: 'Valid result is expected',
+    error: [503, 'ExpectedResponseForGetConfigurationRequest'],
+  },
+  {
+    args: {lnd: makeLnd({res: {}})},
+    description: 'Result should have a log',
+    error: [503, 'ExpectedLogInConfigurationResponse'],
+  },
+  {
+    args: {lnd: makeLnd({res: {log: [1]}})},
+    description: 'Result should have a log with strings',
+    error: [503, 'ExpectedAllLogEntriesAsStrings'],
+  },
+  {
+    args: {lnd: makeLnd({res: {log: []}})},
+    description: 'Result should have a config',
+    error: [503, 'ExpectedArrayOfConfigurationOptionsInResponse'],
+  },
+  {
+    args: {lnd: makeLnd({res: {config: {type: 1}, log: []}})},
+    description: 'Result should have a config',
+    error: [503, 'ExpectedAllConfigOptionsAsStrings'],
+  },
+  {
+    args: {lnd: makeLnd({})},
+    description: 'Configuration is returned',
+    expected: {log: ['log'], options: [{type: 'type', value: 'value'}]},
+  },
+];
+
+tests.forEach(({args, description, error, expected}) => {
+  return test(description, async () => {
+    if (!!error) {
+      await rejects(() => getConfiguration(args), error, 'Got error');
+    } else {
+      deepStrictEqual(await getConfiguration(args), expected, 'Got info');
+    }
+
+    return;
+  });
+});

package/test/lnd_methods/offchain/test_subscribe_to_probe_for_route.js

@@ -42,7 +42,7 @@ const sendToRouteFailure = {
 const makeLnd = ({count, getInfo, sendToRouteV2}) => {
   let returnedRoutes = 0;
 
-  const defaultSendTo = ({}, cbk) => cbk(null, {faillure: sendToRouteFailure});
+  const defaultSendTo = ({}, cbk) => cbk(null, {});
 
   const lnd = {
     default: {

package/test/lnd_methods/onchain/test_get_chain_fee_estimate.js

@@ -38,7 +38,7 @@ const tests = [
       lnd: {default: {estimateFee: ({}, cbk) => cbk('err')}},
       send_to: [{address: 'address', tokens: 1}],
     },
-    description: 'An error is pased back from fee estimate',
+    description: 'An error is passed back from fee estimate',
     error: [503, 'UnexpectedErrEstimatingFeeForChainSend', {err: 'err'}],
   },
   {