History

Sunny Aggarwal be27ec1d29 started fixing merge conflicts		2021-03-21 18:33:14 -04:00
..
.vuepress	docs: update dropdown 0.41 → 0.42 (#8884 )	2021-03-15 19:21:08 +00:00
architecture	x/upgrade: added consensus version tracking (part of ADR-041) (#8743 )	2021-03-19 22:01:29 +00:00
basics	doc secp256r1 (#8899 )	2021-03-19 14:22:59 +00:00
building-modules	Docs: Anys Usage, Events & small cleanups (#8895 )	2021-03-17 12:15:20 +00:00
cn	change dir '.appd' to '.app' (#8695 )	2021-02-25 07:52:17 +00:00
core	started fixing merge conflicts	2021-03-21 18:33:14 -04:00
ibc	fixed broken links, typos (#8783 )	2021-03-09 09:51:52 +00:00
intro	ascii scheme didn't fit view area (#8892 )	2021-03-17 08:46:00 +00:00
kr	context: remove verifier & trust node (#6805 )	2020-07-23 06:44:18 +00:00
migrations	fix REST endpoints in migration docs (#8648 )	2021-02-24 15:03:27 +00:00
ru	Merge PR #5379 : New docs V1 (merge master-docs to master)	2019-12-10 09:29:46 -05:00
run-node	keyring: update documentation (#8839 )	2021-03-11 15:17:43 +00:00
spec	Robert/docs slashing (#8329 )	2021-01-16 00:03:08 +01:00
using-the-sdk	docs: Remove deprecated "Interfaces" section (#8294 )	2021-01-18 00:11:26 +00:00
DOCS_README.md	docs: Remove legacy Msg/queriers in "Basics" section (#7782 )	2020-11-27 12:57:14 +00:00
README.md	docs: Add grpc & rest endpoints overview (#8064 )	2020-12-14 10:51:32 +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 elliptic from 6.5.3 to 6.5.4 in /docs (#8824 )	2021-03-17 14:07:28 +00:00
package.json	build(deps): bump vuepress-theme-cosmos from 1.0.179 to 1.0.180 in /docs (#8356 )	2021-01-18 12:47:24 +00:00
post.sh	Final updates for new docs website (#5388 )	2019-12-11 18:35:27 +01:00
pre.sh	Final updates for new docs website (#5388 )	2019-12-11 18:35:27 +01:00
protodoc-markdown.tmpl	Add script to generate proto-docs (#8238 )	2020-12-31 16:10:13 +00:00
versions	add newline at end of docs/versions file (#8900 )	2021-03-17 08:53:51 +00:00

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, the store or the server.
Building Modules: Important concepts for module developers like messages, keepers, handlers and queriers.
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 gaia full-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.