cosmos-sdk/x
Robert Zaremba 7040387c18
docs(gov): improve gov module spec (#9681)
## Description

Updating the spec to follow the implementation

ref: https://github.com/cosmos/cosmos-sdk/pull/9519#pullrequestreview-704117565


---

### 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...

- [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [x] added `!` to the type prefix if API or client breaking change
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [x] provided a link to the relevant issue or specification
- [x] 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...

- [x] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [x] 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
- [x] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
2021-07-13 15:04:54 +00:00
..
auth types: Inconsistent limit on InfiniteGasMeter and add GasLeft func to GasMeter (#9651) 2021-07-09 10:38:25 -04:00
authz fix: check store keys length before accessing (#9639) 2021-07-08 13:29:12 +02:00
bank feat: add migrations for balances with zero coins (#9664) 2021-07-13 09:22:17 +00:00
capability feat!: remove legacy REST (#9594) 2021-07-06 10:04:54 +00:00
crisis refactor: Update `GetSigners` to return []string (#9418) 2021-07-07 10:18:00 +00:00
distribution fix: check store keys length before accessing (#9639) 2021-07-08 13:29:12 +02:00
evidence refactor: Update `GetSigners` to return []string (#9418) 2021-07-07 10:18:00 +00:00
feegrant refactor: Update `GetSigners` to return []string (#9418) 2021-07-07 10:18:00 +00:00
genutil feat: add migrations for balances with zero coins (#9664) 2021-07-13 09:22:17 +00:00
gov docs(gov): improve gov module spec (#9681) 2021-07-13 15:04:54 +00:00
group feat: Add group module proto definitions and basic types (#9631) 2021-07-09 07:36:16 +00:00
mint feat!: remove legacy REST (#9594) 2021-07-06 10:04:54 +00:00
params feat: add version params to parameters (#9432) 2021-07-08 08:46:45 +00:00
simulation perf: Speedup to params simulation (#9481) 2021-06-17 07:42:07 +00:00
slashing fix: check store keys length before accessing (#9639) 2021-07-08 13:29:12 +02:00
staking fix: check store keys length before accessing (#9639) 2021-07-08 13:29:12 +02:00
upgrade fix: remove stores from renamed/deleted store upgrades (#9409) 2021-07-12 16:54:07 +00:00
README.md chore: add markdownlint to lint commands (#9353) 2021-05-27 15:31:04 +00:00

README.md

List of Modules

Here are some production-grade modules that can be used in Cosmos SDK applications, along with their respective documentation:

  • Auth - Authentication of accounts and transactions for Cosmos SDK application.
  • Authz - Authorization for accounts to perform actions on behalf of other accounts.
  • Bank - Token transfer functionalities.
  • Capability - Object capability implementation.
  • Crisis - Halting the blockchain under certain circumstances (e.g. if an invariant is broken).
  • Distribution - Fee distribution, and staking token provision distribution.
  • Evidence - Evidence handling for double signing, misbehaviour, etc.
  • Governance - On-chain proposals and voting.
  • Mint - Creation of new units of staking token.
  • Params - Globally available parameter store.
  • Slashing - Validator punishment mechanisms.
  • Staking - Proof-of-Stake layer for public blockchains.
  • Upgrade - Software upgrades handling and coordination.

To learn more about the process of building modules, visit the building modules reference documentation.

IBC

The IBC module for the SDK has moved to its own repository.