Make BlindedFailure enum pub.
authorValentine Wallace <vwallace@protonmail.com>
Mon, 18 Dec 2023 19:27:12 +0000 (14:27 -0500)
committerValentine Wallace <vwallace@protonmail.com>
Thu, 11 Jan 2024 16:36:28 +0000 (11:36 -0500)
Necessary to include it in the public PendingHTLCInfo struct in the next commit.

lightning/src/ln/channelmanager.rs

index 9f3a3f425fb8728789551bdf7dec011200266c17..9a13d19f3b81e5732aa80a2a8ae40a6aaf1cc222 100644 (file)
@@ -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,
 }