add: bridge data source mock + wiring (#985)

Author: AmbientTea

Cargo.lock

@@ -71,6 +71,7 @@ derive-new = { workspace = true }
 partner-chains-cli = { workspace = true }
 partner-chains-node-commands = { workspace = true }
 envy = { workspace = true }
+sp-partner-chains-bridge = { workspace = true }
 
 # These dependencies are used for the node template's RPCs
 jsonrpsee = { workspace = true }
@@ -109,6 +110,7 @@ partner-chains-mock-data-sources = { workspace = true, features = [
 	"mc-hash",
 	"sidechain-rpc",
 	"block-participation",
+	"bridge",
 ] }
 tokio = { workspace = true }
 sp-block-participation = { workspace = true, features = ["std"] }

demo/node/Cargo.toml

@@ -5,16 +5,18 @@ use partner_chains_db_sync_data_sources::{
 	McFollowerMetrics, McHashDataSourceImpl, NativeTokenManagementDataSourceImpl,
 	SidechainRpcDataSourceImpl, StakeDistributionDataSourceImpl,
 };
+use partner_chains_demo_runtime::AccountId;
 use partner_chains_mock_data_sources::{
 	AuthoritySelectionDataSourceMock, BlockDataSourceMock, GovernedMapDataSourceMock,
 	McHashDataSourceMock, NativeTokenDataSourceMock, SidechainRpcDataSourceMock,
-	StakeDistributionDataSourceMock,
+	StakeDistributionDataSourceMock, TokenBridgeDataSourceMock,
 };
 use sc_service::error::Error as ServiceError;
 use sidechain_mc_hash::McHashDataSource;
 use sp_block_participation::inherent_data::BlockParticipationDataSource;
 use sp_governed_map::GovernedMapDataSource;
 use sp_native_token_management::NativeTokenManagementDataSource;
+use sp_partner_chains_bridge::TokenBridgeDataSource;
 use std::{error::Error, sync::Arc};
 
 pub const DATA_SOURCE_VAR: &str = "CARDANO_DATA_SOURCE";
@@ -68,6 +70,7 @@ pub struct DataSources {
 	pub sidechain_rpc: Arc<dyn SidechainRpcDataSource + Send + Sync>,
 	pub block_participation: Arc<dyn BlockParticipationDataSource + Send + Sync>,
 	pub governed_map: Arc<dyn GovernedMapDataSource + Send + Sync>,
+	pub bridge: Arc<dyn TokenBridgeDataSource<AccountId> + Send + Sync>,
 }
 
 pub(crate) async fn create_cached_data_sources(
@@ -105,6 +108,7 @@ pub fn create_mock_data_sources()
 		native_token: Arc::new(NativeTokenDataSourceMock::new()),
 		block_participation: Arc::new(StakeDistributionDataSourceMock::new()),
 		governed_map: Arc::new(GovernedMapDataSourceMock::default()),
+		bridge: Arc::new(TokenBridgeDataSourceMock::new()),
 	})
 }
 
@@ -140,12 +144,13 @@ pub async fn create_cached_db_sync_data_sources(
 		)),
 		governed_map: Arc::new(
 			GovernedMapDataSourceCachedImpl::new(
-				pool,
+				pool.clone(),
 				metrics_opt.clone(),
 				GOVERNED_MAP_CACHE_SIZE,
 				block,
 			)
 			.await?,
 		),
+		bridge: Arc::new(TokenBridgeDataSourceMock::new()),
 	})
 }

demo/node/src/data_sources.rs

