cosmos-sdk/docs

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.