cosmos-sdk/x
Zach 27c0a90522
docs: add READMEs to each modules' directory (#10721)
<!--
The default pull request template is for types feat, fix, or refactor.
For other templates, add one of the following parameters to the url:
- template=docs.md
- template=other.md
-->

## Description

Closes: #10588

<!-- Add a description of the changes that this PR introduces and the files that
are the most critical to review. -->

---

### 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
- [ ] 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)
- [x] 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)
- [x] updated the relevant documentation or specification
- [x] 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)
2021-12-10 16:10:11 +00:00
..
auth docs: add READMEs to each modules' directory (#10721) 2021-12-10 16:10:11 +00:00
authz docs: add READMEs to each modules' directory (#10721) 2021-12-10 16:10:11 +00:00
bank docs: add READMEs to each modules' directory (#10721) 2021-12-10 16:10:11 +00:00
capability docs: add READMEs to each modules' directory (#10721) 2021-12-10 16:10:11 +00:00
crisis docs: add READMEs to each modules' directory (#10721) 2021-12-10 16:10:11 +00:00
distribution docs: add READMEs to each modules' directory (#10721) 2021-12-10 16:10:11 +00:00
epoching docs: add READMEs to each modules' directory (#10721) 2021-12-10 16:10:11 +00:00
evidence docs: add READMEs to each modules' directory (#10721) 2021-12-10 16:10:11 +00:00
feegrant docs: add READMEs to each modules' directory (#10721) 2021-12-10 16:10:11 +00:00
genutil chore: bump TM to v0.35.0 release candidate (#10210) 2021-11-16 11:24:38 -08:00
gov docs: add READMEs to each modules' directory (#10721) 2021-12-10 16:10:11 +00:00
group feat: Add server implementation of Group module (#10570) 2021-12-10 11:02:11 +00:00
mint docs: add READMEs to each modules' directory (#10721) 2021-12-10 16:10:11 +00:00
nft fix: update nft storekey nftOfClassByOwnerStoreKey (#10682) 2021-12-07 12:59:51 +00:00
params docs: add READMEs to each modules' directory (#10721) 2021-12-10 16:10:11 +00:00
simulation chore: bump TM to v0.35.0 release candidate (#10210) 2021-11-16 11:24:38 -08:00
slashing docs: add READMEs to each modules' directory (#10721) 2021-12-10 16:10:11 +00:00
staking docs: add READMEs to each modules' directory (#10721) 2021-12-10 16:10:11 +00:00
upgrade docs: add READMEs to each modules' directory (#10721) 2021-12-10 16:10:11 +00:00
README.md docs: add READMEs to each modules' directory (#10721) 2021-12-10 16:10:11 +00:00

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 applications.
  • 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.
  • Epoching - Allows modules to queue messages for execution at a certain block height.
  • Evidence - Evidence handling for double signing, misbehaviour, etc.
  • Feegrant - Grant fee allowances for executing transactions.
  • 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.