@@ -5,7 +5,7 @@ use authority_selection_inherents::{
 use derive_new::new;
 use jsonrpsee::core::async_trait;
 use partner_chains_demo_runtime::{
-	BlockAuthor, CrossChainPublic,
+	AccountId, BlockAuthor, CrossChainPublic,
 	opaque::{Block, SessionKeys},
 };
 use sc_consensus_aura::{SlotDuration, find_pre_digest};
@@ -32,6 +32,9 @@ use sp_native_token_management::{
 	NativeTokenManagementApi, NativeTokenManagementDataSource,
 	NativeTokenManagementInherentDataProvider as NativeTokenIDP,
 };
+use sp_partner_chains_bridge::{
+	TokenBridgeDataSource, TokenBridgeIDPRuntimeApi, TokenBridgeInherentDataProvider,
+};
 use sp_partner_chains_consensus_aura::CurrentSlotProvider;
 use sp_runtime::traits::{Block as BlockT, Header, Zero};
 use sp_session_validator_management::SessionValidatorManagementApi;
@@ -48,6 +51,7 @@ pub struct ProposalCIDP<T> {
 	native_token_data_source: Arc<dyn NativeTokenManagementDataSource + Send + Sync>,
 	block_participation_data_source: Arc<dyn BlockParticipationDataSource + Send + Sync>,
 	governed_map_data_source: Arc<dyn GovernedMapDataSource + Send + Sync>,
+	bridge_data_source: Arc<dyn TokenBridgeDataSource<AccountId> + Send + Sync>,
 }
 
 #[async_trait]
@@ -65,6 +69,7 @@ where
 	T::Api: BlockProductionLogApi<Block, CommitteeMember<CrossChainPublic, SessionKeys>>,
 	T::Api: BlockParticipationApi<Block, BlockAuthor>,
 	T::Api: GovernedMapIDPApi<Block>,
+	T::Api: TokenBridgeIDPRuntimeApi<Block>,
 {
 	type InherentDataProviders = (
 		AuraIDP,
@@ -75,6 +80,7 @@ where
 		NativeTokenIDP,
 		BlockParticipationInherentDataProvider<BlockAuthor, DelegatorKey>,
 		GovernedMapInherentDataProvider,
+		TokenBridgeInherentDataProvider<AccountId>,
 	);
 
 	async fn create_inherent_data_providers(
@@ -90,6 +96,7 @@ where
 			native_token_data_source,
 			block_participation_data_source,
 			governed_map_data_source,
+			bridge_data_source,
 		} = self;
 		let CreateInherentDataConfig { mc_epoch_config, sc_slot_config, time_source } = config;
 
@@ -145,6 +152,14 @@ where
 		)
 		.await?;
 
+		let bridge = TokenBridgeInherentDataProvider::new(
+			client.as_ref(),
+			parent_hash,
+			mc_hash.mc_hash(),
+			bridge_data_source.as_ref(),
+		)
+		.await?;
+
 		Ok((
 			slot,
 			timestamp,
@@ -154,6 +169,7 @@ where
 			native_token,
 			payouts,
 			governed_map,
+			bridge,
 		))
 	}
 }
