certusone
/
cosmos-sdk
mirror of https://github.com/certusone/cosmos-sdk.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
cosmos-sdk/docs/building-modules
History
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]: update building modules section to reflect ADR31 (#7702) 2020-11-17 20:41:43 +00:00
beginblock-endblock.md Misc documentation fixes (#8452) 2021-01-28 16:59:51 +00:00
errors.md Update Building Modules documentation (#7473) 2020-10-14 12:38:14 +00:00
genesis.md Update Building Modules documentation (#7473) 2020-10-14 12:38:14 +00:00
intro.md fixed broken links, typos (#8783) 2021-03-09 09:51:52 +00:00
invariants.md Docs: Anys Usage, Events & small cleanups (#8895) 2021-03-17 12:15:20 +00:00
keeper.md [docs]: update building modules section to reflect ADR31 (#7702) 2020-11-17 20:41:43 +00:00
messages-and-queries.md [docs]: update building modules section to reflect ADR31 (#7702) 2020-11-17 20:41:43 +00:00
module-interfaces.md docs: Remove deprecated "Interfaces" section (#8294) 2021-01-18 00:11:26 +00:00
module-manager.md Misc documentation fixes (#8452) 2021-01-28 16:59:51 +00:00
msg-services.md PlantUML diagrams (#8712) 2021-04-06 09:50:56 +00:00
query-services.md docs: cache-wrapping and virtual store (#8102) 2021-01-05 15:57:33 +00:00
simulator.md Docs: Anys Usage, Events & small cleanups (#8895) 2021-03-17 12:15:20 +00:00
structure.md [docs]: update building modules section to reflect ADR31 (#7702) 2020-11-17 20:41:43 +00:00

README.md

Building Modules

This repository contains documentation on concepts developers need to know in order to build modules for Cosmos SDK applications.

  1. Introduction to Cosmos SDK Modules
  2. AppModule Interface and Module Manager
  3. Messages and Queries
  4. Msg services - Processing Messages
  5. Query Services - Processing Queries
  6. BeginBlocker and EndBlocker
  7. Keepers
  8. Invariants
  9. Genesis
  10. Module Interfaces
  11. Standard Module Structure
  12. Errors