Scope signer services import to the services module

Instead of reexporting them directly at the lib root.

Author: Alenar

mithril-signer/src/database/repository/cardano_transaction_repository.rs

@@ -9,7 +9,7 @@ use mithril_common::entities::{
 use mithril_common::StdResult;
 use mithril_persistence::database::repository::CardanoTransactionRepository;
 
-use crate::{HighestTransactionBlockNumberGetter, TransactionPruner, TransactionStore};
+use crate::services::{HighestTransactionBlockNumberGetter, TransactionPruner, TransactionStore};
 
 #[async_trait]
 impl TransactionStore for CardanoTransactionRepository {

mithril-signer/src/dependency_injection/builder.rs

@@ -36,11 +36,13 @@ use mithril_persistence::store::adapter::SQLiteAdapter;
 use mithril_persistence::store::StakeStore;
 
 use crate::dependency_injection::SignerDependencyContainer;
-use crate::{
+use crate::services::{
     AggregatorHTTPClient, CardanoTransactionsImporter,
-    CardanoTransactionsPreloaderActivationSigner, Configuration, MKTreeStoreSqlite, MetricsService,
-    MithrilSingleSigner, ProtocolInitializerStore, SignerUpkeepService,
+    CardanoTransactionsPreloaderActivationSigner, MithrilSingleSigner, SignerUpkeepService,
     TransactionsImporterByChunk, TransactionsImporterWithPruner, TransactionsImporterWithVacuum,
+};
+use crate::{
+    Configuration, MKTreeStoreSqlite, MetricsService, ProtocolInitializerStore,
     HTTP_REQUEST_TIMEOUT_DURATION, SQLITE_FILE, SQLITE_FILE_CARDANO_TRANSACTION,
 };
 

mithril-signer/src/dependency_injection/containers.rs

@@ -10,9 +10,8 @@ use mithril_common::signed_entity_type_lock::SignedEntityTypeLock;
 use mithril_common::TickerService;
 use mithril_persistence::store::StakeStore;
 
-use crate::{
-    AggregatorClient, MetricsService, ProtocolInitializerStorer, SingleSigner, UpkeepService,
-};
+use crate::services::{AggregatorClient, SingleSigner, UpkeepService};
+use crate::{MetricsService, ProtocolInitializerStorer};
 
 type StakeStoreService = Arc<StakeStore>;
 type CertificateHandlerService = Arc<dyn AggregatorClient>;

mithril-signer/src/lib.rs

@@ -14,7 +14,7 @@ pub mod metrics;
 mod mktree_store_sqlite;
 mod protocol_initializer_store;
 mod runtime;
-mod services;
+pub mod services;
 
 pub use configuration::{Configuration, DefaultConfiguration};
 pub use message_adapters::{
@@ -24,7 +24,6 @@ pub use metrics::*;
 pub use mktree_store_sqlite::*;
 pub use protocol_initializer_store::{ProtocolInitializerStore, ProtocolInitializerStorer};
 pub use runtime::*;
-pub use services::*;
 
 /// HTTP request timeout duration in milliseconds
 const HTTP_REQUEST_TIMEOUT_DURATION: u64 = 30000;

mithril-signer/src/runtime/runner.rs

@@ -15,7 +15,8 @@ use mithril_common::StdResult;
 use mithril_persistence::store::StakeStorer;
 
 use crate::dependency_injection::SignerDependencyContainer;
-use crate::{Configuration, MithrilProtocolInitializerBuilder};
+use crate::services::MithrilProtocolInitializerBuilder;
+use crate::Configuration;
 
 /// This trait is mainly intended for mocking.
 #[async_trait]
@@ -491,11 +492,11 @@ mod tests {
     use mockall::mock;
     use std::{path::Path, sync::Arc};
 
-    use crate::{
-        metrics::MetricsService, AggregatorClient, CardanoTransactionsImporter,
-        DumbAggregatorClient, MithrilSingleSigner, MockAggregatorClient, MockTransactionStore,
-        MockUpkeepService, ProtocolInitializerStore, SingleSigner,
+    use crate::services::{
+        AggregatorClient, CardanoTransactionsImporter, DumbAggregatorClient, MithrilSingleSigner,
+        MockAggregatorClient, MockTransactionStore, MockUpkeepService, SingleSigner,
     };
+    use crate::{metrics::MetricsService, ProtocolInitializerStore};
 
     use super::*;
 

mithril-signer/src/services/cardano_transactions_preloader_checker.rs

@@ -8,7 +8,7 @@ use mithril_common::{
     entities::SignedEntityTypeDiscriminants, StdResult,
 };
 
-use crate::AggregatorClient;
+use crate::services::AggregatorClient;
 
 /// CardanoTransactionsPreloaderActivationSigner
 pub struct CardanoTransactionsPreloaderActivationSigner {
@@ -47,7 +47,7 @@ mod tests {
         entities::SignedEntityTypeDiscriminants, messages::AggregatorFeaturesMessage,
     };
 
-    use crate::{AggregatorClientError, MockAggregatorClient};
+    use crate::services::{AggregatorClientError, MockAggregatorClient};
 
     use super::*;
 

mithril-signer/src/services/mod.rs

@@ -1,3 +1,14 @@
+//! # Services
+//!
+//! This module regroups services. Services are adapters in charge of the different  bounded contexts of the application:
+//!
+//! * Aggregator Client: communicate with the Aggregator
+//! * Cardano Transaction Importer: Import transactions from the Cardano chain
+//! * Single Signer: create single signatures
+//! * Upkeep: perform maintenance tasks
+//!
+//! Each service is defined by a public API (a trait) that is used in the controllers (runtimes).
+
 mod aggregator_client;
 mod cardano_transactions_importer;
 mod cardano_transactions_preloader_checker;

mithril-signer/tests/test_extensions/certificate_handler.rs

@@ -11,7 +11,7 @@ use mithril_common::{
     test_utils::fake_data,
     MithrilTickerService, TickerService,
 };
-use mithril_signer::{AggregatorClient, AggregatorClientError};
+use mithril_signer::services::{AggregatorClient, AggregatorClientError};
 use tokio::sync::RwLock;
 
 pub struct FakeAggregator {

mithril-signer/tests/test_extensions/state_machine_tester.rs

@@ -36,9 +36,11 @@ use mithril_persistence::{
 use mithril_signer::{
     dependency_injection::{ProductionDependenciesBuilder, SignerDependencyContainer},
     metrics::*,
-    AggregatorClient, CardanoTransactionsImporter, Configuration, MKTreeStoreSqlite,
-    MetricsService, MithrilSingleSigner, ProtocolInitializerStore, ProtocolInitializerStorer,
-    RuntimeError, SignerRunner, SignerState, SignerUpkeepService, StateMachine,
+    services::{
+        AggregatorClient, CardanoTransactionsImporter, MithrilSingleSigner, SignerUpkeepService,
+    },
+    Configuration, MKTreeStoreSqlite, MetricsService, ProtocolInitializerStore,
+    ProtocolInitializerStorer, RuntimeError, SignerRunner, SignerState, StateMachine,
 };
 
 use super::FakeAggregator;