From 605dfbbe5454ce9b4dbdca31ffbf104964ba0993 Mon Sep 17 00:00:00 2001 From: rigelrozanski Date: Wed, 30 May 2018 12:04:14 -0700 Subject: [PATCH] changelog, update spec README --- CHANGELOG.md | 6 ++++-- docs/spec/README.md | 6 ++++-- docs/spec/staking/end_block.md | 6 +++--- docs/spec/staking/transactions.md | 2 +- 4 files changed, 12 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 22969a403..dd953b6ab 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -41,9 +41,11 @@ BUG FIXES * query sequence via account store * fixed duplicate pub_key in stake.Validator -## 0.18.0 +FEATURES +* [docs] Reorganize documentation +* [docs] Update staking spec, create WIP spec for slashing, and fees -_TBD_ +## 0.18.0 BREAKING CHANGES diff --git a/docs/spec/README.md b/docs/spec/README.md index e7507bf95..7f773e6aa 100644 --- a/docs/spec/README.md +++ b/docs/spec/README.md @@ -7,11 +7,13 @@ NOTE: the specifications are not yet complete and very much a work in progress. - [Basecoin](basecoin) - Cosmos SDK related specifications and transactions for sending tokens. -- [Staking](staking) - Proof of Stake related specifications including bonding - and delegation transactions, inflation, fees, etc. - [Governance](governance) - Governance related specifications including proposals and voting. - [IBC](ibc) - Specification of the Cosmos inter-blockchain communication (IBC) protocol. +- [Staking](staking) - Proof of Stake related specifications including bonding + and delegation transactions, inflation, etc. +- [Slashing](slashing) - Specifications of validator punishment mechanisms +- [Provisioning](provisioning) - Fee distribution, and atom provision distribution specification - [Other](other) - Other components of the Cosmos Hub, including the reserve pool, All in Bits vesting, etc. diff --git a/docs/spec/staking/end_block.md b/docs/spec/staking/end_block.md index e7c4e1e82..28e3891d1 100644 --- a/docs/spec/staking/end_block.md +++ b/docs/spec/staking/end_block.md @@ -1,7 +1,7 @@ # End-Block -Two staking activities are intended to be processed in the application endblock. - - inform tendermint of validator set changes +Two staking activities are intended to be processed in the application end-block. + - inform Tendermint of validator set changes - process and set atom inflation # Validator Set Changes @@ -10,7 +10,7 @@ The Tendermint validator set may be updated by state transitions that run at the end of every block. The Tendermint validator set may be changed by validators either being revoked due to inactivity/unexpected behaviour (covered in slashing) or changed in validator power. Determining which validator set -changes must be made occures during staking transactions (and slashing +changes must be made occurs during staking transactions (and slashing transactions) - during end-block the already accounted changes are applied and the changes cleared diff --git a/docs/spec/staking/transactions.md b/docs/spec/staking/transactions.md index 8013829ec..11edbb98b 100644 --- a/docs/spec/staking/transactions.md +++ b/docs/spec/staking/transactions.md @@ -19,7 +19,7 @@ Other notes: - `sender` denotes the address of the sender of the transaction - `getXxx`, `setXxx`, and `removeXxx` functions are used to retrieve and modify objects from the store - - `sdk.Rat` refers to a rational numeric type specified by the sdk. + - `sdk.Rat` refers to a rational numeric type specified by the SDK. ### TxCreateValidator