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

docs: book pass + rpc chapter (#3070)

Browse Source
This commit is contained in:
Bjerg
2023-06-12 06:30:52 +02:00
committed by GitHub
parent b19e12341d
commit d65032ee82
23 changed files with 1092 additions and 159 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
book/jsonrpc/net.md Normal file
View File

@ -0,0 +1,48 @@
# `net` Namespace
The `net` API provides information about the networking component of the node.
## `net_listening`
Returns a `bool` indicating whether or not the node is listening for network connections.
| Client | Method invocation |
|--------|---------------------------------------------|
| RPC | `{"method": "net_listening", "params": []}` |
### Example
```js
// > {"jsonrpc":"2.0","id":1,"method":"net_listening","params":[]}
{"jsonrpc":"2.0","id":1,"result":true}
```
## `net_peerCount`
Returns the number of peers connected to the node.
| Client | Method invocation |
|--------|---------------------------------------------|
| RPC | `{"method": "net_peerCount", "params": []}` |
### Example
```js
// > {"jsonrpc":"2.0","id":1,"method":"net_peerCount","params":[]}
{"jsonrpc":"2.0","id":1,"result":10}
```
## `net_version`
Returns the network ID (e.g. 1 for mainnet)
| Client | Method invocation |
|--------|-------------------------------------------|
| RPC | `{"method": "net_version", "params": []}` |
### Example
```js
// > {"jsonrpc":"2.0","id":1,"method":"net_version","params":[]}
{"jsonrpc":"2.0","id":1,"result":1}
```