lightning 7.1.9 → 9.0.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Versions
 
+## 9.0.0
+
+### Breaking Changes
+
+- node.js version 14 is no longer supported, 16 or higher is required
+
+## 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

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/grpc/protos/walletkit.proto

@@ -863,6 +863,76 @@ enum WitnessType {
     transaction.
     */
     COMMITMENT_ANCHOR = 13;
+
+    /*
+    A witness type that is similar to the COMMITMENT_NO_DELAY type,
+    but it omits the tweak that randomizes the key we need to
+    spend with a channel peer supplied set of randomness.
+    */
+    COMMITMENT_NO_DELAY_TWEAKLESS = 14;
+
+    /*
+    A witness type that allows us to spend our output on the counterparty's
+    commitment transaction after a confirmation.
+    */
+    COMMITMENT_TO_REMOTE_CONFIRMED = 15;
+
+    /*
+    A witness type that allows us to sweep an HTLC output that we extended
+    to a party, but was never fulfilled. This _is_ the HTLC output directly
+    on our commitment transaction, and the input to the second-level HTLC
+    timeout transaction. It can only be spent after CLTV expiry, and
+    commitment confirmation.
+    */
+    HTLC_OFFERED_TIMEOUT_SECOND_LEVEL_INPUT_CONFIRMED = 16;
+
+    /*
+    A witness type that allows us to sweep an HTLC output that was offered
+    to us, and for which we have a payment preimage. This _is_ the HTLC
+    output directly on our commitment transaction, and the input to the
+    second-level HTLC success transaction. It can only be spent after the
+    commitment has confirmed.
+    */
+    HTLC_ACCEPTED_SUCCESS_SECOND_LEVEL_INPUT_CONFIRMED = 17;
+
+    /*
+    A witness type that allows us to spend our output on our local
+    commitment transaction after a relative and absolute lock-time lockout as
+    part of the script enforced lease commitment type.
+    */
+    LEASE_COMMITMENT_TIME_LOCK = 18;
+
+    /*
+    A witness type that allows us to spend our output on the counterparty's
+    commitment transaction after a confirmation and absolute locktime as part
+    of the script enforced lease commitment type.
+    */
+    LEASE_COMMITMENT_TO_REMOTE_CONFIRMED = 19;
+
+    /*
+    A witness type that allows us to sweep an HTLC output that we extended
+    to a party, but was never fulfilled. This HTLC output isn't directly on
+    the commitment transaction, but is the result of a confirmed second-level
+    HTLC transaction. As a result, we can only spend this after a CSV delay
+    and CLTV locktime as part of the script enforced lease commitment type.
+    */
+    LEASE_HTLC_OFFERED_TIMEOUT_SECOND_LEVEL = 20;
+
+    /*
+    A witness type that allows us to sweep an HTLC output that was offered
+    to us, and for which we have a payment preimage. This HTLC output isn't
+    directly on our commitment transaction, but is the result of confirmed
+    second-level HTLC transaction. As a result, we can only spend this after
+    a CSV delay and CLTV locktime as part of the script enforced lease
+    commitment type.
+    */
+    LEASE_HTLC_ACCEPTED_SUCCESS_SECOND_LEVEL = 21;
+
+    /*
+    A witness type that allows us to spend a regular p2tr output that's sent
+    to an output which is under complete control of the backing wallet.
+    */
+    TAPROOT_PUB_KEY_SPEND = 22;
 }
 
 message PendingSweep {

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

@@ -4,7 +4,7 @@ const {returnResult} = require('asyncjs-util');
 
 const {routesFromQueryRoutes} = require('../../lnd_responses');
 
-const defaultFinalCltvDelta = 40;
+const defaultFinalCltvDelta = 144;
 const defaultMtokens = '1000000';
 const hexAsBuffer = hex => Buffer.from(hex, 'hex');
 const {isArray} = Array;

package/lnd_methods/offchain/subscribe_to_pay_via_details.js

@@ -3,7 +3,7 @@ const {randomBytes} = require('crypto');
 const {isLnd} = require('./../../lnd_requests');
 const subscribeToPay = require('./subscribe_to_pay');
 
-const defaultCltvDelta = 40;
+const defaultCltvDelta = 144;
 const isPublicKey = n => !!n && /^[0-9A-F]{66}$/i.test(n);
 const method = 'sendPaymentV2';
 const randomId = () => randomBytes(32).toString('hex');

package/lnd_methods/offchain/update_routing_fees.js

@@ -5,7 +5,7 @@ const {isLnd} = require('./../../lnd_requests');
 const {rpcFailedPolicyAsFail} = require('./../../lnd_responses');
 
 const defaultBaseFee = 1;
-const defaultCltvDelta = 40;
+const defaultCltvDelta = 144;
 const defaultRate = 1;
 const feeRatio = 1e6;
 const {floor} = Math;

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/package.json

@@ -7,10 +7,10 @@
     "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",
+    "@types/node": "18.15.13",
     "@types/request": "2.48.8",
     "@types/ws": "8.5.4",
     "async": "3.2.4",
@@ -37,7 +37,7 @@
     "ws": "8.13.0"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
   "keywords": [
     "grpc",
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "7.1.9"
+  "version": "9.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_methods/offchain/test_update_routing_fees.js

@@ -119,7 +119,7 @@ const tests = [
           fee_rate: 0.000001,
           global: true,
           max_htlc_msat: undefined,
-          time_lock_delta: 40,
+          time_lock_delta: 144,
         },
       }),
       description: 'The global channel policy is updated',
@@ -135,7 +135,7 @@ const tests = [
           fee_rate: 0.000001,
           global: true,
           max_htlc_msat: undefined,
-          time_lock_delta: 40,
+          time_lock_delta: 144,
         },
       }),
       description: 'The global channel policy base fee mtokens is updated',