lightning 5.3.4 → 5.4.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Versions
 
+## 5.4.0
+
+- `deletePendingChannel`: Add method to delete a stuck pending channel
+- `getInvoices`: Fill in type definition for `is_unconfirmed`
+
 ## 5.3.4
 
 - `getPayments`: Correct paging issue that prevented paging through all results

package/lnd_methods/invoices/get_invoices.d.ts

@@ -4,7 +4,12 @@ import {
   PaginationArgs,
 } from '../../typescript';
 
-export type GetInvoicesArgs = AuthenticatedLightningArgs<PaginationArgs>;
+export type GetInvoicesArgs = AuthenticatedLightningArgs<
+  PaginationArgs & {
+    /** Omit Canceled and Settled Invoices Bool */
+    is_unconfirmed?: boolean;
+  }
+>;
 
 export type GetInvoicesResult = {
   invoices: {

package/lnd_methods/offchain/delete_pending_channel.d.ts

@@ -0,0 +1,21 @@
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+} from '../../typescript';
+
+export type DeletePendingChannelArgs = AuthenticatedLightningArgs<{
+  /** Hex Encoded Conflicting Transaction String */
+  confirmed_transaction: string;
+  /** Hex Encoded Pending Transaction String */
+  pending_transaction: string;
+  /** Pending Channel Output Index Number */
+  pending_transaction_vout: number;
+}>;
+
+/**
+ * Delete a pending channel
+ *
+ * Pass the confirmed conflicting transaction that spends the same input to make sure that no funds are being deleted.
+ * This method is not supported on LND 0.13.3 and below
+ */
+export const deletePendingChannel: AuthenticatedLightningMethod<DeletePendingChannelArgs>;

package/lnd_methods/offchain/index.d.ts

@@ -5,6 +5,7 @@ export * from './delete_failed_payments';
 export * from './delete_forwarding_reputations';
 export * from './delete_payment';
 export * from './delete_payments';
+export * from './delete_pending_channel';
 export * from './disable_channel';
 export * from './disconnect_watchtower';
 export * from './enable_channel';

package/package.json

@@ -57,5 +57,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.3.4"
+  "version": "5.4.0"
 }

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

@@ -0,0 +1,43 @@
+import {expectError, expectType} from 'tsd';
+import {AuthenticatedLnd} from '../../lnd_grpc';
+import {deletePendingChannel} from '../../lnd_methods';
+
+const lnd = {} as AuthenticatedLnd;
+const confirmed_transaction = 'tx0';
+const pending_transaction = 'tx1';
+const pending_transaction_vout = 1;
+
+expectError(deletePendingChannel());
+expectError(deletePendingChannel({}));
+expectError(deletePendingChannel({lnd}));
+expectError(deletePendingChannel({confirmed_transaction}));
+expectError(deletePendingChannel({pending_transaction}));
+expectError(deletePendingChannel({pending_transaction_vout}));
+expectError(deletePendingChannel({lnd, confirmed_transaction}));
+expectError(deletePendingChannel({lnd, pending_transaction}));
+expectError(deletePendingChannel({lnd, pending_transaction_vout}));
+expectError(
+  deletePendingChannel({lnd, confirmed_transaction, pending_transaction})
+);
+expectError(
+  deletePendingChannel({lnd, confirmed_transaction, pending_transaction_vout})
+);
+expectError(
+  deletePendingChannel({lnd, pending_transaction, pending_transaction_vout})
+);
+
+expectType<void>(
+  await deletePendingChannel({
+    lnd,
+    confirmed_transaction,
+    pending_transaction,
+    pending_transaction_vout,
+  })
+);
+
+expectType<void>(
+  deletePendingChannel(
+    {lnd, confirmed_transaction, pending_transaction, pending_transaction_vout},
+    () => {}
+  )
+);

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

@@ -5,14 +5,18 @@ import {getInvoices, GetInvoicesResult} from '../../lnd_methods';
 const lnd = {} as AuthenticatedLnd;
 const limit = 100;
 const token = 'token';
+const is_unconfirmed = true;
 
 expectError(getInvoices());
 expectError(getInvoices({}));
 expectError(getInvoices({lnd, limit, token}));
+expectError(getInvoices({lnd, limit, token, is_unconfirmed}));
 
 expectType<GetInvoicesResult>(await getInvoices({lnd}));
 expectType<GetInvoicesResult>(await getInvoices({lnd, limit}));
+expectType<GetInvoicesResult>(await getInvoices({lnd, limit, is_unconfirmed}));
 expectType<GetInvoicesResult>(await getInvoices({lnd, token}));
+expectType<GetInvoicesResult>(await getInvoices({lnd, token, is_unconfirmed}));
 
 expectType<void>(
   getInvoices({lnd}, (error, result) => {
@@ -24,8 +28,18 @@ expectType<void>(
     expectType<GetInvoicesResult>(result);
   })
 );
+expectType<void>(
+  getInvoices({lnd, limit, is_unconfirmed}, (error, result) => {
+    expectType<GetInvoicesResult>(result);
+  })
+);
 expectType<void>(
   getInvoices({lnd, token}, (error, result) => {
     expectType<GetInvoicesResult>(result);
   })
 );
+expectType<void>(
+  getInvoices({lnd, token, is_unconfirmed}, (error, result) => {
+    expectType<GetInvoicesResult>(result);
+  })
+);