jleony/nanoreth
1
0
Fork 0
mirror of https://github.com/hl-archive-node/nanoreth.git synced 2025-12-06 10:59:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

fmt: format doc comments (#5308)

Browse Source
This commit is contained in:
DaniPopes
2023-11-05 14:06:30 +01:00
committed by GitHub
parent f9c46bf426
commit 470449ff24
26 changed files with 207 additions and 160 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
crates/consensus/common/src/calc.rs
View File

@ -56,13 +56,11 @@ pub fn base_block_reward(
/// let total_difficulty = U256::from(2_235_668_675_900usize);
/// let number_of_ommers = 1;
///
/// let reward = base_block_reward(&MAINNET, block_number, block_difficulty, total_difficulty).map(|reward| block_reward(reward, 1));
/// let reward = base_block_reward(&MAINNET, block_number, block_difficulty, total_difficulty)
/// .map(|reward| block_reward(reward, 1));
///
/// // The base block reward is 5 ETH, and the ommer inclusion reward is 1/32th of 5 ETH.
/// assert_eq!(
/// reward.unwrap(),
/// ETH_TO_WEI * 5 + ((ETH_TO_WEI * 5) >> 5)
/// );
/// assert_eq!(reward.unwrap(), ETH_TO_WEI * 5 + ((ETH_TO_WEI * 5) >> 5));
/// ```
///
/// # References

30
crates/metrics/metrics-derive/src/lib.rs
View File

@ -28,8 +28,8 @@ mod with_attrs;
///
/// Sample usage:
/// ```
/// use reth_metrics_derive::Metrics;
/// use metrics::{Counter, Gauge, Histogram};
/// use reth_metrics_derive::Metrics;
///
/// #[derive(Metrics)]
/// #[metrics(scope = "metrics_custom")]
@ -43,7 +43,7 @@ mod with_attrs;
/// counter: Counter,
/// /// A renamed histogram.
/// #[metric(rename = "histogram")]
/// histo: Histogram
/// histo: Histogram,
/// }
/// ```
///
@ -56,7 +56,7 @@ mod with_attrs;
/// /// Some doc comment
/// counter: metrics::Counter,
/// /// A renamed histogram.
/// histo: metrics::Histogram
/// histo: metrics::Histogram,
/// }
///
/// impl Default for CustomMetrics {
@ -73,9 +73,18 @@ mod with_attrs;
/// impl CustomMetrics {
/// /// Describe all exposed metrics
/// pub fn describe() {
/// metrics::describe_gauge!("metrics_custom_gauge", "A gauge with doc comment description.");
/// metrics::describe_gauge!("metrics_custom_second_gauge", "A gauge with metric attribute description.");
/// metrics::describe_counter!("metrics_custom_counter", "Metric attribute description will be preferred over doc comment.");
/// metrics::describe_gauge!(
/// "metrics_custom_gauge",
/// "A gauge with doc comment description."
/// );
/// metrics::describe_gauge!(
/// "metrics_custom_second_gauge",
/// "A gauge with metric attribute description."
/// );
/// metrics::describe_counter!(
/// "metrics_custom_counter",
/// "Metric attribute description will be preferred over doc comment."
/// );
/// metrics::describe_histogram!("metrics_custom_histogram", "A renamed histogram.");
/// }
/// }
@ -110,13 +119,14 @@ mod with_attrs;
///
/// impl DynamicScopeMetrics {
/// pub fn new(scope: &str) -> Self {
/// Self {
/// gauge: metrics::register_gauge!(format!("{}{}{}", scope, "_", "gauge"))
/// }
/// Self { gauge: metrics::register_gauge!(format!("{}{}{}", scope, "_", "gauge")) }
/// }
///
/// pub fn describe(scope: &str) {
/// metrics::describe_gauge!(format!("{}{}{}", scope, "_", "gauge"), "A gauge with doc comment description.");
/// metrics::describe_gauge!(
/// format!("{}{}{}", scope, "_", "gauge"),
/// "A gauge with doc comment description."
/// );
/// }
/// }
///

37
crates/net/discv4/src/lib.rs
View File

@ -193,36 +193,31 @@ impl Discv4 {
///
/// ```
/// # use std::io;
/// use std::net::SocketAddr;
/// use std::str::FromStr;
/// use rand::thread_rng;
/// use secp256k1::SECP256K1;
/// use reth_primitives::{NodeRecord, PeerId};
/// use reth_discv4::{Discv4, Discv4Config};
/// use reth_primitives::{NodeRecord, PeerId};
/// use secp256k1::SECP256K1;
/// use std::{net::SocketAddr, str::FromStr};
/// # async fn t() -> io::Result<()> {
/// // generate a (random) keypair
/// let mut rng = thread_rng();
/// let (secret_key, pk) = SECP256K1.generate_keypair(&mut rng);
/// let id = PeerId::from_slice(&pk.serialize_uncompressed()[1..]);
/// let mut rng = thread_rng();
/// let (secret_key, pk) = SECP256K1.generate_keypair(&mut rng);
/// let id = PeerId::from_slice(&pk.serialize_uncompressed()[1..]);
///
/// let socket = SocketAddr::from_str("0.0.0.0:0").unwrap();
/// let local_enr = NodeRecord {
/// address: socket.ip(),
/// tcp_port: socket.port(),
/// udp_port: socket.port(),
/// id,
/// };
/// let config = Discv4Config::default();
/// let socket = SocketAddr::from_str("0.0.0.0:0").unwrap();
/// let local_enr =
/// NodeRecord { address: socket.ip(), tcp_port: socket.port(), udp_port: socket.port(), id };
/// let config = Discv4Config::default();
///
/// let(discv4, mut service) = Discv4::bind(socket, local_enr, secret_key, config).await.unwrap();
/// let (discv4, mut service) = Discv4::bind(socket, local_enr, secret_key, config).await.unwrap();
///
/// // get an update strea
/// let updates = service.update_stream();
/// // get an update strea
/// let updates = service.update_stream();
///
/// let _handle = service.spawn();
/// let _handle = service.spawn();
///
/// // lookup the local node in the DHT
/// let _discovered = discv4.lookup_self().await.unwrap();
/// // lookup the local node in the DHT
/// let _discovered = discv4.lookup_self().await.unwrap();
///
/// # Ok(())
/// # }

8
crates/net/dns/src/lib.rs
View File

@ -118,11 +118,13 @@ impl<R: Resolver> DnsDiscoveryService<R> {
/// Creates a new instance of the [DnsDiscoveryService] using the given settings.
///
/// ```
/// use std::sync::Arc;
/// use reth_dns_discovery::{DnsDiscoveryService, DnsResolver};
/// use std::sync::Arc;
/// # fn t() {
/// let service =
/// DnsDiscoveryService::new(Arc::new(DnsResolver::from_system_conf().unwrap()), Default::default());
/// let service = DnsDiscoveryService::new(
/// Arc::new(DnsResolver::from_system_conf().unwrap()),
/// Default::default(),
/// );
/// # }
/// ```
pub fn new(resolver: Arc<R>, config: DnsDiscoveryConfig) -> Self {

4
crates/net/dns/src/resolver.rs
View File

@ -40,8 +40,8 @@ impl<P: ConnectionProvider> Resolver for AsyncResolver<P> {
///
/// ```
/// # fn t() {
/// use reth_dns_discovery::resolver::DnsResolver;
/// let resolver = DnsResolver::from_system_conf().unwrap();
/// use reth_dns_discovery::resolver::DnsResolver;
/// let resolver = DnsResolver::from_system_conf().unwrap();
/// # }
/// ```
///

20
crates/net/downloaders/src/bodies/task.rs
View File

@ -42,18 +42,16 @@ impl TaskDownloader {
/// # Example
///
/// ```
/// use std::sync::Arc;
/// use reth_downloaders::bodies::bodies::BodiesDownloaderBuilder;
/// use reth_downloaders::bodies::task::TaskDownloader;
/// use reth_interfaces::consensus::Consensus;
/// use reth_interfaces::p2p::bodies::client::BodiesClient;
/// use reth_db::database::Database;
/// fn t<B: BodiesClient + 'static, DB: Database + 'static>(client: Arc<B>, consensus:Arc<dyn Consensus>, db: Arc<DB>) {
/// let downloader = BodiesDownloaderBuilder::default().build(
/// client,
/// consensus,
/// db
/// );
/// use reth_downloaders::bodies::{bodies::BodiesDownloaderBuilder, task::TaskDownloader};
/// use reth_interfaces::{consensus::Consensus, p2p::bodies::client::BodiesClient};
/// use std::sync::Arc;
/// fn t<B: BodiesClient + 'static, DB: Database + 'static>(
/// client: Arc<B>,
/// consensus: Arc<dyn Consensus>,
/// db: Arc<DB>,
/// ) {
/// let downloader = BodiesDownloaderBuilder::default().build(client, consensus, db);
/// let downloader = TaskDownloader::spawn(downloader);
/// }
/// ```

5
crates/net/eth-wire/src/builder.rs
View File

@ -10,9 +10,8 @@ use reth_primitives::{Chain, ForkId, PeerId, B256, U256};
///
/// # Example
/// ```
/// use reth_eth_wire::EthVersion;
/// use reth_primitives::{Chain, U256, B256, MAINNET_GENESIS_HASH, MAINNET, Hardfork};
/// use reth_eth_wire::types::Status;
/// use reth_eth_wire::{types::Status, EthVersion};
/// use reth_primitives::{Chain, Hardfork, B256, MAINNET, MAINNET_GENESIS_HASH, U256};
///
/// // this is just an example status message!
/// let status = Status::builder()

4
crates/net/eth-wire/src/hello.rs
View File

@ -33,11 +33,11 @@ impl HelloMessage {
/// Starts a new `HelloMessageBuilder`
///
/// ```
/// use secp256k1::{SECP256K1, SecretKey};
/// use reth_ecies::util::pk2id;
/// use reth_eth_wire::HelloMessage;
/// use secp256k1::{SecretKey, SECP256K1};
/// let secret_key = SecretKey::new(&mut rand::thread_rng());
/// let id = pk2id(&secret_key.public_key(SECP256K1));
/// let id = pk2id(&secret_key.public_key(SECP256K1));
/// let status = HelloMessage::builder(id).build();
/// ```
pub fn builder(id: PeerId) -> HelloMessageBuilder {

6
crates/net/network/src/config.rs
View File

@ -205,10 +205,8 @@ impl NetworkConfigBuilder {
/// # use reth_eth_wire::HelloMessage;
/// # use reth_network::NetworkConfigBuilder;
/// # fn builder(builder: NetworkConfigBuilder) {
/// let peer_id = builder.get_peer_id();
/// builder.hello_message(
/// HelloMessage::builder(peer_id).build()
/// );
/// let peer_id = builder.get_peer_id();
/// builder.hello_message(HelloMessage::builder(peer_id).build());
/// # }
/// ```
pub fn hello_message(mut self, hello_message: HelloMessage) -> Self {

14
crates/net/network/src/lib.rs
View File

@ -46,10 +46,9 @@
//!
//! ```
//! # async fn launch() {
//! use reth_network::config::rng_secret_key;
//! use reth_network::{NetworkConfig, NetworkManager};
//! use reth_provider::test_utils::NoopProvider;
//! use reth_network::{config::rng_secret_key, NetworkConfig, NetworkManager};
//! use reth_primitives::mainnet_nodes;
//! use reth_provider::test_utils::NoopProvider;
//!
//! // This block provider implementation is used for testing purposes.
//! let client = NoopProvider::default();
@ -57,9 +56,7 @@
//! // The key that's used for encrypting sessions and to identify our node.
//! let local_key = rng_secret_key();
//!
//! let config = NetworkConfig::builder(local_key).boot_nodes(
//! mainnet_nodes()
//! ).build(client);
//! let config = NetworkConfig::builder(local_key).boot_nodes(mainnet_nodes()).build(client);
//!
//! // create the network instance
//! let network = NetworkManager::new(config).await.unwrap();
@ -74,11 +71,10 @@
//! ### Configure all components of the Network with the [`NetworkBuilder`]
//!
//! ```
//! use reth_network::{config::rng_secret_key, NetworkConfig, NetworkManager};
//! use reth_primitives::mainnet_nodes;
//! use reth_provider::test_utils::NoopProvider;
//! use reth_transaction_pool::TransactionPool;
//! use reth_primitives::mainnet_nodes;
//! use reth_network::config::rng_secret_key;
//! use reth_network::{NetworkConfig, NetworkManager};
//! async fn launch<Pool: TransactionPool>(pool: Pool) {
//! // This block provider implementation is used for testing purposes.
//! let client = NoopProvider::default();

5
crates/net/network/src/manager.rs
View File

@ -260,11 +260,10 @@ where
/// components of the network
///
/// ```
/// use reth_network::{config::rng_secret_key, NetworkConfig, NetworkManager};
/// use reth_primitives::mainnet_nodes;
/// use reth_provider::test_utils::NoopProvider;
/// use reth_transaction_pool::TransactionPool;
/// use reth_primitives::mainnet_nodes;
/// use reth_network::config::rng_secret_key;
/// use reth_network::{NetworkConfig, NetworkManager};
/// async fn launch<Pool: TransactionPool>(pool: Pool) {
/// // This block provider implementation is used for testing purposes.
/// let client = NoopProvider::default();

4
crates/net/network/tests/it/clique/geth.rs
View File

@ -22,9 +22,7 @@ use std::{
/// # let clique = async {
///
/// // this creates a funded geth
/// let clique_geth = Geth::new()
/// .p2p_port(30303)
/// .chain_id(1337u64);
/// let clique_geth = Geth::new().p2p_port(30303).chain_id(1337u64);
///
/// // build the funded geth, generating a random signing key and enabling clique
/// let mut clique = CliqueGethInstance::new(clique_geth, None).await;

7
crates/rpc/ipc/src/client.rs
View File

@ -90,12 +90,11 @@ impl IpcTransportClientBuilder {
/// Try to establish the connection.
///
/// ```
/// use jsonrpsee::rpc_params;
/// use jsonrpsee::{core::client::ClientT, rpc_params};
/// use reth_ipc::client::IpcClientBuilder;
/// use jsonrpsee::core::client::ClientT;
/// # async fn run_client() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
/// let client = IpcClientBuilder::default().build("/tmp/my-uds").await?;
/// let response: String = client.request("say_hello", rpc_params![]).await?;
/// let client = IpcClientBuilder::default().build("/tmp/my-uds").await?;
/// let response: String = client.request("say_hello", rpc_params![]).await?;
/// # Ok(())
/// # }
/// ```

1
crates/rpc/ipc/src/server/mod.rs
View File

@ -530,7 +530,6 @@ impl<B, L> Builder<B, L> {
/// # Examples
///
/// ```rust
///
/// #[tokio::main]
/// async fn main() {
/// let builder = tower::ServiceBuilder::new();

111
crates/rpc/rpc-builder/src/lib.rs
View File

@ -18,16 +18,33 @@
//!
//! ```
//! use reth_network_api::{NetworkInfo, Peers};
//! use reth_provider::{AccountReader, BlockReaderIdExt, ChainSpecProvider, CanonStateSubscriptions, StateProviderFactory, EvmEnvProvider, ChangeSetReader};
//! use reth_rpc_builder::{RethRpcModule, RpcModuleBuilder, RpcServerConfig, ServerBuilder, TransportRpcModuleConfig};
//! use reth_provider::{
//! AccountReader, BlockReaderIdExt, CanonStateSubscriptions, ChainSpecProvider,
//! ChangeSetReader, EvmEnvProvider, StateProviderFactory,
//! };
//! use reth_rpc_builder::{
//! RethRpcModule, RpcModuleBuilder, RpcServerConfig, ServerBuilder, TransportRpcModuleConfig,
//! };
//! use reth_tasks::TokioTaskExecutor;
//! use reth_transaction_pool::TransactionPool;
//! pub async fn launch<Provider, Pool, Network, Events>(provider: Provider, pool: Pool, network: Network, events: Events)
//! where
//! Provider: AccountReader + BlockReaderIdExt + ChainSpecProvider + ChangeSetReader + StateProviderFactory + EvmEnvProvider + Clone + Unpin + 'static,
//! pub async fn launch<Provider, Pool, Network, Events>(
//! provider: Provider,
//! pool: Pool,
//! network: Network,
//! events: Events,
//! ) where
//! Provider: AccountReader
//! + BlockReaderIdExt
//! + ChainSpecProvider
//! + ChangeSetReader
//! + StateProviderFactory
//! + EvmEnvProvider
//! + Clone
//! + Unpin
//! + 'static,
//! Pool: TransactionPool + Clone + 'static,
//! Network: NetworkInfo + Peers + Clone + 'static,
//! Events: CanonStateSubscriptions + Clone + 'static,
//! Events: CanonStateSubscriptions + Clone + 'static,
//! {
//! // configure the rpc module per transport
//! let transports = TransportRpcModuleConfig::default().with_http(vec![
@ -36,7 +53,9 @@
//! RethRpcModule::Eth,
//! RethRpcModule::Web3,
//! ]);
//! let transport_modules = RpcModuleBuilder::new(provider, pool, network, TokioTaskExecutor::default(), events).build(transports);
//! let transport_modules =
//! RpcModuleBuilder::new(provider, pool, network, TokioTaskExecutor::default(), events)
//! .build(transports);
//! let handle = RpcServerConfig::default()
//! .with_http(ServerBuilder::default())
//! .start(transport_modules)
@ -49,22 +68,40 @@
//!
//!
//! ```
//! use tokio::try_join;
//! use reth_network_api::{NetworkInfo, Peers};
//! use reth_provider::{AccountReader, BlockReaderIdExt, ChainSpecProvider, CanonStateSubscriptions, StateProviderFactory, EvmEnvProvider, ChangeSetReader};
//! use reth_provider::{
//! AccountReader, BlockReaderIdExt, CanonStateSubscriptions, ChainSpecProvider,
//! ChangeSetReader, EvmEnvProvider, StateProviderFactory,
//! };
//! use reth_rpc::JwtSecret;
//! use reth_rpc_builder::{RethRpcModule, RpcModuleBuilder, RpcServerConfig, TransportRpcModuleConfig};
//! use reth_rpc_api::EngineApiServer;
//! use reth_rpc_builder::{
//! auth::AuthServerConfig, RethRpcModule, RpcModuleBuilder, RpcServerConfig,
//! TransportRpcModuleConfig,
//! };
//! use reth_tasks::TokioTaskExecutor;
//! use reth_transaction_pool::TransactionPool;
//! use reth_rpc_api::EngineApiServer;
//! use reth_rpc_builder::auth::AuthServerConfig;
//! pub async fn launch<Provider, Pool, Network, Events, EngineApi>(provider: Provider, pool: Pool, network: Network, events: Events, engine_api: EngineApi)
//! where
//! Provider: AccountReader + BlockReaderIdExt + ChainSpecProvider + ChangeSetReader + StateProviderFactory + EvmEnvProvider + Clone + Unpin + 'static,
//! use tokio::try_join;
//! pub async fn launch<Provider, Pool, Network, Events, EngineApi>(
//! provider: Provider,
//! pool: Pool,
//! network: Network,
//! events: Events,
//! engine_api: EngineApi,
//! ) where
//! Provider: AccountReader
//! + BlockReaderIdExt
//! + ChainSpecProvider
//! + ChangeSetReader
//! + StateProviderFactory
//! + EvmEnvProvider
//! + Clone
//! + Unpin
//! + 'static,
//! Pool: TransactionPool + Clone + 'static,
//! Network: NetworkInfo + Peers + Clone + 'static,
//! Events: CanonStateSubscriptions + Clone + 'static,
//! EngineApi: EngineApiServer
//! Events: CanonStateSubscriptions + Clone + 'static,
//! EngineApi: EngineApiServer,
//! {
//! // configure the rpc module per transport
//! let transports = TransportRpcModuleConfig::default().with_http(vec![
@ -73,20 +110,20 @@
//! RethRpcModule::Eth,
//! RethRpcModule::Web3,
//! ]);
//! let builder = RpcModuleBuilder::new(provider, pool, network, TokioTaskExecutor::default(), events);
//! let builder =
//! RpcModuleBuilder::new(provider, pool, network, TokioTaskExecutor::default(), events);
//!
//! // configure the server modules
//! let (modules, auth_module, _registry) = builder.build_with_auth_server(transports, engine_api);
//! // configure the server modules
//! let (modules, auth_module, _registry) =
//! builder.build_with_auth_server(transports, engine_api);
//!
//! // start the servers
//! let auth_config = AuthServerConfig::builder(JwtSecret::random()).build();
//! let config = RpcServerConfig::default();
//!
//! let (_rpc_handle, _auth_handle) = try_join!(
//! modules.start_server(config),
//! auth_module.start_server(auth_config),
//! ).unwrap();
//! // start the servers
//! let auth_config = AuthServerConfig::builder(JwtSecret::random()).build();
//! let config = RpcServerConfig::default();
//!
//! let (_rpc_handle, _auth_handle) =
//! try_join!(modules.start_server(config), auth_module.start_server(auth_config),)
//! .unwrap();
//! }
//! ```
@ -515,19 +552,25 @@ impl RpcModuleSelection {
/// Create a selection from the [RethRpcModule] string identifiers
///
/// ```
/// use reth_rpc_builder::{RethRpcModule, RpcModuleSelection};
/// use reth_rpc_builder::{RethRpcModule, RpcModuleSelection};
/// let selection = vec!["eth", "admin"];
/// let config = RpcModuleSelection::try_from_selection(selection).unwrap();
/// assert_eq!(config, RpcModuleSelection::Selection(vec![RethRpcModule::Eth, RethRpcModule::Admin]));
/// assert_eq!(
/// config,
/// RpcModuleSelection::Selection(vec![RethRpcModule::Eth, RethRpcModule::Admin])
/// );
/// ```
///
/// Create a unique selection from the [RethRpcModule] string identifiers
///
/// ```
/// use reth_rpc_builder::{RethRpcModule, RpcModuleSelection};
/// use reth_rpc_builder::{RethRpcModule, RpcModuleSelection};
/// let selection = vec!["eth", "admin", "eth", "admin"];
/// let config = RpcModuleSelection::try_from_selection(selection).unwrap();
/// assert_eq!(config, RpcModuleSelection::Selection(vec![RethRpcModule::Eth, RethRpcModule::Admin]));
/// assert_eq!(
/// config,
/// RpcModuleSelection::Selection(vec![RethRpcModule::Eth, RethRpcModule::Admin])
/// );
/// ```
pub fn try_from_selection<I, T>(selection: I) -> Result<Self, T::Error>
where
@ -1433,8 +1476,8 @@ impl RpcServerConfig {
///
/// ```
/// use reth_rpc_builder::{RethRpcModule, TransportRpcModuleConfig};
/// let config = TransportRpcModuleConfig::default()
/// .with_http([RethRpcModule::Eth, RethRpcModule::Admin]);
/// let config =
/// TransportRpcModuleConfig::default().with_http([RethRpcModule::Eth, RethRpcModule::Admin]);
/// ```
#[derive(Debug, Clone, Default, Eq, PartialEq)]
pub struct TransportRpcModuleConfig {

8
crates/rpc/rpc-types/src/eth/filter.rs
View File

@ -366,7 +366,8 @@ impl Filter {
/// # use alloy_primitives::Address;
/// # use reth_rpc_types::Filter;
/// # fn main() {
/// let filter = Filter::new().address("0xAc4b3DacB91461209Ae9d41EC517c2B9Cb1B7DAF".parse::<Address>().unwrap());
/// let filter = Filter::new()
/// .address("0xAc4b3DacB91461209Ae9d41EC517c2B9Cb1B7DAF".parse::<Address>().unwrap());
/// # }
/// ```
///
@ -377,7 +378,10 @@ impl Filter {
/// # use alloy_primitives::Address;
/// # use reth_rpc_types::Filter;
/// # fn main() {
/// let addresses = vec!["0xAc4b3DacB91461209Ae9d41EC517c2B9Cb1B7DAF".parse::<Address>().unwrap(),"0x8ad599c3A0ff1De082011EFDDc58f1908eb6e6D8".parse::<Address>().unwrap()];
/// let addresses = vec![
/// "0xAc4b3DacB91461209Ae9d41EC517c2B9Cb1B7DAF".parse::<Address>().unwrap(),
/// "0x8ad599c3A0ff1De082011EFDDc58f1908eb6e6D8".parse::<Address>().unwrap(),
/// ];
/// let filter = Filter::new().address(addresses);
/// # }
/// ```

33
crates/rpc/rpc/src/layers/auth_layer.rs
View File

@ -17,25 +17,26 @@ use tower::{Layer, Service};
/// # How to integrate
/// ```rust
/// async fn build_layered_rpc_server() {
/// use jsonrpsee::server::ServerBuilder;
/// use reth_rpc::{AuthLayer, JwtAuthValidator, JwtSecret};
/// use std::net::SocketAddr;
/// use jsonrpsee::server::ServerBuilder;
/// use reth_rpc::{AuthLayer, JwtAuthValidator, JwtSecret};
/// use std::net::SocketAddr;
///
/// const AUTH_PORT: u32 = 8551;
/// const AUTH_ADDR: &str = "0.0.0.0";
/// const AUTH_SECRET: &str = "f79ae8046bc11c9927afe911db7143c51a806c4a537cc08e0d37140b0192f430";
/// const AUTH_PORT: u32 = 8551;
/// const AUTH_ADDR: &str = "0.0.0.0";
/// const AUTH_SECRET: &str =
/// "f79ae8046bc11c9927afe911db7143c51a806c4a537cc08e0d37140b0192f430";
///
/// let addr = format!("{AUTH_ADDR}:{AUTH_PORT}");
/// let secret = JwtSecret::from_hex(AUTH_SECRET).unwrap();
/// let validator = JwtAuthValidator::new(secret);
/// let layer = AuthLayer::new(validator);
/// let middleware = tower::ServiceBuilder::default().layer(layer);
/// let addr = format!("{AUTH_ADDR}:{AUTH_PORT}");
/// let secret = JwtSecret::from_hex(AUTH_SECRET).unwrap();
/// let validator = JwtAuthValidator::new(secret);
/// let layer = AuthLayer::new(validator);
/// let middleware = tower::ServiceBuilder::default().layer(layer);
///
/// let _server = ServerBuilder::default()
/// .set_middleware(middleware)
/// .build(addr.parse::<SocketAddr>().unwrap())
/// .await
/// .unwrap();
/// let _server = ServerBuilder::default()
/// .set_middleware(middleware)
/// .build(addr.parse::<SocketAddr>().unwrap())
/// .await
/// .unwrap();
/// }
/// ```
#[allow(missing_debug_implementations)]

5
crates/rpc/rpc/src/layers/jwt_secret.rs
View File

@ -147,10 +147,7 @@ impl JwtSecret {
/// ```rust
/// use reth_rpc::{Claims, JwtSecret};
///
/// let my_claims = Claims {
/// iat: 0,
/// exp: None
/// };
/// let my_claims = Claims { iat: 0, exp: None };
/// let secret = JwtSecret::random();
/// let token = secret.encode(&my_claims).unwrap();
/// ```

10
crates/stages/src/lib.rs
View File

@ -41,9 +41,13 @@
//! # let pipeline =
//! Pipeline::builder()
//! .with_tip_sender(tip_tx)
//! .add_stages(
//! DefaultStages::new(HeaderSyncMode::Tip(tip_rx), consensus, headers_downloader, bodies_downloader, factory)
//! )
//! .add_stages(DefaultStages::new(
//! HeaderSyncMode::Tip(tip_rx),
//! consensus,
//! headers_downloader,
//! bodies_downloader,
//! factory,
//! ))
//! .build(db, MAINNET.clone());
//! ```
//!

2
crates/storage/db/src/tables/mod.rs
View File

@ -59,7 +59,7 @@ pub const NUM_TABLES: usize = 26;
/// # Example
///
/// ```
/// use reth_db::{ table::Table, TableViewer, Tables };
/// use reth_db::{table::Table, TableViewer, Tables};
/// use std::str::FromStr;
///
/// let headers = Tables::from_str("Headers").unwrap();

6
crates/storage/provider/src/bundle_state/bundle_state_with_receipts.rs
View File

@ -162,9 +162,9 @@ impl BundleStateWithReceipts {
/// # Example
///
/// ```
/// use reth_primitives::{Account, U256, Receipts};
/// use reth_db::{database::Database, test_utils::create_test_rw_db};
/// use reth_primitives::{Account, Receipts, U256};
/// use reth_provider::BundleStateWithReceipts;
/// use reth_db::{test_utils::create_test_rw_db, database::Database};
/// use std::collections::HashMap;
///
/// // Initialize the database
@ -173,7 +173,7 @@ impl BundleStateWithReceipts {
/// // Initialize the bundle state
/// let bundle = BundleStateWithReceipts::new_init(
/// HashMap::from([(
/// [0x11;20].into(),
/// [0x11; 20].into(),
/// (
/// None,
/// Some(Account { nonce: 1, balance: U256::from(10), bytecode_hash: None }),

2
crates/tasks/src/lib.rs
View File

@ -47,7 +47,7 @@ pub mod shutdown;
///
/// ```
/// # async fn t() {
/// use reth_tasks::{TaskSpawner, TokioTaskExecutor};
/// use reth_tasks::{TaskSpawner, TokioTaskExecutor};
/// let executor = TokioTaskExecutor::default();
///
/// let task = executor.spawn(Box::pin(async {

24
crates/transaction-pool/src/lib.rs
View File

@ -279,18 +279,24 @@ where
/// # Example
///
/// ```
/// use reth_provider::StateProviderFactory;
/// use reth_primitives::MAINNET;
/// use reth_provider::StateProviderFactory;
/// use reth_tasks::TokioTaskExecutor;
/// use reth_transaction_pool::{TransactionValidationTaskExecutor, Pool};
/// use reth_transaction_pool::blobstore::InMemoryBlobStore;
/// use reth_transaction_pool::{
/// blobstore::InMemoryBlobStore, Pool, TransactionValidationTaskExecutor,
/// };
/// # fn t<C>(client: C) where C: StateProviderFactory + Clone + 'static {
/// let blob_store = InMemoryBlobStore::default();
/// let pool = Pool::eth_pool(
/// TransactionValidationTaskExecutor::eth(client, MAINNET.clone(), blob_store.clone(), TokioTaskExecutor::default()),
/// blob_store,
/// Default::default(),
/// );
/// let blob_store = InMemoryBlobStore::default();
/// let pool = Pool::eth_pool(
/// TransactionValidationTaskExecutor::eth(
/// client,
/// MAINNET.clone(),
/// blob_store.clone(),
/// TokioTaskExecutor::default(),
/// ),
/// blob_store,
/// Default::default(),
/// );
/// # }
/// ```
pub fn eth_pool(