Merge pull request #1882 from input-output-hk/dlachaume/1842/implement-cardano-stake-distribution-in-client

Implement Cardano stake distribution in `mithril-client` library

Author: dlachaume

CHANGELOG.md

@@ -15,6 +15,7 @@ As a minor extension, we have adopted a slightly different versioning convention
 
   - Implement the signable and artifact builders for the signed entity type `CardanoStakeDistribution`.
   - Implement the HTTP routes related to the signed entity type `CardanoStakeDistribution` on the aggregator REST API.
+  - Added support in the `mithril-client` library for retrieving `CardanoStakeDistribution` by epoch or by hash, and for listing all available `CardanoStakeDistribution`.
 
 - Crates versions:
 

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-client"
-version = "0.8.11"
+version = "0.8.12"
 description = "Mithril client library"
 authors = { workspace = true }
 edition = { workspace = true }

mithril-client/Cargo.toml

@@ -22,6 +22,7 @@ use tokio::sync::RwLock;
 use mithril_common::entities::{ClientError, ServerError};
 use mithril_common::MITHRIL_API_VERSION_HEADER;
 
+use crate::common::Epoch;
 use crate::{MithrilError, MithrilResult};
 
 /// Error tied with the Aggregator client
@@ -92,6 +93,24 @@ pub enum AggregatorRequest {
     /// Lists the aggregator [Cardano transaction snapshot][crate::CardanoTransactionSnapshot]
     #[cfg(feature = "unstable")]
     ListCardanoTransactionSnapshots,
+
+    /// Get a specific [Cardano stake distribution][crate::CardanoStakeDistribution] from the aggregator by hash
+    #[cfg(feature = "unstable")]
+    GetCardanoStakeDistribution {
+        /// Hash of the Cardano stake distribution to retrieve
+        hash: String,
+    },
+
+    /// Get a specific [Cardano stake distribution][crate::CardanoStakeDistribution] from the aggregator by epoch
+    #[cfg(feature = "unstable")]
+    GetCardanoStakeDistributionByEpoch {
+        /// Epoch at the end of which the Cardano stake distribution is computed by the Cardano node
+        epoch: Epoch,
+    },
+
+    /// Lists the aggregator [Cardano stake distribution][crate::CardanoStakeDistribution]
+    #[cfg(feature = "unstable")]
+    ListCardanoStakeDistributions,
 }
 
 impl AggregatorRequest {
@@ -130,6 +149,18 @@ impl AggregatorRequest {
             AggregatorRequest::ListCardanoTransactionSnapshots => {
                 "artifact/cardano-transactions".to_string()
             }
+            #[cfg(feature = "unstable")]
+            AggregatorRequest::GetCardanoStakeDistribution { hash } => {
+                format!("artifact/cardano-stake-distribution/{hash}")
+            }
+            #[cfg(feature = "unstable")]
+            AggregatorRequest::GetCardanoStakeDistributionByEpoch { epoch } => {
+                format!("artifact/cardano-stake-distribution/epoch/{epoch}")
+            }
+            #[cfg(feature = "unstable")]
+            AggregatorRequest::ListCardanoStakeDistributions => {
+                "artifact/cardano-stake-distributions".to_string()
+            }
         }
     }
 
@@ -542,6 +573,24 @@ mod tests {
                 "artifact/cardano-transactions".to_string(),
                 AggregatorRequest::ListCardanoTransactionSnapshots.route()
             );
+
+            assert_eq!(
+                "artifact/cardano-stake-distribution/abc".to_string(),
+                AggregatorRequest::GetCardanoStakeDistribution {
+                    hash: "abc".to_string()
+                }
+                .route()
+            );
+
+            assert_eq!(
+                "artifact/cardano-stake-distribution/epoch/123".to_string(),
+                AggregatorRequest::GetCardanoStakeDistributionByEpoch { epoch: Epoch(123) }.route()
+            );
+
+            assert_eq!(
+                "artifact/cardano-stake-distributions".to_string(),
+                AggregatorRequest::ListCardanoStakeDistributions.route()
+            );
         }
     }