Add validator RPC updates #278
Conversation
There was a problem hiding this comment.
Left a couple really small nitpicky comments, but largely, this looks great. Thanks so much for the work here!
When we have an official validator publisher live at its final URL, it would be great to replace the examples with versions using the production site, list, and quorum. Until then, it's fine as-is.
content/reference-rippled.md
Outdated
| ## validator_lists ## | ||
| [[Source]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/ValidatorLists.cpp "Source") | ||
|
|
||
| The `validator_lists` command returns human readable information about the current list of published and trusted validators used by the server. [New in: rippled 0.90.0] |
There was a problem hiding this comment.
[New in: rippled 0.90.0]
Please add an extra [] to the end there. (Markdown style / compatibility thing)
content/reference-rippled.md
Outdated
| | `available` | Boolean | If `false`, the validator keys in `list` may no longer be supported by this publisher. | | ||
| | `expiration` | String | Either the human readable time when this published list will expire or the string `unknown` if the server has yet to load a list for this publisher. | | ||
| | `list` | Array | Array of published validator keys. | | ||
| | `pubkey_publisher` | String | Hex encoded public key of publisher. | |
There was a problem hiding this comment.
What type of key must publishers use? ECDSA? Are there other options?
There was a problem hiding this comment.
It supports whatever the PublicKey class supports, which is currently secp25k1 or ed25519, but I think the external tooling for generating keys does ed25519 by default. What is the best designation for that?
There was a problem hiding this comment.
I'd just change the description to something like this:
Ed25519 or ECDSA public key of the list publisher, as hexadecimal.
content/reference-rippled.md
Outdated
| ## validator_sites ## | ||
| [[Source]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/ValidatorSites.cpp "Source") | ||
|
|
||
| The `validator_sites` command returns status information of sites serving validator lists. [New in: rippled 0.90.0] |
There was a problem hiding this comment.
Please change [New in: rippled 0.90.0] to [New in: rippled 0.90.0][] for greater Markdown compatibility
|
I think we are close to having the official list ready, so I'll push the updates after that. Do you prefer I squash down to a single commit? |
|
No need to squash commits |
|
merged as df621af |
Adds documentation for upcoming
validator_listsandvalidator_sitesRPC calls. See XRPLF/rippled#2242. I think the RPC formats have settled, but will update this PR if anything changes.