@@ -167,6 +183,7 @@ pub struct VerifierCIDP<T> {
 	native_token_data_source: Arc<dyn NativeTokenManagementDataSource + Send + Sync>,
 	block_participation_data_source: Arc<dyn BlockParticipationDataSource + Send + Sync>,
 	governed_map_data_source: Arc<dyn GovernedMapDataSource + Send + Sync>,
+	bridge_data_source: Arc<dyn TokenBridgeDataSource<AccountId> + Send + Sync>,
 }
 
 impl<T: Send + Sync> CurrentSlotProvider for VerifierCIDP<T> {
@@ -189,6 +206,7 @@ where
 	T::Api: BlockProductionLogApi<Block, CommitteeMember<CrossChainPublic, SessionKeys>>,
 	T::Api: BlockParticipationApi<Block, BlockAuthor>,
 	T::Api: GovernedMapIDPApi<Block>,
+	T::Api: TokenBridgeIDPRuntimeApi<Block>,
 {
 	type InherentDataProviders = (
 		TimestampIDP,
@@ -197,6 +215,7 @@ where
 		NativeTokenIDP,
 		BlockParticipationInherentDataProvider<BlockAuthor, DelegatorKey>,
 		GovernedMapInherentDataProvider,
+		TokenBridgeInherentDataProvider<AccountId>,
 	);
 
 	async fn create_inherent_data_providers(
@@ -212,6 +231,7 @@ where
 			native_token_data_source,
 			block_participation_data_source,
 			governed_map_data_source,
+			bridge_data_source,
 		} = self;
 		let CreateInherentDataConfig { mc_epoch_config, sc_slot_config, time_source, .. } = config;
 
@@ -264,19 +284,28 @@ where
 		let governed_map = GovernedMapInherentDataProvider::new(
 			client.as_ref(),
 			parent_hash,
-			mc_hash,
+			mc_hash.clone(),
 			mc_state_reference.previous_mc_hash(),
 			governed_map_data_source.as_ref(),
 		)
 		.await?;
 
+		let bridge = TokenBridgeInherentDataProvider::new(
+			client.as_ref(),
+			parent_hash,
+			mc_hash,
+			bridge_data_source.as_ref(),
+		)
+		.await?;
+
 		Ok((
 			timestamp,
 			ariadne_data_provider,
 			block_producer_id_provider,
 			native_token,
 			payouts,
 			governed_map,
+			bridge,
 		))
 	}
 }

demo/node/src/inherent_data.rs

@@ -163,6 +163,7 @@ pub fn new_partial(
 			data_sources.native_token.clone(),
 			data_sources.block_participation.clone(),
 			data_sources.governed_map.clone(),
+			data_sources.bridge.clone(),
 		),
 		spawner: &task_manager.spawn_essential_handle(),
 		registry: config.prometheus_registry(),
@@ -352,6 +353,7 @@ pub async fn new_full_base<Network: sc_network::NetworkBackend<Block, <Block as
 				data_sources.native_token.clone(),
 				data_sources.block_participation,
 				data_sources.governed_map,
+				data_sources.bridge.clone(),
 			),
 			force_authoring,
 			backoff_authoring_blocks,

demo/node/src/service.rs

@@ -6,9 +6,9 @@ use authority_selection_inherents::{
 	AuthoritySelectionInputs, mock::MockAuthoritySelectionDataSource,
 };
 use hex_literal::hex;
-use partner_chains_demo_runtime::BlockAuthor;
-use partner_chains_mock_data_sources::GovernedMapDataSourceMock;
+use partner_chains_demo_runtime::{AccountId, BlockAuthor};
 use partner_chains_mock_data_sources::StakeDistributionDataSourceMock;
+use partner_chains_mock_data_sources::{GovernedMapDataSourceMock, TokenBridgeDataSourceMock};
 use sidechain_domain::{
 	DelegatorKey, MainchainBlock, McBlockHash, McBlockNumber, McEpochNumber, McSlotNumber,
 	NativeTokenAmount, ScEpochNumber,
@@ -55,6 +55,7 @@ async fn block_proposal_cidp_should_be_created_correctly() {
 		Arc::new(native_token_data_source),
 		Arc::new(StakeDistributionDataSourceMock::new()),
 		Arc::new(GovernedMapDataSourceMock::default()),
+		Arc::new(TokenBridgeDataSourceMock::<AccountId>::new()),
 	)
 	.create_inherent_data_providers(mock_header().hash(), ())
 	.await
@@ -153,6 +154,7 @@ async fn block_verification_cidp_should_be_created_correctly() {
 		Arc::new(native_token_data_source),
 		Arc::new(StakeDistributionDataSourceMock::new()),
 		Arc::new(GovernedMapDataSourceMock::default()),
+		Arc::new(TokenBridgeDataSourceMock::new()),
 	);
 
 	let inherent_data_providers = verifier_cidp

demo/node/src/tests/inherent_data_tests.rs

@@ -146,6 +146,21 @@ sp_api::mock_impl_runtime_apis! {
 			1
 		}
 	}
