From ac7f5261a265583d97015ce8e1188e7676d328cc Mon Sep 17 00:00:00 2001 From: Jeffrey Czyz Date: Wed, 20 Dec 2023 18:05:42 -0600 Subject: [PATCH] Add ASCII art diagram explaining offers_tests --- lightning/src/ln/offers_tests.rs | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/lightning/src/ln/offers_tests.rs b/lightning/src/ln/offers_tests.rs index b0a8551a080..9b7edee5472 100644 --- a/lightning/src/ln/offers_tests.rs +++ b/lightning/src/ln/offers_tests.rs @@ -13,6 +13,33 @@ //! to initiate and request payment for them, respectively. It also manages the payment flow via //! implementing [`OffersMessageHandler`]. This module tests that functionality, including the //! resulting [`Event`] generation. +//! +//! Two-node success tests use an announced channel: +//! +//! Alice --- Bob +//! +//! While two-node failure tests use an unannounced channel: +//! +//! Alice ... Bob +//! +//! Six-node tests use unannounced channels for the sender and recipient and announced channels for +//! the rest of the network. +//! +//! nodes[4] +//! / \ +//! / \ +//! / \ +//! Alice ... Bob -------- Charlie ... David +//! \ / +//! \ / +//! \ / +//! nodes[5] +//! +//! Unnamed nodes are needed to ensure unannounced nodes can create two-hop blinded paths. +//! +//! Nodes without channels are disconnected and connected as needed to ensure that deterministic +//! blinded paths are used. + use core::time::Duration; use crate::blinded_path::BlindedPath;