lightning 6.3.1 → 6.4.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Versions
 
+## 6.4.0
+
+- `subscribeToRpcRequests`: `open_channel_request` add support for
+    `fee_rate`, `base_fee_mtokens`
+
+## 6.3.2
+
+- `getWalletInfo`: Add support for LND 0.15.5
+
 ## 6.3.1
 
 - `getSettlementStatus`: Add method to lookup received htlc settlement status

package/lnd_messages/open_channel_request.js

@@ -4,7 +4,9 @@ const minConfs = (isZero, confs) => isZero ? Number() : (confs || undefined);
 /** Derive open channel details from an open channel request gRPC message
 
   {
+    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>
     local_funding_amount: <Channel Capacity Tokens String>
     min_htlc_msat: <Minimum HTLC Millitokens String>
     node_pubkey: <Node Public Key Buffer Object>
@@ -16,12 +18,16 @@ const minConfs = (isZero, confs) => isZero ? Number() : (confs || undefined);
     sat_per_vbyte: <Tokens Per Virtual Byte String>
     spend_unconfirmed: <Spend Unconfirmed UTXOs Bool>
     target_conf: <Funding Transaction Confirmation Target Number>
+    use_base_fee: <Set Base Fee Bool>
+    use_fee_rate: <Set Fee Rate Bool>
   }
 
   @returns
   {
+    [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>
     [is_private]: <Channel is Private Bool>
     local_tokens: <Local Tokens Number>
@@ -32,14 +38,16 @@ const minConfs = (isZero, confs) => isZero ? Number() : (confs || undefined);
   }
 */
 module.exports = args => {
-  const feeRate = Number(args.sat_per_vbyte) || Number(args.sat_per_byte);
+  const chainFeeRate = Number(args.sat_per_vbyte) || Number(args.sat_per_byte);
   const hasMinHtlc = args.min_htlc_msat !== Number().toString();
   const publicKey = bufferAsHex(args.node_pubkey) || args.node_pubkey_string;
   const utxoConfs = minConfs(args.spend_unconfirmed, args.min_confirmations);
 
   return {
-    chain_fee_tokens_per_vbyte: feeRate || undefined,
+    base_fee_mtokens: !!args.use_fee_rate ? args.base_fee : undefined,
+    chain_fee_tokens_per_vbyte: chainFeeRate || undefined,
     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_private: args.private || undefined,
     local_tokens: Number(args.local_funding_amount),

package/lnd_methods/info/constants.json

@@ -37,6 +37,7 @@
     "aff2ed3a6a118d664049835c325a5b69e977172f": "0.15.2-beta",
     "b4e7131bdb47531ad2f00ce345ddcdb58935bba5": "0.15.3-beta",
     "bd0c46b4fcb027af1915bd67a3da70e8ca5c6efe": "0.14.3-beta",
+    "c0a09209782b1c62c3393fcea0844e095c25046b": "0.15.5-beta",
     "d176d2d65fc06e6631c4dc9478592be8545a21de": "0.12.0-beta",
     "d233f61383f2f950aa06f5b09da5b0e78e784fae": "0.12.1-beta",
     "d62c575f8499a314eb27f12462d20500b6bda2c7": "0.10.3-beta",

package/lnd_methods/macaroon/subscribe_to_rpc_requests.js

@@ -63,8 +63,10 @@ const type = 'default';
     macaroon: <Base64 Encoded Macaroon String>
     reject: ({message: <Rejection String>}, [cbk]) => {}
     request: {
+      [base_fee_mtokens]: <Routing Base Fee Millitokens Charged String>
       [chain_fee_tokens_per_vbyte]: <Chain Fee Tokens Per VByte Number>
       [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_private]: <Channel is Private Bool>
       local_tokens: <Local Tokens Number>

package/lnd_methods/offchain/get_settlement_status.d.ts

@@ -20,7 +20,7 @@ export type GetSettlementStatusResult = {
 /**
  * Get the settlement status of a received HTLC
  *
- * Note: this method is not supported in LND versions 0.15.4 and below
+ * Note: this method is not supported in LND versions 0.15.5 and below
  *
  * Requires `offchain:read` permissions
  */

package/lnd_methods/offchain/get_settlement_status.js

@@ -12,7 +12,7 @@ const type = 'default';
 
 /** Get the settlement status of a received HTLC
 
-  Note: this method is not supported in LND versions 0.15.4 and below
+  Note: this method is not supported in LND versions 0.15.5 and below
 
   Requires `offchain:read` permissions
 

package/lnd_methods/offchain/subscribe_to_payments.d.ts

@@ -17,6 +17,6 @@ export type SubscribeToPaymentsPaymentEvent =
  *
  * Requires `offchain:read` permission
  *
- * Note: Method not supported on LND 0.15.4 and below
+ * Note: Method not supported on LND 0.15.5 and below
  */
 export const subscribeToPayments: AuthenticatedLightningSubscription<SubscribeToPaymentsArgs>;

package/lnd_methods/offchain/subscribe_to_payments.js

@@ -13,7 +13,7 @@ const type = 'router';
 
   Requires `offchain:read` permission
 
-  Note: Method not supported on LND 0.15.4 and below
+  Note: Method not supported on LND 0.15.5 and below
 
   {
     lnd: <Authenticated LND API Object>

package/lnd_methods/onchain/open_channel.d.ts

@@ -50,8 +50,8 @@ export type OpenChannelResult = {
  *
  * External funding requires LND compiled with `walletrpc` build tag
  *
- * `base_fee_mtokens` is not supported on LND 0.15.4 and below
- * `fee_rate` is not supported on LND 0.15.4 and below
+ * `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
  */
 export const openChannel: AuthenticatedLightningMethod<
   OpenChannelArgs,

package/lnd_methods/onchain/open_channel.js

@@ -20,8 +20,8 @@ const type = 'default';
 
   External funding requires LND compiled with `walletrpc` build tag
 
-  `base_fee_mtokens` is not supported on LND 0.15.4 and below
-  `fee_rate` is not supported on LND 0.15.4 and below
+  `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
 
   {
     [base_fee_mtokens]: <Routing Base Fee Millitokens Charged String>

package/lnd_methods/onchain/open_channels.d.ts

@@ -56,8 +56,8 @@ channel that was not funded.
   `--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.4 and below
- * `fee_rate` is not supported on LND 0.15.4 and below
+ * `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
  */
 export const openChannels: AuthenticatedLightningMethod<
   OpenChannelsArgs,

package/lnd_methods/onchain/open_channels.js

@@ -37,8 +37,8 @@ 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.4 and below
-  `fee_rate` is not supported on LND 0.15.4 and below
+  `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
 
   {
     channels: [{

package/package.json

@@ -10,7 +10,7 @@
     "@grpc/grpc-js": "1.7.3",
     "@grpc/proto-loader": "0.7.3",
     "@types/express": "4.17.14",
-    "@types/node": "18.11.9",
+    "@types/node": "18.11.11",
     "@types/request": "2.48.8",
     "@types/ws": "8.5.3",
     "async": "3.2.4",
@@ -26,13 +26,13 @@
     "invoices": "2.2.2",
     "psbt": "2.7.1",
     "tiny-secp256k1": "2.2.1",
-    "type-fest": "3.2.0"
+    "type-fest": "3.3.0"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
     "@alexbosworth/node-fetch": "2.6.2",
     "@alexbosworth/tap": "15.0.11",
-    "tsd": "0.24.1",
+    "tsd": "0.25.0",
     "typescript": "4.9.3",
     "ws": "8.11.0"
   },
@@ -59,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "6.3.1"
+  "version": "6.4.0"
 }

package/test/lnd_messages/test_open_channel_request.js

@@ -25,8 +25,10 @@ const makeArgs = overrides => {
 
 const makeExpected = overrides => {
   const args = {
+    base_fee_mtokens: undefined,
     chain_fee_tokens_per_vbyte: 1,
     cooperative_close_address: 'close_address',
+    fee_rate: undefined,
     give_tokens: 1,
     is_private: undefined,
     local_tokens: 1,

package/test/lnd_methods/macaroon/test_handle_rpc_request_update.js

@@ -99,8 +99,10 @@ const tests = [
         id: 1,
         macaroon: undefined,
         request: {
+          base_fee_mtokens: undefined,
           chain_fee_tokens_per_vbyte: 1,
           cooperative_close_address: 'close_address',
+          fee_rate: undefined,
           give_tokens: 1,
           is_private: undefined,
           local_tokens: 1,

package/test/lnd_methods/macaroon/test_subscribe_to_rpc_requests.js

@@ -191,8 +191,10 @@ const tests = [
         macaroon: undefined,
         reject: true,
         request: {
+          base_fee_mtokens: undefined,
           chain_fee_tokens_per_vbyte: 1,
           cooperative_close_address: 'close_address',
+          fee_rate: undefined,
           give_tokens: 1,
           is_private: undefined,
           local_tokens: 1,