feb9d93d4d
## Description Closes: #XXXX related to #10885 --- ### 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)
57 lines
2.1 KiB
Markdown
57 lines
2.1 KiB
Markdown
<!--
|
|
order: 0
|
|
title: Staking Overview
|
|
parent:
|
|
title: "staking"
|
|
-->
|
|
|
|
# `staking`
|
|
|
|
## Abstract
|
|
|
|
This paper specifies the Staking module of the Cosmos SDK that was first
|
|
described in the [Cosmos Whitepaper](https://cosmos.network/about/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](01_state.md)**
|
|
* [Pool](01_state.md#pool)
|
|
* [LastTotalPower](01_state.md#lasttotalpower)
|
|
* [Params](01_state.md#params)
|
|
* [Validator](01_state.md#validator)
|
|
* [Delegation](01_state.md#delegation)
|
|
* [UnbondingDelegation](01_state.md#unbondingdelegation)
|
|
* [Redelegation](01_state.md#redelegation)
|
|
* [Queues](01_state.md#queues)
|
|
* [HistoricalInfo](01_state.md#historicalinfo)
|
|
2. **[State Transitions](02_state_transitions.md)**
|
|
* [Validators](02_state_transitions.md#validators)
|
|
* [Delegations](02_state_transitions.md#delegations)
|
|
* [Slashing](02_state_transitions.md#slashing)
|
|
3. **[Messages](03_messages.md)**
|
|
* [MsgCreateValidator](03_messages.md#msgcreatevalidator)
|
|
* [MsgEditValidator](03_messages.md#msgeditvalidator)
|
|
* [MsgDelegate](03_messages.md#msgdelegate)
|
|
* [MsgUndelegate](03_messages.md#msgundelegate)
|
|
* [MsgCancelUnbondingDelegation](03_messages.md#msgcancelunbondingdelegation)
|
|
* [MsgBeginRedelegate](03_messages.md#msgbeginredelegate)
|
|
4. **[Begin-Block](04_begin_block.md)**
|
|
* [Historical Info Tracking](04_begin_block.md#historical-info-tracking)
|
|
5. **[End-Block](05_end_block.md)**
|
|
* [Validator Set Changes](05_end_block.md#validator-set-changes)
|
|
* [Queues](05_end_block.md#queues-)
|
|
6. **[Hooks](06_hooks.md)**
|
|
7. **[Events](07_events.md)**
|
|
* [EndBlocker](07_events.md#endblocker)
|
|
* [Msg's](07_events.md#msg's)
|
|
8. **[Parameters](08_params.md)**
|