Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add net rpc namespace #989

Merged
merged 2 commits into from
Jun 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions crates/alloy/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,10 @@ full = [
"kzg",
"network",
"provider-http", # includes `providers`
"provider-ws", # includes `providers`
"provider-ipc", # includes `providers`
"rpc-types", # includes `rpc-types-eth`
"signer-local", # includes `signers`
"provider-ws", # includes `providers`
"provider-ipc", # includes `providers`
"rpc-types", # includes `rpc-types-eth`
"signer-local", # includes `signers`
]

# configuration
Expand Down Expand Up @@ -155,6 +155,7 @@ provider-engine-api = [
"alloy-provider?/engine-api",
"rpc-types-engine",
]
provider-net-api = ["providers", "alloy-provider?/net-api"]
provider-trace-api = [
"providers",
"alloy-provider?/trace-api",
Expand Down
1 change: 1 addition & 0 deletions crates/provider/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -96,5 +96,6 @@ anvil-node = [
]
debug-api = ["dep:alloy-rpc-types-trace"]
engine-api = ["dep:alloy-rpc-types-engine"]
net-api = []
trace-api = ["dep:alloy-rpc-types-trace"]
txpool-api = ["dep:alloy-rpc-types-txpool"]
5 changes: 5 additions & 0 deletions crates/provider/src/ext/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ mod debug;
#[cfg(feature = "debug-api")]
pub use debug::DebugApi;

#[cfg(feature = "net-api")]
mod net;
#[cfg(feature = "net-api")]
pub use net::NetApi;

#[cfg(feature = "trace-api")]
mod trace;
#[cfg(feature = "trace-api")]
Expand Down
75 changes: 75 additions & 0 deletions crates/provider/src/ext/net.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
//! This module extends the Ethereum JSON-RPC provider with the Net namespace's RPC methods.
use crate::Provider;
use alloy_network::Network;
use alloy_transport::{Transport, TransportResult};

/// Net namespace rpc interface that provides access to network information of the node.
#[cfg_attr(target_arch = "wasm32", async_trait::async_trait(?Send))]
#[cfg_attr(not(target_arch = "wasm32"), async_trait::async_trait)]
pub trait NetApi<N, T>: Send + Sync {
/// Returns a `bool` indicating whether or not the node is listening for network connections.
async fn net_listening(&self) -> TransportResult<bool>;
/// Returns the number of peers connected to the node.
async fn net_peer_count(&self) -> TransportResult<u64>;
/// Returns the network ID (e.g. 1 for mainnet).
async fn net_version(&self) -> TransportResult<u64>;
}

#[cfg_attr(target_arch = "wasm32", async_trait::async_trait(?Send))]
#[cfg_attr(not(target_arch = "wasm32"), async_trait::async_trait)]
impl<N, T, P> NetApi<N, T> for P
where
N: Network,
T: Transport + Clone,
P: Provider<T, N>,
{
async fn net_listening(&self) -> TransportResult<bool> {
self.client().request("net_listening", ()).await
}

async fn net_peer_count(&self) -> TransportResult<u64> {
self.client().request("net_peerCount", ()).map_resp(crate::utils::convert_u64).await
}

async fn net_version(&self) -> TransportResult<u64> {
self.client().request("net_version", ()).map_resp(crate::utils::convert_u64).await
}
}

#[cfg(test)]
mod test {
use crate::ProviderBuilder;

use super::*;
use alloy_node_bindings::Geth;

#[tokio::test]
async fn call_net_version() {
let temp_dir = tempfile::TempDir::with_prefix("geth-test-").unwrap();
let geth = Geth::new().disable_discovery().data_dir(temp_dir.path()).spawn();
let provider = ProviderBuilder::new().on_http(geth.endpoint_url());

let version = provider.net_version().await.expect("net_version call should succeed");
assert_eq!(version, 1);
}

#[tokio::test]
async fn call_net_peer_count() {
let temp_dir = tempfile::TempDir::with_prefix("geth-test-").unwrap();
let geth = Geth::new().disable_discovery().data_dir(temp_dir.path()).spawn();
let provider = ProviderBuilder::new().on_http(geth.endpoint_url());

let count = provider.net_peer_count().await.expect("net_peerCount call should succeed");
assert_eq!(count, 0);
}

#[tokio::test]
async fn call_net_listening() {
let temp_dir = tempfile::TempDir::with_prefix("geth-test-").unwrap();
let geth = Geth::new().disable_discovery().data_dir(temp_dir.path()).spawn();
let provider = ProviderBuilder::new().on_http(geth.endpoint_url());

let listening = provider.net_listening().await.expect("net_listening call should succeed");
assert!(listening);
}
}