chore(runner): Runner Touchups (#256)

* chore(runner): touchup runner crate

* fix: lints

Author: refcell

crates/runner/src/extensions/mod.rs

@@ -4,11 +4,13 @@
 //! of the node building process.
 
 mod canon;
-mod rpc;
-mod tracing;
-mod types;
-
 pub use canon::FlashblocksCanonExtension;
+
+mod rpc;
 pub use rpc::BaseRpcExtension;
+
+mod tracing;
 pub use tracing::TransactionTracingExtension;
-pub(crate) use types::{FlashblocksCell, OpBuilder};
+
+mod types;
+pub use types::{FlashblocksCell, OpBuilder, OpProvider};

crates/runner/src/extensions/types.rs

@@ -1,3 +1,5 @@
+//! Type aliases
+
 use std::sync::Arc;
 
 use base_reth_flashblocks::FlashblocksState;
@@ -10,11 +12,16 @@ use reth::{
 use reth_db::DatabaseEnv;
 use reth_optimism_node::OpNode;
 
-pub(crate) type OpProvider = BlockchainProvider<NodeTypesWithDBAdapter<OpNode, Arc<DatabaseEnv>>>;
 type OpNodeTypes = FullNodeTypesAdapter<OpNode, Arc<DatabaseEnv>, OpProvider>;
 type OpComponentsBuilder = <OpNode as Node<OpNodeTypes>>::ComponentsBuilder;
 type OpAddOns = <OpNode as Node<OpNodeTypes>>::AddOns;
-pub(crate) type OpBuilder =
+
+/// A [`BlockchainProvider`] instance.
+pub type OpProvider = BlockchainProvider<NodeTypesWithDBAdapter<OpNode, Arc<DatabaseEnv>>>;
+
+/// OP Builder is a [`WithLaunchContext`] reth node builder.
+pub type OpBuilder =
     WithLaunchContext<NodeBuilderWithComponents<OpNodeTypes, OpComponentsBuilder, OpAddOns>>;
 
-pub(crate) type FlashblocksCell = Arc<OnceCell<Arc<FlashblocksState<OpProvider>>>>;
+/// The flashblocks cell holds the [`FlashblocksState`].
+pub type FlashblocksCell = Arc<OnceCell<Arc<FlashblocksState<OpProvider>>>>;

crates/runner/src/lib.rs

@@ -1,4 +1,6 @@
 #![doc = include_str!("../README.md")]
+#![doc(issue_tracker_base_url = "https://github.com/base/node-reth/issues/")]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 #![cfg_attr(not(test), warn(unused_crate_dependencies))]
 
 mod context;
@@ -11,4 +13,7 @@ mod config;
 pub use config::{BaseNodeConfig, FlashblocksConfig, TracingConfig};
 
 mod extensions;
-pub use extensions::{BaseRpcExtension, FlashblocksCanonExtension, TransactionTracingExtension};
+pub use extensions::{
+    BaseRpcExtension, FlashblocksCanonExtension, FlashblocksCell, OpBuilder, OpProvider,
+    TransactionTracingExtension,
+};