Change cltv_expiry_delta, htlc_minimum_msat, fees and id methods

visibility to public

Author: jbesraa

lightning/src/routing/router.rs

@@ -1075,7 +1075,8 @@ impl<'a> CandidateRouteHop<'a> {
 		}
 	}
 
-	fn cltv_expiry_delta(&self) -> u32 {
+	/// Returns cltv_expiry_delta for this hop.
+	pub fn cltv_expiry_delta(&self) -> u32 {
 		match self {
 			CandidateRouteHop::FirstHop { .. } => 0,
 			CandidateRouteHop::PublicHop { info, .. } => info.direction().cltv_expiry_delta as u32,
@@ -1085,7 +1086,8 @@ impl<'a> CandidateRouteHop<'a> {
 		}
 	}
 
-	fn htlc_minimum_msat(&self) -> u64 {
+	/// Returns the htlc_minimum_msat for this hop.
+	pub fn htlc_minimum_msat(&self) -> u64 {
 		match self {
 			CandidateRouteHop::FirstHop { details, .. } => details.next_outbound_htlc_minimum_msat,
 			CandidateRouteHop::PublicHop { info, .. } => info.direction().htlc_minimum_msat,
@@ -1095,7 +1097,8 @@ impl<'a> CandidateRouteHop<'a> {
 		}
 	}
 
-	fn fees(&self) -> RoutingFees {
+	/// Returns the fees for this hop.
+	pub fn fees(&self) -> RoutingFees {
 		match self {
 			CandidateRouteHop::FirstHop { .. } => RoutingFees {
 				base_msat: 0, proportional_millionths: 0,
@@ -1129,7 +1132,10 @@ impl<'a> CandidateRouteHop<'a> {
 		}
 	}
 
-	fn id(&self, channel_direction: bool /* src_node_id < target_node_id */) -> CandidateHopId {
+	///  Returns the id of this hop.
+	///  For `Blinded` and `OneHopBlinded` we return `CandidateHopId::Blinded` because we don't know the channel id.
+	///  For any other option we return `CandidateHopId::Clear` because we know the channel id and the direction.
+	pub fn id(&self, channel_direction: bool /* src_node_id < target_node_id */) -> CandidateHopId {
 		match self {
 			CandidateRouteHop::Blinded { hint_idx, .. } => CandidateHopId::Blinded(*hint_idx),
 			CandidateRouteHop::OneHopBlinded { hint_idx, .. } => CandidateHopId::Blinded(*hint_idx),
@@ -1166,8 +1172,12 @@ impl<'a> CandidateRouteHop<'a> {
 	}
 }
 
+/// A wrapper around the various hop id representations.
+///
+/// `CandidateHopId::Clear` is used to identify a hop with a known short channel id and direction.
+/// `CandidateHopId::Blinded` is used to identify a blinded hop `hint_idx`.
 #[derive(Clone, Copy, Eq, Hash, Ord, PartialOrd, PartialEq)]
-enum CandidateHopId {
+pub enum CandidateHopId {
 	/// Contains (scid, src_node_id < target_node_id)
 	Clear((u64, bool)),
 	/// Index of the blinded route hint in [`Payee::Blinded::route_hints`].