lightning 5.0.0 → 5.2.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Versions
 
+## 5.2.0
+
+- `getPendingChannels`: Add support for channel `capacity`
+
+## 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.

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

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",

package/lnd_methods/offchain/get_pending_channels.js

@@ -25,6 +25,7 @@ const type = 'default';
   @returns via cbk or Promise
   {
     pending_channels: [{
+      capacity: <Channel Capacity Tokens Number>
       [close_transaction_id]: <Channel Closing Transaction Id String>
       is_active: <Channel Is Active Bool>
       is_closing: <Channel Is Closing Bool>
@@ -68,6 +69,7 @@ module.exports = ({lnd}, cbk) => {
         return cbk();
       },
 
+      // Get pending channels
       getPending: ['validate', ({}, cbk) => {
         return lnd[type][method]({}, (err, res) => {
           if (!!err) {

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/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

package/lnd_methods/offchain/subscribe_to_pay_via_request.d.ts

@@ -2,123 +2,31 @@ import {
   AuthenticatedLightningArgs,
   AuthenticatedLightningSubscription,
 } from '../../typescript';
+import {
+  SubscribeToPayConfirmedEvent,
+  SubscribeToPayFailedEvent,
+  SubscribeToPayOptionsArgs,
+  SubscribeToPayPayingEvent,
+  SubscribeToPayWithRequestArgs,
+  SubscribeToRoutingFailureEvent,
+} from './subscribe_to_pay';
+
+export type SubscribeToPayViaRequestArgs = AuthenticatedLightningArgs<
+  SubscribeToPayWithRequestArgs &
+    Omit<SubscribeToPayOptionsArgs, 'omit' | 'routes'>
+>;
 
-export type SubscribeToPayViaRequestArgs = AuthenticatedLightningArgs<{
-  /** 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;
-  /** BOLT 11 Payment Request */
-  request: string;
-  /** Tokens To Pay */
-  tokens?: number;
-}>;
+export type SubscribeToPayViaRequestConfirmedEvent = Omit<
+  SubscribeToPayConfirmedEvent,
+  'paths'
+>;
 
-export type SubscribeToPayViaRequestConfirmedEvent = {
-  /** Confirmed at ISO-8601 Date */
-  confirmed_at: string;
-  /** Fee Tokens */
-  fee: number;
-  /** Total Fee Millitokens To Pay */
-  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 Paid */
-  mtokens: string;
-  /** Payment Forwarding Fee Rounded Up Tokens */
-  safe_fee: number;
-  /** Payment Tokens Rounded Up */
-  safe_tokens: number;
-  /** Payment Preimage Hex */
-  secret: string;
-  /** Expiration Block Height */
-  timeout: number;
-  /** Total Tokens Paid */
-  tokens: number;
-};
+export type SubscribeToPayViaRequestFailedEvent = SubscribeToPayFailedEvent;
 
-export type SubscribeToPayViaRequestFailedEvent = {
-  /** 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 SubscribeToPayViaRequestPayingEvent = SubscribeToPayPayingEvent;
 
-export type SubscribeToPayViaRequestPayingEvent = {[key: string]: never};
+export type SubscribeToPayViaRequestRoutingFailureEvent =
+  SubscribeToRoutingFailureEvent;
 
 /**
  * Initiate and subscribe to the outcome of a payment request

package/lnd_methods/offchain/subscribe_to_pay_via_routes.d.ts

@@ -172,15 +172,15 @@ export type SubscribeToPayViaRoutesRoutingFailureEvent = {
     }[];
     /** Total Millitokens To Pay */
     mtokens: string;
+    /** Payment Forwarding Fee Rounded Up Tokens Number */
+    safe_fee: number;
+    /** Payment Tokens Rounded Up Number */
+    safe_tokens: number;
     /** Expiration Block Height */
     timeout: number;
     /** Total Tokens To Pay */
     tokens: number;
   };
-  /** Payment Forwarding Fee Rounded Up Tokens */
-  safe_fee: number;
-  /** Payment Tokens Rounded Up */
-  safe_tokens: number;
   /** Failure Related CLTV Timeout Height */
   timeout_height?: number;
   update?: {
@@ -198,8 +198,6 @@ export type SubscribeToPayViaRoutesRoutingFailureEvent = {
 };
 
 export type SubscribeToPayViaRoutesSuccessEvent = {
-  /** Payment Sent At ISO 8601 Date */
-  confirmed_at: string;
   /** Fee Paid Tokens */
   fee: number;
   /** Fee Paid Millitokens */
@@ -249,6 +247,10 @@ export type SubscribeToPayViaRoutesSuccessEvent = {
     }[];
     /** Total Millitokens To Pay */
     mtokens: string;
+    /** Payment Forwarding Fee Rounded Up Tokens Number */
+    safe_fee: number;
+    /** Payment Tokens Rounded Up Number */
+    safe_tokens: number;
     /** Expiration Block Height */
     timeout: number;
     /** Total Tokens To Pay */

package/lnd_methods/offchain/update_connected_watchtower.d.ts

@@ -2,13 +2,13 @@ import {
   AuthenticatedLightningArgs,
   AuthenticatedLightningMethod,
 } from '../../typescript';
-import {Xor} from '../../typescript/util';
+import {MergeExclusive} from 'type-fest';
 
 export type UpdateConnectedWatchtowerArgs = AuthenticatedLightningArgs<
   {
     /** Watchtower Public Key Hex String */
     public_key: string;
-  } & Xor<
+  } & MergeExclusive<
     {
       /** Add Socket String */
       add_socket: string;

package/lnd_methods/offchain/update_routing_fees.d.ts

@@ -2,9 +2,9 @@ import {
   AuthenticatedLightningArgs,
   AuthenticatedLightningMethod,
 } from '../../typescript';
-import {Xor} from '../../typescript/util';
+import {MergeExclusive} from 'type-fest';
 
-type BaseFeeTokens = Xor<
+type BaseFeeTokens = MergeExclusive<
   {
     /** Base Fee Millitokens Charged */
     base_fee_mtokens?: string;

package/lnd_methods/onchain/close_channel.d.ts

@@ -2,9 +2,9 @@ import {
   AuthenticatedLightningArgs,
   AuthenticatedLightningMethod,
 } from '../../typescript';
-import {Xor} from '../../typescript/util';
+import {MergeExclusive} from 'type-fest';
 
-type ExpectedIdOfChannelToClose = Xor<
+type ExpectedIdOfChannelToClose = MergeExclusive<
   {
     /** Standard Format Channel Id String */
     id: string;
@@ -17,7 +17,7 @@ type ExpectedIdOfChannelToClose = Xor<
   }
 >;
 
-type UnexpectedTokensPerVbyteForChannelClose = Xor<
+type UnexpectedTokensPerVbyteForChannelClose = MergeExclusive<
   {
     /** Confirmation Target Number */
     target_confirmations?: number;
@@ -28,7 +28,7 @@ type UnexpectedTokensPerVbyteForChannelClose = Xor<
   }
 >;
 
-type ExpectedBothPublicKeyAndSocketForChannelClose = Xor<
+type ExpectedBothPublicKeyAndSocketForChannelClose = MergeExclusive<
   {
     /** Peer Public Key String */
     public_key: string;
@@ -53,7 +53,10 @@ export type CoopCloseChannelArgs = AuthenticatedLightningArgs<
     UnexpectedTokensPerVbyteForChannelClose
 >;
 
-export type CloseChannelArgs = Xor<ForceCloseChannelArgs, CoopCloseChannelArgs>;
+export type CloseChannelArgs = MergeExclusive<
+  ForceCloseChannelArgs,
+  CoopCloseChannelArgs
+>;
 
 export type CloseChannelResult = {
   /** Closing Transaction Id Hex */

package/lnd_methods/onchain/fund_pending_channels.js

@@ -24,32 +24,32 @@ const type = 'default';
 
   @returns via cbk or Promise
 */
-module.exports = ({channels, funding, lnd}, cbk) => {
+module.exports = (args, cbk) => {
   return new Promise((resolve, reject) => {
     return asyncAuto({
       // Check arguments
       validate: cbk => {
-        if (!isArray(channels)) {
+        if (!isArray(args.channels)) {
           return cbk([400, 'ExpectedPendingChannelIdsToFundChannels']);
         }
 
-        if (!channels.length) {
+        if (!args.channels.length) {
           return cbk([400, 'ExpectedPendingChannelIdsToFund']);
         }
 
-        if (channels.filter(n => !n).length) {
+        if (args.channels.filter(n => !n).length) {
           return cbk([400, 'ExpectedNonEmptyPendingChannelIdsToFund']);
         }
 
-        if (!!channels.find(n => !isHash(n))) {
+        if (!!args.channels.find(n => !isHash(n))) {
           return cbk([400, 'ExpectedPendingChannelIdOfChannelToFund']);
         }
 
-        if (!isHex(funding)) {
+        if (!isHex(args.funding)) {
           return cbk([400, 'ExpectedFundingPsbtToFundChannel']);
         }
 
-        if (!isLnd({lnd, method, type})) {
+        if (!isLnd({method, type, lnd: args.lnd})) {
           return cbk([400, 'ExpectedAuthenticatedLndToFundChannels']);
         }
 
@@ -57,12 +57,12 @@ module.exports = ({channels, funding, lnd}, cbk) => {
       },
 
       // Funded and signed PSBT
-      psbt: ['validate', ({}, cbk) => cbk(null, bufferFromHex(funding))],
+      psbt: ['validate', ({}, cbk) => cbk(null, bufferFromHex(args.funding))],
 
       // Verify the funding for each pending channel
       verify: ['psbt', 'validate', ({psbt}, cbk) => {
-        return asyncEach(channels, (id, cbk) => {
-          return lnd[type][method]({
+        return asyncEach(args.channels, (id, cbk) => {
+          return args.lnd[type][method]({
             psbt_verify: {
               funded_psbt: psbt,
               pending_chan_id: bufferFromHex(id),
@@ -81,10 +81,10 @@ module.exports = ({channels, funding, lnd}, cbk) => {
 
       // Finalize the psbts
       finalize: ['psbt', 'verify', ({psbt}, cbk) => {
-        const [lastChannel] = channels.slice().reverse();
+        const [lastChannel] = args.channels.slice().reverse();
 
-        return asyncEachSeries(channels, (id, cbk) => {
-          return lnd[type][method]({
+        return asyncEachSeries(args.channels, (id, cbk) => {
+          return args.lnd[type][method]({
             psbt_finalize: {
               no_publish: id !== lastChannel,
               pending_chan_id: bufferFromHex(id),

package/lnd_methods/onchain/fund_psbt.d.ts

@@ -2,7 +2,7 @@ import {
   AuthenticatedLightningArgs,
   AuthenticatedLightningMethod,
 } from '../../typescript';
-import {Xor} from '../../typescript/util';
+import {MergeExclusive} from 'type-fest';
 
 export type FundPsbtArgs = AuthenticatedLightningArgs<
   {
@@ -20,7 +20,7 @@ export type FundPsbtArgs = AuthenticatedLightningArgs<
 
     /** Confirmations To Wait */
     target_confirmations?: number;
-  } & Xor<
+  } & MergeExclusive<
     {
       /** Existing PSBT Hex */
       psbt: string;

package/lnd_methods/onchain/open_channel.js

@@ -26,11 +26,11 @@ const type = 'default';
     [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>
-    local_tokens: <Local Tokens Number>
+    local_tokens: <Total Channel Capacity Tokens Number>
     [min_confirmations]: <Spend UTXOs With Minimum Confirmations Number>
     [min_htlc_mtokens]: <Minimum HTLC Millitokens String>
-    partner_public_key: <Public Key Hex String>
     [partner_csv_delay]: <Peer Output CSV Delay Number>
+    partner_public_key: <Public Key Hex String>
     [partner_socket]: <Peer Connection Host:Port String>
   }
 

package/lnd_methods/onchain/open_channels.d.ts

@@ -22,6 +22,8 @@ export type OpenChannelsArgs = AuthenticatedLightningArgs<{
     /** Peer Connection Host:Port */
     partner_socket?: string;
   }[];
+  /** Do not broadcast any channel funding transactions */
+  is_avoiding_broadcast?: boolean;
 }>;
 
 export type OpenChannelsResult = {

package/lnd_methods/onchain/open_channels.js

@@ -29,6 +29,9 @@ const type = 'default';
   If you do not fund the channels, be sure to `cancelPendingChannel` on each
   channel that was not funded.
 
+  Use `is_avoiding_broadcast` only when self-publishing the raw transaction
+  after the funding step.
+
   {
     channels: [{
       capacity: <Channel Capacity Tokens Number>
@@ -36,10 +39,11 @@ const type = 'default';
       [give_tokens]: <Tokens to Gift To Partner Number> // Defaults to zero
       [is_private]: <Channel is Private Bool> // Defaults to false
       [min_htlc_mtokens]: <Minimum HTLC Millitokens String>
-      partner_public_key: <Public Key Hex String>
       [partner_csv_delay]: <Peer Output CSV Delay Number>
+      partner_public_key: <Public Key Hex String>
       [partner_socket]: <Peer Connection Host:Port String>
     }]
+    [is_avoiding_broadcast]: <Avoid Broadcast of All Channels Bool>
     lnd: <Authenticated LND API Object>
   }
 
@@ -52,28 +56,28 @@ const type = 'default';
     }]
   }
 */
-module.exports = ({channels, lnd}, cbk) => {
+module.exports = (args, cbk) => {
   return new Promise((resolve, reject) => {
     return asyncAuto({
       // Check arguments
       validate: cbk => {
-        if (!isArray(channels)) {
+        if (!isArray(args.channels)) {
           return cbk([400, 'ExpectedChannelsToOpenChannels']);
         }
 
-        if (channels.filter(n => !!n).length !== channels.length) {
+        if (args.channels.filter(n => !!n).length !== args.channels.length) {
           return cbk([400, 'ExpectedChannelDetailsToOpenChannels']);
         }
 
-        if (!!channels.find(n => !n.capacity)) {
+        if (!!args.channels.find(n => !n.capacity)) {
           return cbk([400, 'ExpectedCapacityOfChannelsToOpenChannels']);
         }
 
-        if (!!channels.find(n => !isPublicKey(n.partner_public_key))) {
+        if (!!args.channels.find(n => !isPublicKey(n.partner_public_key))) {
           return cbk([400, 'ExpectedPeerPublicKeyToOpenChannels']);
         }
 
-        if (!isLnd({lnd, method, type})) {
+        if (!isLnd({method, type, lnd: args.lnd})) {
           return cbk([400, 'ExpectedAuthenticatedLndToOpenChannels']);
         }
 
@@ -82,7 +86,7 @@ module.exports = ({channels, lnd}, cbk) => {
 
       // Channels to open
       toOpen: ['validate', ({}, cbk) => {
-        return cbk(null, channels.map(channel => ({
+        return cbk(null, args.channels.map(channel => ({
           capacity: channel.capacity,
           id: makeId(),
           cooperative_close_address: channel.cooperative_close_address,
@@ -101,11 +105,13 @@ module.exports = ({channels, lnd}, cbk) => {
 
         return asyncMap(toOpen, (channel, cbk) => {
           let isDone = false;
+          const isSelfPublish = !!args.is_avoiding_broadcast;
 
-          const channelOpen = lnd[type][method]({
+          const channelOpen = args.lnd[type][method]({
+            close_address: channel.cooperative_close_address || undefined,
             funding_shim: {
               psbt_shim: {
-                no_publish: !channel.id.equals(lastChannel),
+                no_publish: !!isSelfPublish || !channel.id.equals(lastChannel),
                 pending_chan_id: channel.id,
               },
             },
@@ -183,7 +189,7 @@ module.exports = ({channels, lnd}, cbk) => {
         return asyncEach(toOpen, (channel, cbk) => {
           const id = hexFromBuffer(channel.id);
 
-          return cancelPendingChannel({id, lnd}, () => cbk());
+          return cancelPendingChannel({id, lnd: args.lnd}, () => cbk());
         },
         () => {
           return cbk([503, 'UnexpectedErrorOpeningChannels', {err}]);

package/lnd_methods/onchain/request_chain_fee_increase.d.ts

@@ -2,7 +2,7 @@ import {
   AuthenticatedLightningArgs,
   AuthenticatedLightningMethod,
 } from '../../typescript';
-import {Xor} from '../../typescript/util';
+import {MergeExclusive} from 'type-fest';
 
 export type RequestChainFeeIncreaseArgs = AuthenticatedLightningArgs<
   {
@@ -10,7 +10,7 @@ export type RequestChainFeeIncreaseArgs = AuthenticatedLightningArgs<
     transaction_id: string;
     /** Unconfirmed UTXO Transaction Index Number */
     transaction_vout: number;
-  } & Xor<
+  } & MergeExclusive<
     {
       /** Chain Fee Tokens Per Virtual Byte Number */
       fee_tokens_per_vbyte: number;

package/lnd_methods/onchain/script_from_chain_address.d.ts

@@ -1,11 +1,11 @@
-import {Xor} from '../../typescript/util';
+import {MergeExclusive} from 'type-fest';
 
-export type ScriptFromChainAddressArgs = Xor<
+export type ScriptFromChainAddressArgs = MergeExclusive<
   {
     /** Address String */
     bech32_address: string;
   },
-  Xor<
+  MergeExclusive<
     {
       /** Address String */
       p2pkh_address: string;

package/lnd_methods/onchain/send_to_chain_address.d.ts

@@ -4,9 +4,9 @@ import {
   AuthenticatedLightningMethod,
   LightningError,
 } from '../../typescript';
-import {Xor} from '../../typescript/util';
+import {MergeExclusive} from 'type-fest';
 
-type ExpectedNoTokensSpecifiedWhenSendingAllFunds = Xor<
+type ExpectedNoTokensSpecifiedWhenSendingAllFunds = MergeExclusive<
   {
     /** Tokens To Send */
     tokens: number;
@@ -16,7 +16,7 @@ type ExpectedNoTokensSpecifiedWhenSendingAllFunds = Xor<
     is_send_all: true;
   }
 >;
-type ExpectedLogFunctionForChainSendSocketAnnounce = Xor<
+type ExpectedLogFunctionForChainSendSocketAnnounce = MergeExclusive<
   {
     /** Web Socket Servers */
     wss: ws.Server[];

package/lnd_methods/onchain/send_to_chain_addresses.d.ts

@@ -4,9 +4,9 @@ import {
   AuthenticatedLightningMethod,
   LightningError,
 } from '../../typescript';
-import {Xor} from '../../typescript/util';
+import {MergeExclusive} from 'type-fest';
 
-type ExpectedLogForChainSendWebSocketAnnouncement = Xor<
+type ExpectedLogForChainSendWebSocketAnnouncement = MergeExclusive<
   {
     /** Web Socket Servers */
     wss: ws.Server[];

package/lnd_methods/onchain/send_to_chain_output_scripts.d.ts

@@ -2,7 +2,7 @@ import {
   AuthenticatedLightningArgs,
   AuthenticatedLightningMethod,
 } from '../../typescript';
-import {Xor} from '../../typescript/util';
+import {MergeExclusive} from 'type-fest';
 
 export type SendToChainOutputScriptsArgs = AuthenticatedLightningArgs<{
   /** Transaction Label String */

package/lnd_methods/onchain/set_autopilot.d.ts

@@ -2,7 +2,7 @@ import {
   AuthenticatedLightningArgs,
   AuthenticatedLightningMethod,
 } from '../../typescript';
-import {Xor} from '../../typescript/util';
+import {MergeExclusive} from 'type-fest';
 
 export type CandidateNode = {
   /** Node Public Key Hex */
@@ -22,7 +22,10 @@ type ExpectedNodesOrEnabledSettingToAdjustAutopilot =
     };
 
 export type SetAutopilotArgs = AuthenticatedLightningArgs<
-  Xor<ExpectedNodesOrEnabledSettingToAdjustAutopilot, {is_enabled: false}>
+  MergeExclusive<
+    ExpectedNodesOrEnabledSettingToAdjustAutopilot,
+    {is_enabled: false}
+  >
 >;
 
 /**

package/lnd_methods/onchain/subscribe_to_chain_address.d.ts

@@ -2,10 +2,10 @@ import {
   AuthenticatedLightningArgs,
   AuthenticatedLightningSubscription,
 } from '../../typescript';
-import {Xor} from '../../typescript/util';
+import {MergeExclusive} from 'type-fest';
 import {ScriptFromChainAddressArgs} from './script_from_chain_address';
 
-type ExpectedChainAddressToSubscribeForConfirmationEvents = Xor<
+type ExpectedChainAddressToSubscribeForConfirmationEvents = MergeExclusive<
   {
     /** Output Script Hex */
     output_script: string;

package/lnd_methods/onchain/subscribe_to_chain_spend.d.ts

@@ -2,10 +2,10 @@ import {
   AuthenticatedLightningArgs,
   AuthenticatedLightningSubscription,
 } from '../../typescript';
-import {Xor} from '../../typescript/util';
+import {MergeExclusive} from 'type-fest';
 import {ScriptFromChainAddressArgs} from './script_from_chain_address';
 
-type ExpectOutputScriptOrAddress = Xor<
+type ExpectOutputScriptOrAddress = MergeExclusive<
   {
     /** Output Script AKA ScriptPub Hex */
     output_script: string;

package/lnd_responses/pending_as_pending_channels.js

@@ -80,6 +80,7 @@ const outpointSeparator = ':';
   @returns
   {
     pending_channels: [{
+      capacity: <Channel Capacity Tokens Number>
       [close_transaction_id]: <Channel Closing Transaction Id String>
       is_active: <Channel Is Active Bool>
       is_closing: <Channel Is Closing Bool>
@@ -285,6 +286,7 @@ module.exports = args => {
     const pendingTokens = wait.pending_balance || forced.pending_balance;
 
     return {
+      capacity: Number(channel.capacity),
       close_transaction_id: endTx || undefined,
       is_active: false,
       is_closing: !chanOpen,

package/package.json

@@ -10,12 +10,12 @@
     "@grpc/grpc-js": "1.4.4",
     "@grpc/proto-loader": "0.6.7",
     "@types/express": "4.17.13",
-    "@types/node": "16.11.9",
+    "@types/node": "16.11.12",
     "@types/request": "2.48.7",
-    "@types/ws": "8.2.0",
+    "@types/ws": "8.2.2",
     "async": "3.2.2",
     "asyncjs-util": "1.2.7",
-    "bitcoinjs-lib": "6.0.0",
+    "bitcoinjs-lib": "6.0.1",
     "bn.js": "5.2.0",
     "body-parser": "1.19.0",
     "bolt07": "1.7.4",
@@ -23,7 +23,8 @@
     "cbor": "8.1.0",
     "express": "4.17.1",
     "invoices": "2.0.2",
-    "psbt": "1.1.10"
+    "psbt": "1.1.10",
+    "type-fest": "2.8.0"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
@@ -31,10 +32,10 @@
     "@alexbosworth/tap": "15.0.10",
     "tsd": "0.19.0",
     "typescript": "4.5.2",
-    "ws": "8.2.3"
+    "ws": "8.3.0"
   },
   "engines": {
-    "node": ">=12"
+    "node": ">=12.20"
   },
   "keywords": [
     "grpc",
@@ -56,5 +57,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.0.0"
+  "version": "5.2.0"
 }

package/test/lnd_responses/test_pending_as_pending_channels.js

@@ -99,6 +99,7 @@ const makeArgs = overrides => {
 
 const makeExpectedPending = overrides => {
   const res = {
+    capacity: 1,
     close_transaction_id: Buffer.alloc(32).toString('hex'),
     is_active: false,
     is_closing: true,

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

@@ -8,9 +8,9 @@ const p2wpkh = 'p2wpkh';
 
 expectError(createChainAddress());
 expectError(createChainAddress({}));
-expectError(createChainAddress({}));
 expectError(createChainAddress({lnd, format: 'invalidFormat'}));
 
+expectType<CreateChainAddressResult>(await createChainAddress({lnd}));
 expectType<CreateChainAddressResult>(
   await createChainAddress({lnd, format: np2wpkh})
 );
@@ -18,6 +18,11 @@ expectType<CreateChainAddressResult>(
   await createChainAddress({lnd, format: p2wpkh})
 );
 
+expectType<void>(
+  createChainAddress({lnd}, (error, result) => {
+    expectType<CreateChainAddressResult>(result);
+  })
+);
 expectType<void>(
   createChainAddress({lnd, format: np2wpkh}, (error, result) => {
     expectType<CreateChainAddressResult>(result);

package/typescript/shared.d.ts

@@ -1,6 +1,6 @@
 import * as events from 'events';
+import {MergeExclusive} from 'type-fest';
 import {AuthenticatedLnd, UnauthenticatedLnd} from '../lnd_grpc';
-import {Xor} from './util';
 
 export type EmptyObject = {[key: string]: never};
 
@@ -84,7 +84,7 @@ export type PaymentState =
   | 'FAILED_TIMEOUT';
 export type PaymentStatus = CommonStatus | 'UNKNOWN';
 
-export type PaginationArgs = Xor<
+export type PaginationArgs = MergeExclusive<
   {
     /** Page Result Limit */
     limit?: number;

package/typescript/util.d.ts

@@ -1,7 +0,0 @@
-type Without<T, U> = {
-  [KeyType in Exclude<keyof T, keyof U>]?: never;
-};
-
-export type Xor<T, U> = T | U extends object
-  ? (Without<T, U> & U) | (Without<U, T> & T)
-  : T | U;