feat(aggregator-discovery): introduce 'AggregatorDiscoverer' trait

Author: jpraynaud

internal/mithril-aggregator-discovery/src/interface.rs

@@ -0,0 +1,18 @@
+//! Interface definition for Mithril Protocol Configuration provider.
+
+use mithril_common::StdResult;
+
+use crate::model::{AggregatorEndpoint, MithrilNetwork};
+
+/// An aggregator discoverer.
+#[cfg_attr(test, mockall::automock)]
+#[async_trait::async_trait]
+pub trait AggregatorDiscoverer: Sync + Send {
+    /// Get an iterator over a list of available aggregators in a Mithril network.
+    ///
+    /// Note: there is no guarantee that the returned aggregators is sorted, complete or up-to-date.
+    async fn get_available_aggregators(
+        &self,
+        network: MithrilNetwork,
+    ) -> StdResult<Vec<AggregatorEndpoint>>;
+}

internal/mithril-aggregator-discovery/src/lib.rs

@@ -1,4 +1,8 @@
 #![warn(missing_docs)]
 //! This crate provides mechanisms to discover aggregators in a Mithril network.
+
+mod interface;
 mod model;
+
+pub use interface::AggregatorDiscoverer;
 pub use model::{AggregatorEndpoint, MithrilNetwork};