lightning 9.6.0 → 9.7.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Versions
 
+## 9.7.1
+
+- `isDestinationPayable`: Correct behavior for passing variations of amounts
+
+## 9.7.0
+
+- `getPendingChannels`: Add `description` to return pending channel description
+- `getPendingChannels`: Add `is_private` to show pending channel announcement
+
 ## 9.6.0
 
 - `getPendingChannels`: Add `type` to return pending channel type

package/grpc/protos/lightning.proto

@@ -2552,6 +2552,13 @@ message PendingChannelsResponse {
 
         // Whether this channel is advertised to the network or not.
         bool private = 12;
+
+        /*
+        An optional note-to-self to go along with the channel containing some
+        useful information. This is only ever stored locally and in no way
+        impacts the channel's operation.
+        */
+        string memo = 13;
     }
 
     message PendingOpenChannel {

package/lnd_methods/macaroon/subscribe_to_rpc_requests.js

@@ -24,7 +24,7 @@ const type = 'default';
 
   This method is not supported in LND 0.13.4 and below
 
-  `description` is not supported on LND 0.16.3 and below
+  `description` is not supported on LND 0.16.4 and below
 
   {
     [id]: <RPC Middleware Interception Name String>

package/lnd_methods/offchain/get_channels.js

@@ -17,7 +17,7 @@ const type = 'default';
 
   `is_trusted_funding` is not supported on LND 0.15.0 and below
 
-  `description` is not supported on LND 0.16.3 and below
+  `description` is not supported on LND 0.16.4 and below
 
   {
     [is_active]: <Limit Results To Only Active Channels Bool> // false

package/lnd_methods/offchain/get_pending_channels.d.ts

@@ -7,6 +7,8 @@ export type GetPendingChannelsResult = {
     capacity: number;
     /** Channel Closing Transaction Id */
     close_transaction_id?: string;
+    /** Channel Description */
+    description?: string;
     /** Channel Is Active */
     is_active: boolean;
     /** Channel Is Closing */
@@ -15,6 +17,8 @@ export type GetPendingChannelsResult = {
     is_opening: boolean;
     /** Channel Partner Initiated Channel */
     is_partner_initiated?: boolean;
+    /** Channel Is Not Announced */
+    is_private?: boolean;
     /** Channel Local Funds Constrained by Timelock */
     is_timelocked: boolean;
     /** Channel Local Tokens Balance */

package/lnd_methods/offchain/get_pending_channels.js

@@ -17,6 +17,10 @@ const type = 'default';
 
   Requires `offchain:read` permission
 
+  `is_private` is not supported in LND 0.14.5 or before
+
+  `description` is not supported in LND 0.16.4 or before
+
   {
     lnd: <Authenticated LND API Object>
   }
@@ -26,10 +30,12 @@ const type = 'default';
     pending_channels: [{
       capacity: <Channel Capacity Tokens Number>
       [close_transaction_id]: <Channel Closing Transaction Id String>
+      [description]: <Channel Description String>
       is_active: <Channel Is Active Bool>
       is_closing: <Channel Is Closing Bool>
       is_opening: <Channel Is Opening Bool>
       is_partner_initiated: <Channel Partner Initiated Channel Bool>
+      [is_private]: <Channel Is Private Bool>
       is_timelocked: <Channel Local Funds Constrained by Timelock Script Bool>
       local_balance: <Channel Local Tokens Balance Number>
       local_reserve: <Channel Local Reserved Tokens Number>

package/lnd_methods/offchain/is_destination_payable.js

@@ -3,6 +3,7 @@ const {returnResult} = require('asyncjs-util');
 
 const subscribeToPayViaDetails = require('./subscribe_to_pay_via_details');
 
+const defaultMillitokens = '1000';
 const defaultTokens = 1;
 
 /** Determine if a payment destination is actually payable by probing it
@@ -56,7 +57,7 @@ module.exports = (args, cbk) => {
 
       // Attempt payment
       probe: ['validate', ({}, cbk) => {
-        const tokens = !args.mtokens ? null : args.tokens || defaultTokens;
+        const isDefaultTokens = !args.tokens && !args.mtokens;
 
         const sub = subscribeToPayViaDetails({
           cltv_delta: args.cltv_delta,
@@ -66,11 +67,11 @@ module.exports = (args, cbk) => {
           max_fee: args.max_fee,
           max_fee_mtokens: args.max_fee_mtokens,
           max_timeout_height: args.max_timeout_height,
-          mtokens: args.mtokens,
+          mtokens: isDefaultTokens ? defaultMillitokens : args.mtokens,
           outgoing_channel: args.outgoing_channel,
           pathfinding_timeout: args.pathfinding_timeout,
           routes: args.routes,
-          tokens: tokens || undefined,
+          tokens: isDefaultTokens ? defaultTokens : args.tokens,
         });
 
         const finished = (err, res) => {

package/lnd_methods/offchain/subscribe_to_channels.js

@@ -31,7 +31,7 @@ const updateOpening = 'pending_open_channel';
 
   `is_trusted_funding`, `other_ids` are not supported on LND 0.15.0 and below
 
-  `description` is not supported on LND 0.16.3 and below
+  `description` is not supported on LND 0.16.4 and below
 
   @throws
   <Error>

package/lnd_methods/onchain/open_channel.js

@@ -24,9 +24,9 @@ const type = 'default';
   `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
 
-  `is_max_funding` is not supported on LND 0.16.3 and below
+  `is_max_funding` is not supported on LND 0.16.4 and below
 
-  `description` is not supported on LND 0.16.3 and below
+  `description` is not supported on LND 0.16.4 and below
 
   {
     [base_fee_mtokens]: <Routing Base Fee Millitokens Charged String>

package/lnd_methods/onchain/open_channels.js

@@ -40,7 +40,7 @@ const type = 'default';
   `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
 
-  `description` is not supported on LND 0.16.3 and below
+  `description` is not supported on LND 0.16.4 and below
 
   {
     channels: [{

package/lnd_methods/onchain/propose_channel.js

@@ -19,7 +19,7 @@ const type = 'default';
 
   Requires LND compiled with `walletrpc` build tag
 
-  `description` is not supported on LND 0.16.3 and below
+  `description` is not supported on LND 0.16.4 and below
 
   {
     capacity: <Channel Capacity Tokens Number>

package/lnd_responses/pending_as_pending_channels.js

@@ -17,6 +17,7 @@ const outpointSeparator = ':';
         initiator: <Channel Creator Status String>
         local_balance: <Local Balance Tokens String>
         local_chan_reserve_sat: <Local Side Channel Reserve Tokens String>
+        memo: <Channel Description String>
         remote_balance: <Remote Balance Tokens String>
         remote_chan_reserve_sat: <Remote Side Channel Reserve Tokens String>
         remote_node_pub: <Remote Node Public Key Hex String>
@@ -42,6 +43,7 @@ const outpointSeparator = ':';
         initiator: <Channel Creator Status String>
         local_balance: <Local Balance Tokens String>
         local_chan_reserve_sat: <Local Side Channel Reserve Tokens String>
+        memo: <Channel Description String>
         remote_balance: <Remote Balance Tokens String>
         remote_chan_reserve_sat: <Remote Side Channel Reserve Tokens String>
         remote_node_pub: <Remote Node Public Key Hex String>
@@ -59,6 +61,7 @@ const outpointSeparator = ':';
         initiator: <Channel Creator Status String>
         local_balance: <Local Balance Tokens String>
         local_chan_reserve_sat: <Local Side Channel Reserve Tokens String>
+        memo: <Channel Description String>
         remote_balance: <Remote Balance Tokens String>
         remote_chan_reserve_sat: <Remote Side Channel Reserve Tokens String>
         remote_node_pub: <Remote Node Public Key Hex String>
@@ -83,6 +86,7 @@ const outpointSeparator = ':';
     pending_channels: [{
       capacity: <Channel Capacity Tokens Number>
       [close_transaction_id]: <Channel Closing Transaction Id String>
+      [description]: <Channel Description String>
       is_active: <Channel Is Active Bool>
       is_closing: <Channel Is Closing Bool>
       is_opening: <Channel Is Opening Bool>
@@ -291,10 +295,12 @@ module.exports = args => {
     return {
       capacity: Number(channel.capacity),
       close_transaction_id: endTx || undefined,
+      description: channel.memo || undefined,
       is_active: false,
       is_closing: !chanOpen,
       is_opening: !!chanOpen,
       is_partner_initiated: channel.initiator === remoteInitiator,
+      is_private: channel.private || undefined,
       is_timelocked: forced.timelock_blocks !== undefined,
       local_balance: Number(channel.local_balance),
       local_reserve: Number(channel.local_chan_reserve_sat),

package/package.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.8.15",
+    "@grpc/grpc-js": "1.8.16",
     "@grpc/proto-loader": "0.7.7",
     "@types/express": "4.17.17",
     "@types/node": "20.3.1",
@@ -26,7 +26,7 @@
     "invoices": "2.2.3",
     "psbt": "2.7.2",
     "tiny-secp256k1": "2.2.2",
-    "type-fest": "3.11.1"
+    "type-fest": "3.12.0"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "9.6.0"
+  "version": "9.7.1"
 }

package/test/lnd_responses/test_pending_as_pending_channels.js

@@ -101,10 +101,12 @@ const makeExpectedPending = overrides => {
   const res = {
     capacity: 1,
     close_transaction_id: Buffer.alloc(32).toString('hex'),
+    description: undefined,
     is_active: false,
     is_closing: true,
     is_opening: false,
     is_partner_initiated: true,
+    is_private: undefined,
     is_timelocked: true,
     local_balance: 1,
     local_reserve: 1,