ETCM-12351 Dolos data sources stub crate (#1031)

Author: kpinter-iohk

Cargo.lock

@@ -321,7 +321,9 @@ sp-block-producer-metadata = { path = "toolkit/block-producer-metadata/primitive
 
 # Data Sources
 partner-chains-db-sync-data-sources = { path = "toolkit/data-sources/db-sync" }
+partner-chains-dolos-data-sources = { path = "toolkit/data-sources/dolos" }
 partner-chains-mock-data-sources = { path = "toolkit/data-sources/mock", default-features = false }
+partner-chains-data-source-metrics = { path = "toolkit/data-sources/metrics" }
 
 # Governed Map
 sp-governed-map = { path = "toolkit/governed-map/primitives", default-features = false }

Cargo.toml

@@ -101,6 +101,15 @@ partner-chains-db-sync-data-sources = { workspace = true, features = [
 	"block-participation",
 	"bridge",
 ] }
+partner-chains-dolos-data-sources = { workspace = true, features = [
+	"block-source",
+	"candidate-source",
+	"governed-map",
+	"mc-hash",
+	"sidechain-rpc",
+	"block-participation",
+	"bridge",
+] }
 partner-chains-mock-data-sources = { workspace = true, features = [
 	"block-source",
 	"candidate-source",
@@ -110,6 +119,7 @@ partner-chains-mock-data-sources = { workspace = true, features = [
 	"block-participation",
 	"bridge",
 ] }
+partner-chains-data-source-metrics = { workspace = true }
 tokio = { workspace = true }
 sp-block-participation = { workspace = true, features = ["std"] }
 sp-block-producer-metadata = { workspace = true, features = ["std"] }

demo/node/Cargo.toml

@@ -1,16 +1,7 @@
 use authority_selection_inherents::AuthoritySelectionDataSource;
 use pallet_sidechain_rpc::SidechainRpcDataSource;
-use partner_chains_db_sync_data_sources::{
-	BlockDataSourceImpl, CachedTokenBridgeDataSourceImpl, CandidatesDataSourceImpl,
-	GovernedMapDataSourceCachedImpl, McFollowerMetrics, McHashDataSourceImpl,
-	SidechainRpcDataSourceImpl, StakeDistributionDataSourceImpl,
-};
+use partner_chains_data_source_metrics::McFollowerMetrics;
 use partner_chains_demo_runtime::AccountId;
-use partner_chains_mock_data_sources::{
-	AuthoritySelectionDataSourceMock, BlockDataSourceMock, GovernedMapDataSourceMock,
-	McHashDataSourceMock, SidechainRpcDataSourceMock, StakeDistributionDataSourceMock,
-	TokenBridgeDataSourceMock,
-};
 use sc_service::error::Error as ServiceError;
 use sidechain_mc_hash::McHashDataSource;
 use sp_block_participation::inherent_data::BlockParticipationDataSource;
@@ -90,14 +81,15 @@ pub(crate) async fn create_cached_data_sources(
 			ServiceError::Application(format!("Failed to create mock data sources: {err}").into())
 		}),
 
-		DataSourceType::Dolos => {
-			Err(ServiceError::Application("Dolos data source is not implemented yet.".into()))
-		},
+		DataSourceType::Dolos => create_dolos_data_sources().map_err(|err| {
+			ServiceError::Application(format!("Failed to create dolos data sources: {err}").into())
+		}),
 	}
 }
 
 pub fn create_mock_data_sources()
 -> std::result::Result<DataSources, Box<dyn Error + Send + Sync + 'static>> {
+	use partner_chains_mock_data_sources::*;
 	let block = Arc::new(BlockDataSourceMock::new_from_env()?);
 	Ok(DataSources {
 		sidechain_rpc: Arc::new(SidechainRpcDataSourceMock::new(block.clone())),
@@ -109,6 +101,19 @@ pub fn create_mock_data_sources()
 	})
 }
 
+pub fn create_dolos_data_sources()
+-> std::result::Result<DataSources, Box<dyn Error + Send + Sync + 'static>> {
+	use partner_chains_dolos_data_sources::*;
+	Ok(DataSources {
+		sidechain_rpc: Arc::new(SidechainRpcDataSourceImpl::new()),
+		mc_hash: Arc::new(McHashDataSourceImpl::new()),
+		authority_selection: Arc::new(AuthoritySelectionDataSourceImpl::new()),
+		block_participation: Arc::new(StakeDistributionDataSourceImpl::new()),
+		governed_map: Arc::new(GovernedMapDataSourceImpl::default()),
+		bridge: Arc::new(TokenBridgeDataSourceImpl::new()),
+	})
+}
+
 pub const CANDIDATES_FOR_EPOCH_CACHE_SIZE: usize = 64;
 pub const STAKE_CACHE_SIZE: usize = 100;
 pub const GOVERNED_MAP_CACHE_SIZE: u16 = 100;
@@ -117,6 +122,7 @@ pub const BRIDGE_TRANSFER_CACHE_LOOKAHEAD: u32 = 1000;
 pub async fn create_cached_db_sync_data_sources(
 	metrics_opt: Option<McFollowerMetrics>,
 ) -> Result<DataSources, Box<dyn Error + Send + Sync + 'static>> {
+	use partner_chains_db_sync_data_sources::*;
 	let pool = partner_chains_db_sync_data_sources::get_connection_from_env().await?;
 	// block data source is reused between mc_hash and sidechain_rpc to share cache
 	let block = Arc::new(BlockDataSourceImpl::new_from_env(pool.clone()).await?);

