lightning 6.3.0 → 6.3.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Versions
 
-## 6.3.0
+## 6.3.1
 
 - `getSettlementStatus`: Add method to lookup received htlc settlement status
 

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.4 and below
+ *
+ * Requires `offchain:read` permissions
+ */
+export const getSettlementStatus: AuthenticatedLightningMethod<
+  GetSettlementStatusArgs,
+  GetSettlementStatusResult
+>;

package/lnd_methods/offchain/get_settlement_status.js

@@ -18,6 +18,7 @@ const type = 'default';
 
   {
     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/package.json

@@ -23,7 +23,7 @@
     "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"
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "6.3.0"
+  "version": "6.3.1"
 }

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);
+  })
+);