lightning 6.1.2 → 6.2.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Versions
 
+## 6.2.0
+
+- `openChannel`, `openChannels`: Add `base_fee_mtokens`, `fee_rate` to set
+    initial routing fee rate.
+
 ## 6.1.2
 
 - `subscribeToRpcRequests`: Fix support for LND 0.15.1

package/grpc/protos/lightning.proto

@@ -2190,6 +2190,33 @@ message OpenChannelRequest {
     attempted.
     */
     bool scid_alias = 20;
+
+    /*
+    The base fee charged regardless of the number of milli-satoshis sent.
+    */
+    uint64 base_fee = 21;
+
+    /*
+    The fee rate in ppm (parts per million) that will be charged in
+    proportion of the value of each forwarded HTLC.
+    */
+    uint64 fee_rate = 22;
+
+    /*
+    If use_base_fee is true the open channel announcement will update the
+    channel base fee with the value specified in base_fee. In the case of
+    a base_fee of 0 use_base_fee is needed downstream to distinguish whether
+    to use the default base fee value specified in the config or 0.
+    */
+    bool use_base_fee = 23;
+
+    /*
+    If use_fee_rate is true the open channel announcement will update the
+    channel fee rate with the value specified in fee_rate. In the case of
+    a fee_rate of 0 use_fee_rate is needed downstream to distinguish whether
+    to use the default fee rate value specified in the config or 0.
+    */
+    bool use_fee_rate = 24;
 }
 message OpenStatusUpdate {
     oneof update {

package/lnd_methods/onchain/open_channel.js

@@ -20,9 +20,14 @@ const type = 'default';
 
   External funding requires LND compiled with `walletrpc` build tag
 
+  `base_fee_mtokens` is not supported on LND 0.15.2 and below
+  `fee_rate` is not supported on LND 0.15.2 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_private]: <Channel is Private Bool> // Defaults to false
     lnd: <Authenticated LND API Object>
@@ -92,6 +97,8 @@ module.exports = (args, cbk) => {
         let isAnnounced = false;
 
         const options = {
+          base_fee: args.base_fee_mtokens || undefined,
+          fee_rate: args.fee_rate,
           local_funding_amount: args.local_tokens,
           min_confs: minConfs,
           min_htlc_msat: args.min_htlc_mtokens || defaultMinHtlcMtokens,
@@ -99,7 +106,9 @@ module.exports = (args, cbk) => {
           private: !!args.is_private,
           remote_csv_delay: args.partner_csv_delay || undefined,
           spend_unconfirmed: !minConfs,
-        }
+          use_base_fee: args.base_fee_mtokens !== undefined,
+          use_fee_rate: args.fee_rate !== undefined,
+        };
 
         if (!!args.chain_fee_tokens_per_vbyte) {
           options.sat_per_byte = args.chain_fee_tokens_per_vbyte;

package/lnd_methods/onchain/open_channels.js

@@ -8,6 +8,7 @@ const {returnResult} = require('asyncjs-util');
 const cancelPendingChannel = require('./cancel_pending_channel');
 const {isLnd} = require('./../../lnd_requests');
 
+const anchors = 'ANCHORS';
 const bufferFromHex = hex => Buffer.from(hex, 'hex');
 const defaultMinHtlcMtokens = '1';
 const fundEvent = 'psbt_fund';
@@ -36,10 +37,15 @@ const type = 'default';
   `--protocol.option-scid-alias` and `--protocol.zero-conf` set on both sides
   as well as a channel open request listener to accept the trusted funding.
 
+  `base_fee_mtokens` is not supported on LND 0.15.2 and below
+  `fee_rate` is not supported on LND 0.15.2 and below
+
   {
     channels: [{
+      [base_fee_mtokens]: <Routing Base Fee Millitokens Charged String>
       capacity: <Channel Capacity Tokens Number>
       [cooperative_close_address]: <Restrict Coop 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_private]: <Channel is Private Bool> // Defaults to false
       [is_trusted_funding]: <Peer Should Avoid Waiting For Confirmation Bool>
@@ -91,7 +97,9 @@ module.exports = (args, cbk) => {
       // Channels to open
       toOpen: ['validate', ({}, cbk) => {
         return cbk(null, args.channels.map(channel => ({
+          base_fee_mtokens: channel.base_fee_mtokens,
           capacity: channel.capacity,
+          fee_rate: channel.fee_rate,
           id: makeId(),
           cooperative_close_address: channel.cooperative_close_address,
           give_tokens: channel.give_tokens,
@@ -112,8 +120,10 @@ module.exports = (args, cbk) => {
           const isSelfPublish = !!args.is_avoiding_broadcast;
 
           const channelOpen = args.lnd[type][method]({
+            base_fee: channel.base_fee_mtokens || undefined,
             close_address: channel.cooperative_close_address || undefined,
-            commitment_type: channel.is_trusted_funding ? 'ANCHORS' : undefined,
+            commitment_type: channel.is_trusted_funding ? anchors : undefined,
+            fee_rate: channel.fee_rate,
             funding_shim: {
               psbt_shim: {
                 no_publish: !!isSelfPublish || !channel.id.equals(lastChannel),
@@ -127,6 +137,8 @@ module.exports = (args, cbk) => {
             push_sat: channel.give_tokens || undefined,
             remote_csv_delay: channel.partner_csv_delay || undefined,
             scid_alias: channel.is_trusted_funding && channel.is_private,
+            use_base_fee: channel.base_fee_mtokens !== undefined,
+            use_fee_rate: channel.fee_rate !== undefined,
             zero_conf: channel.is_trusted_funding || undefined,
           });
 

package/package.json

@@ -10,7 +10,7 @@
     "@grpc/grpc-js": "1.7.1",
     "@grpc/proto-loader": "0.7.3",
     "@types/express": "4.17.14",
-    "@types/node": "18.7.23",
+    "@types/node": "18.8.1",
     "@types/request": "2.48.8",
     "@types/ws": "8.5.3",
     "async": "3.2.4",
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "6.1.2"
+  "version": "6.2.0"
 }