) -> OpPayloadAttributes {
diff --git a/crates/proof/executor/src/syscalls/canyon.rs b/crates/proof/executor/src/syscalls/canyon.rs
index 2d48b32222..1797920985 100644
--- a/crates/proof/executor/src/syscalls/canyon.rs
+++ b/crates/proof/executor/src/syscalls/canyon.rs
@@ -2,8 +2,8 @@
use crate::{db::TrieDB, errors::ExecutorResult, TrieDBProvider};
use alloy_primitives::{address, b256, hex, Address, Bytes, B256};
+use kona_genesis::RollupConfig;
use kona_mpt::TrieHinter;
-use maili_genesis::RollupConfig;
use revm::{
primitives::{Account, Bytecode, HashMap},
DatabaseCommit, State,
diff --git a/crates/proof/executor/src/syscalls/eip2935.rs b/crates/proof/executor/src/syscalls/eip2935.rs
index 290335d5b9..49fa3a757d 100644
--- a/crates/proof/executor/src/syscalls/eip2935.rs
+++ b/crates/proof/executor/src/syscalls/eip2935.rs
@@ -10,8 +10,8 @@ use crate::{
};
use alloc::boxed::Box;
use alloy_primitives::B256;
+use kona_genesis::RollupConfig;
use kona_mpt::TrieHinter;
-use maili_genesis::RollupConfig;
use op_alloy_rpc_types_engine::OpPayloadAttributes;
use revm::{
db::State,
diff --git a/crates/proof/executor/src/syscalls/eip4788.rs b/crates/proof/executor/src/syscalls/eip4788.rs
index 8a9ffcd43c..84071c38a8 100644
--- a/crates/proof/executor/src/syscalls/eip4788.rs
+++ b/crates/proof/executor/src/syscalls/eip4788.rs
@@ -8,8 +8,8 @@ use crate::{
};
use alloc::boxed::Box;
use alloy_primitives::B256;
+use kona_genesis::RollupConfig;
use kona_mpt::TrieHinter;
-use maili_genesis::RollupConfig;
use op_alloy_rpc_types_engine::OpPayloadAttributes;
use revm::{
db::State,
diff --git a/crates/proof/executor/src/test_utils.rs b/crates/proof/executor/src/test_utils.rs
index 1beac0cc94..cbff663cf8 100644
--- a/crates/proof/executor/src/test_utils.rs
+++ b/crates/proof/executor/src/test_utils.rs
@@ -13,10 +13,10 @@ use alloy_rlp::Decodable;
use alloy_rpc_client::RpcClient;
use alloy_rpc_types_engine::PayloadAttributes;
use alloy_transport_http::{Client, Http};
+use kona_genesis::RollupConfig;
use kona_host::{DiskKeyValueStore, KeyValueStore};
use kona_mpt::{NoopTrieHinter, TrieNode, TrieProvider};
-use maili_genesis::RollupConfig;
-use maili_registry::ROLLUP_CONFIGS;
+use kona_registry::ROLLUP_CONFIGS;
use op_alloy_rpc_types_engine::OpPayloadAttributes;
use serde::{Deserialize, Serialize};
use std::{env::temp_dir, path::PathBuf, sync::Arc};
diff --git a/crates/proof/preimage/src/lib.rs b/crates/proof/preimage/src/lib.rs
index 25ec7a6283..0a761f88c5 100644
--- a/crates/proof/preimage/src/lib.rs
+++ b/crates/proof/preimage/src/lib.rs
@@ -5,7 +5,7 @@
)]
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
#![cfg_attr(not(test), warn(unused_crate_dependencies))]
-#![cfg_attr(not(any(test, feature = "std")), no_std)]
+#![cfg_attr(not(feature = "std"), no_std)]
extern crate alloc;
@@ -29,7 +29,7 @@ pub use traits::{
PreimageOracleClient, PreimageOracleServer, PreimageServerBackend,
};
-#[cfg(any(test, feature = "std"))]
+#[cfg(feature = "std")]
mod native_channel;
-#[cfg(any(test, feature = "std"))]
+#[cfg(feature = "std")]
pub use native_channel::{BidirectionalChannel, NativeChannel};
diff --git a/crates/proof/proof-interop/Cargo.toml b/crates/proof/proof-interop/Cargo.toml
index ebceec3cbc..db5ef2fc07 100644
--- a/crates/proof/proof-interop/Cargo.toml
+++ b/crates/proof/proof-interop/Cargo.toml
@@ -18,10 +18,8 @@ kona-interop = { workspace = true, features = ["serde"] }
kona-proof.workspace = true
kona-mpt.workspace = true
kona-executor.workspace = true
-
-# Maili
-maili-registry.workspace = true
-maili-genesis = { workspace = true, features = ["serde"] }
+kona-registry.workspace = true
+kona-genesis = { workspace = true, features = ["serde"] }
# Alloy
alloy-rlp.workspace = true
diff --git a/crates/proof/proof-interop/src/boot.rs b/crates/proof/proof-interop/src/boot.rs
index d544f70f96..55fbf9e778 100644
--- a/crates/proof/proof-interop/src/boot.rs
+++ b/crates/proof/proof-interop/src/boot.rs
@@ -5,13 +5,13 @@ use crate::{HintType, PreState, INVALID_TRANSITION, INVALID_TRANSITION_HASH};
use alloc::{string::ToString, vec::Vec};
use alloy_primitives::{Bytes, B256, U256};
use alloy_rlp::Decodable;
+use kona_genesis::RollupConfig;
use kona_preimage::{
errors::PreimageOracleError, CommsClient, HintWriterClient, PreimageKey, PreimageKeyType,
PreimageOracleClient,
};
use kona_proof::errors::OracleProviderError;
-use maili_genesis::RollupConfig;
-use maili_registry::{HashMap, ROLLUP_CONFIGS};
+use kona_registry::{HashMap, ROLLUP_CONFIGS};
use serde::{Deserialize, Serialize};
use thiserror::Error;
use tracing::warn;
diff --git a/crates/proof/proof-interop/src/consolidation.rs b/crates/proof/proof-interop/src/consolidation.rs
index 143cf6fe02..8d3222def0 100644
--- a/crates/proof/proof-interop/src/consolidation.rs
+++ b/crates/proof/proof-interop/src/consolidation.rs
@@ -10,7 +10,7 @@ use kona_interop::{MessageGraph, MessageGraphError};
use kona_mpt::OrderedListWalker;
use kona_preimage::CommsClient;
use kona_proof::{errors::OracleProviderError, l2::OracleL2ChainProvider};
-use maili_registry::{HashMap, ROLLUP_CONFIGS};
+use kona_registry::{HashMap, ROLLUP_CONFIGS};
use op_alloy_consensus::OpTxType;
use op_alloy_rpc_types_engine::OpPayloadAttributes;
use thiserror::Error;
diff --git a/crates/proof/proof-interop/src/lib.rs b/crates/proof/proof-interop/src/lib.rs
index 8d29217d65..02b321259d 100644
--- a/crates/proof/proof-interop/src/lib.rs
+++ b/crates/proof/proof-interop/src/lib.rs
@@ -3,7 +3,7 @@
#![deny(unused_must_use, rust_2018_idioms)]
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
#![cfg_attr(not(test), warn(unused_crate_dependencies))]
-#![cfg_attr(not(any(test, feature = "arbitrary")), no_std)]
+#![cfg_attr(not(feature = "arbitrary"), no_std)]
extern crate alloc;
diff --git a/crates/proof/proof-interop/src/pre_state.rs b/crates/proof/proof-interop/src/pre_state.rs
index 90aeefed14..7c04b54588 100644
--- a/crates/proof/proof-interop/src/pre_state.rs
+++ b/crates/proof/proof-interop/src/pre_state.rs
@@ -24,7 +24,7 @@ pub const INVALID_TRANSITION_HASH: B256 =
/// [TransitionState] is a super-structure of the [SuperRoot] that represents the progress of a
/// pending superchain state transition from one [SuperRoot] to the next.
#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
-#[cfg_attr(any(feature = "arbitrary", test), derive(arbitrary::Arbitrary))]
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
pub enum PreState {
/// The canonical state of the superchain.
SuperRoot(SuperRoot),
@@ -149,7 +149,7 @@ impl Decodable for PreState {
/// The [TransitionState] is a super-structure of the [SuperRoot] that represents the progress of a
/// pending superchain state transition from one [SuperRoot] to the next.
#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
-#[cfg_attr(any(feature = "arbitrary", test), derive(arbitrary::Arbitrary))]
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
pub struct TransitionState {
/// The canonical pre-state super root commitment.
pub pre_state: SuperRoot,
@@ -238,7 +238,7 @@ impl Decodable for TransitionState {
#[derive(
Default, Debug, Clone, Eq, PartialEq, RlpEncodable, RlpDecodable, Serialize, Deserialize,
)]
-#[cfg_attr(any(feature = "arbitrary", test), derive(arbitrary::Arbitrary))]
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
pub struct OptimisticBlock {
/// The block hash of the output root.
pub block_hash: B256,
@@ -256,11 +256,10 @@ impl OptimisticBlock {
#[cfg(test)]
mod test {
use super::{OptimisticBlock, SuperRoot, TransitionState};
+ use alloc::{vec, vec::Vec};
use alloy_primitives::B256;
use alloy_rlp::{Decodable, Encodable};
- use arbitrary::Arbitrary;
use kona_interop::OutputRootWithChain;
- use rand::Rng;
#[test]
fn test_static_transition_state_roundtrip() {
@@ -283,7 +282,10 @@ mod test {
}
#[test]
+ #[cfg(feature = "arbitrary")]
fn test_arbitrary_pre_state_roundtrip() {
+ use arbitrary::Arbitrary;
+ use rand::Rng;
let mut bytes = [0u8; 1024];
rand::rng().fill(bytes.as_mut_slice());
let pre_state =
@@ -295,7 +297,10 @@ mod test {
}
#[test]
+ #[cfg(feature = "arbitrary")]
fn test_arbitrary_transition_state_roundtrip() {
+ use arbitrary::Arbitrary;
+ use rand::Rng;
let mut bytes = [0u8; 1024];
rand::rng().fill(bytes.as_mut_slice());
let transition_state =
diff --git a/crates/proof/proof-interop/src/provider.rs b/crates/proof/proof-interop/src/provider.rs
index 57cdd27662..b2759b8529 100644
--- a/crates/proof/proof-interop/src/provider.rs
+++ b/crates/proof/proof-interop/src/provider.rs
@@ -11,7 +11,7 @@ use kona_interop::InteropProvider;
use kona_mpt::{OrderedListWalker, TrieNode, TrieProvider};
use kona_preimage::{CommsClient, PreimageKey, PreimageKeyType};
use kona_proof::errors::OracleProviderError;
-use maili_registry::HashMap;
+use kona_registry::HashMap;
use op_alloy_consensus::OpReceiptEnvelope;
use spin::RwLock;
diff --git a/crates/proof/proof/Cargo.toml b/crates/proof/proof/Cargo.toml
index 55b6f95575..dfd2aa990c 100644
--- a/crates/proof/proof/Cargo.toml
+++ b/crates/proof/proof/Cargo.toml
@@ -18,12 +18,10 @@ kona-derive.workspace = true
kona-driver.workspace = true
kona-preimage.workspace = true
kona-executor.workspace = true
-
-# Maili
-maili-rpc.workspace = true
-maili-protocol.workspace = true
-maili-registry.workspace = true
-maili-genesis = { workspace = true, features = ["serde"] }
+kona-rpc.workspace = true
+kona-protocol.workspace = true
+kona-registry.workspace = true
+kona-genesis = { workspace = true, features = ["serde"] }
# Alloy
alloy-rlp.workspace = true
diff --git a/crates/proof/proof/src/boot.rs b/crates/proof/proof/src/boot.rs
index d58aff6496..ebdf39a349 100644
--- a/crates/proof/proof/src/boot.rs
+++ b/crates/proof/proof/src/boot.rs
@@ -3,9 +3,9 @@
use crate::errors::OracleProviderError;
use alloy_primitives::{B256, U256};
+use kona_genesis::RollupConfig;
use kona_preimage::{PreimageKey, PreimageOracleClient};
-use maili_genesis::RollupConfig;
-use maili_registry::ROLLUP_CONFIGS;
+use kona_registry::ROLLUP_CONFIGS;
use serde::{Deserialize, Serialize};
/// The local key ident for the L1 head hash.
diff --git a/crates/proof/proof/src/errors.rs b/crates/proof/proof/src/errors.rs
index 3b013acf79..a35474a98d 100644
--- a/crates/proof/proof/src/errors.rs
+++ b/crates/proof/proof/src/errors.rs
@@ -4,7 +4,7 @@ use alloc::string::{String, ToString};
use kona_derive::errors::{PipelineError, PipelineErrorKind};
use kona_mpt::OrderedListWalkerError;
use kona_preimage::errors::PreimageOracleError;
-use maili_protocol::{FromBlockError, OpBlockConversionError};
+use kona_protocol::{FromBlockError, OpBlockConversionError};
use thiserror::Error;
/// Error from an oracle-backed provider.
diff --git a/crates/proof/proof/src/executor.rs b/crates/proof/proof/src/executor.rs
index 364d96028a..a255949ed2 100644
--- a/crates/proof/proof/src/executor.rs
+++ b/crates/proof/proof/src/executor.rs
@@ -8,8 +8,8 @@ use kona_driver::Executor;
use kona_executor::{
ExecutionArtifacts, KonaHandleRegister, StatelessL2BlockExecutor, TrieDBProvider,
};
+use kona_genesis::RollupConfig;
use kona_mpt::TrieHinter;
-use maili_genesis::RollupConfig;
use op_alloy_rpc_types_engine::OpPayloadAttributes;
/// An executor wrapper type.
diff --git a/crates/proof/proof/src/l1/blob_provider.rs b/crates/proof/proof/src/l1/blob_provider.rs
index d42e41df31..b035b767bc 100644
--- a/crates/proof/proof/src/l1/blob_provider.rs
+++ b/crates/proof/proof/src/l1/blob_provider.rs
@@ -8,7 +8,7 @@ use alloy_primitives::keccak256;
use async_trait::async_trait;
use kona_derive::traits::BlobProvider;
use kona_preimage::{CommsClient, PreimageKey, PreimageKeyType};
-use maili_protocol::BlockInfo;
+use kona_protocol::BlockInfo;
/// An oracle-backed blob provider.
#[derive(Debug, Clone)]
diff --git a/crates/proof/proof/src/l1/chain_provider.rs b/crates/proof/proof/src/l1/chain_provider.rs
index 6e63e526ea..86665f7393 100644
--- a/crates/proof/proof/src/l1/chain_provider.rs
+++ b/crates/proof/proof/src/l1/chain_provider.rs
@@ -10,7 +10,7 @@ use async_trait::async_trait;
use kona_derive::traits::ChainProvider;
use kona_mpt::{OrderedListWalker, TrieNode, TrieProvider};
use kona_preimage::{CommsClient, PreimageKey, PreimageKeyType};
-use maili_protocol::BlockInfo;
+use kona_protocol::BlockInfo;
/// The oracle-backed L1 chain provider for the client program.
#[derive(Debug, Clone)]
diff --git a/crates/proof/proof/src/l1/pipeline.rs b/crates/proof/proof/src/l1/pipeline.rs
index 3ebe054716..234e11f1f6 100644
--- a/crates/proof/proof/src/l1/pipeline.rs
+++ b/crates/proof/proof/src/l1/pipeline.rs
@@ -17,10 +17,10 @@ use kona_derive::{
types::{PipelineResult, Signal, StepResult},
};
use kona_driver::{DriverPipeline, PipelineCursor};
+use kona_genesis::{RollupConfig, SystemConfig};
use kona_preimage::CommsClient;
-use maili_genesis::{RollupConfig, SystemConfig};
-use maili_protocol::{BlockInfo, L2BlockInfo};
-use maili_rpc::OpAttributesWithParent;
+use kona_protocol::{BlockInfo, L2BlockInfo};
+use kona_rpc::OpAttributesWithParent;
use spin::RwLock;
/// An oracle-backed derivation pipeline.
diff --git a/crates/proof/proof/src/l2/chain_provider.rs b/crates/proof/proof/src/l2/chain_provider.rs
index 78bac798ec..476c069d12 100644
--- a/crates/proof/proof/src/l2/chain_provider.rs
+++ b/crates/proof/proof/src/l2/chain_provider.rs
@@ -10,10 +10,10 @@ use async_trait::async_trait;
use kona_derive::traits::L2ChainProvider;
use kona_driver::PipelineCursor;
use kona_executor::TrieDBProvider;
+use kona_genesis::{RollupConfig, SystemConfig};
use kona_mpt::{OrderedListWalker, TrieHinter, TrieNode, TrieProvider};
use kona_preimage::{CommsClient, PreimageKey, PreimageKeyType};
-use maili_genesis::{RollupConfig, SystemConfig};
-use maili_protocol::{to_system_config, BatchValidationProvider, L2BlockInfo};
+use kona_protocol::{to_system_config, BatchValidationProvider, L2BlockInfo};
use op_alloy_consensus::{OpBlock, OpTxEnvelope};
use spin::RwLock;
diff --git a/crates/proof/proof/src/sync.rs b/crates/proof/proof/src/sync.rs
index ef765faa8f..24f652282c 100644
--- a/crates/proof/proof/src/sync.rs
+++ b/crates/proof/proof/src/sync.rs
@@ -11,8 +11,8 @@ use core::fmt::Debug;
use kona_derive::traits::ChainProvider;
use kona_driver::{PipelineCursor, TipCursor};
use kona_preimage::CommsClient;
-use maili_protocol::BatchValidationProvider;
-use maili_registry::RollupConfig;
+use kona_protocol::BatchValidationProvider;
+use kona_registry::RollupConfig;
use spin::RwLock;
/// Constructs a [`PipelineCursor`] from the caching oracle, boot info, and providers.
diff --git a/crates/protocol/derive/Cargo.toml b/crates/protocol/derive/Cargo.toml
index 0bc4c47c19..b43e0222ac 100644
--- a/crates/protocol/derive/Cargo.toml
+++ b/crates/protocol/derive/Cargo.toml
@@ -12,10 +12,12 @@ homepage.workspace = true
workspace = true
[dependencies]
-# Maili
-maili-rpc.workspace = true
-maili-genesis.workspace = true
-maili-protocol.workspace = true
+# Services
+kona-rpc.workspace = true
+
+# Protocol
+kona-genesis.workspace = true
+kona-protocol.workspace = true
# Alloy
alloy-eips.workspace = true
@@ -41,7 +43,7 @@ tracing-subscriber = { workspace = true, optional = true, features = ["fmt"] }
spin.workspace = true
proptest.workspace = true
serde_json.workspace = true
-maili-registry.workspace = true
+kona-registry.workspace = true
tokio = { workspace = true, features = ["full"] }
tracing-subscriber = { workspace = true, features = ["fmt"] }
tracing = { workspace = true, features = ["std"] }
@@ -50,8 +52,8 @@ alloy-primitives = { workspace = true, features = ["rlp", "k256", "map", "arbitr
[features]
default = []
serde = [
- "maili-protocol/serde",
- "maili-genesis/serde",
+ "kona-protocol/serde",
+ "kona-genesis/serde",
"alloy-primitives/serde",
"alloy-consensus/serde",
"op-alloy-consensus/serde",
diff --git a/crates/protocol/derive/README.md b/crates/protocol/derive/README.md
index 3f8ff6bce0..fc8183595e 100644
--- a/crates/protocol/derive/README.md
+++ b/crates/protocol/derive/README.md
@@ -15,7 +15,7 @@ The intended way of working with `kona-derive` is to use the [`DerivationPipelin
```rust,ignore
use std::sync::Arc;
-use maili_genesis::RollupConfig;
+use kona_genesis::RollupConfig;
use kona_derive::sources::EthereumDataSource;
use kona_derive::pipeline::PipelineBuilder;
use kona_derive::attributes::StatefulAttributesBuilder;
diff --git a/crates/protocol/derive/src/attributes/stateful.rs b/crates/protocol/derive/src/attributes/stateful.rs
index 14c3ea5a27..124e3a633d 100644
--- a/crates/protocol/derive/src/attributes/stateful.rs
+++ b/crates/protocol/derive/src/attributes/stateful.rs
@@ -12,8 +12,8 @@ use alloy_primitives::{address, Address, Bytes, B256};
use alloy_rlp::Encodable;
use alloy_rpc_types_engine::PayloadAttributes;
use async_trait::async_trait;
-use maili_genesis::RollupConfig;
-use maili_protocol::{
+use kona_genesis::RollupConfig;
+use kona_protocol::{
closing_deposit_context_tx, decode_deposit, L1BlockInfoTx, L2BlockInfo, DEPOSIT_EVENT_ABI_HASH,
};
use op_alloy_consensus::{Hardfork, Hardforks};
@@ -251,8 +251,8 @@ mod tests {
use alloc::vec;
use alloy_consensus::Header;
use alloy_primitives::{Log, LogData, B256, U256, U64};
- use maili_genesis::SystemConfig;
- use maili_protocol::{BlockInfo, DepositError};
+ use kona_genesis::SystemConfig;
+ use kona_protocol::{BlockInfo, DepositError};
fn generate_valid_log() -> Log {
let deposit_contract = address!("1111111111111111111111111111111111111111");
diff --git a/crates/protocol/derive/src/errors/attributes.rs b/crates/protocol/derive/src/errors/attributes.rs
index 198ba2a565..d76ed38543 100644
--- a/crates/protocol/derive/src/errors/attributes.rs
+++ b/crates/protocol/derive/src/errors/attributes.rs
@@ -18,7 +18,7 @@ pub enum BuilderError {
BlockMismatchEpochReset(BlockNumHash, BlockNumHash, B256),
/// [SystemConfig] update failed.
///
- /// [SystemConfig]: maili_genesis::SystemConfig
+ /// [SystemConfig]: kona_genesis::SystemConfig
#[error("System config update failed")]
SystemConfigUpdate,
/// Broken time invariant between L2 and L1.
diff --git a/crates/protocol/derive/src/errors/pipeline.rs b/crates/protocol/derive/src/errors/pipeline.rs
index 2fb13190ad..1bbcf9bc9a 100644
--- a/crates/protocol/derive/src/errors/pipeline.rs
+++ b/crates/protocol/derive/src/errors/pipeline.rs
@@ -3,8 +3,8 @@
use crate::errors::BuilderError;
use alloc::string::String;
use alloy_primitives::B256;
-use maili_genesis::SystemConfigUpdateError;
-use maili_protocol::{DepositError, SpanBatchError};
+use kona_genesis::SystemConfigUpdateError;
+use kona_protocol::{DepositError, SpanBatchError};
use thiserror::Error;
/// [crate::ensure] is a short-hand for bubbling up errors in the case of a condition not being met.
@@ -83,7 +83,7 @@ pub enum PipelineError {
InvalidBatchValidity,
/// [SystemConfig] update error.
///
- /// [SystemConfig]: maili_genesis::SystemConfig
+ /// [SystemConfig]: kona_genesis::SystemConfig
#[error("Error updating system config: {0}")]
SystemConfigUpdate(SystemConfigUpdateError),
/// Attributes builder error variant, with [BuilderError].
diff --git a/crates/protocol/derive/src/errors/stages.rs b/crates/protocol/derive/src/errors/stages.rs
index 81e506bd01..b3cccf6797 100644
--- a/crates/protocol/derive/src/errors/stages.rs
+++ b/crates/protocol/derive/src/errors/stages.rs
@@ -1,6 +1,6 @@
//! Error types for derivation pipeline stages.
-use maili_protocol::MAX_SPAN_BATCH_ELEMENTS;
+use kona_protocol::MAX_SPAN_BATCH_ELEMENTS;
use thiserror::Error;
/// A frame decompression error.
diff --git a/crates/protocol/derive/src/pipeline/builder.rs b/crates/protocol/derive/src/pipeline/builder.rs
index 698ec61ed4..0b0679046e 100644
--- a/crates/protocol/derive/src/pipeline/builder.rs
+++ b/crates/protocol/derive/src/pipeline/builder.rs
@@ -10,8 +10,8 @@ use crate::{
};
use alloc::sync::Arc;
use core::fmt::Debug;
-use maili_genesis::RollupConfig;
-use maili_protocol::BlockInfo;
+use kona_genesis::RollupConfig;
+use kona_protocol::BlockInfo;
type L1TraversalStage = L1Traversal
;
type L1RetrievalStage = L1Retrieval>;
diff --git a/crates/protocol/derive/src/pipeline/core.rs b/crates/protocol/derive/src/pipeline/core.rs
index 45d1f2f99f..d07b035207 100644
--- a/crates/protocol/derive/src/pipeline/core.rs
+++ b/crates/protocol/derive/src/pipeline/core.rs
@@ -10,9 +10,9 @@ use crate::{
use alloc::{boxed::Box, collections::VecDeque, sync::Arc};
use async_trait::async_trait;
use core::fmt::Debug;
-use maili_genesis::{RollupConfig, SystemConfig};
-use maili_protocol::{BlockInfo, L2BlockInfo};
-use maili_rpc::OpAttributesWithParent;
+use kona_genesis::{RollupConfig, SystemConfig};
+use kona_protocol::{BlockInfo, L2BlockInfo};
+use kona_rpc::OpAttributesWithParent;
/// The derivation pipeline is responsible for deriving L2 inputs from L1 data.
#[derive(Debug)]
@@ -195,9 +195,9 @@ mod tests {
use crate::{pipeline::DerivationPipeline, test_utils::*};
use alloc::{string::ToString, sync::Arc};
use alloy_rpc_types_engine::PayloadAttributes;
- use maili_genesis::{RollupConfig, SystemConfig};
- use maili_protocol::L2BlockInfo;
- use maili_rpc::OpAttributesWithParent;
+ use kona_genesis::{RollupConfig, SystemConfig};
+ use kona_protocol::L2BlockInfo;
+ use kona_rpc::OpAttributesWithParent;
use op_alloy_rpc_types_engine::OpPayloadAttributes;
fn default_test_payload_attributes() -> OpAttributesWithParent {
diff --git a/crates/protocol/derive/src/sources/blobs.rs b/crates/protocol/derive/src/sources/blobs.rs
index 2a40221b24..f23db4755b 100644
--- a/crates/protocol/derive/src/sources/blobs.rs
+++ b/crates/protocol/derive/src/sources/blobs.rs
@@ -11,7 +11,7 @@ use alloy_consensus::{Transaction, TxEip4844Variant, TxEnvelope, TxType};
use alloy_eips::eip4844::IndexedBlobHash;
use alloy_primitives::{Address, Bytes};
use async_trait::async_trait;
-use maili_protocol::BlockInfo;
+use kona_protocol::BlockInfo;
/// A data iterator that reads from a blob.
#[derive(Debug, Clone)]
diff --git a/crates/protocol/derive/src/sources/calldata.rs b/crates/protocol/derive/src/sources/calldata.rs
index c2f70766de..3b3e5ebc6f 100644
--- a/crates/protocol/derive/src/sources/calldata.rs
+++ b/crates/protocol/derive/src/sources/calldata.rs
@@ -9,7 +9,7 @@ use alloc::{boxed::Box, collections::VecDeque};
use alloy_consensus::{Transaction, TxEnvelope};
use alloy_primitives::{Address, Bytes};
use async_trait::async_trait;
-use maili_protocol::BlockInfo;
+use kona_protocol::BlockInfo;
/// A data iterator that reads from calldata.
#[derive(Debug, Clone)]
diff --git a/crates/protocol/derive/src/sources/ethereum.rs b/crates/protocol/derive/src/sources/ethereum.rs
index 68e2600e95..ca2f7e1262 100644
--- a/crates/protocol/derive/src/sources/ethereum.rs
+++ b/crates/protocol/derive/src/sources/ethereum.rs
@@ -9,8 +9,8 @@ use crate::{
use alloc::{boxed::Box, fmt::Debug};
use alloy_primitives::Bytes;
use async_trait::async_trait;
-use maili_genesis::RollupConfig;
-use maili_protocol::BlockInfo;
+use kona_genesis::RollupConfig;
+use kona_protocol::BlockInfo;
/// A factory for creating an Ethereum data source provider.
#[derive(Debug, Clone)]
@@ -87,8 +87,8 @@ mod tests {
use alloy_consensus::TxEnvelope;
use alloy_eips::eip2718::Decodable2718;
use alloy_primitives::{address, Address};
- use maili_genesis::{RollupConfig, SystemConfig};
- use maili_protocol::BlockInfo;
+ use kona_genesis::{RollupConfig, SystemConfig};
+ use kona_protocol::BlockInfo;
fn default_test_blob_source() -> BlobSource {
let chain_provider = TestChainProvider::default();
diff --git a/crates/protocol/derive/src/sources/mod.rs b/crates/protocol/derive/src/sources/mod.rs
index da1162acdb..d7a5e5f145 100644
--- a/crates/protocol/derive/src/sources/mod.rs
+++ b/crates/protocol/derive/src/sources/mod.rs
@@ -5,7 +5,7 @@
//! to iterate over data for a given (L2) [BlockInfo].
//!
//! [DataAvailabilityProvider]: crate::traits::DataAvailabilityProvider
-//! [BlockInfo]: maili_protocol::BlockInfo
+//! [BlockInfo]: kona_protocol::BlockInfo
mod blob_data;
pub use blob_data::BlobData;
diff --git a/crates/protocol/derive/src/sources/variant.rs b/crates/protocol/derive/src/sources/variant.rs
index 47b391437d..513e0bdf3e 100644
--- a/crates/protocol/derive/src/sources/variant.rs
+++ b/crates/protocol/derive/src/sources/variant.rs
@@ -42,7 +42,7 @@ where
mod tests {
use super::*;
use crate::test_utils::TestChainProvider;
- use maili_protocol::BlockInfo;
+ use kona_protocol::BlockInfo;
use crate::{
sources::{BlobData, EthereumDataSourceVariant},
diff --git a/crates/protocol/derive/src/stages/attributes_queue.rs b/crates/protocol/derive/src/stages/attributes_queue.rs
index ac1f03f14e..b4d216329e 100644
--- a/crates/protocol/derive/src/stages/attributes_queue.rs
+++ b/crates/protocol/derive/src/stages/attributes_queue.rs
@@ -11,9 +11,9 @@ use crate::{
use alloc::{boxed::Box, sync::Arc};
use async_trait::async_trait;
use core::fmt::Debug;
-use maili_genesis::RollupConfig;
-use maili_protocol::{BlockInfo, L2BlockInfo, SingleBatch};
-use maili_rpc::OpAttributesWithParent;
+use kona_genesis::RollupConfig;
+use kona_protocol::{BlockInfo, L2BlockInfo, SingleBatch};
+use kona_rpc::OpAttributesWithParent;
use op_alloy_rpc_types_engine::OpPayloadAttributes;
/// [AttributesQueue] accepts batches from the [BatchQueue] stage
diff --git a/crates/protocol/derive/src/stages/batch/batch_provider.rs b/crates/protocol/derive/src/stages/batch/batch_provider.rs
index a0f9889672..898af94b7c 100644
--- a/crates/protocol/derive/src/stages/batch/batch_provider.rs
+++ b/crates/protocol/derive/src/stages/batch/batch_provider.rs
@@ -10,8 +10,8 @@ use crate::{
use alloc::{boxed::Box, sync::Arc};
use async_trait::async_trait;
use core::fmt::Debug;
-use maili_genesis::RollupConfig;
-use maili_protocol::{BlockInfo, L2BlockInfo, SingleBatch};
+use kona_genesis::RollupConfig;
+use kona_protocol::{BlockInfo, L2BlockInfo, SingleBatch};
/// The [BatchProvider] stage is a mux between the [BatchQueue] and [BatchValidator] stages.
///
@@ -182,8 +182,8 @@ mod test {
types::ResetSignal,
};
use alloc::{sync::Arc, vec};
- use maili_genesis::RollupConfig;
- use maili_protocol::BlockInfo;
+ use kona_genesis::RollupConfig;
+ use kona_protocol::BlockInfo;
#[test]
fn test_batch_provider_validator_active() {
diff --git a/crates/protocol/derive/src/stages/batch/batch_queue.rs b/crates/protocol/derive/src/stages/batch/batch_queue.rs
index f27d66ddc6..b016cf984a 100644
--- a/crates/protocol/derive/src/stages/batch/batch_queue.rs
+++ b/crates/protocol/derive/src/stages/batch/batch_queue.rs
@@ -9,8 +9,8 @@ use crate::{
use alloc::{boxed::Box, sync::Arc, vec::Vec};
use async_trait::async_trait;
use core::fmt::Debug;
-use maili_genesis::RollupConfig;
-use maili_protocol::{
+use kona_genesis::RollupConfig;
+use kona_protocol::{
Batch, BatchValidity, BatchWithInclusionBlock, BlockInfo, L2BlockInfo, SingleBatch,
};
@@ -51,7 +51,7 @@ where
pub(crate) batches: Vec,
/// A set of cached [SingleBatch]es derived from [SpanBatch]es.
///
- /// [SpanBatch]: maili_protocol::SpanBatch
+ /// [SpanBatch]: kona_protocol::SpanBatch
pub(crate) next_spans: Vec,
/// Used to validate the batches.
pub(crate) fetcher: BF,
@@ -468,8 +468,8 @@ mod tests {
use alloy_eips::{eip2718::Decodable2718, BlockNumHash};
use alloy_primitives::{address, b256, Address, Bytes, TxKind, B256, U256};
use alloy_rlp::{BytesMut, Encodable};
- use maili_genesis::{ChainGenesis, MAX_RLP_BYTES_PER_CHANNEL_FJORD};
- use maili_protocol::{BatchReader, L1BlockInfoBedrock, L1BlockInfoTx};
+ use kona_genesis::{ChainGenesis, MAX_RLP_BYTES_PER_CHANNEL_FJORD};
+ use kona_protocol::{BatchReader, L1BlockInfoBedrock, L1BlockInfoTx};
use op_alloy_consensus::{OpBlock, OpTxEnvelope, OpTxType, TxDeposit};
use tracing::Level;
use tracing_subscriber::layer::SubscriberExt;
diff --git a/crates/protocol/derive/src/stages/batch/batch_stream.rs b/crates/protocol/derive/src/stages/batch/batch_stream.rs
index 83c3e31e3b..6fa210cf27 100644
--- a/crates/protocol/derive/src/stages/batch/batch_stream.rs
+++ b/crates/protocol/derive/src/stages/batch/batch_stream.rs
@@ -9,8 +9,8 @@ use crate::{
use alloc::{boxed::Box, collections::VecDeque, sync::Arc};
use async_trait::async_trait;
use core::fmt::Debug;
-use maili_genesis::RollupConfig;
-use maili_protocol::{
+use kona_genesis::RollupConfig;
+use kona_protocol::{
Batch, BatchValidity, BatchWithInclusionBlock, BlockInfo, L2BlockInfo, SingleBatch, SpanBatch,
};
@@ -226,7 +226,7 @@ mod test {
};
use alloc::vec;
use alloy_eips::NumHash;
- use maili_protocol::{SingleBatch, SpanBatchElement};
+ use kona_protocol::{SingleBatch, SpanBatchElement};
use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt};
#[tokio::test]
diff --git a/crates/protocol/derive/src/stages/batch/batch_validator.rs b/crates/protocol/derive/src/stages/batch/batch_validator.rs
index d1ff9499ab..49bdc65499 100644
--- a/crates/protocol/derive/src/stages/batch/batch_validator.rs
+++ b/crates/protocol/derive/src/stages/batch/batch_validator.rs
@@ -10,8 +10,8 @@ use crate::{
use alloc::{boxed::Box, sync::Arc, vec::Vec};
use async_trait::async_trait;
use core::fmt::Debug;
-use maili_genesis::RollupConfig;
-use maili_protocol::{Batch, BatchValidity, BlockInfo, L2BlockInfo, SingleBatch};
+use kona_genesis::RollupConfig;
+use kona_protocol::{Batch, BatchValidity, BlockInfo, L2BlockInfo, SingleBatch};
/// The [BatchValidator] stage is responsible for validating the [SingleBatch]es from
/// the [BatchStream] [AttributesQueue]'s consumption.
@@ -319,8 +319,8 @@ mod test {
use alloc::{sync::Arc, vec, vec::Vec};
use alloy_eips::{BlockNumHash, NumHash};
use alloy_primitives::B256;
- use maili_genesis::RollupConfig;
- use maili_protocol::{Batch, BlockInfo, L2BlockInfo, SingleBatch, SpanBatch};
+ use kona_genesis::RollupConfig;
+ use kona_protocol::{Batch, BlockInfo, L2BlockInfo, SingleBatch, SpanBatch};
use tracing::Level;
use tracing_subscriber::layer::SubscriberExt;
diff --git a/crates/protocol/derive/src/stages/batch/mod.rs b/crates/protocol/derive/src/stages/batch/mod.rs
index 9e1e1cff4c..69fdab2a63 100644
--- a/crates/protocol/derive/src/stages/batch/mod.rs
+++ b/crates/protocol/derive/src/stages/batch/mod.rs
@@ -5,16 +5,16 @@
//! for streaming [SingleBatch]es from [SpanBatch]es, while the [BatchProvider] stage is responsible
//! for ordering and validating the [Batch]es for the [AttributesQueue] stage.
//!
-//! [Batch]: maili_protocol::Batch
-//! [SingleBatch]: maili_protocol::SingleBatch
-//! [SpanBatch]: maili_protocol::SpanBatch
+//! [Batch]: kona_protocol::Batch
+//! [SingleBatch]: kona_protocol::SingleBatch
+//! [SpanBatch]: kona_protocol::SpanBatch
//! [ChannelReader]: crate::stages::channel::ChannelReader
//! [AttributesQueue]: crate::stages::attributes_queue::AttributesQueue
use crate::types::PipelineResult;
use alloc::boxed::Box;
use async_trait::async_trait;
-use maili_protocol::{Batch, BlockInfo, L2BlockInfo};
+use kona_protocol::{Batch, BlockInfo, L2BlockInfo};
mod batch_stream;
pub use batch_stream::{BatchStream, BatchStreamProvider};
@@ -47,8 +47,8 @@ pub trait NextBatchProvider {
/// Returns the number of [SingleBatch]es that are currently buffered in the [BatchStream]
/// from a [SpanBatch].
///
- /// [SpanBatch]: maili_protocol::SpanBatch
- /// [SingleBatch]: maili_protocol::SingleBatch
+ /// [SpanBatch]: kona_protocol::SpanBatch
+ /// [SingleBatch]: kona_protocol::SingleBatch
fn span_buffer_size(&self) -> usize;
/// Allows the stage to flush the buffer in the [crate::stages::BatchStream]
diff --git a/crates/protocol/derive/src/stages/channel/channel_assembler.rs b/crates/protocol/derive/src/stages/channel/channel_assembler.rs
index da4c5981d5..eea0356dac 100644
--- a/crates/protocol/derive/src/stages/channel/channel_assembler.rs
+++ b/crates/protocol/derive/src/stages/channel/channel_assembler.rs
@@ -10,17 +10,17 @@ use alloc::{boxed::Box, sync::Arc};
use alloy_primitives::{hex, Bytes};
use async_trait::async_trait;
use core::fmt::Debug;
-use maili_genesis::{
+use kona_genesis::{
RollupConfig, MAX_RLP_BYTES_PER_CHANNEL_BEDROCK, MAX_RLP_BYTES_PER_CHANNEL_FJORD,
};
-use maili_protocol::{BlockInfo, Channel};
+use kona_protocol::{BlockInfo, Channel};
/// The [ChannelAssembler] stage is responsible for assembling the [Frame]s from the [FrameQueue]
/// stage into a raw compressed [Channel].
///
-/// [Frame]: maili_protocol::Frame
+/// [Frame]: kona_protocol::Frame
/// [FrameQueue]: crate::stages::FrameQueue
-/// [Channel]: maili_protocol::Channel
+/// [Channel]: kona_protocol::Channel
#[derive(Debug)]
pub struct ChannelAssembler
where
@@ -191,10 +191,10 @@ mod test {
test_utils::{CollectingLayer, TestNextFrameProvider, TraceStorage},
};
use alloc::{sync::Arc, vec};
- use maili_genesis::{
+ use kona_genesis::{
RollupConfig, MAX_RLP_BYTES_PER_CHANNEL_BEDROCK, MAX_RLP_BYTES_PER_CHANNEL_FJORD,
};
- use maili_protocol::BlockInfo;
+ use kona_protocol::BlockInfo;
use tracing::Level;
use tracing_subscriber::layer::SubscriberExt;
diff --git a/crates/protocol/derive/src/stages/channel/channel_bank.rs b/crates/protocol/derive/src/stages/channel/channel_bank.rs
index e101d5e0e1..7500459570 100644
--- a/crates/protocol/derive/src/stages/channel/channel_bank.rs
+++ b/crates/protocol/derive/src/stages/channel/channel_bank.rs
@@ -11,8 +11,8 @@ use alloc::{boxed::Box, collections::VecDeque, sync::Arc};
use alloy_primitives::{hex, map::HashMap, Bytes};
use async_trait::async_trait;
use core::fmt::Debug;
-use maili_genesis::RollupConfig;
-use maili_protocol::{BlockInfo, Channel, ChannelId, Frame};
+use kona_genesis::RollupConfig;
+use kona_protocol::{BlockInfo, Channel, ChannelId, Frame};
/// The maximum size of a channel bank.
pub(crate) const MAX_CHANNEL_BANK_SIZE: usize = 100_000_000;
@@ -429,11 +429,11 @@ mod tests {
assert!(channel_bank.channels.is_empty());
assert_eq!(trace_store.lock().iter().filter(|(l, _)| matches!(l, &Level::WARN)).count(), 0);
assert_eq!(channel_bank.ingest_frame(frame.clone()), Ok(()));
- assert_eq!(channel_bank.size(), maili_protocol::FRAME_OVERHEAD);
+ assert_eq!(channel_bank.size(), kona_protocol::FRAME_OVERHEAD);
assert_eq!(channel_bank.channels.len(), 1);
// This should fail since the frame is already ingested.
assert_eq!(channel_bank.ingest_frame(frame), Ok(()));
- assert_eq!(channel_bank.size(), maili_protocol::FRAME_OVERHEAD);
+ assert_eq!(channel_bank.size(), kona_protocol::FRAME_OVERHEAD);
assert_eq!(channel_bank.channels.len(), 1);
assert_eq!(trace_store.lock().iter().filter(|(l, _)| matches!(l, &Level::WARN)).count(), 1);
}
@@ -508,8 +508,8 @@ mod tests {
let _guard = tracing::subscriber::set_default(subscriber);
let configs: [RollupConfig; 2] = [
- maili_registry::ROLLUP_CONFIGS.get(&10).cloned().unwrap(),
- maili_registry::ROLLUP_CONFIGS.get(&8453).cloned().unwrap(),
+ kona_registry::ROLLUP_CONFIGS.get(&10).cloned().unwrap(),
+ kona_registry::ROLLUP_CONFIGS.get(&8453).cloned().unwrap(),
];
for cfg in configs {
diff --git a/crates/protocol/derive/src/stages/channel/channel_provider.rs b/crates/protocol/derive/src/stages/channel/channel_provider.rs
index 0e686c3d73..139f659fb9 100644
--- a/crates/protocol/derive/src/stages/channel/channel_provider.rs
+++ b/crates/protocol/derive/src/stages/channel/channel_provider.rs
@@ -10,8 +10,8 @@ use alloc::{boxed::Box, sync::Arc};
use alloy_primitives::Bytes;
use async_trait::async_trait;
use core::fmt::Debug;
-use maili_genesis::RollupConfig;
-use maili_protocol::BlockInfo;
+use kona_genesis::RollupConfig;
+use kona_protocol::BlockInfo;
/// The [ChannelProvider] stage is a mux between the [ChannelBank] and [ChannelAssembler] stages.
///
@@ -163,8 +163,8 @@ mod test {
types::ResetSignal,
};
use alloc::{sync::Arc, vec};
- use maili_genesis::RollupConfig;
- use maili_protocol::BlockInfo;
+ use kona_genesis::RollupConfig;
+ use kona_protocol::BlockInfo;
#[test]
fn test_channel_provider_assembler_active() {
diff --git a/crates/protocol/derive/src/stages/channel/channel_reader.rs b/crates/protocol/derive/src/stages/channel/channel_reader.rs
index 1b67a09987..b6854535d9 100644
--- a/crates/protocol/derive/src/stages/channel/channel_reader.rs
+++ b/crates/protocol/derive/src/stages/channel/channel_reader.rs
@@ -10,10 +10,10 @@ use alloc::{boxed::Box, sync::Arc};
use alloy_primitives::Bytes;
use async_trait::async_trait;
use core::fmt::Debug;
-use maili_genesis::{
+use kona_genesis::{
RollupConfig, MAX_RLP_BYTES_PER_CHANNEL_BEDROCK, MAX_RLP_BYTES_PER_CHANNEL_FJORD,
};
-use maili_protocol::{Batch, BatchReader, BlockInfo};
+use kona_protocol::{Batch, BatchReader, BlockInfo};
use tracing::{debug, warn};
/// The [ChannelReader] provider trait.
diff --git a/crates/protocol/derive/src/stages/channel/mod.rs b/crates/protocol/derive/src/stages/channel/mod.rs
index d65c3d5013..67771f495b 100644
--- a/crates/protocol/derive/src/stages/channel/mod.rs
+++ b/crates/protocol/derive/src/stages/channel/mod.rs
@@ -5,16 +5,16 @@
//! is responsible for decoding the [Channel]s into [Batch]es, forwarding the [Batch]es to the
//! [BatchQueue] stage.
//!
-//! [Frame]: maili_protocol::Frame
-//! [Channel]: maili_protocol::Channel
-//! [Batch]: maili_protocol::Batch
+//! [Frame]: kona_protocol::Frame
+//! [Channel]: kona_protocol::Channel
+//! [Batch]: kona_protocol::Batch
//! [FrameQueue]: crate::stages::FrameQueue
//! [BatchQueue]: crate::stages::BatchQueue
use crate::types::PipelineResult;
use alloc::boxed::Box;
use async_trait::async_trait;
-use maili_protocol::Frame;
+use kona_protocol::Frame;
pub(crate) mod channel_provider;
pub use channel_provider::ChannelProvider;
diff --git a/crates/protocol/derive/src/stages/frame_queue.rs b/crates/protocol/derive/src/stages/frame_queue.rs
index 083fd0ae46..f57b0c0567 100644
--- a/crates/protocol/derive/src/stages/frame_queue.rs
+++ b/crates/protocol/derive/src/stages/frame_queue.rs
@@ -10,8 +10,8 @@ use alloc::{boxed::Box, collections::VecDeque, sync::Arc};
use alloy_primitives::Bytes;
use async_trait::async_trait;
use core::fmt::Debug;
-use maili_genesis::RollupConfig;
-use maili_protocol::{BlockInfo, Frame};
+use kona_genesis::RollupConfig;
+use kona_protocol::{BlockInfo, Frame};
/// Provides data frames for the [FrameQueue] stage.
#[async_trait]
diff --git a/crates/protocol/derive/src/stages/l1_retrieval.rs b/crates/protocol/derive/src/stages/l1_retrieval.rs
index 3615a94088..56a4ac743f 100644
--- a/crates/protocol/derive/src/stages/l1_retrieval.rs
+++ b/crates/protocol/derive/src/stages/l1_retrieval.rs
@@ -9,7 +9,7 @@ use crate::{
use alloc::boxed::Box;
use alloy_primitives::Address;
use async_trait::async_trait;
-use maili_protocol::BlockInfo;
+use kona_protocol::BlockInfo;
/// Provides L1 blocks for the [L1Retrieval] stage.
/// This is the previous stage in the pipeline.
@@ -23,7 +23,7 @@ pub trait L1RetrievalProvider {
/// [L1Traversal]: crate::stages::L1Traversal
async fn next_l1_block(&mut self) -> PipelineResult>;
- /// Returns the batcher [Address] from the [maili_genesis::SystemConfig].
+ /// Returns the batcher [Address] from the [kona_genesis::SystemConfig].
fn batcher_addr(&self) -> Address;
}
diff --git a/crates/protocol/derive/src/stages/l1_traversal.rs b/crates/protocol/derive/src/stages/l1_traversal.rs
index 55b30eda2e..4b179154f3 100644
--- a/crates/protocol/derive/src/stages/l1_traversal.rs
+++ b/crates/protocol/derive/src/stages/l1_traversal.rs
@@ -9,8 +9,8 @@ use crate::{
use alloc::{boxed::Box, sync::Arc};
use alloy_primitives::Address;
use async_trait::async_trait;
-use maili_genesis::{RollupConfig, SystemConfig};
-use maili_protocol::BlockInfo;
+use kona_genesis::{RollupConfig, SystemConfig};
+use kona_protocol::BlockInfo;
/// The [L1Traversal] stage of the derivation pipeline.
///
@@ -144,7 +144,7 @@ pub(crate) mod tests {
use alloc::vec;
use alloy_consensus::Receipt;
use alloy_primitives::{address, b256, hex, Bytes, Log, LogData, B256};
- use maili_genesis::{CONFIG_UPDATE_EVENT_VERSION_0, CONFIG_UPDATE_TOPIC};
+ use kona_genesis::{CONFIG_UPDATE_EVENT_VERSION_0, CONFIG_UPDATE_TOPIC};
const L1_SYS_CONFIG_ADDR: Address = address!("1337000000000000000000000000000000000000");
diff --git a/crates/protocol/derive/src/test_utils/attributes_queue.rs b/crates/protocol/derive/src/test_utils/attributes_queue.rs
index e8b34dfa26..688a46cbaa 100644
--- a/crates/protocol/derive/src/test_utils/attributes_queue.rs
+++ b/crates/protocol/derive/src/test_utils/attributes_queue.rs
@@ -10,7 +10,7 @@ use crate::{
use alloc::{boxed::Box, string::ToString, vec::Vec};
use alloy_eips::BlockNumHash;
use async_trait::async_trait;
-use maili_protocol::{BlockInfo, L2BlockInfo, SingleBatch};
+use kona_protocol::{BlockInfo, L2BlockInfo, SingleBatch};
use op_alloy_rpc_types_engine::OpPayloadAttributes;
use thiserror::Error;
diff --git a/crates/protocol/derive/src/test_utils/batch_provider.rs b/crates/protocol/derive/src/test_utils/batch_provider.rs
index 730f553755..3ce0010bc7 100644
--- a/crates/protocol/derive/src/test_utils/batch_provider.rs
+++ b/crates/protocol/derive/src/test_utils/batch_provider.rs
@@ -8,7 +8,7 @@ use crate::{
};
use alloc::{boxed::Box, vec::Vec};
use async_trait::async_trait;
-use maili_protocol::{Batch, BlockInfo, L2BlockInfo};
+use kona_protocol::{Batch, BlockInfo, L2BlockInfo};
/// A mock provider for the [BatchQueue] stage.
#[derive(Debug, Default)]
diff --git a/crates/protocol/derive/src/test_utils/batch_stream.rs b/crates/protocol/derive/src/test_utils/batch_stream.rs
index 2e7cd82e4e..610e27c0c8 100644
--- a/crates/protocol/derive/src/test_utils/batch_stream.rs
+++ b/crates/protocol/derive/src/test_utils/batch_stream.rs
@@ -10,7 +10,7 @@ use crate::{
};
use alloc::{boxed::Box, vec::Vec};
use async_trait::async_trait;
-use maili_protocol::{Batch, BlockInfo};
+use kona_protocol::{Batch, BlockInfo};
/// A mock provider for the [`BatchStream`] stage.
///
diff --git a/crates/protocol/derive/src/test_utils/blob_provider.rs b/crates/protocol/derive/src/test_utils/blob_provider.rs
index f1e2b6edc5..11f6a44630 100644
--- a/crates/protocol/derive/src/test_utils/blob_provider.rs
+++ b/crates/protocol/derive/src/test_utils/blob_provider.rs
@@ -5,7 +5,7 @@ use alloc::{boxed::Box, vec::Vec};
use alloy_eips::eip4844::{Blob, IndexedBlobHash};
use alloy_primitives::{map::HashMap, B256};
use async_trait::async_trait;
-use maili_protocol::BlockInfo;
+use kona_protocol::BlockInfo;
/// A mock blob provider for testing.
#[derive(Debug, Clone, Default)]
diff --git a/crates/protocol/derive/src/test_utils/chain_providers.rs b/crates/protocol/derive/src/test_utils/chain_providers.rs
index c10332d9a1..8c1e2c73bd 100644
--- a/crates/protocol/derive/src/test_utils/chain_providers.rs
+++ b/crates/protocol/derive/src/test_utils/chain_providers.rs
@@ -8,8 +8,8 @@ use alloc::{boxed::Box, string::ToString, sync::Arc, vec::Vec};
use alloy_consensus::{Header, Receipt, TxEnvelope};
use alloy_primitives::{map::HashMap, B256};
use async_trait::async_trait;
-use maili_genesis::{RollupConfig, SystemConfig};
-use maili_protocol::{BatchValidationProvider, BlockInfo, L2BlockInfo};
+use kona_genesis::{RollupConfig, SystemConfig};
+use kona_protocol::{BatchValidationProvider, BlockInfo, L2BlockInfo};
use op_alloy_consensus::OpBlock;
use thiserror::Error;
diff --git a/crates/protocol/derive/src/test_utils/channel_provider.rs b/crates/protocol/derive/src/test_utils/channel_provider.rs
index f9bc066341..a0cbff8284 100644
--- a/crates/protocol/derive/src/test_utils/channel_provider.rs
+++ b/crates/protocol/derive/src/test_utils/channel_provider.rs
@@ -10,7 +10,7 @@ use crate::{
};
use alloc::{boxed::Box, vec::Vec};
use async_trait::async_trait;
-use maili_protocol::{BlockInfo, Frame};
+use kona_protocol::{BlockInfo, Frame};
/// A mock [NextFrameProvider] for testing the [ChannelBank] stage.
///
diff --git a/crates/protocol/derive/src/test_utils/channel_reader.rs b/crates/protocol/derive/src/test_utils/channel_reader.rs
index ed8c19f2e7..27398552b8 100644
--- a/crates/protocol/derive/src/test_utils/channel_reader.rs
+++ b/crates/protocol/derive/src/test_utils/channel_reader.rs
@@ -11,7 +11,7 @@ use crate::{
use alloc::{boxed::Box, vec::Vec};
use alloy_primitives::Bytes;
use async_trait::async_trait;
-use maili_protocol::BlockInfo;
+use kona_protocol::BlockInfo;
/// A mock [ChannelReaderProvider] for testing the [ChannelReader] stage.
///
diff --git a/crates/protocol/derive/src/test_utils/data_availability_provider.rs b/crates/protocol/derive/src/test_utils/data_availability_provider.rs
index 8f179d33f8..bba5e85687 100644
--- a/crates/protocol/derive/src/test_utils/data_availability_provider.rs
+++ b/crates/protocol/derive/src/test_utils/data_availability_provider.rs
@@ -5,7 +5,7 @@ use alloc::{boxed::Box, vec::Vec};
use alloy_primitives::Bytes;
use async_trait::async_trait;
use core::fmt::Debug;
-use maili_protocol::BlockInfo;
+use kona_protocol::BlockInfo;
/// Mock data availability provider
#[derive(Debug, Default)]
diff --git a/crates/protocol/derive/src/test_utils/frame_queue.rs b/crates/protocol/derive/src/test_utils/frame_queue.rs
index cd0f3df1fc..dd51b67952 100644
--- a/crates/protocol/derive/src/test_utils/frame_queue.rs
+++ b/crates/protocol/derive/src/test_utils/frame_queue.rs
@@ -9,7 +9,7 @@ use crate::{
use alloc::{boxed::Box, vec::Vec};
use alloy_primitives::Bytes;
use async_trait::async_trait;
-use maili_protocol::BlockInfo;
+use kona_protocol::BlockInfo;
/// A mock [FrameQueueProvider] for testing the [FrameQueue] stage.
///
diff --git a/crates/protocol/derive/src/test_utils/frames.rs b/crates/protocol/derive/src/test_utils/frames.rs
index 1fe7cce0d0..8f765187c0 100644
--- a/crates/protocol/derive/src/test_utils/frames.rs
+++ b/crates/protocol/derive/src/test_utils/frames.rs
@@ -8,8 +8,8 @@ use crate::{
};
use alloc::{sync::Arc, vec, vec::Vec};
use alloy_primitives::Bytes;
-use maili_genesis::RollupConfig;
-use maili_protocol::{BlockInfo, Frame, DERIVATION_VERSION_0};
+use kona_genesis::RollupConfig;
+use kona_protocol::{BlockInfo, Frame, DERIVATION_VERSION_0};
/// A [FrameQueue] builder.
#[derive(Debug, Default)]
diff --git a/crates/protocol/derive/src/test_utils/macros.rs b/crates/protocol/derive/src/test_utils/macros.rs
index 5e39b60b32..4fbe58e5ff 100644
--- a/crates/protocol/derive/src/test_utils/macros.rs
+++ b/crates/protocol/derive/src/test_utils/macros.rs
@@ -1,14 +1,14 @@
//! Macros used across test utilities.
-/// A shorthand syntax for constructing [maili_protocol::Frame]s.
+/// A shorthand syntax for constructing [kona_protocol::Frame]s.
#[macro_export]
macro_rules! frame {
($id:expr, $number:expr, $data:expr, $is_last:expr) => {
- maili_protocol::Frame { id: [$id; 16], number: $number, data: $data, is_last: $is_last }
+ kona_protocol::Frame { id: [$id; 16], number: $number, data: $data, is_last: $is_last }
};
}
-/// A shorthand syntax for constructing a list of [maili_protocol::Frame]s.
+/// A shorthand syntax for constructing a list of [kona_protocol::Frame]s.
#[macro_export]
macro_rules! frames {
($id:expr, $number:expr, $data:expr, $count:expr) => {{
diff --git a/crates/protocol/derive/src/test_utils/pipeline.rs b/crates/protocol/derive/src/test_utils/pipeline.rs
index 654230fde4..bf496939b2 100644
--- a/crates/protocol/derive/src/test_utils/pipeline.rs
+++ b/crates/protocol/derive/src/test_utils/pipeline.rs
@@ -7,9 +7,9 @@ use crate::{
types::PipelineResult,
};
use alloc::{boxed::Box, sync::Arc};
-use maili_genesis::RollupConfig;
-use maili_protocol::{BlockInfo, L2BlockInfo};
-use maili_rpc::OpAttributesWithParent;
+use kona_genesis::RollupConfig;
+use kona_protocol::{BlockInfo, L2BlockInfo};
+use kona_rpc::OpAttributesWithParent;
// Re-export these types used internally to the test pipeline.
use crate::{
diff --git a/crates/protocol/derive/src/test_utils/sys_config_fetcher.rs b/crates/protocol/derive/src/test_utils/sys_config_fetcher.rs
index 37b8157935..666304f37e 100644
--- a/crates/protocol/derive/src/test_utils/sys_config_fetcher.rs
+++ b/crates/protocol/derive/src/test_utils/sys_config_fetcher.rs
@@ -7,8 +7,8 @@ use crate::{
use alloc::{boxed::Box, string::ToString, sync::Arc};
use alloy_primitives::map::HashMap;
use async_trait::async_trait;
-use maili_genesis::{RollupConfig, SystemConfig};
-use maili_protocol::{BatchValidationProvider, L2BlockInfo};
+use kona_genesis::{RollupConfig, SystemConfig};
+use kona_protocol::{BatchValidationProvider, L2BlockInfo};
use op_alloy_consensus::OpBlock;
use thiserror::Error;
diff --git a/crates/protocol/derive/src/traits/attributes.rs b/crates/protocol/derive/src/traits/attributes.rs
index d612f969ce..f0f97fbce1 100644
--- a/crates/protocol/derive/src/traits/attributes.rs
+++ b/crates/protocol/derive/src/traits/attributes.rs
@@ -4,8 +4,8 @@ use crate::types::PipelineResult;
use alloc::boxed::Box;
use alloy_eips::BlockNumHash;
use async_trait::async_trait;
-use maili_protocol::{L2BlockInfo, SingleBatch};
-use maili_rpc::OpAttributesWithParent;
+use kona_protocol::{L2BlockInfo, SingleBatch};
+use kona_rpc::OpAttributesWithParent;
use op_alloy_rpc_types_engine::OpPayloadAttributes;
/// [AttributesProvider] is a trait abstraction that generalizes the [BatchQueue] stage.
diff --git a/crates/protocol/derive/src/traits/data_sources.rs b/crates/protocol/derive/src/traits/data_sources.rs
index d0f5fa62f4..90dffb718c 100644
--- a/crates/protocol/derive/src/traits/data_sources.rs
+++ b/crates/protocol/derive/src/traits/data_sources.rs
@@ -7,7 +7,7 @@ use alloy_eips::eip4844::{Blob, IndexedBlobHash};
use alloy_primitives::Bytes;
use async_trait::async_trait;
use core::fmt::Display;
-use maili_protocol::BlockInfo;
+use kona_protocol::BlockInfo;
/// The BlobProvider trait specifies the functionality of a data source that can provide blobs.
#[async_trait]
diff --git a/crates/protocol/derive/src/traits/pipeline.rs b/crates/protocol/derive/src/traits/pipeline.rs
index 38b4bd6c5a..b9ddde430d 100644
--- a/crates/protocol/derive/src/traits/pipeline.rs
+++ b/crates/protocol/derive/src/traits/pipeline.rs
@@ -3,9 +3,9 @@
use alloc::boxed::Box;
use async_trait::async_trait;
use core::iter::Iterator;
-use maili_genesis::{RollupConfig, SystemConfig};
-use maili_protocol::L2BlockInfo;
-use maili_rpc::OpAttributesWithParent;
+use kona_genesis::{RollupConfig, SystemConfig};
+use kona_protocol::L2BlockInfo;
+use kona_rpc::OpAttributesWithParent;
use crate::{errors::PipelineErrorKind, traits::OriginProvider, types::StepResult};
diff --git a/crates/protocol/derive/src/traits/providers.rs b/crates/protocol/derive/src/traits/providers.rs
index e3da30fe61..8ff4f81eeb 100644
--- a/crates/protocol/derive/src/traits/providers.rs
+++ b/crates/protocol/derive/src/traits/providers.rs
@@ -6,8 +6,8 @@ use alloy_consensus::{Header, Receipt, TxEnvelope};
use alloy_primitives::B256;
use async_trait::async_trait;
use core::fmt::Display;
-use maili_genesis::{RollupConfig, SystemConfig};
-use maili_protocol::{BatchValidationProvider, BlockInfo};
+use kona_genesis::{RollupConfig, SystemConfig};
+use kona_protocol::{BatchValidationProvider, BlockInfo};
/// Describes the functionality of a data source that can provide information from the blockchain.
#[async_trait]
diff --git a/crates/protocol/derive/src/traits/reset.rs b/crates/protocol/derive/src/traits/reset.rs
index 9604ef381d..9c3a568188 100644
--- a/crates/protocol/derive/src/traits/reset.rs
+++ b/crates/protocol/derive/src/traits/reset.rs
@@ -2,8 +2,8 @@
use alloc::boxed::Box;
use async_trait::async_trait;
-use maili_genesis::SystemConfig;
-use maili_protocol::BlockInfo;
+use kona_genesis::SystemConfig;
+use kona_protocol::BlockInfo;
/// Provides the [BlockInfo] and [SystemConfig] for the stack to reset the stages.
#[async_trait]
diff --git a/crates/protocol/derive/src/traits/stages.rs b/crates/protocol/derive/src/traits/stages.rs
index fe467b0bc0..1bdfe6f605 100644
--- a/crates/protocol/derive/src/traits/stages.rs
+++ b/crates/protocol/derive/src/traits/stages.rs
@@ -2,7 +2,7 @@
use alloc::boxed::Box;
use async_trait::async_trait;
-use maili_protocol::BlockInfo;
+use kona_protocol::BlockInfo;
use crate::types::{PipelineResult, Signal};
diff --git a/crates/protocol/derive/src/types/signals.rs b/crates/protocol/derive/src/types/signals.rs
index 1b529f901c..9a9b01fc46 100644
--- a/crates/protocol/derive/src/types/signals.rs
+++ b/crates/protocol/derive/src/types/signals.rs
@@ -4,8 +4,8 @@
//! of the pipeline. They allow the pipeline driver to perform actions such as
//! resetting all stages in the pipeline through message passing.
-use maili_genesis::SystemConfig;
-use maili_protocol::{BlockInfo, L2BlockInfo};
+use kona_genesis::SystemConfig;
+use kona_protocol::{BlockInfo, L2BlockInfo};
/// A signal to send to the pipeline.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
diff --git a/crates/protocol/driver/Cargo.toml b/crates/protocol/driver/Cargo.toml
index 155cdd444d..c31cbb055a 100644
--- a/crates/protocol/driver/Cargo.toml
+++ b/crates/protocol/driver/Cargo.toml
@@ -15,11 +15,9 @@ workspace = true
# Workspace
kona-derive.workspace = true
kona-executor.workspace = true
-
-# Maili
-maili-rpc.workspace = true
-maili-genesis.workspace = true
-maili-protocol.workspace = true
+kona-rpc.workspace = true
+kona-genesis.workspace = true
+kona-protocol.workspace = true
# Alloy
alloy-rlp.workspace = true
diff --git a/crates/protocol/driver/src/core.rs b/crates/protocol/driver/src/core.rs
index ad7edfc37f..cc62ace0ba 100644
--- a/crates/protocol/driver/src/core.rs
+++ b/crates/protocol/driver/src/core.rs
@@ -12,9 +12,9 @@ use kona_derive::{
types::Signal,
};
use kona_executor::ExecutionArtifacts;
-use maili_genesis::RollupConfig;
-use maili_protocol::L2BlockInfo;
-use maili_rpc::OpAttributesWithParent;
+use kona_genesis::RollupConfig;
+use kona_protocol::L2BlockInfo;
+use kona_rpc::OpAttributesWithParent;
use op_alloy_consensus::{OpBlock, OpTxEnvelope, OpTxType};
use spin::RwLock;
diff --git a/crates/protocol/driver/src/cursor.rs b/crates/protocol/driver/src/cursor.rs
index 4b970fcd36..e241c31dd5 100644
--- a/crates/protocol/driver/src/cursor.rs
+++ b/crates/protocol/driver/src/cursor.rs
@@ -3,7 +3,7 @@
use alloc::collections::{btree_map::BTreeMap, vec_deque::VecDeque};
use alloy_consensus::{Header, Sealed};
use alloy_primitives::{map::HashMap, B256};
-use maili_protocol::{BlockInfo, L2BlockInfo};
+use kona_protocol::{BlockInfo, L2BlockInfo};
use crate::TipCursor;
diff --git a/crates/protocol/driver/src/errors.rs b/crates/protocol/driver/src/errors.rs
index f7b95d2db2..f6deaf6947 100644
--- a/crates/protocol/driver/src/errors.rs
+++ b/crates/protocol/driver/src/errors.rs
@@ -1,7 +1,7 @@
//! Contains driver-related error types.
use kona_derive::errors::PipelineErrorKind;
-use maili_protocol::FromBlockError;
+use kona_protocol::FromBlockError;
use thiserror::Error;
/// A [Result] type for the [DriverError].
@@ -19,7 +19,7 @@ where
/// An error returned by the executor.
#[error("Executor error: {0}")]
Executor(E),
- /// An error returned by the conversion from a block to an [maili_protocol::L2BlockInfo].
+ /// An error returned by the conversion from a block to an [kona_protocol::L2BlockInfo].
#[error("From block error: {0}")]
FromBlock(#[from] FromBlockError),
/// Error decoding or encoding RLP.
diff --git a/crates/protocol/driver/src/pipeline.rs b/crates/protocol/driver/src/pipeline.rs
index 55c8d67122..94c7f7c00e 100644
--- a/crates/protocol/driver/src/pipeline.rs
+++ b/crates/protocol/driver/src/pipeline.rs
@@ -2,8 +2,8 @@
use alloc::boxed::Box;
use async_trait::async_trait;
-use maili_protocol::L2BlockInfo;
-use maili_rpc::OpAttributesWithParent;
+use kona_protocol::L2BlockInfo;
+use kona_rpc::OpAttributesWithParent;
use kona_derive::{
errors::{PipelineError, PipelineErrorKind, ResetError},
diff --git a/crates/protocol/driver/src/tip.rs b/crates/protocol/driver/src/tip.rs
index 29a43353f8..536631ae26 100644
--- a/crates/protocol/driver/src/tip.rs
+++ b/crates/protocol/driver/src/tip.rs
@@ -2,7 +2,7 @@
use alloy_consensus::{Header, Sealed};
use alloy_primitives::B256;
-use maili_protocol::L2BlockInfo;
+use kona_protocol::L2BlockInfo;
/// A cursor that keeps track of the L2 tip block.
#[derive(Debug, Clone)]
diff --git a/crates/protocol/genesis/Cargo.toml b/crates/protocol/genesis/Cargo.toml
new file mode 100644
index 0000000000..ea5239036a
--- /dev/null
+++ b/crates/protocol/genesis/Cargo.toml
@@ -0,0 +1,72 @@
+[package]
+name = "kona-genesis"
+version = "0.1.0"
+description = "Optimism genesis types"
+
+edition.workspace = true
+rust-version.workspace = true
+authors.workspace = true
+license.workspace = true
+homepage.workspace = true
+repository.workspace = true
+exclude.workspace = true
+
+[lints]
+workspace = true
+
+[dependencies]
+# Alloy
+alloy-sol-types.workspace = true
+alloy-primitives.workspace = true
+alloy-consensus.workspace = true
+alloy-eips.workspace = true
+
+# Misc
+thiserror.workspace = true
+derive_more = { workspace = true, features = ["from"] }
+
+# `revm` feature
+revm = { workspace = true, optional = true, features = ["optimism"] }
+
+# `arbitrary` feature
+arbitrary = { workspace = true, features = ["derive"], optional = true }
+
+# `serde` feature
+serde = { workspace = true, optional = true }
+serde_repr = { workspace = true, optional = true }
+kona-serde = { workspace = true, optional = true }
+
+[dev-dependencies]
+rand = { workspace = true, features = ["thread_rng"] }
+serde_json.workspace = true
+arbitrary = { workspace = true, features = ["derive"] }
+alloy-primitives = { workspace = true, features = ["rand", "arbitrary"] }
+
+[features]
+default = []
+revm = ["dep:revm"]
+std = [
+ "alloy-primitives/std",
+ "alloy-sol-types/std",
+ "alloy-consensus/std",
+ "alloy-eips/std",
+ "kona-serde?/std",
+ "serde?/std",
+ "thiserror/std"
+]
+arbitrary = [
+ "std",
+ "dep:arbitrary",
+ "alloy-consensus/arbitrary",
+ "alloy-eips/arbitrary",
+ "alloy-primitives/rand",
+ "alloy-primitives/arbitrary",
+]
+serde = [
+ "dep:serde",
+ "dep:serde_repr",
+ "dep:kona-serde",
+ "alloy-primitives/serde",
+ "alloy-eips/serde",
+ "alloy-consensus/serde",
+]
diff --git a/crates/protocol/genesis/README.md b/crates/protocol/genesis/README.md
new file mode 100644
index 0000000000..753a671567
--- /dev/null
+++ b/crates/protocol/genesis/README.md
@@ -0,0 +1,31 @@
+## `kona-genesis`
+
+
+
+
+
+
+
+
+Genesis types for Optimism.
+
+### Usage
+
+_By default, `kona-genesis` enables both `std` and `serde` features._
+
+If you're working in a `no_std` environment (like [`kona`][kona]), disable default features like so.
+
+```toml
+[dependencies]
+kona-genesis = { version = "x.y.z", default-features = false, features = ["serde"] }
+```
+
+#### Rollup Config
+
+`kona-genesis` exports a `RollupConfig`, the primary genesis type for Optimism Consensus.
+
+
+
+
+[alloy-genesis]: https://github.com/alloy-rs
+[kona]: https://github.com/op-rs/kona/blob/main/Cargo.toml#L137
diff --git a/crates/protocol/genesis/maili/Cargo.toml b/crates/protocol/genesis/maili/Cargo.toml
new file mode 100644
index 0000000000..7ee36971c5
--- /dev/null
+++ b/crates/protocol/genesis/maili/Cargo.toml
@@ -0,0 +1,25 @@
+[package]
+name = "maili-genesis"
+version = "0.2.8"
+description = "Genesis types for optimism"
+
+edition.workspace = true
+rust-version.workspace = true
+authors.workspace = true
+license.workspace = true
+homepage.workspace = true
+repository.workspace = true
+exclude.workspace = true
+
+[lints]
+workspace = true
+
+[dependencies]
+kona-genesis.workspace = true
+
+[features]
+default = ["serde", "std"]
+std = ["kona-genesis/std"]
+revm = ["kona-genesis/revm"]
+serde = ["kona-genesis/serde"]
+arbitrary = ["kona-genesis/arbitrary"]
diff --git a/crates/protocol/genesis/maili/README.md b/crates/protocol/genesis/maili/README.md
new file mode 100644
index 0000000000..00841e66f3
--- /dev/null
+++ b/crates/protocol/genesis/maili/README.md
@@ -0,0 +1,7 @@
+# `maili-genesis`
+
+## Notice
+
+This crate is _deprecated_.
+
+Please use [`kona-genesis`](https://crates.io/crates/kona-genesis) instead.
diff --git a/crates/protocol/genesis/maili/src/lib.rs b/crates/protocol/genesis/maili/src/lib.rs
new file mode 100644
index 0000000000..509e50b238
--- /dev/null
+++ b/crates/protocol/genesis/maili/src/lib.rs
@@ -0,0 +1,10 @@
+#![doc = include_str!("../README.md")]
+#![doc(
+ html_logo_url = "https://raw.githubusercontent.com/op-rs/kona/main/assets/square.png",
+ html_favicon_url = "https://raw.githubusercontent.com/op-rs/kona/main/assets/favicon.ico"
+)]
+#![cfg_attr(not(test), warn(unused_crate_dependencies))]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![no_std]
+
+pub use kona_genesis::*;
diff --git a/crates/protocol/genesis/src/chain/addresses.rs b/crates/protocol/genesis/src/chain/addresses.rs
new file mode 100644
index 0000000000..6b335d2727
--- /dev/null
+++ b/crates/protocol/genesis/src/chain/addresses.rs
@@ -0,0 +1,112 @@
+//! Address Types
+
+use alloy_primitives::Address;
+
+/// The set of network-specific contracts for a given chain.
+///
+/// See:
+#[derive(Debug, Clone, Hash, PartialEq, Eq, Default)]
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "serde", serde(rename_all = "PascalCase"))]
+pub struct AddressList {
+ /// The address manager
+ pub address_manager: Address,
+ /// L1 Cross Domain Messenger proxy address
+ pub l1_cross_domain_messenger_proxy: Address,
+ /// L1 ERC721 Bridge proxy address
+ #[cfg_attr(feature = "serde", serde(alias = "L1ERC721BridgeProxy"))]
+ pub l1_erc721_bridge_proxy: Address,
+ /// L1 Standard Bridge proxy address
+ pub l1_standard_bridge_proxy: Address,
+ /// L2 Output Oracle Proxy address
+ pub l2_output_oracle_proxy: Option,
+ /// Optimism Mintable ERC20 Factory Proxy address
+ #[cfg_attr(feature = "serde", serde(alias = "OptimismMintableERC20FactoryProxy"))]
+ pub optimism_mintable_erc20_factory_proxy: Address,
+ /// Optimism Portal Proxy address
+ pub optimism_portal_proxy: Address,
+ /// System Config Proxy address
+ pub system_config_proxy: Address,
+ /// Proxy Admin address
+ pub proxy_admin: Address,
+ /// The superchain config address
+ pub superchain_config: Option,
+
+ // Fault Proof Contract Addresses
+ /// Anchor State Registry Proxy address
+ pub anchor_state_registry_proxy: Option,
+ /// Delayed WETH Proxy address
+ #[cfg_attr(feature = "serde", serde(alias = "DelayedWETHProxy"))]
+ pub delayed_weth_proxy: Option,
+ /// Dispute Game Factory Proxy address
+ pub dispute_game_factory_proxy: Option,
+ /// Fault Dispute Game Proxy address
+ pub fault_dispute_game: Option,
+ /// MIPS Proxy address
+ #[cfg_attr(feature = "serde", serde(alias = "MIPS"))]
+ pub mips: Option,
+ /// Permissioned Dispute Game Proxy address
+ pub permissioned_dispute_game: Option,
+ /// Preimage Oracle Proxy address
+ pub preimage_oracle: Option,
+ /// The data availability challenge contract address
+ #[cfg_attr(feature = "serde", serde(alias = "DAChallengeAddress"))]
+ pub data_availability_challenge: Option,
+}
+
+impl AddressList {
+ /// Sets zeroed addresses to [`Option::None`].
+ pub fn zero_proof_addresses(&mut self) {
+ if self.anchor_state_registry_proxy == Some(Address::ZERO) {
+ self.anchor_state_registry_proxy = None;
+ }
+ if self.delayed_weth_proxy == Some(Address::ZERO) {
+ self.delayed_weth_proxy = None;
+ }
+ if self.dispute_game_factory_proxy == Some(Address::ZERO) {
+ self.dispute_game_factory_proxy = None;
+ }
+ if self.fault_dispute_game == Some(Address::ZERO) {
+ self.fault_dispute_game = None;
+ }
+ if self.mips == Some(Address::ZERO) {
+ self.mips = None;
+ }
+ if self.permissioned_dispute_game == Some(Address::ZERO) {
+ self.permissioned_dispute_game = None;
+ }
+ if self.preimage_oracle == Some(Address::ZERO) {
+ self.preimage_oracle = None;
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn zero_proof_addresses() {
+ let mut addresses = AddressList {
+ anchor_state_registry_proxy: Some(Address::ZERO),
+ delayed_weth_proxy: Some(Address::ZERO),
+ dispute_game_factory_proxy: Some(Address::ZERO),
+ fault_dispute_game: Some(Address::ZERO),
+ mips: Some(Address::ZERO),
+ permissioned_dispute_game: Some(Address::ZERO),
+ preimage_oracle: Some(Address::ZERO),
+ ..Default::default()
+ };
+
+ addresses.zero_proof_addresses();
+
+ assert_eq!(addresses.anchor_state_registry_proxy, None);
+ assert_eq!(addresses.delayed_weth_proxy, None);
+ assert_eq!(addresses.dispute_game_factory_proxy, None);
+ assert_eq!(addresses.fault_dispute_game, None);
+ assert_eq!(addresses.mips, None);
+ assert_eq!(addresses.permissioned_dispute_game, None);
+ assert_eq!(addresses.preimage_oracle, None);
+ }
+}
diff --git a/crates/protocol/genesis/src/chain/altda.rs b/crates/protocol/genesis/src/chain/altda.rs
new file mode 100644
index 0000000000..63d193b60c
--- /dev/null
+++ b/crates/protocol/genesis/src/chain/altda.rs
@@ -0,0 +1,22 @@
+//! Contains the AltDA config type.
+
+use alloc::string::String;
+use alloy_primitives::Address;
+
+/// AltDA configuration.
+///
+/// See:
+#[derive(Debug, Clone, Default, Hash, Eq, PartialEq)]
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub struct AltDAConfig {
+ /// AltDA challenge address
+ #[cfg_attr(feature = "serde", serde(alias = "da_challenge_contract_address"))]
+ pub da_challenge_address: Option,
+ /// AltDA challenge window time (in seconds)
+ pub da_challenge_window: Option,
+ /// AltDA resolution window time (in seconds)
+ pub da_resolve_window: Option,
+ /// AltDA commitment type
+ pub da_commitment_type: Option,
+}
diff --git a/crates/protocol/genesis/src/chain/config.rs b/crates/protocol/genesis/src/chain/config.rs
new file mode 100644
index 0000000000..7e09e47a36
--- /dev/null
+++ b/crates/protocol/genesis/src/chain/config.rs
@@ -0,0 +1,183 @@
+//! Contains the chain config type.
+
+use alloc::string::String;
+use alloy_eips::eip1559::BaseFeeParams;
+use alloy_primitives::Address;
+
+use crate::{
+ base_fee_params, base_fee_params_canyon, rollup::DEFAULT_INTEROP_MESSAGE_EXPIRY_WINDOW,
+ AddressList, AltDAConfig, BaseFeeConfig, ChainGenesis, HardForkConfiguration, Roles,
+ RollupConfig, SuperchainLevel, GRANITE_CHANNEL_TIMEOUT,
+};
+
+/// Defines core blockchain settings per block.
+///
+/// Tailors unique settings for each network based on
+/// its genesis block and superchain configuration.
+///
+/// This struct bridges the interface between the [`ChainConfig`][ccr]
+/// defined in the [`superchain-registry`][scr] and the [`ChainConfig`][ccg]
+/// defined in [`op-geth`][opg].
+///
+/// [opg]: https://github.com/ethereum-optimism/op-geth
+/// [scr]: https://github.com/ethereum-optimism/superchain-registry
+/// [ccg]: https://github.com/ethereum-optimism/op-geth/blob/optimism/params/config.go#L342
+/// [ccr]: https://github.com/ethereum-optimism/superchain-registry/blob/main/superchain/superchain.go#L80
+#[derive(Debug, Clone, Default, Eq, PartialEq)]
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub struct ChainConfig {
+ /// Chain name (e.g. "Base")
+ #[cfg_attr(feature = "serde", serde(rename = "Name", alias = "name"))]
+ pub name: String,
+ /// L1 chain ID
+ #[cfg_attr(feature = "serde", serde(skip))]
+ pub l1_chain_id: u64,
+ /// Chain public RPC endpoint
+ #[cfg_attr(feature = "serde", serde(rename = "PublicRPC", alias = "public_rpc"))]
+ pub public_rpc: String,
+ /// Chain sequencer RPC endpoint
+ #[cfg_attr(feature = "serde", serde(rename = "SequencerRPC", alias = "sequencer_rpc"))]
+ pub sequencer_rpc: String,
+ /// Chain explorer HTTP endpoint
+ #[cfg_attr(feature = "serde", serde(rename = "Explorer", alias = "explorer"))]
+ pub explorer: String,
+ /// Level of integration with the superchain.
+ #[cfg_attr(feature = "serde", serde(rename = "SuperchainLevel", alias = "superchain_level"))]
+ pub superchain_level: SuperchainLevel,
+ /// Whether the chain is governed by optimism.
+ #[cfg_attr(
+ feature = "serde",
+ serde(rename = "GovernedByOptimism", alias = "governed_by_optimism")
+ )]
+ #[cfg_attr(feature = "serde", serde(default))]
+ pub governed_by_optimism: bool,
+ /// Time of when a given chain is opted in to the Superchain.
+ /// If set, hardforks times after the superchain time
+ /// will be inherited from the superchain-wide config.
+ #[cfg_attr(feature = "serde", serde(rename = "SuperchainTime", alias = "superchain_time"))]
+ pub superchain_time: Option,
+ /// Data availability type.
+ #[cfg_attr(
+ feature = "serde",
+ serde(rename = "DataAvailabilityType", alias = "data_availability_type")
+ )]
+ pub data_availability_type: String,
+ /// Chain ID
+ #[cfg_attr(feature = "serde", serde(rename = "l2_chain_id", alias = "chain_id"))]
+ pub chain_id: u64,
+ /// Chain-specific batch inbox address
+ #[cfg_attr(
+ feature = "serde",
+ serde(rename = "batch_inbox_address", alias = "batch_inbox_addr")
+ )]
+ #[cfg_attr(feature = "serde", serde(default))]
+ pub batch_inbox_addr: Address,
+ /// The block time in seconds.
+ #[cfg_attr(feature = "serde", serde(rename = "block_time"))]
+ pub block_time: u64,
+ /// The sequencer window size in seconds.
+ #[cfg_attr(feature = "serde", serde(rename = "seq_window_size"))]
+ pub seq_window_size: u64,
+ /// The maximum sequencer drift in seconds.
+ #[cfg_attr(feature = "serde", serde(rename = "max_sequencer_drift"))]
+ pub max_sequencer_drift: u64,
+ /// Gas paying token metadata. Not consumed by downstream OPStack components.
+ #[cfg_attr(feature = "serde", serde(rename = "GasPayingToken", alias = "gas_paying_token"))]
+ pub gas_paying_token: Option,
+ /// Hardfork Configuration. These values may override the superchain-wide defaults.
+ #[cfg_attr(feature = "serde", serde(alias = "hardforks"))]
+ pub hardfork_configuration: HardForkConfiguration,
+ /// Optimism configuration
+ #[cfg_attr(feature = "serde", serde(rename = "optimism"))]
+ pub optimism: Option,
+ /// Alternative DA configuration
+ #[cfg_attr(feature = "serde", serde(rename = "alt_da"))]
+ pub alt_da: Option,
+ /// Chain-specific genesis information
+ pub genesis: ChainGenesis,
+ /// Roles
+ #[cfg_attr(feature = "serde", serde(rename = "Roles", alias = "roles"))]
+ pub roles: Option,
+ /// Addresses
+ #[cfg_attr(feature = "serde", serde(rename = "Addresses", alias = "addresses"))]
+ pub addresses: Option,
+}
+
+impl ChainConfig {
+ /// Returns the base fee params for the chain.
+ pub fn base_fee_params(&self) -> BaseFeeParams {
+ self.optimism
+ .as_ref()
+ .map(|op| op.as_base_fee_params())
+ .unwrap_or_else(|| base_fee_params(self.chain_id))
+ }
+
+ /// Returns the canyon base fee params for the chain.
+ pub fn canyon_base_fee_params(&self) -> BaseFeeParams {
+ self.optimism
+ .as_ref()
+ .map(|op| op.as_canyon_base_fee_params())
+ .unwrap_or_else(|| base_fee_params_canyon(self.chain_id))
+ }
+
+ /// Loads the rollup config for the OP-Stack chain given the chain config and address list.
+ #[deprecated(since = "0.2.1", note = "please use `as_rollup_config` instead")]
+ pub fn load_op_stack_rollup_config(&self) -> RollupConfig {
+ self.as_rollup_config()
+ }
+
+ /// Loads the rollup config for the OP-Stack chain given the chain config and address list.
+ pub fn as_rollup_config(&self) -> RollupConfig {
+ RollupConfig {
+ genesis: self.genesis,
+ l1_chain_id: self.l1_chain_id,
+ l2_chain_id: self.chain_id,
+ base_fee_params: self.base_fee_params(),
+ block_time: self.block_time,
+ seq_window_size: self.seq_window_size,
+ max_sequencer_drift: self.max_sequencer_drift,
+ canyon_base_fee_params: self.canyon_base_fee_params(),
+ regolith_time: Some(0),
+ canyon_time: self.hardfork_configuration.canyon_time,
+ delta_time: self.hardfork_configuration.delta_time,
+ ecotone_time: self.hardfork_configuration.ecotone_time,
+ fjord_time: self.hardfork_configuration.fjord_time,
+ granite_time: self.hardfork_configuration.granite_time,
+ holocene_time: self.hardfork_configuration.holocene_time,
+ isthmus_time: self.hardfork_configuration.isthmus_time,
+ interop_time: self.hardfork_configuration.interop_time,
+ batch_inbox_address: self.batch_inbox_addr,
+ deposit_contract_address: self
+ .addresses
+ .as_ref()
+ .map(|a| a.optimism_portal_proxy)
+ .unwrap_or_default(),
+ l1_system_config_address: self
+ .addresses
+ .as_ref()
+ .map(|a| a.system_config_proxy)
+ .unwrap_or_default(),
+ protocol_versions_address: self
+ .addresses
+ .as_ref()
+ .map(|a| a.address_manager)
+ .unwrap_or_default(),
+ superchain_config_address: None,
+ blobs_enabled_l1_timestamp: None,
+ da_challenge_address: self
+ .alt_da
+ .as_ref()
+ .and_then(|alt_da| alt_da.da_challenge_address),
+
+ // The below chain parameters can be different per OP-Stack chain,
+ // but since none of the superchain chains differ, it's not represented in the
+ // superchain-registry yet. This restriction on superchain-chains may change in the
+ // future. Test/Alt configurations can still load custom rollup-configs when
+ // necessary.
+ channel_timeout: 300,
+ granite_channel_timeout: GRANITE_CHANNEL_TIMEOUT,
+ interop_message_expiry_window: DEFAULT_INTEROP_MESSAGE_EXPIRY_WINDOW,
+ }
+ }
+}
diff --git a/crates/protocol/genesis/src/chain/hardfork.rs b/crates/protocol/genesis/src/chain/hardfork.rs
new file mode 100644
index 0000000000..b191c03c89
--- /dev/null
+++ b/crates/protocol/genesis/src/chain/hardfork.rs
@@ -0,0 +1,26 @@
+//! Contains the hardfork configuration for the chain.
+
+/// Hardfork configuration.
+///
+/// See:
+#[derive(Debug, Copy, Clone, Default, Hash, Eq, PartialEq)]
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub struct HardForkConfiguration {
+ /// Canyon hardfork activation time
+ pub canyon_time: Option,
+ /// Delta hardfork activation time
+ pub delta_time: Option,
+ /// Ecotone hardfork activation time
+ pub ecotone_time: Option,
+ /// Fjord hardfork activation time
+ pub fjord_time: Option,
+ /// Granite hardfork activation time
+ pub granite_time: Option,
+ /// Holocene hardfork activation time
+ pub holocene_time: Option,
+ /// Isthmus hardfork activation time
+ pub isthmus_time: Option,
+ /// Interop hardfork activation time
+ pub interop_time: Option,
+}
diff --git a/crates/protocol/genesis/src/chain/mod.rs b/crates/protocol/genesis/src/chain/mod.rs
new file mode 100644
index 0000000000..3bd0f6668d
--- /dev/null
+++ b/crates/protocol/genesis/src/chain/mod.rs
@@ -0,0 +1,28 @@
+//! Module containing the chain config.
+
+/// OP Mainnet chain ID.
+pub const OP_MAINNET_CHAIN_ID: u64 = 10;
+
+/// OP Sepolia chain ID.
+pub const OP_SEPOLIA_CHAIN_ID: u64 = 11155420;
+
+/// Base Sepolia chain ID.
+pub const BASE_MAINNET_CHAIN_ID: u64 = 8453;
+
+/// Base Sepolia chain ID.
+pub const BASE_SEPOLIA_CHAIN_ID: u64 = 84532;
+
+mod addresses;
+pub use addresses::AddressList;
+
+mod config;
+pub use config::ChainConfig;
+
+mod altda;
+pub use altda::AltDAConfig;
+
+mod hardfork;
+pub use hardfork::HardForkConfiguration;
+
+mod roles;
+pub use roles::Roles;
diff --git a/crates/protocol/genesis/src/chain/roles.rs b/crates/protocol/genesis/src/chain/roles.rs
new file mode 100644
index 0000000000..199202b76b
--- /dev/null
+++ b/crates/protocol/genesis/src/chain/roles.rs
@@ -0,0 +1,64 @@
+//! OP Stack component roles.
+
+use alloy_primitives::Address;
+
+/// Roles in the OP Stack.
+///
+/// See:
+#[derive(Debug, Clone, Hash, PartialEq, Eq, Default)]
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "serde", serde(rename_all = "PascalCase"))]
+pub struct Roles {
+ /// The system config owner
+ pub system_config_owner: Option,
+ /// The owner of the Proxy Admin
+ pub proxy_admin_owner: Option,
+ /// The guardian address
+ pub guardian: Option,
+ /// The challenger's address
+ pub challenger: Option,
+ /// The proposer's address
+ pub proposer: Option,
+ /// Unsafe block signer.
+ pub unsafe_block_signer: Option,
+ /// The batch submitter's address
+ pub batch_submitter: Option,
+}
+
+#[cfg(test)]
+#[cfg(feature = "serde")]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn test_roles_serde() {
+ let json_roles: &'static str = r#"{
+ "SystemConfigOwner": "0x8c20c40180751d93E939DDDee3517AE0d1EBeAd2",
+ "ProxyAdminOwner": "0x4377BB0F0103992b31eC12b4d796a8687B8dC8E9",
+ "Guardian": "0x8c20c40180751d93E939DDDee3517AE0d1EBeAd2",
+ "Challenger": "0x8c20c40180751d93E939DDDee3517AE0d1EBeAd2",
+ "Proposer": "0x95014c45078354Ff839f14192228108Eac82E00A",
+ "UnsafeBlockSigner": "0xa95B83e39AA78B00F12fe431865B563793D97AF5",
+ "BatchSubmitter": "0x19CC7073150D9f5888f09E0e9016d2a39667df14"
+ }"#;
+
+ let expected: Roles = Roles {
+ system_config_owner: Some(
+ "0x8c20c40180751d93E939DDDee3517AE0d1EBeAd2".parse().unwrap(),
+ ),
+ proxy_admin_owner: Some("0x4377BB0F0103992b31eC12b4d796a8687B8dC8E9".parse().unwrap()),
+ guardian: Some("0x8c20c40180751d93E939DDDee3517AE0d1EBeAd2".parse().unwrap()),
+ challenger: Some("0x8c20c40180751d93E939DDDee3517AE0d1EBeAd2".parse().unwrap()),
+ proposer: Some("0x95014c45078354Ff839f14192228108Eac82E00A".parse().unwrap()),
+ unsafe_block_signer: Some(
+ "0xa95B83e39AA78B00F12fe431865B563793D97AF5".parse().unwrap(),
+ ),
+ batch_submitter: Some("0x19CC7073150D9f5888f09E0e9016d2a39667df14".parse().unwrap()),
+ };
+
+ let deserialized: Roles = serde_json::from_str(json_roles).unwrap();
+
+ assert_eq!(expected, deserialized);
+ }
+}
diff --git a/crates/protocol/genesis/src/genesis.rs b/crates/protocol/genesis/src/genesis.rs
new file mode 100644
index 0000000000..a447ef69f5
--- /dev/null
+++ b/crates/protocol/genesis/src/genesis.rs
@@ -0,0 +1,91 @@
+//! Genesis types.
+
+use alloy_eips::eip1898::BlockNumHash;
+
+use crate::SystemConfig;
+
+/// Chain genesis information.
+#[derive(Debug, Copy, Clone, Default, Hash, Eq, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub struct ChainGenesis {
+ /// L1 genesis block
+ pub l1: BlockNumHash,
+ /// L2 genesis block
+ pub l2: BlockNumHash,
+ /// Timestamp of the L2 genesis block
+ pub l2_time: u64,
+ /// Optional System configuration
+ pub system_config: Option,
+}
+
+#[cfg(feature = "arbitrary")]
+impl<'a> arbitrary::Arbitrary<'a> for ChainGenesis {
+ fn arbitrary(u: &mut arbitrary::Unstructured<'a>) -> arbitrary::Result {
+ let system_config = Option::::arbitrary(u)?;
+ let l1_num_hash = BlockNumHash {
+ number: u64::arbitrary(u)?,
+ hash: alloy_primitives::B256::arbitrary(u)?,
+ };
+ let l2_num_hash = BlockNumHash {
+ number: u64::arbitrary(u)?,
+ hash: alloy_primitives::B256::arbitrary(u)?,
+ };
+ Ok(Self { l1: l1_num_hash, l2: l2_num_hash, l2_time: u.arbitrary()?, system_config })
+ }
+}
+
+#[cfg(test)]
+#[cfg(feature = "serde")]
+mod tests {
+ use super::*;
+ use alloy_primitives::{address, b256, uint};
+
+ const fn ref_genesis() -> ChainGenesis {
+ ChainGenesis {
+ l1: BlockNumHash {
+ hash: b256!("438335a20d98863a4c0c97999eb2481921ccd28553eac6f913af7c12aec04108"),
+ number: 17422590,
+ },
+ l2: BlockNumHash {
+ hash: b256!("dbf6a80fef073de06add9b0d14026d6e5a86c85f6d102c36d3d8e9cf89c2afd3"),
+ number: 105235063,
+ },
+ l2_time: 1686068903,
+ system_config: Some(SystemConfig {
+ batcher_address: address!("6887246668a3b87F54DeB3b94Ba47a6f63F32985"),
+ overhead: uint!(0xbc_U256),
+ scalar: uint!(0xa6fe0_U256),
+ gas_limit: 30000000,
+ base_fee_scalar: None,
+ blob_base_fee_scalar: None,
+ eip1559_denominator: None,
+ eip1559_elasticity: None,
+ operator_fee_scalar: None,
+ operator_fee_constant: None,
+ }),
+ }
+ }
+
+ #[test]
+ fn test_genesis_serde() {
+ let genesis_str = r#"{
+ "l1": {
+ "hash": "0x438335a20d98863a4c0c97999eb2481921ccd28553eac6f913af7c12aec04108",
+ "number": 17422590
+ },
+ "l2": {
+ "hash": "0xdbf6a80fef073de06add9b0d14026d6e5a86c85f6d102c36d3d8e9cf89c2afd3",
+ "number": 105235063
+ },
+ "l2_time": 1686068903,
+ "system_config": {
+ "batcherAddress": "0x6887246668a3b87F54DeB3b94Ba47a6f63F32985",
+ "overhead": "0x00000000000000000000000000000000000000000000000000000000000000bc",
+ "scalar": "0x00000000000000000000000000000000000000000000000000000000000a6fe0",
+ "gasLimit": 30000000
+ }
+ }"#;
+ let genesis: ChainGenesis = serde_json::from_str(genesis_str).unwrap();
+ assert_eq!(genesis, ref_genesis());
+ }
+}
diff --git a/crates/protocol/genesis/src/lib.rs b/crates/protocol/genesis/src/lib.rs
new file mode 100644
index 0000000000..ffab7d663a
--- /dev/null
+++ b/crates/protocol/genesis/src/lib.rs
@@ -0,0 +1,59 @@
+#![doc = include_str!("../README.md")]
+#![doc(
+ html_logo_url = "https://raw.githubusercontent.com/op-rs/kona/main/assets/square.png",
+ html_favicon_url = "https://raw.githubusercontent.com/op-rs/kona/main/assets/favicon.ico",
+ issue_tracker_base_url = "https://github.com/op-rs/kona/issues/"
+)]
+#![cfg_attr(not(test), warn(unused_crate_dependencies))]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(not(feature = "std"), no_std)]
+
+extern crate alloc;
+
+mod params;
+pub use params::{
+ base_fee_params, base_fee_params_canyon, BaseFeeConfig, BASE_SEPOLIA_BASE_FEE_CONFIG,
+ BASE_SEPOLIA_BASE_FEE_PARAMS, BASE_SEPOLIA_BASE_FEE_PARAMS_CANYON,
+ BASE_SEPOLIA_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER, OP_MAINNET_BASE_FEE_CONFIG,
+ OP_MAINNET_BASE_FEE_PARAMS, OP_MAINNET_BASE_FEE_PARAMS_CANYON,
+ OP_MAINNET_EIP1559_BASE_FEE_MAX_CHANGE_DENOMINATOR_CANYON,
+ OP_MAINNET_EIP1559_DEFAULT_BASE_FEE_MAX_CHANGE_DENOMINATOR,
+ OP_MAINNET_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER, OP_SEPOLIA_BASE_FEE_CONFIG,
+ OP_SEPOLIA_BASE_FEE_PARAMS, OP_SEPOLIA_BASE_FEE_PARAMS_CANYON,
+ OP_SEPOLIA_EIP1559_BASE_FEE_MAX_CHANGE_DENOMINATOR_CANYON,
+ OP_SEPOLIA_EIP1559_DEFAULT_BASE_FEE_MAX_CHANGE_DENOMINATOR,
+ OP_SEPOLIA_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER,
+};
+
+mod superchain;
+pub use superchain::{
+ Superchain, SuperchainConfig, SuperchainL1Info, SuperchainLevel, Superchains,
+};
+
+mod updates;
+pub use updates::{
+ BatcherUpdate, Eip1559Update, GasConfigUpdate, GasLimitUpdate, OperatorFeeUpdate,
+};
+
+mod system;
+pub use system::{
+ BatcherUpdateError, EIP1559UpdateError, GasConfigUpdateError, GasLimitUpdateError,
+ LogProcessingError, OperatorFeeUpdateError, SystemConfig, SystemConfigLog, SystemConfigUpdate,
+ SystemConfigUpdateError, SystemConfigUpdateKind, CONFIG_UPDATE_EVENT_VERSION_0,
+ CONFIG_UPDATE_TOPIC,
+};
+
+mod chain;
+pub use chain::{
+ AddressList, AltDAConfig, ChainConfig, HardForkConfiguration, Roles, BASE_MAINNET_CHAIN_ID,
+ BASE_SEPOLIA_CHAIN_ID, OP_MAINNET_CHAIN_ID, OP_SEPOLIA_CHAIN_ID,
+};
+
+mod genesis;
+pub use genesis::ChainGenesis;
+
+mod rollup;
+pub use rollup::{
+ RollupConfig, DEFAULT_INTEROP_MESSAGE_EXPIRY_WINDOW, FJORD_MAX_SEQUENCER_DRIFT,
+ GRANITE_CHANNEL_TIMEOUT, MAX_RLP_BYTES_PER_CHANNEL_BEDROCK, MAX_RLP_BYTES_PER_CHANNEL_FJORD,
+};
diff --git a/crates/protocol/genesis/src/params.rs b/crates/protocol/genesis/src/params.rs
new file mode 100644
index 0000000000..318b5a9be3
--- /dev/null
+++ b/crates/protocol/genesis/src/params.rs
@@ -0,0 +1,225 @@
+//! Module containing fee parameters.
+
+use alloy_eips::eip1559::BaseFeeParams;
+
+use crate::{
+ BASE_MAINNET_CHAIN_ID, BASE_SEPOLIA_CHAIN_ID, OP_MAINNET_CHAIN_ID, OP_SEPOLIA_CHAIN_ID,
+};
+
+/// Base fee max change denominator for Optimism Mainnet as defined in the Optimism
+/// [transaction costs](https://community.optimism.io/docs/developers/build/differences/#transaction-costs) doc.
+pub const OP_MAINNET_EIP1559_DEFAULT_BASE_FEE_MAX_CHANGE_DENOMINATOR: u128 = 50;
+
+/// Base fee max change denominator for Optimism Mainnet as defined in the Optimism Canyon
+/// hardfork.
+pub const OP_MAINNET_EIP1559_BASE_FEE_MAX_CHANGE_DENOMINATOR_CANYON: u128 = 250;
+
+/// Base fee max change denominator for Optimism Mainnet as defined in the Optimism
+/// [transaction costs](https://community.optimism.io/docs/developers/build/differences/#transaction-costs) doc.
+pub const OP_MAINNET_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER: u128 = 6;
+
+/// Base fee max change denominator for Optimism Sepolia as defined in the Optimism
+/// [transaction costs](https://community.optimism.io/docs/developers/build/differences/#transaction-costs) doc.
+pub const OP_SEPOLIA_EIP1559_DEFAULT_BASE_FEE_MAX_CHANGE_DENOMINATOR: u128 = 50;
+
+/// Base fee max change denominator for Optimism Sepolia as defined in the Optimism Canyon
+/// hardfork.
+pub const OP_SEPOLIA_EIP1559_BASE_FEE_MAX_CHANGE_DENOMINATOR_CANYON: u128 = 250;
+
+/// Base fee max change denominator for Optimism Sepolia as defined in the Optimism
+/// [transaction costs](https://community.optimism.io/docs/developers/build/differences/#transaction-costs) doc.
+pub const OP_SEPOLIA_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER: u128 = 6;
+
+/// Base fee max change denominator for Base Sepolia as defined in the Optimism
+/// [transaction costs](https://community.optimism.io/docs/developers/build/differences/#transaction-costs) doc.
+pub const BASE_SEPOLIA_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER: u128 = 10;
+
+/// Get the base fee parameters for Optimism Sepolia.
+pub const OP_SEPOLIA_BASE_FEE_PARAMS: BaseFeeParams = BaseFeeParams {
+ max_change_denominator: OP_SEPOLIA_EIP1559_DEFAULT_BASE_FEE_MAX_CHANGE_DENOMINATOR,
+ elasticity_multiplier: OP_SEPOLIA_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER,
+};
+
+/// Get the base fee parameters for Base Sepolia.
+pub const BASE_SEPOLIA_BASE_FEE_PARAMS: BaseFeeParams = BaseFeeParams {
+ max_change_denominator: OP_SEPOLIA_EIP1559_DEFAULT_BASE_FEE_MAX_CHANGE_DENOMINATOR,
+ elasticity_multiplier: BASE_SEPOLIA_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER,
+};
+
+/// Get the base fee parameters for Optimism Mainnet.
+pub const OP_MAINNET_BASE_FEE_PARAMS: BaseFeeParams = BaseFeeParams {
+ max_change_denominator: OP_MAINNET_EIP1559_DEFAULT_BASE_FEE_MAX_CHANGE_DENOMINATOR,
+ elasticity_multiplier: OP_MAINNET_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER,
+};
+
+/// Get the base fee parameters for Optimism Sepolia.
+pub const OP_SEPOLIA_BASE_FEE_PARAMS_CANYON: BaseFeeParams = BaseFeeParams {
+ max_change_denominator: OP_SEPOLIA_EIP1559_BASE_FEE_MAX_CHANGE_DENOMINATOR_CANYON,
+ elasticity_multiplier: OP_SEPOLIA_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER,
+};
+
+/// Get the base fee parameters for Base Sepolia.
+pub const BASE_SEPOLIA_BASE_FEE_PARAMS_CANYON: BaseFeeParams = BaseFeeParams {
+ max_change_denominator: OP_SEPOLIA_EIP1559_BASE_FEE_MAX_CHANGE_DENOMINATOR_CANYON,
+ elasticity_multiplier: BASE_SEPOLIA_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER,
+};
+
+/// Get the base fee parameters for Optimism Mainnet.
+pub const OP_MAINNET_BASE_FEE_PARAMS_CANYON: BaseFeeParams = BaseFeeParams {
+ max_change_denominator: OP_MAINNET_EIP1559_BASE_FEE_MAX_CHANGE_DENOMINATOR_CANYON,
+ elasticity_multiplier: OP_MAINNET_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER,
+};
+
+/// Returns the [`BaseFeeParams`] for the given chain id.
+pub const fn base_fee_params(chain_id: u64) -> BaseFeeParams {
+ match chain_id {
+ OP_MAINNET_CHAIN_ID => OP_MAINNET_BASE_FEE_PARAMS,
+ OP_SEPOLIA_CHAIN_ID => OP_SEPOLIA_BASE_FEE_PARAMS,
+ BASE_MAINNET_CHAIN_ID => OP_MAINNET_BASE_FEE_PARAMS,
+ BASE_SEPOLIA_CHAIN_ID => BASE_SEPOLIA_BASE_FEE_PARAMS,
+ _ => OP_MAINNET_BASE_FEE_PARAMS,
+ }
+}
+
+/// Returns the [`BaseFeeParams`] for the given chain id, for canyon hardfork.
+pub const fn base_fee_params_canyon(chain_id: u64) -> BaseFeeParams {
+ match chain_id {
+ OP_MAINNET_CHAIN_ID => OP_MAINNET_BASE_FEE_PARAMS_CANYON,
+ OP_SEPOLIA_CHAIN_ID => OP_SEPOLIA_BASE_FEE_PARAMS_CANYON,
+ BASE_MAINNET_CHAIN_ID => OP_MAINNET_BASE_FEE_PARAMS_CANYON,
+ BASE_SEPOLIA_CHAIN_ID => BASE_SEPOLIA_BASE_FEE_PARAMS_CANYON,
+ _ => OP_MAINNET_BASE_FEE_PARAMS_CANYON,
+ }
+}
+
+/// Get the base fee parameters for Optimism Sepolia.
+pub const OP_SEPOLIA_BASE_FEE_CONFIG: BaseFeeConfig = BaseFeeConfig {
+ eip1559_elasticity: OP_SEPOLIA_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER,
+ eip1559_denominator: OP_SEPOLIA_EIP1559_DEFAULT_BASE_FEE_MAX_CHANGE_DENOMINATOR,
+ eip1559_denominator_canyon: OP_SEPOLIA_EIP1559_BASE_FEE_MAX_CHANGE_DENOMINATOR_CANYON,
+};
+
+/// Get the base fee parameters for Base Sepolia.
+pub const BASE_SEPOLIA_BASE_FEE_CONFIG: BaseFeeConfig = BaseFeeConfig {
+ eip1559_elasticity: BASE_SEPOLIA_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER,
+ eip1559_denominator: OP_SEPOLIA_EIP1559_DEFAULT_BASE_FEE_MAX_CHANGE_DENOMINATOR,
+ eip1559_denominator_canyon: OP_SEPOLIA_EIP1559_BASE_FEE_MAX_CHANGE_DENOMINATOR_CANYON,
+};
+
+/// Get the base fee parameters for Optimism Mainnet.
+pub const OP_MAINNET_BASE_FEE_CONFIG: BaseFeeConfig = BaseFeeConfig {
+ eip1559_elasticity: OP_MAINNET_EIP1559_DEFAULT_ELASTICITY_MULTIPLIER,
+ eip1559_denominator: OP_MAINNET_EIP1559_DEFAULT_BASE_FEE_MAX_CHANGE_DENOMINATOR,
+ eip1559_denominator_canyon: OP_MAINNET_EIP1559_BASE_FEE_MAX_CHANGE_DENOMINATOR_CANYON,
+};
+
+/// Optimism Base Fee Configuration
+#[derive(Debug, Copy, Clone, Eq, PartialEq)]
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub struct BaseFeeConfig {
+ /// EIP 1559 Elasticity Parameter
+ #[cfg_attr(
+ feature = "serde",
+ serde(rename = "eip1559Elasticity", alias = "eip1559_elasticity")
+ )]
+ #[cfg_attr(feature = "serde", serde(with = "kona_serde::quantity"))]
+ pub eip1559_elasticity: u128,
+ /// EIP 1559 Denominator
+ #[cfg_attr(
+ feature = "serde",
+ serde(rename = "eip1559Denominator", alias = "eip1559_denominator")
+ )]
+ #[cfg_attr(feature = "serde", serde(with = "kona_serde::quantity"))]
+ pub eip1559_denominator: u128,
+ /// EIP 1559 Denominator for the Canyon hardfork
+ #[cfg_attr(
+ feature = "serde",
+ serde(rename = "eip1559DenominatorCanyon", alias = "eip1559_denominator_canyon")
+ )]
+ #[cfg_attr(feature = "serde", serde(with = "kona_serde::quantity"))]
+ pub eip1559_denominator_canyon: u128,
+}
+
+impl BaseFeeConfig {
+ /// Returns the inner [BaseFeeParams].
+ pub const fn as_base_fee_params(&self) -> BaseFeeParams {
+ BaseFeeParams {
+ max_change_denominator: self.eip1559_denominator,
+ elasticity_multiplier: self.eip1559_elasticity,
+ }
+ }
+
+ /// Returns the [BaseFeeParams] for the canyon hardfork.
+ pub const fn as_canyon_base_fee_params(&self) -> BaseFeeParams {
+ BaseFeeParams {
+ max_change_denominator: self.eip1559_denominator_canyon,
+ elasticity_multiplier: self.eip1559_elasticity,
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn test_base_fee_params_from_chain_id() {
+ assert_eq!(base_fee_params(OP_MAINNET_CHAIN_ID), OP_MAINNET_BASE_FEE_PARAMS);
+ assert_eq!(base_fee_params(OP_SEPOLIA_CHAIN_ID), OP_SEPOLIA_BASE_FEE_PARAMS);
+ assert_eq!(base_fee_params(BASE_MAINNET_CHAIN_ID), OP_MAINNET_BASE_FEE_PARAMS);
+ assert_eq!(base_fee_params(BASE_SEPOLIA_CHAIN_ID), BASE_SEPOLIA_BASE_FEE_PARAMS);
+ assert_eq!(base_fee_params(0), OP_MAINNET_BASE_FEE_PARAMS);
+ }
+
+ #[test]
+ fn test_base_fee_params_canyon_from_chain_id() {
+ assert_eq!(base_fee_params_canyon(OP_MAINNET_CHAIN_ID), OP_MAINNET_BASE_FEE_PARAMS_CANYON);
+ assert_eq!(base_fee_params_canyon(OP_SEPOLIA_CHAIN_ID), OP_SEPOLIA_BASE_FEE_PARAMS_CANYON);
+ assert_eq!(
+ base_fee_params_canyon(BASE_MAINNET_CHAIN_ID),
+ OP_MAINNET_BASE_FEE_PARAMS_CANYON
+ );
+ assert_eq!(
+ base_fee_params_canyon(BASE_SEPOLIA_CHAIN_ID),
+ BASE_SEPOLIA_BASE_FEE_PARAMS_CANYON
+ );
+ assert_eq!(base_fee_params_canyon(0), OP_MAINNET_BASE_FEE_PARAMS_CANYON);
+ }
+
+ #[test]
+ #[cfg(feature = "serde")]
+ fn test_base_fee_config_ser() {
+ let config = OP_MAINNET_BASE_FEE_CONFIG;
+ let raw_str = serde_json::to_string(&config).unwrap();
+ assert_eq!(
+ raw_str,
+ r#"{"eip1559Elasticity":"0x6","eip1559Denominator":"0x32","eip1559DenominatorCanyon":"0xfa"}"#
+ );
+ }
+
+ #[test]
+ #[cfg(feature = "serde")]
+ fn test_base_fee_config_serde_strs() {
+ let raw_str: &'static str = r#"{"eip1559Elasticity":"6","eip1559Denominator":"50","eip1559DenominatorCanyon":"250"}"#;
+ let config: BaseFeeConfig = serde_json::from_str(raw_str).unwrap();
+ assert_eq!(config, OP_MAINNET_BASE_FEE_CONFIG);
+ }
+
+ #[test]
+ #[cfg(feature = "serde")]
+ fn test_base_fee_config_serde_raw_number() {
+ let raw_str: &'static str =
+ r#"{"eip1559Elasticity":6,"eip1559Denominator":50,"eip1559DenominatorCanyon":250}"#;
+ let config: BaseFeeConfig = serde_json::from_str(raw_str).unwrap();
+ assert_eq!(config, OP_MAINNET_BASE_FEE_CONFIG);
+ }
+
+ #[test]
+ #[cfg(feature = "serde")]
+ fn test_base_fee_config_serde_hex() {
+ let raw_str: &'static str = r#"{"eip1559Elasticity":"0x6","eip1559Denominator":"0x32","eip1559DenominatorCanyon":"0xfa"}"#;
+ let config: BaseFeeConfig = serde_json::from_str(raw_str).unwrap();
+ assert_eq!(config, OP_MAINNET_BASE_FEE_CONFIG);
+ }
+}
diff --git a/crates/protocol/genesis/src/rollup.rs b/crates/protocol/genesis/src/rollup.rs
new file mode 100644
index 0000000000..1627339ac0
--- /dev/null
+++ b/crates/protocol/genesis/src/rollup.rs
@@ -0,0 +1,656 @@
+//! Rollup Config Types
+
+use alloy_eips::eip1559::BaseFeeParams;
+use alloy_primitives::Address;
+
+use crate::{
+ base_fee_params, base_fee_params_canyon, ChainGenesis, HardForkConfiguration,
+ OP_MAINNET_CHAIN_ID,
+};
+
+/// The max rlp bytes per channel for the Bedrock hardfork.
+pub const MAX_RLP_BYTES_PER_CHANNEL_BEDROCK: u64 = 10_000_000;
+
+/// The max rlp bytes per channel for the Fjord hardfork.
+pub const MAX_RLP_BYTES_PER_CHANNEL_FJORD: u64 = 100_000_000;
+
+/// The max sequencer drift when the Fjord hardfork is active.
+pub const FJORD_MAX_SEQUENCER_DRIFT: u64 = 1800;
+
+/// The channel timeout once the Granite hardfork is active.
+pub const GRANITE_CHANNEL_TIMEOUT: u64 = 50;
+
+/// The default interop message expiry window. (1 hour, in seconds)
+pub const DEFAULT_INTEROP_MESSAGE_EXPIRY_WINDOW: u64 = 60 * 60;
+
+#[cfg(feature = "serde")]
+const fn default_granite_channel_timeout() -> u64 {
+ GRANITE_CHANNEL_TIMEOUT
+}
+
+#[cfg(feature = "serde")]
+const fn default_interop_message_expiry_window() -> u64 {
+ DEFAULT_INTEROP_MESSAGE_EXPIRY_WINDOW
+}
+
+/// The Rollup configuration.
+#[derive(Debug, Clone, Eq, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub struct RollupConfig {
+ /// The genesis state of the rollup.
+ pub genesis: ChainGenesis,
+ /// The block time of the L2, in seconds.
+ pub block_time: u64,
+ /// Sequencer batches may not be more than MaxSequencerDrift seconds after
+ /// the L1 timestamp of the sequencing window end.
+ ///
+ /// Note: When L1 has many 1 second consecutive blocks, and L2 grows at fixed 2 seconds,
+ /// the L2 time may still grow beyond this difference.
+ ///
+ /// Note: After the Fjord hardfork, this value becomes a constant of `1800`.
+ pub max_sequencer_drift: u64,
+ /// The sequencer window size.
+ pub seq_window_size: u64,
+ /// Number of L1 blocks between when a channel can be opened and when it can be closed.
+ pub channel_timeout: u64,
+ /// The channel timeout after the Granite hardfork.
+ #[cfg_attr(feature = "serde", serde(default = "default_granite_channel_timeout"))]
+ pub granite_channel_timeout: u64,
+ /// The L1 chain ID
+ pub l1_chain_id: u64,
+ /// The L2 chain ID
+ pub l2_chain_id: u64,
+ /// Base Fee Params
+ #[cfg_attr(feature = "serde", serde(default = "BaseFeeParams::optimism"))]
+ pub base_fee_params: BaseFeeParams,
+ /// Base fee params post-canyon hardfork
+ #[cfg_attr(feature = "serde", serde(default = "BaseFeeParams::optimism_canyon"))]
+ pub canyon_base_fee_params: BaseFeeParams,
+ /// `regolith_time` sets the activation time of the Regolith network-upgrade:
+ /// a pre-mainnet Bedrock change that addresses findings of the Sherlock contest related to
+ /// deposit attributes. "Regolith" is the loose deposited rock that sits on top of Bedrock.
+ /// Active if regolith_time != None && L2 block timestamp >= Some(regolith_time), inactive
+ /// otherwise.
+ #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
+ pub regolith_time: Option,
+ /// `canyon_time` sets the activation time of the Canyon network upgrade.
+ /// Active if `canyon_time` != None && L2 block timestamp >= Some(canyon_time), inactive
+ /// otherwise.
+ #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
+ pub canyon_time: Option,
+ /// `delta_time` sets the activation time of the Delta network upgrade.
+ /// Active if `delta_time` != None && L2 block timestamp >= Some(delta_time), inactive
+ /// otherwise.
+ #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
+ pub delta_time: Option,
+ /// `ecotone_time` sets the activation time of the Ecotone network upgrade.
+ /// Active if `ecotone_time` != None && L2 block timestamp >= Some(ecotone_time), inactive
+ /// otherwise.
+ #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
+ pub ecotone_time: Option,
+ /// `fjord_time` sets the activation time of the Fjord network upgrade.
+ /// Active if `fjord_time` != None && L2 block timestamp >= Some(fjord_time), inactive
+ /// otherwise.
+ #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
+ pub fjord_time: Option,
+ /// `granite_time` sets the activation time for the Granite network upgrade.
+ /// Active if `granite_time` != None && L2 block timestamp >= Some(granite_time), inactive
+ /// otherwise.
+ #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
+ pub granite_time: Option,
+ /// `holocene_time` sets the activation time for the Holocene network upgrade.
+ /// Active if `holocene_time` != None && L2 block timestamp >= Some(holocene_time), inactive
+ /// otherwise.
+ #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
+ pub holocene_time: Option,
+ /// `isthmus_time` sets the activation time for the Isthmus network upgrade.
+ /// Active if `isthmus_time` != None && L2 block timestamp >= Some(isthmus_time), inactive
+ /// otherwise.
+ #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
+ pub isthmus_time: Option,
+ /// `interop_time` sets the activation time for the Interop network upgrade.
+ /// Active if `interop_time` != None && L2 block timestamp >= Some(interop_time), inactive
+ /// otherwise.
+ #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
+ pub interop_time: Option,
+ /// `batch_inbox_address` is the L1 address that batches are sent to.
+ pub batch_inbox_address: Address,
+ /// `deposit_contract_address` is the L1 address that deposits are sent to.
+ pub deposit_contract_address: Address,
+ /// `l1_system_config_address` is the L1 address that the system config is stored at.
+ pub l1_system_config_address: Address,
+ /// `protocol_versions_address` is the L1 address that the protocol versions are stored at.
+ pub protocol_versions_address: Address,
+ /// The superchain config address.
+ #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
+ pub superchain_config_address: Option,
+ /// `blobs_enabled_l1_timestamp` is the timestamp to start reading blobs as a batch data
+ /// source. Optional.
+ #[cfg_attr(
+ feature = "serde",
+ serde(rename = "blobs_data", skip_serializing_if = "Option::is_none")
+ )]
+ pub blobs_enabled_l1_timestamp: Option,
+ /// `da_challenge_address` is the L1 address that the data availability challenge contract is
+ /// stored at.
+ #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
+ pub da_challenge_address: Option,
+ /// `interop_message_expiry_window` is the maximum time (in seconds) that an initiating message
+ /// can be referenced on a remote chain before it expires.
+ #[cfg_attr(feature = "serde", serde(default = "default_interop_message_expiry_window"))]
+ pub interop_message_expiry_window: u64,
+}
+
+#[cfg(feature = "arbitrary")]
+impl<'a> arbitrary::Arbitrary<'a> for RollupConfig {
+ fn arbitrary(u: &mut arbitrary::Unstructured<'a>) -> arbitrary::Result {
+ use crate::{
+ BASE_SEPOLIA_BASE_FEE_PARAMS, BASE_SEPOLIA_BASE_FEE_PARAMS_CANYON,
+ OP_MAINNET_BASE_FEE_PARAMS, OP_MAINNET_BASE_FEE_PARAMS_CANYON,
+ OP_SEPOLIA_BASE_FEE_PARAMS, OP_SEPOLIA_BASE_FEE_PARAMS_CANYON,
+ };
+ let (base_fee_params, canyon_base_fee_params) = match u32::arbitrary(u)? % 3 {
+ 0 => (OP_MAINNET_BASE_FEE_PARAMS, OP_MAINNET_BASE_FEE_PARAMS_CANYON),
+ 1 => (OP_SEPOLIA_BASE_FEE_PARAMS, OP_SEPOLIA_BASE_FEE_PARAMS_CANYON),
+ _ => (BASE_SEPOLIA_BASE_FEE_PARAMS, BASE_SEPOLIA_BASE_FEE_PARAMS_CANYON),
+ };
+
+ Ok(Self {
+ genesis: ChainGenesis::arbitrary(u)?,
+ block_time: u.arbitrary()?,
+ max_sequencer_drift: u.arbitrary()?,
+ seq_window_size: u.arbitrary()?,
+ channel_timeout: u.arbitrary()?,
+ granite_channel_timeout: u.arbitrary()?,
+ l1_chain_id: u.arbitrary()?,
+ l2_chain_id: u.arbitrary()?,
+ base_fee_params,
+ canyon_base_fee_params,
+ regolith_time: Option::::arbitrary(u)?,
+ canyon_time: Option::::arbitrary(u)?,
+ delta_time: Option::::arbitrary(u)?,
+ ecotone_time: Option::::arbitrary(u)?,
+ fjord_time: Option::::arbitrary(u)?,
+ granite_time: Option::::arbitrary(u)?,
+ holocene_time: Option::::arbitrary(u)?,
+ isthmus_time: Option::::arbitrary(u)?,
+ interop_time: Option::::arbitrary(u)?,
+ batch_inbox_address: Address::arbitrary(u)?,
+ deposit_contract_address: Address::arbitrary(u)?,
+ l1_system_config_address: Address::arbitrary(u)?,
+ protocol_versions_address: Address::arbitrary(u)?,
+ superchain_config_address: Option::::arbitrary(u)?,
+ blobs_enabled_l1_timestamp: Option::::arbitrary(u)?,
+ da_challenge_address: Option::::arbitrary(u)?,
+ interop_message_expiry_window: u.arbitrary()?,
+ })
+ }
+}
+
+// Need to manually implement Default because [`BaseFeeParams`] has no Default impl.
+impl Default for RollupConfig {
+ fn default() -> Self {
+ Self {
+ genesis: ChainGenesis::default(),
+ block_time: 0,
+ max_sequencer_drift: 0,
+ seq_window_size: 0,
+ channel_timeout: 0,
+ granite_channel_timeout: GRANITE_CHANNEL_TIMEOUT,
+ l1_chain_id: 0,
+ l2_chain_id: 0,
+ base_fee_params: base_fee_params(OP_MAINNET_CHAIN_ID),
+ canyon_base_fee_params: base_fee_params_canyon(OP_MAINNET_CHAIN_ID),
+ regolith_time: None,
+ canyon_time: None,
+ delta_time: None,
+ ecotone_time: None,
+ fjord_time: None,
+ granite_time: None,
+ holocene_time: None,
+ isthmus_time: None,
+ interop_time: None,
+ batch_inbox_address: Address::ZERO,
+ deposit_contract_address: Address::ZERO,
+ l1_system_config_address: Address::ZERO,
+ protocol_versions_address: Address::ZERO,
+ superchain_config_address: None,
+ blobs_enabled_l1_timestamp: None,
+ da_challenge_address: None,
+ interop_message_expiry_window: DEFAULT_INTEROP_MESSAGE_EXPIRY_WINDOW,
+ }
+ }
+}
+
+#[cfg(feature = "revm")]
+impl RollupConfig {
+ /// Returns the active [`revm::primitives::SpecId`] for the executor.
+ ///
+ /// ## Takes
+ /// - `timestamp`: The timestamp of the executing block.
+ ///
+ /// ## Returns
+ /// The active [`revm::primitives::SpecId`] for the executor.
+ pub fn spec_id(&self, timestamp: u64) -> revm::primitives::SpecId {
+ if self.is_isthmus_active(timestamp) {
+ revm::primitives::SpecId::ISTHMUS
+ } else if self.is_holocene_active(timestamp) {
+ revm::primitives::SpecId::HOLOCENE
+ } else if self.is_fjord_active(timestamp) {
+ revm::primitives::SpecId::FJORD
+ } else if self.is_ecotone_active(timestamp) {
+ revm::primitives::SpecId::ECOTONE
+ } else if self.is_canyon_active(timestamp) {
+ revm::primitives::SpecId::CANYON
+ } else if self.is_regolith_active(timestamp) {
+ revm::primitives::SpecId::REGOLITH
+ } else {
+ revm::primitives::SpecId::BEDROCK
+ }
+ }
+}
+
+impl RollupConfig {
+ /// Returns true if Regolith is active at the given timestamp.
+ pub fn is_regolith_active(&self, timestamp: u64) -> bool {
+ self.regolith_time.is_some_and(|t| timestamp >= t) || self.is_canyon_active(timestamp)
+ }
+
+ /// Returns true if Canyon is active at the given timestamp.
+ pub fn is_canyon_active(&self, timestamp: u64) -> bool {
+ self.canyon_time.is_some_and(|t| timestamp >= t) || self.is_delta_active(timestamp)
+ }
+
+ /// Returns true if Delta is active at the given timestamp.
+ pub fn is_delta_active(&self, timestamp: u64) -> bool {
+ self.delta_time.is_some_and(|t| timestamp >= t) || self.is_ecotone_active(timestamp)
+ }
+
+ /// Returns true if Ecotone is active at the given timestamp.
+ pub fn is_ecotone_active(&self, timestamp: u64) -> bool {
+ self.ecotone_time.is_some_and(|t| timestamp >= t) || self.is_fjord_active(timestamp)
+ }
+
+ /// Returns true if Fjord is active at the given timestamp.
+ pub fn is_fjord_active(&self, timestamp: u64) -> bool {
+ self.fjord_time.is_some_and(|t| timestamp >= t) || self.is_granite_active(timestamp)
+ }
+
+ /// Returns true if Granite is active at the given timestamp.
+ pub fn is_granite_active(&self, timestamp: u64) -> bool {
+ self.granite_time.is_some_and(|t| timestamp >= t) || self.is_holocene_active(timestamp)
+ }
+
+ /// Returns true if Holocene is active at the given timestamp.
+ pub fn is_holocene_active(&self, timestamp: u64) -> bool {
+ self.holocene_time.is_some_and(|t| timestamp >= t) || self.is_isthmus_active(timestamp)
+ }
+
+ /// Returns true if Isthmus is active at the given timestamp.
+ pub fn is_isthmus_active(&self, timestamp: u64) -> bool {
+ self.isthmus_time.is_some_and(|t| timestamp >= t) || self.is_interop_active(timestamp)
+ }
+
+ /// Returns true if Interop is active at the given timestamp.
+ pub fn is_interop_active(&self, timestamp: u64) -> bool {
+ self.interop_time.is_some_and(|t| timestamp >= t)
+ }
+
+ /// Returns true if a DA Challenge proxy Address is provided in the rollup config and the
+ /// address is not zero.
+ pub fn is_alt_da_enabled(&self) -> bool {
+ self.da_challenge_address.is_some_and(|addr| !addr.is_zero())
+ }
+
+ /// Returns the max sequencer drift for the given timestamp.
+ pub fn max_sequencer_drift(&self, timestamp: u64) -> u64 {
+ if self.is_fjord_active(timestamp) {
+ FJORD_MAX_SEQUENCER_DRIFT
+ } else {
+ self.max_sequencer_drift
+ }
+ }
+
+ /// Returns the max rlp bytes per channel for the given timestamp.
+ pub fn max_rlp_bytes_per_channel(&self, timestamp: u64) -> u64 {
+ if self.is_fjord_active(timestamp) {
+ MAX_RLP_BYTES_PER_CHANNEL_FJORD
+ } else {
+ MAX_RLP_BYTES_PER_CHANNEL_BEDROCK
+ }
+ }
+
+ /// Returns the channel timeout for the given timestamp.
+ pub fn channel_timeout(&self, timestamp: u64) -> u64 {
+ if self.is_granite_active(timestamp) {
+ self.granite_channel_timeout
+ } else {
+ self.channel_timeout
+ }
+ }
+
+ /// Returns the [HardForkConfiguration] using [RollupConfig] timestamps.
+ pub const fn hardfork_config(&self) -> HardForkConfiguration {
+ HardForkConfiguration {
+ canyon_time: self.canyon_time,
+ delta_time: self.delta_time,
+ ecotone_time: self.ecotone_time,
+ fjord_time: self.fjord_time,
+ granite_time: self.granite_time,
+ holocene_time: self.holocene_time,
+ isthmus_time: self.isthmus_time,
+ interop_time: self.interop_time,
+ }
+ }
+
+ /// Checks the scalar value in Ecotone.
+ pub fn check_ecotone_l1_system_config_scalar(scalar: [u8; 32]) -> Result<(), &'static str> {
+ let version_byte = scalar[0];
+ match version_byte {
+ 0 => {
+ if scalar[1..28] != [0; 27] {
+ return Err("Bedrock scalar padding not empty");
+ }
+ Ok(())
+ }
+ 1 => {
+ if scalar[1..24] != [0; 23] {
+ return Err("Invalid version 1 scalar padding");
+ }
+ Ok(())
+ }
+ _ => {
+ // ignore the event if it's an unknown scalar format
+ Err("Unrecognized scalar version")
+ }
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ #[cfg(feature = "serde")]
+ use crate::{SystemConfig, OP_MAINNET_BASE_FEE_PARAMS, OP_MAINNET_BASE_FEE_PARAMS_CANYON};
+ #[cfg(feature = "serde")]
+ use alloy_eips::BlockNumHash;
+ use alloy_primitives::address;
+ #[cfg(feature = "serde")]
+ use alloy_primitives::{b256, U256};
+
+ #[test]
+ #[cfg(feature = "arbitrary")]
+ fn test_arbitrary_rollup_config() {
+ use arbitrary::Arbitrary;
+ use rand::Rng;
+ let mut bytes = [0u8; 1024];
+ rand::rng().fill(bytes.as_mut_slice());
+ RollupConfig::arbitrary(&mut arbitrary::Unstructured::new(&bytes)).unwrap();
+ }
+
+ #[test]
+ #[cfg(feature = "revm")]
+ fn test_revm_spec_id() {
+ // By default, the spec ID should be BEDROCK.
+ let mut config = RollupConfig { regolith_time: Some(10), ..Default::default() };
+ assert_eq!(config.spec_id(0), revm::primitives::SpecId::BEDROCK);
+ assert_eq!(config.spec_id(10), revm::primitives::SpecId::REGOLITH);
+ config.canyon_time = Some(20);
+ assert_eq!(config.spec_id(20), revm::primitives::SpecId::CANYON);
+ config.ecotone_time = Some(30);
+ assert_eq!(config.spec_id(30), revm::primitives::SpecId::ECOTONE);
+ config.fjord_time = Some(40);
+ assert_eq!(config.spec_id(40), revm::primitives::SpecId::FJORD);
+ config.holocene_time = Some(50);
+ assert_eq!(config.spec_id(50), revm::primitives::SpecId::HOLOCENE);
+ config.isthmus_time = Some(60);
+ assert_eq!(config.spec_id(60), revm::primitives::SpecId::ISTHMUS);
+ }
+
+ #[test]
+ fn test_regolith_active() {
+ let mut config = RollupConfig::default();
+ assert!(!config.is_regolith_active(0));
+ config.regolith_time = Some(10);
+ assert!(config.is_regolith_active(10));
+ assert!(!config.is_regolith_active(9));
+ }
+
+ #[test]
+ fn test_canyon_active() {
+ let mut config = RollupConfig::default();
+ assert!(!config.is_canyon_active(0));
+ config.canyon_time = Some(10);
+ assert!(config.is_regolith_active(10));
+ assert!(config.is_canyon_active(10));
+ assert!(!config.is_canyon_active(9));
+ }
+
+ #[test]
+ fn test_delta_active() {
+ let mut config = RollupConfig::default();
+ assert!(!config.is_delta_active(0));
+ config.delta_time = Some(10);
+ assert!(config.is_regolith_active(10));
+ assert!(config.is_canyon_active(10));
+ assert!(config.is_delta_active(10));
+ assert!(!config.is_delta_active(9));
+ }
+
+ #[test]
+ fn test_ecotone_active() {
+ let mut config = RollupConfig::default();
+ assert!(!config.is_ecotone_active(0));
+ config.ecotone_time = Some(10);
+ assert!(config.is_regolith_active(10));
+ assert!(config.is_canyon_active(10));
+ assert!(config.is_delta_active(10));
+ assert!(config.is_ecotone_active(10));
+ assert!(!config.is_ecotone_active(9));
+ }
+
+ #[test]
+ fn test_fjord_active() {
+ let mut config = RollupConfig::default();
+ assert!(!config.is_fjord_active(0));
+ config.fjord_time = Some(10);
+ assert!(config.is_regolith_active(10));
+ assert!(config.is_canyon_active(10));
+ assert!(config.is_delta_active(10));
+ assert!(config.is_ecotone_active(10));
+ assert!(config.is_fjord_active(10));
+ assert!(!config.is_fjord_active(9));
+ }
+
+ #[test]
+ fn test_granite_active() {
+ let mut config = RollupConfig::default();
+ assert!(!config.is_granite_active(0));
+ config.granite_time = Some(10);
+ assert!(config.is_regolith_active(10));
+ assert!(config.is_canyon_active(10));
+ assert!(config.is_delta_active(10));
+ assert!(config.is_ecotone_active(10));
+ assert!(config.is_fjord_active(10));
+ assert!(config.is_granite_active(10));
+ assert!(!config.is_granite_active(9));
+ }
+
+ #[test]
+ fn test_holocene_active() {
+ let mut config = RollupConfig::default();
+ assert!(!config.is_holocene_active(0));
+ config.holocene_time = Some(10);
+ assert!(config.is_regolith_active(10));
+ assert!(config.is_canyon_active(10));
+ assert!(config.is_delta_active(10));
+ assert!(config.is_ecotone_active(10));
+ assert!(config.is_fjord_active(10));
+ assert!(config.is_granite_active(10));
+ assert!(config.is_holocene_active(10));
+ assert!(!config.is_holocene_active(9));
+ }
+
+ #[test]
+ fn test_isthmus_active() {
+ let mut config = RollupConfig::default();
+ assert!(!config.is_isthmus_active(0));
+ config.isthmus_time = Some(10);
+ assert!(config.is_regolith_active(10));
+ assert!(config.is_canyon_active(10));
+ assert!(config.is_delta_active(10));
+ assert!(config.is_ecotone_active(10));
+ assert!(config.is_fjord_active(10));
+ assert!(config.is_granite_active(10));
+ assert!(config.is_holocene_active(10));
+ assert!(config.is_isthmus_active(10));
+ assert!(!config.is_isthmus_active(9));
+ }
+
+ #[test]
+ fn test_interop_active() {
+ let mut config = RollupConfig::default();
+ assert!(!config.is_interop_active(0));
+ config.interop_time = Some(10);
+ assert!(config.is_regolith_active(10));
+ assert!(config.is_canyon_active(10));
+ assert!(config.is_delta_active(10));
+ assert!(config.is_ecotone_active(10));
+ assert!(config.is_fjord_active(10));
+ assert!(config.is_granite_active(10));
+ assert!(config.is_holocene_active(10));
+ assert!(config.is_isthmus_active(10));
+ assert!(config.is_interop_active(10));
+ assert!(!config.is_interop_active(9));
+ }
+
+ #[test]
+ fn test_alt_da_enabled() {
+ let mut config = RollupConfig::default();
+ assert!(!config.is_alt_da_enabled());
+ config.da_challenge_address = Some(Address::ZERO);
+ assert!(!config.is_alt_da_enabled());
+ config.da_challenge_address = Some(address!("0000000000000000000000000000000000000001"));
+ assert!(config.is_alt_da_enabled());
+ }
+
+ #[test]
+ fn test_granite_channel_timeout() {
+ let mut config =
+ RollupConfig { channel_timeout: 100, granite_time: Some(10), ..Default::default() };
+ assert_eq!(config.channel_timeout(0), 100);
+ assert_eq!(config.channel_timeout(10), GRANITE_CHANNEL_TIMEOUT);
+ config.granite_time = None;
+ assert_eq!(config.channel_timeout(10), 100);
+ }
+
+ #[test]
+ fn test_max_sequencer_drift() {
+ let mut config = RollupConfig { max_sequencer_drift: 100, ..Default::default() };
+ assert_eq!(config.max_sequencer_drift(0), 100);
+ config.fjord_time = Some(10);
+ assert_eq!(config.max_sequencer_drift(0), 100);
+ assert_eq!(config.max_sequencer_drift(10), FJORD_MAX_SEQUENCER_DRIFT);
+ }
+
+ #[test]
+ #[cfg(feature = "serde")]
+ fn test_deserialize_reference_rollup_config() {
+ // Reference serialized rollup config from the `op-node`.
+ let ser_cfg = r#"
+{
+ "genesis": {
+ "l1": {
+ "hash": "0x481724ee99b1f4cb71d826e2ec5a37265f460e9b112315665c977f4050b0af54",
+ "number": 10
+ },
+ "l2": {
+ "hash": "0x88aedfbf7dea6bfa2c4ff315784ad1a7f145d8f650969359c003bbed68c87631",
+ "number": 0
+ },
+ "l2_time": 1725557164,
+ "system_config": {
+ "batcherAddr": "0xc81f87a644b41e49b3221f41251f15c6cb00ce03",
+ "overhead": "0x0000000000000000000000000000000000000000000000000000000000000000",
+ "scalar": "0x00000000000000000000000000000000000000000000000000000000000f4240",
+ "gasLimit": 30000000
+ }
+ },
+ "block_time": 2,
+ "max_sequencer_drift": 600,
+ "seq_window_size": 3600,
+ "channel_timeout": 300,
+ "l1_chain_id": 3151908,
+ "l2_chain_id": 1337,
+ "regolith_time": 0,
+ "canyon_time": 0,
+ "delta_time": 0,
+ "ecotone_time": 0,
+ "fjord_time": 0,
+ "batch_inbox_address": "0xff00000000000000000000000000000000042069",
+ "deposit_contract_address": "0x08073dc48dde578137b8af042bcbc1c2491f1eb2",
+ "l1_system_config_address": "0x94ee52a9d8edd72a85dea7fae3ba6d75e4bf1710",
+ "protocol_versions_address": "0x0000000000000000000000000000000000000000"
+}
+ "#;
+ let config: RollupConfig = serde_json::from_str(ser_cfg).unwrap();
+
+ // Validate standard fields.
+ assert_eq!(
+ config.genesis,
+ ChainGenesis {
+ l1: BlockNumHash {
+ hash: b256!("481724ee99b1f4cb71d826e2ec5a37265f460e9b112315665c977f4050b0af54"),
+ number: 10
+ },
+ l2: BlockNumHash {
+ hash: b256!("88aedfbf7dea6bfa2c4ff315784ad1a7f145d8f650969359c003bbed68c87631"),
+ number: 0
+ },
+ l2_time: 1725557164,
+ system_config: Some(SystemConfig {
+ batcher_address: address!("c81f87a644b41e49b3221f41251f15c6cb00ce03"),
+ overhead: U256::ZERO,
+ scalar: U256::from(0xf4240),
+ gas_limit: 30_000_000,
+ base_fee_scalar: None,
+ blob_base_fee_scalar: None,
+ eip1559_denominator: None,
+ eip1559_elasticity: None,
+ operator_fee_scalar: None,
+ operator_fee_constant: None,
+ })
+ }
+ );
+ assert_eq!(config.block_time, 2);
+ assert_eq!(config.max_sequencer_drift, 600);
+ assert_eq!(config.seq_window_size, 3600);
+ assert_eq!(config.channel_timeout, 300);
+ assert_eq!(config.l1_chain_id, 3151908);
+ assert_eq!(config.l2_chain_id, 1337);
+ assert_eq!(config.regolith_time, Some(0));
+ assert_eq!(config.canyon_time, Some(0));
+ assert_eq!(config.delta_time, Some(0));
+ assert_eq!(config.ecotone_time, Some(0));
+ assert_eq!(config.fjord_time, Some(0));
+ assert_eq!(
+ config.batch_inbox_address,
+ address!("ff00000000000000000000000000000000042069")
+ );
+ assert_eq!(
+ config.deposit_contract_address,
+ address!("08073dc48dde578137b8af042bcbc1c2491f1eb2")
+ );
+ assert_eq!(
+ config.l1_system_config_address,
+ address!("94ee52a9d8edd72a85dea7fae3ba6d75e4bf1710")
+ );
+ assert_eq!(config.protocol_versions_address, Address::ZERO);
+
+ // Validate non-standard fields.
+ assert_eq!(config.granite_channel_timeout, GRANITE_CHANNEL_TIMEOUT);
+ assert_eq!(config.base_fee_params, OP_MAINNET_BASE_FEE_PARAMS);
+ assert_eq!(config.canyon_base_fee_params, OP_MAINNET_BASE_FEE_PARAMS_CANYON);
+ assert_eq!(config.interop_message_expiry_window, DEFAULT_INTEROP_MESSAGE_EXPIRY_WINDOW);
+ }
+}
diff --git a/crates/protocol/genesis/src/superchain/chain.rs b/crates/protocol/genesis/src/superchain/chain.rs
new file mode 100644
index 0000000000..9ea30a75e1
--- /dev/null
+++ b/crates/protocol/genesis/src/superchain/chain.rs
@@ -0,0 +1,79 @@
+//! Contains the `Superchain` type.
+
+use crate::{ChainConfig, SuperchainConfig};
+use alloc::{string::String, vec::Vec};
+
+/// A superchain configuration.
+#[derive(Debug, Clone, Default, Eq, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub struct Superchain {
+ /// Superchain identifier, without capitalization or display changes.
+ pub name: String,
+ /// Superchain configuration file contents.
+ pub config: SuperchainConfig,
+ /// Chain IDs of chains that are part of this superchain.
+ pub chains: Vec,
+}
+
+#[cfg(test)]
+#[cfg(feature = "serde")]
+mod tests {
+ use super::*;
+ use crate::{HardForkConfiguration, SuperchainConfig, SuperchainL1Info};
+ use alloc::{string::ToString, vec};
+
+ #[test]
+ fn test_superchain_serde() {
+ let raw: &str = r#"
+ {
+ "name": "Mainnet",
+ "config": {
+ "name": "Mainnet",
+ "l1": {
+ "chainId": 10,
+ "publicRPC": "https://mainnet.rpc",
+ "explorer": "https://mainnet.explorer"
+ },
+ "hardforks": {
+ "canyon_time": 1699981200,
+ "delta_time": 1703203200,
+ "ecotone_time": 1708534800,
+ "fjord_time": 1716998400,
+ "granite_time": 1723478400,
+ "holocene_time": 1732633200
+ }
+ },
+ "chains": []
+ }
+ "#;
+
+ let superchain = Superchain {
+ name: "Mainnet".to_string(),
+ config: SuperchainConfig {
+ name: "Mainnet".to_string(),
+ l1: SuperchainL1Info {
+ chain_id: 10,
+ public_rpc: "https://mainnet.rpc".to_string(),
+ explorer: "https://mainnet.explorer".to_string(),
+ },
+ hardforks: HardForkConfiguration {
+ canyon_time: Some(1699981200),
+ delta_time: Some(1703203200),
+ ecotone_time: Some(1708534800),
+ fjord_time: Some(1716998400),
+ granite_time: Some(1723478400),
+ holocene_time: Some(1732633200),
+ isthmus_time: None,
+ interop_time: None,
+ },
+ protocol_versions_addr: None,
+ superchain_config_addr: None,
+ op_contracts_manager_proxy_addr: None,
+ },
+ chains: vec![],
+ };
+
+ let deserialized: Superchain = serde_json::from_str(raw).unwrap();
+ assert_eq!(superchain, deserialized);
+ }
+}
diff --git a/crates/protocol/genesis/src/superchain/chains.rs b/crates/protocol/genesis/src/superchain/chains.rs
new file mode 100644
index 0000000000..dc425284c0
--- /dev/null
+++ b/crates/protocol/genesis/src/superchain/chains.rs
@@ -0,0 +1,14 @@
+//! Contains the `Superchains` type.
+
+use alloc::vec::Vec;
+
+use crate::Superchain;
+
+/// A list of Hydrated Superchain Configs.
+#[derive(Debug, Clone, Default, Eq, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
+pub struct Superchains {
+ /// A list of superchain configs.
+ pub superchains: Vec,
+}
diff --git a/crates/protocol/genesis/src/superchain/config.rs b/crates/protocol/genesis/src/superchain/config.rs
new file mode 100644
index 0000000000..99b547e94a
--- /dev/null
+++ b/crates/protocol/genesis/src/superchain/config.rs
@@ -0,0 +1,26 @@
+//! Contains the `SuperchainConfig` type.
+
+use crate::{HardForkConfiguration, SuperchainL1Info};
+use alloc::string::String;
+use alloy_primitives::Address;
+
+/// A superchain configuration file format
+#[derive(Debug, Clone, Default, Hash, Eq, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub struct SuperchainConfig {
+ /// Superchain name (e.g. "Mainnet")
+ pub name: String,
+ /// Superchain L1 anchor information
+ pub l1: SuperchainL1Info,
+ /// Default hardforks timestamps.
+ pub hardforks: HardForkConfiguration,
+ /// Optional addresses for the superchain-wide default protocol versions contract.
+ #[cfg_attr(feature = "serde", serde(alias = "protocolVersionsAddr"))]
+ pub protocol_versions_addr: Option,
+ /// Optional address for the superchain-wide default superchain config contract.
+ #[cfg_attr(feature = "serde", serde(alias = "superchainConfigAddr"))]
+ pub superchain_config_addr: Option,
+ /// The op contracts manager proxy address.
+ #[cfg_attr(feature = "serde", serde(alias = "OPContractsManagerProxyAddr"))]
+ pub op_contracts_manager_proxy_addr: Option,
+}
diff --git a/crates/protocol/genesis/src/superchain/info.rs b/crates/protocol/genesis/src/superchain/info.rs
new file mode 100644
index 0000000000..de2a479234
--- /dev/null
+++ b/crates/protocol/genesis/src/superchain/info.rs
@@ -0,0 +1,17 @@
+//! Contains the superchain L1 information.
+
+use alloc::string::String;
+
+/// Superchain L1 anchor information
+#[derive(Debug, Clone, Default, Hash, Eq, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub struct SuperchainL1Info {
+ /// L1 chain ID
+ #[cfg_attr(feature = "serde", serde(alias = "chainId"))]
+ pub chain_id: u64,
+ /// L1 chain public RPC endpoint
+ #[cfg_attr(feature = "serde", serde(alias = "publicRPC"))]
+ pub public_rpc: String,
+ /// L1 chain explorer RPC endpoint
+ pub explorer: String,
+}
diff --git a/crates/protocol/genesis/src/superchain/level.rs b/crates/protocol/genesis/src/superchain/level.rs
new file mode 100644
index 0000000000..ea6bb66edc
--- /dev/null
+++ b/crates/protocol/genesis/src/superchain/level.rs
@@ -0,0 +1,20 @@
+//! Contains the superchain level.
+
+/// Level of integration with the superchain.
+///
+/// See:
+#[derive(Debug, Copy, Clone, Default, Hash, Eq, PartialEq)]
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[cfg_attr(feature = "serde", derive(serde_repr::Serialize_repr, serde_repr::Deserialize_repr))]
+#[repr(u8)]
+pub enum SuperchainLevel {
+ /// Frontier chains are chains with customizations beyond the
+ /// standard OP Stack configuration and are considered "advanced".
+ Frontier = 0,
+ /// A candidate for a standard chain.
+ #[default]
+ StandardCandidate = 1,
+ /// Standard chains don't have any customizations beyond the
+ /// standard OP Stack configuration and are considered "vanilla".
+ Standard = 2,
+}
diff --git a/crates/protocol/genesis/src/superchain/mod.rs b/crates/protocol/genesis/src/superchain/mod.rs
new file mode 100644
index 0000000000..5863f2d8fe
--- /dev/null
+++ b/crates/protocol/genesis/src/superchain/mod.rs
@@ -0,0 +1,16 @@
+//! Contains superchain-specific types.
+
+mod level;
+pub use level::SuperchainLevel;
+
+mod chain;
+pub use chain::Superchain;
+
+mod chains;
+pub use chains::Superchains;
+
+mod config;
+pub use config::SuperchainConfig;
+
+mod info;
+pub use info::SuperchainL1Info;
diff --git a/crates/protocol/genesis/src/system/config.rs b/crates/protocol/genesis/src/system/config.rs
new file mode 100644
index 0000000000..bc18395d63
--- /dev/null
+++ b/crates/protocol/genesis/src/system/config.rs
@@ -0,0 +1,451 @@
+//! Contains the [`SystemConfig`] type.
+
+use alloy_consensus::{Eip658Value, Receipt};
+use alloy_primitives::{Address, Log, B64, U256};
+
+use crate::{
+ RollupConfig, SystemConfigLog, SystemConfigUpdateError, SystemConfigUpdateKind,
+ CONFIG_UPDATE_TOPIC,
+};
+
+/// System configuration.
+#[derive(Debug, Copy, Clone, Default, Hash, Eq, PartialEq)]
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
+pub struct SystemConfig {
+ /// Batcher address
+ #[cfg_attr(feature = "serde", serde(rename = "batcherAddress", alias = "batcherAddr"))]
+ pub batcher_address: Address,
+ /// Fee overhead value
+ pub overhead: U256,
+ /// Fee scalar value
+ pub scalar: U256,
+ /// Gas limit value
+ pub gas_limit: u64,
+ /// Base fee scalar value
+ pub base_fee_scalar: Option,
+ /// Blob base fee scalar value
+ pub blob_base_fee_scalar: Option,
+ /// EIP-1559 denominator
+ pub eip1559_denominator: Option,
+ /// EIP-1559 elasticity
+ pub eip1559_elasticity: Option,
+ /// The operator fee scalar (isthmus hardfork)
+ pub operator_fee_scalar: Option,
+ /// The operator fee constant (isthmus hardfork)
+ pub operator_fee_constant: Option,
+}
+
+impl SystemConfig {
+ /// Filters all L1 receipts to find config updates and applies the config updates.
+ pub fn update_with_receipts(
+ &mut self,
+ receipts: &[Receipt],
+ l1_system_config_address: Address,
+ ecotone_active: bool,
+ ) -> Result<(), SystemConfigUpdateError> {
+ for receipt in receipts {
+ if Eip658Value::Eip658(false) == receipt.status {
+ continue;
+ }
+
+ receipt.logs.iter().try_for_each(|log| {
+ let topics = log.topics();
+ if log.address == l1_system_config_address &&
+ !topics.is_empty() &&
+ topics[0] == CONFIG_UPDATE_TOPIC
+ {
+ // Safety: Error is bubbled up by the trailing `?`
+ self.process_config_update_log(log, ecotone_active)?;
+ }
+ Ok::<(), SystemConfigUpdateError>(())
+ })?;
+ }
+ Ok(())
+ }
+
+ /// Returns the eip1559 parameters from a [SystemConfig] encoded as a [B64].
+ pub fn eip_1559_params(
+ &self,
+ rollup_config: &RollupConfig,
+ parent_timestamp: u64,
+ next_timestamp: u64,
+ ) -> Option {
+ let is_holocene = rollup_config.is_holocene_active(next_timestamp);
+
+ // For the first holocene block, a zero'd out B64 is returned to signal the
+ // execution layer to use the canyon base fee parameters. Else, the system
+ // config's eip1559 parameters are encoded as a B64.
+ if is_holocene && !rollup_config.is_holocene_active(parent_timestamp) {
+ Some(B64::ZERO)
+ } else {
+ is_holocene.then_some(B64::from_slice(
+ &[
+ self.eip1559_denominator.unwrap_or_default().to_be_bytes(),
+ self.eip1559_elasticity.unwrap_or_default().to_be_bytes(),
+ ]
+ .concat(),
+ ))
+ }
+ }
+
+ /// Decodes an EVM log entry emitted by the system config contract and applies it as a
+ /// [SystemConfig] change.
+ ///
+ /// Parse log data for:
+ ///
+ /// ```text
+ /// event ConfigUpdate(
+ /// uint256 indexed version,
+ /// UpdateType indexed updateType,
+ /// bytes data
+ /// );
+ /// ```
+ fn process_config_update_log(
+ &mut self,
+ log: &Log,
+ ecotone_active: bool,
+ ) -> Result {
+ // Construct the system config log from the log.
+ let log = SystemConfigLog::new(log.clone(), ecotone_active);
+
+ // Construct the update type from the log.
+ let update = log.build()?;
+
+ // Apply the update to the system config.
+ update.apply(self);
+
+ // Return the update type.
+ Ok(update.kind())
+ }
+}
+
+#[cfg(test)]
+mod test {
+ use super::*;
+ use crate::CONFIG_UPDATE_EVENT_VERSION_0;
+ use alloc::vec;
+ use alloy_primitives::{address, b256, hex, LogData, B256};
+
+ #[test]
+ #[cfg(feature = "serde")]
+ fn test_system_config_alias() {
+ let sc_str: &'static str = r#"{
+ "batcherAddress": "0x6887246668a3b87F54DeB3b94Ba47a6f63F32985",
+ "overhead": "0x00000000000000000000000000000000000000000000000000000000000000bc",
+ "scalar": "0x00000000000000000000000000000000000000000000000000000000000a6fe0",
+ "gasLimit": 30000000
+ }"#;
+ let system_config: SystemConfig = serde_json::from_str(sc_str).unwrap();
+ assert_eq!(
+ system_config,
+ SystemConfig {
+ batcher_address: address!("6887246668a3b87F54DeB3b94Ba47a6f63F32985"),
+ overhead: U256::from(0xbc),
+ scalar: U256::from(0xa6fe0),
+ gas_limit: 30000000,
+ ..Default::default()
+ }
+ );
+ }
+
+ #[test]
+ #[cfg(feature = "arbitrary")]
+ fn test_arbitrary_system_config() {
+ use arbitrary::Arbitrary;
+ use rand::Rng;
+ let mut bytes = [0u8; 1024];
+ rand::rng().fill(bytes.as_mut_slice());
+ SystemConfig::arbitrary(&mut arbitrary::Unstructured::new(&bytes)).unwrap();
+ }
+
+ #[test]
+ fn test_eip_1559_params_from_system_config_none() {
+ let rollup_config = RollupConfig::default();
+ let sys_config = SystemConfig::default();
+ assert_eq!(sys_config.eip_1559_params(&rollup_config, 0, 0), None);
+ }
+
+ #[test]
+ fn test_eip_1559_params_from_system_config_some() {
+ let rollup_config = RollupConfig { holocene_time: Some(0), ..Default::default() };
+ let sys_config = SystemConfig {
+ eip1559_denominator: Some(1),
+ eip1559_elasticity: None,
+ ..Default::default()
+ };
+ let expected = Some(B64::from_slice(&[1u32.to_be_bytes(), 0u32.to_be_bytes()].concat()));
+ assert_eq!(sys_config.eip_1559_params(&rollup_config, 0, 0), expected);
+ }
+
+ #[test]
+ fn test_eip_1559_params_from_system_config() {
+ let rollup_config = RollupConfig { holocene_time: Some(0), ..Default::default() };
+ let sys_config = SystemConfig {
+ eip1559_denominator: Some(1),
+ eip1559_elasticity: Some(2),
+ ..Default::default()
+ };
+ let expected = Some(B64::from_slice(&[1u32.to_be_bytes(), 2u32.to_be_bytes()].concat()));
+ assert_eq!(sys_config.eip_1559_params(&rollup_config, 0, 0), expected);
+ }
+
+ #[test]
+ fn test_default_eip_1559_params_from_system_config() {
+ let rollup_config = RollupConfig { holocene_time: Some(0), ..Default::default() };
+ let sys_config = SystemConfig {
+ eip1559_denominator: None,
+ eip1559_elasticity: None,
+ ..Default::default()
+ };
+ let expected = Some(B64::ZERO);
+ assert_eq!(sys_config.eip_1559_params(&rollup_config, 0, 0), expected);
+ }
+
+ #[test]
+ fn test_default_eip_1559_params_from_system_config_pre_holocene() {
+ let rollup_config = RollupConfig::default();
+ let sys_config = SystemConfig {
+ eip1559_denominator: Some(1),
+ eip1559_elasticity: Some(2),
+ ..Default::default()
+ };
+ assert_eq!(sys_config.eip_1559_params(&rollup_config, 0, 0), None);
+ }
+
+ #[test]
+ fn test_default_eip_1559_params_first_block_holocene() {
+ let rollup_config = RollupConfig { holocene_time: Some(2), ..Default::default() };
+ let sys_config = SystemConfig {
+ eip1559_denominator: Some(1),
+ eip1559_elasticity: Some(2),
+ ..Default::default()
+ };
+ assert_eq!(sys_config.eip_1559_params(&rollup_config, 0, 2), Some(B64::ZERO));
+ }
+
+ #[test]
+ #[cfg(feature = "serde")]
+ fn test_system_config_serde() {
+ let sc_str = r#"{
+ "batcherAddr": "0x6887246668a3b87F54DeB3b94Ba47a6f63F32985",
+ "overhead": "0x00000000000000000000000000000000000000000000000000000000000000bc",
+ "scalar": "0x00000000000000000000000000000000000000000000000000000000000a6fe0",
+ "gasLimit": 30000000
+ }"#;
+ let system_config: SystemConfig = serde_json::from_str(sc_str).unwrap();
+ assert_eq!(
+ system_config.batcher_address,
+ address!("6887246668a3b87F54DeB3b94Ba47a6f63F32985")
+ );
+ assert_eq!(system_config.overhead, U256::from(0xbc));
+ assert_eq!(system_config.scalar, U256::from(0xa6fe0));
+ assert_eq!(system_config.gas_limit, 30000000);
+ }
+
+ #[test]
+ fn test_system_config_update_with_receipts_unchanged() {
+ let mut system_config = SystemConfig::default();
+ let receipts = vec![];
+ let l1_system_config_address = Address::ZERO;
+ let ecotone_active = false;
+
+ system_config
+ .update_with_receipts(&receipts, l1_system_config_address, ecotone_active)
+ .unwrap();
+
+ assert_eq!(system_config, SystemConfig::default());
+ }
+
+ #[test]
+ fn test_system_config_update_with_receipts_batcher_address() {
+ const UPDATE_TYPE: B256 =
+ b256!("0000000000000000000000000000000000000000000000000000000000000000");
+ let mut system_config = SystemConfig::default();
+ let l1_system_config_address = Address::ZERO;
+ let ecotone_active = false;
+
+ let update_log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ UPDATE_TYPE,
+ ],
+ hex!("00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000beef").into()
+ )
+ };
+
+ let receipt = Receipt {
+ logs: vec![update_log],
+ status: Eip658Value::Eip658(true),
+ cumulative_gas_used: 0,
+ };
+
+ system_config
+ .update_with_receipts(&[receipt], l1_system_config_address, ecotone_active)
+ .unwrap();
+
+ assert_eq!(
+ system_config.batcher_address,
+ address!("000000000000000000000000000000000000bEEF"),
+ );
+ }
+
+ #[test]
+ fn test_system_config_update_batcher_log() {
+ const UPDATE_TYPE: B256 =
+ b256!("0000000000000000000000000000000000000000000000000000000000000000");
+
+ let mut system_config = SystemConfig::default();
+
+ let update_log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ UPDATE_TYPE,
+ ],
+ hex!("00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000beef").into()
+ )
+ };
+
+ // Update the batcher address.
+ system_config.process_config_update_log(&update_log, false).unwrap();
+
+ assert_eq!(
+ system_config.batcher_address,
+ address!("000000000000000000000000000000000000bEEF")
+ );
+ }
+
+ #[test]
+ fn test_system_config_update_gas_config_log() {
+ const UPDATE_TYPE: B256 =
+ b256!("0000000000000000000000000000000000000000000000000000000000000001");
+
+ let mut system_config = SystemConfig::default();
+
+ let update_log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ UPDATE_TYPE,
+ ],
+ hex!("00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000babe000000000000000000000000000000000000000000000000000000000000beef").into()
+ )
+ };
+
+ // Update the batcher address.
+ system_config.process_config_update_log(&update_log, false).unwrap();
+
+ assert_eq!(system_config.overhead, U256::from(0xbabe));
+ assert_eq!(system_config.scalar, U256::from(0xbeef));
+ }
+
+ #[test]
+ fn test_system_config_update_gas_config_log_ecotone() {
+ const UPDATE_TYPE: B256 =
+ b256!("0000000000000000000000000000000000000000000000000000000000000001");
+
+ let mut system_config = SystemConfig::default();
+
+ let update_log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ UPDATE_TYPE,
+ ],
+ hex!("00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000babe000000000000000000000000000000000000000000000000000000000000beef").into()
+ )
+ };
+
+ // Update the gas limit.
+ system_config.process_config_update_log(&update_log, true).unwrap();
+
+ assert_eq!(system_config.overhead, U256::from(0));
+ assert_eq!(system_config.scalar, U256::from(0xbeef));
+ }
+
+ #[test]
+ fn test_system_config_update_gas_limit_log() {
+ const UPDATE_TYPE: B256 =
+ b256!("0000000000000000000000000000000000000000000000000000000000000002");
+
+ let mut system_config = SystemConfig::default();
+
+ let update_log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ UPDATE_TYPE,
+ ],
+ hex!("00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000beef").into()
+ )
+ };
+
+ // Update the gas limit.
+ system_config.process_config_update_log(&update_log, false).unwrap();
+
+ assert_eq!(system_config.gas_limit, 0xbeef_u64);
+ }
+
+ #[test]
+ fn test_system_config_update_eip1559_params_log() {
+ const UPDATE_TYPE: B256 =
+ b256!("0000000000000000000000000000000000000000000000000000000000000004");
+
+ let mut system_config = SystemConfig::default();
+ let update_log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ UPDATE_TYPE,
+ ],
+ hex!("000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000babe0000beef").into()
+ )
+ };
+
+ // Update the EIP-1559 parameters.
+ system_config.process_config_update_log(&update_log, false).unwrap();
+
+ assert_eq!(system_config.eip1559_denominator, Some(0xbabe_u32));
+ assert_eq!(system_config.eip1559_elasticity, Some(0xbeef_u32));
+ }
+
+ #[test]
+ fn test_system_config_update_operator_fee_log() {
+ const UPDATE_TYPE: B256 =
+ b256!("0000000000000000000000000000000000000000000000000000000000000005");
+
+ let mut system_config = SystemConfig::default();
+ let update_log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ UPDATE_TYPE,
+ ],
+ hex!("0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000babe000000000000beef").into()
+ )
+ };
+
+ // Update the operator fee.
+ system_config.process_config_update_log(&update_log, false).unwrap();
+
+ assert_eq!(system_config.operator_fee_scalar, Some(0xbabe_u32));
+ assert_eq!(system_config.operator_fee_constant, Some(0xbeef_u64));
+ }
+}
diff --git a/crates/protocol/genesis/src/system/errors.rs b/crates/protocol/genesis/src/system/errors.rs
new file mode 100644
index 0000000000..312f8cb943
--- /dev/null
+++ b/crates/protocol/genesis/src/system/errors.rs
@@ -0,0 +1,175 @@
+//! Contains error types for system config updates.
+
+use alloy_primitives::B256;
+use derive_more::From;
+
+/// An error for processing the [crate::SystemConfig] update log.
+#[derive(Debug, From, thiserror::Error, Clone, Copy, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub enum SystemConfigUpdateError {
+ /// An error occurred while processing the update log.
+ #[error("Log processing error: {0}")]
+ LogProcessing(LogProcessingError),
+ /// A batcher update error.
+ #[error("Batcher update error: {0}")]
+ Batcher(BatcherUpdateError),
+ /// A gas config update error.
+ #[error("Gas config update error: {0}")]
+ GasConfig(GasConfigUpdateError),
+ /// A gas limit update error.
+ #[error("Gas limit update error: {0}")]
+ GasLimit(GasLimitUpdateError),
+ /// An EIP-1559 parameter update error.
+ #[error("EIP-1559 parameter update error: {0}")]
+ Eip1559(EIP1559UpdateError),
+ /// An operator fee parameter update error.
+ #[error("Operator fee parameter update error: {0}")]
+ OperatorFee(OperatorFeeUpdateError),
+}
+
+/// An error occurred while processing the update log.
+#[derive(Debug, From, thiserror::Error, Clone, Copy, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub enum LogProcessingError {
+ /// Received an incorrect number of log topics.
+ #[error("Invalid config update log: invalid topic length: {0}")]
+ InvalidTopicLen(usize),
+ /// The log topic is invalid.
+ #[error("Invalid config update log: invalid topic")]
+ InvalidTopic,
+ /// The config update log version is unsupported.
+ #[error("Invalid config update log: unsupported version: {0}")]
+ UnsupportedVersion(B256),
+ /// Failed to decode the update type from the config update log.
+ #[error("Failed to decode config update log: update type")]
+ UpdateTypeDecodingError,
+ /// An invalid system config update type.
+ #[error("Invalid system config update type: {0}")]
+ InvalidSystemConfigUpdateType(u64),
+}
+
+/// An error for updating the batcher address on the [crate::SystemConfig].
+#[derive(Debug, thiserror::Error, Clone, Copy, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub enum BatcherUpdateError {
+ /// Invalid data length.
+ #[error("Invalid config update log: invalid data length: {0}")]
+ InvalidDataLen(usize),
+ /// Failed to decode the data pointer argument from the batcher update log.
+ #[error("Failed to decode batcher update log: data pointer")]
+ PointerDecodingError,
+ /// The data pointer is invalid.
+ #[error("Invalid config update log: invalid data pointer: {0}")]
+ InvalidDataPointer(u64),
+ /// Failed to decode the data length argument from the batcher update log.
+ #[error("Failed to decode batcher update log: data length")]
+ LengthDecodingError,
+ /// The data length is invalid.
+ #[error("Invalid config update log: invalid data length: {0}")]
+ InvalidDataLength(u64),
+ /// Failed to decode the batcher address argument from the batcher update log.
+ #[error("Failed to decode batcher update log: batcher address")]
+ BatcherAddressDecodingError,
+}
+
+/// An error for updating the gas config on the [crate::SystemConfig].
+#[derive(Debug, thiserror::Error, Clone, Copy, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub enum GasConfigUpdateError {
+ /// Invalid data length.
+ #[error("Invalid config update log: invalid data length: {0}")]
+ InvalidDataLen(usize),
+ /// Failed to decode the data pointer argument from the gas config update log.
+ #[error("Failed to decode gas config update log: data pointer")]
+ PointerDecodingError,
+ /// The data pointer is invalid.
+ #[error("Invalid config update log: invalid data pointer: {0}")]
+ InvalidDataPointer(u64),
+ /// Failed to decode the data length argument from the gas config update log.
+ #[error("Failed to decode gas config update log: data length")]
+ LengthDecodingError,
+ /// The data length is invalid.
+ #[error("Invalid config update log: invalid data length: {0}")]
+ InvalidDataLength(u64),
+ /// Failed to decode the overhead argument from the gas config update log.
+ #[error("Failed to decode gas config update log: overhead")]
+ OverheadDecodingError,
+ /// Failed to decode the scalar argument from the gas config update log.
+ #[error("Failed to decode gas config update log: scalar")]
+ ScalarDecodingError,
+}
+
+/// An error for updating the gas limit on the [crate::SystemConfig].
+#[derive(Debug, thiserror::Error, Clone, Copy, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub enum GasLimitUpdateError {
+ /// Invalid data length.
+ #[error("Invalid config update log: invalid data length: {0}")]
+ InvalidDataLen(usize),
+ /// Failed to decode the data pointer argument from the gas limit update log.
+ #[error("Failed to decode gas limit update log: data pointer")]
+ PointerDecodingError,
+ /// The data pointer is invalid.
+ #[error("Invalid config update log: invalid data pointer: {0}")]
+ InvalidDataPointer(u64),
+ /// Failed to decode the data length argument from the gas limit update log.
+ #[error("Failed to decode gas limit update log: data length")]
+ LengthDecodingError,
+ /// The data length is invalid.
+ #[error("Invalid config update log: invalid data length: {0}")]
+ InvalidDataLength(u64),
+ /// Failed to decode the gas limit argument from the gas limit update log.
+ #[error("Failed to decode gas limit update log: gas limit")]
+ GasLimitDecodingError,
+}
+
+/// An error for updating the EIP-1559 parameters on the [crate::SystemConfig].
+#[derive(Debug, thiserror::Error, Clone, Copy, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub enum EIP1559UpdateError {
+ /// Invalid data length.
+ #[error("Invalid config update log: invalid data length: {0}")]
+ InvalidDataLen(usize),
+ /// Failed to decode the data pointer argument from the eip 1559 update log.
+ #[error("Failed to decode eip1559 parameter update log: data pointer")]
+ PointerDecodingError,
+ /// The data pointer is invalid.
+ #[error("Invalid config update log: invalid data pointer: {0}")]
+ InvalidDataPointer(u64),
+ /// Failed to decode the data length argument from the eip 1559 update log.
+ #[error("Failed to decode eip1559 parameter update log: data length")]
+ LengthDecodingError,
+ /// The data length is invalid.
+ #[error("Invalid config update log: invalid data length: {0}")]
+ InvalidDataLength(u64),
+ /// Failed to decode the eip1559 params argument from the eip 1559 update log.
+ #[error("Failed to decode eip1559 parameter update log: eip1559 parameters")]
+ EIP1559DecodingError,
+}
+
+/// An error for updating the operator fee parameters on the [crate::SystemConfig].
+#[derive(Debug, thiserror::Error, Clone, Copy, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub enum OperatorFeeUpdateError {
+ /// Invalid data length.
+ #[error("Invalid config update log: invalid data length: {0}")]
+ InvalidDataLen(usize),
+ /// Failed to decode the data pointer argument from the eip 1559 update log.
+ #[error("Failed to decode eip1559 parameter update log: data pointer")]
+ PointerDecodingError,
+ /// The data pointer is invalid.
+ #[error("Invalid config update log: invalid data pointer: {0}")]
+ InvalidDataPointer(u64),
+ /// Failed to decode the data length argument from the eip 1559 update log.
+ #[error("Failed to decode eip1559 parameter update log: data length")]
+ LengthDecodingError,
+ /// The data length is invalid.
+ #[error("Invalid config update log: invalid data length: {0}")]
+ InvalidDataLength(u64),
+ /// Failed to decode the scalar argument from the update log.
+ #[error("Failed to decode operator fee parameter update log: scalar")]
+ ScalarDecodingError,
+ /// Failed to decode the constant argument from the update log.
+ #[error("Failed to decode operator fee parameter update log: constant")]
+ ConstantDecodingError,
+}
diff --git a/crates/protocol/genesis/src/system/kind.rs b/crates/protocol/genesis/src/system/kind.rs
new file mode 100644
index 0000000000..d70d608691
--- /dev/null
+++ b/crates/protocol/genesis/src/system/kind.rs
@@ -0,0 +1,39 @@
+//! Contains the kind of system config update.
+
+use crate::{LogProcessingError, SystemConfigUpdateError};
+
+/// Represents type of update to the system config.
+#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq)]
+#[repr(u64)]
+pub enum SystemConfigUpdateKind {
+ /// Batcher update type
+ Batcher = 0,
+ /// Gas config update type
+ GasConfig = 1,
+ /// Gas limit update type
+ GasLimit = 2,
+ /// Unsafe block signer update type
+ UnsafeBlockSigner = 3,
+ /// EIP-1559 parameters update type
+ Eip1559 = 4,
+ /// Operator fee parameter update
+ OperatorFee = 5,
+}
+
+impl TryFrom for SystemConfigUpdateKind {
+ type Error = SystemConfigUpdateError;
+
+ fn try_from(value: u64) -> Result {
+ match value {
+ 0 => Ok(Self::Batcher),
+ 1 => Ok(Self::GasConfig),
+ 2 => Ok(Self::GasLimit),
+ 3 => Ok(Self::UnsafeBlockSigner),
+ 4 => Ok(Self::Eip1559),
+ 5 => Ok(Self::OperatorFee),
+ _ => Err(SystemConfigUpdateError::LogProcessing(
+ LogProcessingError::InvalidSystemConfigUpdateType(value),
+ )),
+ }
+ }
+}
diff --git a/crates/protocol/genesis/src/system/log.rs b/crates/protocol/genesis/src/system/log.rs
new file mode 100644
index 0000000000..f6abd45688
--- /dev/null
+++ b/crates/protocol/genesis/src/system/log.rs
@@ -0,0 +1,97 @@
+//! Contains the [`SystemConfigLog`].
+
+use alloy_primitives::Log;
+
+use crate::{
+ BatcherUpdate, Eip1559Update, GasConfigUpdate, GasLimitUpdate, LogProcessingError,
+ OperatorFeeUpdate, SystemConfigUpdate, SystemConfigUpdateError, SystemConfigUpdateKind,
+ CONFIG_UPDATE_EVENT_VERSION_0, CONFIG_UPDATE_TOPIC,
+};
+
+/// The system config log is an EVM log entry emitted
+/// by the system contract to update the system config.
+///
+/// The log data is formatted as follows:
+/// ```text
+/// event ConfigUpdate(
+/// uint256 indexed version,
+/// UpdateType indexed updateType,
+/// bytes data
+/// );
+/// ```
+#[derive(Debug, Clone, Hash, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub struct SystemConfigLog {
+ /// The log.
+ pub log: Log,
+ /// Whether ecotone is active.
+ pub ecotone_active: bool,
+}
+
+impl SystemConfigLog {
+ /// Constructs a new system config update.
+ pub const fn new(log: Log, ecotone_active: bool) -> Self {
+ Self { log, ecotone_active }
+ }
+
+ /// Validate the log topic.
+ pub fn validate_topic(&self) -> Result<(), LogProcessingError> {
+ if self.log.topics().len() < 3 {
+ return Err(LogProcessingError::InvalidTopicLen(self.log.topics().len()));
+ }
+ if self.log.topics()[0] != CONFIG_UPDATE_TOPIC {
+ return Err(LogProcessingError::InvalidTopic);
+ }
+ Ok(())
+ }
+
+ /// Validate the config update version.
+ pub fn validate_version(&self) -> Result<(), LogProcessingError> {
+ let version = self.log.topics()[1];
+ if version != CONFIG_UPDATE_EVENT_VERSION_0 {
+ return Err(LogProcessingError::UnsupportedVersion(version));
+ }
+ Ok(())
+ }
+
+ /// Extracts the update type from the log.
+ pub fn update_type(&self) -> Result {
+ if self.log.topics().len() < 3 {
+ return Err(LogProcessingError::InvalidTopicLen(self.log.topics().len()).into());
+ }
+ let topic = self.log.topics()[2];
+ let topic_bytes = <&[u8; 8]>::try_from(&topic.as_slice()[24..])
+ .map_err(|_| LogProcessingError::UpdateTypeDecodingError)?;
+ let ty = u64::from_be_bytes(*topic_bytes);
+ ty.try_into()
+ }
+
+ /// Builds the [`SystemConfigUpdate`] from the log.
+ pub fn build(&self) -> Result {
+ self.validate_topic()?;
+ self.validate_version()?;
+ match self.update_type()? {
+ SystemConfigUpdateKind::Batcher => {
+ let update = BatcherUpdate::try_from(self)?;
+ Ok(SystemConfigUpdate::Batcher(update))
+ }
+ SystemConfigUpdateKind::GasConfig => {
+ let update = GasConfigUpdate::try_from(self)?;
+ Ok(SystemConfigUpdate::GasConfig(update))
+ }
+ SystemConfigUpdateKind::GasLimit => {
+ let update = GasLimitUpdate::try_from(self)?;
+ Ok(SystemConfigUpdate::GasLimit(update))
+ }
+ SystemConfigUpdateKind::Eip1559 => {
+ let update = Eip1559Update::try_from(self)?;
+ Ok(SystemConfigUpdate::Eip1559(update))
+ }
+ SystemConfigUpdateKind::OperatorFee => {
+ let update = OperatorFeeUpdate::try_from(self)?;
+ Ok(SystemConfigUpdate::OperatorFee(update))
+ }
+ SystemConfigUpdateKind::UnsafeBlockSigner => Ok(SystemConfigUpdate::UnsafeBlockSigner),
+ }
+ }
+}
diff --git a/crates/protocol/genesis/src/system/mod.rs b/crates/protocol/genesis/src/system/mod.rs
new file mode 100644
index 0000000000..f7e0bc50d9
--- /dev/null
+++ b/crates/protocol/genesis/src/system/mod.rs
@@ -0,0 +1,28 @@
+//! Contains types related to the [`SystemConfig`].
+
+use alloy_primitives::{b256, B256};
+
+/// `keccak256("ConfigUpdate(uint256,uint8,bytes)")`
+pub const CONFIG_UPDATE_TOPIC: B256 =
+ b256!("1d2b0bda21d56b8bd12d4f94ebacffdfb35f5e226f84b461103bb8beab6353be");
+
+/// The initial version of the system config event log.
+pub const CONFIG_UPDATE_EVENT_VERSION_0: B256 = B256::ZERO;
+
+mod config;
+pub use config::SystemConfig;
+
+mod log;
+pub use log::SystemConfigLog;
+
+mod update;
+pub use update::SystemConfigUpdate;
+
+mod kind;
+pub use kind::SystemConfigUpdateKind;
+
+mod errors;
+pub use errors::{
+ BatcherUpdateError, EIP1559UpdateError, GasConfigUpdateError, GasLimitUpdateError,
+ LogProcessingError, OperatorFeeUpdateError, SystemConfigUpdateError,
+};
diff --git a/crates/protocol/genesis/src/system/update.rs b/crates/protocol/genesis/src/system/update.rs
new file mode 100644
index 0000000000..98aeaf35ef
--- /dev/null
+++ b/crates/protocol/genesis/src/system/update.rs
@@ -0,0 +1,51 @@
+//! Contains the [`SystemConfigUpdate`].
+
+use crate::{
+ BatcherUpdate, Eip1559Update, GasConfigUpdate, GasLimitUpdate, OperatorFeeUpdate, SystemConfig,
+ SystemConfigUpdateKind,
+};
+
+/// The system config update is an update
+/// of type [`SystemConfigUpdateKind`].
+#[derive(Debug, Clone, Hash, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub enum SystemConfigUpdate {
+ /// The batcher update.
+ Batcher(BatcherUpdate),
+ /// The gas config update.
+ GasConfig(GasConfigUpdate),
+ /// The gas limit update.
+ GasLimit(GasLimitUpdate),
+ /// The unsafe block signer update.
+ UnsafeBlockSigner,
+ /// The EIP-1559 parameters update.
+ Eip1559(Eip1559Update),
+ /// The operator fee parameter update.
+ OperatorFee(OperatorFeeUpdate),
+}
+
+impl SystemConfigUpdate {
+ /// Applies the update to the [`SystemConfig`].
+ pub fn apply(&self, config: &mut SystemConfig) {
+ match self {
+ Self::Batcher(update) => update.apply(config),
+ Self::GasConfig(update) => update.apply(config),
+ Self::GasLimit(update) => update.apply(config),
+ Self::UnsafeBlockSigner => { /* Ignored in derivation */ }
+ Self::Eip1559(update) => update.apply(config),
+ Self::OperatorFee(update) => update.apply(config),
+ }
+ }
+
+ /// Returns the update kind.
+ pub const fn kind(&self) -> SystemConfigUpdateKind {
+ match self {
+ Self::Batcher(_) => SystemConfigUpdateKind::Batcher,
+ Self::GasConfig(_) => SystemConfigUpdateKind::GasConfig,
+ Self::GasLimit(_) => SystemConfigUpdateKind::GasLimit,
+ Self::UnsafeBlockSigner => SystemConfigUpdateKind::UnsafeBlockSigner,
+ Self::Eip1559(_) => SystemConfigUpdateKind::Eip1559,
+ Self::OperatorFee(_) => SystemConfigUpdateKind::OperatorFee,
+ }
+ }
+}
diff --git a/crates/protocol/genesis/src/updates/batcher.rs b/crates/protocol/genesis/src/updates/batcher.rs
new file mode 100644
index 0000000000..66ceaa2c7e
--- /dev/null
+++ b/crates/protocol/genesis/src/updates/batcher.rs
@@ -0,0 +1,184 @@
+//! The batcher update type.
+
+use alloy_primitives::Address;
+use alloy_sol_types::{sol, SolType};
+
+use crate::{BatcherUpdateError, SystemConfig, SystemConfigLog};
+
+/// The batcher update type.
+#[derive(Debug, Clone, Hash, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub struct BatcherUpdate {
+ /// The batcher address.
+ pub batcher_address: Address,
+}
+
+impl BatcherUpdate {
+ /// Applies the update to the [`SystemConfig`].
+ pub fn apply(&self, config: &mut SystemConfig) {
+ config.batcher_address = self.batcher_address;
+ }
+}
+
+impl TryFrom<&SystemConfigLog> for BatcherUpdate {
+ type Error = BatcherUpdateError;
+
+ fn try_from(log: &SystemConfigLog) -> Result {
+ let log = &log.log;
+ if log.data.data.len() != 96 {
+ return Err(BatcherUpdateError::InvalidDataLen(log.data.data.len()));
+ }
+
+ let Ok(pointer) = ::abi_decode(&log.data.data[0..32], true) else {
+ return Err(BatcherUpdateError::PointerDecodingError);
+ };
+ if pointer != 32 {
+ return Err(BatcherUpdateError::InvalidDataPointer(pointer));
+ }
+ let Ok(length) = ::abi_decode(&log.data.data[32..64], true) else {
+ return Err(BatcherUpdateError::LengthDecodingError);
+ };
+ if length != 32 {
+ return Err(BatcherUpdateError::InvalidDataLength(length));
+ }
+
+ let Ok(batcher_address) = ::abi_decode(&log.data.data[64..], true) else {
+ return Err(BatcherUpdateError::BatcherAddressDecodingError);
+ };
+
+ Ok(Self { batcher_address })
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use crate::{CONFIG_UPDATE_EVENT_VERSION_0, CONFIG_UPDATE_TOPIC};
+ use alloc::vec;
+ use alloy_primitives::{address, hex, Bytes, Log, LogData, B256};
+
+ #[test]
+ fn test_batcher_update_try_from() {
+ let update_type = B256::ZERO;
+
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ update_type,
+ ],
+ hex!("00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let update = BatcherUpdate::try_from(&system_log).unwrap();
+ assert_eq!(update.batcher_address, address!("000000000000000000000000000000000000bEEF"),);
+ }
+
+ #[test]
+ fn test_batcher_update_invalid_data_len() {
+ let log =
+ Log { address: Address::ZERO, data: LogData::new_unchecked(vec![], Bytes::default()) };
+ let system_log = SystemConfigLog::new(log, false);
+ let err = BatcherUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, BatcherUpdateError::InvalidDataLen(0));
+ }
+
+ #[test]
+ fn test_batcher_update_pointer_decoding_error() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000babe0000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = BatcherUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, BatcherUpdateError::PointerDecodingError);
+ }
+
+ #[test]
+ fn test_batcher_update_invalid_pointer_length() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("000000000000000000000000000000000000000000000000000000000000002100000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000babe0000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = BatcherUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, BatcherUpdateError::InvalidDataPointer(33));
+ }
+
+ #[test]
+ fn test_batcher_update_length_decoding_error() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("0000000000000000000000000000000000000000000000000000000000000020FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF0000000000000000000000000000000000000000000000000000babe0000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = BatcherUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, BatcherUpdateError::LengthDecodingError);
+ }
+
+ #[test]
+ fn test_batcher_update_invalid_data_length() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000210000000000000000000000000000000000000000000000000000babe0000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = BatcherUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, BatcherUpdateError::InvalidDataLength(33));
+ }
+
+ #[test]
+ fn test_batcher_update_batcher_decoding_error() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000020FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = BatcherUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, BatcherUpdateError::BatcherAddressDecodingError);
+ }
+}
diff --git a/crates/protocol/genesis/src/updates/eip1559.rs b/crates/protocol/genesis/src/updates/eip1559.rs
new file mode 100644
index 0000000000..559076448f
--- /dev/null
+++ b/crates/protocol/genesis/src/updates/eip1559.rs
@@ -0,0 +1,191 @@
+//! The EIP-1559 update type.
+
+use alloy_sol_types::{sol, SolType};
+
+use crate::{EIP1559UpdateError, SystemConfig, SystemConfigLog};
+
+/// The EIP-1559 update type.
+#[derive(Debug, Default, Clone, Hash, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub struct Eip1559Update {
+ /// The EIP-1559 denominator.
+ pub eip1559_denominator: u32,
+ /// The EIP-1559 elasticity multiplier.
+ pub eip1559_elasticity: u32,
+}
+
+impl Eip1559Update {
+ /// Applies the update to the [`SystemConfig`].
+ pub fn apply(&self, config: &mut SystemConfig) {
+ config.eip1559_denominator = Some(self.eip1559_denominator);
+ config.eip1559_elasticity = Some(self.eip1559_elasticity);
+ }
+}
+
+impl TryFrom<&SystemConfigLog> for Eip1559Update {
+ type Error = EIP1559UpdateError;
+
+ fn try_from(log: &SystemConfigLog) -> Result {
+ let log = &log.log;
+ if log.data.data.len() != 96 {
+ return Err(EIP1559UpdateError::InvalidDataLen(log.data.data.len()));
+ }
+
+ let Ok(pointer) = ::abi_decode(&log.data.data[0..32], true) else {
+ return Err(EIP1559UpdateError::PointerDecodingError);
+ };
+ if pointer != 32 {
+ return Err(EIP1559UpdateError::InvalidDataPointer(pointer));
+ }
+ let Ok(length) = ::abi_decode(&log.data.data[32..64], true) else {
+ return Err(EIP1559UpdateError::LengthDecodingError);
+ };
+ if length != 32 {
+ return Err(EIP1559UpdateError::InvalidDataLength(length));
+ }
+
+ let Ok(eip1559_params) = ::abi_decode(&log.data.data[64..], true) else {
+ return Err(EIP1559UpdateError::EIP1559DecodingError);
+ };
+
+ Ok(Self {
+ eip1559_denominator: (eip1559_params >> 32) as u32,
+ eip1559_elasticity: eip1559_params as u32,
+ })
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use crate::{CONFIG_UPDATE_EVENT_VERSION_0, CONFIG_UPDATE_TOPIC};
+ use alloc::vec;
+ use alloy_primitives::{hex, Address, Bytes, Log, LogData, B256};
+
+ #[test]
+ fn test_eip1559_update_try_from() {
+ let update_type = B256::ZERO;
+
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ update_type,
+ ],
+ hex!("000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000babe0000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let update = Eip1559Update::try_from(&system_log).unwrap();
+
+ assert_eq!(update.eip1559_denominator, 0xbabe_u32);
+ assert_eq!(update.eip1559_elasticity, 0xbeef_u32);
+ }
+
+ #[test]
+ fn test_eip1559_update_invalid_data_len() {
+ let log =
+ Log { address: Address::ZERO, data: LogData::new_unchecked(vec![], Bytes::default()) };
+ let system_log = SystemConfigLog::new(log, false);
+ let err = Eip1559Update::try_from(&system_log).unwrap_err();
+ assert_eq!(err, EIP1559UpdateError::InvalidDataLen(0));
+ }
+
+ #[test]
+ fn test_eip1559_update_pointer_decoding_error() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000babe0000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = Eip1559Update::try_from(&system_log).unwrap_err();
+ assert_eq!(err, EIP1559UpdateError::PointerDecodingError);
+ }
+
+ #[test]
+ fn test_eip1559_update_invalid_pointer_length() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("000000000000000000000000000000000000000000000000000000000000002100000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000babe0000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = Eip1559Update::try_from(&system_log).unwrap_err();
+ assert_eq!(err, EIP1559UpdateError::InvalidDataPointer(33));
+ }
+
+ #[test]
+ fn test_eip1559_update_length_decoding_error() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("0000000000000000000000000000000000000000000000000000000000000020FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF0000000000000000000000000000000000000000000000000000babe0000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = Eip1559Update::try_from(&system_log).unwrap_err();
+ assert_eq!(err, EIP1559UpdateError::LengthDecodingError);
+ }
+
+ #[test]
+ fn test_eip1559_update_invalid_data_length() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000210000000000000000000000000000000000000000000000000000babe0000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = Eip1559Update::try_from(&system_log).unwrap_err();
+ assert_eq!(err, EIP1559UpdateError::InvalidDataLength(33));
+ }
+
+ #[test]
+ fn test_eip1559_update_eip1559_decoding_error() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000020FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = Eip1559Update::try_from(&system_log).unwrap_err();
+ assert_eq!(err, EIP1559UpdateError::EIP1559DecodingError);
+ }
+}
diff --git a/crates/protocol/genesis/src/updates/gas_config.rs b/crates/protocol/genesis/src/updates/gas_config.rs
new file mode 100644
index 0000000000..9252322522
--- /dev/null
+++ b/crates/protocol/genesis/src/updates/gas_config.rs
@@ -0,0 +1,223 @@
+//! The gas config update type.
+
+use alloy_primitives::U256;
+use alloy_sol_types::{sol, SolType};
+
+use crate::{GasConfigUpdateError, RollupConfig, SystemConfig, SystemConfigLog};
+
+/// The gas config update type.
+#[derive(Debug, Default, Clone, Hash, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub struct GasConfigUpdate {
+ /// The scalar.
+ pub scalar: Option,
+ /// The overhead.
+ pub overhead: Option,
+}
+
+impl GasConfigUpdate {
+ /// Applies the update to the [`SystemConfig`].
+ pub fn apply(&self, config: &mut SystemConfig) {
+ if let Some(scalar) = self.scalar {
+ config.scalar = scalar;
+ }
+ if let Some(overhead) = self.overhead {
+ config.overhead = overhead;
+ }
+ }
+}
+
+impl TryFrom<&SystemConfigLog> for GasConfigUpdate {
+ type Error = GasConfigUpdateError;
+
+ fn try_from(sys_log: &SystemConfigLog) -> Result {
+ let log = &sys_log.log;
+ if log.data.data.len() != 128 {
+ return Err(GasConfigUpdateError::InvalidDataLen(log.data.data.len()));
+ }
+
+ let Ok(pointer) = ::abi_decode(&log.data.data[0..32], true) else {
+ return Err(GasConfigUpdateError::PointerDecodingError);
+ };
+ if pointer != 32 {
+ return Err(GasConfigUpdateError::InvalidDataPointer(pointer));
+ }
+ let Ok(length) = ::abi_decode(&log.data.data[32..64], true) else {
+ return Err(GasConfigUpdateError::LengthDecodingError);
+ };
+ if length != 64 {
+ return Err(GasConfigUpdateError::InvalidDataLength(length));
+ }
+
+ let Ok(overhead) = ::abi_decode(&log.data.data[64..96], true) else {
+ return Err(GasConfigUpdateError::OverheadDecodingError);
+ };
+ let Ok(scalar) = ::abi_decode(&log.data.data[96..], true) else {
+ return Err(GasConfigUpdateError::ScalarDecodingError);
+ };
+
+ if sys_log.ecotone_active &&
+ RollupConfig::check_ecotone_l1_system_config_scalar(scalar.to_be_bytes()).is_err()
+ {
+ // ignore invalid scalars, retain the old system-config scalar
+ return Ok(Self::default());
+ }
+
+ // If ecotone is active, set the overhead to zero, otherwise set to the decoded value.
+ let overhead = if sys_log.ecotone_active { U256::ZERO } else { overhead };
+
+ Ok(Self { scalar: Some(scalar), overhead: Some(overhead) })
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use crate::{CONFIG_UPDATE_EVENT_VERSION_0, CONFIG_UPDATE_TOPIC};
+ use alloc::vec;
+ use alloy_primitives::{hex, uint, Address, Bytes, Log, LogData, B256};
+
+ #[test]
+ fn test_gas_config_update_try_from() {
+ let update_type = B256::ZERO;
+
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ update_type,
+ ],
+ hex!("00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000babe000000000000000000000000000000000000000000000000000000000000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let update = GasConfigUpdate::try_from(&system_log).unwrap();
+
+ assert_eq!(update.overhead, Some(uint!(0xbabe_U256)));
+ assert_eq!(update.scalar, Some(uint!(0xbeef_U256)));
+ }
+
+ #[test]
+ fn test_gas_config_update_invalid_data_len() {
+ let log =
+ Log { address: Address::ZERO, data: LogData::new_unchecked(vec![], Bytes::default()) };
+ let system_log = SystemConfigLog::new(log, false);
+ let err = GasConfigUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, GasConfigUpdateError::InvalidDataLen(0));
+ }
+
+ #[test]
+ fn test_gas_config_update_pointer_decoding_error() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000babe000000000000000000000000000000000000000000000000000000000000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = GasConfigUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, GasConfigUpdateError::PointerDecodingError);
+ }
+
+ #[test]
+ fn test_gas_config_update_invalid_pointer_length() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("00000000000000000000000000000000000000000000000000000000000000210000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000babe000000000000000000000000000000000000000000000000000000000000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = GasConfigUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, GasConfigUpdateError::InvalidDataPointer(33));
+ }
+
+ #[test]
+ fn test_gas_config_update_length_decoding_error() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("0000000000000000000000000000000000000000000000000000000000000020FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000000000000000000000000000000000000000000000000000000000babe000000000000000000000000000000000000000000000000000000000000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = GasConfigUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, GasConfigUpdateError::LengthDecodingError);
+ }
+
+ #[test]
+ fn test_gas_config_update_invalid_data_length() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000041000000000000000000000000000000000000000000000000000000000000babe000000000000000000000000000000000000000000000000000000000000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = GasConfigUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, GasConfigUpdateError::InvalidDataLength(65));
+ }
+
+ #[test]
+ fn test_gas_config_update_overhead_decoding_succeeds_max_u256() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000040FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000000000000000000000000000000000000000000000000000000000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ assert!(GasConfigUpdate::try_from(&system_log).is_ok());
+ }
+
+ #[test]
+ fn test_gas_config_update_scalar_decoding_succeeds_max_u256() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000babeFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ assert!(GasConfigUpdate::try_from(&system_log).is_ok());
+ }
+}
diff --git a/crates/protocol/genesis/src/updates/gas_limit.rs b/crates/protocol/genesis/src/updates/gas_limit.rs
new file mode 100644
index 0000000000..d58401f265
--- /dev/null
+++ b/crates/protocol/genesis/src/updates/gas_limit.rs
@@ -0,0 +1,191 @@
+//! The gas limit update type.
+
+use alloy_primitives::{U256, U64};
+use alloy_sol_types::{sol, SolType};
+
+use crate::{GasLimitUpdateError, SystemConfig, SystemConfigLog};
+
+/// The gas limit update type.
+#[derive(Debug, Default, Clone, Hash, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub struct GasLimitUpdate {
+ /// The gas limit.
+ pub gas_limit: u64,
+}
+
+impl GasLimitUpdate {
+ /// Applies the update to the [`SystemConfig`].
+ pub fn apply(&self, config: &mut SystemConfig) {
+ config.gas_limit = self.gas_limit;
+ }
+}
+
+impl TryFrom<&SystemConfigLog> for GasLimitUpdate {
+ type Error = GasLimitUpdateError;
+
+ fn try_from(log: &SystemConfigLog) -> Result {
+ let log = &log.log;
+ if log.data.data.len() != 96 {
+ return Err(GasLimitUpdateError::InvalidDataLen(log.data.data.len()));
+ }
+
+ let Ok(pointer) = ::abi_decode(&log.data.data[0..32], true) else {
+ return Err(GasLimitUpdateError::PointerDecodingError);
+ };
+ if pointer != 32 {
+ return Err(GasLimitUpdateError::InvalidDataPointer(pointer));
+ }
+ let Ok(length) = ::abi_decode(&log.data.data[32..64], true) else {
+ return Err(GasLimitUpdateError::LengthDecodingError);
+ };
+ if length != 32 {
+ return Err(GasLimitUpdateError::InvalidDataLength(length));
+ }
+
+ let Ok(gas_limit) = ::abi_decode(&log.data.data[64..], true) else {
+ return Err(GasLimitUpdateError::GasLimitDecodingError);
+ };
+
+ // Prevent overflows here.
+ let max = U256::from(u64::MAX as u128);
+ if gas_limit > max {
+ return Err(GasLimitUpdateError::GasLimitDecodingError);
+ }
+
+ Ok(Self { gas_limit: U64::from(gas_limit).saturating_to::() })
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use crate::{CONFIG_UPDATE_EVENT_VERSION_0, CONFIG_UPDATE_TOPIC};
+ use alloc::vec;
+ use alloy_primitives::{hex, Address, Bytes, Log, LogData, B256};
+
+ #[test]
+ fn test_gas_limit_update_try_from() {
+ let update_type = B256::ZERO;
+
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ update_type,
+ ],
+ hex!("00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let update = GasLimitUpdate::try_from(&system_log).unwrap();
+
+ assert_eq!(update.gas_limit, 0xbeef_u64);
+ }
+
+ #[test]
+ fn test_gas_limit_update_invalid_data_len() {
+ let log =
+ Log { address: Address::ZERO, data: LogData::new_unchecked(vec![], Bytes::default()) };
+ let system_log = SystemConfigLog::new(log, false);
+ let err = GasLimitUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, GasLimitUpdateError::InvalidDataLen(0));
+ }
+
+ #[test]
+ fn test_gas_limit_update_pointer_decoding_error() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000babe0000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = GasLimitUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, GasLimitUpdateError::PointerDecodingError);
+ }
+
+ #[test]
+ fn test_gas_limit_update_invalid_pointer_length() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("000000000000000000000000000000000000000000000000000000000000002100000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000babe0000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = GasLimitUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, GasLimitUpdateError::InvalidDataPointer(33));
+ }
+
+ #[test]
+ fn test_gas_limit_update_length_decoding_error() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("0000000000000000000000000000000000000000000000000000000000000020FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF0000000000000000000000000000000000000000000000000000babe0000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = GasLimitUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, GasLimitUpdateError::LengthDecodingError);
+ }
+
+ #[test]
+ fn test_gas_limit_update_invalid_data_length() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000210000000000000000000000000000000000000000000000000000babe0000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = GasLimitUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, GasLimitUpdateError::InvalidDataLength(33));
+ }
+
+ #[test]
+ fn test_gas_limit_update_gas_limit_decoding_error() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000020FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = GasLimitUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, GasLimitUpdateError::GasLimitDecodingError);
+ }
+}
diff --git a/crates/protocol/genesis/src/updates/mod.rs b/crates/protocol/genesis/src/updates/mod.rs
new file mode 100644
index 0000000000..29f7aa9d17
--- /dev/null
+++ b/crates/protocol/genesis/src/updates/mod.rs
@@ -0,0 +1,16 @@
+//! Contains all updates to the [crate::SystemConfig] type.
+
+mod batcher;
+pub use batcher::BatcherUpdate;
+
+mod gas_config;
+pub use gas_config::GasConfigUpdate;
+
+mod gas_limit;
+pub use gas_limit::GasLimitUpdate;
+
+mod eip1559;
+pub use eip1559::Eip1559Update;
+
+mod operator_fee;
+pub use operator_fee::OperatorFeeUpdate;
diff --git a/crates/protocol/genesis/src/updates/operator_fee.rs b/crates/protocol/genesis/src/updates/operator_fee.rs
new file mode 100644
index 0000000000..f0977054f0
--- /dev/null
+++ b/crates/protocol/genesis/src/updates/operator_fee.rs
@@ -0,0 +1,176 @@
+//! The Operator Fee update type.
+
+use alloy_sol_types::{sol, SolType};
+
+use crate::{OperatorFeeUpdateError, SystemConfig, SystemConfigLog};
+
+/// The Operator Fee update type.
+#[derive(Debug, Default, Clone, Hash, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+pub struct OperatorFeeUpdate {
+ /// The operator fee scalar.
+ pub operator_fee_scalar: u32,
+ /// The operator fee constant.
+ pub operator_fee_constant: u64,
+}
+
+impl OperatorFeeUpdate {
+ /// Applies the update to the [`SystemConfig`].
+ pub fn apply(&self, config: &mut SystemConfig) {
+ config.operator_fee_scalar = Some(self.operator_fee_scalar);
+ config.operator_fee_constant = Some(self.operator_fee_constant);
+ }
+}
+
+impl TryFrom<&SystemConfigLog> for OperatorFeeUpdate {
+ type Error = OperatorFeeUpdateError;
+
+ fn try_from(log: &SystemConfigLog) -> Result {
+ let log = &log.log;
+ if log.data.data.len() != 96 {
+ return Err(OperatorFeeUpdateError::InvalidDataLen(log.data.data.len()));
+ }
+
+ let Ok(pointer) = ::abi_decode(&log.data.data[0..32], true) else {
+ return Err(OperatorFeeUpdateError::PointerDecodingError);
+ };
+ if pointer != 32 {
+ return Err(OperatorFeeUpdateError::InvalidDataPointer(pointer));
+ }
+ let Ok(length) = ::abi_decode(&log.data.data[32..64], true) else {
+ return Err(OperatorFeeUpdateError::LengthDecodingError);
+ };
+ if length != 32 {
+ return Err(OperatorFeeUpdateError::InvalidDataLength(length));
+ }
+
+ // The operator fee scalar and constant are
+ // packed into a single u256 as follows:
+ //
+ // | Bytes | Actual Size | Variable |
+ // |----------|-------------|----------|
+ // | 0 .. 24 | uint32 | scalar |
+ // | 24 .. 32 | uint64 | constant |
+ // |----------|-------------|----------|
+
+ let mut be_bytes = [0u8; 4];
+ be_bytes[0..4].copy_from_slice(&log.data.data[84..88]);
+ let operator_fee_scalar = u32::from_be_bytes(be_bytes);
+
+ let mut be_bytes = [0u8; 8];
+ be_bytes[0..8].copy_from_slice(&log.data.data[88..96]);
+ let operator_fee_constant = u64::from_be_bytes(be_bytes);
+
+ Ok(Self { operator_fee_scalar, operator_fee_constant })
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use crate::{CONFIG_UPDATE_EVENT_VERSION_0, CONFIG_UPDATE_TOPIC};
+ use alloc::vec;
+ use alloy_primitives::{hex, Address, Bytes, Log, LogData, B256};
+
+ #[test]
+ fn test_operator_fee_update_try_from() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![], // Topics aren't checked
+ hex!("0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000babe000000000000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let update = OperatorFeeUpdate::try_from(&system_log).unwrap();
+
+ assert_eq!(update.operator_fee_scalar, 0xbabe_u32);
+ assert_eq!(update.operator_fee_constant, 0xbeef_u64);
+ }
+
+ #[test]
+ fn test_operator_fee_update_invalid_data_len() {
+ let log =
+ Log { address: Address::ZERO, data: LogData::new_unchecked(vec![], Bytes::default()) };
+ let system_log = SystemConfigLog::new(log, false);
+ let err = OperatorFeeUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, OperatorFeeUpdateError::InvalidDataLen(0));
+ }
+
+ #[test]
+ fn test_operator_fee_update_pointer_decoding_error() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000babe0000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = OperatorFeeUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, OperatorFeeUpdateError::PointerDecodingError);
+ }
+
+ #[test]
+ fn test_operator_fee_update_invalid_pointer_length() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("000000000000000000000000000000000000000000000000000000000000002100000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000babe0000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = OperatorFeeUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, OperatorFeeUpdateError::InvalidDataPointer(33));
+ }
+
+ #[test]
+ fn test_operator_fee_update_length_decoding_error() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("0000000000000000000000000000000000000000000000000000000000000020FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF0000000000000000000000000000000000000000000000000000babe0000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = OperatorFeeUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, OperatorFeeUpdateError::LengthDecodingError);
+ }
+
+ #[test]
+ fn test_operator_fee_update_invalid_data_length() {
+ let log = Log {
+ address: Address::ZERO,
+ data: LogData::new_unchecked(
+ vec![
+ CONFIG_UPDATE_TOPIC,
+ CONFIG_UPDATE_EVENT_VERSION_0,
+ B256::ZERO,
+ ],
+ hex!("000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000210000000000000000000000000000000000000000000000000000babe0000beef").into()
+ )
+ };
+
+ let system_log = SystemConfigLog::new(log, false);
+ let err = OperatorFeeUpdate::try_from(&system_log).unwrap_err();
+ assert_eq!(err, OperatorFeeUpdateError::InvalidDataLength(33));
+ }
+}
diff --git a/crates/protocol/interop/Cargo.toml b/crates/protocol/interop/Cargo.toml
index 401c8f602a..c81c90c460 100644
--- a/crates/protocol/interop/Cargo.toml
+++ b/crates/protocol/interop/Cargo.toml
@@ -12,6 +12,10 @@ homepage.workspace = true
workspace = true
[dependencies]
+# Workspace
+kona-genesis.workspace = true
+kona-registry.workspace = true
+
# General
thiserror.workspace = true
async-trait.workspace = true
@@ -24,10 +28,6 @@ alloy-consensus.workspace = true
alloy-rlp.workspace = true
op-alloy-consensus.workspace = true
-# maili
-maili-genesis.workspace = true
-maili-registry.workspace = true
-
# Arbitrary
arbitrary = { version = "1.4", features = ["derive"], optional = true }
@@ -35,11 +35,13 @@ arbitrary = { version = "1.4", features = ["derive"], optional = true }
serde = { workspace = true, optional = true }
[dev-dependencies]
+serde_json.workspace = true
tokio = { workspace = true, features = ["full"] }
alloy-primitives = { workspace = true, features = ["rlp", "arbitrary"] }
arbitrary = { version = "1.4", features = ["derive"] }
rand.workspace = true
[features]
+default = []
arbitrary = ["dep:arbitrary", "alloy-primitives/arbitrary"]
serde = ["dep:serde", "alloy-primitives/serde"]
diff --git a/crates/protocol/interop/src/errors.rs b/crates/protocol/interop/src/errors.rs
index d77be971d4..435ff99295 100644
--- a/crates/protocol/interop/src/errors.rs
+++ b/crates/protocol/interop/src/errors.rs
@@ -33,7 +33,7 @@ pub enum MessageGraphError {
InvalidMessages(Vec),
/// Missing a [RollupConfig] for a chain ID
///
- /// [RollupConfig]: maili_genesis::RollupConfig
+ /// [RollupConfig]: kona_genesis::RollupConfig
#[error("Missing a RollupConfig for chain ID {0}")]
MissingRollupConfig(u64),
/// Interop provider error
diff --git a/crates/protocol/interop/src/graph.rs b/crates/protocol/interop/src/graph.rs
index f673059d43..25445bc394 100644
--- a/crates/protocol/interop/src/graph.rs
+++ b/crates/protocol/interop/src/graph.rs
@@ -9,8 +9,8 @@ use crate::{
use alloc::vec::Vec;
use alloy_consensus::{Header, Sealed};
use alloy_primitives::{hex, keccak256, map::HashMap};
-use maili_genesis::RollupConfig;
-use maili_registry::ROLLUP_CONFIGS;
+use kona_genesis::RollupConfig;
+use kona_registry::ROLLUP_CONFIGS;
use tracing::{info, warn};
/// The message graph represents a set of blocks at a given timestamp and the interop
@@ -240,7 +240,7 @@ mod test {
use super::MessageGraph;
use crate::{test_util::SuperchainBuilder, MessageGraphError};
use alloy_primitives::{hex, keccak256, map::HashMap, Address};
- use maili_genesis::RollupConfig;
+ use kona_genesis::RollupConfig;
const MESSAGE: [u8; 4] = hex!("deadbeef");
const OP_CHAIN_ID: u64 = 10;
diff --git a/crates/protocol/interop/src/lib.rs b/crates/protocol/interop/src/lib.rs
index c5fada5f4c..ffd7866e67 100644
--- a/crates/protocol/interop/src/lib.rs
+++ b/crates/protocol/interop/src/lib.rs
@@ -5,7 +5,7 @@
)]
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
#![cfg_attr(not(test), warn(unused_crate_dependencies))]
-#![cfg_attr(not(any(test, feature = "arbitrary")), no_std)]
+#![cfg_attr(not(feature = "arbitrary"), no_std)]
extern crate alloc;
@@ -24,6 +24,9 @@ pub use constants::{CROSS_L2_INBOX_ADDRESS, MESSAGE_EXPIRY_WINDOW, SUPER_ROOT_VE
mod traits;
pub use traits::InteropProvider;
+mod safety;
+pub use safety::SafetyLevel;
+
mod errors;
pub use errors::{MessageGraphError, MessageGraphResult, SuperRootError, SuperRootResult};
diff --git a/crates/protocol/interop/src/message.rs b/crates/protocol/interop/src/message.rs
index 94de90038f..fdfe4fa438 100644
--- a/crates/protocol/interop/src/message.rs
+++ b/crates/protocol/interop/src/message.rs
@@ -12,11 +12,13 @@ use op_alloy_consensus::OpReceiptEnvelope;
sol! {
/// @notice The struct for a pointer to a message payload in a remote (or local) chain.
#[derive(Default, Debug, PartialEq, Eq)]
+ #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
struct MessageIdentifier {
address origin;
uint256 blockNumber;
uint256 logIndex;
uint256 timestamp;
+ #[cfg_attr(feature = "serde", serde(rename = "chainID"))]
uint256 chainId;
}
@@ -24,6 +26,7 @@ sol! {
/// @param msgHash Hash of message payload being executed.
/// @param id Encoded Identifier of the message.
#[derive(Default, Debug, PartialEq, Eq)]
+ #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
event ExecutingMessage(bytes32 indexed msgHash, MessageIdentifier id);
/// @notice Executes a cross chain message on the destination chain.
diff --git a/crates/protocol/interop/src/safety.rs b/crates/protocol/interop/src/safety.rs
new file mode 100644
index 0000000000..7c37dcf45f
--- /dev/null
+++ b/crates/protocol/interop/src/safety.rs
@@ -0,0 +1,43 @@
+//! Message safety level for interoperability.
+
+/// The safety level of a message.
+#[derive(Debug, Clone, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "serde", serde(rename_all = "kebab-case"))]
+pub enum SafetyLevel {
+ /// The message is finalized.
+ Finalized,
+ /// The message is safe.
+ Safe,
+ /// The message is safe locally.
+ LocalSafe,
+ /// The message is unsafe across chains.
+ CrossUnsafe,
+ /// The message is unsafe.
+ Unsafe,
+ /// The message is invalid.
+ Invalid,
+}
+
+#[cfg(test)]
+#[cfg(feature = "serde")]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn test_safety_level_serde() {
+ let level = SafetyLevel::Finalized;
+ let json = serde_json::to_string(&level).unwrap();
+ assert_eq!(json, r#""finalized""#);
+
+ let level: SafetyLevel = serde_json::from_str(&json).unwrap();
+ assert_eq!(level, SafetyLevel::Finalized);
+ }
+
+ #[test]
+ fn test_serde_safety_level_fails() {
+ let json = r#""failed""#;
+ let level: Result = serde_json::from_str(json);
+ assert!(level.is_err());
+ }
+}
diff --git a/crates/protocol/protocol/Cargo.toml b/crates/protocol/protocol/Cargo.toml
new file mode 100644
index 0000000000..648e7b6c50
--- /dev/null
+++ b/crates/protocol/protocol/Cargo.toml
@@ -0,0 +1,105 @@
+[package]
+name = "kona-protocol"
+version = "0.1.0"
+description = "Optimism protocol-specific types"
+
+edition.workspace = true
+rust-version.workspace = true
+authors.workspace = true
+license.workspace = true
+homepage.workspace = true
+repository.workspace = true
+exclude.workspace = true
+
+[lints]
+workspace = true
+
+[dependencies]
+# Workspace
+kona-genesis.workspace = true
+
+# OP Alloy
+op-alloy-flz.workspace = true
+op-alloy-consensus.workspace = true
+
+# Alloy
+alloy-primitives = { workspace = true, features = ["map"] }
+alloy-rlp.workspace = true
+alloy-eips.workspace = true
+alloy-consensus.workspace = true
+
+# Misc
+rand = { workspace = true, features = ["small_rng"] }
+tracing.workspace = true
+thiserror.workspace = true
+async-trait.workspace = true
+unsigned-varint.workspace = true
+
+# Compression
+brotli.workspace = true
+miniz_oxide.workspace = true
+alloc-no-stdlib.workspace = true
+
+# `arbitrary` feature
+arbitrary = { workspace = true, features = ["derive"], optional = true }
+
+# `serde` feature
+serde = { workspace = true, optional = true }
+alloy-serde = { workspace = true, optional = true }
+
+# `test-utils` feature
+spin = { workspace = true, optional = true }
+tracing-subscriber = { workspace = true, features = ["fmt"], optional = true }
+
+[dev-dependencies]
+brotli = { workspace = true, features = ["std"] }
+revm.workspace = true
+spin.workspace = true
+rand = { workspace = true, features = ["std", "std_rng"] }
+rstest.workspace = true
+proptest.workspace = true
+serde_json.workspace = true
+alloy-sol-types.workspace = true
+tokio = { workspace = true, features = ["full"] }
+arbitrary = { workspace = true, features = ["derive"] }
+tracing-subscriber = { workspace = true, features = ["fmt"] }
+alloy-primitives = { workspace = true, features = ["arbitrary"] }
+
+[features]
+default = []
+std = [
+ "kona-genesis/std",
+ "op-alloy-consensus/std",
+ "brotli/std",
+ "alloy-consensus/std",
+ "alloy-primitives/std",
+ "alloy-rlp/std",
+ "alloy-serde?/std",
+ "miniz_oxide/std",
+ "thiserror/std",
+ "unsigned-varint/std"
+]
+test-utils = [
+ "dep:spin",
+ "dep:tracing-subscriber",
+]
+arbitrary = [
+ "std",
+ "dep:arbitrary",
+ "kona-genesis/arbitrary",
+ "op-alloy-consensus/arbitrary",
+ "alloy-consensus/arbitrary",
+ "alloy-eips/arbitrary",
+ "alloy-primitives/rand",
+ "alloy-primitives/arbitrary",
+]
+serde = [
+ "dep:serde",
+ "dep:alloy-serde",
+ "kona-genesis/serde",
+ "op-alloy-consensus/serde",
+ "alloy-consensus/serde",
+ "alloy-eips/serde",
+ "alloy-primitives/serde",
+ "tracing-subscriber?/serde"
+]
diff --git a/crates/protocol/protocol/README.md b/crates/protocol/protocol/README.md
new file mode 100644
index 0000000000..aa7ca8e34b
--- /dev/null
+++ b/crates/protocol/protocol/README.md
@@ -0,0 +1,19 @@
+## `kona-protocol`
+
+
+
+
+
+
+
+
+Core protocol types for Optimism.
+
+These include types, constants, and methods for derivation as well as batch-submission.
+
+### Provenance
+
+This code was initially ported from [kona-primitives] to [op-alloy] as part of maili migrations.
+
+[kona-primitives]: https://github.com/ethereum-optimism/kona/tree/main/crates/kona-primitives
+[op-alloy]: https://github.com/alloy-rs/op-alloy
diff --git a/crates/protocol/protocol/examples/batch_to_frames.rs b/crates/protocol/protocol/examples/batch_to_frames.rs
new file mode 100644
index 0000000000..1ccd520f2a
--- /dev/null
+++ b/crates/protocol/protocol/examples/batch_to_frames.rs
@@ -0,0 +1,112 @@
+//! An example encoding and decoding a [SingleBatch].
+//!
+//! This example demonstrates EIP-2718 encoding a [SingleBatch]
+//! through a [ChannelOut] and into individual [Frame]s.
+//!
+//! Notice, the raw batch is first _encoded_.
+//! Once encoded, it is compressed into raw data that the channel is constructed with.
+//!
+//! The [ChannelOut] then outputs frames individually using the maximum frame size,
+//! in this case hardcoded to 100, to construct the frames.
+//!
+//! Finally, once [Frame]s are built from the [ChannelOut], they are encoded and ready
+//! to be batch-submitted to the data availability layer.
+
+#[cfg(feature = "std")]
+fn main() {
+ use alloy_primitives::BlockHash;
+ use kona_genesis::RollupConfig;
+ use kona_protocol::{
+ Batch, ChannelId, ChannelOut, CompressionAlgo, SingleBatch, VariantCompressor,
+ };
+
+ // Use the example transaction
+ let transactions = example_transactions();
+
+ // Construct a basic `SingleBatch`
+ let parent_hash = BlockHash::ZERO;
+ let epoch_num = 1;
+ let epoch_hash = BlockHash::ZERO;
+ let timestamp = 1;
+ let single_batch = SingleBatch { parent_hash, epoch_num, epoch_hash, timestamp, transactions };
+ let batch = Batch::Single(single_batch);
+
+ // Create a new channel.
+ let id = ChannelId::default();
+ let config = RollupConfig::default();
+ let compressor: VariantCompressor = CompressionAlgo::Brotli10.into();
+ let mut channel_out = ChannelOut::new(id, &config, compressor);
+
+ // Add the compressed batch to the `ChannelOut`.
+ channel_out.add_batch(batch).unwrap();
+
+ // Output frames
+ while channel_out.ready_bytes() > 0 {
+ let frame = channel_out.output_frame(100).expect("outputs frame");
+ println!("Frame: {}", alloy_primitives::hex::encode(frame.encode()));
+ if channel_out.ready_bytes() <= 100 {
+ channel_out.close();
+ }
+ }
+
+ assert!(channel_out.closed);
+ println!("Successfully encoded Batch to frames");
+}
+
+#[cfg(feature = "std")]
+fn example_transactions() -> Vec {
+ use alloy_consensus::{SignableTransaction, TxEip1559, TxEnvelope};
+ use alloy_eips::eip2718::{Decodable2718, Encodable2718};
+ use alloy_primitives::{Address, PrimitiveSignature, U256};
+
+ let mut transactions = Vec::new();
+
+ // First Transaction in the batch.
+ let tx = TxEip1559 {
+ chain_id: 10u64,
+ nonce: 2,
+ max_fee_per_gas: 3,
+ max_priority_fee_per_gas: 4,
+ gas_limit: 5,
+ to: Address::left_padding_from(&[6]).into(),
+ value: U256::from(7_u64),
+ input: vec![8].into(),
+ access_list: Default::default(),
+ };
+ let sig = PrimitiveSignature::test_signature();
+ let tx_signed = tx.into_signed(sig);
+ let envelope: TxEnvelope = tx_signed.into();
+ let encoded = envelope.encoded_2718();
+ transactions.push(encoded.clone().into());
+ let mut slice = encoded.as_slice();
+ let decoded = TxEnvelope::decode_2718(&mut slice).unwrap();
+ assert!(matches!(decoded, TxEnvelope::Eip1559(_)));
+
+ // Second transaction in the batch.
+ let tx = TxEip1559 {
+ chain_id: 10u64,
+ nonce: 2,
+ max_fee_per_gas: 3,
+ max_priority_fee_per_gas: 4,
+ gas_limit: 5,
+ to: Address::left_padding_from(&[7]).into(),
+ value: U256::from(7_u64),
+ input: vec![8].into(),
+ access_list: Default::default(),
+ };
+ let sig = PrimitiveSignature::test_signature();
+ let tx_signed = tx.into_signed(sig);
+ let envelope: TxEnvelope = tx_signed.into();
+ let encoded = envelope.encoded_2718();
+ transactions.push(encoded.clone().into());
+ let mut slice = encoded.as_slice();
+ let decoded = TxEnvelope::decode_2718(&mut slice).unwrap();
+ assert!(matches!(decoded, TxEnvelope::Eip1559(_)));
+
+ transactions
+}
+
+#[cfg(not(feature = "std"))]
+fn main() {
+ /* not implemented for no_std */
+}
diff --git a/crates/protocol/protocol/examples/frames_to_batch.rs b/crates/protocol/protocol/examples/frames_to_batch.rs
new file mode 100644
index 0000000000..a5f099820a
--- /dev/null
+++ b/crates/protocol/protocol/examples/frames_to_batch.rs
@@ -0,0 +1,100 @@
+//! This example decodes raw [Frame]s and reads them into a [Channel] and into a [SingleBatch].
+
+use alloy_consensus::{SignableTransaction, TxEip1559, TxEnvelope};
+use alloy_eips::eip2718::{Decodable2718, Encodable2718};
+use alloy_primitives::{hex, Address, BlockHash, Bytes, PrimitiveSignature, U256};
+use kona_genesis::RollupConfig;
+use kona_protocol::{decompress_brotli, Batch, BlockInfo, Channel, Frame, SingleBatch};
+
+fn main() {
+ // Raw frame data taken from the `encode_channel` example.
+ let first_frame = hex!("60d54f49b71978b1b09288af847b11d200000000004d1b1301f82f0f6c3734f4821cd090ef3979d71a98e7e483b1dccdd525024c0ef16f425c7b4976a7acc0c94a0514b72c096d4dcc52f0b22dae193c70c86d0790a304a08152c8250031d091063ea000");
+ let second_frame = hex!("60d54f49b71978b1b09288af847b11d2000100000046b00d00005082edde7ccf05bded2004462b5e80e1c42cd08e307f5baac723b22864cc6cd01ddde84efc7c018d7ada56c2fa8e3c5bedd494c3a7a884439d5771afcecaf196cb3801");
+
+ // Decode the raw frames.
+ let decoded_first = Frame::decode(&first_frame).expect("decodes frame").1;
+ let decoded_second = Frame::decode(&second_frame).expect("decodes frame").1;
+
+ // Create a channel.
+ let id = decoded_first.id;
+ let open_block = BlockInfo::default();
+ let mut channel = Channel::new(id, open_block);
+
+ // Add the frames to the channel.
+ let l1_inclusion_block = BlockInfo::default();
+ channel.add_frame(decoded_first, l1_inclusion_block).expect("adds frame");
+ channel.add_frame(decoded_second, l1_inclusion_block).expect("adds frame");
+
+ // Get the frame data from the channel.
+ let frame_data = channel.frame_data().expect("some frame data");
+ println!("Frame data: {}", hex::encode(&frame_data));
+
+ // Decompress the frame data with brotli.
+ let config = RollupConfig::default();
+ let max = config.max_rlp_bytes_per_channel(open_block.timestamp) as usize;
+ let decompressed = decompress_brotli(&frame_data, max).expect("decompresses brotli");
+ println!("Decompressed frame data: {}", hex::encode(&decompressed));
+
+ // Decode the single batch from the decompressed data.
+ let batch = Batch::decode(&mut decompressed.as_slice(), &config).expect("batch decodes");
+ assert_eq!(
+ batch,
+ Batch::Single(SingleBatch {
+ parent_hash: BlockHash::ZERO,
+ epoch_num: 1,
+ epoch_hash: BlockHash::ZERO,
+ timestamp: 1,
+ transactions: example_transactions(),
+ })
+ );
+
+ println!("Successfully decoded frames into a Batch");
+}
+
+fn example_transactions() -> Vec {
+ let mut transactions = Vec::new();
+
+ // First Transaction in the batch.
+ let tx = TxEip1559 {
+ chain_id: 10u64,
+ nonce: 2,
+ max_fee_per_gas: 3,
+ max_priority_fee_per_gas: 4,
+ gas_limit: 5,
+ to: Address::left_padding_from(&[6]).into(),
+ value: U256::from(7_u64),
+ input: vec![8].into(),
+ access_list: Default::default(),
+ };
+ let sig = PrimitiveSignature::test_signature();
+ let tx_signed = tx.into_signed(sig);
+ let envelope: TxEnvelope = tx_signed.into();
+ let encoded = envelope.encoded_2718();
+ transactions.push(encoded.clone().into());
+ let mut slice = encoded.as_slice();
+ let decoded = TxEnvelope::decode_2718(&mut slice).unwrap();
+ assert!(matches!(decoded, TxEnvelope::Eip1559(_)));
+
+ // Second transaction in the batch.
+ let tx = TxEip1559 {
+ chain_id: 10u64,
+ nonce: 2,
+ max_fee_per_gas: 3,
+ max_priority_fee_per_gas: 4,
+ gas_limit: 5,
+ to: Address::left_padding_from(&[7]).into(),
+ value: U256::from(7_u64),
+ input: vec![8].into(),
+ access_list: Default::default(),
+ };
+ let sig = PrimitiveSignature::test_signature();
+ let tx_signed = tx.into_signed(sig);
+ let envelope: TxEnvelope = tx_signed.into();
+ let encoded = envelope.encoded_2718();
+ transactions.push(encoded.clone().into());
+ let mut slice = encoded.as_slice();
+ let decoded = TxEnvelope::decode_2718(&mut slice).unwrap();
+ assert!(matches!(decoded, TxEnvelope::Eip1559(_)));
+
+ transactions
+}
diff --git a/crates/protocol/protocol/src/batch/bits.rs b/crates/protocol/protocol/src/batch/bits.rs
new file mode 100644
index 0000000000..4c0b462690
--- /dev/null
+++ b/crates/protocol/protocol/src/batch/bits.rs
@@ -0,0 +1,234 @@
+//! Module for working with span batch bits.
+
+use crate::SpanBatchError;
+use alloc::{vec, vec::Vec};
+use alloy_primitives::bytes;
+use alloy_rlp::Buf;
+use core::cmp::Ordering;
+
+/// Type for span batch bits.
+#[derive(Debug, Default, Clone, PartialEq, Eq)]
+pub struct SpanBatchBits(Vec);
+
+impl AsRef<[u8]> for SpanBatchBits {
+ fn as_ref(&self) -> &[u8] {
+ &self.0
+ }
+}
+
+impl SpanBatchBits {
+ /// Creates a new span batch bits.
+ pub const fn new(inner: Vec) -> Self {
+ Self(inner)
+ }
+
+ /// Decodes a standard span-batch bitlist from a reader.
+ /// The bitlist is encoded as big-endian integer, left-padded with zeroes to a multiple of 8
+ /// bits. The encoded bitlist cannot be longer than `bit_length`.
+ pub fn decode(b: &mut &[u8], bit_length: usize) -> Result {
+ let buffer_len = bit_length / 8 + if bit_length % 8 != 0 { 1 } else { 0 };
+ let bits = if b.len() < buffer_len {
+ let mut bits = vec![0; buffer_len];
+ bits[..b.len()].copy_from_slice(b);
+ b.advance(b.len());
+ bits
+ } else {
+ let v = b[..buffer_len].to_vec();
+ b.advance(buffer_len);
+ v
+ };
+ let sb_bits = Self(bits);
+
+ if sb_bits.bit_len() > bit_length {
+ return Err(SpanBatchError::BitfieldTooLong);
+ }
+
+ Ok(sb_bits)
+ }
+
+ /// Encodes a standard span-batch bitlist.
+ /// The bitlist is encoded as big-endian integer, left-padded with zeroes to a multiple of 8
+ /// bits. The encoded bitlist cannot be longer than `bit_length`
+ pub fn encode(
+ w: &mut dyn bytes::BufMut,
+ bit_length: usize,
+ bits: &Self,
+ ) -> Result<(), SpanBatchError> {
+ if bits.bit_len() > bit_length {
+ return Err(SpanBatchError::BitfieldTooLong);
+ }
+
+ // Round up, ensure enough bytes when number of bits is not a multiple of 8.
+ // Alternative of (L+7)/8 is not overflow-safe.
+ let buf_len = bit_length / 8 + if bit_length % 8 != 0 { 1 } else { 0 };
+ let mut buf = vec![0; buf_len];
+ buf[buf_len - bits.0.len()..].copy_from_slice(bits.as_ref());
+ w.put_slice(&buf);
+ Ok(())
+ }
+
+ /// Get a bit from the [SpanBatchBits] bitlist.
+ pub fn get_bit(&self, index: usize) -> Option {
+ let byte_index = index / 8;
+ let bit_index = index % 8;
+
+ // Check if the byte index is within the bounds of the bitlist
+ if byte_index < self.0.len() {
+ // Retrieve the specific byte that contains the bit we're interested in
+ let byte = self.0[self.0.len() - byte_index - 1];
+
+ // Shift the bits of the byte to the right, based on the bit index, and
+ // mask it with 1 to isolate the bit we're interested in.
+ // If the result is not zero, the bit is set to 1, otherwise it's 0.
+ Some(if byte & (1 << bit_index) != 0 { 1 } else { 0 })
+ } else {
+ // Return None if the index is out of bounds
+ None
+ }
+ }
+
+ /// Sets a bit in the [SpanBatchBits] bitlist.
+ pub fn set_bit(&mut self, index: usize, value: bool) {
+ let byte_index = index / 8;
+ let bit_index = index % 8;
+
+ // Ensure the vector is large enough to contain the bit at 'index'.
+ // If not, resize the vector, filling with 0s.
+ if byte_index >= self.0.len() {
+ Self::resize_from_right(&mut self.0, byte_index + 1);
+ }
+
+ // Retrieve the specific byte to modify
+ let len = self.0.len();
+ let byte = &mut self.0[len - byte_index - 1];
+
+ if value {
+ // Set the bit to 1
+ *byte |= 1 << bit_index;
+ } else {
+ // Set the bit to 0
+ *byte &= !(1 << bit_index);
+ }
+ }
+
+ /// Calculates the bit length of the [SpanBatchBits] bitfield.
+ pub fn bit_len(&self) -> usize {
+ // Iterate over the bytes from left to right to find the first non-zero byte
+ for (i, &byte) in self.0.iter().enumerate() {
+ if byte != 0 {
+ // Calculate the index of the most significant bit in the byte
+ let msb_index = 7 - byte.leading_zeros() as usize; // 0-based index
+
+ // Calculate the total bit length
+ let total_bit_length = msb_index + 1 + ((self.0.len() - i - 1) * 8);
+ return total_bit_length;
+ }
+ }
+
+ // If all bytes are zero, the bitlist is considered to have a length of 0
+ 0
+ }
+
+ /// Resizes an array from the right. Useful for big-endian zero extension.
+ fn resize_from_right(vec: &mut Vec, new_size: usize) {
+ let current_size = vec.len();
+ match new_size.cmp(¤t_size) {
+ Ordering::Less => {
+ // Remove elements from the beginning.
+ let remove_count = current_size - new_size;
+ vec.drain(0..remove_count);
+ }
+ Ordering::Greater => {
+ // Calculate how many new elements to add.
+ let additional = new_size - current_size;
+ // Prepend new elements with default values.
+ let mut prepend_elements = vec![T::default(); additional];
+ prepend_elements.append(vec);
+ *vec = prepend_elements;
+ }
+ Ordering::Equal => { /* If new_size == current_size, do nothing. */ }
+ }
+ }
+}
+
+#[cfg(test)]
+mod test {
+ use super::*;
+ use proptest::{collection::vec, prelude::any, proptest};
+
+ proptest! {
+ #[test]
+ fn test_encode_decode_roundtrip_span_bitlist(vec in vec(any::(), 0..5096)) {
+ let bits = SpanBatchBits(vec);
+ assert_eq!(SpanBatchBits::decode(&mut bits.as_ref(), bits.0.len() * 8).unwrap(), bits);
+ let mut encoded = Vec::new();
+ SpanBatchBits::encode(&mut encoded, bits.0.len() * 8, &bits).unwrap();
+ assert_eq!(encoded, bits.0);
+ }
+
+ #[test]
+ fn test_span_bitlist_bitlen(index in 0usize..65536) {
+ let mut bits = SpanBatchBits::default();
+ bits.set_bit(index, true);
+ assert_eq!(bits.0.len(), (index / 8) + 1);
+ assert_eq!(bits.bit_len(), index + 1);
+ }
+
+ #[test]
+ fn test_span_bitlist_bitlen_shrink(first_index in 8usize..65536) {
+ let second_index = first_index.clamp(0, first_index - 8);
+ let mut bits = SpanBatchBits::default();
+
+ // Set and clear first index.
+ bits.set_bit(first_index, true);
+ assert_eq!(bits.0.len(), (first_index / 8) + 1);
+ assert_eq!(bits.bit_len(), first_index + 1);
+ bits.set_bit(first_index, false);
+ assert_eq!(bits.0.len(), (first_index / 8) + 1);
+ assert_eq!(bits.bit_len(), 0);
+
+ // Set second bit. Even though the array is larger, as it was originally allocated with more words,
+ // the bitlength should still be lowered as the higher-order words are 0'd out.
+ bits.set_bit(second_index, true);
+ assert_eq!(bits.0.len(), (first_index / 8) + 1);
+ assert_eq!(bits.bit_len(), second_index + 1);
+ }
+ }
+
+ #[test]
+ fn bitlist_big_endian_zero_extended() {
+ let mut bits = SpanBatchBits::default();
+
+ bits.set_bit(1, true);
+ bits.set_bit(6, true);
+ bits.set_bit(8, true);
+ bits.set_bit(15, true);
+ assert_eq!(bits.0[0], 0b1000_0001);
+ assert_eq!(bits.0[1], 0b0100_0010);
+ assert_eq!(bits.0.len(), 2);
+ assert_eq!(bits.bit_len(), 16);
+ }
+
+ #[test]
+ fn test_static_set_get_bits_span_bitlist() {
+ let mut bits = SpanBatchBits::default();
+ assert!(bits.0.is_empty());
+
+ bits.set_bit(0, true);
+ bits.set_bit(1, true);
+ bits.set_bit(2, true);
+ bits.set_bit(4, true);
+ bits.set_bit(7, true);
+ assert_eq!(bits.0.len(), 1);
+ assert_eq!(bits.get_bit(0), Some(1));
+ assert_eq!(bits.get_bit(1), Some(1));
+ assert_eq!(bits.get_bit(2), Some(1));
+ assert_eq!(bits.get_bit(3), Some(0));
+ assert_eq!(bits.get_bit(4), Some(1));
+
+ bits.set_bit(17, true);
+ assert_eq!(bits.get_bit(17), Some(1));
+ assert_eq!(bits.get_bit(32), None);
+ assert_eq!(bits.0.len(), 3);
+ }
+}
diff --git a/crates/protocol/protocol/src/batch/core.rs b/crates/protocol/protocol/src/batch/core.rs
new file mode 100644
index 0000000000..3225ab6d4d
--- /dev/null
+++ b/crates/protocol/protocol/src/batch/core.rs
@@ -0,0 +1,133 @@
+//! Module containing the core [Batch] enum.
+
+use crate::{
+ BatchDecodingError, BatchEncodingError, BatchType, RawSpanBatch, SingleBatch, SpanBatch,
+};
+use alloy_primitives::bytes;
+use alloy_rlp::{Buf, Decodable, Encodable};
+use kona_genesis::RollupConfig;
+
+/// A Batch.
+#[derive(Debug, Clone, PartialEq, Eq)]
+#[allow(clippy::large_enum_variant)]
+pub enum Batch {
+ /// A single batch
+ Single(SingleBatch),
+ /// Span Batches
+ Span(SpanBatch),
+}
+
+impl Batch {
+ /// Returns the timestamp for the batch.
+ pub fn timestamp(&self) -> u64 {
+ match self {
+ Self::Single(sb) => sb.timestamp,
+ Self::Span(sb) => sb.starting_timestamp(),
+ }
+ }
+
+ /// Attempts to decode a batch from a reader.
+ pub fn decode(r: &mut &[u8], cfg: &RollupConfig) -> Result {
+ if r.is_empty() {
+ return Err(BatchDecodingError::EmptyBuffer);
+ }
+
+ // Read the batch type
+ let batch_type = BatchType::from(r[0]);
+ r.advance(1);
+
+ match batch_type {
+ BatchType::Single => {
+ let single_batch =
+ SingleBatch::decode(r).map_err(BatchDecodingError::AlloyRlpError)?;
+ Ok(Self::Single(single_batch))
+ }
+ BatchType::Span => {
+ let mut raw_span_batch = RawSpanBatch::decode(r)?;
+ let span_batch = raw_span_batch
+ .derive(cfg.block_time, cfg.genesis.l2_time, cfg.l2_chain_id)
+ .map_err(BatchDecodingError::SpanBatchError)?;
+ Ok(Self::Span(span_batch))
+ }
+ }
+ }
+
+ /// Attempts to encode the batch to a writer.
+ pub fn encode(&self, out: &mut dyn bytes::BufMut) -> Result<(), BatchEncodingError> {
+ match self {
+ Self::Single(sb) => {
+ out.put_u8(BatchType::Single as u8);
+ sb.encode(out);
+ }
+ Self::Span(sb) => {
+ out.put_u8(BatchType::Span as u8);
+ let raw_span_batch =
+ sb.to_raw_span_batch().map_err(BatchEncodingError::SpanBatchError)?;
+ raw_span_batch.encode(out).map_err(BatchEncodingError::SpanBatchError)?;
+ }
+ }
+ Ok(())
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use crate::{SpanBatchElement, SpanBatchError, SpanBatchTransactions};
+ use alloc::{vec, vec::Vec};
+ use alloy_consensus::{Signed, TxEip2930, TxEnvelope};
+ use alloy_primitives::{address, hex, Bytes, PrimitiveSignature as Signature, TxKind};
+
+ #[test]
+ fn test_single_batch_encode_decode() {
+ let mut out = Vec::new();
+ let batch = Batch::Single(SingleBatch::default());
+ batch.encode(&mut out).unwrap();
+ let decoded = Batch::decode(&mut out.as_slice(), &RollupConfig::default()).unwrap();
+ assert_eq!(batch, decoded);
+ }
+
+ #[test]
+ fn test_span_batch_encode_decode() {
+ let sig = Signature::test_signature();
+ let to = address!("0123456789012345678901234567890123456789");
+ let tx = TxEnvelope::Eip2930(Signed::new_unchecked(
+ TxEip2930 { to: TxKind::Call(to), chain_id: 1, ..Default::default() },
+ sig,
+ Default::default(),
+ ));
+ let mut span_batch_txs = SpanBatchTransactions::default();
+ let mut buf = vec![];
+ tx.encode(&mut buf);
+ let txs = vec![Bytes::from(buf)];
+ let chain_id = 1;
+ span_batch_txs.add_txs(txs, chain_id).unwrap();
+
+ let mut out = Vec::new();
+ let batch = Batch::Span(SpanBatch {
+ block_tx_counts: vec![1],
+ batches: vec![SpanBatchElement::default()],
+ txs: span_batch_txs,
+ ..Default::default()
+ });
+ batch.encode(&mut out).unwrap();
+ let decoded = Batch::decode(&mut out.as_slice(), &RollupConfig::default()).unwrap();
+ assert_eq!(Batch::Span(SpanBatch {
+ batches: vec![SpanBatchElement {
+ transactions: vec![hex!("01f85f808080809401234567890123456789012345678901234567898080c080a0840cfc572845f5786e702984c2a582528cad4b49b2a10b9db1be7fca90058565a025e7109ceb98168d95b09b18bbf6b685130e0562f233877d492b94eee0c5b6d1").into()],
+ ..Default::default()
+ }],
+ txs: SpanBatchTransactions::default(),
+ ..Default::default()
+ }), decoded);
+ }
+
+ #[test]
+ fn test_empty_span_batch() {
+ let mut out = Vec::new();
+ let batch = Batch::Span(SpanBatch::default());
+ // Fails to even encode an empty span batch - decoding will do the same
+ let err = batch.encode(&mut out).unwrap_err();
+ assert_eq!(BatchEncodingError::SpanBatchError(SpanBatchError::EmptySpanBatch), err);
+ }
+}
diff --git a/crates/protocol/protocol/src/batch/element.rs b/crates/protocol/protocol/src/batch/element.rs
new file mode 100644
index 0000000000..c17d4e1e84
--- /dev/null
+++ b/crates/protocol/protocol/src/batch/element.rs
@@ -0,0 +1,56 @@
+//! Span Batch Element
+
+use crate::SingleBatch;
+use alloc::vec::Vec;
+use alloy_primitives::Bytes;
+
+/// MAX_SPAN_BATCH_ELEMENTS is the maximum number of blocks, transactions in total,
+/// or transaction per block allowed in a span batch.
+pub const MAX_SPAN_BATCH_ELEMENTS: u64 = 10_000_000;
+
+/// A single batch element is similar to the [SingleBatch] type
+/// but does not contain the parent hash and epoch hash since spans
+/// do not contain this data for every block in the span.
+#[derive(Debug, Default, Clone, PartialEq, Eq)]
+pub struct SpanBatchElement {
+ /// The epoch number of the L1 block
+ pub epoch_num: u64,
+ /// The timestamp of the L2 block
+ pub timestamp: u64,
+ /// The transactions in the L2 block
+ pub transactions: Vec,
+}
+
+impl From for SpanBatchElement {
+ fn from(batch: SingleBatch) -> Self {
+ Self {
+ epoch_num: batch.epoch_num,
+ timestamp: batch.timestamp,
+ transactions: batch.transactions,
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use proptest::{collection::vec, prelude::any, proptest};
+
+ proptest! {
+ #[test]
+ fn test_span_batch_element_from_single_batch(epoch_num in 0u64..u64::MAX, timestamp in 0u64..u64::MAX, transactions in vec(any::(), 0..100)) {
+ let single_batch = SingleBatch {
+ epoch_num,
+ timestamp,
+ transactions: transactions.clone(),
+ ..Default::default()
+ };
+
+ let span_batch_element: SpanBatchElement = single_batch.into();
+
+ assert_eq!(span_batch_element.epoch_num, epoch_num);
+ assert_eq!(span_batch_element.timestamp, timestamp);
+ assert_eq!(span_batch_element.transactions, transactions);
+ }
+ }
+}
diff --git a/crates/protocol/protocol/src/batch/errors.rs b/crates/protocol/protocol/src/batch/errors.rs
new file mode 100644
index 0000000000..7a1c0e2c33
--- /dev/null
+++ b/crates/protocol/protocol/src/batch/errors.rs
@@ -0,0 +1,85 @@
+//! Span Batch Errors
+
+/// Span Batch Errors
+#[derive(Debug, thiserror::Error, Clone, PartialEq, Eq)]
+pub enum SpanBatchError {
+ /// The span batch is too big
+ #[error("The span batch is too big.")]
+ TooBigSpanBatchSize,
+ /// The bit field is too long
+ #[error("The bit field is too long")]
+ BitfieldTooLong,
+ /// Empty Span Batch
+ #[error("Empty span batch")]
+ EmptySpanBatch,
+ /// Missing L1 origin
+ #[error("Missing L1 origin")]
+ MissingL1Origin,
+ /// Decoding errors
+ #[error("Span batch decoding error: {0}")]
+ Decoding(#[from] SpanDecodingError),
+}
+
+/// An error encoding a batch.
+#[derive(Debug, thiserror::Error, Clone, PartialEq, Eq)]
+pub enum BatchEncodingError {
+ /// Error encoding an Alloy RLP
+ #[error("Error encoding an Alloy RLP: {0}")]
+ AlloyRlpError(alloy_rlp::Error),
+ /// Error encoding a span batch
+ #[error("Error encoding a span batch: {0}")]
+ SpanBatchError(#[from] SpanBatchError),
+}
+
+/// An error decoding a batch.
+#[derive(Debug, thiserror::Error, Clone, PartialEq, Eq)]
+pub enum BatchDecodingError {
+ /// Empty buffer
+ #[error("Empty buffer")]
+ EmptyBuffer,
+ /// Error decoding an Alloy RLP
+ #[error("Error decoding an Alloy RLP: {0}")]
+ AlloyRlpError(alloy_rlp::Error),
+ /// Error decoding a span batch
+ #[error("Error decoding a span batch: {0}")]
+ SpanBatchError(#[from] SpanBatchError),
+}
+
+/// Decoding Error
+#[derive(Debug, thiserror::Error, Clone, PartialEq, Eq)]
+pub enum SpanDecodingError {
+ /// Failed to decode relative timestamp
+ #[error("Failed to decode relative timestamp")]
+ RelativeTimestamp,
+ /// Failed to decode L1 origin number
+ #[error("Failed to decode L1 origin number")]
+ L1OriginNumber,
+ /// Failed to decode parent check
+ #[error("Failed to decode parent check")]
+ ParentCheck,
+ /// Failed to decode L1 origin check
+ #[error("Failed to decode L1 origin check")]
+ L1OriginCheck,
+ /// Failed to decode block count
+ #[error("Failed to decode block count")]
+ BlockCount,
+ /// Failed to decode block tx counts
+ #[error("Failed to decode block tx counts")]
+ BlockTxCounts,
+ /// Failed to decode transaction nonces
+ #[error("Failed to decode transaction nonces")]
+ TxNonces,
+ /// Mismatch in length between the transaction type and signature arrays in a span batch
+ /// transaction payload.
+ #[error("Mismatch in length between the transaction type and signature arrays")]
+ TypeSignatureLenMismatch,
+ /// Invalid transaction type
+ #[error("Invalid transaction type")]
+ InvalidTransactionType,
+ /// Invalid transaction data
+ #[error("Invalid transaction data")]
+ InvalidTransactionData,
+ /// Invalid transaction signature
+ #[error("Invalid transaction signature")]
+ InvalidTransactionSignature,
+}
diff --git a/crates/protocol/protocol/src/batch/inclusion.rs b/crates/protocol/protocol/src/batch/inclusion.rs
new file mode 100644
index 0000000000..54556d6fce
--- /dev/null
+++ b/crates/protocol/protocol/src/batch/inclusion.rs
@@ -0,0 +1,75 @@
+//! Module containing the [BatchWithInclusionBlock] struct.
+
+use crate::{Batch, BatchValidationProvider, BatchValidity, BlockInfo, L2BlockInfo};
+use kona_genesis::RollupConfig;
+
+/// A batch with its inclusion block.
+#[derive(Debug, Clone, PartialEq, Eq)]
+pub struct BatchWithInclusionBlock {
+ /// The inclusion block
+ pub inclusion_block: BlockInfo,
+ /// The batch
+ pub batch: Batch,
+}
+
+impl BatchWithInclusionBlock {
+ /// Creates a new batch with inclusion block.
+ pub const fn new(inclusion_block: BlockInfo, batch: Batch) -> Self {
+ Self { inclusion_block, batch }
+ }
+
+ /// Validates the batch can be applied on top of the specified L2 safe head.
+ /// The first entry of the l1_blocks should match the origin of the l2_safe_head.
+ /// One or more consecutive l1_blocks should be provided.
+ /// In case of only a single L1 block, the decision whether a batch is valid may have to stay
+ /// undecided.
+ pub async fn check_batch(
+ &self,
+ cfg: &RollupConfig,
+ l1_blocks: &[BlockInfo],
+ l2_safe_head: L2BlockInfo,
+ fetcher: &mut BF,
+ ) -> BatchValidity {
+ match &self.batch {
+ Batch::Single(single_batch) => {
+ single_batch.check_batch(cfg, l1_blocks, l2_safe_head, &self.inclusion_block)
+ }
+ Batch::Span(span_batch) => {
+ span_batch
+ .check_batch(cfg, l1_blocks, l2_safe_head, &self.inclusion_block, fetcher)
+ .await
+ }
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use crate::test_utils::TestBatchValidator;
+ use alloc::vec;
+
+ #[tokio::test]
+ async fn test_single_batch_with_inclusion_block() {
+ let batch =
+ BatchWithInclusionBlock::new(BlockInfo::default(), Batch::Single(Default::default()));
+ let l1_blocks = vec![BlockInfo::default()];
+ let l2_safe_head = L2BlockInfo::default();
+ let cfg = RollupConfig::default();
+ let mut validator = TestBatchValidator::default();
+ let result = batch.check_batch(&cfg, &l1_blocks, l2_safe_head, &mut validator).await;
+ assert_eq!(result, BatchValidity::Accept);
+ }
+
+ #[tokio::test]
+ async fn test_span_batch_with_inclusion_block() {
+ let batch =
+ BatchWithInclusionBlock::new(BlockInfo::default(), Batch::Span(Default::default()));
+ let l1_blocks = vec![BlockInfo::default()];
+ let l2_safe_head = L2BlockInfo::default();
+ let cfg = RollupConfig::default();
+ let mut validator = TestBatchValidator::default();
+ let result = batch.check_batch(&cfg, &l1_blocks, l2_safe_head, &mut validator).await;
+ assert_eq!(result, BatchValidity::Undecided);
+ }
+}
diff --git a/crates/protocol/protocol/src/batch/mod.rs b/crates/protocol/protocol/src/batch/mod.rs
new file mode 100644
index 0000000000..ff2090bb72
--- /dev/null
+++ b/crates/protocol/protocol/src/batch/mod.rs
@@ -0,0 +1,55 @@
+//! Contains batch types.
+
+mod r#type;
+pub use r#type::*;
+
+mod reader;
+pub use reader::BatchReader;
+
+mod tx;
+pub use tx::BatchTransaction;
+
+mod core;
+pub use core::Batch;
+
+mod raw;
+pub use raw::RawSpanBatch;
+
+mod payload;
+pub use payload::SpanBatchPayload;
+
+mod prefix;
+pub use prefix::SpanBatchPrefix;
+
+mod inclusion;
+pub use inclusion::BatchWithInclusionBlock;
+
+mod errors;
+pub use errors::{BatchDecodingError, BatchEncodingError, SpanBatchError, SpanDecodingError};
+
+mod bits;
+pub use bits::SpanBatchBits;
+
+mod span;
+pub use span::SpanBatch;
+
+mod transactions;
+pub use transactions::SpanBatchTransactions;
+
+mod element;
+pub use element::{SpanBatchElement, MAX_SPAN_BATCH_ELEMENTS};
+
+mod validity;
+pub use validity::BatchValidity;
+
+mod single;
+pub use single::SingleBatch;
+
+mod tx_data;
+pub use tx_data::{
+ SpanBatchEip1559TransactionData, SpanBatchEip2930TransactionData,
+ SpanBatchEip7702TransactionData, SpanBatchLegacyTransactionData, SpanBatchTransactionData,
+};
+
+mod traits;
+pub use traits::BatchValidationProvider;
diff --git a/crates/protocol/protocol/src/batch/payload.rs b/crates/protocol/protocol/src/batch/payload.rs
new file mode 100644
index 0000000000..d618d9d5f9
--- /dev/null
+++ b/crates/protocol/protocol/src/batch/payload.rs
@@ -0,0 +1,197 @@
+//! Raw Span Batch Payload
+
+use super::MAX_SPAN_BATCH_ELEMENTS;
+use crate::{SpanBatchBits, SpanBatchError, SpanBatchTransactions, SpanDecodingError};
+use alloc::vec::Vec;
+use alloy_primitives::bytes;
+
+/// Span Batch Payload
+#[derive(Debug, Clone, Default, PartialEq, Eq)]
+pub struct SpanBatchPayload {
+ /// Number of L2 block in the span
+ pub block_count: u64,
+ /// Standard span-batch bitlist of blockCount bits. Each bit indicates if the L1 origin is
+ /// changed at the L2 block.
+ pub origin_bits: SpanBatchBits,
+ /// List of transaction counts for each L2 block
+ pub block_tx_counts: Vec,
+ /// Transactions encoded in SpanBatch specs
+ pub txs: SpanBatchTransactions,
+}
+
+impl SpanBatchPayload {
+ /// Decodes a [SpanBatchPayload] from a reader.
+ pub fn decode_payload(r: &mut &[u8]) -> Result {
+ let mut payload = Self::default();
+ payload.decode_block_count(r)?;
+ payload.decode_origin_bits(r)?;
+ payload.decode_block_tx_counts(r)?;
+ payload.decode_txs(r)?;
+ Ok(payload)
+ }
+
+ /// Encodes a [SpanBatchPayload] into a writer.
+ pub fn encode_payload(&self, w: &mut dyn bytes::BufMut) -> Result<(), SpanBatchError> {
+ self.encode_block_count(w);
+ self.encode_origin_bits(w)?;
+ self.encode_block_tx_counts(w);
+ self.encode_txs(w)
+ }
+
+ /// Decodes the origin bits from a reader.
+ pub fn decode_origin_bits(&mut self, r: &mut &[u8]) -> Result<(), SpanBatchError> {
+ if self.block_count > MAX_SPAN_BATCH_ELEMENTS {
+ return Err(SpanBatchError::TooBigSpanBatchSize);
+ }
+
+ self.origin_bits = SpanBatchBits::decode(r, self.block_count as usize)?;
+ Ok(())
+ }
+
+ /// Decode a block count from a reader.
+ pub fn decode_block_count(&mut self, r: &mut &[u8]) -> Result<(), SpanBatchError> {
+ let (block_count, remaining) = unsigned_varint::decode::u64(r)
+ .map_err(|_| SpanBatchError::Decoding(SpanDecodingError::BlockCount))?;
+ // The number of transactions in a single L2 block cannot be greater than
+ // [MAX_SPAN_BATCH_ELEMENTS].
+ if block_count > MAX_SPAN_BATCH_ELEMENTS {
+ return Err(SpanBatchError::TooBigSpanBatchSize);
+ }
+ if block_count == 0 {
+ return Err(SpanBatchError::EmptySpanBatch);
+ }
+ self.block_count = block_count;
+ *r = remaining;
+ Ok(())
+ }
+
+ /// Decode block transaction counts from a reader.
+ pub fn decode_block_tx_counts(&mut self, r: &mut &[u8]) -> Result<(), SpanBatchError> {
+ // Initially allocate the vec with the block count, to reduce re-allocations in the first
+ // few blocks.
+ let mut block_tx_counts = Vec::with_capacity(self.block_count as usize);
+
+ for _ in 0..self.block_count {
+ let (block_tx_count, remaining) = unsigned_varint::decode::u64(r)
+ .map_err(|_| SpanBatchError::Decoding(SpanDecodingError::BlockTxCounts))?;
+
+ // The number of transactions in a single L2 block cannot be greater than
+ // [MAX_SPAN_BATCH_ELEMENTS].
+ if block_tx_count > MAX_SPAN_BATCH_ELEMENTS {
+ return Err(SpanBatchError::TooBigSpanBatchSize);
+ }
+ block_tx_counts.push(block_tx_count);
+ *r = remaining;
+ }
+ self.block_tx_counts = block_tx_counts;
+ Ok(())
+ }
+
+ /// Decode transactions from a reader.
+ pub fn decode_txs(&mut self, r: &mut &[u8]) -> Result<(), SpanBatchError> {
+ if self.block_tx_counts.is_empty() {
+ return Err(SpanBatchError::EmptySpanBatch);
+ }
+
+ let total_block_tx_count =
+ self.block_tx_counts.iter().try_fold(0u64, |acc, block_tx_count| {
+ acc.checked_add(*block_tx_count).ok_or(SpanBatchError::TooBigSpanBatchSize)
+ })?;
+
+ // The total number of transactions in a span batch cannot be greater than
+ // [MAX_SPAN_BATCH_ELEMENTS].
+ if total_block_tx_count > MAX_SPAN_BATCH_ELEMENTS {
+ return Err(SpanBatchError::TooBigSpanBatchSize);
+ }
+ self.txs.total_block_tx_count = total_block_tx_count;
+ self.txs.decode(r)?;
+ Ok(())
+ }
+
+ /// Encode the origin bits into a writer.
+ pub fn encode_origin_bits(&self, w: &mut dyn bytes::BufMut) -> Result<(), SpanBatchError> {
+ SpanBatchBits::encode(w, self.block_count as usize, &self.origin_bits)
+ }
+
+ /// Encode the block count into a writer.
+ pub fn encode_block_count(&self, w: &mut dyn bytes::BufMut) {
+ let mut u64_varint_buf = [0u8; 10];
+ w.put_slice(unsigned_varint::encode::u64(self.block_count, &mut u64_varint_buf));
+ }
+
+ /// Encode the block transaction counts into a writer.
+ pub fn encode_block_tx_counts(&self, w: &mut dyn bytes::BufMut) {
+ let mut u64_varint_buf = [0u8; 10];
+ for block_tx_count in &self.block_tx_counts {
+ u64_varint_buf.fill(0);
+ w.put_slice(unsigned_varint::encode::u64(*block_tx_count, &mut u64_varint_buf));
+ }
+ }
+
+ /// Encode the transactions into a writer.
+ pub fn encode_txs(&self, w: &mut dyn bytes::BufMut) -> Result<(), SpanBatchError> {
+ self.txs.encode(w)
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use alloc::vec;
+
+ #[test]
+ fn test_decode_origin_bits() {
+ let block_count = 10;
+ let encoded = vec![2; block_count / 8 + 1];
+ let mut payload =
+ SpanBatchPayload { block_count: block_count as u64, ..Default::default() };
+ payload.decode_origin_bits(&mut encoded.as_slice()).unwrap();
+ assert_eq!(payload.origin_bits, SpanBatchBits::new(vec![2; block_count / 8 + 1]));
+ }
+
+ #[test]
+ fn test_zero_block_count() {
+ let mut u64_varint_buf = [0; 10];
+ let mut encoded = unsigned_varint::encode::u64(0, &mut u64_varint_buf);
+ let mut payload = SpanBatchPayload::default();
+ let err = payload.decode_block_count(&mut encoded).unwrap_err();
+ assert_eq!(err, SpanBatchError::EmptySpanBatch);
+ }
+
+ #[test]
+ fn test_decode_block_count() {
+ let block_count = MAX_SPAN_BATCH_ELEMENTS;
+ let mut u64_varint_buf = [0; 10];
+ let mut encoded = unsigned_varint::encode::u64(block_count, &mut u64_varint_buf);
+ let mut payload = SpanBatchPayload::default();
+ payload.decode_block_count(&mut encoded).unwrap();
+ assert_eq!(payload.block_count, block_count);
+ }
+
+ #[test]
+ fn test_decode_block_count_errors() {
+ let block_count = MAX_SPAN_BATCH_ELEMENTS + 1;
+ let mut u64_varint_buf = [0; 10];
+ let mut encoded = unsigned_varint::encode::u64(block_count, &mut u64_varint_buf);
+ let mut payload = SpanBatchPayload::default();
+ let err = payload.decode_block_count(&mut encoded).unwrap_err();
+ assert_eq!(err, SpanBatchError::TooBigSpanBatchSize);
+ }
+
+ #[test]
+ fn test_decode_block_tx_counts() {
+ let block_count = 2;
+ let mut u64_varint_buf = [0; 10];
+ let mut encoded = unsigned_varint::encode::u64(block_count, &mut u64_varint_buf);
+ let mut payload = SpanBatchPayload::default();
+ payload.decode_block_count(&mut encoded).unwrap();
+ let mut r: Vec = Vec::new();
+ for _ in 0..2 {
+ let mut buf = [0u8; 10];
+ let encoded = unsigned_varint::encode::u64(2, &mut buf);
+ r.append(&mut encoded.to_vec());
+ }
+ payload.decode_block_tx_counts(&mut r.as_slice()).unwrap();
+ assert_eq!(payload.block_tx_counts, vec![2, 2]);
+ }
+}
diff --git a/crates/protocol/protocol/src/batch/prefix.rs b/crates/protocol/protocol/src/batch/prefix.rs
new file mode 100644
index 0000000000..7eb2da9688
--- /dev/null
+++ b/crates/protocol/protocol/src/batch/prefix.rs
@@ -0,0 +1,96 @@
+//! Raw Span Batch Prefix
+
+use crate::{SpanBatchError, SpanDecodingError};
+use alloy_primitives::{bytes, FixedBytes};
+
+/// Span Batch Prefix
+#[derive(Debug, Clone, Default, PartialEq, Eq)]
+pub struct SpanBatchPrefix {
+ /// Relative timestamp of the first block
+ pub rel_timestamp: u64,
+ /// L1 origin number
+ pub l1_origin_num: u64,
+ /// First 20 bytes of the first block's parent hash
+ pub parent_check: FixedBytes<20>,
+ /// First 20 bytes of the last block's L1 origin hash
+ pub l1_origin_check: FixedBytes<20>,
+}
+
+impl SpanBatchPrefix {
+ /// Decodes a [SpanBatchPrefix] from a reader.
+ pub fn decode_prefix(r: &mut &[u8]) -> Result {
+ let mut prefix = Self::default();
+ prefix.decode_rel_timestamp(r)?;
+ prefix.decode_l1_origin_num(r)?;
+ prefix.decode_parent_check(r)?;
+ prefix.decode_l1_origin_check(r)?;
+ Ok(prefix)
+ }
+
+ /// Decodes the relative timestamp from a reader.
+ pub fn decode_rel_timestamp(&mut self, r: &mut &[u8]) -> Result<(), SpanBatchError> {
+ let (rel_timestamp, remaining) = unsigned_varint::decode::u64(r)
+ .map_err(|_| SpanBatchError::Decoding(SpanDecodingError::RelativeTimestamp))?;
+ *r = remaining;
+ self.rel_timestamp = rel_timestamp;
+ Ok(())
+ }
+
+ /// Decodes the L1 origin number from a reader.
+ pub fn decode_l1_origin_num(&mut self, r: &mut &[u8]) -> Result<(), SpanBatchError> {
+ let (l1_origin_num, remaining) = unsigned_varint::decode::u64(r)
+ .map_err(|_| SpanBatchError::Decoding(SpanDecodingError::L1OriginNumber))?;
+ *r = remaining;
+ self.l1_origin_num = l1_origin_num;
+ Ok(())
+ }
+
+ /// Decodes the parent check from a reader.
+ pub fn decode_parent_check(&mut self, r: &mut &[u8]) -> Result<(), SpanBatchError> {
+ let (parent_check, remaining) = r.split_at(20);
+ let parent_check = FixedBytes::<20>::from_slice(parent_check);
+ *r = remaining;
+ self.parent_check = parent_check;
+ Ok(())
+ }
+
+ /// Decodes the L1 origin check from a reader.
+ pub fn decode_l1_origin_check(&mut self, r: &mut &[u8]) -> Result<(), SpanBatchError> {
+ let (l1_origin_check, remaining) = r.split_at(20);
+ let l1_origin_check = FixedBytes::<20>::from_slice(l1_origin_check);
+ *r = remaining;
+ self.l1_origin_check = l1_origin_check;
+ Ok(())
+ }
+
+ /// Encodes the [SpanBatchPrefix] into a writer.
+ pub fn encode_prefix(&self, w: &mut dyn bytes::BufMut) {
+ let mut u64_buf = [0u8; 10];
+ w.put_slice(unsigned_varint::encode::u64(self.rel_timestamp, &mut u64_buf));
+ w.put_slice(unsigned_varint::encode::u64(self.l1_origin_num, &mut u64_buf));
+ w.put_slice(self.parent_check.as_slice());
+ w.put_slice(self.l1_origin_check.as_slice());
+ }
+}
+
+#[cfg(test)]
+mod test {
+ use super::*;
+ use alloc::vec::Vec;
+ use alloy_primitives::address;
+
+ #[test]
+ fn test_span_batch_prefix_encoding_roundtrip() {
+ let expected = SpanBatchPrefix {
+ rel_timestamp: 0xFF,
+ l1_origin_num: 0xEE,
+ parent_check: address!("beef00000000000000000000000000000000beef").into(),
+ l1_origin_check: address!("babe00000000000000000000000000000000babe").into(),
+ };
+
+ let mut buf = Vec::new();
+ expected.encode_prefix(&mut buf);
+
+ assert_eq!(SpanBatchPrefix::decode_prefix(&mut buf.as_slice()).unwrap(), expected);
+ }
+}
diff --git a/crates/protocol/protocol/src/batch/raw.rs b/crates/protocol/protocol/src/batch/raw.rs
new file mode 100644
index 0000000000..4c57fe9224
--- /dev/null
+++ b/crates/protocol/protocol/src/batch/raw.rs
@@ -0,0 +1,143 @@
+//! Module containing the [RawSpanBatch] struct.
+
+use alloc::{vec, vec::Vec};
+use alloy_primitives::bytes;
+
+use crate::{
+ BatchType, SpanBatch, SpanBatchElement, SpanBatchError, SpanBatchPayload, SpanBatchPrefix,
+ SpanDecodingError,
+};
+
+/// Raw Span Batch
+#[derive(Debug, Clone, PartialEq, Eq)]
+pub struct RawSpanBatch {
+ /// The span batch prefix
+ pub prefix: SpanBatchPrefix,
+ /// The span batch payload
+ pub payload: SpanBatchPayload,
+}
+
+impl RawSpanBatch {
+ /// Returns the batch type
+ pub const fn get_batch_type(&self) -> BatchType {
+ BatchType::Span
+ }
+
+ /// Encodes the [RawSpanBatch] into a writer.
+ pub fn encode(&self, w: &mut dyn bytes::BufMut) -> Result<(), SpanBatchError> {
+ self.prefix.encode_prefix(w);
+ self.payload.encode_payload(w)
+ }
+
+ /// Decodes the [RawSpanBatch] from a reader.]
+ pub fn decode(r: &mut &[u8]) -> Result {
+ let prefix = SpanBatchPrefix::decode_prefix(r)?;
+ let payload = SpanBatchPayload::decode_payload(r)?;
+ Ok(Self { prefix, payload })
+ }
+
+ /// Converts a [RawSpanBatch] into a [SpanBatch], which has a list of [SpanBatchElement]s. Thos
+ /// function does not populate the [SpanBatch] with chain configuration data, which is
+ /// required for making payload attributes.
+ pub fn derive(
+ &mut self,
+ block_time: u64,
+ genesis_time: u64,
+ chain_id: u64,
+ ) -> Result {
+ if self.payload.block_count == 0 {
+ return Err(SpanBatchError::EmptySpanBatch);
+ }
+
+ let mut block_origin_nums = vec![0u64; self.payload.block_count as usize];
+ let mut l1_origin_number = self.prefix.l1_origin_num;
+ for i in (0..self.payload.block_count).rev() {
+ block_origin_nums[i as usize] = l1_origin_number;
+ if self
+ .payload
+ .origin_bits
+ .get_bit(i as usize)
+ .ok_or(SpanBatchError::Decoding(SpanDecodingError::L1OriginCheck))? ==
+ 1 &&
+ i > 0
+ {
+ l1_origin_number -= 1;
+ }
+ }
+
+ // Get all transactions in the batch.
+ let enveloped_txs = self.payload.txs.full_txs(chain_id)?;
+
+ let mut tx_idx = 0;
+ let batches = (0..self.payload.block_count).fold(Vec::new(), |mut acc, i| {
+ let transactions =
+ (0..self.payload.block_tx_counts[i as usize]).fold(Vec::new(), |mut acc, _| {
+ acc.push(enveloped_txs[tx_idx].clone());
+ tx_idx += 1;
+ acc
+ });
+ acc.push(SpanBatchElement {
+ epoch_num: block_origin_nums[i as usize],
+ timestamp: genesis_time + self.prefix.rel_timestamp + block_time * i,
+ transactions: transactions.into_iter().map(|v| v.into()).collect(),
+ });
+ acc
+ });
+
+ Ok(SpanBatch {
+ parent_check: self.prefix.parent_check,
+ l1_origin_check: self.prefix.l1_origin_check,
+ batches,
+ ..Default::default()
+ })
+ }
+}
+
+#[cfg(test)]
+mod test {
+ use super::*;
+ use alloy_primitives::FixedBytes;
+
+ #[test]
+ fn test_try_from_span_batch_empty_batches_errors() {
+ let span_batch = SpanBatch::default();
+ let raw_span_batch = span_batch.to_raw_span_batch().unwrap_err();
+ assert_eq!(raw_span_batch, SpanBatchError::EmptySpanBatch);
+ }
+
+ #[test]
+ fn test_try_from_span_batch_succeeds() {
+ let parent_check = FixedBytes::from([2u8; 20]);
+ let l1_origin_check = FixedBytes::from([3u8; 20]);
+ let first = SpanBatchElement { epoch_num: 100, timestamp: 400, transactions: Vec::new() };
+ let last = SpanBatchElement { epoch_num: 200, timestamp: 500, transactions: Vec::new() };
+ let span_batch = SpanBatch {
+ batches: vec![first, last],
+ genesis_timestamp: 300,
+ parent_check,
+ l1_origin_check,
+ ..Default::default()
+ };
+ let expected_prefix = SpanBatchPrefix {
+ rel_timestamp: 100,
+ l1_origin_num: 200,
+ parent_check,
+ l1_origin_check,
+ };
+ let expected_payload = SpanBatchPayload { block_count: 2, ..Default::default() };
+ let raw_span_batch = span_batch.to_raw_span_batch().unwrap();
+ assert_eq!(raw_span_batch.prefix, expected_prefix);
+ assert_eq!(raw_span_batch.payload, expected_payload);
+ }
+
+ #[test]
+ fn test_decode_encode_raw_span_batch() {
+ // Load in the raw span batch from the `op-node` derivation pipeline implementation.
+ let raw_span_batch_hex = include_bytes!("./testdata/raw_batch.hex");
+ let raw_span_batch = RawSpanBatch::decode(&mut raw_span_batch_hex.as_slice()).unwrap();
+
+ let mut encoding_buf = Vec::new();
+ raw_span_batch.encode(&mut encoding_buf).unwrap();
+ assert_eq!(encoding_buf, raw_span_batch_hex);
+ }
+}
diff --git a/crates/protocol/protocol/src/batch/reader.rs b/crates/protocol/protocol/src/batch/reader.rs
new file mode 100644
index 0000000000..96c75c7b18
--- /dev/null
+++ b/crates/protocol/protocol/src/batch/reader.rs
@@ -0,0 +1,126 @@
+//! Contains the [BatchReader] which is used to iteratively consume batches from raw data.
+
+use crate::{decompress_brotli, Batch};
+use alloc::vec::Vec;
+use alloy_primitives::Bytes;
+use alloy_rlp::Decodable;
+use kona_genesis::RollupConfig;
+use miniz_oxide::inflate::decompress_to_vec_zlib;
+/// ZLIB Deflate Compression Method.
+const ZLIB_DEFLATE_COMPRESSION_METHOD: u8 = 8;
+
+/// ZLIB Reserved Compression Info.
+const ZLIB_RESERVED_COMPRESSION_METHOD: u8 = 15;
+
+/// Brotili Compression Channel Version.
+const CHANNEL_VERSION_BROTLI: u8 = 1;
+
+/// Batch Reader provides a function that iteratively consumes batches from the reader.
+/// The L1Inclusion block is also provided at creation time.
+/// Warning: the batch reader can read every batch-type.
+/// The caller of the batch-reader should filter the results.
+#[derive(Debug)]
+pub struct BatchReader {
+ /// The raw data to decode.
+ data: Option
- 
- 
- 
+ 
+ 
+ 
+ 
+ 
+ 
-> 📖 `kona` is in active development, and is not yet ready for use in production. During development, this book will evolve quickly and may contain inaccuracies.
+> [!WARNING]
>
-> Please [open an issue][new-issue] if you find any errors or have any suggestions for improvements, and also feel free to [contribute][contributing] to the project!
+> `kona` is in active development, and is not yet ready for use in production.
+> During development, this book will evolve quickly and may contain inaccuracies.
+>
+> Please [open an issue][new-issue] if you find any errors or have any suggestions
+> for improvements, and also feel free to [contribute][contributing] to the project!
+
## Introduction
-Kona is a suite of libraries and build pipelines for developing verifiable Rust programs targeting
+Kona is _the_ monorepo for the Rust Optimism OP Stack.
+
+Kona provides a suite of libraries and build pipelines for developing verifiable Rust programs targeting
{{#template ../templates/glossary-link.md root=./ ref=fault-proof-vm text=Fault Proof VMs}}.
-It is built and maintained by members of [OP Labs][op-labs] as well as open source contributors, and is licensed under the MIT License.
+It is built and maintained by members of [OP Labs][op-labs] as well as open source contributors,
+and is licensed under the MIT License.
Kona provides tooling and abstractions around low-level syscalls, memory management, and other common structures that authors of verifiable programs
will need to interact with. It also provides build pipelines for compiling `no_std` Rust programs to a format that can be executed by supported
diff --git a/book/src/sdk/README.md b/book/src/sdk/README.md
new file mode 100644
index 0000000000..bdabc58936
--- /dev/null
+++ b/book/src/sdk/README.md
@@ -0,0 +1,3 @@
+# Building
+
+
diff --git a/book/src/sdk/genesis/README.md b/book/src/sdk/genesis/README.md
new file mode 100644
index 0000000000..e8e4846d2a
--- /dev/null
+++ b/book/src/sdk/genesis/README.md
@@ -0,0 +1,14 @@
+# Genesis
+
+
+
+The genesis crate contains types related to chain genesis.
+
+This section contains in-depth sections on building with [`maili-genesis`][genesis] crate types.
+
+- [The Rollup Config](./rollup-config.md)
+- [The System Config](./system-config.md)
+
+
+
+{{#include ../../links.md}}
diff --git a/book/src/sdk/genesis/rollup-config.md b/book/src/sdk/genesis/rollup-config.md
new file mode 100644
index 0000000000..8e554f00b9
--- /dev/null
+++ b/book/src/sdk/genesis/rollup-config.md
@@ -0,0 +1,21 @@
+# Rollup Configs
+
+Rollup configurations are a consensus construct used to configure an Optimism Consensus client.
+When an OP Stack chain is deployed into production or consensus nodes are configured to sync the chain,
+certain consensus parameters can be configured. These parameters are defined in the
+[OP Stack specs][spec-configurability].
+
+Consensus parameters are consumed by OP Stack software through the `RollupConfig` type defined in the
+[`maili-genesis`][genesis] crate.
+
+## `RollupConfig` Type
+
+The [`RollupConfig`][rc] type is defined in [`maili-genesis`][genesis].
+
+Rollup configs can be loaded for a given chain id using [`maili-registry`][registry].
+The `ROLLUP_CONFIG` mapping in the `maili-registry` provides a mapping from chain ids
+to rollup config.
+
+
+
+{{#include ../../links.md}}
diff --git a/book/src/sdk/genesis/system-config.md b/book/src/sdk/genesis/system-config.md
new file mode 100644
index 0000000000..b3022475c9
--- /dev/null
+++ b/book/src/sdk/genesis/system-config.md
@@ -0,0 +1,30 @@
+# System Config
+
+The system configuration is a set of configurable chain parameters
+defined in a contract on L1. These parameters can be changed through
+the system config contract, emitting events that are picked up by
+the [rollup node derivation process][derivation]. To dive deeper
+into the System Config, visit the
+[OP Stack Specifications][system-config-specs].
+
+## `SystemConfig` Type
+
+The [`SystemConfig`][system-config] type is defined in
+[`maili-genesis`][genesis].
+
+Parameters defined in the [`SystemConfig`][system-config] are expected to be
+updated through L1 receipts, using the [`update_with_receipts`][update] method.
+
+## Holocene Updates
+
+The [Holocene Hardfork][holocene] introduced an update to the
+[`SystemConfig`][system-config] type, adding EIP-1559 parameters to the config.
+
+The [`SystemConfig`][system-config] type in [`maili-genesis`][genesis] provides
+a method called [`eip_1559_params`][eip] that returns the EIP-1559 parameters
+encoded as a [`B64`][b64].
+
+
+
+
+{{#include ../../links.md}}
diff --git a/book/src/sdk/intro.md b/book/src/sdk/intro.md
index 24df6f58d4..3369151e29 100644
--- a/book/src/sdk/intro.md
+++ b/book/src/sdk/intro.md
@@ -1,22 +1,22 @@
# Kona SDK
Welcome to the Kona SDK, a powerful set of libraries designed to revolutionize the way developers build proofs for the
-OP Stack STF on top of the OP Stack's FPVMs and other verifiable backends like [SP-1][sp-1], [Risc0][rzero],
+OP Stack STF on top of the OP Stack's FPVMs and other verifiable backends like [SP-1][sp-1], [Risc0][rzero],
[Intel TDX][tdx], and [AMD SEV-SNP][sev-snp]. At its core, Kona is built on the principles of modularity, extensibility,
and developer empowerment.
## A Foundation of Flexibility
The kona repository is more than a fault proof program for the OP Stack — it's an ecosystem of interoperable components,
-each crafted with reusability and extensibility as primary goals. While we provide
+each crafted with reusability and extensibility as primary goals. While we provide
{{#template ../../templates/glossary-link.md root=./ ref=fault-proof-vm text=Fault Proof VM}} and "online" backends
for key components like `kona-derive` and `kona-executor`, the true power of `kona` lies in its adaptability.
## Extend Without Forking
One of Kona's standout features is its ability to support custom features and data sources without requiring you to fork
-the entire project. Through careful use of Rust's powerful trait system and abstract interfaces, we've created a
-framework that allows you to plug in your own features and ideas seamlessly.
+the entire project. Through careful use of Rust's powerful trait system and abstract interfaces, we've created a
+framework that allows you to plug in your own features and ideas seamlessly.
## What You'll Learn
@@ -29,7 +29,7 @@ Whether you're looking to use Kona as-is, extend its functionality, or create en
this guide is intended to provide you with the knowledge and tools you need to succeed.
[sp-1]: https://github.com/succinct-labs/sp-1
-[rzero]: https://github.com/risc0/risc0
+[rzero]: https://github.com/risc0/risc0
[tdx]: https://www.intel.com/content/www/us/en/developer/tools/trust-domain-extensions/documentation.html
[sev-snp]: https://www.amd.com/en/developer/sev.html
diff --git a/book/src/sdk/pipeline/intro.md b/book/src/sdk/pipeline/intro.md
index 0c8f1e44ac..ea5d9dff8e 100644
--- a/book/src/sdk/pipeline/intro.md
+++ b/book/src/sdk/pipeline/intro.md
@@ -93,8 +93,8 @@ the [`PipelineBuilder`][builder] to instantiate a [`DerivationPipeline`][dp].
```rust,ignore
// Imports
use std::sync::Arc;
-use maili_protocol::BlockInfo;
-use maili_genesis::RollupConfig;
+use kona_protocol::BlockInfo;
+use kona_genesis::RollupConfig;
use kona_providers_alloy::*;
// Use a default rollup config.
diff --git a/book/src/sdk/pipeline/providers.md b/book/src/sdk/pipeline/providers.md
index ded948414b..e69700696e 100644
--- a/book/src/sdk/pipeline/providers.md
+++ b/book/src/sdk/pipeline/providers.md
@@ -23,7 +23,7 @@ required trait implementations are the providers stubbed with `todo!()`.
```rust
use std::sync::Arc;
-use maili_genesis::RollupConfig;
+use kona_genesis::RollupConfig;
use kona_derive::pipeline::PipelineBuilder;
use kona_derive::attributes::StatefulAttributesBuilder;
@@ -67,7 +67,7 @@ let pipeline = PipelineBuilder::new()
```rust
use async_trait::async_trait;
use alloy_primitives::Bytes;
-use maili_protocol::BlockInfo;
+use kona_protocol::BlockInfo;
use kona_derive::traits::DataAvailabilityProvider;
use kona_derive::errors::PipelineResult;
diff --git a/book/src/sdk/protocol/README.md b/book/src/sdk/protocol/README.md
new file mode 100644
index 0000000000..23e0a6d96d
--- /dev/null
+++ b/book/src/sdk/protocol/README.md
@@ -0,0 +1,66 @@
+# Protocol
+
+
+
+The [`maili-protocol`][protocol] crate contains types, constants, and methods
+specific to Optimism derivation and batch-submission.
+
+[`maili-protocol`][protocol] supports `no_std`.
+
+## Background
+
+Protocol types are primarily used for L2 chain derivation. This section will
+break down L2 chain derivation as it relates to types defined in
+`maili-protocol` - that is, from the raw L2 chain data posted to L1, to the
+[`Batch`][batch] type. And since the [`Batch`][batch] type naively breaks up
+into the payload attributes, once executed, it becomes the canonical L2 block!
+Note though, this provides an incredibly simplified introduction. It is advised
+to reference [the specs][s] for the most up-to-date information regarding
+derivation.
+
+The L2 chain is derived from data posted to the L1 chain - either as calldata
+or blob data. Data is iteratively pulled from each L1 block and translated
+into the first type defined by `maili-protocol`: the [`Frame`][frame] type.
+
+[`Frame`][frame]s are [parsed][parsed] from the raw data. Each [`Frame`][frame]
+is a part of a [`Channel`][channel], the next type one level up in deriving
+L2 blocks. [`Channel`][channel]s have IDs that frames reference. [`Frame`][frame]s
+are [added][added] iteratively to the [`Channel`][channel]. Once a
+[`Channel`][channel] [is ready][ready], it can be used to read a [`Batch`][batch].
+
+Since a [`Channel`][channel] stitches together frames, it contains the raw frame
+data. In order to turn this [`Channel`][channel] data into a [`Batch`][batch],
+it needs to be decompressed using the respective (de)compression algorithm
+(see [the channel specs][channel-specs] for more detail on this). Once
+decompressed, the raw data can be [decoded][decoded] into the [`Batch`][batch]
+type.
+
+
+## Sections
+
+#### Core Derviation Types (discussed above)
+
+- [Frames](./frames.md)
+- [Channels](./channels.md)
+- [Batches](./batches.md)
+
+#### Other Critical Protocol Types
+
+- [BlockInfo and L2BlockInfo Types](./block-info.md)
+- [L1BlockInfo Types](./l1-block-info.md)
+
+
+
+
+[decoded]: https://docs.rs/maili-protocol/latest/maili_protocol/enum.Batch.html#method.decode
+[batch]: https://docs.rs/maili-protocol/latest/maili_protocol/enum.Batch.html
+[ready]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Channel.html#method.is_ready
+[added]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Channel.html#method.add_frame
+[channel]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Channel.html
+[frame]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Frame.html
+[parsed]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Frame.html#method.parse_frames
+
+[protocol]: https://crates.io/crates/maili-protocol
+[s]: https://specs.optimism.io/protocol/derivation.html#overview
+[lcd]: https://specs.optimism.io/protocol/derivation.html#overview
+[channel-specs]: https://specs.optimism.io/protocol/derivation.html#channel-format
diff --git a/book/src/sdk/protocol/batches.md b/book/src/sdk/protocol/batches.md
new file mode 100644
index 0000000000..c31173ce7d
--- /dev/null
+++ b/book/src/sdk/protocol/batches.md
@@ -0,0 +1,109 @@
+# Batches
+
+A [Batch][batch] contains a list of transactions to be included in a specific
+L2 block. Since the [Delta hardfork][delta], there are two Batch types or
+variants: [`SingleBatch`][single-batch] and [`SpanBatch`][span-batch].
+
+## Where Batches fit in the OP Stack
+
+The [Batch][batch] is the highest-level data type in the OP Stack
+derivation process that comes prior to building payload attributes.
+A [Batch][batch] is constructed by taking the raw data from a
+[Channel][channel], decompressing it, and decoding the [Batch][batch]
+from this decompressed data.
+
+Alternatively, when looking at the [Batch][batch] type from a batching
+perspective, and not from the derivation perspective, the [Batch][batch]
+type contains a list of L2 transactions and is compressed into the
+[`Channel`][channel] type. In turn, the [`Channel`][channel] is split
+into frames which are posted to the data availability layer through batcher
+transactions.
+
+## Contents of a `Batch`
+
+A [`Batch`][batch] is either a [`SingleBatch`][single-batch] or a
+[`SpanBatch`][span-batch], each with their own contents. Below,
+these types are broken down in their respective sections.
+
+### `SingleBatch` Type
+
+The [`SingleBatch`][single-batch] type contains the following.
+
+- A [`BlockHash`][block-hash] parent hash that represents the parent L2 block.
+- A `u64` epoch number that identifies the [epoch][epoch] for this batch.
+- A [`BlockHash`][block-hash] epoch hash.
+- The timestamp for the batch as a `u64`.
+- A list of EIP-2718 encoded transactions (represented as [`Bytes`][bytes]).
+
+In order to validate the [`SingleBatch`][single-batch] once decoded,
+the [`SingleBatch::check_batch`][check-batch-single] method should be used,
+providing the rollup config, l1 blocks, l2 safe head, and inclusion block.
+
+### `SpanBatch` Type
+
+The [`SpanBatch`][span-batch] type (available since the [Delta hardfork][delta])
+comprises the data needed to build a "span" of multiple L2 blocks. It contains
+the following data.
+
+- The parent check (the first 20 bytes of the block's parent hash).
+- The l1 origin check (the first 20 bytes of the last block's l1 origin hash).
+- The genesis timestamp.
+- The chain id.
+- A list of [`SpanBatchElement`][span-batch-element]s. These are similar to
+ the [`SingleBatch`][single-batch] type but don't contain the parent hash
+ and epoch hash for this L2 block.
+- Origin bits.
+- Block transaction counts.
+- Span batch transactions which contain information for transactions in a span batch.
+
+Similar to the `SingleBatch` type discussed above, the [`SpanBatch`][span-batch] type
+must be validated once decoded. For this, the [`SpanBatch::check_batch`][check-batch-span]
+method is available.
+
+After the [Holocene hardfork][holocene] was introduced, span batch validation is greatly
+simplified to be forwards-invalidating instead of backwards-invalidating, so a new
+[`SpanBatch::check_batch_prefix`][check-batch-prefix] method provides a way to validate
+each batch as it is loaded, in an iterative fashion.
+
+## Batch Encoding
+
+The first byte of the decompressed channel data is the
+[`BatchType`][batch-type], which identifies whether the batch is a
+[`SingleBatch`][single-batch] or a [`SpanBatch`][span-batch].
+From there, the respective type is decoded, and [derived][derived]
+in the case of the [`SpanBatch`][span-batch].
+
+The `Batch` encoding format for the [`SingleBatch`][single-batch] is
+broken down [in the specs][specs].
+
+## The `Batch` Type
+
+The [`Batch`][batch] type itself only provides two useful methods.
+
+- [`timestamp`][timestamp] returns the timestamp of the [`Batch`][batch]
+- [`decode`][decode], constructs a new [`Batch`][batch] from the provided
+ raw, decompressed batch data and rollup config.
+
+Within each [`Batch`][batch] variant, the individual types contain
+more functionality.
+
+
+
+[holocene]: https://specs.optimism.io/protocol/holocene/overview.html
+[check-batch-prefix]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.SpanBatch.html#method.check_batch_prefix
+[check-batch-span]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.SpanBatch.html#method.check_batch
+[span-batch-element]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.SpanBatchElement.html
+[check-batch-single]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.SingleBatch.html#method.check_batch
+[bytes]: https://docs.rs/alloy-primitives/latest/alloy_primitives/struct.Bytes.html
+[block-hash]: https://docs.rs/alloy-primitives/latest/alloy_primitives/aliases/type.BlockHash.html
+[epoch]: https://specs.optimism.io/glossary.html?highlight=Epoch#sequencing-epoch
+[decode]: https://docs.rs/maili-protocol/latest/maili_protocol/enum.Batch.html#method.decode
+[timestamp]: https://docs.rs/maili-protocol/latest/maili_protocol/enum.Batch.html#method.timestamp
+[specs]: https://specs.optimism.io/protocol/derivation.html#batch-format
+[derived]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.RawSpanBatch.html#method.derive
+[batch-type]: https://docs.rs/maili-protocol/latest/maili_protocol/enum.BatchType.html
+[channel]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Channel.html
+[batch]: https://docs.rs/maili-protocol/latest/maili_protocol/enum.Batch.html
+[span-batch]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.SpanBatch.html
+[single-batch]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.SingleBatch.html
+[delta]: https://specs.optimism.io/protocol/delta/overview.html
diff --git a/book/src/sdk/protocol/block-info.md b/book/src/sdk/protocol/block-info.md
new file mode 100644
index 0000000000..aa0d6ef6fe
--- /dev/null
+++ b/book/src/sdk/protocol/block-info.md
@@ -0,0 +1,27 @@
+# BlockInfo and L2BlockInfo Types
+
+Optimism defines block info types that encapsulate minimal block header
+information needed by protocol operations.
+
+
+## BlockInfo
+
+The [`BlockInfo`][bi] type is straightforward, containing the block hash,
+number, parent hash, and timestamp.
+
+
+## L2BlockInfo
+
+The [`L2BlockInfo`][lbi] extends the [`BlockInfo`][bi] type for the canonical
+L2 chain. It contains the "L1 origin" which is a set of block info for the L1
+block that this L2 block "originated".
+
+[`L2BlockInfo`][lbi] provides a [`from_block_and_gensis`][fbg] method to
+construct the [`L2BlockInfo`][lbi] from a block and `ChainGenesis`.
+
+
+
+
+[bi]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.BlockInfo.html
+[lbi]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.L2BlockInfo.html
+[fbg]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.L2BlockInfo.html#method.from_block_and_genesis
diff --git a/book/src/sdk/protocol/channels.md b/book/src/sdk/protocol/channels.md
new file mode 100644
index 0000000000..75ba19ce75
--- /dev/null
+++ b/book/src/sdk/protocol/channels.md
@@ -0,0 +1,109 @@
+# Channels
+
+Taken from the [OP Stack specs][specs], [`Channel`][channel]s are a set of
+sequencer batches (for any L2 blocks) compressed together.
+
+
+## Where Channels fit in the OP Stack
+
+L2 transactions are grouped into what are called [sequencer batches][seq-batch].
+In order to obtain a better compression ratio when posting these L2 transactions
+to the data availability layer, [sequencer batches][seq-batch] are compressed
+together into what is called a [Channel][channel]. This ultimately reduces
+data availability costs. As previously noted in the [Frame][frame-docs] section,
+[Channel][channel]s may not "fit" in a single batcher transaction, posting the
+data to the data availability layer. In order to accommodate large
+[Channel][channel]s, a tertiary [Frame][frame] data type breaks the
+[Channel][channel] up into multiple [Frame][frame]s where a batcher transaction
+then consists of one or multiple [Frame][frame]s.
+
+
+## Contents of a Channel
+
+A [Channel][channel] is comprised of the following items.
+- A [`ChannelId`][cid] which is a 16 byte long identifier for the channel.
+ Notice, [Frame][frame]s also contain a [`ChannelId`][cid], which is the
+ identical to this identifier, since frames "belong" to a given channel.
+- A [`BlockInfo`][block-info] that marks the L1 block at which the channel
+ is "opened" at.
+- The estimated size of the channel (as a `usize`) used to drop the channel
+ if there is a data overflow.
+- A `boolean` if the channel is "closed". This indicates if the last frame
+ has been buffered, and added to the channel.
+- A `u16` indicating the highest frame number within the channel.
+- The frame number of the last frame (where `is_last` set to `true`).
+- A mapping from Frame number to the [`Frame`][frame] itself.
+- A [`BlockInfo`][block-info] for highest L1 inclusion block that a frame
+ was included in.
+
+
+## Channel Encoding
+
+[`Channel`][channel] encoding is even more straightforward than that of a
+[`Frame`][frame]. Simply, a [`Channel`][channel] is the concatenated list
+of encoded [`Frame`][frame]s.
+
+Since each [`Frame`][frame] contains the [`ChannelId`][cid] that corresponds
+to the given [`Channel`][channel], constructing a [`Channel`][channel] is as
+simple as calling the [`Channel::add_frame`][add-frame] method for each of
+its [`Frame`][frame]s.
+
+Once the [`Channel`][channel] has ingested all of it's [`Frame`][frame]s,
+it will be marked as "ready", with the [`Channel::is_ready`][is-ready]
+method returning `true`.
+
+
+## The `Channel` Type
+
+As discussed [above](#-channel-encoding), the [`Channel`][channel] type is
+expected to be populated with [`Frame`][frame]s using its
+[`Channel::add_frame`][add-frame] method. Below we demonstrate constructing
+a minimal [`Channel`][channel] using a few frames.
+
+```rust
+use maili_protocol::{Channel, Frame};
+
+// Construct a channel at the given L1 block.
+let id = [0xee; 16];
+let block = BlockInfo::default();
+let mut channel = Channel::new(id, block);
+
+// The channel will consist of 3 frames.
+let frame_0 = Frame { id: [0xee; 16], number: 0, ..Default::default() };
+let frame_1 = Frame { id: [0xee; 16], number: 1, ..Default::default() };
+let frame_2 = Frame { id: [0xee; 16], number: 2, is_last: true, ..Default::default() };
+
+// Add the frames to the channel.
+channel.add_frame(frame_0);
+channel.add_frame(frame_1);
+channel.add_frame(frame_2);
+
+// Since the last frame was ingested,
+// the channel should be ready.
+assert!(channel.is_ready());
+```
+
+There are a few rules when adding a [`Frame`][frame] to a [`Channel`][channel].
+- The [`Frame`][frame]'s id must be the same [`ChannelId`][cid] as the [`Channel`][channel]s.
+- [`Frame`][frame]s cannot be added once a [`Channel`][channel] is closed.
+- [`Frame`][frame]s within a [`Channel`][channel] must have distinct numbers.
+
+Notice, [`Frame`][frame]s can be added out-of-order so long as the [`Channel`][channel] is
+still open, and the frame hasn't already been added.
+
+
+
+
+[is-ready]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Channel.html#method.is_ready
+[add-frame]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Channel.html#method.add_frame
+
+[block-info]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.BlockInfo.html
+
+[frame-docs]: ./frames.md
+[specs]: https://specs.optimism.io/protocol/derivation.html#batch-submission-wire-format
+[seq-batch]: https://specs.optimism.io/glossary.html#sequencer-batch
+
+
+[channel]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Channel.html
+[cid]: https://docs.rs/maili-protocol/latest/maili_protocol/type.ChannelId.html
+[frame]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Frame.html
diff --git a/book/src/sdk/protocol/frames.md b/book/src/sdk/protocol/frames.md
new file mode 100644
index 0000000000..9cea7d5f0d
--- /dev/null
+++ b/book/src/sdk/protocol/frames.md
@@ -0,0 +1,85 @@
+# Frames
+
+[`Frame`][frame]s are the lowest level data format in the OP Stack protocol.
+
+
+## Where Frames fit in the OP Stack
+
+Transactions posted to the data availability layer of the rollup
+contain one or multiple [Frame][frame]s. Frames are chunks of raw data that
+belong to a given [Channel][channel], the next, higher up data format in the
+OP Stack protocol. Importantly, a given transaction can contain
+a variety of frames from _different_ channels, allowing maximum flexibility
+when breaking up channels into batcher transactions.
+
+
+## Contents of a Frame
+
+A [Frame][frame] is comprised of the following items.
+- A [`ChannelId`][cid] which is a 16 byte long identifier for the channel that
+ the given frame belongs to.
+- A `number` that identifies the index of the frame within the channel. Frames
+ are 0-indexed and are bound to `u16` size limit.
+- `data` contains the raw data within the frame.
+- `is_last` marks if the frame is the last within the channel.
+
+
+## Frame Encoding
+
+When frames are posted through a batcher transaction, they are encoded as a
+contiguous list with a single byte prefix denoting the derivation version.
+The encoding can be represented as the following concatenated bytes.
+
+```
+encoded = DERIVATION_VERSION_0 ++ encoded_frame_0 ++ encoded_frame_1 ++ ..
+```
+
+Where `DERIVATION_VERSION_0` is a single byte (`0x00`) indicating the derivation
+version including how the frames are encoded. Currently, the only supported
+derivation version is `0`.
+
+
+`encoded_frame_0`, `encoded_frame_1`, and so on, are all [`Frame`][frame]s encoded
+as raw bytes. A single encoded [`Frame`][frame] can be represented by the following
+concatenation of it's fields.
+
+```
+encoded_frame = channel_id ++ frame_number ++ frame_data_length ++ frame_data ++ is_last
+```
+
+Where `++` represents concatenation. The frame's fields map to it's encoding.
+- `channel_id` is the 16 byte long [`Frame::id`][id].
+- `frame_number` is the 2 byte long (or `u16`) [`Frame::number`][number].
+- `frame_data_length` and `frame_data` provide the necessary details to decode
+ the [`Frame::data`][data], where `frame_data_length` is 4 bytes long (or `u32`).
+- `is_last` is a single byte [`Frame::is_last`][is_last].
+
+
+## maili's `Frame` Type
+
+[`maili-protocol`][protocol] provides the [`Frame`][frame] type with a few useful
+methods. [`Frame`][frame]s can be encoded and decoded using the [`Frame::encode`][encode]
+and [`Frame::decode`][decode] methods. Given the raw batcher transaction data or blob data
+containing the concatenated derivation version and contiguous list of encoded frames,
+the [`Frame::parse_frame`][parse_frame] and [`Frame::parse_frames`][parse_frames] methods
+provide ways to decode single and multiple frames, respectively.
+
+
+
+
+[encode]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Frame.html#method.encode
+[decode]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Frame.html#method.decode
+
+[parse_frame]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Frame.html#method.parse_frame
+[parse_frames]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Frame.html#method.parse_frames
+
+[protocol]: https://crates.io/crate/maili-protocol
+
+[id]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Frame.html#structfield.id
+[number]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Frame.html#structfield.number
+[data]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Frame.html#structfield.data
+[is_last]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Frame.html#structfield.is_last
+
+[cid]: https://docs.rs/maili-protocol/latest/maili_protocol/type.ChannelId.html
+[channel]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Channel.html
+[frame]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Frame.html
diff --git a/clippy.toml b/clippy.toml
new file mode 100644
index 0000000000..8c0bc009eb
--- /dev/null
+++ b/clippy.toml
@@ -0,0 +1 @@
+msrv = "1.81"
diff --git a/crates/services/net/Cargo.toml b/crates/external/net/Cargo.toml
similarity index 100%
rename from crates/services/net/Cargo.toml
rename to crates/external/net/Cargo.toml
diff --git a/crates/services/net/README.md b/crates/external/net/README.md
similarity index 100%
rename from crates/services/net/README.md
rename to crates/external/net/README.md
diff --git a/crates/services/net/src/builder.rs b/crates/external/net/src/builder.rs
similarity index 100%
rename from crates/services/net/src/builder.rs
rename to crates/external/net/src/builder.rs
diff --git a/crates/services/net/src/discovery/bootnodes.rs b/crates/external/net/src/discovery/bootnodes.rs
similarity index 100%
rename from crates/services/net/src/discovery/bootnodes.rs
rename to crates/external/net/src/discovery/bootnodes.rs
diff --git a/crates/services/net/src/discovery/builder.rs b/crates/external/net/src/discovery/builder.rs
similarity index 100%
rename from crates/services/net/src/discovery/builder.rs
rename to crates/external/net/src/discovery/builder.rs
diff --git a/crates/services/net/src/discovery/driver.rs b/crates/external/net/src/discovery/driver.rs
similarity index 100%
rename from crates/services/net/src/discovery/driver.rs
rename to crates/external/net/src/discovery/driver.rs
diff --git a/crates/services/net/src/discovery/mod.rs b/crates/external/net/src/discovery/mod.rs
similarity index 100%
rename from crates/services/net/src/discovery/mod.rs
rename to crates/external/net/src/discovery/mod.rs
diff --git a/crates/services/net/src/driver.rs b/crates/external/net/src/driver.rs
similarity index 100%
rename from crates/services/net/src/driver.rs
rename to crates/external/net/src/driver.rs
diff --git a/crates/services/net/src/gossip/behaviour.rs b/crates/external/net/src/gossip/behaviour.rs
similarity index 100%
rename from crates/services/net/src/gossip/behaviour.rs
rename to crates/external/net/src/gossip/behaviour.rs
diff --git a/crates/services/net/src/gossip/config.rs b/crates/external/net/src/gossip/config.rs
similarity index 100%
rename from crates/services/net/src/gossip/config.rs
rename to crates/external/net/src/gossip/config.rs
diff --git a/crates/services/net/src/gossip/driver.rs b/crates/external/net/src/gossip/driver.rs
similarity index 100%
rename from crates/services/net/src/gossip/driver.rs
rename to crates/external/net/src/gossip/driver.rs
diff --git a/crates/services/net/src/gossip/event.rs b/crates/external/net/src/gossip/event.rs
similarity index 100%
rename from crates/services/net/src/gossip/event.rs
rename to crates/external/net/src/gossip/event.rs
diff --git a/crates/services/net/src/gossip/handler.rs b/crates/external/net/src/gossip/handler.rs
similarity index 100%
rename from crates/services/net/src/gossip/handler.rs
rename to crates/external/net/src/gossip/handler.rs
diff --git a/crates/services/net/src/gossip/mod.rs b/crates/external/net/src/gossip/mod.rs
similarity index 100%
rename from crates/services/net/src/gossip/mod.rs
rename to crates/external/net/src/gossip/mod.rs
diff --git a/crates/services/net/src/lib.rs b/crates/external/net/src/lib.rs
similarity index 100%
rename from crates/services/net/src/lib.rs
rename to crates/external/net/src/lib.rs
diff --git a/crates/services/net/src/types/enr.rs b/crates/external/net/src/types/enr.rs
similarity index 100%
rename from crates/services/net/src/types/enr.rs
rename to crates/external/net/src/types/enr.rs
diff --git a/crates/services/net/src/types/mod.rs b/crates/external/net/src/types/mod.rs
similarity index 100%
rename from crates/services/net/src/types/mod.rs
rename to crates/external/net/src/types/mod.rs
diff --git a/crates/services/net/src/types/peer.rs b/crates/external/net/src/types/peer.rs
similarity index 95%
rename from crates/services/net/src/types/peer.rs
rename to crates/external/net/src/types/peer.rs
index 0aa0424453..88e4e0630a 100644
--- a/crates/services/net/src/types/peer.rs
+++ b/crates/external/net/src/types/peer.rs
@@ -1,7 +1,5 @@
//! Peer Types
-#[cfg(any(test, feature = "arbitrary"))]
-use arbitrary::{Arbitrary, Unstructured};
use discv5::enr::{CombinedKey, Enr};
use libp2p::{multiaddr::Protocol, Multiaddr};
use std::net::{IpAddr, SocketAddr};
@@ -24,9 +22,9 @@ pub enum PeerConversionError {
MissingPort,
}
-#[cfg(any(test, feature = "arbitrary"))]
-impl<'a> Arbitrary<'a> for Peer {
- fn arbitrary(u: &mut Unstructured<'a>) -> arbitrary::Result
+