better errors

Author: kpinter-iohk

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

@@ -6,7 +6,6 @@ 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};
@@ -46,9 +45,14 @@ pub struct BlockDataSourceImpl {
 impl BlockDataSourceImpl {
 	/// Returns the latest _unstable_ Cardano block from Dolos
 	pub async fn get_latest_block_info(&self) -> Result<MainchainBlock> {
-		self.client.blocks_latest().await.map_err(|e| {
-			DataSourceError::ExpectedDataNotFound(format!("No latest block on chain. {e}",)).into()
-		}).and_then(from_block_content)
+		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 Dolos that is within
@@ -118,19 +122,14 @@ impl BlockDataSourceImpl {
 	pub async fn new_from_env(
 		client: MiniBFClient,
 	) -> std::result::Result<Self, Box<dyn Error + Send + Sync + 'static>> {
-		Self::from_config(
-			client,
-			DolosBlockDataSourceConfig::from_env()?,
-			&read_mc_epoch_config()?,
-		).await
+		Self::from_config(client, DolosBlockDataSourceConfig::from_env()?, &read_mc_epoch_config()?)
+			.await
 	}
 
 	/// Creates a new instance of [BlockDataSourceImpl], using passed configuration.
 	pub async fn from_config(
 		client: MiniBFClient,
-		DolosBlockDataSourceConfig {
-			block_stability_margin,
-		}: DolosBlockDataSourceConfig,
+		DolosBlockDataSourceConfig { block_stability_margin }: DolosBlockDataSourceConfig,
 		mc_epoch_config: &MainchainEpochConfig,
 	) -> Result<BlockDataSourceImpl> {
 		let genesis = client.genesis().await?;
@@ -142,15 +141,15 @@ impl BlockDataSourceImpl {
 		let max_slot_boundary = 3 * min_slot_boundary;
 		let cache_size = 100;
 		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(),
-				))
+			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,
@@ -269,8 +268,8 @@ 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
+					.map_err(|e| e.into())
 					.and_then(from_block_content)
 			});
 			futures::future::try_join_all(futures).await?.into_iter().collect()

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

@@ -1,9 +1,17 @@
 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, genesis_content::GenesisContent, 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::*;
 
+use crate::DataSourceError;
+
 /// Mainchain block id, either a block hash or a block number
 pub enum McBlockId {
 	/// Domain type Mainchain block hash
@@ -49,63 +57,79 @@ pub trait MiniBFApi {
 	async fn addresses_utxos(
 		&self,
 		address: MainchainAddress,
-	) -> Result<Vec<AddressUtxoContentInner>, String>;
+	) -> Result<Vec<AddressUtxoContentInner>, DataSourceError>;
 	/// Transactions on the address.
 	async fn addresses_transactions(
 		&self,
 		address: MainchainAddress,
-	) -> Result<Vec<AddressTransactionsContentInner>, String>;
+	) -> Result<Vec<AddressTransactionsContentInner>, DataSourceError>;
 
 	/// List of a specific asset transactions.
 	async fn assets_transactions(
 		&self,
 		asset_id: AssetId,
-	) -> Result<Vec<AssetTransactionsInner>, String>;
+	) -> Result<Vec<AssetTransactionsInner>, DataSourceError>;
 	/// List of a addresses containing a specific asset.
-	async fn assets_addresses(&self, asset_id: AssetId)
-	-> Result<Vec<AssetAddressesInner>, String>;
+	async fn assets_addresses(
+		&self,
+		asset_id: AssetId,
+	) -> Result<Vec<AssetAddressesInner>, DataSourceError>;
 
 	/// Return the latest block available to the backends, also known as the tip of the blockchain.
-	async fn blocks_latest(&self) -> Result<BlockContent, String>;
+	async fn blocks_latest(&self) -> Result<BlockContent, DataSourceError>;
 	/// Return the content of a requested block.
-	async fn blocks_by_id(&self, id: impl Into<McBlockId> + Send) -> Result<BlockContent, String>;
+	async fn blocks_by_id(
+		&self,
+		id: impl Into<McBlockId> + Send,
+	) -> Result<BlockContent, DataSourceError>;
 	/// Return the content of a requested block for a specific slot.
-	async fn blocks_slot(&self, slot_number: McSlotNumber) -> Result<BlockContent, String>;
+	async fn blocks_slot(&self, slot_number: McSlotNumber)
+	-> Result<BlockContent, DataSourceError>;
 	/// Return the list of blocks following a specific block.
 	async fn blocks_next(
 		&self,
 		hash: impl Into<McBlockId> + Send,
-	) -> Result<Vec<BlockContent>, String>;
+	) -> Result<Vec<BlockContent>, DataSourceError>;
 	/// Return the transactions within the block.
-	async fn blocks_txs(&self, id: impl Into<McBlockId> + Send) -> Result<Vec<String>, String>;
+	async fn blocks_txs(
+		&self,
+		id: impl Into<McBlockId> + Send,
+	) -> Result<Vec<String>, DataSourceError>;
 
 	/// Return the blocks minted for the epoch specified.
-	async fn epochs_blocks(&self, epoch_number: McEpochNumber) -> Result<Vec<String>, String>;
+	async fn epochs_blocks(
+		&self,
+		epoch_number: McEpochNumber,
+	) -> Result<Vec<String>, DataSourceError>;
 	/// Return the protocol parameters for the epoch specified.
 	async fn epochs_parameters(
 		&self,
 		epoch_number: McEpochNumber,
-	) -> Result<EpochParamContent, String>;
+	) -> Result<EpochParamContent, DataSourceError>;
 	/// Return the active stake distribution for the epoch specified by stake pool.
 	async fn epochs_stakes_by_pool(
 		&self,
 		epoch_number: McEpochNumber,
 		pool_id: &str,
-	) -> Result<Vec<EpochStakePoolContentInner>, String>;
+	) -> Result<Vec<EpochStakePoolContentInner>, DataSourceError>;
 
 	/// History of stake pool parameters over epochs.
-	async fn pools_history(&self, pool_id: &str) -> Result<Vec<PoolHistoryInner>, String>;
+	async fn pools_history(&self, pool_id: &str) -> Result<Vec<PoolHistoryInner>, DataSourceError>;
 	/// List of registered stake pools with additional information.
-	async fn pools_extended(&self) -> Result<Vec<PoolListExtendedInner>, String>;
+	async fn pools_extended(&self) -> Result<Vec<PoolListExtendedInner>, DataSourceError>;
 
 	/// Query JSON value of a datum by its hash.
-	async fn scripts_datum_hash(&self, datum_hash: &str) -> Result<Vec<serde_json::Value>, String>;
+	async fn scripts_datum_hash(
+		&self,
+		datum_hash: &str,
+	) -> Result<Vec<serde_json::Value>, DataSourceError>;
 
 	/// Return content of the requested transaction.
-	async fn transaction_by_hash(&self, tx_hash: McTxHash) -> Result<TxContent, String>;
+	async fn transaction_by_hash(&self, tx_hash: McTxHash) -> Result<TxContent, DataSourceError>;
 	/// Return the inputs and UTXOs of the specific transaction.
-	async fn transactions_utxos(&self, tx_hash: McTxHash) -> Result<TxContentUtxo, String>;
+	async fn transactions_utxos(&self, tx_hash: McTxHash)
+	-> Result<TxContentUtxo, DataSourceError>;
 
 	/// Return the information about blockchain genesis.
-	async fn genesis(&self) -> Result<GenesisContent, String>;
+	async fn genesis(&self) -> Result<GenesisContent, DataSourceError>;
 }