Skip to content
This repository has been archived by the owner on Oct 19, 2024. It is now read-only.

Add Block::time #1250

Merged
merged 2 commits into from
May 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions ethers-core/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ rand = { version = "0.8.5", default-features = false }
tiny-keccak = { version = "2.0.2", default-features = false }

# misc
chrono = { version = "0.4", default-features = false }
serde = { version = "1.0.124", default-features = false, features = ["derive"] }
serde_json = { version = "1.0.64", default-features = false }
thiserror = { version = "1.0.31", default-features = false }
Expand Down
34 changes: 34 additions & 0 deletions ethers-core/src/types/block.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
// Taken 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 chrono::{DateTime, TimeZone, Utc};
#[cfg(not(feature = "celo"))]
use core::cmp::Ordering;
use serde::{ser::SerializeStruct, Deserialize, Deserializer, Serialize, Serializer};
use std::str::FromStr;
use thiserror::Error;

/// The block type returned from RPC calls.
/// This is generic over a `TX` type which will be either the hash or the full transaction,
Expand Down Expand Up @@ -91,6 +93,18 @@ pub struct Block<TX> {
pub epoch_snark_data: Option<EpochSnarkData>,
}

/// Error returned by [`Block::time`].
#[derive(Clone, Copy, Debug, Error)]
pub enum TimeError {
/// Timestamp is zero.
#[error("timestamp is zero")]
TimestampZero,

/// Timestamp is too large for [`DateTime<Utc>`].
#[error("timestamp is too large")]
TimestampOverflow,
}

// ref <https://eips.ethereum.org/EIPS/eip-1559>
#[cfg(not(feature = "celo"))]
pub const ELASTICITY_MULTIPLIER: U256 = U256([2u64, 0, 0, 0]);
Expand Down Expand Up @@ -135,6 +149,26 @@ impl<TX> Block<TX> {
Ordering::Equal => self.base_fee_per_gas,
}
}

/// Parse [`Self::timestamp`] into a [`DateTime<Utc>`].
///
/// # Errors
///
/// * [`TimeError::TimestampZero`] if the timestamp is zero, or
/// * [`TimeError::TimestampOverflow`] if the timestamp is too large to be represented as a
/// [`DateTime<Utc>`].
pub fn time(&self) -> Result<DateTime<Utc>, TimeError> {
if self.timestamp.is_zero() {
return Err(TimeError::TimestampZero)
}
if self.timestamp.bits() > 63 {
return Err(TimeError::TimestampOverflow)
}
// Casting to i64 is safe because the timestamp is guaranteed to be less than 2^63.
// TODO: It would be nice if there was `TryInto<i64> for U256`.
let secs = self.timestamp.as_u64() as i64;
Ok(Utc.timestamp(secs, 0))
}
}

impl Block<TxHash> {
Expand Down
2 changes: 1 addition & 1 deletion ethers-core/src/types/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ mod bytes;
pub use self::bytes::{deserialize_bytes, serialize_bytes, Bytes, ParseBytesError};

mod block;
pub use block::{Block, BlockId, BlockNumber};
pub use block::{Block, BlockId, BlockNumber, TimeError};

#[cfg(feature = "celo")]
pub use block::Randomness;
Expand Down