lightning 4.14.4 → 5.1.1

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Versions
 
+## 5.1.1
+
+- `openChannels`: Fix `cooperative_close_address` not being set on channels
+
+## 5.1.0
+
+- Add support for LND 0.14.1
+- `openChannels`: Add `is_avoiding_broadcast` to avoid all funding broadcast
+
+## 5.0.1
+
+- `createChainAddress`: Fix type hints to reflect optionality of `format`
+
+## 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/README.md

@@ -52,10 +52,6 @@ To access unauthenticated methods like the wallet unlocker, use
 
 ## Methods
 
-There are two libraries, [ln-service](https://github.com/alexbosworth/ln-service) and this library.
-
-Methods exported by this library support typescript, but ln-service includes additional metthods.
-
 - [addPeer](https://github.com/alexbosworth/ln-service#addpeer): Connect to a new peer
 - [authenticatedLndGrpc](https://github.com/alexbosworth/ln-service#authenticatedlndgrpc): 
     Instantiate connection to authenticated lnd methods.

package/lnd_methods/address/create_chain_address.d.ts

@@ -5,7 +5,7 @@ import {
 
 export type CreateChainAddressArgs = AuthenticatedLightningArgs<{
   /** Receive Address Type */
-  format: 'np2wpkh' | 'p2wpkh';
+  format?: 'np2wpkh' | 'p2wpkh';
   /** Get As-Yet Unused Address */
   is_unused?: boolean;
 }>;

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

@@ -24,6 +24,7 @@
     "4f567577db9d85b6f392f960b3aabddcad3cd02c": "0.13.3-beta",
     "52bb3f33707b81972c67937c7a89addcdf00991c": "0.10.1-beta",
     "596fd90ef310cd7abbf2251edaae9ba4d5f8a689": "0.13.1-beta",
+    "6042004edaaa5b3cad0a0808ff23dba4716f7178": "0.14.1-beta",
     "61c34683058f2cc8dc10f49392a0057440d831c4": "0.13.4-beta",
     "725ff104808f49f0a5247bfdb4b6b5da7f488d38": "0.13.0-beta",
     "7f34774529fa0964d47fc418d4d2965435cbfdc0": "0.11.1-beta",
@@ -31,7 +32,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/get_route_through_hops.d.ts

@@ -2,9 +2,9 @@ import {
   AuthenticatedLightningArgs,
   AuthenticatedLightningMethod,
 } from '../../typescript';
-import {Xor} from '../../typescript/util';
+import {MergeExclusive} from 'type-fest';
 
-type Tokens = Xor<
+type Tokens = MergeExclusive<
   {
     /** Millitokens to Send */
     mtokens?: string;

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_pay.d.ts

@@ -2,75 +2,83 @@ import {
   AuthenticatedLightningArgs,
   AuthenticatedLightningSubscription,
 } from '../../typescript';
+import {MergeExclusive} from 'type-fest';
 
-type SubscribeToPayWithDestination = {
+export type SubscribeToPayWithDestinationArgs = {
   /** Destination Public Key String> */
   destination: string;
   /** Payment Request Hash Hex String> */
   id: string;
   /** Final CLTV Delta Number> */
   cltv_delta?: number;
-  request?: never;
 };
 
-type SubscribeToPayWithRequest = {
+export type SubscribeToPayWithRequestArgs = {
   /** BOLT 11 Payment Request String> */
   request: string;
-  cltv_delta?: never;
+};
+
+export type SubscribeToPayWithDestinationOrRequestArgs = MergeExclusive<
+  SubscribeToPayWithDestinationArgs,
+  SubscribeToPayWithRequestArgs
+>;
+
+export type SubscribeToPayOptionsArgs = {
+  features?: {
+    /** Feature Bit Number> */
+    bit: number;
+  }[];
+  /** Pay Through Specific Final Hop Public Key Hex String> */
+  incoming_peer?: string;
+  /** Maximum Fee Tokens To Pay Number> */
+  max_fee?: number;
+  /** Maximum Fee Millitokens to Pay String> */
+  max_fee_mtokens?: string;
+  /** Maximum Millitokens For A Multi-Path Path */
+  max_path_mtokens?: string;
+  /** Maximum Simultaneous Paths Number> */
+  max_paths?: number;
+  /** Maximum Height of Payment Timeout Number> */
+  max_timeout_height?: number;
+  messages?: {
+    /** Message Type Number String> */
+    type: string;
+    /** Message Raw Value Hex Encoded String> */
+    value: string;
+  }[];
+  /** Millitokens to Pay String> */
+  mtokens?: string;
+  /** Pay Out of Outgoing Channel Id String> */
+  outgoing_channel?: string;
+  /** Pay Out of Outgoing Channel Ids String> */
+  outgoing_channels?: string[];
+  /** Time to Spend Finding a Route Milliseconds Number> */
+  pathfinding_timeout?: number;
+  /** Payment Identifier Hex String> */
+  payment?: string;
+  routes?: {
+    /** Base Routing Fee In Millitokens String> */
+    base_fee_mtokens?: string;
+    /** Standard Format Channel Id String> */
+    channel?: string;
+    /** CLTV Blocks Delta Number> */
+    cltv_delta?: number;
+    /** Fee Rate In Millitokens Per Million Number> */
+    fee_rate?: number;
+    /** Forward Edge Public Key Hex String> */
+    public_key: string;
+  }[][];
+  /** Tokens to Pay Number> */
+  tokens?: number;
 };
 
 export type SubscribeToPayArgs = AuthenticatedLightningArgs<
-  (SubscribeToPayWithDestination | SubscribeToPayWithRequest) & {
-    features?: {
-      /** Feature Bit Number> */
-      bit: number;
-    }[];
-    /** Pay Through Specific Final Hop Public Key Hex String> */
-    incoming_peer?: string;
-    /** Maximum Fee Tokens To Pay Number> */
-    max_fee?: number;
-    /** Maximum Fee Millitokens to Pay String> */
-    max_fee_mtokens?: string;
-    /** Maximum Millitokens For A Multi-Path Path */
-    max_path_mtokens?: string;
-    /** Maximum Simultaneous Paths Number> */
-    max_paths?: number;
-    /** Maximum Height of Payment Timeout Number> */
-    max_timeout_height?: number;
-    messages?: {
-      /** Message Type Number String> */
-      type: string;
-      /** Message Raw Value Hex Encoded String> */
-      value: string;
-    }[];
-    /** Millitokens to Pay String> */
-    mtokens?: string;
-    /** Pay Out of Outgoing Channel Id String> */
-    outgoing_channel?: string;
-    /** Pay Out of Outgoing Channel Ids String> */
-    outgoing_channels?: string[];
-    /** Time to Spend Finding a Route Milliseconds Number> */
-    pathfinding_timeout?: number;
-    /** Payment Identifier Hex String> */
-    payment?: string;
-    routes?: {
-      /** Base Routing Fee In Millitokens String> */
-      base_fee_mtokens?: string;
-      /** Standard Format Channel Id String> */
-      channel?: string;
-      /** CLTV Blocks Delta Number> */
-      cltv_delta?: number;
-      /** Fee Rate In Millitokens Per Million Number> */
-      fee_rate?: number;
-      /** Forward Edge Public Key Hex String> */
-      public_key: string;
-    }[][];
-    /** Tokens to Probe Number> */
-    tokens?: number;
-  }
+  SubscribeToPayWithDestinationOrRequestArgs & SubscribeToPayOptionsArgs
 >;
 
 export type SubscribeToPayConfirmedEvent = {
+  /** Payment Confirmed At ISO 8601 Date String */
+  confirmed_at: string;
   /** Total Fee Tokens Paid Rounded Down Number> */
   fee: number;
   /** Total Fee Millitokens Paid String> */
@@ -174,7 +182,103 @@ export type SubscribeToPayFailedEvent = {
   };
 };
 
-export type SubscribeToPayPayingEvent = {[key: string]: never};
+export type SubscribeToPayPayingEvent = {
+  /** 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;
+};
+
+export type SubscribeToRoutingFailureEvent = {
+  /** Standard Format Channel Id String> */
+  channel?: string;
+  /** Failure Index Number> */
+  index: number;
+  /** Millitokens String> */
+  mtokens?: string;
+  /** Public Key Hex String> */
+  public_key?: string;
+  /** Failure Reason String> */
+  reason: string;
+  route: {
+    /** Total Route Fee Tokens To Pay Number> */
+    fee: number;
+    /** Total Route Fee Millitokens To Pay String> */
+    fee_mtokens: string;
+    hops: {
+      /** Standard Format Channel Id String> */
+      channel: string;
+      /** Channel Capacity Tokens Number> */
+      channel_capacity: number;
+      /** Fee 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 Route Millitokens String> */
+    mtokens: string;
+    /** Payment Identifier Hex String> */
+    payment?: string;
+    /** Expiration Block Height Number> */
+    timeout: number;
+    /** Total Route Tokens Number> */
+    tokens: number;
+    /** Total Millitokens String> */
+    total_mtokens?: string;
+  };
+};
 
 /**
  * Initiate and subscribe to the outcome of a payment

package/lnd_methods/offchain/subscribe_to_pay_via_details.d.ts

@@ -1,146 +1,34 @@
+import {SetOptional} from 'type-fest';
 import {
   AuthenticatedLightningArgs,
   AuthenticatedLightningSubscription,
 } from '../../typescript';
+import {
+  SubscribeToPayConfirmedEvent,
+  SubscribeToPayFailedEvent,
+  SubscribeToPayOptionsArgs,
+  SubscribeToPayPayingEvent,
+  SubscribeToPayWithDestinationArgs,
+  SubscribeToRoutingFailureEvent,
+} from './subscribe_to_pay';
+
+export type SubscribeToPayViaDetailsArgs = AuthenticatedLightningArgs<
+  SetOptional<SubscribeToPayWithDestinationArgs, 'id'> &
+    SubscribeToPayOptionsArgs
+>;
 
-export type SubscribeToPayViaDetailsArgs = AuthenticatedLightningArgs<{
-  /** Final CLTV Delta */
-  cltv_delta?: number;
-  /** Destination Public Key */
-  destination: string;
-  features?: {
-    /** Feature Bit */
-    bit: number;
-  }[];
-  /** Payment Request Hash Hex */
-  id?: string;
-  /** Pay Through Specific Final Hop Public Key Hex */
-  incoming_peer?: string;
-  /** Maximum Fee Tokens To Pay */
-  max_fee?: number;
-  /** Maximum Fee Millitokens to Pay */
-  max_fee_mtokens?: string;
-  /** Maximum Millitokens For A Multi-Path Path */
-  max_path_mtokens?: string;
-  /** Maximum Simultaneous Paths */
-  max_paths?: number;
-  /** Maximum Height of Payment Timeout */
-  max_timeout_height?: number;
-  messages?: {
-    /** Message Type number */
-    type: string;
-    /** Message Raw Value Hex Encoded */
-    value: string;
-  }[];
-  /** Millitokens to Pay */
-  mtokens?: string;
-  /** Pay Out of Outgoing Channel Id */
-  outgoing_channel?: string;
-  /** Pay Out of Outgoing Channel Ids */
-  outgoing_channels?: string[];
-  /** Time to Spend Finding a Route Milliseconds */
-  pathfinding_timeout?: number;
-  /** Payment Identifier Hex String */
-  payment?: string;
-  routes?: [
-    {
-      /** Base Routing Fee In Millitokens */
-      base_fee_mtokens?: string;
-      /** Standard Format Channel Id */
-      channel?: string;
-      /** CLTV Blocks Delta */
-      cltv_delta?: number;
-      /** Fee Rate In Millitokens Per Million */
-      fee_rate?: number;
-      /** Forward Edge Public Key Hex */
-      public_key: string;
-    }[]
-  ];
-  /** Tokens to Pay */
-  tokens?: number;
-}>;
+export type SubscribeToPayViaDetailsConfirmedEvent =
+  SubscribeToPayConfirmedEvent;
 
-export type SubscribeToPayViaDetailsConfirmedEvent = {
-  /** Confirmed at ISO-8601 Date */
-  confirmed_at: string;
-  /** Fee Tokens Paid */
-  fee: number;
-  /** Total Fee Millitokens Paid */
-  fee_mtokens: string;
-  hops: {
-    /** Standard Format Channel Id */
-    channel: string;
-    /** Channel Capacity Tokens */
-    channel_capacity: number;
-    /** Fee Millitokens */
-    fee_mtokens: string;
-    /** Forward Millitokens */
-    forward_mtokens: string;
-    /** Public Key Hex */
-    public_key: string;
-    /** Timeout Block Height */
-    timeout: number;
-  }[];
-  /** Payment Hash Hex */
-  id?: string;
-  /** Total Millitokens To Pay */
-  mtokens: string;
-  /** Payment Forwarding Fee Rounded Up Tokens */
-  safe_fee: number;
-  /** Payment Tokens Rounded Up */
-  safe_tokens: number;
-  /** Payment Preimage Hex */
-  secret: string;
-  /** Total Tokens Paid Rounded Down */
-  tokens: number;
-};
+export type SubscribeToPayViaDetailsFailedEvent = SubscribeToPayFailedEvent;
 
-export type SubscribeToPayViaDetailsFailedEvent = {
-  /** Failed Due To Lack of Balance */
-  is_insufficient_balance: boolean;
-  /** Failed Due to Invalid Payment */
-  is_invalid_payment: boolean;
-  /** Failed Due to Pathfinding Timeout */
-  is_pathfinding_timeout: boolean;
-  /** Failed Due to Route Not Found */
-  is_route_not_found: boolean;
-  route?: {
-    /** Route Total Fee Tokens Rounded Down */
-    fee: number;
-    /** Route Total Fee Millitokens */
-    fee_mtokens: string;
-    hops: {
-      /** Standard Format Channel Id */
-      channel: string;
-      /** Channel Capacity Tokens */
-      channel_capacity: number;
-      /** Hop Forwarding Fee Rounded Down Tokens */
-      fee: number;
-      /** Hop Forwarding Fee Millitokens */
-      fee_mtokens: string;
-      /** Hop Forwarding Tokens Rounded Down */
-      forward: number;
-      /** Hop Forwarding Millitokens */
-      forward_mtokens: string;
-      /** Hop Sending To Public Key Hex */
-      public_key: string;
-      /** Hop CTLV Expiration Height */
-      timeout: number;
-    }[];
-    /** Payment Sending Millitokens */
-    mtokens: string;
-    /** Payment Forwarding Fee Rounded Up Tokens */
-    safe_fee: number;
-    /** Payment Sending Tokens Rounded Up */
-    safe_tokens: number;
-    /** Payment CLTV Expiration Height */
-    timeout: number;
-    /** Payment Sending Tokens Rounded Down */
-    tokens: number;
-  };
-};
+export type SubscribeToPayViaDetailsPayingEvent = Omit<
+  SubscribeToPayPayingEvent,
+  'request'
+>;
 
-export type SubscribeToPayViaDetailsPayingEvent = {[key: string]: never};
+export type SubscribeToPayViaDetailsRoutingFailure =
+  SubscribeToRoutingFailureEvent;
 
 /**
  * Subscribe to the flight of a payment