clef: documentation generator + docs #19020
Conversation
cmd/clef/README.md
Outdated
| --keystore value Directory for the keystore (default: "$HOME/.ethereum/keystore") | ||
| --configdir value Directory for clef configuration (default: "$HOME/.clef") | ||
| --networkid value Network identifier (integer, 1=Frontier, 2=Morden (disused), 3=Ropsten, 4=Rinkeby) (default: 1) | ||
| --keystore value Directory for the keystore (default: "/home/user/.ethereum/keystore") |
There was a problem hiding this comment.
Is there a reason to replace $HOME with some hardcoded value ?
| ### SignDataRequest | ||
|
|
||
| SignDataRequest contains information about a pending request to sign some data.The data to be signed can be of various types, defined by content-type. Clef has done mostof the work in canonicalizing and making sense of the data, and it's up to the UI to presentthe user with the contents of the `message` | ||
|
|
There was a problem hiding this comment.
Spaces in the wrong places, pointed out by scared face emoji:
some data.😱The data to be 😱 signed can be of various types, defined by content-type. Clef has done most😱of the work in canonicalizing and making sense of the data, and it's up to the UI to presentthe user with the contents of the message
cmd/clef/datatypes.md
Outdated
| ``` | ||
| ### SignTxRequest | ||
|
|
||
| SignTxRequest contains information about a pending request to sign a transaction.Aside from the transaction itself, there is also a call_info-struct. That struct containsmessages of various types, that the user should be informed of. |
There was a problem hiding this comment.
SignTxRequest contains information about a pending request to sign a transaction.😱Aside from the transaction itself, there is also a call_info-struct. That struct contains😱messages of various types, that the user should be informed of.
also, I would write it as call_info-struct
cmd/clef/datatypes.md
Outdated
|
|
||
| A ruleset that implements a rate limitation needs to know what transactions are sent out to the external interface. By hooking into this methods, the ruleset can maintain track of that count. | ||
|
|
||
| **OBS:** Note that if an attacker can restore your `clef` data to a previous point in time (e.g through a backup), he can reset such windows, even if he is unable to decrypt the content. |
There was a problem hiding this comment.
Prefer the grammatically correct "he or she" or the more convenient and upcoming "they".
cmd/clef/datatypes.md
Outdated
| ``` | ||
| ### UserInputResponse | ||
|
|
||
| Reponse to list request. The response contains a list of all addresses to show the caller. Note: the UI is free to respond with any address the caller, regardless of whether it exists or not |
* clef: implement documentation generation + remove unused struct * clef: formatting + spelling * clef: updates to doc
This is the third clef-pr in the series, based on top #19018 . It contains a
clef gendocscommand, which will hopefully make it easier to provide up-to-date and extensive documentation about the various data type used in various communication channels.Here's the curerntly generated markdown: https://github.com/ethereum/go-ethereum/blob/deb3c5cd5d0ec1f1cbc82729f65cae63340e07b4/cmd/clef/datatypes.md