cosmos-sdk/docs
Robert Zaremba f3ffb337da
docs: adr-40: reduce multistore and make it atomic (#9355)
* adr-40: use prefix store instead of multistore

* add note about prefix.Store

* Update SC and SS setup information and historical versions sepc

* add note about key prefix optimization

* rephrased the changes related to multistore

* Apply suggestions from code review

Co-authored-by: Ryan Christoffersen <12519942+ryanchristo@users.noreply.github.com>

* Update docs/architecture/adr-040-storage-and-smt-state-commitments.md

* Update docs/architecture/adr-040-storage-and-smt-state-commitments.md

* Update docs/architecture/adr-040-storage-and-smt-state-commitments.md

Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>

* design update

* update merkle proofs

* Apply suggestions from code review

Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>

* reword huffman compression paragraph

* ADR-40: update on multi-store refactor and IBC proofs (#10191)

* Update on multistore refactor and IBC proof

* cleanup whitespace

* Update docs/architecture/adr-040-storage-and-smt-state-commitments.md

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* revise for PR

* add todo

* Update docs/architecture/adr-040-storage-and-smt-state-commitments.md

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* review updates

* add todo for protobuf message type compression

* add link to a discussion

* guarantee atomic commit with IBC workaround proposal

* adding more links to references

* Apply suggestions from code review

Co-authored-by: Roy Crihfield <roy@manteia.ltd>

* reword the module key compression part

Co-authored-by: Ryan Christoffersen <12519942+ryanchristo@users.noreply.github.com>
Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>
Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>
Co-authored-by: Roy Crihfield <roy@manteia.ltd>
2021-10-22 12:45:00 +02:00
..
.vuepress docs: #10221 Create 404 page (#10296) 2021-10-07 07:45:23 +00:00
architecture docs: adr-40: reduce multistore and make it atomic (#9355) 2021-10-22 12:45:00 +02:00
basics docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
building-modules docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
core feat: ADR-040: Implement KV Store with decoupled storage and SMT (#9892) 2021-10-19 11:58:06 +00:00
ibc docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
intro docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
ko docs: clean up translations and readme (#9539) 2021-07-05 10:07:26 +00:00
migrations docs: update migrations doc (#10313) 2021-10-06 13:24:33 +02:00
ru docs: clean up translations and readme (#9539) 2021-07-05 10:07:26 +00:00
run-node docs: Corrext tx multisign documentation example. (#10274) 2021-10-04 11:20:19 +00:00
spec docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
uml docs: uml hotfix (#9124) 2021-04-16 07:59:21 +00:00
using-the-sdk docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
zh docs: clean up translations and readme (#9539) 2021-07-05 10:07:26 +00:00
404.md docs: #10221 Create 404 page (#10296) 2021-10-07 07:45:23 +00:00
cosmos-sdk-image.jpg Merge PR #4643: Update cosmos sdk image, remove unused images 2019-06-30 16:29:05 -04:00
DOC_WRITING_GUIDELINES.md docs: use RFC 2119 keywords (#9532) 2021-06-22 00:04:55 +00:00
DOCS_README.md docs: clean up translations and readme (#9539) 2021-07-05 10:07:26 +00:00
package-lock.json docs: client docs for upgrade module (#10320) 2021-10-12 11:56:40 +00:00
package.json bump vuepress-theme-cosmos (#9099) 2021-04-13 12:18:47 +00:00
post.sh docs: fix cosmovisor quickstart (#9730) 2021-07-26 07:51:36 +00:00
pre.sh docs: fix cosmovisor quickstart (#9730) 2021-07-26 07:51:36 +00:00
protodoc-markdown.tmpl Add script to generate proto-docs (#8238) 2020-12-31 16:10:13 +00:00
README.md docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
versions docs: update to v0.44 version tag (#10069) 2021-09-08 08:34:54 -07:00

Cosmos SDK Documentation

Get Started

  • Cosmos SDK Intro: High-level overview of the Cosmos SDK.
  • Starport: A developer-friendly interface to the Cosmos SDK to scaffold, launch, and maintain any crypto application on a sovereign and secured blockchain.
  • SDK Tutorials: Tutorials that showcase how to build Cosmos SDK-based blockchains from scratch and explain the basic Cosmos SDK principles in the process.

Reference Docs

  • Basics: Basic concepts of the Cosmos SDK, including the standard anatomy of an application, the transaction lifecycle, and accounts management.
  • Core: Core concepts of the Cosmos SDK, including baseapp, the store, or the server.
  • Building Modules: Important concepts for module developers like message, keeper, and querier.
  • IBC: IBC protocol integration and concepts.
  • Running a Node, API, CLI: How to run a node and interact with the node using the CLI and the API.
  • Migrations: Migration guides for updating to newer versions of Cosmos SDK.

Other Resources

Cosmos Hub

The Cosmos Hub (gaia) docs have moved to github.com/cosmos/gaia.

Languages

The Cosmos SDK is 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 the DOCS_README.md for details of the build process and considerations when making changes.