feat(core): more type parsing (#2095)

* feat(core): more type parsing

* c

* doc
This commit is contained in:
DaniPopes 2023-01-31 18:37:33 +01:00 committed by GitHub
parent b0ef6ee9a2
commit 9b7d184fd6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 47 additions and 21 deletions

View File

@ -1,9 +1,7 @@
// Taken from <https://github.com/tomusdrw/rust-web3/blob/master/src/types/block.rs> // Modified from <https://github.com/tomusdrw/rust-web3/blob/master/src/types/block.rs>
use crate::types::{Address, Bloom, Bytes, Transaction, TxHash, H256, U256, U64}; use crate::types::{Address, Bloom, Bytes, Transaction, TxHash, H256, U256, U64};
use chrono::{DateTime, TimeZone, Utc}; use chrono::{DateTime, TimeZone, Utc};
#[cfg(not(feature = "celo"))]
use core::cmp::Ordering;
use serde::{ use serde::{
de::{MapAccess, Visitor}, de::{MapAccess, Visitor},
ser::SerializeStruct, ser::SerializeStruct,
@ -13,6 +11,7 @@ use std::{fmt, fmt::Formatter, str::FromStr};
use thiserror::Error; use thiserror::Error;
/// The block type returned from RPC calls. /// The block type returned from RPC calls.
///
/// This is generic over a `TX` type which will be either the hash or the full transaction, /// This is generic over a `TX` type which will be either the hash or the full transaction,
/// i.e. `Block<TxHash>` or `Block<Transaction>`. /// i.e. `Block<TxHash>` or `Block<Transaction>`.
#[derive(Debug, Default, Clone, PartialEq, Eq, Deserialize, Serialize)] #[derive(Debug, Default, Clone, PartialEq, Eq, Deserialize, Serialize)]
@ -142,6 +141,8 @@ impl<TX> Block<TX> {
/// Reference: <https://eips.ethereum.org/EIPS/eip-1559> /// Reference: <https://eips.ethereum.org/EIPS/eip-1559>
#[cfg(not(feature = "celo"))] #[cfg(not(feature = "celo"))]
pub fn next_block_base_fee(&self) -> Option<U256> { pub fn next_block_base_fee(&self) -> Option<U256> {
use core::cmp::Ordering;
let target_usage = self.gas_target(); let target_usage = self.gas_target();
let base_fee_per_gas = self.base_fee_per_gas?; let base_fee_per_gas = self.base_fee_per_gas?;
@ -397,10 +398,10 @@ impl From<Block<Transaction>> for Block<TxHash> {
} }
} }
#[derive(Debug, Default, Clone, PartialEq, Eq, Deserialize, Serialize)]
#[cfg(feature = "celo")]
/// Commit-reveal data for generating randomness in the /// Commit-reveal data for generating randomness in the
/// [Celo protocol](https://docs.celo.org/celo-codebase/protocol/identity/randomness) /// [Celo protocol](https://docs.celo.org/celo-codebase/protocol/identity/randomness)
#[derive(Debug, Default, Clone, PartialEq, Eq, Deserialize, Serialize)]
#[cfg(feature = "celo")]
pub struct Randomness { pub struct Randomness {
/// The committed randomness for that block /// The committed randomness for that block
pub committed: Bytes, pub committed: Bytes,
@ -408,9 +409,9 @@ pub struct Randomness {
pub revealed: Bytes, pub revealed: Bytes,
} }
/// SNARK-friendly epoch block signature and bitmap
#[derive(Debug, Default, Clone, PartialEq, Eq, Deserialize, Serialize)] #[derive(Debug, Default, Clone, PartialEq, Eq, Deserialize, Serialize)]
#[cfg(feature = "celo")] #[cfg(feature = "celo")]
/// SNARK-friendly epoch block signature and bitmap
pub struct EpochSnarkData { pub struct EpochSnarkData {
/// The bitmap showing which validators signed on the epoch block /// The bitmap showing which validators signed on the epoch block
pub bitmap: Bytes, pub bitmap: Bytes,
@ -418,8 +419,8 @@ pub struct EpochSnarkData {
pub signature: Bytes, pub signature: Bytes,
} }
/// A [block hash](H256) or [block number](BlockNumber).
#[derive(Copy, Clone, Debug, PartialEq, Eq)] #[derive(Copy, Clone, Debug, PartialEq, Eq)]
/// A Block Hash or Block Number
pub enum BlockId { pub enum BlockId {
// TODO: May want to expand this to include the requireCanonical field // TODO: May want to expand this to include the requireCanonical field
// <https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1898.md> // <https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1898.md>
@ -530,7 +531,21 @@ impl<'de> Deserialize<'de> for BlockId {
} }
} }
/// A block Number (or tag - "latest", "earliest", "pending") impl FromStr for BlockId {
type Err = String;
fn from_str(s: &str) -> Result<Self, Self::Err> {
let s = s.strip_prefix("0x").unwrap_or(s);
if s.len() == 64 {
let hash = s.parse::<H256>().map_err(|e| e.to_string());
hash.map(Self::Hash)
} else {
s.parse().map(Self::Number)
}
}
}
/// A block number or tag.
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq, Hash)] #[derive(Copy, Clone, Debug, Default, PartialEq, Eq, Hash)]
pub enum BlockNumber { pub enum BlockNumber {
/// Latest block /// Latest block
@ -624,15 +639,22 @@ impl FromStr for BlockNumber {
type Err = String; type Err = String;
fn from_str(s: &str) -> Result<Self, Self::Err> { fn from_str(s: &str) -> Result<Self, Self::Err> {
let block = match s { match s {
"latest" => Self::Latest, "latest" => Ok(Self::Latest),
"finalized" => Self::Finalized, "finalized" => Ok(Self::Finalized),
"safe" => Self::Safe, "safe" => Ok(Self::Safe),
"earliest" => Self::Earliest, "earliest" => Ok(Self::Earliest),
"pending" => Self::Pending, "pending" => Ok(Self::Pending),
n => BlockNumber::Number(n.parse::<U64>().map_err(|err| err.to_string())?), n => {
}; if let Ok(n) = n.parse::<U64>() {
Ok(block) Ok(Self::Number(n))
} else if let Ok(n) = n.parse::<u64>() {
Ok(Self::Number(n.into()))
} else {
Err("Invalid block number".into())
}
}
}
} }
} }

View File

@ -1,7 +1,7 @@
use crate::types::Address; use crate::types::Address;
use rlp::{Decodable, Encodable, RlpStream}; use rlp::{Decodable, Encodable, RlpStream};
use serde::{ser::Error as SerializationError, Deserialize, Deserializer, Serialize, Serializer}; use serde::{ser::Error as SerializationError, Deserialize, Deserializer, Serialize, Serializer};
use std::{cmp::Ordering, convert::Infallible, str::FromStr}; use std::{cmp::Ordering, str::FromStr};
/// ENS name or Ethereum Address. Not RLP encoded/serialized if it's a name. /// ENS name or Ethereum Address. Not RLP encoded/serialized if it's a name.
#[derive(Clone, Debug, PartialEq, Eq)] #[derive(Clone, Debug, PartialEq, Eq)]
@ -100,10 +100,14 @@ impl From<Address> for NameOrAddress {
} }
impl FromStr for NameOrAddress { impl FromStr for NameOrAddress {
type Err = Infallible; type Err = <Address as FromStr>::Err;
fn from_str(s: &str) -> Result<Self, Self::Err> { fn from_str(s: &str) -> Result<Self, Self::Err> {
Ok(Self::Name(s.to_string())) if s.starts_with("0x") {
s.parse().map(Self::Address)
} else {
Ok(Self::Name(s.to_string()))
}
} }
} }