History

Julien Robert 6d0ef15b0a refactor: migrate to `cosmos/gogoproto` (#13070 )		2022-09-08 17:27:48 +00:00
..
.vuepress	docs: improve docs (#12647 )	2022-07-20 14:04:55 +02:00
architecture	refactor: migrate to `cosmos/gogoproto` (#13070 )	2022-09-08 17:27:48 +00:00
assets	docs: adding acceptance tests description (#10534 )	2021-12-10 01:34:34 +00:00
basics	refactor: migrate to `cosmos/gogoproto` (#13070 )	2022-09-08 17:27:48 +00:00
building-chain	docs: add module documentation testing (#12762 )	2022-09-07 01:34:38 +02:00
building-modules	docs: add module documentation testing (#12762 )	2022-09-07 01:34:38 +02:00
core	refactor: migrate to `cosmos/gogoproto` (#13070 )	2022-09-08 17:27:48 +00:00
cosmwasm	docs: add module documentation testing (#12762 )	2022-09-07 01:34:38 +02:00
ibc	docs: add module documentation testing (#12762 )	2022-09-07 01:34:38 +02:00
intro	docs: update sdk & tm version links in docs (#12976 )	2022-08-20 08:42:13 +02:00
migrations	docs: add module documentation testing (#12762 )	2022-09-07 01:34:38 +02:00
run-node	refactor: migrate to `cosmos/gogoproto` (#13070 )	2022-09-08 17:27:48 +00:00
spec	docs: Improve markdownlint configuration (#11104 )	2022-02-10 12:07:01 +00:00
uml	docs: uml hotfix (#9124 )	2021-04-16 07:59:21 +00:00
using-the-sdk	docs: Improve markdownlint configuration (#11104 )	2022-02-10 12:07:01 +00:00
404.md	style: lint go and markdown (#10060 )	2021-10-30 13:43:04 +00:00
DOCS_README.md	docs: improve docs (#12647 )	2022-07-20 14:04:55 +02:00
DOC_WRITING_GUIDELINES.md	docs: Improve markdownlint configuration (#11104 )	2022-02-10 12:07:01 +00:00
README.md	docs: updates outdated docs (#12014 )	2022-05-31 08:59:38 -04: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 terser from 4.8.0 to 4.8.1 in /docs (#12651 )	2022-07-20 14:46:35 +02:00
package.json	build(deps): Bump vuepress-theme-cosmos from 1.0.182 to 1.0.183 in /docs (#10966 )	2022-01-19 11:47:52 +01:00
post.sh	docs: fix cosmovisor quickstart (#9730 )	2021-07-26 07:51:36 +00:00
pre.sh	chore: collapse module spec and readme (#13143 )	2022-09-05 12:26:40 +00:00
protodoc-markdown.tmpl	Add script to generate proto-docs (#8238 )	2020-12-31 16:10:13 +00:00
versions	docs: improve docs (#12647 )	2022-07-20 14:04:55 +02:00

README.md

Cosmos SDK Documentation

Get Started

Cosmos SDK Intro: High-level overview of the Cosmos SDK.
Ignite CLI: 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

Module Directory: Cosmos SDK module implementations and their respective documentation.
Specifications: Specifications of modules and other parts of the Cosmos SDK.
Cosmos SDK API Reference: Godocs of the Cosmos SDK.
REST and RPC Endpoints: List of endpoints to interact with a gaia full-node.
Rosetta API: Rosetta API integration.

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.