lightning 5.0.1 → 5.2.1

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Versions
 
+## 5.2.1
+
+- `getPendingChannels`: Add support for channel `capacity`
+
+## 5.1.1
+
+- `openChannels`: Fix `cooperative_close_address` not being set on channels
+
+## 5.1.0
+
+- Add support for LND 0.14.1
+- `openChannels`: Add `is_avoiding_broadcast` to avoid all funding broadcast
+
 ## 5.0.1
 
 - `createChainAddress`: Fix type hints to reflect optionality of `format`

package/README.md

@@ -52,10 +52,6 @@ To access unauthenticated methods like the wallet unlocker, use
 
 ## Methods
 
-There are two libraries, [ln-service](https://github.com/alexbosworth/ln-service) and this library.
-
-Methods exported by this library support typescript, but ln-service includes additional metthods.
-
 - [addPeer](https://github.com/alexbosworth/ln-service#addpeer): Connect to a new peer
 - [authenticatedLndGrpc](https://github.com/alexbosworth/ln-service#authenticatedlndgrpc): 
     Instantiate connection to authenticated lnd methods.

package/lnd_methods/info/constants.json

@@ -24,6 +24,7 @@
     "4f567577db9d85b6f392f960b3aabddcad3cd02c": "0.13.3-beta",
     "52bb3f33707b81972c67937c7a89addcdf00991c": "0.10.1-beta",
     "596fd90ef310cd7abbf2251edaae9ba4d5f8a689": "0.13.1-beta",
+    "6042004edaaa5b3cad0a0808ff23dba4716f7178": "0.14.1-beta",
     "61c34683058f2cc8dc10f49392a0057440d831c4": "0.13.4-beta",
     "725ff104808f49f0a5247bfdb4b6b5da7f488d38": "0.13.0-beta",
     "7f34774529fa0964d47fc418d4d2965435cbfdc0": "0.11.1-beta",

package/lnd_methods/offchain/get_pending_channels.d.ts

@@ -3,6 +3,8 @@ import {AuthenticatedLnd} from '../../lnd_grpc';
 
 export type GetPendingChannelsResult = {
   pending_channels: {
+    /** Channel Capacity Tokens */
+    capacity: number;
     /** Channel Closing Transaction Id */
     close_transaction_id?: string;
     /** Channel Is Active */

package/lnd_methods/offchain/get_pending_channels.js

@@ -25,6 +25,7 @@ const type = 'default';
   @returns via cbk or Promise
   {
     pending_channels: [{
+      capacity: <Channel Capacity Tokens Number>
       [close_transaction_id]: <Channel Closing Transaction Id String>
       is_active: <Channel Is Active Bool>
       is_closing: <Channel Is Closing Bool>
@@ -68,6 +69,7 @@ module.exports = ({lnd}, cbk) => {
         return cbk();
       },
 
+      // Get pending channels
       getPending: ['validate', ({}, cbk) => {
         return lnd[type][method]({}, (err, res) => {
           if (!!err) {

package/lnd_methods/onchain/fund_pending_channels.js

@@ -24,32 +24,32 @@ const type = 'default';
 
   @returns via cbk or Promise
 */
-module.exports = ({channels, funding, lnd}, cbk) => {
+module.exports = (args, cbk) => {
   return new Promise((resolve, reject) => {
     return asyncAuto({
       // Check arguments
       validate: cbk => {
-        if (!isArray(channels)) {
+        if (!isArray(args.channels)) {
           return cbk([400, 'ExpectedPendingChannelIdsToFundChannels']);
         }
 
-        if (!channels.length) {
+        if (!args.channels.length) {
           return cbk([400, 'ExpectedPendingChannelIdsToFund']);
         }
 
-        if (channels.filter(n => !n).length) {
+        if (args.channels.filter(n => !n).length) {
           return cbk([400, 'ExpectedNonEmptyPendingChannelIdsToFund']);
         }
 
-        if (!!channels.find(n => !isHash(n))) {
+        if (!!args.channels.find(n => !isHash(n))) {
           return cbk([400, 'ExpectedPendingChannelIdOfChannelToFund']);
         }
 
-        if (!isHex(funding)) {
+        if (!isHex(args.funding)) {
           return cbk([400, 'ExpectedFundingPsbtToFundChannel']);
         }
 
-        if (!isLnd({lnd, method, type})) {
+        if (!isLnd({method, type, lnd: args.lnd})) {
           return cbk([400, 'ExpectedAuthenticatedLndToFundChannels']);
         }
 
@@ -57,12 +57,12 @@ module.exports = ({channels, funding, lnd}, cbk) => {
       },
 
       // Funded and signed PSBT
-      psbt: ['validate', ({}, cbk) => cbk(null, bufferFromHex(funding))],
+      psbt: ['validate', ({}, cbk) => cbk(null, bufferFromHex(args.funding))],
 
       // Verify the funding for each pending channel
       verify: ['psbt', 'validate', ({psbt}, cbk) => {
-        return asyncEach(channels, (id, cbk) => {
-          return lnd[type][method]({
+        return asyncEach(args.channels, (id, cbk) => {
+          return args.lnd[type][method]({
             psbt_verify: {
               funded_psbt: psbt,
               pending_chan_id: bufferFromHex(id),
@@ -81,10 +81,10 @@ module.exports = ({channels, funding, lnd}, cbk) => {
 
       // Finalize the psbts
       finalize: ['psbt', 'verify', ({psbt}, cbk) => {
-        const [lastChannel] = channels.slice().reverse();
+        const [lastChannel] = args.channels.slice().reverse();
 
-        return asyncEachSeries(channels, (id, cbk) => {
-          return lnd[type][method]({
+        return asyncEachSeries(args.channels, (id, cbk) => {
+          return args.lnd[type][method]({
             psbt_finalize: {
               no_publish: id !== lastChannel,
               pending_chan_id: bufferFromHex(id),

package/lnd_methods/onchain/open_channel.js

@@ -26,11 +26,11 @@ const type = 'default';
     [give_tokens]: <Tokens to Gift To Partner Number> // Defaults to zero
     [is_private]: <Channel is Private Bool> // Defaults to false
     lnd: <Authenticated LND API Object>
-    local_tokens: <Local Tokens Number>
+    local_tokens: <Total Channel Capacity Tokens Number>
     [min_confirmations]: <Spend UTXOs With Minimum Confirmations Number>
     [min_htlc_mtokens]: <Minimum HTLC Millitokens String>
-    partner_public_key: <Public Key Hex String>
     [partner_csv_delay]: <Peer Output CSV Delay Number>
+    partner_public_key: <Public Key Hex String>
     [partner_socket]: <Peer Connection Host:Port String>
   }
 

package/lnd_methods/onchain/open_channels.d.ts

@@ -22,6 +22,8 @@ export type OpenChannelsArgs = AuthenticatedLightningArgs<{
     /** Peer Connection Host:Port */
     partner_socket?: string;
   }[];
+  /** Do not broadcast any channel funding transactions */
+  is_avoiding_broadcast?: boolean;
 }>;
 
 export type OpenChannelsResult = {

package/lnd_methods/onchain/open_channels.js

@@ -29,6 +29,9 @@ const type = 'default';
   If you do not fund the channels, be sure to `cancelPendingChannel` on each
   channel that was not funded.
 
+  Use `is_avoiding_broadcast` only when self-publishing the raw transaction
+  after the funding step.
+
   {
     channels: [{
       capacity: <Channel Capacity Tokens Number>
@@ -36,10 +39,11 @@ const type = 'default';
       [give_tokens]: <Tokens to Gift To Partner Number> // Defaults to zero
       [is_private]: <Channel is Private Bool> // Defaults to false
       [min_htlc_mtokens]: <Minimum HTLC Millitokens String>
-      partner_public_key: <Public Key Hex String>
       [partner_csv_delay]: <Peer Output CSV Delay Number>
+      partner_public_key: <Public Key Hex String>
       [partner_socket]: <Peer Connection Host:Port String>
     }]
+    [is_avoiding_broadcast]: <Avoid Broadcast of All Channels Bool>
     lnd: <Authenticated LND API Object>
   }
 
@@ -52,28 +56,28 @@ const type = 'default';
     }]
   }
 */
-module.exports = ({channels, lnd}, cbk) => {
+module.exports = (args, cbk) => {
   return new Promise((resolve, reject) => {
     return asyncAuto({
       // Check arguments
       validate: cbk => {
-        if (!isArray(channels)) {
+        if (!isArray(args.channels)) {
           return cbk([400, 'ExpectedChannelsToOpenChannels']);
         }
 
-        if (channels.filter(n => !!n).length !== channels.length) {
+        if (args.channels.filter(n => !!n).length !== args.channels.length) {
           return cbk([400, 'ExpectedChannelDetailsToOpenChannels']);
         }
 
-        if (!!channels.find(n => !n.capacity)) {
+        if (!!args.channels.find(n => !n.capacity)) {
           return cbk([400, 'ExpectedCapacityOfChannelsToOpenChannels']);
         }
 
-        if (!!channels.find(n => !isPublicKey(n.partner_public_key))) {
+        if (!!args.channels.find(n => !isPublicKey(n.partner_public_key))) {
           return cbk([400, 'ExpectedPeerPublicKeyToOpenChannels']);
         }
 
-        if (!isLnd({lnd, method, type})) {
+        if (!isLnd({method, type, lnd: args.lnd})) {
           return cbk([400, 'ExpectedAuthenticatedLndToOpenChannels']);
         }
 
@@ -82,7 +86,7 @@ module.exports = ({channels, lnd}, cbk) => {
 
       // Channels to open
       toOpen: ['validate', ({}, cbk) => {
-        return cbk(null, channels.map(channel => ({
+        return cbk(null, args.channels.map(channel => ({
           capacity: channel.capacity,
           id: makeId(),
           cooperative_close_address: channel.cooperative_close_address,
@@ -101,11 +105,13 @@ module.exports = ({channels, lnd}, cbk) => {
 
         return asyncMap(toOpen, (channel, cbk) => {
           let isDone = false;
+          const isSelfPublish = !!args.is_avoiding_broadcast;
 
-          const channelOpen = lnd[type][method]({
+          const channelOpen = args.lnd[type][method]({
+            close_address: channel.cooperative_close_address || undefined,
             funding_shim: {
               psbt_shim: {
-                no_publish: !channel.id.equals(lastChannel),
+                no_publish: !!isSelfPublish || !channel.id.equals(lastChannel),
                 pending_chan_id: channel.id,
               },
             },
@@ -183,7 +189,7 @@ module.exports = ({channels, lnd}, cbk) => {
         return asyncEach(toOpen, (channel, cbk) => {
           const id = hexFromBuffer(channel.id);
 
-          return cancelPendingChannel({id, lnd}, () => cbk());
+          return cancelPendingChannel({id, lnd: args.lnd}, () => cbk());
         },
         () => {
           return cbk([503, 'UnexpectedErrorOpeningChannels', {err}]);

package/lnd_responses/pending_as_pending_channels.js

@@ -80,6 +80,7 @@ const outpointSeparator = ':';
   @returns
   {
     pending_channels: [{
+      capacity: <Channel Capacity Tokens Number>
       [close_transaction_id]: <Channel Closing Transaction Id String>
       is_active: <Channel Is Active Bool>
       is_closing: <Channel Is Closing Bool>
@@ -285,6 +286,7 @@ module.exports = args => {
     const pendingTokens = wait.pending_balance || forced.pending_balance;
 
     return {
+      capacity: Number(channel.capacity),
       close_transaction_id: endTx || undefined,
       is_active: false,
       is_closing: !chanOpen,

package/package.json

@@ -10,12 +10,12 @@
     "@grpc/grpc-js": "1.4.4",
     "@grpc/proto-loader": "0.6.7",
     "@types/express": "4.17.13",
-    "@types/node": "16.11.9",
+    "@types/node": "16.11.12",
     "@types/request": "2.48.7",
-    "@types/ws": "8.2.0",
+    "@types/ws": "8.2.2",
     "async": "3.2.2",
     "asyncjs-util": "1.2.7",
-    "bitcoinjs-lib": "6.0.0",
+    "bitcoinjs-lib": "6.0.1",
     "bn.js": "5.2.0",
     "body-parser": "1.19.0",
     "bolt07": "1.7.4",
@@ -24,7 +24,7 @@
     "express": "4.17.1",
     "invoices": "2.0.2",
     "psbt": "1.1.10",
-    "type-fest": "2.6.0"
+    "type-fest": "2.8.0"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
@@ -32,10 +32,10 @@
     "@alexbosworth/tap": "15.0.10",
     "tsd": "0.19.0",
     "typescript": "4.5.2",
-    "ws": "8.2.3"
+    "ws": "8.3.0"
   },
   "engines": {
-    "node": ">=12"
+    "node": ">=12.20"
   },
   "keywords": [
     "grpc",
@@ -57,5 +57,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.0.1"
+  "version": "5.2.1"
 }

package/test/lnd_responses/test_pending_as_pending_channels.js

@@ -99,6 +99,7 @@ const makeArgs = overrides => {
 
 const makeExpectedPending = overrides => {
   const res = {
+    capacity: 1,
     close_transaction_id: Buffer.alloc(32).toString('hex'),
     is_active: false,
     is_closing: true,