lightning 4.14.4 → 5.0.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Versions
 
+## 5.0.0
+
+- Removed support for determining the type of channel to support LND 0.14.0.
+
+- `createChainAddress`: Make address format optional and add p2wpkh as default
+- `sendToChainOutputScripts`: Fix specification of `fee_tokens_per_vbyte`
+
+### Breaking Changes
+
+- `getChannels`, `getPendingChannels`, `subscribeToChannels`: Remove
+    attributes `is_anchor`, `is_static_remote_key`, `is_variable_remote_key`.
+
 ## 4.14.4
 
 - `getPayment`, `subscribeToPastPayment`: Add `pending` for pending payment details

package/lnd_methods/address/create_chain_address.d.ts

@@ -12,7 +12,7 @@ export type CreateChainAddressArgs = AuthenticatedLightningArgs<{
 
 export type CreateChainAddressResult = {
   /** Chain Address */
-  address: string;
+  address?: string;
 };
 
 /**

package/lnd_methods/address/create_chain_address.js

@@ -5,6 +5,7 @@ const addressFormats = require('./address_formats');
 const {isLnd} = require('./../../lnd_requests');
 
 const connectFailMessage = '14 UNAVAILABLE: Connect Failed';
+const defaultAddressFormat = 'p2wpkh';
 const method = 'newAddress';
 const type = 'default';
 
@@ -13,7 +14,7 @@ const type = 'default';
   Requires `address:write` permission
 
   {
-    format: <Receive Address Type String> // "np2wpkh" || "p2wpkh"
+    [format]: <Receive Address Type String> // "np2wpkh" || "p2wpkh"
     [is_unused]: <Get As-Yet Unused Address Bool>
     lnd: <Authenticated LND API Object>
   }
@@ -28,7 +29,7 @@ module.exports = (args, cbk) => {
     return asyncAuto({
       // Check arguments
       validate: cbk => {
-        if (!args.format || addressFormats[args.format] === undefined) {
+        if (!!args.format && addressFormats[args.format] === undefined) {
           return cbk([400, 'ExpectedKnownAddressFormat']);
         }
 
@@ -41,11 +42,13 @@ module.exports = (args, cbk) => {
 
       // Type
       type: ['validate', ({}, cbk) => {
+        const format = args.format || defaultAddressFormat;
+
         if (!args.is_unused) {
-          return cbk(null, addressFormats[args.format]);
+          return cbk(null, addressFormats[format]);
         }
 
-        return cbk(null, addressFormats[`unused_${args.format}`]);
+        return cbk(null, addressFormats[`unused_${format}`]);
       }],
 
       // Get the address

package/lnd_methods/info/constants.json

@@ -31,7 +31,8 @@
     "86114c575c2dff9dff1e1bb4df961c64aea9fc1c": "0.10.4-beta",
     "d176d2d65fc06e6631c4dc9478592be8545a21de": "0.12.0-beta",
     "d233f61383f2f950aa06f5b09da5b0e78e784fae": "0.12.1-beta",
-    "d62c575f8499a314eb27f12462d20500b6bda2c7": "0.10.3-beta"
+    "d62c575f8499a314eb27f12462d20500b6bda2c7": "0.10.3-beta",
+    "df0b82f0165f19bde8832bacd1e35544b0a2990d": "0.14.0-beta"
   },
   "weightedType": "weightedcomb",
   "wrongLnd": "12 UNIMPLEMENTED: unknown service autopilotrpc.Autopilot"

package/lnd_methods/macaroon/verify_access.d.ts

@@ -18,7 +18,7 @@ export type VerifyAccessResult = {
 /**
  * Verify an access token has a given set of permissions
  *
- * Note: this method is not supported in LND versions 0.13.3 and below
+ * Note: this method is not supported in LND versions 0.13.4 and below
  *
  * Requires `macaroon:read` permission
  */

package/lnd_methods/macaroon/verify_access.js

@@ -14,7 +14,7 @@ const type = 'default';
 
 /** Verify an access token has a given set of permissions
 
-  Note: this method is not supported in LND versions 0.13.3 and below
+  Note: this method is not supported in LND versions 0.13.4 and below
 
   Requires `macaroon:read` permission
 

package/lnd_methods/offchain/get_channels.d.ts

@@ -40,8 +40,6 @@ export type GetChannelsResult = {
     is_partner_initiated: boolean;
     /** Channel Is Private */
     is_private: boolean;
-    /** Remote Key Is Static */
-    is_static_remote_key: boolean;
     /** Local Balance Tokens */
     local_balance: number;
     /** Local CSV Blocks Delay */

package/lnd_methods/offchain/get_channels.js

@@ -34,13 +34,10 @@ const type = 'default';
       [cooperative_close_delay_height]: <Deny Coop Close Until Height Number>
       id: <Standard Format Channel Id String>
       is_active: <Channel Active Bool>
-      is_anchor: <Channel Supports Anchor Outputs Bool>
       is_closing: <Channel Is Closing Bool>
       is_opening: <Channel Is Opening Bool>
       is_partner_initiated: <Channel Partner Opened Channel Bool>
       is_private: <Channel Is Private Bool>
-      is_static_remote_key: <Remote Key Is Static Bool>
-      is_variable_remote_key: <Remote Key Is Variable Bool>
       local_balance: <Local Balance Tokens Number>
       [local_csv]: <Local CSV Blocks Delay Number>
       [local_dust]: <Remote Non-Enforceable Amount Tokens Number>

package/lnd_methods/offchain/get_pending_channels.js

@@ -27,7 +27,6 @@ const type = 'default';
     pending_channels: [{
       [close_transaction_id]: <Channel Closing Transaction Id String>
       is_active: <Channel Is Active Bool>
-      is_anchor: <Channel Is Anchor Channel Type Bool>
       is_closing: <Channel Is Closing Bool>
       is_opening: <Channel Is Opening Bool>
       is_partner_initiated: <Channel Partner Initiated Channel Bool>

package/lnd_methods/offchain/send_message_to_peer.d.ts

@@ -21,7 +21,7 @@ export type SendMessageToPeerArgs =
  * If specified, message type is expected to be between 32768 and 65535
  * Message data should not be larger than 65533 bytes
  *
- * Note: this method is not supported in LND versions 0.13.3 and below
+ * Note: this method is not supported in LND versions 0.13.4 and below
  *
  * Requires `offchain:write` permission
  */

package/lnd_methods/offchain/send_message_to_peer.js

@@ -17,7 +17,7 @@ const type = 'default';
 
   Message data should not be larger than 65533 bytes
 
-  Note: this method is not supported in LND versions 0.13.3 and below
+  Note: this method is not supported in LND versions 0.13.4 and below
 
   Requires `offchain:write` permission
 

package/lnd_methods/offchain/subscribe_to_channels.d.ts

@@ -89,8 +89,6 @@ export type SubscribeToChannelsChannelOpenedEvent = {
   is_partner_initiated: boolean;
   /** Channel Is Private */
   is_private: boolean;
-  /** Remote Key Is Static */
-  is_static_remote_key: boolean;
   /** Local Balance Tokens */
   local_balance: number;
   /** Local Initially Pushed Tokens */

package/lnd_methods/offchain/subscribe_to_channels.js

@@ -83,13 +83,10 @@ const updateOpening = 'pending_open_channel';
     [cooperative_close_delay_height]: <Prevent Coop Close Until Height Number>
     id: <Standard Format Channel Id String>
     is_active: <Channel Active Bool>
-    is_anchor: <Channel Supports Anchor Outputs Bool>
     is_closing: <Channel Is Closing Bool>
     is_opening: <Channel Is Opening Bool>
     is_partner_initiated: <Channel Partner Opened Channel Bool>
     is_private: <Channel Is Private Bool>
-    is_static_remote_key: <Remote Key Is Static Bool>
-    is_variable_remote_key: <Remote Key Is Variable Bool>
     local_balance: <Local Balance Tokens Number>
     local_given: <Local Initially Pushed Tokens Number>
     local_reserve: <Local Reserved Tokens Number>

package/lnd_methods/onchain/send_to_chain_output_scripts.js

@@ -11,8 +11,11 @@ const initialConfirmationCount = 0;
 const {isArray} = Array;
 const {isBuffer} = Buffer;
 const method = 'sendOutputs';
+const minFeeRate = 1;
 const unconfirmedConfCount = 0;
 const type = 'wallet';
+const weightPerKWeight = 1e3;
+const weightPerVByte = 4;
 
 /** Send on-chain funds to multiple output scripts
 
@@ -58,6 +61,10 @@ module.exports = (args, cbk) => {
       },
 
       send: ['validate', ({}, cbk) => {
+        const feePerVByte = args.fee_tokens_per_vbyte || minFeeRate;
+
+        const feePerKw = feePerVByte * weightPerKWeight / weightPerVByte;
+
         return args.lnd[type][method]({
           label: args.description || undefined,
           min_confs: args.utxo_confirmations || undefined,
@@ -65,7 +72,7 @@ module.exports = (args, cbk) => {
             pk_script: hexAsBuffer(output.script),
             value: output.tokens.toString(),
           })),
-          sat_per_byte: args.fee_tokens_per_vbyte || undefined,
+          sat_per_kw: feePerKw,
           spend_unconfirmed: args.utxo_confirmations === unconfirmedConfCount,
         },
         (err, res) => {
@@ -78,7 +85,7 @@ module.exports = (args, cbk) => {
           }
 
           try {
-            fromBuffer(res.raw_tx).getId()
+            fromBuffer(res.raw_tx).getId();
           } catch (err) {
             return cbk([500, 'ExpectedRawTransactionInSendToOutputsResponse']);
           }

package/lnd_methods/unauthenticated/subscribe_to_wallet_status.js

@@ -71,8 +71,6 @@ module.exports = ({lnd}) => {
 
     subscription.cancel();
 
-    subscription.removeAllListeners();
-
     return;
   });
 

package/lnd_responses/pending_as_pending_channels.js

@@ -82,7 +82,6 @@ const outpointSeparator = ':';
     pending_channels: [{
       [close_transaction_id]: <Channel Closing Transaction Id String>
       is_active: <Channel Is Active Bool>
-      is_anchor: <Channel Is Anchor Channel Type Bool>
       is_closing: <Channel Is Closing Bool>
       is_opening: <Channel Is Opening Bool>
       is_partner_initiated: <Channel Partner Initiated Channel Bool>
@@ -288,7 +287,6 @@ module.exports = args => {
     return {
       close_transaction_id: endTx || undefined,
       is_active: false,
-      is_anchor: channel.commitment_type === anchorChannelType,
       is_closing: !chanOpen,
       is_opening: !!chanOpen,
       is_partner_initiated: channel.initiator === remoteInitiator,

package/lnd_responses/rpc_channel_as_channel.js

@@ -74,13 +74,10 @@ const outpointDelimiter = ':';
     [cooperative_close_delay_height]: <Prevent Coop Close Until Height Number>
     id: <Standard Format Channel Id String>
     is_active: <Channel Active Bool>
-    is_anchor: <Channel Supports Anchor Outputs Bool>
     is_closing: <Channel Is Closing Bool>
     is_opening: <Channel Is Opening Bool>
     is_partner_initiated: <Channel Partner Opened Channel Bool>
     is_private: <Channel Is Private Bool>
-    is_static_remote_key: <Remote Key Is Static Bool>
-    is_variable_remote_key: <Remote Key Is Variable Bool>
     local_balance: <Local Balance Tokens Number>
     local_csv: <Local CSV Blocks Delay Number>
     local_dust: <Remote Non-Enforceable Amount Tokens Number>
@@ -224,13 +221,10 @@ module.exports = args => {
     cooperative_close_delay_height: height,
     id: chanFormat({number: args.chan_id}).channel,
     is_active: args.active,
-    is_anchor: chanType === commitmentTypes.anchor,
     is_closing: false,
     is_opening: false,
     is_partner_initiated: !args.initiator,
     is_private: args.private,
-    is_static_remote_key: chanType === commitmentTypes.static_remote_key,
-    is_variable_remote_key: chanType === commitmentTypes.variable_remote_key,
     local_balance: Number(args.local_balance),
     local_csv: own.csv_delay,
     local_dust: Number(own.dust_limit_sat),

package/package.json

@@ -8,9 +8,9 @@
   },
   "dependencies": {
     "@grpc/grpc-js": "1.4.4",
-    "@grpc/proto-loader": "0.6.6",
+    "@grpc/proto-loader": "0.6.7",
     "@types/express": "4.17.13",
-    "@types/node": "16.11.7",
+    "@types/node": "16.11.9",
     "@types/request": "2.48.7",
     "@types/ws": "8.2.0",
     "async": "3.2.2",
@@ -29,8 +29,8 @@
   "devDependencies": {
     "@alexbosworth/node-fetch": "2.6.2",
     "@alexbosworth/tap": "15.0.10",
-    "tsd": "0.18.0",
-    "typescript": "4.4.4",
+    "tsd": "0.19.0",
+    "typescript": "4.5.2",
     "ws": "8.2.3"
   },
   "engines": {
@@ -56,5 +56,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "4.14.4"
+  "version": "5.0.0"
 }

package/test/lnd_methods/address/test_create_chain_address.js

@@ -3,11 +3,6 @@ const {test} = require('@alexbosworth/tap');
 const {createChainAddress} = require('./../../../');
 
 const tests = [
-  {
-    args: {},
-    description: 'An address format is required',
-    error: [400, 'ExpectedKnownAddressFormat'],
-  },
   {
     args: {format: 'foo'},
     description: 'A known address format is required',

package/test/lnd_methods/offchain/test_get_channels.js

@@ -11,13 +11,10 @@ const makeExpected = overrides => {
     cooperative_close_delay_height: undefined,
     id: '0x0x1',
     is_active: true,
-    is_anchor: false,
     is_closing: false,
     is_opening: false,
     is_partner_initiated: false,
     is_private: true,
-    is_static_remote_key: false,
-    is_variable_remote_key: true,
     local_balance: 1,
     local_csv: 1,
     local_dust: 1,
@@ -250,8 +247,6 @@ const tests = [
     expected: {
       channel: makeExpected({
         cooperative_close_delay_height: 1,
-        is_static_remote_key: true,
-        is_variable_remote_key: false,
       }),
     },
   },
@@ -261,8 +256,6 @@ const tests = [
     expected: {
       channel: makeExpected({
         cooperative_close_delay_height: 5e5,
-        is_anchor: true,
-        is_variable_remote_key: false,
       }),
     },
   },

package/test/lnd_methods/offchain/test_subscribe_to_channels.js

@@ -244,13 +244,10 @@ const tests = [
             cooperative_close_delay_height: undefined,
             id: '0x0x1',
             is_active: false,
-            is_anchor: false,
             is_closing: false,
             is_opening: false,
             is_partner_initiated: false,
             is_private: false,
-            is_static_remote_key: false,
-            is_variable_remote_key: true,
             local_balance: 1,
             local_csv: 1,
             local_dust: 1,

package/test/lnd_responses/test_pending_as_pending_channels.js

@@ -101,7 +101,6 @@ const makeExpectedPending = overrides => {
   const res = {
     close_transaction_id: Buffer.alloc(32).toString('hex'),
     is_active: false,
-    is_anchor: false,
     is_closing: true,
     is_opening: false,
     is_partner_initiated: true,

package/test/lnd_responses/test_rpc_channel_as_channel.js

@@ -69,13 +69,10 @@ const makeExpected = overrides => {
     cooperative_close_delay_height: undefined,
     id: '0x0x1',
     is_active: true,
-    is_anchor: false,
     is_closing: false,
     is_opening: false,
     is_partner_initiated: true,
     is_private: true,
-    is_static_remote_key: false,
-    is_variable_remote_key: true,
     local_balance: 1,
     local_csv: 1,
     local_dust: 1,
@@ -236,8 +233,6 @@ const tests = [
     description: 'Initiated RPC channel is mapped to channel',
     expected: makeExpected({
       is_partner_initiated: false,
-      is_static_remote_key: true,
-      is_variable_remote_key: false,
     }),
   },
   {
@@ -262,8 +257,6 @@ const tests = [
     }),
     description: 'Local constraints RPC channel is mapped to channel',
     expected: makeExpected({
-      is_anchor: true,
-      is_variable_remote_key: false,
       local_csv: 1,
       local_dust: 1,
       local_max_htlcs: 1,