cosmos-sdk/docs/core
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
..
README.md docs: Remove deprecated "Interfaces" section (#8294) 2021-01-18 00:11:26 +00:00
baseapp.md Docs: Anys Usage, Events & small cleanups (#8895) 2021-03-17 12:15:20 +00:00
baseapp_state-begin_block.png Merge PR #4748: Write-Through Inter-Block Cache 2019-09-04 13:33:32 -04:00
baseapp_state-checktx.png Merge PR #4748: Write-Through Inter-Block Cache 2019-09-04 13:33:32 -04:00
baseapp_state-commit.png Merge PR #4748: Write-Through Inter-Block Cache 2019-09-04 13:33:32 -04:00
baseapp_state-deliver_tx.png Merge PR #4748: Write-Through Inter-Block Cache 2019-09-04 13:33:32 -04:00
baseapp_state-initchain.png Merge PR #4748: Write-Through Inter-Block Cache 2019-09-04 13:33:32 -04:00
baseapp_state_types.png Merge PR #4748: Write-Through Inter-Block Cache 2019-09-04 13:33:32 -04:00
cli.md Update docs (#8751) 2021-03-16 12:14:54 +00:00
context.md Fix typo in context and node docs (#8533) 2021-02-08 09:55:24 +00:00
encoding.md Docs: Anys Usage, Events & small cleanups (#8895) 2021-03-17 12:15:20 +00:00
events.md Docs: Anys Usage, Events & small cleanups (#8895) 2021-03-17 12:15:20 +00:00
grpc_rest.md Update docs (#8751) 2021-03-16 12:14:54 +00:00
node.md docs: update bech32 account docs (#9006) 2021-03-29 11:22:30 +00:00
ocap.md PlantUML diagrams (#8712) 2021-04-06 09:50:56 +00:00
proto-docs.md ADR-038 Part 1: WriteListener, listen.KVStore, MultiStore and KVStore updates (#8551) 2021-03-30 16:13:51 -04:00
runtx_middleware.md docs: Remove deprecated "Interfaces" section (#8294) 2021-01-18 00:11:26 +00:00
simulation.md docs: Remove deprecated "Interfaces" section (#8294) 2021-01-18 00:11:26 +00:00
store.md Docs: Anys Usage, Events & small cleanups (#8895) 2021-03-17 12:15:20 +00:00
telemetry.md docs: Remove deprecated "Interfaces" section (#8294) 2021-01-18 00:11:26 +00:00
transactions.md Create docs for signing & broadcasting txs (#8257) 2021-01-07 16:21:50 +00:00

README.md

Core Concepts

This repository contains reference documentation on the core concepts of the Cosmos SDK.

  1. BaseApp
  2. Transaction
  3. Context
  4. Node Client
  5. Store
  6. Encoding
  7. gRPC, REST and Tendermint Endpoints
  8. Command-Line Interface
  9. Events
  10. Telemetry
  11. Object-Capabilities
  12. RunTx recovery middleware
  13. Simulation
  14. Protobuf documentation

After reading about the core concepts, check the IBC documentation to learn more about the IBC core concepts and how to integrate it to you application.