lightning 5.13.1 → 5.15.1

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Versions
 
+## 5.15.1
+
+- `getFailedPayments`, `getPayments`, `getPendingPayments`: Remove
+    `confirmed_at` date when a payment is not confirmed, add `created_at` and
+    `failed_at` dates for attempt start and attempt failed dates.
+
+## 5.15.0
+
+- `beginGroupSigningSession`: Add method to start a MuSig2 signing session
+- `endGroupSigningSession`: Add method to complete a MuSig2 signing session
+- `updateGroupSigningSession`: Add method to add nonces to a MuSig2 session
+
+## 5.14.0
+
+- `getRouteToDestination`, `isDestinationPayable`, `pay`,
+    `payViaPaymentDetails`, `payViaPaymentRequest`, `probeForRoute`,
+    `subscribeToPayViaDetails`, `subscribeToPayViaRequest`,
+    `subscribeToProbeForRoute` - add support for pathfinding `confidence`
+
 ## 5.13.1
 
 - `signTransaction`: Fix multi-input signing for upcoming Taproot API changes

package/README.md

@@ -24,8 +24,8 @@ Methods for working with the Lightning Network
     https://github.com/stackernews/stacker.news
 - [Suredbits API](https://suredbits.com/) -
     https://github.com/Suredbits/sb-api-lnd
-- [Synonym demo server](https://synonym.to) -
-    https://github.com/synonymdev/slash-pay-demo-server
+- [Synonym Blocktank server](https://synonym.to) -
+    https://github.com/synonymdev/blocktank-server/
 - [Tarnhelm](https://www.tarnhelm.app/) - https://github.com/bkiac/tarnhelm
 - [tbtcswaps](https://tbtcswaps.com/) -
     https://github.com/keep-community/tbtcswaps

package/grpc/protos/chainnotifier.proto

@@ -12,9 +12,11 @@ service ChainNotifier {
     registers an intent for a client to be notified once a confirmation request
     has reached its required number of confirmations on-chain.
 
-    A client can specify whether the confirmation request should be for a
-    particular transaction by its hash or for an output script by specifying a
-    zero hash.
+    A confirmation request must have a valid output script. It is also possible
+    to give a transaction ID. If the transaction ID is not set, a notification
+    is sent once the output script confirms. If the transaction ID is also set,
+    a notification is sent once the output script confirms in the given
+    transaction.
     */
     rpc RegisterConfirmationsNtfn (ConfRequest) returns (stream ConfEvent);
 

package/grpc/protos/lightning.proto

@@ -1809,6 +1809,11 @@ message GetInfoResponse {
     announcements and invoices.
     */
     map<uint32, Feature> features = 19;
+
+    /*
+    Indicates whether the HTLC interceptor API is in always-on mode.
+    */
+    bool require_htlc_interceptor = 21;
 }
 
 message GetRecoveryInfoRequest {
@@ -2692,6 +2697,12 @@ message QueryRoutesRequest {
     fallback.
     */
     repeated lnrpc.FeatureBit dest_features = 17;
+
+    /*
+    The time preference for this payment. Set to -1 to optimize for fees
+    only, to 1 to optimize for reliability only or a value inbetween for a mix.
+    */
+    double time_pref = 18;
 }
 
 message NodePair {
@@ -2760,7 +2771,7 @@ message Hop {
     TLV format. Note that if any custom tlv_records below are specified, then
     this field MUST be set to true for them to be encoded properly.
     */
-    bool tlv_payload = 9;
+    bool tlv_payload = 9 [deprecated = true];
 
     /*
     An optional TLV record that signals the use of an MPP payment. If present,
@@ -2786,6 +2797,9 @@ message Hop {
     to drop off at each hop within the onion.
     */
     map<uint64, bytes> custom_records = 11;
+
+    // The payment metadata to send along with the payment to the payee.
+    bytes metadata = 13;
 }
 
 message MPPRecord {

package/grpc/protos/router.proto

@@ -284,6 +284,12 @@ message SendPaymentRequest {
     If set, an AMP-payment will be attempted.
     */
     bool amp = 22;
+
+    /*
+    The time preference for this payment. Set to -1 to optimize for fees
+    only, to 1 to optimize for reliability only or a value inbetween for a mix.
+    */
+    double time_pref = 23;
 }
 
 message TrackPaymentRequest {

package/grpc/protos/signer.proto

@@ -62,6 +62,86 @@ service Signer {
     hashed with sha256, resulting in the final key length of 256bit.
     */
     rpc DeriveSharedKey (SharedKeyRequest) returns (SharedKeyResponse);
+
+    /*
+    MuSig2CombineKeys (experimental!) is a stateless helper RPC that can be used
+    to calculate the combined MuSig2 public key from a list of all participating
+    signers' public keys. This RPC is completely stateless and deterministic and
+    does not create any signing session. It can be used to determine the Taproot
+    public key that should be put in an on-chain output once all public keys are
+    known. A signing session is only needed later when that output should be
+    _spent_ again.
+
+    NOTE: The MuSig2 BIP is not final yet and therefore this API must be
+    considered to be HIGHLY EXPERIMENTAL and subject to change in upcoming
+    releases. Backward compatibility is not guaranteed!
+    */
+    rpc MuSig2CombineKeys (MuSig2CombineKeysRequest)
+        returns (MuSig2CombineKeysResponse);
+
+    /*
+    MuSig2CreateSession (experimental!) creates a new MuSig2 signing session
+    using the local key identified by the key locator. The complete list of all
+    public keys of all signing parties must be provided, including the public
+    key of the local signing key. If nonces of other parties are already known,
+    they can be submitted as well to reduce the number of RPC calls necessary
+    later on.
+
+    NOTE: The MuSig2 BIP is not final yet and therefore this API must be
+    considered to be HIGHLY EXPERIMENTAL and subject to change in upcoming
+    releases. Backward compatibility is not guaranteed!
+    */
+    rpc MuSig2CreateSession (MuSig2SessionRequest)
+        returns (MuSig2SessionResponse);
+
+    /*
+    MuSig2RegisterNonces (experimental!) registers one or more public nonces of
+    other signing participants for a session identified by its ID. This RPC can
+    be called multiple times until all nonces are registered.
+
+    NOTE: The MuSig2 BIP is not final yet and therefore this API must be
+    considered to be HIGHLY EXPERIMENTAL and subject to change in upcoming
+    releases. Backward compatibility is not guaranteed!
+    */
+    rpc MuSig2RegisterNonces (MuSig2RegisterNoncesRequest)
+        returns (MuSig2RegisterNoncesResponse);
+
+    /*
+    MuSig2Sign (experimental!) creates a partial signature using the local
+    signing key that was specified when the session was created. This can only
+    be called when all public nonces of all participants are known and have been
+    registered with the session. If this node isn't responsible for combining
+    all the partial signatures, then the cleanup flag should be set, indicating
+    that the session can be removed from memory once the signature was produced.
+
+    NOTE: The MuSig2 BIP is not final yet and therefore this API must be
+    considered to be HIGHLY EXPERIMENTAL and subject to change in upcoming
+    releases. Backward compatibility is not guaranteed!
+    */
+    rpc MuSig2Sign (MuSig2SignRequest) returns (MuSig2SignResponse);
+
+    /*
+    MuSig2CombineSig (experimental!) combines the given partial signature(s)
+    with the local one, if it already exists. Once a partial signature of all
+    participants is registered, the final signature will be combined and
+    returned.
+
+    NOTE: The MuSig2 BIP is not final yet and therefore this API must be
+    considered to be HIGHLY EXPERIMENTAL and subject to change in upcoming
+    releases. Backward compatibility is not guaranteed!
+    */
+    rpc MuSig2CombineSig (MuSig2CombineSigRequest)
+        returns (MuSig2CombineSigResponse);
+
+    /*
+    MuSig2Cleanup (experimental!) allows a caller to clean up a session early in
+    cases where it's obvious that the signing session won't succeed and the
+    resources can be released.
+    NOTE: The MuSig2 BIP is not final yet and therefore this API must be
+    considered to be HIGHLY EXPERIMENTAL and subject to change in upcoming
+    releases. Backward compatibility is not guaranteed!
+    */
+    rpc MuSig2Cleanup (MuSig2CleanupRequest) returns (MuSig2CleanupResponse);
 }
 
 message KeyLocator {
@@ -264,4 +344,232 @@ message SharedKeyRequest {
 message SharedKeyResponse {
     // The shared public key, hashed with sha256.
     bytes shared_key = 1;
+}
+
+message TweakDesc {
+    /*
+    Tweak is the 32-byte value that will modify the public key.
+    */
+    bytes tweak = 1;
+
+    /*
+    Specifies if the target key should be converted to an x-only public key
+    before tweaking. If true, then the public key will be mapped to an x-only
+    key before the tweaking operation is applied.
+    */
+    bool is_x_only = 2;
+}
+
+message TaprootTweakDesc {
+    /*
+    The root hash of the tapscript tree if a script path is committed to. If
+    the MuSig2 key put on chain doesn't also commit to a script path (BIP-0086
+    key spend only), then this needs to be empty and the key_spend_only field
+    below must be set to true. This is required because gRPC cannot
+    differentiate between a zero-size byte slice and a nil byte slice (both
+    would be serialized the same way). So the extra boolean is required.
+    */
+    bytes script_root = 1;
+
+    /*
+    Indicates that the above script_root is expected to be empty because this
+    is a BIP-0086 key spend only commitment where only the internal key is
+    committed to instead of also including a script root hash.
+    */
+    bool key_spend_only = 2;
+}
+
+message MuSig2CombineKeysRequest {
+    /*
+    A list of all public keys (serialized in 32-byte x-only format!)
+    participating in the signing session. The list will always be sorted
+    lexicographically internally. This must include the local key which is
+    described by the above key_loc.
+    */
+    repeated bytes all_signer_pubkeys = 1;
+
+    /*
+    A series of optional generic tweaks to be applied to the the aggregated
+    public key.
+    */
+    repeated TweakDesc tweaks = 2;
+
+    /*
+    An optional taproot specific tweak that must be specified if the MuSig2
+    combined key will be used as the main taproot key of a taproot output
+    on-chain.
+    */
+    TaprootTweakDesc taproot_tweak = 3;
+}
+
+message MuSig2CombineKeysResponse {
+    /*
+    The combined public key (in the 32-byte x-only format) with all tweaks
+    applied to it. If a taproot tweak is specified, this corresponds to the
+    taproot key that can be put into the on-chain output.
+    */
+    bytes combined_key = 1;
+
+    /*
+    The raw combined public key (in the 32-byte x-only format) before any tweaks
+    are applied to it. If a taproot tweak is specified, this corresponds to the
+    internal key that needs to be put into the witness if the script spend path
+    is used.
+    */
+    bytes taproot_internal_key = 2;
+}
+
+message MuSig2SessionRequest {
+    /*
+    The key locator that identifies which key to use for signing.
+    */
+    KeyLocator key_loc = 1;
+
+    /*
+    A list of all public keys (serialized in 32-byte x-only format!)
+    participating in the signing session. The list will always be sorted
+    lexicographically internally. This must include the local key which is
+    described by the above key_loc.
+    */
+    repeated bytes all_signer_pubkeys = 2;
+
+    /*
+    An optional list of all public nonces of other signing participants that
+    might already be known.
+    */
+    repeated bytes other_signer_public_nonces = 3;
+
+    /*
+    A series of optional generic tweaks to be applied to the the aggregated
+    public key.
+    */
+    repeated TweakDesc tweaks = 4;
+
+    /*
+    An optional taproot specific tweak that must be specified if the MuSig2
+    combined key will be used as the main taproot key of a taproot output
+    on-chain.
+    */
+    TaprootTweakDesc taproot_tweak = 5;
+}
+
+message MuSig2SessionResponse {
+    /*
+    The unique ID that represents this signing session. A session can be used
+    for producing a signature a single time. If the signing fails for any
+    reason, a new session with the same participants needs to be created.
+    */
+    bytes session_id = 1;
+
+    /*
+    The combined public key (in the 32-byte x-only format) with all tweaks
+    applied to it. If a taproot tweak is specified, this corresponds to the
+    taproot key that can be put into the on-chain output.
+    */
+    bytes combined_key = 2;
+
+    /*
+    The raw combined public key (in the 32-byte x-only format) before any tweaks
+    are applied to it. If a taproot tweak is specified, this corresponds to the
+    internal key that needs to be put into the witness if the script spend path
+    is used.
+    */
+    bytes taproot_internal_key = 3;
+
+    /*
+    The two public nonces the local signer uses, combined into a single value
+    of 66 bytes. Can be split into the two 33-byte points to get the individual
+    nonces.
+    */
+    bytes local_public_nonces = 4;
+
+    /*
+    Indicates whether all nonces required to start the signing process are known
+    now.
+    */
+    bool have_all_nonces = 5;
+}
+
+message MuSig2RegisterNoncesRequest {
+    /*
+    The unique ID of the signing session those nonces should be registered with.
+    */
+    bytes session_id = 1;
+
+    /*
+    A list of all public nonces of other signing participants that should be
+    registered.
+    */
+    repeated bytes other_signer_public_nonces = 3;
+}
+
+message MuSig2RegisterNoncesResponse {
+    /*
+    Indicates whether all nonces required to start the signing process are known
+    now.
+    */
+    bool have_all_nonces = 1;
+}
+
+message MuSig2SignRequest {
+    /*
+    The unique ID of the signing session to use for signing.
+    */
+    bytes session_id = 1;
+
+    /*
+    The 32-byte SHA256 digest of the message to sign.
+    */
+    bytes message_digest = 2;
+
+    /*
+    Cleanup indicates that after signing, the session state can be cleaned up,
+    since another participant is going to be responsible for combining the
+    partial signatures.
+    */
+    bool cleanup = 3;
+}
+
+message MuSig2SignResponse {
+    /*
+    The partial signature created by the local signer.
+    */
+    bytes local_partial_signature = 1;
+}
+
+message MuSig2CombineSigRequest {
+    /*
+    The unique ID of the signing session to combine the signatures for.
+    */
+    bytes session_id = 1;
+
+    /*
+    The list of all other participants' partial signatures to add to the current
+    session.
+    */
+    repeated bytes other_partial_signatures = 2;
+}
+
+message MuSig2CombineSigResponse {
+    /*
+    Indicates whether all partial signatures required to create a final, full
+    signature are known yet. If this is true, then the final_signature field is
+    set, otherwise it is empty.
+    */
+    bool have_all_signatures = 1;
+
+    /*
+    The final, full signature that is valid for the combined public key.
+    */
+    bytes final_signature = 2;
+}
+
+message MuSig2CleanupRequest {
+    /*
+    The unique ID of the signing session that should be removed/cleaned up.
+    */
+    bytes session_id = 1;
+}
+
+message MuSig2CleanupResponse {
 }

package/index.js

@@ -1,6 +1,7 @@
 const {addExternalSocket} = require('./lnd_methods');
 const {addPeer} = require('./lnd_methods');
 const {authenticatedLndGrpc} = require('./lnd_grpc');
+const {beginGroupSigningSession} = require('./lnd_methods');
 const {broadcastChainTransaction} = require('./lnd_methods');
 const {cancelHodlInvoice} = require('./lnd_methods');
 const {cancelPendingChannel} = require('./lnd_methods');
@@ -24,6 +25,7 @@ const {disableChannel} = require('./lnd_methods');
 const {disconnectWatchtower} = require('./lnd_methods');
 const {emitGrpcEvents} = require('./lnd_gateway');
 const {enableChannel} = require('./lnd_methods');
+const {endGroupSigningSession} = require('./lnd_methods');
 const {fundPendingChannels} = require('./lnd_methods');
 const {fundPsbt} = require('./lnd_methods');
 const {getAccessIds} = require('./lnd_methods');
@@ -133,6 +135,7 @@ const {updateAlias} = require('./lnd_methods');
 const {updateChainTransaction} = require('./lnd_methods');
 const {updateColor} = require('./lnd_methods');
 const {updateConnectedWatchtower} = require('./lnd_methods');
+const {updateGroupSigningSession} = require('./lnd_methods');
 const {updatePathfindingSettings} = require('./lnd_methods');
 const {updateRoutingFees} = require('./lnd_methods');
 const {verifyAccess} = require('./lnd_methods');
@@ -145,6 +148,7 @@ module.exports = {
   addExternalSocket,
   addPeer,
   authenticatedLndGrpc,
+  beginGroupSigningSession,
   broadcastChainTransaction,
   cancelHodlInvoice,
   cancelPendingChannel,
@@ -166,6 +170,7 @@ module.exports = {
   disableChannel,
   disconnectWatchtower,
   enableChannel,
+  endGroupSigningSession,
   diffieHellmanComputeSecret,
   emitGrpcEvents,
   fundPendingChannels,
@@ -277,6 +282,7 @@ module.exports = {
   updateColor,
   updateChainTransaction,
   updateConnectedWatchtower,
+  updateGroupSigningSession,
   updatePathfindingSettings,
   updateRoutingFees,
   verifyAccess,

package/lnd_methods/index.js

@@ -1,5 +1,6 @@
 const {addExternalSocket} = require('./peers');
 const {addPeer} = require('./peers');
+const {beginGroupSigningSession} = require('./signer');
 const {broadcastChainTransaction} = require('./onchain');
 const {cancelHodlInvoice} = require('./invoices');
 const {cancelPendingChannel} = require('./onchain');
@@ -22,6 +23,7 @@ const {diffieHellmanComputeSecret} = require('./signer');
 const {disableChannel} = require('./offchain');
 const {disconnectWatchtower} = require('./offchain');
 const {enableChannel} = require('./offchain');
+const {endGroupSigningSession} = require('./signer');
 const {fundPendingChannels} = require('./onchain');
 const {fundPsbt} = require('./onchain');
 const {getAccessIds} = require('./macaroon');
@@ -129,6 +131,7 @@ const {updateAlias} = require('./peers');
 const {updateChainTransaction} = require('./onchain');
 const {updateColor} = require('./peers');
 const {updateConnectedWatchtower} = require('./offchain');
+const {updateGroupSigningSession} = require('./signer');
 const {updatePathfindingSettings} = require('./offchain');
 const {updateRoutingFees} = require('./offchain');
 const {verifyAccess} = require('./macaroon');
@@ -140,6 +143,7 @@ const {verifyMessage} = require('./message');
 module.exports = {
   addExternalSocket,
   addPeer,
+  beginGroupSigningSession,
   broadcastChainTransaction,
   cancelHodlInvoice,
   cancelPendingChannel,
@@ -162,6 +166,7 @@ module.exports = {
   disableChannel,
   disconnectWatchtower,
   enableChannel,
+  endGroupSigningSession,
   fundPendingChannels,
   fundPsbt,
   getAccessIds,
@@ -269,6 +274,7 @@ module.exports = {
   updateChainTransaction,
   updateColor,
   updateConnectedWatchtower,
+  updateGroupSigningSession,
   updatePathfindingSettings,
   updateRoutingFees,
   verifyAccess,

package/lnd_methods/info/get_route_to_destination.js

@@ -17,6 +17,7 @@ const {pathNotFoundErrors} = require('./constants');
 const {routeHintFromRoute} = require('./../../lnd_requests');
 const {routesFromQueryRoutes} = require('./../../lnd_responses');
 
+const asTimePreference = n => n === undefined ? n : ((n * 2) - 1e6) / 1e6;
 const bufFromHex = hex => !hex ? null : Buffer.from(hex, 'hex');
 const {concat} = Buffer;
 const defaultRetryInterval = retryCount => 50 * Math.pow(2, retryCount);
@@ -24,6 +25,7 @@ const defaultMaxFee = Number.MAX_SAFE_INTEGER;
 const errorFilter = err => Array.isArray(err) && err.slice().shift() === 429;
 const internalServerError = /internal.server.error/i;
 const {isArray} = Array;
+const isConfidence = n => !isNaN(n) && n >= 0 && n <= 1e6;
 const isHex = n => !(n.length % 2) && /^[0-9A-F]*$/i.test(n);
 const mtokensByteLength = 8;
 const networkBusyError = /device.or.resource.busy/;
@@ -41,8 +43,11 @@ const trimByte = 0;
 
   Requires `info:read` permission
 
+  Preferred `confidence` is not supported on LND 0.14.3 and below
+
   {
     [cltv_delta]: <Final CLTV Delta Number>
+    [confidence]: <Preferred Route Confidence Number Out of One Million Number>
     destination: <Final Send Destination Hex Encoded Public Key String>
     [features]: [{
       bit: <Feature Bit Number>
@@ -112,6 +117,10 @@ module.exports = (args, cbk) => {
     return asyncAuto({
       // Check arguments
       validate: cbk => {
+        if (args.confidence !== undefined && !isConfidence(args.confidence)) {
+          return cbk([400, 'ExpectedConfidenceInPartsPerMillionForQuery']);
+        }
+
         if (!args.destination || !isHex(args.destination)) {
           return cbk([400, 'ExpectedDestinationKeyToGetRouteToDestination']);
         }
@@ -261,6 +270,7 @@ module.exports = (args, cbk) => {
             pub_key: args.destination,
             route_hints: routeHints || undefined,
             source_pub_key: args.start || undefined,
+            time_pref: asTimePreference(args.confidence),
             use_mission_control: !args.is_ignoring_past_failures,
           },
           (err, response) => {

package/lnd_methods/macaroon/methods.json

@@ -7,6 +7,11 @@
     "method": "ConnectPeer",
     "type": "default"
   },
+  "beginGroupSigningSession": {
+    "depends_on": ["getPublicKey"],
+    "method": "MuSig2CreateSession",
+    "type": "signer"
+  },
   "broadcastChainTransaction": {
     "method": "PublishTransaction",
     "type": "wallet"
@@ -87,6 +92,10 @@
     "method": "UpdateChanStatus",
     "type": "router"
   },
+  "endGroupSigningSession": {
+    "methods": ["MuSig2Cleanup", "MuSig2CombineSig"],
+    "type": "signer"
+  },
   "fundPendingChannels": {
     "method": "FundingStateStep",
     "type": "default"
@@ -514,6 +523,10 @@
     "methods": ["AddTower", "RemoveTower"],
     "type": "tower_client"
   },
+  "updateGroupSigningSession": {
+    "methods": ["MuSig2RegisterNonces", "MuSig2Sign"],
+    "type": "signer"
+  },
   "updatePathfindingSettings": {
     "method": "SetMissionControlConfig",
     "type": "router"

package/lnd_methods/offchain/get_failed_payments.js

@@ -56,7 +56,9 @@ const type = 'default';
           message: <Error Message String>
         }
         [index]: <Payment Add Index Number>
-        [confirmed_at]: <Payment Confirmed At ISO 8601 Date String>
+        [confirmed_at]: <Payment Attempt Succeeded At ISO 8601 Date String>
+        created_at: <Attempt Was Started At ISO 8601 Date String>
+        [failed_at]: <Payment Attempt Failed At ISO 8601 Date String>
         is_confirmed: <Payment Attempt Succeeded Bool>
         is_failed: <Payment Attempt Failed Bool>
         is_pending: <Payment Attempt is Waiting For Resolution Bool>

package/lnd_methods/offchain/get_payments.js

@@ -55,7 +55,9 @@ const type = 'default';
           message: <Error Message String>
         }
         [index]: <Payment Add Index Number>
-        [confirmed_at]: <Payment Confirmed At ISO 8601 Date String>
+        [confirmed_at]: <Payment Attempt Succeeded At ISO 8601 Date String>
+        created_at: <Attempt Was Started At ISO 8601 Date String>
+        [failed_at]: <Payment Attempt Failed At ISO 8601 Date String>
         is_confirmed: <Payment Attempt Succeeded Bool>
         is_failed: <Payment Attempt Failed Bool>
         is_pending: <Payment Attempt is Waiting For Resolution Bool>

package/lnd_methods/offchain/get_pending_payments.js

@@ -57,6 +57,8 @@ const type = 'default';
         }
         [index]: <Payment Add Index Number>
         [confirmed_at]: <Payment Confirmed At ISO 8601 Date String>
+        created_at: <Attempt Was Started At ISO 8601 Date String>
+        [failed_at]: <Payment Attempt Failed At ISO 8601 Date String>
         is_confirmed: <Payment Attempt Succeeded Bool>
         is_failed: <Payment Attempt Failed Bool>
         is_pending: <Payment Attempt is Waiting For Resolution Bool>

package/lnd_methods/offchain/is_destination_payable.js

@@ -9,8 +9,11 @@ const defaultTokens = 1;
 
   Requires `offchain:write` permission
 
+  Preferred `confidence` is not supported on LND 0.14.3 and below
+
   {
     [cltv_delta]: <Final CLTV Delta Number>
+    [confidence]: <Preferred Route Confidence Number Out of One Million Number>
     destination: <Pay to Node with Public Key Hex String>
     [incoming_peer]: <Pay Through Specific Final Hop Public Key Hex String>
     lnd: <Authenticated LND API Object>
@@ -57,6 +60,7 @@ module.exports = (args, cbk) => {
 
         const sub = subscribeToPayViaDetails({
           cltv_delta: args.cltv_delta,
+          confidence: args.confidence,
           destination: args.destination,
           lnd: args.lnd,
           max_fee: args.max_fee,

package/lnd_methods/offchain/pay.js

@@ -17,7 +17,10 @@ const payViaRoutes = require('./pay_via_routes');
 
   `max_path_mtokens` is not supported in LND 0.12.0 or below
 
+  Preferred `confidence` is not supported on LND 0.14.3 and below
+
   {
+    [confidence]: <Preferred Route Confidence Number Out of One Million Number>
     [incoming_peer]: <Pay Through Specific Final Hop Public Key Hex String>
     lnd: <Authenticated LND API Object>
     [max_fee]: <Maximum Additional Fee Tokens To Pay Number>
@@ -124,6 +127,7 @@ module.exports = (args, cbk) => {
         }
 
         return payViaPaymentRequest({
+          confidence: args.confidence,
           incoming_peer: args.incoming_peer,
           lnd: args.lnd,
           max_fee: args.max_fee,