Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: extract optimism genesis info #17

Merged
merged 1 commit into from
Jul 3, 2024
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
2 changes: 2 additions & 0 deletions crates/rpc-types/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@ op-alloy-consensus = { workspace = true, features = ["serde"] }
alloy-primitives = { workspace = true, features = ["rlp", "serde", "std"] }
alloy-rpc-types-eth.workspace = true
alloy-network.workspace = true
alloy-serde.workspace = true

serde = { workspace = true, features = ["derive"] }
serde_json = { workspace = true }

# arbitrary
arbitrary = { workspace = true, features = ["derive"], optional = true }
Expand Down
218 changes: 215 additions & 3 deletions crates/rpc-types/src/genesis.rs
Original file line number Diff line number Diff line change
@@ -1,10 +1,42 @@
//! OP types for genesis data.

/// Genesis info for Optimism.
use alloy_serde::OtherFields;
use serde::de::Error;

/// Container type for all Optimism specific fields in a genesis file.
#[derive(Default, Debug, Clone, Copy, Eq, PartialEq, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct OptimismChainInfo {
/// Genesis information
pub genesis_info: Option<OptimismGenesisInfo>,
/// Base fee information
pub base_fee_info: Option<OptimismBaseFeeInfo>,
}

impl OptimismChainInfo {
/// Extracts the Optimism specific fields from a genesis file. These fields are expected to be
/// contained in the `genesis.config` under `extra_fields` property.
pub fn extract_from(others: &OtherFields) -> Option<Self> {
Self::try_from(others).ok()
}
}

impl TryFrom<&OtherFields> for OptimismChainInfo {
type Error = serde_json::Error;

fn try_from(others: &OtherFields) -> Result<Self, Self::Error> {
let genesis_info = OptimismGenesisInfo::try_from(others).ok();
let base_fee_info = OptimismBaseFeeInfo::try_from(others).ok();

Ok(OptimismChainInfo { genesis_info, base_fee_info })
}
}

/// The Optimism-specific genesis block specification.
#[derive(Default, Debug, Clone, Copy, Eq, PartialEq, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct OptimismGenesisInfo {
/// Bedrock block number
/// bedrock block number
pub bedrock_block: Option<u64>,
/// regolith hardfork timestamp
pub regolith_time: Option<u64>,
Expand All @@ -16,7 +48,22 @@ pub struct OptimismGenesisInfo {
pub fjord_time: Option<u64>,
}

/// Additional base fee info for Optimism.
impl OptimismGenesisInfo {
/// Extract the Optimism-specific genesis info from a genesis file.
pub fn extract_from(others: &OtherFields) -> Option<Self> {
Self::try_from(others).ok()
}
}

impl TryFrom<&OtherFields> for OptimismGenesisInfo {
type Error = serde_json::Error;

fn try_from(others: &OtherFields) -> Result<Self, Self::Error> {
others.deserialize_as()
Vid201 marked this conversation as resolved.
Show resolved Hide resolved
}
}

/// The Optimism-specific base fee specification.
#[derive(Default, Debug, Clone, Copy, Eq, PartialEq, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct OptimismBaseFeeInfo {
Expand All @@ -27,3 +74,168 @@ pub struct OptimismBaseFeeInfo {
/// EIP-1559 denominator after canyon
pub eip1559_denominator_canyon: Option<u64>,
}

impl OptimismBaseFeeInfo {
/// Extracts the Optimism base fee info by looking for the `optimism` key. It is intended to be
/// parsed from a genesis file.
pub fn extract_from(others: &OtherFields) -> Option<Self> {
Self::try_from(others).ok()
}
}

impl TryFrom<&OtherFields> for OptimismBaseFeeInfo {
type Error = serde_json::Error;

fn try_from(others: &OtherFields) -> Result<Self, Self::Error> {
if let Some(Ok(optimism_base_fee_info)) =
others.get_deserialized::<OptimismBaseFeeInfo>("optimism")
{
Ok(optimism_base_fee_info)
Vid201 marked this conversation as resolved.
Show resolved Hide resolved
} else {
Err(serde_json::Error::missing_field("optimism"))
}
}
}

#[cfg(test)]
mod tests {
use super::*;

#[test]
fn test_extract_optimism_genesis_info() {
let genesis_info = r#"
{
"bedrockBlock": 10,
"regolithTime": 12,
"canyonTime": 0,
"ecotoneTime": 0
}
"#;

let others: OtherFields = serde_json::from_str(genesis_info).unwrap();
let genesis_info = OptimismGenesisInfo::extract_from(&others).unwrap();

assert_eq!(
genesis_info,
OptimismGenesisInfo {
bedrock_block: Some(10),
regolith_time: Some(12),
canyon_time: Some(0),
ecotone_time: Some(0),
fjord_time: None,
}
);
}

#[test]
fn test_extract_optimism_base_fee_info() {
let base_fee_info = r#"
{
"optimism": {
"eip1559Elasticity": 0,
"eip1559Denominator": 8,
"eip1559DenominatorCanyon": 8
}
}
"#;

let others: OtherFields = serde_json::from_str(base_fee_info).unwrap();
let base_fee_info = OptimismBaseFeeInfo::extract_from(&others).unwrap();

assert_eq!(
base_fee_info,
OptimismBaseFeeInfo {
eip1559_elasticity: Some(0),
eip1559_denominator: Some(8),
eip1559_denominator_canyon: Some(8),
}
);
}

#[test]
fn test_extract_optimism_chain_info() {
let chain_info = r#"
{
"bedrockBlock": 10,
"regolithTime": 12,
"canyonTime": 0,
"ecotoneTime": 0,
"optimism": {
"eip1559Denominator": 8,
"eip1559DenominatorCanyon": 8
}
}
"#;

let others: OtherFields = serde_json::from_str(chain_info).unwrap();
let chain_info = OptimismChainInfo::extract_from(&others).unwrap();

assert_eq!(
chain_info,
OptimismChainInfo {
genesis_info: Some(OptimismGenesisInfo {
bedrock_block: Some(10),
regolith_time: Some(12),
canyon_time: Some(0),
ecotone_time: Some(0),
fjord_time: None,
}),
base_fee_info: Some(OptimismBaseFeeInfo {
eip1559_elasticity: None,
eip1559_denominator: Some(8),
eip1559_denominator_canyon: Some(8),
}),
}
);

let chain_info = OptimismChainInfo::try_from(&others).unwrap();

assert_eq!(
chain_info,
OptimismChainInfo {
genesis_info: Some(OptimismGenesisInfo {
bedrock_block: Some(10),
regolith_time: Some(12),
canyon_time: Some(0),
ecotone_time: Some(0),
fjord_time: None,
}),
base_fee_info: Some(OptimismBaseFeeInfo {
eip1559_elasticity: None,
eip1559_denominator: Some(8),
eip1559_denominator_canyon: Some(8),
}),
}
);
}

#[test]
fn test_extract_optimism_chain_info_no_base_fee() {
let chain_info = r#"
{
"bedrockBlock": 10,
"regolithTime": 12,
"canyonTime": 0,
"ecotoneTime": 0,
"fjordTime": 0
}
"#;

let others: OtherFields = serde_json::from_str(chain_info).unwrap();
let chain_info = OptimismChainInfo::extract_from(&others).unwrap();

assert_eq!(
chain_info,
OptimismChainInfo {
genesis_info: Some(OptimismGenesisInfo {
bedrock_block: Some(10),
regolith_time: Some(12),
canyon_time: Some(0),
ecotone_time: Some(0),
fjord_time: Some(0),
}),
base_fee_info: None,
}
);
}
}
Loading