Add a document for espresso-dev-node #1722
Conversation
ImJeremyHe
requested review from
nomaxg,
philippecamacho,
sveitser,
jbearer and
tbro
as code owners
doc/espresso-dev-node.md
Outdated
|
|
||
| ## Parameters | ||
|
|
||
| | Name | Type | Environment Variable | Description | |
There was a problem hiding this comment.
We should also specify what the default behavior is if arguments are not provided.
| | ------ | ------- | ---------------------------------------- | | ||
| | height | integer | The L1 height from which hotshot is down | | ||
|
|
||
| ### POST /api/set-hotshot-up |
There was a problem hiding this comment.
I'm curious if we really need both endpoints. could we just have post /api/hotshot or similar which which reacted on the basis of current state of hotshot (like a toggle). Also since these are POSTs, it might be reasonable to move the command to the POST body. just a thought
There was a problem hiding this comment.
Yes that makes sense. I don't have any though about which is better. But the parameters of these 2 endpoints are totally different. I think we don't have to combine these into only 1.
There was a problem hiding this comment.
Humm yea but it is POST, so if we do something like RPC we could just have a command input, and the request bodies would all differ based on the command. But anyway it not really import
| By calling this, the L1 height in the light contract will be frozen, and rollups will detect the HotShot failure. This | ||
| is intended for testing rollups' functionalities when HotShot is down. | ||
|
|
||
| Parameters |
There was a problem hiding this comment.
I'm assuming these parameters are set in the POST body, but I don't see this stipulated anywhere. I think it could be helpful to show an example request with curl which shows exactly what the request looks like.
| [`builder`](https://docs.espressosys.com/sequencer/api-reference/builder-api), | ||
| [`sequencer`](https://docs.espressosys.com/sequencer/api-reference/sequencer-api), and `prover`. | ||
|
|
||
| In addition, you can access the `dev_node_port` to retrieve debugging information. Here are the details of the dev node |
There was a problem hiding this comment.
Consider linking to the toml specification or generated docs (if we generate documentation from the specification).
There was a problem hiding this comment.
The toml specification is used to generate an HTML doc for users accessing to a wrong route/endpoint. Of course we can also link the toml file here, but just a bit weird. And builder api page doesn't link anything, so I just followed the conventions.
There was a problem hiding this comment.
builder api documentation should also link to spec 😃 (IMO) .
Co-authored-by: tbro <[email protected]>
Co-authored-by: tbro <[email protected]>
ImJeremyHe
force-pushed
the
jh/dev-node-doc
branch
from
27d62fa to
4e6f01c
Compare
#1682
This PR:
This PR does not:
Publish this document
Key places to review:
How to test this PR:
Run the container and then Ctrl+C
It will exit successfully.