use boxed error for native token IDP error (#153)

Author: AmbientTea

mainchain-follower/db-sync-follower/src/native_token/mod.rs

@@ -25,8 +25,6 @@ pub struct NativeTokenManagementDataSourceImpl {
 
 observed_async_trait!(
 impl NativeTokenManagementDataSource for NativeTokenManagementDataSourceImpl {
-	type Error = DataSourceError;
-
 	// after_block is always less or equal to_block
 	// to_block is always a stable block
 	async fn get_total_native_token_transfer(
@@ -36,7 +34,7 @@ impl NativeTokenManagementDataSource for NativeTokenManagementDataSourceImpl {
 		policy_id: PolicyId,
 		asset_name: AssetName,
 		address: MainchainAddress,
-	) -> std::result::Result<NativeTokenAmount, Self::Error> {
+	) -> std::result::Result<NativeTokenAmount, Box<dyn std::error::Error + Send + Sync>> {
 		if let Some(after_block) = after_block {
 			if after_block == to_block {
 				Ok(NativeTokenAmount(0))

mainchain-follower/mock/src/native_token.rs

@@ -1,5 +1,4 @@
 use async_trait::async_trait;
-use main_chain_follower_api::*;
 use sidechain_domain::*;
 use sp_native_token_management::NativeTokenManagementDataSource;
 
@@ -19,16 +18,14 @@ impl Default for NativeTokenDataSourceMock {
 
 #[async_trait]
 impl NativeTokenManagementDataSource for NativeTokenDataSourceMock {
-	type Error = DataSourceError;
-
 	async fn get_total_native_token_transfer(
 		&self,
 		_after_block: Option<McBlockHash>,
 		_to_block: McBlockHash,
 		_native_token_policy_id: PolicyId,
 		_native_token_asset_name: AssetName,
 		_illiquid_supply_address: MainchainAddress,
-	) -> Result<NativeTokenAmount> {
+	) -> Result<NativeTokenAmount, Box<dyn std::error::Error + Send + Sync>> {
 		Ok(NativeTokenAmount(1000))
 	}
 }

node/src/main_chain_follower.rs

@@ -2,7 +2,7 @@ use db_sync_follower::native_token::NativeTokenManagementDataSourceImpl;
 use db_sync_follower::{
 	block::BlockDataSourceImpl, candidates::CandidatesDataSourceImpl, metrics::McFollowerMetrics,
 };
-use main_chain_follower_api::{BlockDataSource, CandidateDataSource, DataSourceError};
+use main_chain_follower_api::{BlockDataSource, CandidateDataSource};
 use main_chain_follower_mock::{
 	block::BlockDataSourceMock, candidate::MockCandidateDataSource,
 	native_token::NativeTokenDataSourceMock,
@@ -16,8 +16,7 @@ use std::sync::Arc;
 pub struct DataSources {
 	pub block: Arc<dyn BlockDataSource + Send + Sync>,
 	pub candidate: Arc<dyn CandidateDataSource + Send + Sync>,
-	pub native_token:
-		Arc<dyn NativeTokenManagementDataSource<Error = DataSourceError> + Send + Sync>,
+	pub native_token: Arc<dyn NativeTokenManagementDataSource + Send + Sync>,
 }
 
 pub(crate) async fn create_cached_main_chain_follower_data_sources(

primitives/native-token-management/src/lib.rs

@@ -101,8 +101,6 @@ mod inherent_provider {
 
 	#[async_trait::async_trait]
 	pub trait NativeTokenManagementDataSource {
-		type Error;
-
 		/// Retrieves total of native token transfers into the illiquid supply in the range (after_block, to_block]
 		async fn get_total_native_token_transfer(
 			&self,
@@ -111,7 +109,7 @@ mod inherent_provider {
 			native_token_policy_id: PolicyId,
 			native_token_asset_name: AssetName,
 			illiquid_supply_address: MainchainAddress,
-		) -> Result<NativeTokenAmount, Self::Error>;
+		) -> Result<NativeTokenAmount, Box<dyn std::error::Error + Send + Sync>>;
 	}
 
 	pub struct NativeTokenManagementInherentDataProvider {
@@ -140,7 +138,7 @@ mod inherent_provider {
 		pub async fn new_for_runtime_version<Block, C, E>(
 			version_check: fn(RuntimeVersion) -> bool,
 			client: Arc<C>,
-			data_source: &(dyn NativeTokenManagementDataSource<Error = E> + Send + Sync),
+			data_source: &(dyn NativeTokenManagementDataSource + Send + Sync),
 			mc_hash: McBlockHash,
 			parent_hash: <Block as BlockT>::Hash,
 		) -> Result<Self, IDPCreationError>
@@ -149,7 +147,6 @@ mod inherent_provider {
 			C: HeaderBackend<Block>,
 			C: ProvideRuntimeApi<Block> + Send + Sync,
 			C::Api: NativeTokenManagementApi<Block>,
-			E: std::error::Error + Send + Sync + 'static,
 		{
 			let version = client.runtime_api().version(parent_hash)?;
 
@@ -160,9 +157,9 @@ mod inherent_provider {
 			}
 		}
 
-		pub async fn new<Block, C, E>(
+		pub async fn new<Block, C>(
 			client: Arc<C>,
-			data_source: &(dyn NativeTokenManagementDataSource<Error = E> + Send + Sync),
+			data_source: &(dyn NativeTokenManagementDataSource + Send + Sync),
 			mc_hash: McBlockHash,
 			parent_hash: <Block as BlockT>::Hash,
 		) -> Result<Self, IDPCreationError>
@@ -171,7 +168,6 @@ mod inherent_provider {
 			C: HeaderBackend<Block>,
 			C: ProvideRuntimeApi<Block> + Send + Sync,
 			C::Api: NativeTokenManagementApi<Block>,
-			E: std::error::Error + Send + Sync + 'static,
 		{
 			let api = client.runtime_api();
 			let Some(scripts) = api.get_main_chain_scripts(parent_hash)? else {
@@ -192,7 +188,7 @@ mod inherent_provider {
 					scripts.illiquid_supply_validator_address,
 				)
 				.await
-				.map_err(|err| IDPCreationError::DataSourceError(Box::new(err)))?;
+				.map_err(IDPCreationError::DataSourceError)?;
 
 			let token_amount = if token_amount.0 > 0 { Some(token_amount) } else { None };
 
@@ -232,32 +228,25 @@ mod inherent_provider {
 	pub mod mock {
 		use crate::NativeTokenManagementDataSource;
 		use async_trait::async_trait;
-		use core::marker::PhantomData;
 		use derive_new::new;
 		use sidechain_domain::*;
 		use std::collections::HashMap;
 
 		#[derive(new, Default)]
-		pub struct MockNativeTokenDataSource<Err> {
+		pub struct MockNativeTokenDataSource {
 			transfers: HashMap<(Option<McBlockHash>, McBlockHash), NativeTokenAmount>,
-			_marker: PhantomData<Err>,
 		}
 
 		#[async_trait]
-		impl<Err> NativeTokenManagementDataSource for MockNativeTokenDataSource<Err>
-		where
-			Err: std::error::Error + Send + Sync,
-		{
-			type Error = Err;
-
+		impl NativeTokenManagementDataSource for MockNativeTokenDataSource {
 			async fn get_total_native_token_transfer(
 				&self,
 				after_block: Option<McBlockHash>,
 				to_block: McBlockHash,
 				_native_token_policy_id: PolicyId,
 				_native_token_asset_name: AssetName,
 				_illiquid_supply_address: MainchainAddress,
-			) -> Result<NativeTokenAmount, Self::Error> {
+			) -> Result<NativeTokenAmount, Box<dyn std::error::Error + Send + Sync>> {
 				Ok(self.transfers.get(&(after_block, to_block)).cloned().unwrap_or_default())
 			}
 		}

primitives/native-token-management/src/tests/mod.rs

@@ -15,13 +15,6 @@ mod inherent_provider {
 	use sp_runtime::testing::DigestItem;
 	use std::sync::Arc;
 
-	#[derive(thiserror::Error, sp_runtime::RuntimeDebug)]
-	pub enum TestErr {
-		#[allow(unused)]
-		#[error("Test error")]
-		Err,
-	}
-
 	#[tokio::test]
 	async fn correctly_fetches_total_transfer_between_two_hashes() {
 		let parent_number = 1; // not genesis
@@ -82,7 +75,7 @@ mod inherent_provider {
 		let parent_hash = Hash::from([2; 32]);
 		let parent_mc_hash = Some(McBlockHash([3; 32]));
 
-		let data_source = MockNativeTokenDataSource::<TestErr>::new([].into());
+		let data_source = MockNativeTokenDataSource::new([].into());
 		let main_chain_scripts = Some(MainChainScripts::default());
 		let client = create_client(parent_hash, parent_mc_hash, parent_number, main_chain_scripts);
 
@@ -150,7 +143,7 @@ mod inherent_provider {
 		parent_mc_hash: Option<McBlockHash>,
 		mc_hash: McBlockHash,
 		total_transfered: u128,
-	) -> MockNativeTokenDataSource<TestErr> {
+	) -> MockNativeTokenDataSource {
 		let total_transfered = NativeTokenAmount(total_transfered);
 		MockNativeTokenDataSource::new([((parent_mc_hash, mc_hash), total_transfered)].into())
 	}