lightning 5.3.1 → 5.4.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # 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
+
+## 5.3.3
+
+- `pay`, `payViaPaymentRequest`: Fix support for `outgoing_channels` constraint
+
 ## 5.3.1
 
 - `getInvoices`: Add `is_unconfirmed` to filter out canceled/settled invoices

package/README.md

@@ -7,17 +7,26 @@ Methods for working with the Lightning Network
 ## Selected Projects using Lightning
 
 - [coinos.io](https://coinos.io/) - https://github.com/coinos/coinos-server
-- [LNMarkets](https://twitter.com/lnmarkets) - https://github.com/lnmarkets/umbrel
+- [Lightning Shell](https://lightningshell.app/) -
+    https://github.com/ibz/lightning-shell
+- [LNMarkets](https://twitter.com/lnmarkets) -
+    https://github.com/lnmarkets/umbrel
 - [Galoy](https://galoy.io/) - https://github.com/GaloyMoney/galoy
 - [Tarnhelm](https://www.tarnhelm.app/) - https://github.com/bkiac/tarnhelm
-- [tbtcswaps](https://tbtcswaps.com/) - https://github.com/keep-community/tbtcswaps
-- [stackernews](https://stacker.news/) - https://github.com/stackernews/stacker.news
-- [Thunderhub](https://www.thunderhub.io/) - https://github.com/apotdevin/thunderhub
-- [Lightning Roulette](https://lightning-roulette.com/) - https://github.com/igreshev/lightning-roulette
-- [Lightning Poker](https://lightning-poker.com/) - https://github.com/igreshev/lightning-poker
+- [tbtcswaps](https://tbtcswaps.com/) -
+    https://github.com/keep-community/tbtcswaps
+- [stackernews](https://stacker.news/) -
+    https://github.com/stackernews/stacker.news
+- [Thunderhub](https://www.thunderhub.io/) -
+    https://github.com/apotdevin/thunderhub
+- [Lightning Roulette](https://lightning-roulette.com/) -
+    https://github.com/igreshev/lightning-roulette
+- [Lightning Poker](https://lightning-poker.com/) -
+    https://github.com/igreshev/lightning-poker
 - [p2plnbot](https://telegram.me/lnp2pbot) - https://github.com/grunch/p2plnbot
 - [rekr](https://rekr.app/) - https://github.com/ryan-lingle/rekr
-- [Suredbits API](https://suredbits.com/) - https://github.com/Suredbits/sb-api-lnd
+- [Suredbits API](https://suredbits.com/) -
+    https://github.com/Suredbits/sb-api-lnd
 
 ## LND Authentication
 

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/get_failed_payments.js

@@ -8,7 +8,7 @@ const {sortBy} = require('./../../arrays');
 const defaultLimit = 250;
 const {isArray} = Array;
 const isFailed = payment => !!payment && payment.status === 'FAILED';
-const lastPageFirstIndexOffset = 0;
+const lastPageFirstIndexOffset = 1;
 const method = 'listPayments';
 const {parse} = JSON;
 const {stringify} = JSON;
@@ -152,7 +152,7 @@ module.exports = ({limit, lnd, token}, cbk) => {
 
           return cbk(null, {
             payments: res.payments.filter(isFailed),
-            token: offset === lastPageFirstIndexOffset ? undefined : token,
+            token: offset <= lastPageFirstIndexOffset ? undefined : token,
           });
         });
       }],

package/lnd_methods/offchain/get_payments.js

@@ -157,7 +157,7 @@ module.exports = ({limit, lnd, token}, cbk) => {
 
           return cbk(null, {
             payments: res.payments,
-            token: offset === lastPageFirstIndexOffset ? undefined : token,
+            token: offset <= lastPageFirstIndexOffset ? undefined : token,
           });
         });
       }],
@@ -185,7 +185,7 @@ module.exports = ({limit, lnd, token}, cbk) => {
         });
 
         return cbk(null, {
-          next: !!foundPayments.length ? listPayments.token : undefined,
+          next: listPayments.token || undefined,
           payments: payments.sorted.reverse(),
         });
       }],

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/lnd_methods/offchain/pay_via_payment_request.js

@@ -99,6 +99,7 @@ module.exports = (args, cbk) => {
           messages: args.messages,
           mtokens: args.mtokens,
           outgoing_channel: args.outgoing_channel,
+          outgoing_channels: args.outgoing_channels,
           pathfinding_timeout: args.pathfinding_timeout,
           request: args.request,
           tokens: args.tokens,

package/lnd_methods/unauthenticated/create_wallet.js

@@ -3,6 +3,8 @@ const {returnResult} = require('asyncjs-util');
 
 const {isLnd} = require('./../../lnd_requests');
 
+const bufferAsBase64 = buffer => buffer.toString('base64');
+const {isBuffer} = Buffer;
 const method = 'initWallet';
 const type = 'unlocker';
 const utf8AsBuf = utf8 => Buffer.from(utf8, 'utf8');
@@ -19,6 +21,9 @@ const utf8AsBuf = utf8 => Buffer.from(utf8, 'utf8');
   }
 
   @returns via cbk or Promise
+  {
+    macaroon: <Base64 Encoded Admin Macaroon String>
+  }
 */
 module.exports = ({lnd, passphrase, password, seed}, cbk) => {
   return new Promise((resolve, reject) => {
@@ -47,12 +52,20 @@ module.exports = ({lnd, passphrase, password, seed}, cbk) => {
           cipher_seed_mnemonic: seed.split(' '),
           wallet_password: utf8AsBuf(password),
         },
-        err => {
+        (err, res) => {
           if (!!err) {
             return cbk([503, 'UnexpectedInitWalletError', {err}]);
           }
 
-          return cbk();
+          if (!res) {
+            return cbk([503, 'ExpectedResponseForInitWallet']);
+          }
+
+          if (!isBuffer(res.admin_macaroon)) {
+            return cbk([503, 'ExpectedAdminMacaroonToCrateWallet']);
+          }
+
+          return cbk(null, bufferAsBase64(res.admin_macaroon));
         });
       }],
     },

package/package.json

@@ -7,32 +7,32 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.5.0",
+    "@grpc/grpc-js": "1.5.3",
     "@grpc/proto-loader": "0.6.9",
     "@types/express": "4.17.13",
-    "@types/node": "17.0.8",
+    "@types/node": "17.0.10",
     "@types/request": "2.48.8",
     "@types/ws": "8.2.2",
     "async": "3.2.3",
-    "asyncjs-util": "1.2.7",
+    "asyncjs-util": "1.2.8",
     "bitcoinjs-lib": "6.0.1",
     "bn.js": "5.2.0",
     "body-parser": "1.19.1",
     "bolt07": "1.8.0",
-    "bolt09": "0.2.0",
+    "bolt09": "0.2.1",
     "cbor": "8.1.0",
     "express": "4.17.2",
-    "invoices": "2.0.2",
+    "invoices": "2.0.3",
     "psbt": "1.1.10",
-    "type-fest": "2.9.0"
+    "type-fest": "2.10.0"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
     "@alexbosworth/node-fetch": "2.6.2",
     "@alexbosworth/tap": "15.0.10",
     "tsd": "0.19.1",
-    "typescript": "4.5.4",
-    "ws": "8.4.0"
+    "typescript": "4.5.5",
+    "ws": "8.4.2"
   },
   "engines": {
     "node": ">=12.20"
@@ -57,5 +57,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.3.1"
+  "version": "5.4.0"
 }

package/test/lnd_methods/unauthenticated/test_create_wallet.js

@@ -30,7 +30,13 @@ const tests = [
   },
   {
     args: {
-      lnd: {unlocker: {initWallet: ({}, cbk) => cbk()}},
+      lnd: {
+        unlocker: {
+          initWallet: ({}, cbk) => cbk(null, {
+            admin_macaroon: Buffer.alloc(1),
+          }),
+        },
+      },
       password: 'pass',
       seed: 'seed',
     },

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