2019-12-17 03:44:44 -08:00
<!--
layout: homepage
2019-12-11 09:35:27 -08:00
title: Cosmos SDK Documentation
description: Cosmos SDK is the world’ s most popular framework for building application-specific blockchains.
2019-12-10 06:29:46 -08:00
sections:
- title: Introduction
desc: High-level overview of the Cosmos SDK.
2019-12-11 14:58:22 -08:00
url: /intro/overview.html
2019-12-10 06:29:46 -08:00
icon: introduction
- title: Basics
desc: Anatomy of a blockchain, transaction lifecycle, accounts and more.
icon: basics
2019-12-11 14:58:22 -08:00
url: /basics/app-anatomy.html
- title: Core Concepts
2019-12-11 09:35:27 -08:00
desc: Read about the core concepts like `baseapp` , the store, or the server.
2019-12-10 06:29:46 -08:00
icon: core
2019-12-11 14:58:22 -08:00
url: /core/baseapp.html
2019-12-10 06:29:46 -08:00
- title: Building Modules
desc: Discover how to build modules for the Cosmos SDK.
icon: modules
2019-12-11 14:58:22 -08:00
url: /building-modules/intro.html
2021-06-08 05:03:42 -07:00
- title: Running a Node
desc: Running and interacting with nodes using the CLI and API.
2019-12-10 06:29:46 -08:00
icon: interfaces
2021-06-08 05:03:42 -07:00
url: /run-node/
2019-12-10 06:29:46 -08:00
- title: Modules
desc: Explore existing modules to build your application with.
icon: specifications
2019-12-11 09:35:27 -08:00
url: /modules/
2019-12-10 06:29:46 -08:00
stack:
- title: Cosmos Hub
2019-12-11 09:35:27 -08:00
desc: The first of thousands of interconnected blockchains on the Cosmos Network.
2019-12-10 06:29:46 -08:00
color: "#BA3FD9"
label: hub
url: http://hub.cosmos.network
2019-12-17 03:44:44 -08:00
- title: Tendermint Core
2019-12-11 09:35:27 -08:00
desc: The leading BFT engine for building blockchains, powering Cosmos SDK.
2019-12-10 06:29:46 -08:00
color: "#00BB00"
label: core
url: http://docs.tendermint.com
footer:
newsletter: false
2019-12-17 03:44:44 -08:00
aside: false
-->
2019-12-10 06:29:46 -08:00
2019-01-03 08:08:10 -08:00
# Cosmos SDK Documentation
2018-06-16 20:16:04 -07:00
2019-01-03 08:08:10 -08:00
## Get Started
2018-06-16 21:18:24 -07:00
2019-12-10 06:29:46 -08:00
- **[SDK Intro](./intro/overview.md)**: High-level overview of the Cosmos SDK.
2021-04-22 14:02:53 -07:00
- **[Starport](https://github.com/tendermint/starport/blob/develop/docs/README.md)**: A developer-friendly interface to the Cosmos SDK to scaffold a standard Cosmos SDK blockchain app.
- **[SDK Application Tutorial](https://github.com/cosmos/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.
2018-11-14 11:44:17 -08:00
2019-12-10 06:29:46 -08:00
## Reference
2018-11-14 11:44:17 -08:00
2021-04-22 14:02:53 -07:00
- **[Basics](./basics/)**: Documentation on the basic concepts of the Cosmos SDK, like the standard anatomy of an application, the transaction lifecycle, and accounts management.
- **[Core](./core/)**: Documentation on the core concepts of the Cosmos SDK, like `baseapp` , the `store` , or the `server` .
- **[Building Modules](./building-modules/)**: Important concepts for module developers like `message` , `keeper` , `handler` , and `querier` .
2020-12-14 02:51:32 -08:00
- **[IBC](./ibc/)**: Documentation for the IBC protocol integration and concepts.
2021-04-22 14:02:53 -07:00
- **[Running a Node, API, CLI](./run-node/)**: Documentation on how to run a node and interact with the node using the CLI and the API.
2020-12-14 02:51:32 -08:00
- **[Migrations](./migrations/)**: Migration guides for updating to Stargate.
2018-12-19 11:41:30 -08:00
2019-12-10 06:29:46 -08:00
## Other Resources
2018-12-19 11:41:30 -08:00
2021-04-22 14:02:53 -07:00
- **[Module Directory](../x/)**: Cosmos SDK module implementations and their respective documentation.
2019-12-10 06:29:46 -08:00
- **[Specifications](./spec/)**: Specifications of modules and other parts of the Cosmos SDK.
- **[SDK API Reference](https://godoc.org/github.com/cosmos/cosmos-sdk)**: Godocs of the Cosmos SDK.
- **[REST API spec](https://cosmos.network/rpc/)**: List of endpoints to interact with a `gaia` full-node through REST.
2018-12-19 11:41:30 -08:00
2019-09-03 05:59:24 -07:00
## Cosmos Hub
2019-05-21 11:16:55 -07:00
2021-04-22 14:02:53 -07:00
The Cosmos Hub (`gaia`) docs have moved to [github.com/cosmos/gaia ](https://github.com/cosmos/gaia/tree/master/docs ).
2019-05-21 11:16:55 -07:00
2018-12-19 11:41:30 -08:00
## Languages
2021-04-22 14:02:53 -07:00
The Cosmos SDK is written in [Golang ](https://golang.org/ ), though the
2018-12-19 11:41:30 -08:00
framework could be implemented similarly in other languages.
Contact us for information about funding an implementation in another language.
2018-11-14 14:32:41 -08:00
## Contribute
2018-09-19 10:24:31 -07:00
2021-04-22 14:02:53 -07:00
See the [DOCS_README.md ](https://github.com/cosmos/cosmos-sdk/blob/master/docs/DOCS_README.md ) for details of the build process and
2018-09-19 10:24:31 -07:00
considerations when making changes.