From: Valentine Wallace <vwallace@protonmail.com>
Date: Mon, 18 Dec 2023 19:27:12 +0000 (-0500)
Subject: Make BlindedFailure enum pub.
X-Git-Tag: v0.0.120~5^2~5
X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=f09ac1931f77ee8ccefff50c060878aca3a9eb8b;p=rust-lightning

Make BlindedFailure enum pub.

Necessary to include it in the public PendingHTLCInfo struct in the next commit.
---

diff --git a/lightning/src/ln/channelmanager.rs b/lightning/src/ln/channelmanager.rs
index 9f3a3f425..9a13d19f3 100644
--- a/lightning/src/ln/channelmanager.rs
+++ b/lightning/src/ln/channelmanager.rs
@@ -305,10 +305,15 @@ pub(super) enum HTLCForwardInfo {
 	},
 }
 
-// Used for failing blinded HTLCs backwards correctly.
+/// Whether this blinded HTLC is being failed backwards by the introduction node or a blinded node,
+/// which determines the failure message that should be used.
 #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
-enum BlindedFailure {
+pub enum BlindedFailure {
+	/// This HTLC is being failed backwards by the introduction node, and thus should be failed with
+	/// [`msgs::UpdateFailHTLC`] and error code `0x8000|0x4000|24`.
 	FromIntroductionNode,
+	/// This HTLC is being failed backwards by a blinded node within the path, and thus should be
+	/// failed with [`msgs::UpdateFailMalformedHTLC`] and error code `0x8000|0x4000|24`.
 	FromBlindedNode,
 }