fc_rpc_v2_api/net.rs
1// This file is part of Frontier.
2
3// Copyright (C) Parity Technologies (UK) Ltd.
4// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
5
6// This program is free software: you can redistribute it and/or modify
7// it under the terms of the GNU General Public License as published by
8// the Free Software Foundation, either version 3 of the License, or
9// (at your option) any later version.
10
11// This program is distributed in the hope that it will be useful,
12// but WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14// GNU General Public License for more details.
15
16// You should have received a copy of the GNU General Public License
17// along with this program. If not, see <https://www.gnu.org/licenses/>.
18
19use ethereum_types::U64;
20use jsonrpsee::{core::RpcResult, proc_macros::rpc};
21
22/// Net RPC interface.
23#[rpc(client, server, namespace = "net")]
24#[async_trait]
25pub trait NetApi {
26 /// Returns the network ID (e.g. 1 for mainnet, 5 for goerli).
27 #[method(name = "version")]
28 async fn version(&self) -> RpcResult<String>;
29
30 /// Returns the number of connected peers.
31 #[method(name = "peerCount")]
32 async fn peer_count(&self) -> RpcResult<U64>;
33
34 /// Returns an indication if the node is listening for network connections.
35 #[method(name = "listening")]
36 async fn listening(&self) -> RpcResult<bool>;
37}