forks/go-ethereum
1
0
Fork 1
mirror of https://github.com/ethereum/go-ethereum.git synced 2026-04-03 08:35:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

p2p/simulations: update doc of HTTP endpoints (#29894)

Browse source
This commit is contained in:
bugmaker9371 2024-06-12 01:41:17 +08:00 committed by GitHub
parent c732039a34
commit b6f2bbd417
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 19 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
p2p/simulations/README.md
View file

@ -123,20 +123,25 @@ The API is initialised with a particular node adapter and has the following
endpoints: endpoints:
``` ```
GET / Get network information OPTIONS / Response 200 with "Access-Control-Allow-Headers"" header set to "Content-Type""
POST /start Start all nodes in the network GET / Get network information
POST /stop Stop all nodes in the network POST /start Start all nodes in the network
GET /events Stream network events POST /stop Stop all nodes in the network
GET /snapshot Take a network snapshot POST /mocker/start Start the mocker node simulation
POST /snapshot Load a network snapshot POST /mocker/stop Stop the mocker node simulation
POST /nodes Create a node GET /mocker Get a list of available mockers
GET /nodes Get all nodes in the network POST /reset Reset all properties of a network to initial (empty) state
GET /nodes/:nodeid Get node information GET /events Stream network events
POST /nodes/:nodeid/start Start a node GET /snapshot Take a network snapshot
POST /nodes/:nodeid/stop Stop a node POST /snapshot Load a network snapshot
POST /nodes/:nodeid/conn/:peerid Connect two nodes POST /nodes Create a node
DELETE /nodes/:nodeid/conn/:peerid Disconnect two nodes GET /nodes Get all nodes in the network
GET /nodes/:nodeid/rpc Make RPC requests to a node via WebSocket GET /nodes/:nodeid Get node information
POST /nodes/:nodeid/start Start a node
POST /nodes/:nodeid/stop Stop a node
POST /nodes/:nodeid/conn/:peerid Connect two nodes
DELETE /nodes/:nodeid/conn/:peerid Disconnect two nodes
GET /nodes/:nodeid/rpc Make RPC requests to a node via WebSocket
``` ```
For convenience, `nodeid` in the URL can be the name of a node rather than its For convenience, `nodeid` in the URL can be the name of a node rather than its