demo/node/src/data_sources.rs

@@ -4,8 +4,7 @@ use crate::data_sources::DataSources;
 use crate::inherent_data::{CreateInherentDataConfig, ProposalCIDP, VerifierCIDP};
 use crate::rpc::GrandpaDeps;
 use authority_selection_inherents::AuthoritySelectionDataSource;
-use partner_chains_db_sync_data_sources::McFollowerMetrics;
-use partner_chains_db_sync_data_sources::register_metrics_warn_errors;
+use partner_chains_data_source_metrics::{McFollowerMetrics, register_metrics_warn_errors};
 use partner_chains_demo_runtime::{self, RuntimeApi, opaque::Block};
 use sc_client_api::BlockBackend;
 use sc_consensus_aura::{ImportQueueParams, SlotProportion, StartAuraParams};

demo/node/src/service.rs

@@ -30,29 +30,32 @@ log = { workspace = true }
 thiserror = { workspace = true }
 blake2b_simd = { workspace = true }
 figment = { workspace = true }
-substrate-prometheus-endpoint = { workspace = true }
 derive-new = { workspace = true }
 lru = { workspace = true }
 sp-timestamp = { workspace = true, features = ["std"] }
-sp-governed-map = { workspace = true, features = [
-    "std",
-], optional = true }
+sp-governed-map = { workspace = true, features = ["std"], optional = true }
 sidechain-mc-hash = { workspace = true, optional = true }
 pallet-sidechain-rpc = { workspace = true, optional = true }
 authority-selection-inherents = { workspace = true, features = [
     "std",
 ], optional = true }
 cardano-serialization-lib = { workspace = true }
+partner-chains-data-source-metrics = { workspace = true }
 partner-chains-plutus-data = { workspace = true }
 sp-block-participation = { workspace = true, features = [
     "std",
 ], optional = true }
-sp-partner-chains-bridge = { workspace = true, optional = true, features = ["std"] }
+sp-partner-chains-bridge = { workspace = true, optional = true, features = [
+    "std",
+] }
 
 [dev-dependencies]
 tokio-test = "0.4.3"
 ctor = "0.5.0"
-testcontainers-modules = { version = "0.13.0", features = ["blocking", "postgres"] }
+testcontainers-modules = { version = "0.13.0", features = [
+    "blocking",
+    "postgres",
+] }
 pretty_assertions = { workspace = true }
 paste = { workspace = true }
 

toolkit/data-sources/db-sync/Cargo.toml

@@ -14,6 +14,7 @@
 //! # Usage
 //!
 //! ```rust
+//! use partner_chains_data_source_metrics::*;
 //! use partner_chains_db_sync_data_sources::*;
 //! use sqlx::PgPool;
 //! use std::{ error::Error, sync::Arc };
@@ -42,9 +43,8 @@
 //! }
 //! ```
 
-use crate::McFollowerMetrics;
 use crate::db_model::*;
-use crate::metrics::observed_async_trait;
+use partner_chains_data_source_metrics::{McFollowerMetrics, observed_async_trait};
 use partner_chains_plutus_data::bridge::{TokenTransferDatum, TokenTransferDatumV1};
 use sidechain_domain::McBlockHash;
 use sp_partner_chains_bridge::*;

toolkit/data-sources/db-sync/src/bridge/mod.rs

@@ -4,10 +4,10 @@ use crate::db_model::{
 	self, Address, Asset, BlockNumber, DbSyncConfigurationProvider, EpochNumber, MainchainTxOutput,
 	StakePoolEntry,
 };
-use crate::metrics::{McFollowerMetrics, observed_async_trait};
 use authority_selection_inherents::*;
 use itertools::Itertools;
 use log::error;
+use partner_chains_data_source_metrics::{McFollowerMetrics, observed_async_trait};
 use partner_chains_plutus_data::{
 	d_param::DParamDatum, permissioned_candidates::PermissionedCandidateDatums,
 	registered_candidates::RegisterValidatorDatum,

toolkit/data-sources/db-sync/src/candidates/mod.rs

@@ -1,8 +1,8 @@
 use crate::candidates::CandidatesDataSourceImpl;
 use crate::db_model::{DbSyncConfigurationProvider, TxInConfiguration, index_exists_unsafe};
-use crate::metrics::mock::test_metrics;
 use authority_selection_inherents::AuthoritySelectionDataSource;
 use hex_literal::hex;
+use partner_chains_data_source_metrics::mock::test_metrics;
 use sidechain_domain::*;
 use sqlx::PgPool;
 use std::cell::OnceCell;

toolkit/data-sources/db-sync/src/candidates/tests.rs

@@ -3,10 +3,10 @@ use crate::DataSourceError::ExpectedDataNotFound;
 use crate::Result;
 use crate::block::BlockDataSourceImpl;
 use crate::db_model::{DbSyncConfigurationProvider, GovernedMapAction, TxInConfiguration};
-use crate::metrics::{McFollowerMetrics, observed_async_trait};
 use db_sync_sqlx::{Asset, BlockNumber};
 use itertools::Itertools;
 use log::warn;
+use partner_chains_data_source_metrics::{McFollowerMetrics, observed_async_trait};
 use partner_chains_plutus_data::governed_map::GovernedMapDatum;
 use sidechain_domain::byte_string::ByteString;
 use sidechain_domain::*;