address comments

Author: kpinter-iohk

toolkit/data-sources/dolos/src/block.rs

@@ -6,6 +6,7 @@ use crate::{
 use chrono::{DateTime, NaiveDateTime, TimeDelta};
 use derive_new::new;
 use figment::{Figment, providers::Env};
+use futures::TryFutureExt;
 use log::{debug, info};
 use serde::Deserialize;
 use sidechain_domain::mainchain_epoch::{MainchainEpochConfig, MainchainEpochDerivation};
@@ -34,8 +35,7 @@ pub struct BlockDataSourceImpl {
 	mainchain_epoch_config: MainchainEpochConfig,
 	/// Additional offset applied when selecting the latest stable Cardano block
 	///
-	/// This parameter should be 0 by default and should only be increased to 1 in networks
-	/// struggling with frequent block rejections due to Db-Sync or Cardano node lag.
+	/// This parameter should be 1 by default.
 	block_stability_margin: u32,
 	/// Number of contiguous Cardano blocks to be cached by this data source
 	cache_size: u16,
@@ -44,14 +44,14 @@ pub struct BlockDataSourceImpl {
 }
 
 impl BlockDataSourceImpl {
-	/// Returns the latest _unstable_ Cardano block from the Db-Sync database
+	/// Returns the latest _unstable_ Cardano block from Dolos
 	pub async fn get_latest_block_info(&self) -> Result<MainchainBlock> {
-		self.client.blocks_latest().await.and_then(from_block_content).map_err(|e| {
+		self.client.blocks_latest().await.map_err(|e| {
 			DataSourceError::ExpectedDataNotFound(format!("No latest block on chain. {e}",)).into()
-		})
+		}).and_then(from_block_content)
 	}
 
-	/// Returns the latest _stable_ Cardano block from the Db-Sync database that is within
+	/// Returns the latest _stable_ Cardano block from Dolos that is within
 	/// acceptable bounds from `reference_timestamp`, accounting for the additional stability
 	/// offset configured by [block_stability_margin][Self::block_stability_margin].
 	pub async fn get_latest_stable_block_for(
@@ -94,22 +94,14 @@ impl BlockDataSourceImpl {
 
 /// Configuration for [BlockDataSourceImpl]
 #[derive(Debug, Clone, Deserialize)]
-pub struct DbSyncBlockDataSourceConfig {
-	/// Cardano security parameter, ie. the number of confirmations needed to stabilize a block
-	pub cardano_security_parameter: u32,
-	/// Expected fraction of Cardano slots that will have a block produced
-	///
-	/// This value can be found in `shelley-genesis.json` file used by the Cardano node,
-	/// example: `"activeSlotsCoeff": 0.05`.
-	pub cardano_active_slots_coeff: f64,
+pub struct DolosBlockDataSourceConfig {
 	/// Additional offset applied when selecting the latest stable Cardano block
 	///
-	/// This parameter should be 0 by default and should only be increased to 1 in networks
-	/// struggling with frequent block rejections due to Db-Sync or Cardano node lag.
+	/// This parameter should be 1 by default.
 	pub block_stability_margin: u32,
 }
 
-impl DbSyncBlockDataSourceConfig {
+impl DolosBlockDataSourceConfig {
 	/// Reads the config from environment
 	pub fn from_env() -> std::result::Result<Self, Box<dyn Error + Send + Sync + 'static>> {
 		let config: Self = Figment::new()
@@ -126,38 +118,39 @@ impl BlockDataSourceImpl {
 	pub async fn new_from_env(
 		client: MiniBFClient,
 	) -> std::result::Result<Self, Box<dyn Error + Send + Sync + 'static>> {
-		Ok(Self::from_config(
+		Self::from_config(
 			client,
-			DbSyncBlockDataSourceConfig::from_env()?,
+			DolosBlockDataSourceConfig::from_env()?,
 			&read_mc_epoch_config()?,
-		))
+		).await
 	}
 
 	/// Creates a new instance of [BlockDataSourceImpl], using passed configuration.
-	pub fn from_config(
+	pub async fn from_config(
 		client: MiniBFClient,
-		DbSyncBlockDataSourceConfig {
-			cardano_security_parameter,
-			cardano_active_slots_coeff,
+		DolosBlockDataSourceConfig {
 			block_stability_margin,
-		}: DbSyncBlockDataSourceConfig,
+		}: DolosBlockDataSourceConfig,
 		mc_epoch_config: &MainchainEpochConfig,
-	) -> BlockDataSourceImpl {
-		let k: f64 = cardano_security_parameter.into();
+	) -> Result<BlockDataSourceImpl> {
+		let genesis = client.genesis().await?;
+		let active_slots_coeff = genesis.active_slots_coefficient;
+		let security_parameter = genesis.security_param as u32;
+		let k: f64 = security_parameter.into();
 		let slot_duration: f64 = mc_epoch_config.slot_duration_millis.millis() as f64;
-		let min_slot_boundary = (slot_duration * k / cardano_active_slots_coeff).round() as i64;
+		let min_slot_boundary = (slot_duration * k / active_slots_coeff).round() as i64;
 		let max_slot_boundary = 3 * min_slot_boundary;
 		let cache_size = 100;
-		BlockDataSourceImpl::new(
-			client,
-			cardano_security_parameter,
-			TimeDelta::milliseconds(min_slot_boundary),
-			TimeDelta::milliseconds(max_slot_boundary),
-			mc_epoch_config.clone(),
-			block_stability_margin,
-			cache_size,
-			BlocksCache::new_arc_mutex(),
-		)
+		Ok(BlockDataSourceImpl::new(
+					client,
+					security_parameter,
+					TimeDelta::milliseconds(min_slot_boundary),
+					TimeDelta::milliseconds(max_slot_boundary),
+					mc_epoch_config.clone(),
+					block_stability_margin,
+					cache_size,
+					BlocksCache::new_arc_mutex(),
+				))
 	}
 	async fn get_latest_block(
 		&self,
@@ -221,7 +214,7 @@ impl BlockDataSourceImpl {
 			debug!("Block by hash: {hash} found in cache.");
 			Ok(Some(From::from(block)))
 		} else {
-			debug!("Block by hash: {hash}, not found in cache, serving from database.");
+			debug!("Block by hash: {hash}, not found in cache, serving from Dolos.");
 			if let Some(block_by_hash) =
 				self.get_stable_block_by_hash_from_db(hash, reference_timestamp).await?
 			{
@@ -276,6 +269,7 @@ impl BlockDataSourceImpl {
 			let futures = (from_block_no.0..=to_block_no.0).map(|block_no| async move {
 				self.client
 					.blocks_by_id(McBlockNumber(block_no))
+					.map_err(|e| e.into())
 					.await
 					.and_then(from_block_content)
 			});

toolkit/data-sources/dolos/src/client/api.rs

@@ -1,12 +1,6 @@
 use async_trait::async_trait;
 use blockfrost_openapi::models::{
-	address_transactions_content_inner::AddressTransactionsContentInner,
-	address_utxo_content_inner::AddressUtxoContentInner,
-	asset_addresses_inner::AssetAddressesInner, asset_transactions_inner::AssetTransactionsInner,
-	block_content::BlockContent, epoch_param_content::EpochParamContent,
-	epoch_stake_pool_content_inner::EpochStakePoolContentInner,
-	pool_history_inner::PoolHistoryInner, pool_list_extended_inner::PoolListExtendedInner,
-	tx_content::TxContent, tx_content_utxo::TxContentUtxo,
+	address_transactions_content_inner::AddressTransactionsContentInner, address_utxo_content_inner::AddressUtxoContentInner, asset_addresses_inner::AssetAddressesInner, asset_transactions_inner::AssetTransactionsInner, block_content::BlockContent, epoch_param_content::EpochParamContent, epoch_stake_pool_content_inner::EpochStakePoolContentInner, genesis_content::GenesisContent, pool_history_inner::PoolHistoryInner, pool_list_extended_inner::PoolListExtendedInner, tx_content::TxContent, tx_content_utxo::TxContentUtxo
 };
 use sidechain_domain::*;
 
@@ -111,4 +105,7 @@ pub trait MiniBFApi {
 	async fn transaction_by_hash(&self, tx_hash: McTxHash) -> Result<TxContent, String>;
 	/// Return the inputs and UTXOs of the specific transaction.
 	async fn transactions_utxos(&self, tx_hash: McTxHash) -> Result<TxContentUtxo, String>;
+
+	/// Return the information about blockchain genesis.
+	async fn genesis(&self) -> Result<GenesisContent, String>;
 }

toolkit/data-sources/dolos/src/client/conversions.rs

@@ -1,21 +1,22 @@
 use blockfrost_openapi::models::block_content::BlockContent;
 use sidechain_domain::*;
+use crate::{Result, DataSourceError};
 
-pub fn from_block_content(value: BlockContent) -> Result<MainchainBlock, String> {
+pub fn from_block_content(value: BlockContent) -> Result<MainchainBlock> {
 	Ok(MainchainBlock {
 		number: value
 			.height
 			.map(|n| sidechain_domain::McBlockNumber(n as u32))
-			.ok_or("number missing")?,
+			.ok_or(DataSourceError::InvalidData("number missing".to_string()))?,
 		hash: McBlockHash::decode_hex(&value.hash)?,
 		epoch: value
 			.epoch
 			.map(|n| sidechain_domain::McEpochNumber(n as u32))
-			.ok_or("epoch missing")?,
+			.ok_or(DataSourceError::InvalidData("epoch missing".to_string()))?,
 		slot: value
 			.slot
 			.map(|n| sidechain_domain::McSlotNumber(n as u64))
-			.ok_or("slot missing")?,
+			.ok_or(DataSourceError::InvalidData("slot missing".to_string()))?,
 		timestamp: value.time as u64,
 	})
 }

toolkit/data-sources/dolos/src/client/minibf.rs

@@ -1,12 +1,6 @@
 use async_trait::async_trait;
 use blockfrost_openapi::models::{
-	address_transactions_content_inner::AddressTransactionsContentInner,
-	address_utxo_content_inner::AddressUtxoContentInner,
-	asset_addresses_inner::AssetAddressesInner, asset_transactions_inner::AssetTransactionsInner,
-	block_content::BlockContent, epoch_param_content::EpochParamContent,
-	epoch_stake_pool_content_inner::EpochStakePoolContentInner,
-	pool_history_inner::PoolHistoryInner, pool_list_extended_inner::PoolListExtendedInner,
-	tx_content::TxContent, tx_content_utxo::TxContentUtxo,
+	address_transactions_content_inner::AddressTransactionsContentInner, address_utxo_content_inner::AddressUtxoContentInner, asset_addresses_inner::AssetAddressesInner, asset_transactions_inner::AssetTransactionsInner, block_content::BlockContent, epoch_param_content::EpochParamContent, epoch_stake_pool_content_inner::EpochStakePoolContentInner, genesis_content::GenesisContent, pool_history_inner::PoolHistoryInner, pool_list_extended_inner::PoolListExtendedInner, tx_content::TxContent, tx_content_utxo::TxContentUtxo
 };
 use serde::de::DeserializeOwned;
 use sidechain_domain::*;
@@ -188,6 +182,10 @@ impl MiniBFApi for MiniBFClient {
 	async fn transactions_utxos(&self, tx_hash: McTxHash) -> Result<TxContentUtxo, String> {
 		self.request(&format!("txs/{tx_hash}/utxos")).await
 	}
+
+	async fn genesis(&self) -> Result<GenesisContent, String> {
+		self.request(&format!("genesis")).await
+	}
 }
 
 fn format_asset_id(asset_id: &AssetId) -> String {

toolkit/data-sources/dolos/src/lib.rs

@@ -45,7 +45,7 @@ pub enum DataSourceError {
 	/// Indicates that Dolos rejected a request as invalid
 	#[error("Bad request: `{0}`.")]
 	BadRequest(String),
-	/// Indicates that an internal error occured when querying Dolos
+	/// Indicates that an internal error occurred when querying Dolos
 	#[error("Internal error of data source: `{0}`.")]
 	InternalDataSourceError(String),
 	/// Indicates that expected data was not found when querying Dolos