Skip to content

Commit 6087aff

Browse files
committed
f Add docs for AChannelManager associated types
1 parent 700da40 commit 6087aff

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

lightning/src/ln/channelmanager.rs

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -837,22 +837,39 @@ pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L> =
837837

838838
/// A trivial trait which describes any [`ChannelManager`].
839839
pub trait AChannelManager {
840+
/// A type implementing [`chain::Watch`].
840841
type Watch: chain::Watch<Self::Signer> + ?Sized;
842+
/// A type that may be dereferenced to [`Self::Watch`].
841843
type M: Deref<Target = Self::Watch>;
844+
/// A type implementing [`BroadcasterInterface`].
842845
type Broadcaster: BroadcasterInterface + ?Sized;
846+
/// A type that may be dereferenced to [`Self::Broadcaster`].
843847
type T: Deref<Target = Self::Broadcaster>;
848+
/// A type implementing [`EntropySource`].
844849
type EntropySource: EntropySource + ?Sized;
850+
/// A type that may be dereferenced to [`Self::EntropySource`].
845851
type ES: Deref<Target = Self::EntropySource>;
852+
/// A type implementing [`NodeSigner`].
846853
type NodeSigner: NodeSigner + ?Sized;
854+
/// A type that may be dereferenced to [`Self::NodeSigner`].
847855
type NS: Deref<Target = Self::NodeSigner>;
856+
/// A type implementing [`WriteableEcdsaChannelSigner`].
848857
type Signer: WriteableEcdsaChannelSigner + Sized;
858+
/// A type implementing [`SignerProvider`] for [`Self::Signer`].
849859
type SignerProvider: SignerProvider<Signer = Self::Signer> + ?Sized;
860+
/// A type that may be dereferenced to [`Self::SignerProvider`].
850861
type SP: Deref<Target = Self::SignerProvider>;
862+
/// A type implementing [`FeeEstimator`].
851863
type FeeEstimator: FeeEstimator + ?Sized;
864+
/// A type that may be dereferenced to [`Self::FeeEstimator`].
852865
type F: Deref<Target = Self::FeeEstimator>;
866+
/// A type implementing [`Router`].
853867
type Router: Router + ?Sized;
868+
/// A type that may be dereferenced to [`Self::Router`].
854869
type R: Deref<Target = Self::Router>;
870+
/// A type implementing [`Logger`].
855871
type Logger: Logger + ?Sized;
872+
/// A type that may be dereferenced to [`Self::Logger`].
856873
type L: Deref<Target = Self::Logger>;
857874
/// Returns a reference to the actual [`ChannelManager`] object.
858875
fn get_cm(&self) -> &ChannelManager<Self::M, Self::T, Self::ES, Self::NS, Self::SP, Self::F, Self::R, Self::L>;

0 commit comments

Comments
 (0)