feat: --debug.etherscan for fake consensus client #8082
Conversation
shekhirin
added
C-enhancement
crates/consensus/rpc/src/lib.rs
Outdated
| let block: EtherscanBlockResponse = self | ||
| .http_client | ||
| .get(&self.etherscan_base_api_url) | ||
| .query(&[ | ||
| ("module", "proxy"), | ||
| ("action", "eth_getBlockByNumber"), | ||
| ("tag", "latest"), | ||
| ("boolean", "true"), | ||
| ("apikey", &self.etherscan_api_key), | ||
| ]) | ||
| .send() | ||
| .await | ||
| .unwrap() | ||
| .json() | ||
| .await |
There was a problem hiding this comment.
I'd like to make this configurable, for example I think it could be useful to provide another node's rpc endpoint and use eth_subscribe + eth_getBlockByHash to fetch the block
so perhaps a stream type helper that yields full blocks
this is perhaps a better solution that just etherscan,
see for example:
crates/consensus/rpc/src/lib.rs
Outdated
| reth_rpc_types::engine::ForkchoiceState { | ||
| head_block_hash: block_hash, | ||
| safe_block_hash: block_hash, | ||
| finalized_block_hash: block_hash, | ||
| }, |
There was a problem hiding this comment.
this might break certain assumptions about blocks that can (or cannot in this case) be reorged. i'd prefer that API call above was a batch call that also fetches safe & finalized hashes
There was a problem hiding this comment.
good callout. I haven't found a way to get safe/finalized blocks state from Etherscan, because their eth_getBlockByNumber doesn't support tags other than latest. maybe you know some tricks? afaik beaconscan isn't exposed in API.
otherwise, should I just change the --debug.etherscan parameter to --debug.consensus-rpc and use its eth_getBlockByNumber?
There was a problem hiding this comment.
The safe block hash will be at most 32 blocks behind head, and finalized is at most 32 behind that, so you could use head, head-32, head-64 after fetching the three hashes
| /// by number to fetch past finalized and safe blocks. | ||
| pub trait BlockProvider: Send + Sync + 'static { | ||
| /// Spawn a block provider to send new blocks to the given sender. | ||
| fn spawn(&self, tx: mpsc::Sender<RichBlock>) -> impl Future<Output = ()> + Send; |
There was a problem hiding this comment.
What would you prefer, this or impl Stream<Output = RichBlock>? IMO impl Stream<Output = RichBlock> is much less nicer to implement (bc of manual state machine building vs just async fn), but can change it
There was a problem hiding this comment.
nice! I'd prefer to see this generalised to any node infrastructure service that uses API keys, not only Etherscan. wdyt @shekhirin @mattsse @rkrasiuk ?
| // Load previous block hashes. We're using (head - 32) and (head - 64) as the safe and | ||
| // finalized block hashes. | ||
| // todo: chdeck for off by ones in offset | ||
| let safe_block_hash = get_or_fetch_previous_block( |
There was a problem hiding this comment.
this should be a function of self
There was a problem hiding this comment.
updated, if understood this comment correctly. if not — ping again pls.
|
@mattsse highlighting this PR just in case it slipped through the cracks! |
| conflicts_with = "tip", | ||
| conflicts_with = "rpc_consensus_http" | ||
| )] | ||
| pub etherscan: bool, |
There was a problem hiding this comment.
this should take an Option<Option<String>> if Some(Some(api_url)) use that, if Some(None) use the chain's default
| conflicts_with = "tip", | ||
| conflicts_with = "rpc_consensus_http" | ||
| )] | ||
| pub etherscan: bool, |
There was a problem hiding this comment.
this should take an Option<Option<String>> if Some(Some(api_url)) use that, if Some(None) use the chain's default
| /// Runs a fake consensus client using blocks from an RPC endpoint. HTTP endpoint for getting | ||
| /// past blocks. | ||
| #[arg( | ||
| long = "debug.rpc-consensus-http", | ||
| help_heading = "Debug", | ||
| conflicts_with = "tip", | ||
| conflicts_with = "etherscan", | ||
| requires = "rpc_consensus_ws" | ||
| )] | ||
| pub rpc_consensus_http: Option<String>, | ||
|
|
||
| /// Runs a fake consensus client using blocks from an RPC endpoint. WS endpoint for getting new | ||
| /// blocks. | ||
| #[arg( | ||
| long = "debug.rpc-consensus-ws", | ||
| help_heading = "Debug", | ||
| conflicts_with = "tip", | ||
| conflicts_with = "etherscan", | ||
| requires = "rpc_consensus_http" | ||
| )] | ||
| pub rpc_consensus_ws: Option<String>, |
There was a problem hiding this comment.
technically we don't need both endpoints, but I'm fine with this limitation for now, but a single arg is sufficient
| .expect("etherscan urls not found for rpc consensus client") | ||
| .0 | ||
| .to_owned(), | ||
| chain | ||
| .etherscan_api_key() | ||
| .expect("etherscan api key not found for rpc consensus client"), |
There was a problem hiding this comment.
these should be errors not panics
This is an early draft for fake consensus client that fetches blocks from Etherscan and propagates it to execution layer as FCUs and new payloads. Designed to replace
--debug.tipwhen developing. #6711