f - Add docs for ChannelLiquidity fields
authorJeffrey Czyz <jkczyz@gmail.com>
Tue, 1 Feb 2022 02:43:54 +0000 (20:43 -0600)
committerJeffrey Czyz <jkczyz@gmail.com>
Wed, 2 Feb 2022 16:33:47 +0000 (10:33 -0600)
lightning/src/routing/scoring.rs

index 1600ae071d2b8a380a98e1671627cd818865922e..cf47ab853b93589561e7e362b4791747d613f703 100644 (file)
@@ -496,7 +496,10 @@ impl_writeable_tlv_based!(ProbabilisticScoringParameters, {
 /// first node in the ordering of the channel's counterparties. Thus, swapping the two liquidity
 /// offset fields gives the opposite direction.
 struct ChannelLiquidity {
+       /// Lower channel liquidity bound in terms of an offset from zero.
        min_liquidity_offset_msat: u64,
+
+       /// Upper channel liquidity bound in terms of an offset from the effective capacity.
        max_liquidity_offset_msat: u64,
 }