mirror of
https://github.com/tendermint/tendermint.git
synced 2026-01-04 04:04:00 +00:00
docs: minor doc fixes (#4335)
* docs: minor doc fixes - minor doc fixes that i ran into while reading things - test if we have github actions Signed-off-by: Marko Baricevic <marbar3778@yahoo.com> * no github actions yet * add with * revert and change wording
This commit is contained in:
Marko
GitHub
@@ -21,12 +21,12 @@ representation of the pubkey.
|
||||
This has two significant drawbacks.
|
||||
Amino encoding is less space-efficient, due to requiring support for upgradability.
|
||||
Amino encoding support requires forking protobuf and adding this new interface support
|
||||
option in the langauge of choice.
|
||||
option in the language of choice.
|
||||
|
||||
The reason for continuing to use amino however is that people can create code
|
||||
more easily in languages that already have an up to date amino library.
|
||||
It is possible that this will change in the future, if it is deemed that
|
||||
requiring amino for interacting with tendermint cryptography is unneccessary.
|
||||
requiring amino for interacting with Tendermint cryptography is unnecessary.
|
||||
|
||||
The arguments for space efficiency here are refuted on the basis that there are
|
||||
far more egregious wastages of space in the SDK.
|
||||
@@ -35,9 +35,9 @@ increasing the space attached to each validator / account.
|
||||
|
||||
The alternative to using amino here would be for us to create an enum type.
|
||||
Switching to just an enum type is worthy of investigation post-launch.
|
||||
For referrence, part of amino encoding interfaces is basically a 4 byte enum
|
||||
For reference, part of amino encoding interfaces is basically a 4 byte enum
|
||||
type definition.
|
||||
Enum types would just change that 4 bytes to be a varuint, and it would remove
|
||||
Enum types would just change that 4 bytes to be a variant, and it would remove
|
||||
the protobuf overhead, but it would be hard to integrate into the existing API.
|
||||
|
||||
### Signatures
|
||||
|
||||
@@ -11,6 +11,6 @@ nodes. This blockchain is accessible via various rpc endpoints, mainly
|
||||
`/blockchain?minHeight=_&maxHeight=_` to get a list of headers. But what
|
||||
exactly is stored in these blocks?
|
||||
|
||||
The [specification](../spec/blockchain/blockchain.md) contains a detailed description of each component - that's the best place to get started.
|
||||
The [specification](https://github.com/tendermint/spec/blob/953523c3cb99fdb8c8f7a2d21e3a99094279e9de/spec/blockchain/blockchain.md) contains a detailed description of each component - that's the best place to get started.
|
||||
|
||||
To dig deeper, check out the [types package documentation](https://godoc.org/github.com/tendermint/tendermint/types).
|
||||
|
||||
@@ -18,7 +18,7 @@ commit for a recent block
|
||||
hash where the commit includes a
|
||||
majority of signatures from the last known validator set. From there,
|
||||
all the application state is verifiable with [merkle
|
||||
proofs](../spec/blockchain/encoding.md#iavl-tree).
|
||||
proofs](https://github.com/tendermint/spec/blob/953523c3cb99fdb8c8f7a2d21e3a99094279e9de/spec/blockchain/encoding.md#iavl-tree).
|
||||
|
||||
## Properties
|
||||
|
||||
|
||||
@@ -34,21 +34,21 @@ The following metrics are available:
|
||||
| consensus_rounds | Gauge | 0.21.0 | | Number of rounds |
|
||||
| consensus_num_txs | Gauge | 0.21.0 | | Number of transactions |
|
||||
| consensus_total_txs | Gauge | 0.21.0 | | Total number of transactions committed |
|
||||
| consensus_block_parts | counter | on dev | peer_id | number of blockparts transmitted by peer |
|
||||
| consensus_latest_block_height | gauge | on dev | | /status sync_info number |
|
||||
| consensus_fast_syncing | gauge | on dev | | either 0 (not fast syncing) or 1 (syncing) |
|
||||
| consensus_block_parts | counter | 0.25.0 | peer_id | number of blockparts transmitted by peer |
|
||||
| consensus_latest_block_height | gauge | 0.25.0 | | /status sync_info number |
|
||||
| consensus_fast_syncing | gauge | 0.25.0 | | either 0 (not fast syncing) or 1 (syncing) |
|
||||
| consensus_block_size_bytes | Gauge | 0.21.0 | | Block size in bytes |
|
||||
| p2p_peers | Gauge | 0.21.0 | | Number of peers node's connected to |
|
||||
| p2p_peer_receive_bytes_total | counter | on dev | peer_id, chID | number of bytes per channel received from a given peer |
|
||||
| p2p_peer_send_bytes_total | counter | on dev | peer_id, chID | number of bytes per channel sent to a given peer |
|
||||
| p2p_peer_pending_send_bytes | gauge | on dev | peer_id | number of pending bytes to be sent to a given peer |
|
||||
| p2p_num_txs | gauge | on dev | peer_id | number of transactions submitted by each peer_id |
|
||||
| p2p_pending_send_bytes | gauge | on dev | peer_id | amount of data pending to be sent to peer |
|
||||
| p2p_peer_receive_bytes_total | counter | 0.25.0 | peer_id, chID | number of bytes per channel received from a given peer |
|
||||
| p2p_peer_send_bytes_total | counter | 0.25.0 | peer_id, chID | number of bytes per channel sent to a given peer |
|
||||
| p2p_peer_pending_send_bytes | gauge | 0.25.0 | peer_id | number of pending bytes to be sent to a given peer |
|
||||
| p2p_num_txs | gauge | 0.25.0 | peer_id | number of transactions submitted by each peer_id |
|
||||
| p2p_pending_send_bytes | gauge | 0.25.0 | peer_id | amount of data pending to be sent to peer |
|
||||
| mempool_size | Gauge | 0.21.0 | | Number of uncommitted transactions |
|
||||
| mempool_tx_size_bytes | histogram | on dev | | transaction sizes in bytes |
|
||||
| mempool_failed_txs | counter | on dev | | number of failed transactions |
|
||||
| mempool_recheck_times | counter | on dev | | number of transactions rechecked in the mempool |
|
||||
| state_block_processing_time | histogram | on dev | | time between BeginBlock and EndBlock in ms |
|
||||
| mempool_tx_size_bytes | histogram | 0.25.0 | | transaction sizes in bytes |
|
||||
| mempool_failed_txs | counter | 0.25.0 | | number of failed transactions |
|
||||
| mempool_recheck_times | counter | 0.25.0 | | number of transactions rechecked in the mempool |
|
||||
| state_block_processing_time | histogram | 0.25.0 | | time between BeginBlock and EndBlock in ms |
|
||||
|
||||
## Useful queries
|
||||
|
||||
|
||||
@@ -31,9 +31,9 @@ There are two ways to become validator.
|
||||
_+2/3 is short for "more than 2/3"_
|
||||
|
||||
A block is committed when +2/3 of the validator set sign [precommit
|
||||
votes](../spec/blockchain/blockchain.md#vote) for that block at the same `round`.
|
||||
votes](https://github.com/tendermint/spec/blob/953523c3cb99fdb8c8f7a2d21e3a99094279e9de/spec/blockchain/blockchain.md#vote) for that block at the same `round`.
|
||||
The +2/3 set of precommit votes is called a
|
||||
[_commit_](../spec/blockchain/blockchain.md#commit). While any +2/3 set of
|
||||
[_commit_](https://github.com/tendermint/spec/blob/953523c3cb99fdb8c8f7a2d21e3a99094279e9de/spec/blockchain/blockchain.md#commit). While any +2/3 set of
|
||||
precommits for the same block at the same height&round can serve as
|
||||
validation, the canonical commit is included in the next block (see
|
||||
[LastCommit](../spec/blockchain/blockchain.md#lastcommit)).
|
||||
[LastCommit](https://github.com/tendermint/spec/blob/953523c3cb99fdb8c8f7a2d21e3a99094279e9de/spec/blockchain/blockchain.md#lastcommit)).
|
||||
|
||||
@@ -7,8 +7,18 @@ parent:
|
||||
|
||||
# Overview
|
||||
|
||||
Tendermint comes with some tools for:
|
||||
Tendermint has some tools that are associated with it for:
|
||||
|
||||
- [Benchmarking](./benchmarking.md)
|
||||
- [Monitoring](./monitoring.md)
|
||||
- [Benchmarking](#benchmarking)
|
||||
- [Validation of remote signers](./remote-signer-validation.md)
|
||||
- [Testnets](#testnets)
|
||||
|
||||
|
||||
## Benchmarking
|
||||
|
||||
Benchmarking is done with tm-load-test, for information on how to use the tool please visit the docs: https://github.com/interchainio/tm-load-test
|
||||
|
||||
|
||||
## Testnets
|
||||
|
||||
The testnets tool is aimed at testing Tendermint with different configurations. For more information please visit: https://github.com/interchainio/testnets.
|
||||
|
||||
@@ -1,4 +0,0 @@
|
||||
# tm-load-test
|
||||
|
||||
Tm-bench has been removed in favor of [tm-load-test](https://github.com/interchainio/tm-load-test).
|
||||
for information on how to use tm-load-test please visit the docs: https://github.com/interchainio/tm-load-test
|
||||
Reference in New Issue
Block a user