diff --git a/crates/derive/README.md b/crates/derive/README.md index 4504e7dc9..bbf2935a2 100644 --- a/crates/derive/README.md +++ b/crates/derive/README.md @@ -1,8 +1,9 @@ # `kona-derive` - CI - Kona Derive - License +CI +Kona Derive +License +Codecov A `no_std` compatible implementation of the OP Stack's [derivation pipeline][derive]. @@ -17,12 +18,12 @@ use std::sync::Arc; use op_alloy_genesis::RollupConfig; use kona_derive::sources::EthereumDataSource; use kona_derive::pipeline::PipelineBuilder; -use kona_derive::stages::{StatefulAttributesBuilder}; +use kona_derive::attributes::StatefulAttributesBuilder; -let chain_provider = ...; -let l2_chain_provider = ...; -let blob_provider = ...; -let l1_origin = ...; +let chain_provider = todo!(); +let l2_chain_provider = todo!(); +let blob_provider = todo!(); +let l1_origin = todo!(); let cfg = Arc::new(RollupConfig::default()); let attributes = StatefulAttributesBuilder::new( @@ -57,8 +58,6 @@ The most up-to-date feature list will be available on the [docs.rs `Feature Flag Some features include the following. - `serde`: Serialization and Deserialization support for `kona-derive` types. -- `metrics`: Enables prometheus metric collection. _Note: This requires an `std` environment._ -- `online`: Exposes an [alloy-provider][ap] powered data source using "online" HTTP requests. - `test-utils`: Test utilities for downstream libraries. By default, `kona-derive` enables the `serde` feature.