diff --git a/lightning/src/lib.rs b/lightning/src/lib.rs index 1bcd02a9f7d..95953e6a033 100644 --- a/lightning/src/lib.rs +++ b/lightning/src/lib.rs @@ -62,7 +62,7 @@ compile_error!("Tests will always fail with cfg=fuzzing"); #[macro_use] extern crate alloc; -extern crate lightning_types; +pub extern crate lightning_types as types; pub extern crate bitcoin; #[cfg(any(test, feature = "std"))] diff --git a/lightning/src/ln/features.rs b/lightning/src/ln/features.rs index 4637dfc2b25..e05fb9c4187 100644 --- a/lightning/src/ln/features.rs +++ b/lightning/src/ln/features.rs @@ -11,6 +11,10 @@ //! //! See [`lightning_types::features`] for the list of features currently supported. //! +//! Note that the use of types via this module is deprecated and will be removed in a future +//! version. Instead, use feature objects via [`lightning::types::features`]. +//! +//! [`lightning::types::features`]: crate::types::features //! [BOLT #9]: https://github.com/lightning/bolts/blob/master/09-features.md pub use lightning_types::features::Features; diff --git a/lightning/src/ln/mod.rs b/lightning/src/ln/mod.rs index 8009f31b0dc..dceb52ab4ae 100644 --- a/lightning/src/ln/mod.rs +++ b/lightning/src/ln/mod.rs @@ -8,6 +8,12 @@ // licenses. //! Implementations of various parts of the Lightning protocol are in this module. +//! +//! Note that the re-exports of [`PaymentHash`], [`PaymentPreimage`], and [`PaymentSecret`] here +//! are deprecated and will be removed in a future version. Instead, use them via +//! [`lightning::types::payment`]. +//! +//! [`lightning::types::payment`]: crate::types::payment #[cfg(any(test, feature = "_test_utils"))] #[macro_use] diff --git a/lightning/src/ln/types.rs b/lightning/src/ln/types.rs index d5ab05505bb..659c7e4caba 100644 --- a/lightning/src/ln/types.rs +++ b/lightning/src/ln/types.rs @@ -8,6 +8,12 @@ // licenses. //! Various wrapper types (most around 32-byte arrays) for use in lightning. +//! +//! Note that the re-exports of [`PaymentHash`], [`PaymentPreimage`], and [`PaymentSecret`] here +//! are deprecated and will be removed in a future version. Instead, use them via +//! [`lightning::types::payment`]. +//! +//! [`lightning::types::payment`]: crate::types::payment use crate::chain::transaction::OutPoint; use crate::io;