lightning 4.14.1 → 5.0.0

package/CHANGELOG.md

@@ -1,6 +1,18 @@
 # Versions
 
-## 4.14.1
+## 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/index.js

@@ -75,10 +75,10 @@ const {lndGateway} = require('./lnd_gateway');
 const {lockUtxo} = require('./lnd_methods');
 const {openChannel} = require('./lnd_methods');
 const {openChannels} = require('./lnd_methods');
+const {pay} = require('./lnd_methods');
 const {payViaPaymentDetails} = require('./lnd_methods');
 const {payViaPaymentRequest} = require('./lnd_methods');
 const {payViaRoutes} = require('./lnd_methods');
-const {pay} = require('./lnd_methods');
 const {prepareForChannelProposal} = require('./lnd_methods');
 const {probeForRoute} = require('./lnd_methods');
 const {proposeChannel} = require('./lnd_methods');
@@ -123,8 +123,8 @@ const {subscribeToWalletStatus} = require('./lnd_methods');
 const {unauthenticatedLndGrpc} = require('./lnd_grpc');
 const {unlockUtxo} = require('./lnd_methods');
 const {unlockWallet} = require('./lnd_methods');
-const {updateConnectedWatchtower} = require('./lnd_methods');
 const {updateChainTransaction} = require('./lnd_methods');
+const {updateConnectedWatchtower} = require('./lnd_methods');
 const {updatePathfindingSettings} = require('./lnd_methods');
 const {updateRoutingFees} = require('./lnd_methods');
 const {verifyAccess} = require('./lnd_methods');
