From 9a665ca0b8cf9700f1aa95de50c406c84f3ab474 Mon Sep 17 00:00:00 2001 From: Evan Feenstra Date: Sat, 28 Oct 2023 08:38:17 -0700 Subject: [PATCH] public scid utils --- lightning/src/util/mod.rs | 2 +- lightning/src/util/scid_utils.rs | 8 ++++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/lightning/src/util/mod.rs b/lightning/src/util/mod.rs index e86885a83..9affed555 100644 --- a/lightning/src/util/mod.rs +++ b/lightning/src/util/mod.rs @@ -20,6 +20,7 @@ pub mod ser; pub mod message_signing; pub mod invoice; pub mod persist; +pub mod scid_utils; pub mod string; pub mod wakers; #[cfg(fuzzing)] @@ -34,7 +35,6 @@ pub(crate) mod chacha20; pub(crate) mod poly1305; pub(crate) mod chacha20poly1305rfc; pub(crate) mod transaction_utils; -pub(crate) mod scid_utils; pub(crate) mod time; pub mod indexed_map; diff --git a/lightning/src/util/scid_utils.rs b/lightning/src/util/scid_utils.rs index fbbcc69a1..d74f18e93 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, } @@ -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 } -- 2.39.5