lightning 6.3.0 → 6.3.2

package/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Versions
 
-## 6.3.0
+## 6.3.2
+
+- `getWalletInfo`: Add support for LND 0.15.5
+
+## 6.3.1
 
 - `getSettlementStatus`: Add method to lookup received htlc settlement status
 

package/lnd_methods/info/constants.json

@@ -37,6 +37,7 @@
     "aff2ed3a6a118d664049835c325a5b69e977172f": "0.15.2-beta",
     "b4e7131bdb47531ad2f00ce345ddcdb58935bba5": "0.15.3-beta",
     "bd0c46b4fcb027af1915bd67a3da70e8ca5c6efe": "0.14.3-beta",
+    "c0a09209782b1c62c3393fcea0844e095c25046b": "0.15.5-beta",
     "d176d2d65fc06e6631c4dc9478592be8545a21de": "0.12.0-beta",
     "d233f61383f2f950aa06f5b09da5b0e78e784fae": "0.12.1-beta",
     "d62c575f8499a314eb27f12462d20500b6bda2c7": "0.10.3-beta",

package/lnd_methods/offchain/get_settlement_status.d.ts

@@ -0,0 +1,30 @@
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+} from '../../typescript';
+
+export type GetSettlementStatusArgs = AuthenticatedLightningArgs<{
+  /** Standard Format Channel Id String */
+  channel: string;
+  /** Payment Id Number */
+  payment: number;
+}>;
+
+export type GetSettlementStatusResult = {
+  /** Payment Went to Chain Bool */
+  is_onchain: boolean;
+  /** Payment Is Settled Into Non-HTLC Balance Bool */
+  is_settled: boolean;
+};
+
+/**
+ * Get the settlement status of a received HTLC
+ *
+ * Note: this method is not supported in LND versions 0.15.5 and below
+ *
+ * Requires `offchain:read` permissions
+ */
+export const getSettlementStatus: AuthenticatedLightningMethod<
+  GetSettlementStatusArgs,
+  GetSettlementStatusResult
+>;

package/lnd_methods/offchain/get_settlement_status.js

@@ -12,12 +12,13 @@ const type = 'default';
 
 /** Get the settlement status of a received HTLC
 
-  Note: this method is not supported in LND versions 0.15.4 and below
+  Note: this method is not supported in LND versions 0.15.5 and below
 
   Requires `offchain:read` permissions
 
   {
     channel: <Standard Format Channel Id String>
+    lnd: <Authenticated LND API Object>
     payment: <Payment Id Number>
   }
 

package/lnd_methods/offchain/index.d.ts

@@ -27,6 +27,7 @@ export * from './get_payments';
 export * from './get_pending_channels';
 export * from './get_pending_payments';
 export * from './get_route_through_hops';
+export * from './get_settlement_status';
 export * from './is_destination_payable';
 export * from './pay_via_payment_details';
 export * from './pay_via_payment_request';

package/lnd_methods/offchain/subscribe_to_forward_requests.js

@@ -83,7 +83,7 @@ module.exports = ({lnd}) => {
       const request = rpcForwardAsForwardRequest(data);
 
       return emitter.emit(event, {
-        accept: () => sub.write({
+        accept: async () => await sub.write({
           action: forwardPaymentActions.accept,
           incoming_circuit_key: data.incoming_circuit_key,
         }),
@@ -97,11 +97,11 @@ module.exports = ({lnd}) => {
         mtokens: request.mtokens,
         onion: request.onion,
         out_channel: request.out_channel,
-        reject: () => sub.write({
+        reject: async () => await sub.write({
           action: forwardPaymentActions.reject,
           incoming_circuit_key: data.incoming_circuit_key,
         }),
-        settle: ({secret}) => sub.write({
+        settle: async ({secret}) => await sub.write({
           action: forwardPaymentActions.settle,
           incoming_circuit_key: data.incoming_circuit_key,
           preimage: bufferFromHex(secret),

package/lnd_methods/offchain/subscribe_to_payments.d.ts

@@ -17,6 +17,6 @@ export type SubscribeToPaymentsPaymentEvent =
  *
  * Requires `offchain:read` permission
  *
- * Note: Method not supported on LND 0.15.4 and below
+ * Note: Method not supported on LND 0.15.5 and below
  */
 export const subscribeToPayments: AuthenticatedLightningSubscription<SubscribeToPaymentsArgs>;