+
+	impl sp_partner_chains_bridge::TokenBridgeIDPRuntimeApi<Block> for TestApi {
+		fn get_pallet_version() -> u32 {
+			1
+		}
+		fn get_main_chain_scripts() -> Option<sp_partner_chains_bridge::MainChainScripts> {
+			None
+		}
+		fn get_max_transfers_per_block() -> u32 {
+			32
+		}
+		fn get_last_data_checkpoint() -> Option<sp_partner_chains_bridge::BridgeDataCheckpoint> {
+			None
+		}
+	}
 }
 
 impl HeaderBackend<Block> for TestApi {

demo/node/src/tests/runtime_api_mock.rs

@@ -133,7 +133,7 @@ pub struct BridgeDataCheckpoint(pub UtxoId);
 /// Interface for data sources that can be used by [TokenBridgeInherentDataProvider]
 #[cfg(feature = "std")]
 #[async_trait::async_trait]
-pub trait TokenBridgeDataSource<RecipientAddress> {
+pub trait TokenBridgeDataSource<RecipientAddress>: Send + Sync {
 	/// Fetches at most `max_transfers` of token bridge transfers after `data_checkpoint` up to `current_mc_block`
 	async fn get_transfers(
 		&self,
@@ -219,7 +219,7 @@ impl<RecipientAddress: Encode + Send + Sync> TokenBridgeInherentDataProvider<Rec
 		client: &T,
 		parent_hash: Block::Hash,
 		current_mc_hash: McBlockHash,
-		data_source: &dyn TokenBridgeDataSource<RecipientAddress>,
+		data_source: &(dyn TokenBridgeDataSource<RecipientAddress> + Send + Sync),
 	) -> Result<Self, InherentDataCreationError>
 	where
 		Block: BlockT,

toolkit/bridge/primitives/src/lib.rs

@@ -29,6 +29,7 @@ sidechain-mc-hash = { workspace = true, optional = true }
 sp-block-participation = { workspace = true, optional = true }
 pallet-sidechain-rpc = { workspace = true, optional = true }
 authority-selection-inherents = { workspace = true, optional = true }
+sp-partner-chains-bridge = { workspace = true, optional = true }
 
 [features]
 default = ["std", "block-source", "candidate-source", "governed-map", "native-token"]
@@ -48,3 +49,4 @@ native-token = ["sp-native-token-management"]
 mc-hash = ["sidechain-mc-hash"]
 sidechain-rpc = ["pallet-sidechain-rpc"]
 block-participation = ["sp-block-participation"]
+bridge = ["sp-partner-chains-bridge"]

toolkit/data-sources/mock/Cargo.toml

@@ -0,0 +1,32 @@
+use crate::Result;
+use sidechain_domain::*;
+use sp_partner_chains_bridge::{
+	BridgeDataCheckpoint, BridgeTransferV1, MainChainScripts, TokenBridgeDataSource,
+};
+use std::marker::PhantomData;
+/// Mocked token bridge data source
+pub struct TokenBridgeDataSourceMock<RecipientAddress> {
+	_phantom: PhantomData<RecipientAddress>,
+}
+
+impl<RecipientAddress> TokenBridgeDataSourceMock<RecipientAddress> {
+	/// Creates a new mocked token bridge data source
+	pub fn new() -> Self {
+		Self { _phantom: Default::default() }
+	}
+}
+
+#[async_trait::async_trait]
+impl<RecipientAddress: Send + Sync> TokenBridgeDataSource<RecipientAddress>
+	for TokenBridgeDataSourceMock<RecipientAddress>
+{
+	async fn get_transfers(
+		&self,
+		_main_chain_scripts: MainChainScripts,
+		_data_checkpoint: BridgeDataCheckpoint,
+		_max_transfers: u32,
+		_current_mc_block: McBlockHash,
+	) -> Result<(Vec<BridgeTransferV1<RecipientAddress>>, BridgeDataCheckpoint)> {
+		Ok((vec![], Default::default()))
+	}
+}