History

Sunny Aggarwal c1557a2b90 Merge branch 'master' into adr_gov_split_vote		2020-11-11 13:35:22 -04:00
..
.vuepress	docs: Docs theme bump, Algolia DocSearch (#7164 )	2020-08-25 20:10:20 +00:00
architecture	reassign to adr 037	2020-11-11 13:35:07 -04:00
basics	docs: Basic/App-anatomy explains Msg Service by default (#7670 )	2020-10-28 11:47:22 +00:00
building-modules	Rename RegisterGRPCRoutes (#7696 )	2020-10-28 11:39:49 +00:00
cn	docs: fix broken url in cn/basics/app-anatomy.md (master) (#7831 )	2020-11-06 11:21:53 +00:00
core	Update Building Modules documentation (#7473 )	2020-10-14 12:38:14 +00:00
ibc	Async Ack Fixes (#7735 )	2020-11-02 15:13:48 +00:00
interfaces	docs: Add new section "Running a Node" (#7701 )	2020-11-04 14:02:22 +00:00
intro	typo fix (#6223 )	2020-05-14 22:14:08 -04:00
kr	context: remove verifier & trust node (#6805 )	2020-07-23 06:44:18 +00:00
ru	Merge PR #5379 : New docs V1 (merge master-docs to master)	2019-12-10 09:29:46 -05:00
run-node	Small fixes in docs and error messages (#7826 )	2020-11-06 01:25:38 +00:00
spec	docs: Revert SPEC-SPEC and update x/{auth,bank,evidence,slashing} (#7407 )	2020-10-16 12:42:48 +00:00
using-the-sdk	Update cosmovisor.md (#7837 )	2020-11-06 11:05:41 +00:00
DOCS_README.md	Merge PR #5379 : New docs V1 (merge master-docs to master)	2019-12-10 09:29:46 -05:00
README.md	docs: update .vuepress/config.js (#6493 )	2020-07-01 19:01:15 +02: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 vuepress-theme-cosmos from 1.0.173 to 1.0.175 in /docs (#7806 )	2020-11-04 10:40:25 +01:00
package.json	build(deps): bump vuepress-theme-cosmos from 1.0.173 to 1.0.175 in /docs (#7806 )	2020-11-04 10:40:25 +01: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
versions	docs: remove v0.40.x from versions	2020-11-09 10:26:34 -08: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.
Interfaces: Documentation on building interfaces for Cosmos SDK applications.

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.