EPROD 1086 block validation with a single reth node #48
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| [package] | ||
| name = "bitfinity-block-validator" | ||
| version.workspace = true | ||
| edition.workspace = true | ||
| rust-version.workspace = true | ||
| license.workspace = true | ||
| homepage.workspace = true | ||
| repository.workspace = true | ||
|
|
||
| [lints] | ||
| workspace = true | ||
|
|
||
| [dependencies] | ||
| async-trait.workspace = true | ||
| did.workspace = true | ||
| evm-canister-client.workspace = true | ||
| ic-agent.workspace = true | ||
| ic-canister-client.workspace = true | ||
| itertools.workspace = true | ||
| reth-db.workspace = true | ||
| reth-engine-tree.workspace = true | ||
| reth-evm.workspace = true | ||
| reth-evm-ethereum.workspace = true | ||
| reth-provider.workspace = true | ||
| reth-primitives.workspace = true | ||
| reth-revm.workspace = true | ||
| tracing.workspace = true |
|
There was a problem hiding this comment. Maybe add at least one unit test that would show that all the calculated hashes have expected values? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,208 @@ | ||
| //! Bitfinity block validator. | ||
|
|
||
| use did::unsafe_blocks::ValidateUnsafeBlockArgs; | ||
| use did::{Transaction, H256}; | ||
| use evm_canister_client::{CanisterClient, EvmCanisterClient}; | ||
| use itertools::Itertools; | ||
| use reth_db::database::Database; | ||
| use reth_engine_tree::tree::MemoryOverlayStateProvider; | ||
| use reth_evm::execute::Executor as _; | ||
| use reth_evm::execute::{BlockExecutionOutput, BlockExecutorProvider as _}; | ||
| use reth_evm_ethereum::execute::EthExecutorProvider; | ||
| use reth_evm_ethereum::{execute::EthBlockExecutor, EthEvmConfig}; | ||
| use reth_primitives::U256; | ||
| use reth_primitives::{Address, Receipt}; | ||
| use reth_primitives::{Block, BlockWithSenders}; | ||
| use reth_provider::{ChainSpecProvider as _, ExecutionOutcome, ProviderFactory, StateProvider}; | ||
| use reth_revm::database::StateProviderDatabase; | ||
|
|
||
| /// Block validator for Bitfinity. | ||
| /// | ||
| /// The validator validates the block by executing it and then | ||
| /// confirming it on the EVM. | ||
| #[derive(Clone, Debug)] | ||
| pub struct BitfinityBlockValidator<C, DB> | ||
| where | ||
| C: CanisterClient, | ||
| { | ||
| evm_client: EvmCanisterClient<C>, | ||
| provider_factory: ProviderFactory<DB>, | ||
| } | ||
|
|
||
| impl<C, DB> BitfinityBlockValidator<C, DB> | ||
| where | ||
| C: CanisterClient, | ||
| DB: Database, | ||
| { | ||
| /// Create a new [`BitfinityBlockValidator`]. | ||
| pub fn new(evm_client: EvmCanisterClient<C>, provider_factory: ProviderFactory<DB>) -> Self { | ||
| Self { evm_client, provider_factory } | ||
| } | ||
|
|
||
| /// Validate a block. | ||
| pub async fn validate_block( | ||
| &self, | ||
| block: Block, | ||
| transactions: &[Transaction], | ||
| ) -> Result<(), Box<dyn std::error::Error>> { | ||
| if !self.unsafe_blocks_enabled().await? { | ||
| tracing::debug!("Unsafe blocks are disabled"); | ||
| return Ok(()); | ||
| } | ||
|
Comment on lines
+48
to
+51
There was a problem hiding this comment. Does this check have any meaning? If unsafe blocks are disabled on EVM wouldn't it just return empty list if we request them? In this case we anyway do one GET request on every iteration. But if it's enabled, with this check on every iteration we do 2 GET requests instead of 1. |
||
| let validate_args = self.execute_block(block, transactions)?; | ||
| self.validate_unsafe_block(validate_args).await?; | ||
|
|
||
| Ok(()) | ||
| } | ||
|
|
||
| /// Get whether unsafe blocks are enabled. | ||
| async fn unsafe_blocks_enabled(&self) -> Result<bool, Box<dyn std::error::Error>> { | ||
|
There was a problem hiding this comment. I would call this method somehow different, because in rust methods names starting with |
||
| self.evm_client | ||
| .is_unsafe_blocks_enabled() | ||
| .await | ||
| .map_err(|err| Box::new(err) as Box<dyn std::error::Error>) | ||
| } | ||
|
|
||
| /// Execute block and return validation arguments. | ||
| fn execute_block( | ||
| &self, | ||
| block: Block, | ||
| transactions: &[Transaction], | ||
| ) -> Result<ValidateUnsafeBlockArgs, Box<dyn std::error::Error>> { | ||
| // execute the block | ||
| let block_number = block.number; | ||
| tracing::debug!("Executing block: {block_number}",); | ||
| let executor = self.executor(); | ||
| let block_with_senders = Self::convert_block(block, transactions); | ||
|
|
||
| let output = match executor.execute((&block_with_senders, U256::MAX).into()) { | ||
| Ok(output) => output, | ||
| Err(err) => { | ||
| tracing::error!("Failed to execute block: {err:?}"); | ||
| return Ok(ValidateUnsafeBlockArgs { | ||
| block_number, | ||
| block_hash: H256::zero(), | ||
| transactions_root: H256::zero(), | ||
| state_root: H256::zero(), | ||
| receipts_root: H256::zero(), | ||
| }); | ||
| } | ||
| }; | ||
|
|
||
| // calculate the receipts root | ||
| let receipts_root = self.calculate_receipts_root(&output.receipts); | ||
| tracing::debug!("Block {block_number} receipts root: {receipts_root}",); | ||
|
|
||
| // calculate trasnsactions_root | ||
| let transactions_root = self.calculate_transactions_root(&block_with_senders); | ||
| tracing::debug!("Block {block_number} transactions root: {transactions_root}",); | ||
|
|
||
| // calculate block hash | ||
| let block_hash = self.calculate_block_hash(&block_with_senders); | ||
| tracing::debug!("Block {block_number} hash: {block_hash}",); | ||
|
|
||
| // calculate state root | ||
| let state_root = self.calculate_state_root(output, block_number)?; | ||
| tracing::debug!("Block {block_number} state root: {state_root}",); | ||
|
|
||
| Ok(ValidateUnsafeBlockArgs { | ||
| block_number, | ||
| block_hash, | ||
| transactions_root, | ||
| state_root, | ||
| receipts_root, | ||
| }) | ||
| } | ||
|
|
||
| /// Calculate the receipts root. | ||
| fn calculate_receipts_root(&self, receipts: &[reth_primitives::Receipt]) -> H256 { | ||
| let receipts_with_bloom = | ||
| receipts.iter().map(|receipt| receipt.clone().with_bloom()).collect::<Vec<_>>(); | ||
| let calculated_root = reth_primitives::proofs::calculate_receipt_root(&receipts_with_bloom); | ||
| H256::from_slice(calculated_root.as_ref()) | ||
| } | ||
|
|
||
| /// Calculate the transactions root. | ||
| fn calculate_transactions_root(&self, block: &BlockWithSenders) -> H256 { | ||
| let calculated_root = reth_primitives::proofs::calculate_transaction_root(&block.body); | ||
| H256::from_slice(calculated_root.as_ref()) | ||
| } | ||
|
|
||
| /// Calculate the block hash. | ||
| fn calculate_block_hash(&self, block: &BlockWithSenders) -> H256 { | ||
| let calculated_hash = block.clone().seal_slow().hash(); | ||
| H256::from_slice(calculated_hash.as_ref()) | ||
| } | ||
|
|
||
| /// Calculate the state root. | ||
| fn calculate_state_root( | ||
| &self, | ||
| execution_output: BlockExecutionOutput<Receipt>, | ||
| block_number: u64, | ||
| ) -> Result<H256, Box<dyn std::error::Error>> { | ||
| // get state root | ||
| let execution_outcome = ExecutionOutcome::new( | ||
| execution_output.state, | ||
| execution_output.receipts.into(), | ||
| block_number, | ||
| vec![execution_output.requests.into()], | ||
| ); | ||
| let provider = match self.provider_factory.provider() { | ||
| Ok(provider) => provider, | ||
| Err(err) => { | ||
| tracing::error!("Failed to get provider: {err:?}"); | ||
| return Err(Box::new(err)); | ||
| } | ||
| }; | ||
| let calculated_state_root = | ||
| execution_outcome.hash_state_slow().state_root_with_updates(provider.tx_ref())?.0; | ||
|
|
||
| Ok(H256::from_slice(calculated_state_root.as_ref())) | ||
| } | ||
|
|
||
| /// Convert [`Block`] to [`BlockWithSenders`]. | ||
| fn convert_block(block: Block, transactions: &[Transaction]) -> BlockWithSenders { | ||
| let senders = transactions | ||
| .iter() | ||
| .map(|tx| Address::from_slice(tx.from.0.as_ref())) | ||
| .unique() | ||
| .collect::<Vec<_>>(); | ||
| tracing::debug!("Found {} unique senders in block", senders.len()); | ||
|
|
||
| BlockWithSenders { block, senders } | ||
| } | ||
|
|
||
| /// Try to validate an unsafe block on the EVM. | ||
| async fn validate_unsafe_block( | ||
| &self, | ||
| validate_args: ValidateUnsafeBlockArgs, | ||
| ) -> Result<(), Box<dyn std::error::Error>> { | ||
| let block_number = validate_args.block_number; | ||
| tracing::info!("Confirming block on EVM: {block_number}: {validate_args:?}",); | ||
|
|
||
| let res = self.evm_client.validate_unsafe_block(validate_args).await?; | ||
|
|
||
| tracing::info!("Validate unsafe block response for block {block_number}: {res:?}",); | ||
|
|
||
| if let Err(err) = res { | ||
| tracing::error!("Failed to validate unsafe block: {err:?}"); | ||
| return Err(Box::new(err)); | ||
| } | ||
|
|
||
| Ok(()) | ||
| } | ||
|
|
||
| /// Get the block executor for the latest block. | ||
| fn executor( | ||
| &self, | ||
| ) -> EthBlockExecutor< | ||
| EthEvmConfig, | ||
| StateProviderDatabase<MemoryOverlayStateProvider<Box<dyn StateProvider>>>, | ||
| > { | ||
| let historical = self.provider_factory.latest().expect("no latest provider"); | ||
|
|
||
| let db = MemoryOverlayStateProvider::new(Vec::new(), historical); | ||
| let executor = EthExecutorProvider::ethereum(self.provider_factory.chain_spec()); | ||
| executor.executor(StateProviderDatabase::new(db)) | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't forget to change to the right tag