fix: extend eth_syncing response type and serde (#1624)

This commit is contained in:
Matthias Seitz 2022-08-21 00:30:53 +02:00 committed by GitHub
parent ff754263a3
commit 8abb9d86e2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 169 additions and 30 deletions

View File

@ -68,3 +68,6 @@ mod other;
pub use other::OtherFields;
pub mod serde_helpers;
mod syncing;
pub use syncing::{SyncProgress, SyncingStatus};

View File

@ -0,0 +1,164 @@
//! Types for `eth_syncing` RPC call
use crate::types::U64;
use serde::{Deserialize, Deserializer, Serialize, Serializer};
/// Structure used in `eth_syncing` RPC
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum SyncingStatus {
/// When client is synced to highest block, eth_syncing with return string "false"
IsFalse,
/// When client is still syncing past blocks we get IsSyncing information.
IsSyncing(Box<SyncProgress>),
}
impl Serialize for SyncingStatus {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
match self {
SyncingStatus::IsFalse => serializer.serialize_bool(false),
SyncingStatus::IsSyncing(sync) => sync.serialize(serializer),
}
}
}
impl<'de> Deserialize<'de> for SyncingStatus {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: Deserializer<'de>,
{
#[derive(Debug, Serialize, Deserialize)]
#[serde(untagged)]
pub enum SyncingStatusIntermediate {
/// When client is synced to the highest block, eth_syncing with return string "false"
IsFalse(bool),
/// When client is still syncing past blocks we get IsSyncing information.
IsSyncing(Box<SyncProgress>),
}
match SyncingStatusIntermediate::deserialize(deserializer)? {
SyncingStatusIntermediate::IsFalse(false) => Ok(SyncingStatus::IsFalse),
SyncingStatusIntermediate::IsFalse(true) => Err(serde::de::Error::custom(
"eth_syncing returned `true` that is undefined value.",
)),
SyncingStatusIntermediate::IsSyncing(sync) => Ok(SyncingStatus::IsSyncing(sync)),
}
}
}
/// Represents the sync status of the node
///
/// **Note:** while the `eth_syncing` RPC response is defined as:
///
/// > Returns:
/// >
/// > Object|Boolean, An object with sync status data or FALSE, when not syncing:
///
/// > startingBlock: QUANTITY - The block at which the import started (will only be reset, after the
/// > sync reached his head)
/// > currentBlock: QUANTITY - The current block, same as eth_blockNumber
/// > highestBlock: QUANTITY - The estimated highest block
///
/// Geth returns additional fields: <https://github.com/ethereum/go-ethereum/blob/0ce494b60cd00d70f1f9f2dd0b9bfbd76204168a/ethclient/ethclient.go#L597-L617>
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SyncProgress {
pub current_block: U64,
pub highest_block: U64,
pub starting_block: U64,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub pulled_states: Option<U64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub known_states: Option<U64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub healed_bytecode_bytes: Option<U64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub healed_bytecodes: Option<U64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub healed_trienode_bytes: Option<U64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub healed_trienodes: Option<U64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub healing_bytecode: Option<U64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub healing_trienodes: Option<U64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub synced_account_bytes: Option<U64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub synced_accounts: Option<U64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub synced_bytecode_bytes: Option<U64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub synced_bytecodes: Option<U64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub synced_storage: Option<U64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub synced_storage_bytes: Option<U64>,
}
#[cfg(test)]
mod tests {
use super::*;
// <https://github.com/gakonst/ethers-rs/issues/1623>
#[test]
fn deserialize_sync_geth() {
let s = r#"{
"currentBlock": "0xeaa2b4",
"healedBytecodeBytes": "0xaad91fe",
"healedBytecodes": "0x61d3",
"healedTrienodeBytes": "0x156ac02b1",
"healedTrienodes": "0x2885aa4",
"healingBytecode": "0x0",
"healingTrienodes": "0x454",
"highestBlock": "0xeaa329",
"startingBlock": "0xea97ee",
"syncedAccountBytes": "0xa29fec90d",
"syncedAccounts": "0xa7ed9ad",
"syncedBytecodeBytes": "0xdec39008",
"syncedBytecodes": "0x8d407",
"syncedStorage": "0x2a517da1",
"syncedStorageBytes": "0x23634dbedf"
}"#;
let sync: SyncingStatus = serde_json::from_str(s).unwrap();
match sync {
SyncingStatus::IsFalse => {
panic!("unexpected variant")
}
SyncingStatus::IsSyncing(_) => {}
}
}
#[test]
fn deserialize_sync_minimal() {
let s = r#"{
"currentBlock": "0xeaa2b4",
"highestBlock": "0xeaa329",
"startingBlock": "0xea97ee"
}"#;
let sync: SyncingStatus = serde_json::from_str(s).unwrap();
match sync {
SyncingStatus::IsFalse => {
panic!("unexpected variant")
}
SyncingStatus::IsSyncing(_) => {}
}
}
#[test]
fn deserialize_sync_false() {
let s = r#"false"#;
let sync: SyncingStatus = serde_json::from_str(s).unwrap();
match sync {
SyncingStatus::IsFalse => {}
SyncingStatus::IsSyncing(_) => {
panic!("unexpected variant")
}
}
}
}

View File

@ -88,15 +88,6 @@ where
}
}
/// Structure used in eth_syncing RPC
#[derive(Clone, Debug)]
pub enum SyncingStatus {
/// When client is synced to highest block, eth_syncing with return string "false"
IsFalse,
/// When client is still syncing past blocks we get IsSyncing information.
IsSyncing { starting_block: U256, current_block: U256, highest_block: U256 },
}
/// A middleware allows customizing requests send and received from an ethereum node.
///
/// Writing a middleware is as simple as:

View File

@ -29,7 +29,7 @@ use ethers_core::{
utils,
};
use hex::FromHex;
use serde::{de::DeserializeOwned, Deserialize, Serialize};
use serde::{de::DeserializeOwned, Serialize};
use thiserror::Error;
use url::{ParseError, Url};
@ -539,26 +539,7 @@ impl<P: JsonRpcClient> Middleware for Provider<P> {
/// Return current client syncing status. If IsFalse sync is over.
async fn syncing(&self) -> Result<SyncingStatus, Self::Error> {
#[derive(Debug, Serialize, Deserialize)]
#[serde(untagged)]
pub enum SyncingStatusIntermediate {
/// When client is synced to highest block, eth_syncing with return string "false"
IsFalse(bool),
/// When client is still syncing past blocks we get IsSyncing information.
IsSyncing { starting_block: U256, current_block: U256, highest_block: U256 },
}
let intermediate: SyncingStatusIntermediate = self.request("eth_syncing", ()).await?;
match intermediate {
SyncingStatusIntermediate::IsFalse(false) => Ok(SyncingStatus::IsFalse),
SyncingStatusIntermediate::IsFalse(true) => Err(ProviderError::CustomError(
"eth_syncing returned `true` that is undefined value.".to_owned(),
)),
SyncingStatusIntermediate::IsSyncing {
starting_block,
current_block,
highest_block,
} => Ok(SyncingStatus::IsSyncing { starting_block, current_block, highest_block }),
}
self.request("eth_syncing", ()).await
}
/// Returns the network version.