lightning 7.1.8 → 8.0.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Versions
 
+## 8.0.0
+
+- `openChannel`: Add `is_max_funding` to fund a channel maximally
+- `subscribeToRpcRequests`: Add support for returning `is_max_funding` in
+    `open_channel_request`
+
+### Breaking Changes
+
+- `subscribeToRpcRequests`: `open_channel_request`: `local_tokens` is now an
+    optional value
+
+## 7.1.9
+
+- `getPeers`: Correct feature bit returned as string and not number
+
 ## 7.1.8
 
 - `signChainAddressMessage`: Add method to sign a message given a chain address

package/grpc/protos/lightning.proto

@@ -2265,6 +2265,13 @@ message OpenChannelRequest {
     capacity.
     */
     uint64 remote_chan_reserve_sat = 25;
+
+    /*
+    If set, then lnd will attempt to commit all the coins under control of the
+    internal wallet to open the channel, and the LocalFundingAmount field must
+    be zero and is ignored.
+    */
+    bool fund_max = 26;
 }
 message OpenStatusUpdate {
     oneof update {

package/lnd_messages/open_channel_request.js

@@ -7,6 +7,7 @@ const minConfs = (isZero, confs) => isZero ? Number() : (confs || undefined);
     base_fee: <Set Channel Base Fee Millitokens String>
     close_address: <Cooperative Close Address String>
     fee_rate: <Set Channel Routing Fee Rate Millitoken Per Millitokens String>
+    fund_max: <Use Maximal Funding Bool>
     local_funding_amount: <Channel Capacity Tokens String>
     min_htlc_msat: <Minimum HTLC Millitokens String>
     node_pubkey: <Node Public Key Buffer Object>
@@ -29,8 +30,9 @@ const minConfs = (isZero, confs) => isZero ? Number() : (confs || undefined);
     [cooperative_close_address]: <Restrict Cooperative Close To Address String>
     [fee_rate]: <Routing Fee Rate In Millitokens Per Million Number>
     [give_tokens]: <Tokens to Gift To Partner Number>
+    [is_max_funding]: <Use Maximal Chain Funds For Local Funding Bool>
     [is_private]: <Channel is Private Bool>
-    local_tokens: <Local Tokens Number>
+    [local_tokens]: <Local Tokens Number>
     [min_confirmations]: <Spend UTXOs With Minimum Confirmations Number>
     [min_htlc_mtokens]: <Minimum HTLC Millitokens String>
     partner_public_key: <Public Key Hex String>
@@ -40,6 +42,7 @@ const minConfs = (isZero, confs) => isZero ? Number() : (confs || undefined);
 module.exports = args => {
   const chainFeeRate = Number(args.sat_per_vbyte) || Number(args.sat_per_byte);
   const hasMinHtlc = args.min_htlc_msat !== Number().toString();
+  const normalFunded = !args.fund_max;
   const publicKey = bufferAsHex(args.node_pubkey) || args.node_pubkey_string;
   const utxoConfs = minConfs(args.spend_unconfirmed, args.min_confirmations);
 
@@ -49,8 +52,9 @@ module.exports = args => {
     cooperative_close_address: args.close_address || undefined,
     fee_rate: !!args.use_fee_rate ? Number(args.fee_rate) : undefined,
     give_tokens: Number(args.push_sat) || undefined,
+    is_max_funding: !!args.fund_max || undefined,
     is_private: args.private || undefined,
-    local_tokens: Number(args.local_funding_amount),
+    local_tokens: normalFunded ? Number(args.local_funding_amount) : undefined,
     min_confirmations: utxoConfs,
     min_htlc_mtokens: hasMinHtlc ? args.min_htlc_msat : undefined,
     partner_public_key: publicKey,

package/lnd_methods/macaroon/subscribe_to_rpc_requests.js

@@ -69,8 +69,9 @@ const type = 'default';
       [cooperative_close_address]: <Prefer Cooperative Close To Address String>
       [fee_rate]: <Routing Fee Rate In Millitokens Per Million Number>
       [give_tokens]: <Tokens to Gift To Partner Number>
+      [is_max_funding]: <Use Maximal Chain Funds For Local Funding Bool>
       [is_private]: <Channel is Private Bool>
-      local_tokens: <Local Tokens Number>
+      [local_tokens]: <Local Tokens Number>
       [min_confirmations]: <Spend UTXOs With Minimum Confirmations Number>
       [min_htlc_mtokens]: <Minimum HTLC Millitokens String>
       partner_public_key: <Public Key Hex String>

package/lnd_methods/onchain/open_channel.js

@@ -23,15 +23,18 @@ 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.0 and below
+
   {
     [base_fee_mtokens]: <Routing Base Fee Millitokens Charged String>
     [chain_fee_tokens_per_vbyte]: <Chain Fee Tokens Per VByte Number>
     [cooperative_close_address]: <Restrict Cooperative Close To Address String>
     [fee_rate]: <Routing Fee Rate In Millitokens Per Million Number>
     [give_tokens]: <Tokens to Gift To Partner Number> // Defaults to zero
+    [is_max_funding]: <Use Maximal Chain Funds For Local Funding Bool>
     [is_private]: <Channel is Private Bool> // Defaults to false
     lnd: <Authenticated LND API Object>
-    local_tokens: <Total Channel Capacity 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_csv_delay]: <Peer Output CSV Delay Number>
@@ -54,11 +57,11 @@ module.exports = (args, cbk) => {
           return cbk([400, 'ExpectedLndForChannelOpen']);
         }
 
-        if (!args.local_tokens) {
+        if (!args.local_tokens && !args.is_max_funding) {
           return cbk([400, 'ExpectedLocalTokensNumberToOpenChannelWith']);
         }
 
-        if (args.local_tokens < minChannelTokens) {
+        if (!args.is_max_funding && args.local_tokens < minChannelTokens) {
           return cbk([400, 'ExpectedLargerChannelSizeForChannelOpen']);
         }
 
@@ -99,6 +102,7 @@ module.exports = (args, cbk) => {
         const options = {
           base_fee: args.base_fee_mtokens || undefined,
           fee_rate: args.fee_rate,
+          fund_max: args.is_max_funding || undefined,
           local_funding_amount: args.local_tokens,
           min_confs: minConfs,
           min_htlc_msat: args.min_htlc_mtokens || defaultMinHtlcMtokens,

package/lnd_responses/rpc_peer_as_peer.js

@@ -116,7 +116,7 @@ module.exports = peer => {
     bytes_received: Number(peer.bytes_recv),
     bytes_sent: Number(peer.bytes_sent),
     features: keys(peer.features).map(bit => ({
-      bit,
+      bit: Number(bit),
       is_known: peer.features[bit].is_known,
       is_required: peer.features[bit].is_required,
       type: featureFlagDetails({bit}).type,

package/package.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.8.13",
+    "@grpc/grpc-js": "1.8.14",
     "@grpc/proto-loader": "0.7.6",
     "@types/express": "4.17.17",
     "@types/node": "18.15.11",
@@ -33,7 +33,7 @@
     "@alexbosworth/node-fetch": "2.6.2",
     "@alexbosworth/tap": "15.0.12",
     "tsd": "0.28.1",
-    "typescript": "5.0.3",
+    "typescript": "5.0.4",
     "ws": "8.13.0"
   },
   "engines": {
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "7.1.8"
+  "version": "8.0.0"
 }

package/test/lnd_messages/test_open_channel_request.js

@@ -30,6 +30,7 @@ const makeExpected = overrides => {
     cooperative_close_address: 'close_address',
     fee_rate: undefined,
     give_tokens: 1,
+    is_max_funding: undefined,
     is_private: undefined,
     local_tokens: 1,
     min_confirmations: 0,

package/test/lnd_methods/macaroon/test_handle_rpc_request_update.js

@@ -105,6 +105,7 @@ const tests = [
           cooperative_close_address: 'close_address',
           fee_rate: undefined,
           give_tokens: 1,
+          is_max_funding: undefined,
           is_private: undefined,
           local_tokens: 1,
           min_confirmations: 0,

package/test/lnd_methods/macaroon/test_subscribe_to_rpc_requests.js

@@ -196,6 +196,7 @@ const tests = [
           cooperative_close_address: 'close_address',
           fee_rate: undefined,
           give_tokens: 1,
+          is_max_funding: undefined,
           is_private: undefined,
           local_tokens: 1,
           min_confirmations: 0,

package/test/lnd_responses/test_rpc_peer_as_peer.js

@@ -34,7 +34,7 @@ const makeExpected = overrides => {
     bytes_received: 1,
     bytes_sent: 1,
     features: [{
-      bit: '1',
+      bit: 1,
       is_known: true,
       is_required: false,
       type: 'data_loss_protection',