## Description Closes: #9404 --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [x] reviewed "Files changed" and left comments if necessary - [x] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
82 lines
3.6 KiB
Markdown
82 lines
3.6 KiB
Markdown
<!--
|
||
layout: homepage
|
||
title: Cosmos SDK Documentation
|
||
description: Cosmos SDK is the world’s most popular framework for building application-specific blockchains.
|
||
sections:
|
||
- title: Introduction
|
||
desc: High-level overview of the Cosmos SDK.
|
||
url: /intro/overview.html
|
||
icon: introduction
|
||
- title: Basics
|
||
desc: Anatomy of a blockchain, transaction lifecycle, accounts and more.
|
||
icon: basics
|
||
url: /basics/app-anatomy.html
|
||
- title: Core Concepts
|
||
desc: Read about the core concepts like baseapp, the store, or the server.
|
||
icon: core
|
||
url: /core/baseapp.html
|
||
- title: Building Modules
|
||
desc: Discover how to build modules for the Cosmos SDK.
|
||
icon: modules
|
||
url: /building-modules/intro.html
|
||
- title: Running a Node
|
||
desc: Running and interacting with nodes using the CLI and API.
|
||
icon: interfaces
|
||
url: /run-node/
|
||
- title: Modules
|
||
desc: Explore existing modules to build your application with.
|
||
icon: specifications
|
||
url: /modules/
|
||
stack:
|
||
- title: Cosmos Hub
|
||
desc: The first of thousands of interconnected blockchains on the Cosmos Network.
|
||
color: "#BA3FD9"
|
||
label: hub
|
||
url: http://hub.cosmos.network
|
||
- title: Tendermint Core
|
||
desc: The leading BFT engine for building blockchains, powering Cosmos SDK.
|
||
color: "#00BB00"
|
||
label: core
|
||
url: http://docs.tendermint.com
|
||
footer:
|
||
newsletter: false
|
||
aside: false
|
||
-->
|
||
|
||
# Cosmos SDK Documentation
|
||
|
||
## Get Started
|
||
|
||
* **[Cosmos SDK Intro](./intro/overview.md)**: High-level overview of the Cosmos SDK.
|
||
* **[Starport](https://docs.starport.network/)**: A developer-friendly interface to the Cosmos SDK to scaffold, launch, and maintain any crypto application on a sovereign and secured blockchain.
|
||
* **[SDK Tutorials](https://tutorials.cosmos.network/)**: 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](./basics/)**: Basic concepts of the Cosmos SDK, including the standard anatomy of an application, the transaction lifecycle, and accounts management.
|
||
* **[Core](./core/)**: Core concepts of the Cosmos SDK, including `baseapp`, the `store`, or the `server`.
|
||
* **[Building Modules](./building-modules/)**: Important concepts for module developers like `message`, `keeper`, and `querier`.
|
||
* **[IBC](./ibc/)**: IBC protocol integration and concepts.
|
||
* **[Running a Node, API, CLI](./run-node/)**: How to run a node and interact with the node using the CLI and the API.
|
||
* **[Migrations](./migrations/)**: Migration guides for updating to newer versions of Cosmos SDK.
|
||
|
||
## Other Resources
|
||
|
||
* **[Module Directory](../x/)**: Cosmos SDK module implementations and their respective documentation.
|
||
* **[Specifications](./spec/)**: Specifications of modules and other parts of the Cosmos SDK.
|
||
* **[Cosmos SDK API Reference](https://godoc.org/github.com/cosmos/cosmos-sdk)**: Godocs of the Cosmos SDK.
|
||
* **[REST and RPC Endpoints](https://cosmos.network/rpc/)**: List of endpoints to interact with a `gaia` full-node.
|
||
* **[Rosetta API](./run-node/rosetta.md)**: Rosetta API integration.
|
||
|
||
## Cosmos Hub
|
||
|
||
The Cosmos Hub (`gaia`) docs have moved to [github.com/cosmos/gaia](https://github.com/cosmos/gaia/tree/master/docs).
|
||
|
||
## Languages
|
||
|
||
The Cosmos SDK is written in [Golang](https://golang.org/), 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](https://github.com/cosmos/cosmos-sdk/blob/master/docs/DOCS_README.md) for details of the build process and considerations when making changes.
|