c41baa9bc8
* 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> |
||
|---|---|---|
| .. | ||
| .vuepress | ||
| architecture | ||
| basics | ||
| building-modules | ||
| cn | ||
| core | ||
| ibc | ||
| intro | ||
| kr | ||
| migrations | ||
| ru | ||
| run-node | ||
| spec | ||
| uml | ||
| using-the-sdk | ||
| DOCS_README.md | ||
| README.md | ||
| cosmos-sdk-image.jpg | ||
| package-lock.json | ||
| package.json | ||
| post.sh | ||
| pre.sh | ||
| protodoc-markdown.tmpl | ||
| versions | ||
README.md
Cosmos SDK Documentation
Get Started
- SDK Intro: High-level overview of the Cosmos SDK.
- Quick Start Guide: Scaffold a standard Cosmos SDK app and run a node.
- SDK Application Tutorial: A tutorial that showcases how to build an SDK-based blockchain from scratch and explains the basic principles of the SDK in the process.
Reference
- Basics: Documentation on the basic concepts of the Cosmos SDK, like the standard anatomy of an application, the transaction lifecycle and accounts management.
- Core: Documentation on the core concepts of the Cosmos SDK, like
baseapp, thestoreor theserver. - Building Modules: Important concepts for module developers like
messages,keepers,handlers andqueriers. - IBC: Documentation for the IBC protocol integration and concepts.
- Running a Node, API, CLI: Documentation on how to run a node, and how to interact with it using the CLI and the API.
- Migrations: Migration guides for updating to Stargate.
Other Resources
- Module Directory: Module implementations and their respective documentation.
- Specifications: Specifications of modules and other parts of the Cosmos SDK.
- SDK API Reference: Godocs of the Cosmos SDK.
- REST API spec: List of endpoints to interact with a
gaiafull-node through REST.
Cosmos Hub
The Cosmos Hub (gaia) docs have moved here.
Languages
The Cosmos-SDK is currently written in Golang, though the framework could be implemented similarly in other languages. Contact us for information about funding an implementation in another language.
Contribute
See this file for details of the build process and considerations when making changes.