cosmos-sdk/x/auth/spec
Alexander Kolesov 47bfcba519
docs: Fix vesting doc. (#9883)
## Description

Closes: https://github.com/cosmos/cosmos-sdk/issues/9882

Add info about PermanentLockedAccount. Add info about MsgCreateVestingAccount.

---

### 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)
- [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [x] added a changelog entry to `CHANGELOG.md`
- [x] 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
- [x] 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
- [x] 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-08-09 17:44:11 +00:00
..
01_concepts.md x/{auth, bank, distr} docs basic cleanup (#8268) 2021-01-11 12:11:22 +00:00
02_state.md docs: Revert SPEC-SPEC and update x/{auth,bank,evidence,slashing} (#7407) 2020-10-16 12:42:48 +00:00
03_antehandlers.md Update x/auth AnteHandler Spec (#9298) 2021-05-12 09:10:11 +00:00
04_keepers.md docs: fix module spec ordering (#9870) 2021-08-09 08:09:17 +00:00
05_vesting.md docs: Fix vesting doc. (#9883) 2021-08-09 17:44:11 +00:00
06_params.md docs: fix module spec ordering (#9870) 2021-08-09 08:09:17 +00:00
README.md docs: Revert SPEC-SPEC and update x/{auth,bank,evidence,slashing} (#7407) 2020-10-16 12:42:48 +00:00

README.md

auth

Abstract

This document specifies the auth module of the Cosmos SDK.

The auth module is responsible for specifying the base transaction and account types for an application, since the SDK itself is agnostic to these particulars. It contains the ante handler, where all basic transaction validity checks (signatures, nonces, auxiliary fields) are performed, and exposes the account keeper, which allows other modules to read, write, and modify accounts.

This module will be used in the Cosmos Hub.

Contents

  1. Concepts
  2. State
  3. AnteHandlers
  4. Keepers
  5. Vesting
  6. Parameters