Skip to content

Commit 0ebd19a

Browse files
committed
Correct documentation about Refund::payer_id
The docs incorrectly stated that Refund::payer_id is for signing, where it is only used for identifying a node if Refund::paths is not present.
1 parent 8e36737 commit 0ebd19a

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

lightning/src/offers/refund.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ pub struct RefundBuilder {
102102
}
103103

104104
impl RefundBuilder {
105-
/// Creates a new builder for a refund using the [`Refund::payer_id`] for signing invoices. Use
106-
/// a different pubkey per refund to avoid correlating refunds.
105+
/// Creates a new builder for a refund using the [`Refund::payer_id`] for the node to send to
106+
/// if no [`Refund::paths`] are set.
107107
///
108108
/// Additionally, sets the required [`Refund::description`], [`Refund::metadata`], and
109109
/// [`Refund::amount_msats`].
@@ -285,7 +285,9 @@ impl Refund {
285285
&self.contents.features
286286
}
287287

288-
/// A possibly transient pubkey used to sign the refund.
288+
/// A possibly transient pubkey used for the node to send to if there are no [`paths`].
289+
///
290+
/// [`paths`]: Self::paths
289291
pub fn payer_id(&self) -> PublicKey {
290292
self.contents.payer_id
291293
}

0 commit comments

Comments
 (0)