feat(l1): implement forkchoiceupdatedv2, newpayloadv2 and getpayloadv2 #1297
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,72 +4,74 @@ use ethrex_blockchain::{ | |
| latest_canonical_block_hash, | ||
| payload::{create_payload, BuildPayloadArgs}, | ||
| }; | ||
| use ethrex_core::types::{BlockHeader, ChainConfig}; | ||
| use serde_json::Value; | ||
| use tracing::{info, warn}; | ||
|
|
||
| use crate::{ | ||
| types::{ | ||
| fork_choice::{ForkChoiceResponse, ForkChoiceState, PayloadAttributes}, | ||
| payload::PayloadStatus, | ||
| }, | ||
| utils::RpcRequest, | ||
| RpcApiContext, RpcErr, RpcHandler, | ||
| }; | ||
|
|
||
| #[derive(Debug)] | ||
| pub struct ForkChoiceUpdated { | ||
| pub fork_choice_state: ForkChoiceState, | ||
| pub payload_attributes: Result<Option<PayloadAttributes>, String>, | ||
| } | ||
|
|
||
| impl ForkChoiceUpdated { | ||
| // TODO(#853): Allow fork choice to be executed even if fork choice updated was not correctly parsed. | ||
| fn parse(params: &Option<Vec<Value>>) -> Result<ForkChoiceUpdated, RpcErr> { | ||
| let params = params | ||
| .as_ref() | ||
| .ok_or(RpcErr::BadParams("No params provided".to_owned()))?; | ||
| if params.len() != 2 { | ||
| return Err(RpcErr::BadParams("Expected 2 params".to_owned())); | ||
| } | ||
| Ok(ForkChoiceUpdated { | ||
| fork_choice_state: serde_json::from_value(params[0].clone())?, | ||
| payload_attributes: serde_json::from_value(params[1].clone()) | ||
| .map_err(|e| e.to_string()), | ||
| }) | ||
| } | ||
|
|
||
| fn try_from(fork_choice_updated: &dyn ForkChoiceUpdatedImpl) -> Result<RpcRequest, String> { | ||
| let request = fork_choice_updated.request(); | ||
| match &request.payload_attributes { | ||
| Ok(attrs) => Ok(RpcRequest { | ||
| method: fork_choice_updated.method(), | ||
| params: Some(vec![ | ||
| serde_json::json!(request.fork_choice_state), | ||
| serde_json::json!(attrs), | ||
| ]), | ||
| ..Default::default() | ||
| }), | ||
| Err(err) => Err(err.to_string()), | ||
| } | ||
| } | ||
|
|
||
| fn handle( | ||
| fork_choice_updated: &dyn ForkChoiceUpdatedImpl, | ||
| context: RpcApiContext, | ||
| ) -> Result<Value, RpcErr> { | ||
| let request = fork_choice_updated.request(); | ||
| let storage = &context.storage; | ||
| info!( | ||
| "New fork choice request with head: {}, safe: {}, finalized: {}.", | ||
| request.fork_choice_state.head_block_hash, | ||
| request.fork_choice_state.safe_block_hash, | ||
| request.fork_choice_state.finalized_block_hash | ||
| ); | ||
|
|
||
| let head_block = match apply_fork_choice( | ||
| storage, | ||
| request.fork_choice_state.head_block_hash, | ||
| request.fork_choice_state.safe_block_hash, | ||
| request.fork_choice_state.finalized_block_hash, | ||
| ) { | ||
| Ok(head) => head, | ||
| Err(error) => { | ||
|
|
@@ -89,7 +91,7 @@ impl RpcHandler for ForkChoiceUpdatedV3 { | |
| "Missing latest canonical block".to_owned(), | ||
| )); | ||
| }; | ||
| let sync_head = request.fork_choice_state.head_block_hash; | ||
| tokio::spawn(async move { | ||
| // If we can't get hold of the syncer, then it means that there is an active sync in process | ||
| if let Ok(mut syncer) = context.syncer.try_lock() { | ||
|
|
@@ -112,34 +114,25 @@ impl RpcHandler for ForkChoiceUpdatedV3 { | |
|
|
||
| // Build block from received payload. This step is skipped if applying the fork choice state failed | ||
| let mut response = ForkChoiceResponse::from(PayloadStatus::valid_with_hash( | ||
| request.fork_choice_state.head_block_hash, | ||
| )); | ||
|
|
||
| match &request.payload_attributes { | ||
| // Payload may be invalid but we had to apply fork choice state nevertheless. | ||
| Err(e) => return Err(RpcErr::InvalidPayloadAttributes(e.into())), | ||
| Ok(None) => (), | ||
| Ok(Some(attributes)) => { | ||
| info!("Fork choice updated includes payload attributes. Creating a new payload."); | ||
| let chain_config = storage.get_chain_config()?; | ||
| fork_choice_updated.validate(attributes, chain_config, head_block)?; | ||
|
There was a problem hiding this comment. So this is the only thing that is different between the FCU calls? What if there is any actions besides validating? There was a problem hiding this comment. For this call the only difference are the validations and the |
||
| let args = BuildPayloadArgs { | ||
| parent: request.fork_choice_state.head_block_hash, | ||
| timestamp: attributes.timestamp, | ||
| fee_recipient: attributes.suggested_fee_recipient, | ||
| random: attributes.prev_randao, | ||
| withdrawals: attributes.withdrawals.clone(), | ||
| beacon_root: attributes.parent_beacon_block_root, | ||
| version: fork_choice_updated.version(), | ||
| }; | ||
| let payload_id = args.id(); | ||
| response.set_id(payload_id); | ||
|
|
@@ -157,3 +150,138 @@ impl RpcHandler for ForkChoiceUpdatedV3 { | |
| serde_json::to_value(response).map_err(|error| RpcErr::Internal(error.to_string())) | ||
| } | ||
| } | ||
|
|
||
| trait ForkChoiceUpdatedImpl { | ||
|
There was a problem hiding this comment. nit: can we just call it There was a problem hiding this comment. There is a struct already named like that |
||
| fn method(&self) -> String; | ||
| fn request(&self) -> &ForkChoiceUpdated; | ||
| fn version(&self) -> u8; | ||
| fn validate( | ||
| &self, | ||
| attributes: &PayloadAttributes, | ||
| chain_config: ChainConfig, | ||
| head_block: BlockHeader, | ||
| ) -> Result<(), RpcErr>; | ||
| } | ||
|
|
||
| #[derive(Debug)] | ||
| pub struct ForkChoiceUpdatedV2(ForkChoiceUpdated); | ||
|
|
||
| impl ForkChoiceUpdatedImpl for ForkChoiceUpdatedV2 { | ||
| fn method(&self) -> String { | ||
| "engine_forkchoiceUpdatedV2".to_string() | ||
| } | ||
|
|
||
| fn request(&self) -> &ForkChoiceUpdated { | ||
| &self.0 | ||
| } | ||
|
|
||
| fn version(&self) -> u8 { | ||
| 2 | ||
| } | ||
|
|
||
| fn validate( | ||
| &self, | ||
| attributes: &PayloadAttributes, | ||
| chain_config: ChainConfig, | ||
| head_block: BlockHeader, | ||
| ) -> Result<(), RpcErr> { | ||
| if attributes.parent_beacon_block_root.is_some() { | ||
| return Err(RpcErr::InvalidPayloadAttributes( | ||
| "forkChoiceV2 with Beacon Root".to_string(), | ||
| )); | ||
| } | ||
| if !chain_config.is_shanghai_activated(attributes.timestamp) { | ||
| return Err(RpcErr::UnsuportedFork( | ||
| "forkChoiceV2 used to build pre-Shanghai payload".to_string(), | ||
| )); | ||
| } | ||
| if chain_config.is_cancun_activated(attributes.timestamp) { | ||
| return Err(RpcErr::UnsuportedFork( | ||
| "forkChoiceV2 used to build Cancun payload".to_string(), | ||
| )); | ||
| } | ||
| if attributes.timestamp <= head_block.timestamp { | ||
| return Err(RpcErr::InvalidPayloadAttributes( | ||
| "invalid timestamp".to_string(), | ||
| )); | ||
| } | ||
| Ok(()) | ||
| } | ||
| } | ||
|
|
||
| impl TryFrom<ForkChoiceUpdatedV2> for RpcRequest { | ||
| type Error = String; | ||
|
|
||
| fn try_from(val: ForkChoiceUpdatedV2) -> Result<Self, Self::Error> { | ||
| ForkChoiceUpdated::try_from(&val) | ||
| } | ||
| } | ||
|
|
||
| impl RpcHandler for ForkChoiceUpdatedV2 { | ||
| fn parse(params: &Option<Vec<Value>>) -> Result<Self, RpcErr> { | ||
| Ok(Self(ForkChoiceUpdated::parse(params)?)) | ||
|
There was a problem hiding this comment. where do you validate that params is in fact v2? There was a problem hiding this comment. The only difference is the |
||
| } | ||
|
|
||
| fn handle(&self, context: RpcApiContext) -> Result<Value, RpcErr> { | ||
| ForkChoiceUpdated::handle(self, context) | ||
| } | ||
| } | ||
|
|
||
| #[derive(Debug)] | ||
| pub struct ForkChoiceUpdatedV3(pub ForkChoiceUpdated); | ||
|
|
||
| impl ForkChoiceUpdatedImpl for ForkChoiceUpdatedV3 { | ||
| fn method(&self) -> String { | ||
| "engine_forkchoiceUpdatedV3".to_string() | ||
| } | ||
|
|
||
| fn request(&self) -> &ForkChoiceUpdated { | ||
| &self.0 | ||
| } | ||
|
|
||
| fn version(&self) -> u8 { | ||
| 3 | ||
| } | ||
|
|
||
| fn validate( | ||
| &self, | ||
| attributes: &PayloadAttributes, | ||
| chain_config: ChainConfig, | ||
| head_block: BlockHeader, | ||
| ) -> Result<(), RpcErr> { | ||
| if attributes.parent_beacon_block_root.is_none() { | ||
| return Err(RpcErr::InvalidPayloadAttributes( | ||
| "Null Parent Beacon Root".to_string(), | ||
| )); | ||
| } | ||
| if !chain_config.is_cancun_activated(attributes.timestamp) { | ||
| return Err(RpcErr::UnsuportedFork( | ||
| "forkChoiceV3 used to build pre-Cancun payload".to_string(), | ||
| )); | ||
| } | ||
| if attributes.timestamp <= head_block.timestamp { | ||
| return Err(RpcErr::InvalidPayloadAttributes( | ||
| "invalid timestamp".to_string(), | ||
| )); | ||
| } | ||
| Ok(()) | ||
| } | ||
| } | ||
|
|
||
| impl TryFrom<ForkChoiceUpdatedV3> for RpcRequest { | ||
| type Error = String; | ||
|
|
||
| fn try_from(val: ForkChoiceUpdatedV3) -> Result<Self, Self::Error> { | ||
| ForkChoiceUpdated::try_from(&val) | ||
| } | ||
| } | ||
|
|
||
| impl RpcHandler for ForkChoiceUpdatedV3 { | ||
| fn parse(params: &Option<Vec<Value>>) -> Result<Self, RpcErr> { | ||
| Ok(Self(ForkChoiceUpdated::parse(params)?)) | ||
| } | ||
|
|
||
| fn handle(&self, context: RpcApiContext) -> Result<Value, RpcErr> { | ||
| ForkChoiceUpdated::handle(self, context) | ||
| } | ||
| } | ||
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.
Nit: I'd prefer if we used some explicit fields here.
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.
I kind of prefer that too... but it's like repeating arbitrary code: