add: ETCM-12253 bridge pallet, IDP and data source API (#963)

Author: AmbientTea

Cargo.lock

@@ -57,6 +57,8 @@ members = [
 	"toolkit/governed-map/primitives",
 	"toolkit/governed-map/pallet",
 	"toolkit/committee-selection/selection-simulator",
+	"toolkit/bridge/pallet",
+	"toolkit/bridge/primitives",
 ]
 resolver = "2"
 
@@ -330,5 +332,9 @@ partner-chains-mock-data-sources = { path = "toolkit/data-sources/mock", default
 sp-governed-map = { path = "toolkit/governed-map/primitives", default-features = false }
 pallet-governed-map = { path = "toolkit/governed-map/pallet", default-features = false }
 
+# Bridge
+sp-partner-chains-bridge = { path = "toolkit/bridge/primitives", default-features = false }
+pallet-partner-chains-bridge = { path = "toolkit/bridge/pallet", default-features = false }
+
 # demo node
 partner-chains-demo-runtime = { path = "demo/runtime" }

Cargo.toml

@@ -46,6 +46,14 @@ In SCALE encoding of inherent data custom implementations of `Encode` and `Decod
 
 `getAriadneParameters` and `getRegistrations` RPC results format has changed, `auraPubKey` and `grandpaPubKey` are replaced by `"keys": {"aura": "...", "gran": "..."}`.
 
+### Unidirectional Token Bridge (Work-in-progress)
+
+A set of modules implementing observability layer, runtime pallet and offchain commands for a trustless token bridge moving tokens from Cardano to the Partner Chain.
+
+This bridge feature works by monitoring an *illiquid supply validator address* on Cardano for new UTXOs. These UTXOs are interpreted as being either user-initiated
+transfers sent to a specified address on the Partner Chain, or reserve transfers made as part of the chain's operations for the purposes of distributing them as
+block producer rewards on-chain. Handling of the transfers is left to the chain builders themselves to implement according to their business needs and ledger structure.
+
 ### Other additions
 
 * `delete_metadata` extrinsic in `pallet-block-producer-metadata`

changelog.md

@@ -56,6 +56,7 @@ pub fn pc_create_chain_spec(config: &CreateChainSpecConfig<SessionKeys>) -> serd
 			participation_data_release_period: 30,
 			..Default::default()
 		},
+		bridge: Default::default(),
 	};
 	let genesis_json = serde_json::to_value(runtime_genesis_config)
 		.expect("Genesis config must be serialized correctly");

demo/node/src/chain_spec.rs

@@ -161,6 +161,7 @@ pub fn staging_genesis(
 			participation_data_release_period: 30,
 			..Default::default()
 		},
+		bridge: Default::default(),
 	};
 
 	Ok(serde_json::to_value(config).expect("Genesis config must be serialized correctly"))

demo/node/src/staging.rs

@@ -51,6 +51,7 @@ pub fn chain_spec() -> Result<ChainSpec, envy::Error> {
 			participation_data_release_period: 30,
 			..Default::default()
 		},
+		bridge: Default::default(),
 	};
 	let genesis_json = serde_json::to_value(runtime_genesis_config)
 		.expect("Genesis config must be serialized correctly");

demo/node/src/template_chain_spec.rs

@@ -213,6 +213,7 @@ pub fn testnet_genesis(
 			participation_data_release_period: 30,
 			..Default::default()
 		},
+		bridge: Default::default(),
 	};
 
 	Ok(serde_json::to_value(config).expect("Genesis config must be serialized correctly"))

demo/node/src/testnet.rs

@@ -93,6 +93,8 @@ pallet-governed-map = { workspace = true }
 sp-governed-map = { workspace = true }
 sp-block-producer-fees = { workspace = true }
 pallet-block-producer-fees = { workspace = true }
+pallet-partner-chains-bridge = { workspace = true }
+sp-partner-chains-bridge = { workspace = true }
 
 [dev-dependencies]
 sp-io = { workspace = true }
@@ -172,6 +174,8 @@ std = [
 	"sp-block-participation/std",
 	"pallet-governed-map/std",
 	"sp-governed-map/std",
+	"pallet-partner-chains-bridge/std",
+	"sp-partner-chains-bridge/std",
 ]
 
 runtime-benchmarks = [
@@ -191,6 +195,7 @@ runtime-benchmarks = [
 	"pallet-block-producer-metadata/runtime-benchmarks",
 	"pallet-block-participation/runtime-benchmarks",
 	"pallet-governed-map/runtime-benchmarks",
+	"pallet-partner-chains-bridge/runtime-benchmarks",
 ]
 try-runtime = [
 	"frame-try-runtime/try-runtime",

demo/runtime/Cargo.toml

@@ -65,6 +65,7 @@ fn testnet_genesis(
 			main_chain_scripts: Some(sp_governed_map::MainChainScriptsV1::default()),
 			..Default::default()
 		},
+		bridge: Default::default(),
 	};
 
 	serde_json::to_value(config).expect("Could not build genesis config.")

demo/runtime/src/genesis_config_presets.rs

@@ -46,6 +46,7 @@ use sp_core::ByteArray;
 use sp_core::{OpaqueMetadata, crypto::KeyTypeId};
 use sp_governed_map::MainChainScriptsV1;
 use sp_inherents::InherentIdentifier;
+use sp_partner_chains_bridge::{BridgeDataCheckpoint, MainChainScripts as BridgeMainChainScripts};
 use sp_runtime::{
 	ApplyExtrinsicResult, MultiSignature, Perbill, generic, impl_opaque_keys,
 	traits::{
@@ -674,6 +675,20 @@ impl pallet_governed_map::Config for Runtime {
 
 impl crate::test_helper_pallet::Config for Runtime {}
 
+parameter_types! {
+pub const MaxTransfersPerBlock: u32 = 256;}
+
+impl pallet_partner_chains_bridge::Config for Runtime {
+	type GovernanceOrigin = EnsureRoot<Runtime>;
+	type Recipient = AccountId;
+	type TransferHandler = TestHelperPallet;
+	type MaxTransfersPerBlock = MaxTransfersPerBlock;
+	type WeightInfo = ();
+
+	#[cfg(feature = "runtime-benchmarks")]
+	type BenchmarkHelper = ();
+}
+
 // Create the runtime by composing the FRAME pallets that were previously configured.
 construct_runtime!(
 	pub struct Runtime {
@@ -702,6 +717,7 @@ construct_runtime!(
 		Session: pallet_partner_chains_session,
 		NativeTokenManagement: pallet_native_token_management,
 		GovernedMap: pallet_governed_map,
+		Bridge: pallet_partner_chains_bridge,
 		TestHelperPallet: crate::test_helper_pallet,
 	}
 );
@@ -758,6 +774,7 @@ mod benches {
 		[pallet_block_producer_metadata, BlockProducerMetadata]
 		[pallet_block_participation, BlockParticipation]
 		[pallet_governed_map, GovernedMap]
+		[pallet_partner_chains_bridge, Bridge]
 	);
 }
 
@@ -1129,6 +1146,21 @@ impl_runtime_apis! {
 			GovernedMap::get_version()
 		}
 	}
+
+	impl sp_partner_chains_bridge::TokenBridgeIDPRuntimeApi<Block> for Runtime {
+		fn get_pallet_version() -> u32 {
+			Bridge::get_pallet_version()
+		}
+		fn get_main_chain_scripts() -> Option<BridgeMainChainScripts> {
+			Bridge::get_main_chain_scripts()
+		}
+		fn get_max_transfers_per_block() -> u32 {
+			Bridge::get_max_transfers_per_block()
+		}
+		fn get_last_data_checkpoint() -> Option<BridgeDataCheckpoint> {
+			Bridge::get_data_checkpoint()
+		}
+	}
 }
 
 #[cfg(test)]