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.

Sign up for GitHub

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

Jump to bottom

feat: Support unnamed OP chains #8488

Merged
merged 5 commits into from
Jun 3, 2024
Merged

feat: Support unnamed OP chains #8488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
952b3e1
feat: Support un-named OP chains
BrianBland May 29, 2024
c59b8c3
Canyon is before Ecotone
BrianBland May 29, 2024
72d0c3a
Fix unwrapping style
BrianBland May 29, 2024
b0f9ca3
Support variable base fee params
BrianBland May 29, 2024
8f0ee33
Fix const validity
BrianBland May 31, 2024
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
3 changes: 2 additions & 1 deletion crates/net/discv5/src/network_stack_id.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ impl NetworkStackId {
/// ENR fork ID kv-pair key, for an Optimism CL node.
pub const OPSTACK: &'static [u8] = b"opstack";

#[allow(clippy::missing_const_for_fn)]
/// Returns the [`NetworkStackId`] that matches the given [`ChainSpec`].
pub const fn id(chain: &ChainSpec) -> Option<&'static [u8]> {
mattsse marked this conversation as resolved.
Show resolved Hide resolved
pub fn id(chain: &ChainSpec) -> Option<&'static [u8]> {
if chain.is_optimism() {
return Some(Self::OPEL)
} else if chain.is_eth() {
Expand Down
147 changes: 133 additions & 14 deletions crates/primitives/src/chain/spec.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -574,6 +574,14 @@ impl ChainSpec {

/// Returns `true` if this chain contains Optimism configuration.
#[inline]
#[cfg(feature = "optimism")]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: This change attempts to preserve the const behavior when possible, and also prioritizes the const self.chain.is_optimism() case over the slower runtime-evaluated hardfork check. The performance penalty should only impact unnamed chains or non-OP chains when the optimism feature is enabled.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice

pub fn is_optimism(&self) -> bool {
self.chain.is_optimism() || self.hardforks.contains_key(&Hardfork::Bedrock)
}

/// Returns `true` if this chain contains Optimism configuration.
#[inline]
#[cfg(not(feature = "optimism"))]
pub const fn is_optimism(&self) -> bool {
self.chain.is_optimism()
}
Expand Down Expand Up @@ -1041,9 +1049,9 @@ impl From<Genesis> for ChainSpec {
#[cfg(feature = "optimism")]
(Hardfork::Regolith, optimism_genesis_info.regolith_time),
#[cfg(feature = "optimism")]
(Hardfork::Ecotone, optimism_genesis_info.ecotone_time),
#[cfg(feature = "optimism")]
(Hardfork::Canyon, optimism_genesis_info.canyon_time),
#[cfg(feature = "optimism")]
(Hardfork::Ecotone, optimism_genesis_info.ecotone_time),
];

let time_hardforks = time_hardfork_opts
Expand All @@ -1070,6 +1078,8 @@ impl From<Genesis> for ChainSpec {
hardforks,
paris_block_and_final_difficulty,
deposit_contract,
#[cfg(feature = "optimism")]
base_fee_params: optimism_genesis_info.base_fee_params,
..Default::default()
}
}
Expand Down Expand Up @@ -1623,11 +1633,51 @@ struct OptimismGenesisInfo {
regolith_time: Option<u64>,
ecotone_time: Option<u64>,
canyon_time: Option<u64>,
base_fee_params: BaseFeeParamsKind,
}

#[cfg(feature = "optimism")]
impl OptimismGenesisInfo {
fn extract_from(genesis: &Genesis) -> Self {
let optimism_config =
genesis.config.extra_fields.get("optimism").and_then(|value| value.as_object());

let eip1559_elasticity = optimism_config
.and_then(|config| config.get("eip1559Elasticity"))
.and_then(|value| value.as_u64());

let eip1559_denominator = optimism_config
.and_then(|config| config.get("eip1559Denominator"))
.and_then(|value| value.as_u64());

let eip1559_denominator_canyon = optimism_config
.and_then(|config| config.get("eip1559DenominatorCanyon"))
.and_then(|value| value.as_u64());

let base_fee_params = if let (Some(elasticity), Some(denominator)) =
(eip1559_elasticity, eip1559_denominator)
{
if let Some(canyon_denominator) = eip1559_denominator_canyon {
BaseFeeParamsKind::Variable(
vec![
(
Hardfork::London,
BaseFeeParams::new(denominator as u128, elasticity as u128),
),
(
Hardfork::Canyon,
BaseFeeParams::new(canyon_denominator as u128, elasticity as u128),
),
]
.into(),
)
} else {
BaseFeeParams::new(denominator as u128, elasticity as u128).into()
}
} else {
BaseFeeParams::ethereum().into()
};

Self {
bedrock_block: genesis
.config
Expand All @@ -1639,16 +1689,17 @@ impl OptimismGenesisInfo {
.extra_fields
.get("regolithTime")
.and_then(|value| value.as_u64()),
ecotone_time: genesis
canyon_time: genesis
.config
.extra_fields
.get("ecotoneTime")
.get("canyonTime")
.and_then(|value| value.as_u64()),
canyon_time: genesis
ecotone_time: genesis
.config
.extra_fields
.get("canyonTime")
.get("ecotoneTime")
.and_then(|value| value.as_u64()),
base_fee_params,
}
}
}
Expand Down Expand Up @@ -3255,8 +3306,63 @@ Post-merge hard forks (timestamp based):
"config": {
"bedrockBlock": 10,
"regolithTime": 20,
"ecotoneTime": 30,
"canyonTime": 40,
"canyonTime": 30,
"ecotoneTime": 40,
"optimism": {
"eip1559Elasticity": 50,
"eip1559Denominator": 60
}
}
}
"#;
let genesis: Genesis = serde_json::from_str(geth_genesis).unwrap();

let actual_bedrock_block = genesis.config.extra_fields.get("bedrockBlock");
assert_eq!(actual_bedrock_block, Some(serde_json::Value::from(10)).as_ref());
let actual_regolith_timestamp = genesis.config.extra_fields.get("regolithTime");
assert_eq!(actual_regolith_timestamp, Some(serde_json::Value::from(20)).as_ref());
let actual_canyon_timestamp = genesis.config.extra_fields.get("canyonTime");
assert_eq!(actual_canyon_timestamp, Some(serde_json::Value::from(30)).as_ref());
let actual_ecotone_timestamp = genesis.config.extra_fields.get("ecotoneTime");
assert_eq!(actual_ecotone_timestamp, Some(serde_json::Value::from(40)).as_ref());

let optimism_object = genesis.config.extra_fields.get("optimism").unwrap();
assert_eq!(
optimism_object,
&serde_json::json!({
"eip1559Elasticity": 50,
"eip1559Denominator": 60,
})
);

let chain_spec: ChainSpec = genesis.into();

assert_eq!(
chain_spec.base_fee_params,
BaseFeeParamsKind::Constant(BaseFeeParams::new(60, 50))
);

assert!(!chain_spec.is_fork_active_at_block(Hardfork::Bedrock, 0));
assert!(!chain_spec.is_fork_active_at_timestamp(Hardfork::Regolith, 0));
assert!(!chain_spec.is_fork_active_at_timestamp(Hardfork::Canyon, 0));
assert!(!chain_spec.is_fork_active_at_timestamp(Hardfork::Ecotone, 0));

assert!(chain_spec.is_fork_active_at_block(Hardfork::Bedrock, 10));
assert!(chain_spec.is_fork_active_at_timestamp(Hardfork::Regolith, 20));
assert!(chain_spec.is_fork_active_at_timestamp(Hardfork::Canyon, 30));
assert!(chain_spec.is_fork_active_at_timestamp(Hardfork::Ecotone, 40));
}

#[cfg(feature = "optimism")]
#[test]
fn parse_optimism_hardforks_variable_base_fee_params() {
let geth_genesis = r#"
{
"config": {
"bedrockBlock": 10,
"regolithTime": 20,
"canyonTime": 30,
"ecotoneTime": 40,
"optimism": {
"eip1559Elasticity": 50,
"eip1559Denominator": 60,
Expand All @@ -3271,10 +3377,10 @@ Post-merge hard forks (timestamp based):
assert_eq!(actual_bedrock_block, Some(serde_json::Value::from(10)).as_ref());
let actual_regolith_timestamp = genesis.config.extra_fields.get("regolithTime");
assert_eq!(actual_regolith_timestamp, Some(serde_json::Value::from(20)).as_ref());
let actual_ecotone_timestamp = genesis.config.extra_fields.get("ecotoneTime");
assert_eq!(actual_ecotone_timestamp, Some(serde_json::Value::from(30)).as_ref());
let actual_canyon_timestamp = genesis.config.extra_fields.get("canyonTime");
assert_eq!(actual_canyon_timestamp, Some(serde_json::Value::from(40)).as_ref());
assert_eq!(actual_canyon_timestamp, Some(serde_json::Value::from(30)).as_ref());
let actual_ecotone_timestamp = genesis.config.extra_fields.get("ecotoneTime");
assert_eq!(actual_ecotone_timestamp, Some(serde_json::Value::from(40)).as_ref());

let optimism_object = genesis.config.extra_fields.get("optimism").unwrap();
assert_eq!(
Expand All @@ -3285,15 +3391,28 @@ Post-merge hard forks (timestamp based):
"eip1559DenominatorCanyon": 70
})
);

let chain_spec: ChainSpec = genesis.into();

assert_eq!(
chain_spec.base_fee_params,
BaseFeeParamsKind::Variable(
vec![
(Hardfork::London, BaseFeeParams::new(60, 50)),
(Hardfork::Canyon, BaseFeeParams::new(70, 50)),
]
.into()
)
);

assert!(!chain_spec.is_fork_active_at_block(Hardfork::Bedrock, 0));
assert!(!chain_spec.is_fork_active_at_timestamp(Hardfork::Regolith, 0));
assert!(!chain_spec.is_fork_active_at_timestamp(Hardfork::Ecotone, 0));
assert!(!chain_spec.is_fork_active_at_timestamp(Hardfork::Canyon, 0));
assert!(!chain_spec.is_fork_active_at_timestamp(Hardfork::Ecotone, 0));

assert!(chain_spec.is_fork_active_at_block(Hardfork::Bedrock, 10));
assert!(chain_spec.is_fork_active_at_timestamp(Hardfork::Regolith, 20));
assert!(chain_spec.is_fork_active_at_timestamp(Hardfork::Ecotone, 30));
assert!(chain_spec.is_fork_active_at_timestamp(Hardfork::Canyon, 40));
assert!(chain_spec.is_fork_active_at_timestamp(Hardfork::Canyon, 30));
assert!(chain_spec.is_fork_active_at_timestamp(Hardfork::Ecotone, 40));
}
}
Loading