package/lnd_methods/offchain/subscribe_to_payments.js

@@ -13,7 +13,7 @@ const type = 'router';
 
   Requires `offchain:read` permission
 
-  Note: Method not supported on LND 0.15.4 and below
+  Note: Method not supported on LND 0.15.5 and below
 
   {
     lnd: <Authenticated LND API Object>

package/lnd_methods/onchain/open_channel.d.ts

@@ -50,8 +50,8 @@ export type OpenChannelResult = {
  *
  * External funding requires LND compiled with `walletrpc` build tag
  *
- * `base_fee_mtokens` is not supported on LND 0.15.4 and below
- * `fee_rate` is not supported on LND 0.15.4 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
  */
 export const openChannel: AuthenticatedLightningMethod<
   OpenChannelArgs,

package/lnd_methods/onchain/open_channel.js

@@ -20,8 +20,8 @@ const type = 'default';
 
   External funding requires LND compiled with `walletrpc` build tag
 
-  `base_fee_mtokens` is not supported on LND 0.15.4 and below
-  `fee_rate` is not supported on LND 0.15.4 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
 
   {
     [base_fee_mtokens]: <Routing Base Fee Millitokens Charged String>

package/lnd_methods/onchain/open_channels.d.ts

@@ -56,8 +56,8 @@ channel that was not funded.
   `--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.
 
- * `base_fee_mtokens` is not supported on LND 0.15.4 and below
- * `fee_rate` is not supported on LND 0.15.4 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
  */
 export const openChannels: AuthenticatedLightningMethod<
   OpenChannelsArgs,

package/lnd_methods/onchain/open_channels.js

@@ -37,8 +37,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.
 
-  `base_fee_mtokens` is not supported on LND 0.15.4 and below
-  `fee_rate` is not supported on LND 0.15.4 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
 
   {
     channels: [{

package/package.json

@@ -10,7 +10,7 @@
     "@grpc/grpc-js": "1.7.3",
     "@grpc/proto-loader": "0.7.3",
     "@types/express": "4.17.14",
-    "@types/node": "18.11.9",
+    "@types/node": "18.11.10",
     "@types/request": "2.48.8",
     "@types/ws": "8.5.3",
     "async": "3.2.4",
@@ -23,16 +23,16 @@
     "cbor": "8.1.0",
     "ecpair": "2.1.0",
     "express": "4.18.2",
-    "invoices": "2.2.1",
+    "invoices": "2.2.2",
     "psbt": "2.7.1",
     "tiny-secp256k1": "2.2.1",
-    "type-fest": "3.2.0"
+    "type-fest": "3.3.0"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
     "@alexbosworth/node-fetch": "2.6.2",
     "@alexbosworth/tap": "15.0.11",
-    "tsd": "0.24.1",
+    "tsd": "0.25.0",
     "typescript": "4.9.3",
     "ws": "8.11.0"
   },
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "6.3.0"
+  "version": "6.3.2"
 }

package/test/typescript/get_settlement_status.test-d.ts

@@ -0,0 +1,26 @@
+import {expectError, expectType} from 'tsd';
+import {AuthenticatedLnd} from '../../lnd_grpc';
+import {
+  getSettlementStatus,
+  GetSettlementStatusResult,
+} from '../../lnd_methods';
+
+const lnd = {} as AuthenticatedLnd;
+const channel = 'channel id';
+const payment = 0;
+
+expectError(getSettlementStatus());
+expectError(getSettlementStatus({}));
+expectError(getSettlementStatus({lnd}));
+expectError(getSettlementStatus({lnd, channel}));
+expectError(getSettlementStatus({lnd, payment}));
+
+expectType<GetSettlementStatusResult>(
+  await getSettlementStatus({lnd, channel, payment})
+);
+
+expectType<void>(
+  getSettlementStatus({lnd, channel, payment}, (error, result) => {
+    expectType<GetSettlementStatusResult>(result);
+  })
+);