Token Governor Updates (polytope-labs#275)

Co-authored-by: David Salami <wizdave97@gmail.com>

evm/src/modules/Registrar.sol

@@ -59,7 +59,7 @@ contract TokenRegistrar is BaseIsmpModule {
     error UnauthorizedAction();
 
     // @notice A user has initiated the asset registration process
-    event RegistrationBegun(bytes32 indexed assetId, address indexed owner);
+    event RegistrationBegun(bytes32 indexed assetId, address indexed owner, uint256 feePaid);
 
     // @notice Governance has updated the registrar parameters
     event ParamsUpdated(RegistrarParams oldParams, RegistrarParams newParams);
@@ -100,7 +100,8 @@ contract TokenRegistrar is BaseIsmpModule {
     function registerAsset(bytes32 assetId) public payable {
         address feeToken = IIsmpHost(_params.host).feeToken();
         uint256 messagingFee = 64 * IIsmpHost(_params.host).perByteFee();
-        uint256 fee = _params.baseFee + messagingFee;
+        uint256 baseFee = _params.baseFee;
+        uint256 fee = baseFee + messagingFee;
 
         // user has provided the native token
         if (msg.value > 0) {
@@ -114,9 +115,9 @@ contract TokenRegistrar is BaseIsmpModule {
                 address(this),
                 block.timestamp
             );
-            SafeERC20.safeTransfer(IERC20(feeToken), _params.host, _params.baseFee);
+            SafeERC20.safeTransfer(IERC20(feeToken), _params.host, baseFee);
         } else {
-            SafeERC20.safeTransferFrom(IERC20(feeToken), msg.sender, _params.host, _params.baseFee);
+            SafeERC20.safeTransferFrom(IERC20(feeToken), msg.sender, _params.host, baseFee);
             SafeERC20.safeTransferFrom(IERC20(feeToken), msg.sender, address(this), messagingFee);
         }
         bytes memory data = abi.encode(RequestBody({owner: msg.sender, assetId: assetId}));
@@ -133,7 +134,7 @@ contract TokenRegistrar is BaseIsmpModule {
         });
         IDispatcher(_params.host).dispatch(request);
 
-        emit RegistrationBegun({assetId: assetId, owner: msg.sender});
+        emit RegistrationBegun({assetId: assetId, owner: msg.sender, feePaid: baseFee });
     }
 
     // @notice Governance parameter updates

modules/ismp/clients/arbitrum/src/lib.rs

@@ -30,7 +30,8 @@ use ismp::{
 		ConsensusStateId, IntermediateState, StateCommitment, StateMachineHeight, StateMachineId,
 	},
 	error::Error,
-	host::{ethereum, IsmpHost, StateMachine},
+	host::{ethereum, StateMachine},
+	messaging::Keccak256,
 };
 
 /// Storage layout slot for the nodes map in the Rollup Contract
@@ -46,7 +47,7 @@ pub struct GlobalState {
 
 impl GlobalState {
 	/// https://github.com/OffchainLabs/nitro/blob/5e9f4228e6418b114a5aea0aa7f2f0cc161b67c0/contracts/src/state/GlobalState.sol#L16
-	pub fn hash<H: IsmpHost>(&self) -> H256 {
+	pub fn hash<H: Keccak256>(&self) -> H256 {
 		// abi encode packed
 		let mut buf = Vec::new();
 		buf.extend_from_slice("Global state:".as_bytes());
@@ -105,7 +106,7 @@ pub struct ArbitrumPayloadProof {
 }
 
 /// https://github.com/OffchainLabs/nitro/blob/5e9f4228e6418b114a5aea0aa7f2f0cc161b67c0/contracts/src/rollup/RollupLib.sol#L59
-fn get_state_hash<H: IsmpHost>(
+fn get_state_hash<H: Keccak256>(
 	global_state: GlobalState,
 	machine_status: MachineStatus,
 	inbox_max_count: U256,
@@ -120,7 +121,7 @@ fn get_state_hash<H: IsmpHost>(
 	H::keccak256(&buf)
 }
 
-pub fn verify_arbitrum_payload<H: IsmpHost + Send + Sync>(
+pub fn verify_arbitrum_payload<H: Keccak256 + Send + Sync>(
 	payload: ArbitrumPayloadProof,
 	root: H256,
 	rollup_core_address: H160,

modules/ismp/clients/bsc/Cargo.toml

@@ -19,6 +19,7 @@ bsc-verifier = { workspace = true }
 sync-committee-primitives = { workspace = true }
 geth-primitives = { workspace = true }
 evm-common = { workspace = true }
+pallet-ismp-host-executive = { workspace = true }
 
 [features]
 default = ["std"]
@@ -31,5 +32,6 @@ std = [
     "bsc-verifier/std",
     "ismp/std",
     "sync-committee-primitives/std",
-    "evm-common/std"
+    "evm-common/std",
+    "pallet-ismp-host-executive/std"
 ]

modules/ismp/clients/bsc/src/lib.rs

@@ -11,18 +11,17 @@ use bsc_verifier::{
 	verify_bsc_header, NextValidators, VerificationResult,
 };
 use codec::{Decode, Encode};
-use evm_common::{req_res_receipt_keys, verify_membership, verify_state_proof};
+use evm_common::EvmStateMachine;
 use geth_primitives::Header;
 use ismp::{
 	consensus::{
 		ConsensusClient, ConsensusClientId, ConsensusStateId, StateCommitment, StateMachineClient,
 	},
 	error::Error,
 	host::{IsmpHost, StateMachine},
-	messaging::{Proof, StateCommitmentHeight},
-	router::RequestResponse,
+	messaging::StateCommitmentHeight,
 };
-use sp_core::{H160, H256};
+use sp_core::H256;
 use sync_committee_primitives::constants::BlsPublicKey;
 
 pub const BSC_CONSENSUS_ID: ConsensusStateId = *b"BSCP";
@@ -34,24 +33,25 @@ pub struct ConsensusState {
 	pub finalized_height: u64,
 	pub finalized_hash: H256,
 	pub current_epoch: u64,
-	pub ismp_contract_address: H160,
 }
 
-pub struct BscClient<H: IsmpHost>(PhantomData<H>);
+pub struct BscClient<H: IsmpHost, T: pallet_ismp_host_executive::Config>(PhantomData<(H, T)>);
 
-impl<H: IsmpHost> Default for BscClient<H> {
+impl<H: IsmpHost, T: pallet_ismp_host_executive::Config> Default for BscClient<H, T> {
 	fn default() -> Self {
 		Self(PhantomData)
 	}
 }
 
-impl<H: IsmpHost> Clone for BscClient<H> {
+impl<H: IsmpHost, T: pallet_ismp_host_executive::Config> Clone for BscClient<H, T> {
 	fn clone(&self) -> Self {
 		Self(PhantomData)
 	}
 }
 
-impl<H: IsmpHost + Send + Sync + Default + 'static> ConsensusClient for BscClient<H> {
+impl<H: IsmpHost + Send + Sync + Default + 'static, T: pallet_ismp_host_executive::Config>
+	ConsensusClient for BscClient<H, T>
+{
 	fn verify_consensus(
 		&self,
 		_host: &dyn IsmpHost,
@@ -164,46 +164,9 @@ impl<H: IsmpHost + Send + Sync + Default + 'static> ConsensusClient for BscClien
 		id: ismp::host::StateMachine,
 	) -> Result<Box<dyn StateMachineClient>, ismp::error::Error> {
 		match id {
-			StateMachine::Bsc => Ok(Box::new(<EvmStateMachine<H>>::default())),
+			StateMachine::Bsc => Ok(Box::new(<EvmStateMachine<H, T>>::default())),
 			state_machine =>
 				Err(Error::Custom(alloc::format!("Unsupported state machine: {state_machine:?}"))),
 		}
 	}
 }
-
-#[derive(Default, Clone)]
-pub struct EvmStateMachine<H: IsmpHost>(core::marker::PhantomData<H>);
-
-impl<H: IsmpHost + Send + Sync> StateMachineClient for EvmStateMachine<H> {
-	fn verify_membership(
-		&self,
-		host: &dyn IsmpHost,
-		item: RequestResponse,
-		root: StateCommitment,
-		proof: &Proof,
-	) -> Result<(), Error> {
-		let consensus_state = host.consensus_state(proof.height.id.consensus_state_id)?;
-		let consensus_state = ConsensusState::decode(&mut &consensus_state[..])
-			.map_err(|_| Error::Custom("Cannot decode consensus state".to_string()))?;
-
-		verify_membership::<H>(item, root, proof, consensus_state.ismp_contract_address)
-	}
-
-	fn state_trie_key(&self, items: RequestResponse) -> Vec<Vec<u8>> {
-		req_res_receipt_keys::<H>(items)
-	}
-
-	fn verify_state_proof(
-		&self,
-		host: &dyn IsmpHost,
-		keys: Vec<Vec<u8>>,
-		root: StateCommitment,
-		proof: &Proof,
-	) -> Result<BTreeMap<Vec<u8>, Option<Vec<u8>>>, Error> {
-		let consensus_state = host.consensus_state(proof.height.id.consensus_state_id)?;
-		let consensus_state = ConsensusState::decode(&mut &consensus_state[..])
-			.map_err(|_| Error::Custom("Cannot decode consensus state".to_string()))?;
-
-		verify_state_proof::<H>(keys, root, proof, consensus_state.ismp_contract_address)
-	}
-}

modules/ismp/clients/optimism/src/lib.rs

@@ -30,7 +30,7 @@ use ismp::{
 		ConsensusStateId, IntermediateState, StateCommitment, StateMachineHeight, StateMachineId,
 	},
 	error::Error,
-	host::{ethereum, IsmpHost, StateMachine},
+	host::{ethereum, StateMachine},
 	messaging::Keccak256,
 };
 
@@ -65,7 +65,7 @@ pub struct OptimismPayloadProof {
 	pub timestamp: u64,
 }
 
-pub fn verify_optimism_payload<H: IsmpHost + Send + Sync>(
+pub fn verify_optimism_payload<H: Keccak256 + Send + Sync>(
 	payload: OptimismPayloadProof,
 	root: H256,
 	l2_oracle_address: H160,
@@ -207,7 +207,7 @@ pub fn calculate_output_root<H: Keccak256>(
 pub const CANNON: u32 = 0;
 pub const _PERMISSIONED: u32 = 1;
 
-pub fn verify_optimism_dispute_game_proof<H: IsmpHost + Send + Sync>(
+pub fn verify_optimism_dispute_game_proof<H: Keccak256 + Send + Sync>(
 	payload: OptimismDisputeGameProof,
 	root: H256,
 	dispute_factory_address: H160,

modules/ismp/clients/sync-committee/Cargo.toml

@@ -18,6 +18,7 @@ geth-primitives = { workspace = true, default-features = false }
 evm-common = { workspace = true }
 arbitrum-verifier = { workspace = true }
 op-verifier = { workspace = true }
+pallet-ismp-host-executive = { workspace = true }
 
 # crates.io
 hex = { version = "0.4.3", default-features = false }

modules/ismp/clients/sync-committee/evm-common/Cargo.toml

@@ -12,6 +12,7 @@ publish = false
 ismp = { workspace = true  }
 ethereum-triedb = { workspace = true  }
 geth-primitives = { workspace = true  }
+pallet-ismp-host-executive = { workspace = true }
 
 # crates.io
 trie-db = { workspace = true }
@@ -39,5 +40,6 @@ std = [
     "ethabi/std",
     "hash256-std-hasher/std",
     "hex/std",
-    "geth-primitives/std"
+    "geth-primitives/std",
+    "pallet-ismp-host-executive/std"
 ]

modules/ismp/clients/sync-committee/evm-common/src/lib.rs

@@ -19,11 +19,13 @@
 #![allow(unused_variables)]
 
 extern crate alloc;
+
 use alloc::collections::BTreeMap;
 use ethabi::ethereum_types::{H160, H256};
 use ismp::{
-	consensus::StateCommitment,
+	consensus::{StateCommitment, StateMachineClient},
 	error::Error,
+	host::IsmpHost,
 	messaging::{Keccak256, Proof},
 	router::RequestResponse,
 };
@@ -32,6 +34,7 @@ pub mod prelude {
 	pub use alloc::{boxed::Box, string::ToString, vec, vec::Vec};
 }
 
+use pallet_ismp_host_executive::EvmHosts;
 use prelude::*;
 
 pub mod presets;
@@ -110,3 +113,53 @@ pub fn verify_state_proof<H: Keccak256 + Send + Sync>(
 
 	Ok(map)
 }
+
+pub struct EvmStateMachine<H: IsmpHost, T: pallet_ismp_host_executive::Config>(
+	core::marker::PhantomData<(H, T)>,
+);
+
+impl<H: IsmpHost, T: pallet_ismp_host_executive::Config> Default for EvmStateMachine<H, T> {
+	fn default() -> Self {
+		Self(core::marker::PhantomData)
+	}
+}
+
+impl<H: IsmpHost, T: pallet_ismp_host_executive::Config> Clone for EvmStateMachine<H, T> {
+	fn clone(&self) -> Self {
+		EvmStateMachine::<H, T>::default()
+	}
+}
+
+impl<H: IsmpHost + Send + Sync, T: pallet_ismp_host_executive::Config> StateMachineClient
+	for EvmStateMachine<H, T>
+{
+	fn verify_membership(
+		&self,
+		host: &dyn IsmpHost,
+		item: RequestResponse,
+		root: StateCommitment,
+		proof: &Proof,
+	) -> Result<(), Error> {
+		let contract_address = EvmHosts::<T>::get(&proof.height.id.state_id)
+			.ok_or_else(|| Error::Custom("Ismp contract address not found".to_string()))?;
+		verify_membership::<H>(item, root, proof, contract_address)
+	}
+
+	fn state_trie_key(&self, items: RequestResponse) -> Vec<Vec<u8>> {
+		// State trie keys are used to process timeouts from EVM chains
+		// We return the trie keys for request or response receipts
+		req_res_receipt_keys::<H>(items)
+	}
+
+	fn verify_state_proof(
+		&self,
+		host: &dyn IsmpHost,
+		keys: Vec<Vec<u8>>,
+		root: StateCommitment,
+		proof: &Proof,
+	) -> Result<BTreeMap<Vec<u8>, Option<Vec<u8>>>, Error> {
+		let ismp_address = EvmHosts::<T>::get(&proof.height.id.state_id)
+			.ok_or_else(|| Error::Custom("Ismp contract address not found".to_string()))?;
+		verify_state_proof::<H>(keys, root, proof, ismp_address)
+	}
+}