History

mergify[bot] 8f494997a3 docs: update to v0.44 migration (backport #10070 ) (#10129 )		2021-09-13 12:24:23 -04:00
..
.vuepress	docs: update to v0.44 version tag (#10069 ) (#10099 )	2021-09-10 13:22:51 +02:00
architecture	docs: use RFC 2119 keywords (#9532 )	2021-06-22 00:04:55 +00:00
basics	docs: Update baseapp.md and tx-lifecycle.md (#9792 ) (#9802 )	2021-07-28 12:04:30 +02:00
building-modules	docs: add chain upgrade guide v0.43 (backport #9567 ) (#9725 )	2021-07-20 12:30:42 +02:00
cn	fix interfaces links (#9448 )	2021-06-08 12:03:42 +00:00
core	docs: update to v0.44 migration (backport #10070 ) (#10129 )	2021-09-13 12:24:23 -04:00
ibc	chore: add markdownlint to lint commands (#9353 )	2021-05-27 15:31:04 +00:00
intro	chore: add markdownlint to lint commands (#9353 )	2021-05-27 15:31:04 +00:00
kr	fix interfaces links (#9448 )	2021-06-08 12:03:42 +00:00
migrations	docs: update to v0.44 migration (backport #10070 ) (#10129 )	2021-09-13 12:24:23 -04:00
ru	chore: add markdownlint to lint commands (#9353 )	2021-05-27 15:31:04 +00:00
run-node	docs: clarify grpc server (#9761 ) (#10101 )	2021-09-09 12:31:22 -04:00
spec	chore: add markdownlint to lint commands (#9353 )	2021-05-27 15:31:04 +00:00
uml	docs: uml hotfix (#9124 )	2021-04-16 07:59:21 +00:00
using-the-sdk	docs: Fix simulation docs link (#9452 )	2021-06-04 07:24:57 +00:00
DOCS_README.md	fix interfaces links (#9448 )	2021-06-08 12:03:42 +00:00
DOC_WRITING_GUIDELINES.md	docs: use RFC 2119 keywords (#9532 )	2021-06-22 00:04:55 +00:00
README.md	fix interfaces links (#9448 )	2021-06-08 12:03:42 +00:00
cosmos-sdk-image.jpg	Merge PR #4643 : Update cosmos sdk image, remove unused images	2019-06-30 16:29:05 -04:00
package-lock.json	build(deps): bump postcss from 7.0.35 to 7.0.36 in /docs (#9525 )	2021-06-17 05:52:08 +00:00
package.json	bump vuepress-theme-cosmos (#9099 )	2021-04-13 12:18:47 +00:00
post.sh	docs: fix cosmovisor quickstart (backport #9730 ) (#9789 )	2021-07-28 11:27:49 +02:00
pre.sh	docs: fix cosmovisor quickstart (backport #9730 ) (#9789 )	2021-07-28 11:27:49 +02:00
protodoc-markdown.tmpl	Add script to generate proto-docs (#8238 )	2020-12-31 16:10:13 +00:00
versions	docs: update to v0.44 version tag (#10069 ) (#10099 )	2021-09-10 13:22:51 +02:00

README.md

Cosmos SDK Documentation

Get Started

SDK Intro: High-level overview of the Cosmos SDK.
Starport: A developer-friendly interface to the Cosmos SDK to scaffold a standard Cosmos SDK blockchain app.
SDK Application Tutorial: A tutorial that showcases how to build a Cosmos 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, the store, or the server.
Building Modules: Important concepts for module developers like message, keeper, handler, and querier.
IBC: Documentation for the IBC protocol integration and concepts.
Running a Node, API, CLI: Documentation on how to run a node and interact with the node using the CLI and the API.
Migrations: Migration guides for updating to Stargate.

Other Resources

Module Directory: Cosmos SDK 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 gaia full-node through REST.

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.