reth_rpc/
admin.rs

1use std::sync::Arc;
2
3use alloy_genesis::ChainConfig;
4use alloy_rpc_types_admin::{
5    EthInfo, EthPeerInfo, EthProtocolInfo, NodeInfo, PeerInfo, PeerNetworkInfo, PeerProtocolInfo,
6    Ports, ProtocolInfo,
7};
8use async_trait::async_trait;
9use jsonrpsee::core::RpcResult;
10use reth_chainspec::{EthChainSpec, EthereumHardfork, EthereumHardforks, ForkCondition};
11use reth_network_api::{NetworkInfo, Peers};
12use reth_network_peers::{AnyNode, NodeRecord};
13use reth_network_types::PeerKind;
14use reth_rpc_api::AdminApiServer;
15use reth_rpc_server_types::ToRpcResult;
16use reth_transaction_pool::TransactionPool;
17use revm_primitives::keccak256;
18
19/// `admin` API implementation.
20///
21/// This type provides the functionality for handling `admin` related requests.
22pub struct AdminApi<N, ChainSpec, Pool> {
23    /// An interface to interact with the network
24    network: N,
25    /// The specification of the blockchain's configuration.
26    chain_spec: Arc<ChainSpec>,
27    /// The transaction pool
28    pool: Pool,
29}
30
31impl<N, ChainSpec, Pool> AdminApi<N, ChainSpec, Pool> {
32    /// Creates a new instance of `AdminApi`.
33    pub const fn new(network: N, chain_spec: Arc<ChainSpec>, pool: Pool) -> Self {
34        Self { network, chain_spec, pool }
35    }
36}
37
38#[async_trait]
39impl<N, ChainSpec, Pool> AdminApiServer for AdminApi<N, ChainSpec, Pool>
40where
41    N: NetworkInfo + Peers + 'static,
42    ChainSpec: EthChainSpec + EthereumHardforks + Send + Sync + 'static,
43    Pool: TransactionPool + 'static,
44{
45    /// Handler for `admin_addPeer`
46    fn add_peer(&self, record: NodeRecord) -> RpcResult<bool> {
47        self.network.add_peer_with_udp(record.id, record.tcp_addr(), record.udp_addr());
48        Ok(true)
49    }
50
51    /// Handler for `admin_removePeer`
52    fn remove_peer(&self, record: AnyNode) -> RpcResult<bool> {
53        self.network.remove_peer(record.peer_id(), PeerKind::Basic);
54        Ok(true)
55    }
56
57    /// Handler for `admin_addTrustedPeer`
58    fn add_trusted_peer(&self, record: AnyNode) -> RpcResult<bool> {
59        if let Some(record) = record.node_record() {
60            self.network.add_trusted_peer_with_udp(record.id, record.tcp_addr(), record.udp_addr())
61        }
62        self.network.add_trusted_peer_id(record.peer_id());
63        Ok(true)
64    }
65
66    /// Handler for `admin_removeTrustedPeer`
67    fn remove_trusted_peer(&self, record: AnyNode) -> RpcResult<bool> {
68        self.network.remove_peer(record.peer_id(), PeerKind::Trusted);
69        Ok(true)
70    }
71
72    /// Handler for `admin_peers`
73    async fn peers(&self) -> RpcResult<Vec<PeerInfo>> {
74        let peers = self.network.get_all_peers().await.to_rpc_result()?;
75        let mut infos = Vec::with_capacity(peers.len());
76
77        for peer in peers {
78            infos.push(PeerInfo {
79                id: alloy_primitives::hex::encode(keccak256(peer.remote_id.as_slice())),
80                name: peer.client_version.to_string(),
81                enode: peer.enode,
82                enr: peer.enr,
83                caps: peer.capabilities.capabilities().iter().map(|cap| cap.to_string()).collect(),
84                network: PeerNetworkInfo {
85                    remote_address: peer.remote_addr,
86                    local_address: peer.local_addr.unwrap_or_else(|| self.network.local_addr()),
87                    inbound: peer.direction.is_incoming(),
88                    trusted: peer.kind.is_trusted(),
89                    static_node: peer.kind.is_static(),
90                },
91                protocols: PeerProtocolInfo {
92                    eth: Some(EthPeerInfo::Info(EthInfo { version: peer.status.version as u64 })),
93                    snap: None,
94                    other: Default::default(),
95                },
96            })
97        }
98
99        Ok(infos)
100    }
101
102    /// Handler for `admin_nodeInfo`
103    async fn node_info(&self) -> RpcResult<NodeInfo> {
104        let enode = self.network.local_node_record();
105        let status = self.network.network_status().await.to_rpc_result()?;
106        let mut config = ChainConfig {
107            chain_id: self.chain_spec.chain().id(),
108            terminal_total_difficulty_passed: self
109                .chain_spec
110                .final_paris_total_difficulty()
111                .is_some(),
112            terminal_total_difficulty: self
113                .chain_spec
114                .ethereum_fork_activation(EthereumHardfork::Paris)
115                .ttd(),
116            deposit_contract_address: self.chain_spec.deposit_contract().map(|dc| dc.address),
117            ..self.chain_spec.genesis().config.clone()
118        };
119
120        // helper macro to set the block or time for a hardfork if known
121        macro_rules! set_block_or_time {
122            ($config:expr, [$( $field:ident => $fork:ident,)*]) => {
123                $(
124                    // don't overwrite if already set
125                    if $config.$field.is_none() {
126                        $config.$field = match self.chain_spec.ethereum_fork_activation(EthereumHardfork::$fork) {
127                            ForkCondition::Block(block) => Some(block),
128                            ForkCondition::TTD { fork_block, .. } => fork_block,
129                            ForkCondition::Timestamp(ts) => Some(ts),
130                            ForkCondition::Never => None,
131                        };
132                    }
133                )*
134            };
135        }
136
137        set_block_or_time!(config, [
138            homestead_block => Homestead,
139            dao_fork_block => Dao,
140            eip150_block => Tangerine,
141            eip155_block => SpuriousDragon,
142            eip158_block => SpuriousDragon,
143            byzantium_block => Byzantium,
144            constantinople_block => Constantinople,
145            petersburg_block => Petersburg,
146            istanbul_block => Istanbul,
147            muir_glacier_block => MuirGlacier,
148            berlin_block => Berlin,
149            london_block => London,
150            arrow_glacier_block => ArrowGlacier,
151            gray_glacier_block => GrayGlacier,
152            shanghai_time => Shanghai,
153            cancun_time => Cancun,
154            prague_time => Prague,
155        ]);
156
157        Ok(NodeInfo {
158            id: alloy_primitives::hex::encode(keccak256(enode.id.as_slice())),
159            name: status.client_version,
160            enode: enode.to_string(),
161            enr: self.network.local_enr().to_string(),
162            ip: enode.address,
163            ports: Ports { discovery: enode.udp_port, listener: enode.tcp_port },
164            listen_addr: enode.tcp_addr(),
165            #[expect(deprecated)]
166            protocols: ProtocolInfo {
167                eth: Some(EthProtocolInfo {
168                    network: status.eth_protocol_info.network,
169                    genesis: status.eth_protocol_info.genesis,
170                    config,
171                    head: status.eth_protocol_info.head,
172                    difficulty: None,
173                }),
174                snap: None,
175            },
176        })
177    }
178
179    /// Handler for `admin_peerEvents`
180    async fn subscribe_peer_events(
181        &self,
182        _pending: jsonrpsee::PendingSubscriptionSink,
183    ) -> jsonrpsee::core::SubscriptionResult {
184        Err("admin_peerEvents is not implemented yet".into())
185    }
186
187    /// Handler for `admin_clearTxpool`
188    async fn clear_txpool(&self) -> RpcResult<u64> {
189        let all_hashes = self.pool.all_transaction_hashes();
190        let count = all_hashes.len() as u64;
191        let _ = self.pool.remove_transactions(all_hashes);
192        Ok(count)
193    }
194}
195
196impl<N, ChainSpec, Pool> std::fmt::Debug for AdminApi<N, ChainSpec, Pool> {
197    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
198        f.debug_struct("AdminApi").finish_non_exhaustive()
199    }
200}
reth_rpc/admin.rs

reth_rpc/
admin.rs
