From: Jeffrey Czyz <jkczyz@gmail.com>
Date: Thu, 21 Dec 2023 00:05:42 +0000 (-0600)
Subject: Add ASCII art diagram explaining offers_tests
X-Git-Tag: v0.0.123-beta~93^2~2
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=ffc24c3af9a274557434a64f74ad72f338c78419;p=rust-lightning

Add ASCII art diagram explaining offers_tests
---

diff --git a/lightning/src/ln/offers_tests.rs b/lightning/src/ln/offers_tests.rs
index c8381f2a..0038bdd7 100644
--- a/lightning/src/ln/offers_tests.rs
+++ b/lightning/src/ln/offers_tests.rs
@@ -13,6 +13,32 @@
 //! 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;