This repository has been archived by the owner on Jun 3, 2020. It is now read-only.
tendermint-rs: Add TendermintConfig and Error(Kind) types #298
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tarcieri
force-pushed
the
tendermint-rs/config
branch
3 times, most recently
from
3344f23
to
69693e9
Compare
tony-iqlusion
changed the title
tarcieri
force-pushed
the
tendermint-rs/config
branch
from
69693e9
to
6df0471
Compare
tarcieri
force-pushed
the
tendermint-rs/config
branch
from
6df0471
to
55022b0
Compare
ebuchman
approved these changes
Jul 23, 2019
tendermint-rs/src/config.rs
Outdated
|
|
||
| /// Is this configuration for a validator? | ||
| pub fn is_validator(&self) -> bool { | ||
| self.priv_validator_key_file.is_some() || self.priv_validator_laddr.is_some() |
There was a problem hiding this comment.
default tendermint config has a validator key file but isn't necessarily for a validator
|
|
||
| /// Loglevel configuration | ||
| #[derive(Clone, Debug, Eq, PartialEq)] | ||
| pub struct LogLevel(BTreeMap<String, String>); |
There was a problem hiding this comment.
The main things I like about BTreeMap over HashMap is you always get a deterministic ordering (i.e. the elements are ordered) and by avoiding the use of a hash function they're naturally hashDoS resistant, so I generally use them anywhere the key type impls Ord. That all comes at the cost of slightly more memory usage.
Adds types which describes the structure of `config.toml` files, and support for parsing them with serde and the `toml` crate. This should describe every configuration field generated by the default boilerplate. Additionally this commit changes the `Error` type in `tendermint-rs` from an enum to a struct, renaming the original `Error` enum to `ErrorKind`. This allows incorporating additional information into each error: this commit uses it to add a "msg" field to each error which is needed to get reasonable parse errors from config files, however since it's built on the `failure` crate and using a `failure::Context`, this will also capture a backtrace at the time the error is generated. Last but certainly not least, this adds parsers and serializers for the `node_key.json` and `priv_validator_key.json` configuration files as well, along with a new `tendermint::private_key::PrivateKey` type for Ed25519 keypairs.
tarcieri
force-pushed
the
tendermint-rs/config
branch
from
55022b0
to
e1fd1bb
Compare
Merged
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds types which describes the structure of
config.tomlfiles, and support for parsing them with serde and thetomlcrate.This should describe every configuration field generated by the default boilerplate.
Additionally this commit changes the
Errortype intendermint-rsfrom an enum to a struct, renaming the originalErrorenum toErrorKind. This allows incorporating additional information into each error: this commit uses it to add a "msg" field to each error which is needed to get reasonable parse errors from config files, however since it's built on thefailurecrate and using afailure::Context, this will also capture a backtrace at the time the error is generated.The change from
ErrortoErrorKindis incomplete: several parts of the API are now returningErrorKindinstead of error. All call sites should probably returnErrorinstead ofErrorKindbefore a final crate release.