Skip to content

Trivial #3246 followups. #3959

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 25, 2025
Merged

Trivial #3246 followups. #3959

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a25bdb
Drop now-unused public `MAX_SHORT_LIVED_RELATIVE_EXPIRY` constant
TheBlueMatt Jul 24, 2025
86c186a
Be more pedantically correct in offer/refund builder documentation
TheBlueMatt Jul 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 8 additions & 25 deletions lightning/src/ln/channelmanager.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2964,19 +2964,6 @@ const MAX_PEER_STORAGE_SIZE: usize = 1024;
/// many peers we reject new (inbound) connections.
const MAX_NO_CHANNEL_PEERS: usize = 250;

/// The maximum expiration from the current time where an [`Offer`] or [`Refund`] is considered
/// short-lived, while anything with a greater expiration is considered long-lived.
///
/// Using [`ChannelManager::create_offer_builder`] or [`ChannelManager::create_refund_builder`],
/// will include a [`BlindedMessagePath`] created using [`MessageRouter::create_blinded_paths`].
///
/// Using compact [`BlindedMessagePath`]s may provide better privacy as the [`MessageRouter`] could select
/// more hops. However, since they use short channel ids instead of pubkeys, they are more likely to
/// become invalid over time as channels are closed. Thus, they are only suitable for short-term use.
///
/// [`BlindedMessagePath`]: crate::blinded_path::message::BlindedMessagePath
pub const MAX_SHORT_LIVED_RELATIVE_EXPIRY: Duration = Duration::from_secs(60 * 60 * 24);

/// Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
/// These include payments that have yet to find a successful path, or have unresolved HTLCs.
#[derive(Debug, PartialEq)]
Expand Down Expand Up @@ -11567,8 +11554,9 @@ macro_rules! create_offer_builder { ($self: ident, $builder: ty) => {
///
/// # Privacy
///
/// Uses the [`MessageRouter`] provided to the [`ChannelManager`] at construction to build a
/// [`BlindedMessagePath`] for the offer. See those docs for privacy implications.
/// Uses [`MessageRouter`] provided at construction to construct a [`BlindedMessagePath`] for
/// the offer. See the documentation of the selected [`MessageRouter`] for details on how it
/// selects blinded paths including privacy implications and reliability tradeoffs.
///
/// Also, uses a derived signing pubkey in the offer for recipient privacy.
///
Expand Down Expand Up @@ -11597,7 +11585,7 @@ macro_rules! create_offer_builder { ($self: ident, $builder: ty) => {
/// This gives users full control over how the [`BlindedMessagePath`] is constructed,
/// including the option to omit it entirely.
///
/// See [`Self::create_offer_builder`] for details on offer construction, privacy, and limitations.
/// See [`Self::create_offer_builder`] for more details on usage.
///
/// [`BlindedMessagePath`]: crate::blinded_path::message::BlindedMessagePath
/// [`Offer`]: crate::offers::offer::Offer
Expand Down Expand Up @@ -11640,9 +11628,9 @@ macro_rules! create_refund_builder { ($self: ident, $builder: ty) => {
///
/// # Privacy
///
/// Uses [`MessageRouter`] to construct a [`BlindedMessagePath`] for the refund based on the given
/// `absolute_expiry` according to [`MAX_SHORT_LIVED_RELATIVE_EXPIRY`]. See those docs for
/// privacy implications.
/// Uses [`MessageRouter`] provided at construction to construct a [`BlindedMessagePath`] for
/// the refund. See the documentation of the selected [`MessageRouter`] for details on how it
/// selects blinded paths including privacy implications and reliability tradeoffs.
///
/// Also, uses a derived payer id in the refund for payer privacy.
///
Expand Down Expand Up @@ -11689,12 +11677,7 @@ macro_rules! create_refund_builder { ($self: ident, $builder: ty) => {
/// refund, including the option to omit it entirely. This is useful for testing or when
/// alternative privacy strategies are needed.
///
/// See [`Self::create_refund_builder`] for:
/// - refund recognition by [`ChannelManager`] via [`Bolt12Invoice`] handling,
/// - `payment_id` rules and expiration behavior,
/// - invoice revocation and refund failure handling,
/// - defaulting behavior for `max_total_routing_fee_msat`,
/// - and detailed payment and privacy semantics.
/// See [`Self::create_refund_builder`] for more details on usage.
///
/// # Errors
///
Expand Down
6 changes: 5 additions & 1 deletion lightning/src/ln/offers_tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ use crate::blinded_path::message::BlindedMessagePath;
use crate::blinded_path::payment::{Bolt12OfferContext, Bolt12RefundContext, PaymentContext};
use crate::blinded_path::message::OffersContext;
use crate::events::{ClosureReason, Event, HTLCHandlingFailureType, PaidBolt12Invoice, PaymentFailureReason, PaymentPurpose};
use crate::ln::channelmanager::{Bolt12PaymentError, MAX_SHORT_LIVED_RELATIVE_EXPIRY, PaymentId, RecentPaymentDetails, RecipientOnionFields, Retry, self};
use crate::ln::channelmanager::{Bolt12PaymentError, PaymentId, RecentPaymentDetails, RecipientOnionFields, Retry, self};
use crate::types::features::Bolt12InvoiceFeatures;
use crate::ln::functional_test_utils::*;
use crate::ln::msgs::{BaseMessageHandler, ChannelMessageHandler, Init, NodeAnnouncement, OnionMessage, OnionMessageHandler, RoutingMessageHandler, SocketAddress, UnsignedGossipMessage, UnsignedNodeAnnouncement};
Expand All @@ -67,6 +67,10 @@ use crate::routing::router::{PaymentParameters, RouteParameters, RouteParameters
use crate::sign::{NodeSigner, Recipient};
use crate::util::ser::Writeable;

/// This used to determine whether we built a compact path or not, but now its just a random
/// constant we apply to blinded path expiry in these tests.
const MAX_SHORT_LIVED_RELATIVE_EXPIRY: Duration = Duration::from_secs(60 * 60 * 24);

use crate::prelude::*;

macro_rules! expect_recent_payment {
Expand Down
18 changes: 8 additions & 10 deletions lightning/src/offers/flow.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -562,8 +562,9 @@ where
///
/// # Privacy
///
/// Uses the [`OffersMessageFlow`]'s [`MessageRouter`] to construct a [`BlindedMessagePath`]
/// for the offer. See those docs for privacy implications.
/// Uses [`MessageRouter`] provided at construction to construct a [`BlindedMessagePath`] for
/// the offer. See the documentation of the selected [`MessageRouter`] for details on how it
/// selects blinded paths including privacy implications and reliability tradeoffs.
///
/// Also uses a derived signing pubkey in the offer for recipient privacy.
///
Expand Down Expand Up @@ -598,7 +599,7 @@ where
/// This gives users full control over how the [`BlindedMessagePath`] is constructed,
/// including the option to omit it entirely.
///
/// See [`Self::create_offer_builder`] for details on offer construction, privacy, and limitations.
/// See [`Self::create_offer_builder`] for more details on usage.
pub fn create_offer_builder_using_router<ME: Deref, ES: Deref>(
&self, router: ME, entropy_source: ES, peers: Vec<MessageForwardNode>,
) -> Result<OfferBuilder<DerivedMetadata, secp256k1::All>, Bolt12SemanticError>
Expand Down Expand Up @@ -682,8 +683,9 @@ where
///
/// # Privacy
///
/// Uses the [`OffersMessageFlow`]'s [`MessageRouter`] to construct a [`BlindedMessagePath`]
/// for the offer. See those docs for privacy implications.
/// Uses [`MessageRouter`] provided at construction to construct a [`BlindedMessagePath`] for
/// the refund. See the documentation of the selected [`MessageRouter`] for details on how it
/// selects blinded paths including privacy implications and reliability tradeoffs.
///
/// The builder will have the provided expiration set. Any changes to the expiration on the
/// returned builder will not be honored by [`OffersMessageFlow`]. For non-`std`, the highest seen
Expand Down Expand Up @@ -734,11 +736,7 @@ where
/// This gives users full control over how the [`BlindedMessagePath`] is constructed,
/// including the option to omit it entirely.
///
/// See [`Self::create_refund_builder`] for:
/// - how the resulting [`Refund`] is recognized by [`OffersMessageFlow`] and verified via [`Self::verify_bolt12_invoice`],
/// - refund expiration handling,
/// - rules around revocation and [`Event::PaymentFailed`] behavior,
/// - and defaulting logic for `max_total_routing_fee_msat`.
/// See [`Self::create_refund_builder`] for more details on usage.
///
/// # Errors
///
Expand Down