go-ethereum/docs/xdc/net/net.md
JukLee0ira b114eb0e5b
docs: update jsonrpc api document (#1468)
* module admin

* module eth

* module net

* module txpool

* module XDPoS

* module miner

* module debug
2025-09-11 08:45:23 +08:00

103 lines
1.2 KiB
Markdown

# Module net
The `net` API provides insight about the networking aspect of the client.
## Method net_listening
The `listening` method returns an indication if the node is listening for network connections.
Parameters:
None
Returns:
result: bool, always listening
Example:
```shell
curl -s -X POST -H "Content-Type: application/json" ${RPC} -d '{
"jsonrpc": "2.0",
"id": 1001,
"method": "net_listening"
}' | jq
```
Response:
```json
{
"jsonrpc": "2.0",
"id": 1001,
"result": true
}
```
## Method net_peerCount
The `peerCount` method returns the number of connected peers.
Parameters:
None
Returns:
result: uint
Example:
```shell
curl -s -X POST -H "Content-Type: application/json" ${RPC} -d '{
"jsonrpc": "2.0",
"id": 1001,
"method": "net_peerCount"
}' | jq
```
Response:
```json
{
"jsonrpc": "2.0",
"id": 1001,
"result": "0x10"
}
```
## Method net_version
The `version` method returns the devp2p network ID
Parameters:
None
Returns:
result: string
Example:
```shell
curl -s -X POST -H "Content-Type: application/json" ${RPC} -d '{
"jsonrpc": "2.0",
"id": 1001,
"method": "net_version"
}' | jq
```
Response:
```json
{
"jsonrpc": "2.0",
"id": 1001,
"result": "50"
}
```