X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Futil%2Fscid_utils.rs;h=9d943b4d466e5af801607d64f5687e4395588bb9;hb=a85d5b14444f3ef2dab994b404f4fb37635a3824;hp=fbbcc69a133e0966e8bd937d1838ac8dc4fd5c17;hpb=1f399b0984d591019320459d804cbad859c608ae;p=rust-lightning

diff --git a/lightning/src/util/scid_utils.rs b/lightning/src/util/scid_utils.rs
index fbbcc69a..9d943b4d 100644
--- a/lightning/src/util/scid_utils.rs
+++ b/lightning/src/util/scid_utils.rs
@@ -7,6 +7,8 @@
 // You may not use this file except in accordance with one or both of these
 // licenses.
 
+//! Utilities for creating and parsing short channel ids.
+
 /// Maximum block height that can be used in a `short_channel_id`. This
 /// value is based on the 3-bytes available for block height.
 pub const MAX_SCID_BLOCK: u64 = 0x00ffffff;
@@ -22,8 +24,11 @@ pub const MAX_SCID_VOUT_INDEX: u64 = 0xffff;
 /// A `short_channel_id` construction error
 #[derive(Debug, PartialEq, Eq)]
 pub enum ShortChannelIdError {
+	/// Block height too high
 	BlockOverflow,
+	/// Tx index too high
 	TxIndexOverflow,
+	/// Vout index too high
 	VoutIndexOverflow,
 }
 
@@ -69,7 +74,7 @@ pub(crate) mod fake_scid {
 	use bitcoin::blockdata::constants::ChainHash;
 	use bitcoin::network::constants::Network;
 	use crate::sign::EntropySource;
-	use crate::util::chacha20::ChaCha20;
+	use crate::crypto::chacha20::ChaCha20;
 	use crate::util::scid_utils;
 
 	use core::convert::TryInto;
@@ -91,8 +96,11 @@ pub(crate) mod fake_scid {
 	/// into the fake scid.
 	#[derive(Copy, Clone)]
 	pub(crate) enum Namespace {
+		/// Phantom nodes namespace
 		Phantom,
+		/// SCID aliases for outbound private channels
 		OutboundAlias,
+		/// Payment interception namespace
 		Intercept
 	}