Skip to content

Commit 1fa3806

Browse files
committed
Extend payment probe docs
1 parent ed6c529 commit 1fa3806

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

src/lib.rs

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1302,7 +1302,10 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
13021302
/// This may be used to send "pre-flight" probes, i.e., to train our scorer before conducting
13031303
/// the actual payment. Note this is only useful if there likely is sufficient time for the
13041304
/// probe to settle before sending out the actual payment, e.g., when waiting for user
1305-
/// confirmation in a wallet UI.
1305+
/// confirmation in a wallet UI. Otherwise, there is a chance the probe could take up some
1306+
/// liquidity needed to complete the actual payment. Users should therefore be cautious and
1307+
/// might avoid sending probes if liquidity is scarce and/or they don't expect the probe to
1308+
/// return before they send the payment.
13061309
pub fn send_payment_probe(&self, invoice: &Bolt11Invoice) -> Result<(), Error> {
13071310
let rt_lock = self.runtime.read().unwrap();
13081311
if rt_lock.is_none() {
@@ -1340,7 +1343,10 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
13401343
/// This may be used to send "pre-flight" probes, i.e., to train our scorer before conducting
13411344
/// the actual payment. Note this is only useful if there likely is sufficient time for the
13421345
/// probe to settle before sending out the actual payment, e.g., when waiting for user
1343-
/// confirmation in a wallet UI.
1346+
/// confirmation in a wallet UI. Otherwise, there is a chance the probe could take up some
1347+
/// liquidity needed to complete the actual payment. Users should therefore be cautious and
1348+
/// might avoid sending probes if liquidity is scarce and/or they don't expect the probe to
1349+
/// return before they send the payment.
13441350
pub fn send_spontaneous_payment_probe(
13451351
&self, amount_msat: u64, node_id: PublicKey,
13461352
) -> Result<(), Error> {

0 commit comments

Comments
 (0)