chore(aggregator-discovery): scaffold new crate

jpraynaud · jpraynaud · commit 2fa8023da001 · 2025-11-17T14:56:34.000+01:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -843,7 +843,7 @@ jobs:
           # the same name (we only want to document those anyway)
           cargo doc --no-deps --lib -p mithril-stm -p mithril-common \
                     -p mithril-cardano-node-chain -p mithril-cardano-node-internal-database \
-                    -p mithril-aggregator-client -p mithril-build-script -p mithril-cli-helper \
+                    -p mithril-aggregator-client -p mithril-aggregator-discovery -p mithril-build-script -p mithril-cli-helper \
                     -p mithril-dmq -p mithril-doc -p mithril-doc-derive \
                     -p mithril-era -p mithril-metric -p mithril-persistence -p mithril-resource-pool \
                     -p mithril-ticker -p mithril-signed-entity-lock -p mithril-signed-entity-preloader \
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -12,6 +12,7 @@ members = [
     "internal/cardano-node/mithril-cardano-node-chain",
     "internal/cardano-node/mithril-cardano-node-internal-database",
     "internal/mithril-aggregator-client",
+    "internal/mithril-aggregator-discovery",
     "internal/mithril-build-script",
     "internal/mithril-cli-helper",
     "internal/mithril-dmq",
diff --git a/Makefile b/Makefile
@@ -1,15 +1,33 @@
-COMPONENTS = mithril-aggregator mithril-client mithril-client-cli mithril-client-wasm \
-			 mithril-common mithril-relay mithril-signer mithril-stm \
-			 internal/mithril-build-script internal/mithril-cli-helper internal/mithril-doc \
+COMPONENTS = demo/protocol-demo \
+			 internal/cardano-node/mithril-cardano-node-chain \
+			 internal/cardano-node/mithril-cardano-node-internal-database \
+			 internal/mithril-aggregator-client \
+			 internal/mithril-aggregator-discovery \
+			 internal/mithril-build-script \
+			 internal/mithril-cli-helper \
 			 internal/mithril-dmq \
-			 internal/mithril-doc-derive internal/mithril-era internal/mithril-metric internal/mithril-persistence \
+			 internal/mithril-doc \
+			 internal/mithril-doc-derive \
+			 internal/mithril-era \
+			 internal/mithril-metric \
+			 internal/mithril-persistence \
 			 internal/mithril-protocol-config \
-			 internal/mithril-resource-pool internal/mithril-ticker \
-			 internal/cardano-node/mithril-cardano-node-chain internal/cardano-node/mithril-cardano-node-internal-database \
-			 internal/signed-entity/mithril-signed-entity-lock internal/signed-entity/mithril-signed-entity-preloader \
-			 internal/tests/mithril-api-spec internal/tests/mithril-test-http-server \
-			 demo/protocol-demo \
-			 mithril-test-lab/mithril-aggregator-fake mithril-test-lab/mithril-end-to-end
+			 internal/mithril-resource-pool \
+			 internal/mithril-ticker \
+			 internal/signed-entity/mithril-signed-entity-lock \
+			 internal/signed-entity/mithril-signed-entity-preloader \
+			 internal/tests/mithril-api-spec \
+			 internal/tests/mithril-test-http-server \
+			 mithril-aggregator \
+			 mithril-client \
+			 mithril-client-cli \
+			 mithril-client-wasm \
+			 mithril-common \
+			 mithril-relay \
+			 mithril-signer \
+			 mithril-stm \
+			 mithril-test-lab/mithril-aggregator-fake \
+			 mithril-test-lab/mithril-end-to-end
 GOALS := $(or $(MAKECMDGOALS),all)
 NON_COMPONENT_GOALS := check-format format
 
diff --git a/README.md b/README.md
@@ -80,7 +80,10 @@ This repository consists of the following parts:
 - [**Mithril signer**](./mithril-signer): the node of the **Mithril network** responsible for producing individual signatures that are collected and aggregated by the **Mithril aggregator**.
 
 - [**Internal**](./internal): the shared tools and API used by **Mithril** crates.
-  - [**Mithril aggregator client**](./internal/mithril-aggregator-client): a client to request data from a Mithril Aggregator, used by **Mithril network** nodes and client library.
+
+  - [**Mithril aggregator client**](./internal/mithril-aggregator-client): a client to request data from a Mithril aggregator, used by **Mithril network** nodes and client library.
+
+  - [**Mithril aggregator discovery**](./internal/mithril-aggregator-discovery): mechanisms to discover available Mithril aggregator, used by **Mithril network** nodes and client library.
 
   - [**Mithril build script**](./internal/mithril-build-script): a toolbox for Mithril crates that uses a build script phase.
 
@@ -113,11 +116,13 @@ This repository consists of the following parts:
   - [**Mithril signed entity prealoader**](./internal/signed-entity/mithril-signed-entity-preloader): a **preload** mechanism for the Cardano transaction signed entity, used by **Mithril network** nodes.
 
   - [**tests**](./internal/tests): shared testing tools used by **Mithril** crates.
+
     - [**Mithril api spec**](./internal/tests/mithril-api-spec): toolset to verify conformity of http routes against an Open Api specification, used by **Mithril network** nodes.
 
     - [**Mithril test http server**](internal/tests/mithril-test-http-server): provides a test http server, used by **Mithril network** nodes.
 
 - [**Mithril test lab**](./mithril-test-lab): the suite of tools that allow us to test and stress the **Mithril** protocol implementations.
+
   - [**Mithril devnet**](./mithril-test-lab/mithril-devnet): the private **Mithril/Cardano network** used to scaffold a **Mithril network** on top of a **Cardano network**.
 
   - [**Mithril end to end**](./mithril-test-lab/mithril-end-to-end): the tool used to run test scenarios against a **Mithril devnet**.
diff --git a/internal/mithril-aggregator-discovery/Cargo.toml b/internal/mithril-aggregator-discovery/Cargo.toml
@@ -0,0 +1,30 @@
+[package]
+name = "mithril-aggregator-discovery"
+description = "Mechanisms to discover aggregator available in a Mithril network."
+version = "0.1.0"
+authors.workspace = true
+documentation.workspace = true
+edition.workspace = true
+homepage.workspace = true
+license.workspace = true
+repository.workspace = true
+include = ["**/*.rs", "Cargo.toml", "README.md", ".gitignore"]
+
+[lib]
+crate-type = ["lib", "cdylib", "staticlib"]
+
+[dependencies]
+anyhow = { workspace = true }
+async-trait = { workspace = true }
+mithril-common = { path = "../../mithril-common" }
+serde = { workspace = true }
+slog = { workspace = true }
+slog-scope = "4.4.0"
+thiserror = { workspace = true }
+tokio = { workspace = true, features = ["sync"] }
+
+[dev-dependencies]
+mockall = { workspace = true }
+slog-async = { workspace = true }
+slog-term = { workspace = true }
+tokio = { workspace = true, features = ["macros"] }
diff --git a/internal/mithril-aggregator-discovery/Makefile b/internal/mithril-aggregator-discovery/Makefile
@@ -0,0 +1,19 @@
+.PHONY: all build test check doc
+
+CARGO = cargo
+
+all: test build
+
+build:
+	${CARGO} build --release
+
+test:
+	${CARGO} test
+
+check:
+	${CARGO} check --release --all-features --all-targets
+	${CARGO} clippy --release --all-features --all-targets
+	${CARGO} fmt --check
+
+doc:
+	${CARGO} doc --no-deps --open
diff --git a/internal/mithril-aggregator-discovery/README.md b/internal/mithril-aggregator-discovery/README.md
@@ -0,0 +1,3 @@
+# Mithril-aggregator-discovery
+
+This crate provides mechanisms to discover aggregators in a Mithril network.
diff --git a/internal/mithril-aggregator-discovery/src/lib.rs b/internal/mithril-aggregator-discovery/src/lib.rs
@@ -0,0 +1,2 @@
+#![warn(missing_docs)]
+//! This crate provides mechanisms to discover aggregators in a Mithril network.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Mithril-aggregator-discovery`
	`2`	`+`
	`3`	`+This crate provides mechanisms to discover aggregators in a Mithril network.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+#![warn(missing_docs)]`
	`2`	`+//! This crate provides mechanisms to discover aggregators in a Mithril network.`