cosmos-sdk/x
Rikard Hjort c41baa9bc8
PlantUML diagrams (#8712)
* Overview of keepers in object capability model (OCM)

* Updates to the spec, making clarifications

* Create a sequence diagram of a (fresh) delegation

* Misc notes, not yet decided where to put them

* Description of the shares abstraction in validators

* Model all keeper dependencies and move the UML file to docs

* Move and rename delegation sequence diagram

* Move shares description

* Remove TODO

* Diagram touch-ups

* Add how consensus power is calculated

* remove temp file

* Diagram improvements

* Describe slashing in more detail

* Describe redelegation

* Describe unbonding

* Delegation updates

* Delegation updates

* Make a diagram describing overall transaction flow

* Add delegation flows for the events of tokens being bonded/unbonding/etc.

* Grammar fix

* Diagram updates: distinguish alts, remove numbering.

* Use groups instead of "func:" participants

* Remove unused keepers from dependency diagram

* Add title to unbonding diagram

* Move keeper dependencies

* small doc updates

* remove numbers on sequence diagram

* !!!WIP EndBlock

* Explain "Last"-prefix in storage

* Remove `panic` step (they are supposed to never happen)

* EndBlock sequence diagram (with TODOs)

* Add TODO

* More visible TODOs

* Remove numbering

* Complete EndBlock

* Remove numbering

* Remove TODOs and update title

* add title back

* remove endblock seq-diagram

* Make power index update conditional on not being jailed

* update title

* Move files to /docs

* Install PlantUML and compile images to png and txt

* Use transaction flow in documentation

* Use staking UML in staking docs

* Clarify uml with inline doc

* Add keeper deps diagram to docs

* Only produce SVG images

Co-authored-by: hjort <>
Co-authored-by: Marko <marbar3778@yahoo.com>
2021-04-06 09:50:56 +00:00
..
auth x/auth new test - multisig tx on simulate endpoint (#9038) 2021-04-05 17:04:22 +00:00
authz add +nobuild flags to all relevant test cases (#8934) 2021-03-19 11:24:29 +00:00
bank Fix migrations bug discovered with manual tests (#8998) 2021-03-29 11:56:45 +00:00
capability fixed broken links, typos (#8783) 2021-03-09 09:51:52 +00:00
crisis logging (#8785) 2021-03-04 20:40:01 +00:00
distribution Make clearer that the distribution iterates over all active validators (#8866) 2021-03-29 16:57:50 +00:00
evidence fix make protoc error (#8799) 2021-03-05 15:23:01 +00:00
feegrant move feegrant ante to auth ante (#8682) 2021-03-23 07:31:09 +00:00
genaccounts various linter fixes (#8666) 2021-02-23 08:46:01 +00:00
genutil Remove bech32 PubKey support (#7477) 2021-03-25 14:53:22 +00:00
gov Add 0.43 CLI JSON `migrate` command (#8880) 2021-03-22 11:30:26 +00:00
mint various linter fixes (#8666) 2021-02-23 08:46:01 +00:00
params various linter fixes (#8666) 2021-02-23 08:46:01 +00:00
simulation various linter fixes (#8666) 2021-02-23 08:46:01 +00:00
slashing Fix migrations bug discovered with manual tests (#8998) 2021-03-29 11:56:45 +00:00
staking PlantUML diagrams (#8712) 2021-04-06 09:50:56 +00:00
upgrade InitGenesis in migrations when fromVersion==0 (#9007) 2021-04-02 15:41:35 +00:00
README.md Remove IBC from the SDK (#8735) 2021-03-04 13:11:34 +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.