feat(client): implement basic aggregator discoverer

Author: jpraynaud

Cargo.lock

@@ -59,6 +59,7 @@ flate2 = { version = "1.1.4", optional = true }
 flume = { version = "0.11.1", optional = true }
 futures = "0.3.31"
 mithril-common = { path = "../mithril-common", version = ">=0.6", default-features = false }
+mithril-aggregator-discovery = { path = "../internal/mithril-aggregator-discovery", features = ["rand"] }
 reqwest = { workspace = true, default-features = false, features = [
     "charset",
     "http2",

mithril-client/Cargo.toml

@@ -1,6 +1,9 @@
 use anyhow::{Context, anyhow};
 #[cfg(feature = "fs")]
 use chrono::Utc;
+use mithril_aggregator_discovery::{
+    AggregatorDiscoverer, HttpConfigAggregatorDiscoverer, MithrilNetwork,
+};
 use mithril_common::messages::AggregatorCapabilities;
 use reqwest::Url;
 use serde::{Deserialize, Serialize};
@@ -44,7 +47,7 @@ const fn one_week_in_seconds() -> u32 {
 /// The type of discovery to use to find the aggregator to connect to.
 pub enum AggregatorDiscoveryType {
     /// Automatically discover the aggregator.
-    Automatic,
+    Automatic(MithrilNetwork),
     /// Use a specific URL to connect to the aggregator.
     Url(String),
 }
@@ -175,6 +178,7 @@ impl Client {
 pub struct ClientBuilder {
     aggregator_discovery: AggregatorDiscoveryType,
     aggregator_capabilities: Option<AggregatorCapabilities>,
+    aggregator_discoverer: Option<Arc<dyn AggregatorDiscoverer>>,
     genesis_verification_key: Option<GenesisVerificationKey>,
     origin_tag: Option<String>,
     client_type: Option<String>,
@@ -196,16 +200,19 @@ impl ClientBuilder {
     /// Constructs a new `ClientBuilder` that fetches data from the aggregator at the given
     /// endpoint and with the given genesis verification key.
     pub fn aggregator(endpoint: &str, genesis_verification_key: &str) -> ClientBuilder {
-        Self::new(AggregatorDiscoveryType::Url(endpoint.to_string())).with_genesis_verification_key(
-            GenesisVerificationKey::JsonHex(genesis_verification_key.to_string()),
-        )
+        Self::new(AggregatorDiscoveryType::Url(endpoint.to_string()))
+            .with_genesis_verification_key(GenesisVerificationKey::JsonHex(
+                genesis_verification_key.to_string(),
+            ))
+            .with_aggregator_discoverer(Arc::new(HttpConfigAggregatorDiscoverer::default()))
     }
 
     /// Constructs a new `ClientBuilder` without any dependency set.
     pub fn new(aggregator_discovery: AggregatorDiscoveryType) -> ClientBuilder {
         Self {
             aggregator_discovery,
             aggregator_capabilities: None,
+            aggregator_discoverer: None,
             genesis_verification_key: None,
             origin_tag: None,
             client_type: None,
@@ -241,11 +248,21 @@ impl ClientBuilder {
         self
     }
 
+    /// Sets the aggregator discoverer to use to find the aggregator endpoint when in automatic discovery.
+    pub fn with_aggregator_discoverer(
+        mut self,
+        discoverer: Arc<dyn AggregatorDiscoverer>,
+    ) -> ClientBuilder {
+        self.aggregator_discoverer = Some(discoverer);
+
+        self
+    }
+
     /// Returns a `Client` that uses the dependencies provided to this `ClientBuilder`.
     ///
     /// The builder will try to create the missing dependencies using default implementations
     /// if possible.
-    pub fn build(self) -> MithrilResult<Client> {
+    pub async fn build(self) -> MithrilResult<Client> {
         let logger = self
             .logger
             .clone()
@@ -264,7 +281,7 @@ impl ClientBuilder {
         let feedback_sender = FeedbackSender::new(&self.feedback_receivers);
 
         let aggregator_client = match self.aggregator_client {
-            None => Arc::new(self.build_aggregator_client(logger.clone())?),
+            None => Arc::new(self.build_aggregator_client(logger.clone()).await?),
             Some(client) => client,
         };
 
@@ -367,15 +384,24 @@ impl ClientBuilder {
         })
     }
 
-    fn build_aggregator_client(
+    async fn build_aggregator_client(
         &self,
         logger: Logger,
     ) -> Result<AggregatorHTTPClient, anyhow::Error> {
         let aggregator_endpoint = match self.aggregator_discovery {
             AggregatorDiscoveryType::Url(ref url) => url.clone(),
-            AggregatorDiscoveryType::Automatic => {
-                todo!("Implement automatic aggregator discovery")
-            }
+            AggregatorDiscoveryType::Automatic(ref network) => match &self.aggregator_discoverer {
+                Some(discoverer) => discoverer
+                    .get_available_aggregators(network.to_owned())
+                    .await
+                    .with_context(|| "Discovering aggregator endpoint failed")?
+                    .next()
+                    .unwrap()
+                    .into(),
+                None => {
+                    return Err(anyhow!("The aggregator discoverer must be provided to build the client with automatic discovery using the 'with_aggregator_discoverer' function").into());
+                }
+            },
         };
         let endpoint_url = Url::parse(&aggregator_endpoint).with_context(|| {
             format!("Invalid aggregator endpoint, it must be a correctly formed url: '{aggregator_endpoint}'")

mithril-client/src/client.rs

@@ -63,6 +63,7 @@ async fn cardano_db_snapshot_list_get_download_verify() {
                 extensions::test_logger(),
             )))
             .build()
+            .await
             .expect("Should be able to create a Client");
 
     let cardano_db_snapshots = client

mithril-client/tests/cardano_db_snapshot_list_get_download_verify.rs

@@ -22,6 +22,7 @@ async fn cardano_transaction_proof_get_validate() {
                 FakeCertificateVerifier::build_that_validate_any_certificate(),
             )
             .build()
+            .await
             .expect("Should be able to create a Client");
     let cardano_transaction_client = client.cardano_transaction();
 

mithril-client/tests/cardano_transaction_proof.rs

@@ -16,6 +16,7 @@ async fn certificate_get_list() {
     let client =
         ClientBuilder::aggregator(&fake_aggregator.server_root_url(), genesis_verification_key)
             .build()
+            .await
             .expect("Should be able to create a Client");
 
     let certificates = client

mithril-client/tests/certificate_get_list.rs

@@ -21,6 +21,7 @@ async fn mithril_stake_distribution_list_get_show_verify() {
                 FakeCertificateVerifier::build_that_validate_any_certificate(),
             )
             .build()
+            .await
             .expect("Should be able to create a Client");
     let mithril_stake_distribution_client = client.mithril_stake_distribution();
 

mithril-client/tests/mithril_stake_distribution_list_get_show_verify.rs

@@ -50,6 +50,7 @@ async fn snapshot_list_get_show_download_verify() {
             )))
             .with_logger(extensions::test_logger())
             .build()
+            .await
             .expect("Should be able to create a Client");
 
     let snapshots = client