fix: doc comments (#70)

Author: Fraser999

crates/blobber/src/error.rs

@@ -2,7 +2,7 @@ use crate::{DecodeError, FetchError};
 use alloy::{eips::eip2718::Eip2718Error, primitives::B256};
 use reth::transaction_pool::BlobStoreError;
 
-/// Result using [`BlobFetcherError`] as the default error type.
+/// Result using [`BlobberError`] as the default error type.
 pub type BlobberResult<T, E = BlobberError> = std::result::Result<T, E>;
 
 /// Blob fetching errors

crates/block-processor/src/alias.rs

@@ -3,6 +3,8 @@ use alloy::{
     primitives::{Address, map::HashSet},
 };
 use eyre::OptionExt;
+#[cfg(doc)]
+use reth::providers::StateProvider;
 use reth::providers::{StateProviderBox, StateProviderFactory};
 use std::sync::{Arc, Mutex};
 

crates/block-processor/src/utils.rs

@@ -1,7 +1,7 @@
 use reth_chainspec::EthereumHardforks;
 use trevm::revm::primitives::hardfork::SpecId;
 
-/// Equivalent to [`reth_evm_ethereum::revm_spec`], however, always starts at
+/// Equivalent to `reth_evm_ethereum::revm_spec`, however, always starts at
 /// [`SpecId::PRAGUE`] and transitions to [`SpecId::OSAKA`].
 pub fn revm_spec(chain_spec: &reth::chainspec::ChainSpec, timestamp: u64) -> SpecId {
     if chain_spec.is_amsterdam_active_at_timestamp(timestamp) {

crates/db/src/traits.rs

@@ -1,6 +1,8 @@
 use crate::{DbExtractionResults, DbSignetEvent, RuChain, SignetDbRw};
 use alloy::primitives::{B256, BlockNumber};
 use itertools::Itertools;
+#[cfg(doc)]
+use reth::providers::DatabaseProviderRW;
 use reth::providers::{OriginalValuesKnown, ProviderResult};
 use reth_db::models::StoredBlockBodyIndices;
 use signet_evm::BlockResult;

crates/node-tests/src/context.rs

@@ -77,7 +77,7 @@ pub struct SignetTestContext {
     /// The alias oracle used by the Signet Node instance.
     pub alias_oracle: Arc<Mutex<HashSet<Address>>>,
 
-    /// Test addresses, copied from [`signet_types::test_utils::TEST_USERS`] for
+    /// Test addresses, copied from [`signet_test_utils::users::TEST_USERS`] for
     /// convenience
     pub addresses: [Address; 10],
 }

crates/node-tests/src/lib.rs

@@ -16,7 +16,7 @@ pub mod constants;
 
 /// Test context.
 mod context;
-pub use context::SignetTestContext;
+pub use context::{BalanceChecks, NonceChecks, SignetTestContext};
 
 /// Bespoke conversion utilities for converting between alloy and reth types.
 pub mod convert;

crates/rpc/src/debug/endpoints.rs

@@ -23,7 +23,7 @@ use tracing::Instrument;
 #[derive(Debug, serde::Deserialize)]
 pub(super) struct TraceBlockParams<T>(T, #[serde(default)] Option<GethDebugTracingOptions>);
 
-/// Params type for `debug_traceTransaction`.`
+/// Params type for `debug_traceTransaction`.
 #[derive(Debug, serde::Deserialize)]
 pub(super) struct TraceTransactionParams(B256, #[serde(default)] Option<GethDebugTracingOptions>);