mirrors/tendermint
1
0
Fork 0
mirror of https://github.com/tendermint/tendermint.git synced 2026-01-06 21:36:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: mention unbonding period in MaxAgeNumBlocks/MaxAgeDuration

Browse Source 
Closes #4670
This commit is contained in:
Anton Kaliaev
2020-04-21 17:10:15 +04:00
committed by GitHub
parent 727c15e5e2
commit 0d6e28cb56
2 changed files with 34 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/tendermint-core/using-tendermint.md
View File

@@ -67,10 +67,10 @@ definition](https://github.com/tendermint/tendermint/blob/master/types/genesis.g
#### Sample genesis.json
```
```json
{
"genesis_time": "2018-11-13T18:11:50.277637Z",
"chain_id": "test-chain-s4ui7D",
"genesis_time": "2020-04-21T11:17:42.341227868Z",
"chain_id": "test-chain-ROp9KF",
"consensus_params": {
"block": {
"max_bytes": "22020096",
@@ -78,8 +78,8 @@ definition](https://github.com/tendermint/tendermint/blob/master/types/genesis.g
"time_iota_ms": "1000"
},
"evidence": {
"max_age_num_blocks": "100000"
"max_age_duration": "10000"
"max_age_num_blocks": "100000",
"max_age_duration": "172800000000000"
},
"validator": {
"pub_key_types": [
@@ -89,10 +89,10 @@ definition](https://github.com/tendermint/tendermint/blob/master/types/genesis.g
},
"validators": [
{
"address": "39C04A480B54AB258A45355A5E48ADDED9956C65",
"address": "B547AB87E79F75A4A3198C57A8C2FDAF8628CB47",
"pub_key": {
"type": "tendermint/PubKeyEd25519",
"value": "DMEMMj1+thrkUCGocbvvKzXeaAtRslvX9MWtB+smuIA="
"value": "P/V6GHuZrb8rs/k1oBorxc6vyXMlnzhJmv7LmjELDys="
},
"power": "10",
"name": ""
@@ -333,7 +333,7 @@ When `tendermint init` is run, both a `genesis.json` and
`priv_validator_key.json` are created in `~/.tendermint/config`. The
`genesis.json` might look like:
```
```json
{
"validators" : [
{
@@ -353,7 +353,7 @@ When `tendermint init` is run, both a `genesis.json` and
And the `priv_validator_key.json`:
```
```json
{
"last_step" : 0,
"last_round" : "0",
@@ -480,7 +480,7 @@ tendermint gen_validator
Now we can update our genesis file. For instance, if the new
`priv_validator_key.json` looks like:
```
```json
{
"address" : "5AF49D2A2D4F5AD4C7C8C4CC2FB020131E9C4902",
"pub_key" : {
@@ -499,7 +499,7 @@ Now we can update our genesis file. For instance, if the new
then the new `genesis.json` will be:
```
```json
{
"validators" : [
{

30
types/params.go
View File

@@ -30,14 +30,13 @@ type ConsensusParams struct {
}
// HashedParams is a subset of ConsensusParams.
// It is amino encoded and hashed into
// the Header.ConsensusHash.
// It is amino encoded and hashed into the Header.ConsensusHash.
type HashedParams struct {
BlockMaxBytes int64
BlockMaxGas int64
}
// BlockParams define limits on the block size and gas plus minimum time
// BlockParams defines limits on the block size and gas plus minimum time
// between blocks.
type BlockParams struct {
MaxBytes int64 `json:"max_bytes"`
@@ -47,10 +46,27 @@ type BlockParams struct {
TimeIotaMs int64 `json:"time_iota_ms"`
}
// EvidenceParams determine how we handle evidence of malfeasance.
// EvidenceParams determines how we handle evidence of malfeasance.
//
// Evidence older than MaxAgeNumBlocks && MaxAgeDuration is considered
// stale and ignored.
//
// In Cosmos-SDK based blockchains, MaxAgeDuration is usually equal to the
// unbonding period. MaxAgeNumBlocks is calculated by dividing the unboding
// period by the average block time (e.g. 2 weeks / 6s per block = 2d8h).
type EvidenceParams struct {
MaxAgeNumBlocks int64 `json:"max_age_num_blocks"` // only accept new evidence more recent than this
MaxAgeDuration time.Duration `json:"max_age_duration"`
// Max age of evidence, in blocks.
//
// The basic formula for calculating this is: MaxAgeDuration / {average block
// time}.
MaxAgeNumBlocks int64 `json:"max_age_num_blocks"`
// Max age of evidence, in time.
//
// It should correspond with an app's "unbonding period" or other similar
// mechanism for handling [Nothing-At-Stake
// attacks](https://github.com/ethereum/wiki/wiki/Proof-of-Stake-FAQ#what-is-the-nothing-at-stake-problem-and-how-can-it-be-fixed).
MaxAgeDuration time.Duration `json:"max_age_duration"`
}
// ValidatorParams restrict the public key types validators can use.
@@ -77,7 +93,7 @@ func DefaultBlockParams() BlockParams {
}
}
// DefaultEvidenceParams Params returns a default EvidenceParams.
// DefaultEvidenceParams returns a default EvidenceParams.
func DefaultEvidenceParams() EvidenceParams {
return EvidenceParams{
MaxAgeNumBlocks: 100000, // 27.8 hrs at 1block/s