@@ -211,10 +211,10 @@ module.exports = {
   lockUtxo,
   openChannel,
   openChannels,
+  pay,
   payViaPaymentDetails,
   payViaPaymentRequest,
   payViaRoutes,
-  pay,
   prepareForChannelProposal,
   probeForRoute,
   proposeChannel,
@@ -259,8 +259,8 @@ module.exports = {
   unauthenticatedLndGrpc,
   unlockUtxo,
   unlockWallet,
-  updateConnectedWatchtower,
   updateChainTransaction,
+  updateConnectedWatchtower,
   updatePathfindingSettings,
   updateRoutingFees,
   verifyAccess,

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/subscribe_to_rpc_requests.d.ts

@@ -21,8 +21,6 @@ export type SubscribeToRpcRequestsResult = {
 };
 
 export type SubscribeToRpcRequestsCommonEvent = {
-  /** Call Id Number */
-  call: number;
   /** Message Id Number */
   id: number;
   /** Base64 Encoded Macaroon String */
@@ -122,11 +120,17 @@ export type SubscribeToRpcRequestsPayViaRouteRequestEvent =
     };
   }>;
 
+export type SubscribeToRpcRequestsRequestOrResponseEvent =
+  SubscribeToRpcRequestsCommonEvent & {
+    /** Call Id Number */
+    call: number;
+  };
+
 export type SubscribeToRpcRequestsRequestEvent =
-  SubscribeToRpcRequestsCommonEvent;
+  SubscribeToRpcRequestsRequestOrResponseEvent;
 
 export type SubscribeToRpcRequestsResponseEvent =
-  SubscribeToRpcRequestsCommonEvent;
+  SubscribeToRpcRequestsRequestOrResponseEvent;
 
 /**
  * Subscribe to RPC requests and their responses

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/disconnect_watchtower.d.ts

@@ -6,8 +6,6 @@ import {
 export type DisconnectWatchtowerArgs = AuthenticatedLightningArgs<{
   /** Watchtower Public Key Hex String */
   public_key: string;
-  /** Retry Delay Milliseconds Number */
-  retry_delay?: number;
 }>;
 
 /**

package/lnd_methods/offchain/disconnect_watchtower.js

@@ -17,7 +17,6 @@ const unimplementedError = '12 UNIMPLEMENTED: unknown service wtclientrpc.Watcht
   {
     lnd: <Authenticated LND API Object>
     public_key: <Watchtower Public Key Hex String>
-    [retry_delay]: <Retry Delay Milliseconds Number>
   }
 
   @returns via cbk or Promise

package/lnd_methods/offchain/emit_payment.js

@@ -1,8 +1,10 @@
 const {confirmedFromPayment} = require('./../../lnd_responses');
 const {failureFromPayment} = require('./../../lnd_responses');
 const {pendingFromPayment} = require('./../../lnd_responses');
+const {routingFailureFromHtlc} = require('./../../lnd_responses');
 const {states} = require('./payment_states');
 
+const failedStatus = 'FAILED';
 const {isArray} = Array;
 
 /** Emit payment from payment event
@@ -31,6 +33,16 @@ module.exports = ({data, emitter}) => {
         return;
       }
 
+      // Emit routing failures
+      data.htlcs.filter(n => n.status === failedStatus).forEach(htlc => {
+        return emitter.emit('routing_failure', routingFailureFromHtlc(htlc));
+      });
+
+      // Exit early when the HTLCs have no pending payments
+      if (!data.htlcs.find(n => n.status === states.paying)) {
+        return;
+      }
+
       return emitter.emit('paying', pendingFromPayment(data));
 
     default:

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/offchain/subscribe_to_past_payment.d.ts

@@ -66,7 +66,56 @@ export type SubscribeToPastPaymentFailedEvent = {
   is_route_not_found: boolean;
 };
 
-export type SubscribeToPastPaymentPayingEvent = {[key: string]: never};
+export type SubscribeToPastPaymentPayingEvent = {
+  /** Payment Created At ISO 8601 Date String */
+  created_at: string;
+  /** Payment Destination Hex String */
+  destination: string;
+  /** Payment Hash Hex String */
+  id: string;
+  /** Total Millitokens Pending String */
+  mtokens: string;
+  paths: {
+    /** Total Fee Tokens Pending Number */
+    fee: number;
+    /** Total Fee Millitokens Pending String */
+    fee_mtokens: string;
+    hops: {
+      /** Standard Format Channel Id String */
+      channel: string;
+      /** Channel Capacity Tokens Number */
+      channel_capacity: number;
+      /** Fee Tokens Rounded Down Number */
+      fee: number;
+      /** Fee Millitokens String */
+      fee_mtokens: string;
+      /** Forward Tokens Number */
+      forward: number;
+      /** Forward Millitokens String */
+      forward_mtokens: string;
+      /** Public Key Hex String */
+      public_key: string;
+      /** Timeout Block Height Number */
+      timeout: number;
+    }[];
+    /** Total Millitokens Pending String */
+    mtokens: string;
+    /** Total Fee Tokens Pending Rounded Up Number */
+    safe_fee: number;
+    /** Total Tokens Pending, Rounded Up Number */
+    safe_tokens: number;
+    /** Expiration Block Height Number */
+    timeout: number;
+  }[];
+  /** BOLT 11 Encoded Payment Request String */
+  request?: string;
+  /** Total Tokens Pending, Rounded Up Number */
+  safe_tokens: number;
+  /** Expiration Block Height Number */
+  timeout?: number;
+  /** Total Tokens Pending Rounded Down Number */
+  tokens: number;
+};
 
 /**
  * Subscribe to the status of a past payment

package/lnd_methods/offchain/subscribe_to_past_payment.js

@@ -8,10 +8,12 @@ const {confirmedFromPayment} = require('./../../lnd_responses');
 const {confirmedFromPaymentStatus} = require('./../../lnd_responses');
 const emitPayment = require('./emit_payment');
 const {failureFromPayment} = require('./../../lnd_responses');
+const {handleRemoveListener} = require('./../../grpc');
 const {isLnd} = require('./../../lnd_requests');
 const {safeTokens} = require('./../../bolt00');
 const {states} = require('./payment_states');
 
+const events = ['confirmed', 'failed', 'paying'];
 const hexToBuffer = hex => Buffer.from(hex, 'hex');
 const {isArray} = Array;
 const isHash = n => /^[0-9A-F]{64}$/i.test(n);
@@ -141,6 +143,9 @@ module.exports = args => {
 
   const sub = args.lnd[type][method]({payment_hash: hash});
 
+  // Terminate subscription when all listeners are removed
+  handleRemoveListener({emitter, events, subscription: sub});
+
   sub.on('data', data => emitPayment({data, emitter}));
   sub.on('end', () => emitter.emit('end'));
   sub.on('error', err => emitError(err));

package/lnd_methods/offchain/subscribe_to_pay.js

@@ -146,7 +146,62 @@ const unknownServiceErr = 'unknown service verrpc.Versioner';
   }
 
   @event 'paying'
-  {}
+  {
+    created_at: <Payment Created At ISO 8601 Date String>
+    destination: <Payment Destination Hex String>
+    id: <Payment Hash Hex String>
+    mtokens: <Total Millitokens Pending String>
+    paths: [{
+      fee: <Total Fee Tokens Pending Number>
+      fee_mtokens: <Total Fee Millitokens Pending String>
+      hops: [{
+        channel: <Standard Format Channel Id String>
+        channel_capacity: <Channel Capacity Tokens Number>
+        fee: <Fee Tokens Rounded Down Number>
+        fee_mtokens: <Fee Millitokens String>
+        forward: <Forward Tokens Number>
+        forward_mtokens: <Forward Millitokens String>
+        public_key: <Public Key Hex String>
+        timeout: <Timeout Block Height Number>
+      }]
+      mtokens: <Total Millitokens Pending String>
+      safe_fee: <Total Fee Tokens Pending Rounded Up Number>
+      safe_tokens: <Total Tokens Pending, Rounded Up Number>
+      timeout: <Expiration Block Height Number>
+    }]
+    [request]: <BOLT 11 Encoded Payment Request String>
+    safe_tokens: <Total Tokens Pending, Rounded Up Number>
+    [timeout]: <Expiration Block Height Number>
+    tokens: <Total Tokens Pending Rounded Down Number>
+  }
+
+  @event 'routing_failure'
+  {
+    [channel]: <Standard Format Channel Id String>
+    index: <Failure Index Number>
+    [mtokens]: <Millitokens String>
+    [public_key]: <Public Key Hex String>
+    reason: <Failure Reason String>
+    route: {
+      fee: <Total Route Fee Tokens To Pay Number>
+      fee_mtokens: <Total Route Fee Millitokens To Pay String>
+      hops: [{
+        channel: <Standard Format Channel Id String>
+        channel_capacity: <Channel Capacity Tokens Number>
+        fee: <Fee Number>
+        fee_mtokens: <Fee Millitokens String>
+        forward: <Forward Tokens Number>
+        forward_mtokens: <Forward Millitokens String>
+        public_key: <Public Key Hex String>
+        timeout: <Timeout Block Height Number>
+      }]
+      mtokens: <Total Route Millitokens String>
+      [payment]: <Payment Identifier Hex String>
+      timeout: <Expiration Block Height Number>
+      tokens: <Total Route Tokens Number>
+      [total_mtokens]: <Total Millitokens String>
+    }
+  }
 */
 module.exports = args => {
   if (!!args.cltv_delta && !!args.request) {
@@ -316,7 +371,7 @@ module.exports = args => {
         last_hop_pubkey: hexToBuf(args.incoming_peer),
         max_parts: args.max_paths || defaultMaxPaths,
         max_shard_size_msat: args.max_path_mtokens || undefined,
-        no_inflight_updates: true,
+        no_inflight_updates: false,
         outgoing_chan_id: !hasOutIds ? singleOut : undefined,
         outgoing_chan_ids: outgoingChannelIds,
         payment_addr: !!args.payment ? hexToBuf(args.payment) : undefined,

package/lnd_methods/offchain/subscribe_to_pay_via_details.js

@@ -120,7 +120,61 @@ const type = 'router';
   }
 
   @event 'paying'
-  {}
+  {
+    created_at: <Payment Created At ISO 8601 Date String>
+    destination: <Payment Destination Hex String>
+    id: <Payment Hash Hex String>
+    mtokens: <Total Millitokens Pending String>
+    paths: [{
+      fee: <Total Fee Tokens Pending Number>
+      fee_mtokens: <Total Fee Millitokens Pending String>
+      hops: [{
+        channel: <Standard Format Channel Id String>
+        channel_capacity: <Channel Capacity Tokens Number>
+        fee: <Fee Tokens Rounded Down Number>
+        fee_mtokens: <Fee Millitokens String>
+        forward: <Forward Tokens Number>
+        forward_mtokens: <Forward Millitokens String>
+        public_key: <Public Key Hex String>
+        timeout: <Timeout Block Height Number>
+      }]
+      mtokens: <Total Millitokens Pending String>
+      safe_fee: <Total Fee Tokens Pending Rounded Up Number>
+      safe_tokens: <Total Tokens Pending, Rounded Up Number>
+      timeout: <Expiration Block Height Number>
+    }]
+    safe_tokens: <Total Tokens Pending, Rounded Up Number>
+    [timeout]: <Expiration Block Height Number>
+    tokens: <Total Tokens Pending Rounded Down Number>
+  }
+
+  @event 'routing_failure'
+  {
+    [channel]: <Standard Format Channel Id String>
+    index: <Failure Index Number>
+    [mtokens]: <Millitokens String>
+    [public_key]: <Public Key Hex String>
+    reason: <Failure Reason String>
+    route: {
+      fee: <Total Route Fee Tokens To Pay Number>
+      fee_mtokens: <Total Route Fee Millitokens To Pay String>
+      hops: [{
+        channel: <Standard Format Channel Id String>
+        channel_capacity: <Channel Capacity Tokens Number>
+        fee: <Fee Number>
+        fee_mtokens: <Fee Millitokens String>
+        forward: <Forward Tokens Number>
+        forward_mtokens: <Forward Millitokens String>
+        public_key: <Public Key Hex String>
+        timeout: <Timeout Block Height Number>
+      }]
+      mtokens: <Total Route Millitokens String>
+      [payment]: <Payment Identifier Hex String>
+      timeout: <Expiration Block Height Number>
+      tokens: <Total Route Tokens Number>
+      [total_mtokens]: <Total Millitokens String>
+    }
+  }
 */
 module.exports = args => {
   if (!isPublicKey(args.destination)) {

package/lnd_methods/offchain/subscribe_to_pay_via_request.js

@@ -100,7 +100,62 @@ const type = 'router';
   }
 
   @event 'paying'
-  {}
+  {
+    created_at: <Payment Created At ISO 8601 Date String>
+    destination: <Payment Destination Hex String>
+    id: <Payment Hash Hex String>
+    mtokens: <Total Millitokens Pending String>
+    paths: [{
+      fee: <Total Fee Tokens Pending Number>
+      fee_mtokens: <Total Fee Millitokens Pending String>
+      hops: [{
+        channel: <Standard Format Channel Id String>
+        channel_capacity: <Channel Capacity Tokens Number>
+        fee: <Fee Tokens Rounded Down Number>
+        fee_mtokens: <Fee Millitokens String>
+        forward: <Forward Tokens Number>
+        forward_mtokens: <Forward Millitokens String>
+        public_key: <Public Key Hex String>
+        timeout: <Timeout Block Height Number>
+      }]
+      mtokens: <Total Millitokens Pending String>
+      safe_fee: <Total Fee Tokens Pending Rounded Up Number>
+      safe_tokens: <Total Tokens Pending, Rounded Up Number>
+      timeout: <Expiration Block Height Number>
+    }]
+    [request]: <BOLT 11 Encoded Payment Request String>
+    safe_tokens: <Total Tokens Pending, Rounded Up Number>
+    [timeout]: <Expiration Block Height Number>
+    tokens: <Total Tokens Pending Rounded Down Number>
+  }
+
+  @event 'routing_failure'
+  {
+    [channel]: <Standard Format Channel Id String>
+    index: <Failure Index Number>
+    [mtokens]: <Millitokens String>
+    [public_key]: <Public Key Hex String>
+    reason: <Failure Reason String>
+    route: {
+      fee: <Total Route Fee Tokens To Pay Number>
+      fee_mtokens: <Total Route Fee Millitokens To Pay String>
+      hops: [{
+        channel: <Standard Format Channel Id String>
+        channel_capacity: <Channel Capacity Tokens Number>
+        fee: <Fee Number>
+        fee_mtokens: <Fee Millitokens String>
+        forward: <Forward Tokens Number>
+        forward_mtokens: <Forward Millitokens String>
+        public_key: <Public Key Hex String>
+        timeout: <Timeout Block Height Number>
+      }]
+      mtokens: <Total Route Millitokens String>
+      [payment]: <Payment Identifier Hex String>
+      timeout: <Expiration Block Height Number>
+      tokens: <Total Route Tokens Number>
+      [total_mtokens]: <Total Millitokens String>
+    }
+  }
 */
 module.exports = args => {
   if (!args.request) {

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/index.js

@@ -14,6 +14,7 @@ const pendingAsPendingChannels = require('./pending_as_pending_channels');
 const pendingFromPayment = require('./pending_from_payment');
 const policyFromChannelUpdate = require('./policy_from_channel_update');
 const routesFromQueryRoutes = require('./routes_from_query_routes');
+const routingFailureFromHtlc = require('./routing_failure_from_htlc');
 const rpcAttemptHtlcAsAttempt = require('./rpc_attempt_htlc_as_attempt');
 const rpcChannelAsChannel = require('./rpc_channel_as_channel');
 const rpcChannelAsOldRpcChannel = require('./rpc_channel_as_old_rpc_channel');
@@ -57,6 +58,7 @@ module.exports = {
   pendingFromPayment,
   policyFromChannelUpdate,
   routesFromQueryRoutes,
+  routingFailureFromHtlc,
   rpcAttemptHtlcAsAttempt,
   rpcChannelAsChannel,
   rpcChannelAsOldRpcChannel,

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/routing_failure_from_htlc.js

@@ -0,0 +1,105 @@
+const paymentFailure = require('./payment_failure');
+const rpcRouteAsRoute = require('./rpc_route_as_route');
+
+/** Derive routing failure details from an HTLC
+
+  {
+    attempt_time_ns: <HTLC Sent At Epoch Time Nanoseconds String>
+    failure: {
+      [channel_update]: {
+        base_fee: <Base Fee Millitokens Number>
+        chain_hash: <Chain Hash Buffer Object>
+        [chan_id]: <Numeric Channel Id String>
+        channel_flags: <Channel Flags Number>
+        extra_opaque_data: <Extra Opaque Data Buffer Object>
+        fee_rate: <Fee Rate Number>
+        htlc_maximum_msat: <Maximum HTLC Millitokens Number>
+        htlc_minimum_msat: <Minimum HTLC Millitokens Number>
+        message_flags: <Message Flags Number>
+        signature: <Signature Buffer Object>
+        time_lock_delta: <CLTV Delta Number>
+        timestamp: <Update Epoch Time Seconds Number>
+      }
+      code: <Failure Code String>
+      [failure_source_index]: <Failed Hop Index Number>
+      height: <Height Number>
+      htlc_msat: <HTLC Millitokens String>
+    }
+    resolve_time_ns: <HTLC Resolved At Epoch Time Nanoseconds String>
+    route: {
+      hops: [{
+        amt_to_forward: <Tokens to Forward String>
+        amt_to_forward_msat: <Millitokens to Forward String>
+        chan_id: <Numeric Format Channel Id String>
+        chan_capacity: <Channel Capacity Number>
+        expiry: <Timeout Chain Height Number>
+        fee: <Fee in Tokens Number>
+        fee_msat: <Fee in Millitokens Number>
+        [mpp_record]: {
+          payment_addr: <Payment Identifier Buffer>
+          total_amt_msat: <Total Payment Millitokens Amount String>
+        }
+        pub_key: <Next Hop Public Key Hex String>
+        tlv_payload: <Has Extra TLV Data Bool>
+      }]
+      total_amt: <Total Tokens String>
+      total_amt_msat: <Route Total Millitokens String>
+      total_fees: <Route Fee Tokens String>
+      total_fees_msat: <Route Total Fees Millitokens String>
+      total_time_lock: <Route Total Timelock Number>
+    }
+    status: <HTLC Status String>
+  }
+
+  @throws
+  <Error>
+
+  @returns
+  {
+    [channel]: <Standard Format Channel Id String>
+    index: <Failure Index Number>
+    [mtokens]: <Millitokens String>
+    [public_key]: <Public Key Hex String>
+    reason: <Failure Reason String>
+    route: {
+      fee: <Total Route Fee Tokens To Pay Number>
+      fee_mtokens: <Total Route Fee Millitokens To Pay String>
+      hops: [{
+        channel: <Standard Format Channel Id String>
+        channel_capacity: <Channel Capacity Tokens Number>
+        fee: <Fee Number>
+        fee_mtokens: <Fee Millitokens String>
+        forward: <Forward Tokens Number>
+        forward_mtokens: <Forward Millitokens String>
+        public_key: <Public Key Hex String>
+        timeout: <Timeout Block Height Number>
+      }]
+      mtokens: <Total Route Millitokens String>
+      [payment]: <Payment Identifier Hex String>
+      timeout: <Expiration Block Height Number>
+      tokens: <Total Route Tokens Number>
+      [total_mtokens]: <Total Millitokens String>
+    }
+  }
+*/
+module.exports = htlc => {
+  const from = htlc.route.hops[htlc.failure.failure_source_index - 1] || {};
+
+  const failure = paymentFailure({
+    channel: htlc.channel,
+    failure: htlc.failure,
+    index: htlc.index,
+    key: from.pub_key,
+  });
+
+  const route = rpcRouteAsRoute(htlc.route);
+
+  return {
+    route,
+    channel: failure.details.channel,
+    index: failure.details.index,
+    mtokens: route.mtokens,
+    public_key: from.pub_key,
+    reason: failure.message,
+  };
+};

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,29 +8,29 @@
   },
   "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",
     "asyncjs-util": "1.2.7",
-    "bitcoinjs-lib": "5.2.0",
+    "bitcoinjs-lib": "6.0.0",
     "bn.js": "5.2.0",
     "body-parser": "1.19.0",
     "bolt07": "1.7.4",
     "bolt09": "0.2.0",
     "cbor": "8.1.0",
     "express": "4.17.1",
-    "invoices": "2.0.1",
+    "invoices": "2.0.2",
     "psbt": "1.1.10"
   },
   "description": "Lightning Network client library",
   "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.1"
+  "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_get_payment.js

@@ -52,6 +52,8 @@ const makeLnd = args => {
         };
         const emitter = new EventEmitter();
 
+        emitter.cancel = () => {};
+
         if (!!args.is_end) {
           process.nextTick(() => emitter.emit('end'));
         } else if (!!args.err) {

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_routing_failure_from_htlc.js

@@ -0,0 +1,137 @@
+const {test} = require('@alexbosworth/tap');
+
+const {routingFailureFromHtlc} = require('./../../lnd_responses');
+
+const makeHtlc = overrides => {
+  const htlc = {
+    attempt_time_ns: '1',
+    failure: {
+      channel_update: {
+        base_fee: 1,
+        chain_hash: Buffer.alloc(32),
+        chan_id: '1',
+        channel_flags: 1,
+        extra_opaque_data: Buffer.alloc(0),
+        fee_rate: 1,
+        htlc_maximum_msat: 1,
+        htlc_minimum_msat: 1,
+        message_flags: 1,
+        signature: Buffer.alloc(0),
+        time_lock_delta: 1,
+        timestamp: 1,
+      },
+      code: 'TEMPORARY_CHANNEL_FAILURE',
+      failure_source_index: 0,
+      height: 1,
+      htlc_msat: '1000',
+    },
+    resolve_time_ns: '1',
+    route: {
+      hops: [{
+        amt_to_forward: '1',
+        amt_to_forward_msat: '1000',
+        chan_id: '1',
+        chan_capacity: 1,
+        expiry: 1,
+        fee: 0,
+        fee_msat: '0',
+        pub_key: Buffer.alloc(33, 3).toString('hex'),
+        tlv_payload: true,
+      }],
+      total_amt: '1',
+      total_amt_msat: '1000',
+      total_fees: 0,
+      total_fees_msat: '0',
+      total_time_lock: 1,
+    },
+    status: 'FAILED',
+  };
+
+  Object.keys(overrides || {}).forEach(k => htlc[k] = overrides[k]);
+
+  return htlc;
+};
+
+const makeExpected = overrides => {
+  const expected = {
+    route: {
+      fee: 0,
+      fee_mtokens: '0',
+      hops: [
+        {
+          channel: '0x0x1',
+          channel_capacity: 1,
+          fee: 0,
+          fee_mtokens: '0',
+          forward: 1,
+          forward_mtokens: '1000',
+          public_key: '030303030303030303030303030303030303030303030303030303030303030303',
+          timeout: 1,
+        }
+      ],
+      mtokens: '1000',
+      payment: undefined,
+      timeout: 1,
+      tokens: 1,
+      total_mtokens: undefined,
+    },
+    channel: '0x0x1',
+    index: 0,
+    mtokens: '1000',
+    public_key: undefined,
+    reason: 'TemporaryChannelFailure',
+  };
+
+  Object.keys(overrides || {}).forEach(key => expected[key] = overrides[key]);
+
+  return expected;
+};
+
+const tests = [
+  {
+    args: makeHtlc({}),
+    description: 'HTLC is mapped to a routing failure',
+    expected: makeExpected({}),
+  },
+  {
+    args: makeHtlc({
+      failure: {
+        channel_update: {
+          base_fee: 1,
+          chain_hash: Buffer.alloc(32),
+          chan_id: '1',
+          channel_flags: 1,
+          extra_opaque_data: Buffer.alloc(0),
+          fee_rate: 1,
+          htlc_maximum_msat: 1,
+          htlc_minimum_msat: 1,
+          message_flags: 1,
+          signature: Buffer.alloc(0),
+          time_lock_delta: 1,
+          timestamp: 1,
+        },
+        code: 'TEMPORARY_CHANNEL_FAILURE',
+        failure_source_index: 1,
+        height: 1,
+        htlc_msat: '1000',
+      },
+    }),
+    description: 'HTLC is mapped to a routing failure with key',
+    expected: makeExpected({
+      index: 1,
+      public_key: Buffer.alloc(33, 3).toString('hex'),
+    }),
+  },
+];
+
+tests.forEach(({args, description, error, expected}) => {
+  return test(description, ({end, strictSame, throws}) => {
+    if (!!error) {
+      throws(() => routingFailureFromHtlc(args), new Error(error), 'Got err');
+    } else {
+      strictSame(routingFailureFromHtlc(args), expected, 'HTLC mapped');
+    }
+
+    return end();
+  });
+});

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,

package/test/typescript/disconnect_watchtower.test-d.ts

@@ -10,13 +10,7 @@ expectError(disconnectWatchtower());
 expectError(disconnectWatchtower({}));
 expectError(disconnectWatchtower({lnd}));
 expectError(disconnectWatchtower({public_key}));
-expectError(disconnectWatchtower({retry_delay}));
-expectError(disconnectWatchtower({lnd, retry_delay}));
 
 expectType<void>(await disconnectWatchtower({lnd, public_key}));
-expectType<void>(await disconnectWatchtower({lnd, public_key, retry_delay}));
 
 expectType<void>(disconnectWatchtower({lnd, public_key}, () => {}));
-expectType<void>(
-  disconnectWatchtower({lnd, public_key, retry_delay}, () => {})
-);