cosmos-sdk/x/staking/spec
atheeshp d7ba5d2d9c
docs: update `x/staking` begin unbonding docs (#11439)
## Description

Closes: #11350 



---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
2022-03-23 16:29:05 +00:00
..
01_state.md docs: Code blocks in SDK docs are broken (#11189) 2022-02-14 23:39:35 +01:00
02_state_transitions.md docs: update `x/staking` begin unbonding docs (#11439) 2022-03-23 16:29:05 +00:00
03_messages.md docs: Code blocks in SDK docs are broken (#11189) 2022-02-14 23:39:35 +01:00
04_begin_block.md Merge PR #5380: ADR 17 Implementation: Historical Module 2019-12-18 08:20:02 -05:00
05_end_block.md docs: Improve markdownlint configuration (#11104) 2022-02-10 12:07:01 +00:00
06_hooks.md docs: Improve markdownlint configuration (#11104) 2022-02-10 12:07:01 +00:00
07_events.md docs: Improve markdownlint configuration (#11104) 2022-02-10 12:07:01 +00:00
08_params.md feat: Min commission upgrade 0.44 (#10529) 2021-11-12 11:55:55 +00:00
09_client.md style: lint go and markdown (#10060) 2021-10-30 13:43:04 +00:00
README.md docs: Improve markdownlint configuration (#11104) 2022-02-10 12:07:01 +00:00

README.md

staking

Abstract

This paper specifies the Staking module of the Cosmos SDK that was first described in the Cosmos Whitepaper in June 2016.

The module enables Cosmos SDK-based blockchain to support an advanced Proof-of-Stake (PoS) system. In this system, holders of the native staking token of the chain can become validators and can delegate tokens to validators, ultimately determining the effective validator set for the system.

This module is used in the Cosmos Hub, the first Hub in the Cosmos network.

Contents

  1. State
  2. State Transitions
  3. Messages
  4. Begin-Block
  5. End-Block
  6. Hooks
  7. Events
  8. Parameters