3fd376bd56
<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺ v ✰ Thanks for creating a PR! ✰ v Before smashing the submit button please review the checkboxes. v If a checkbox is n/a - please still include it but + a little note why ☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > --> ## Description <!-- Add a description of the changes that this PR introduces and the files that are the most critical to review. --> closes: #9106 --- Before we can merge this PR, please make sure that all the following items have been checked off. If any of the checklist items are not applicable, please leave them but write a little note why. - [x] Targeted PR against correct branch (see [CONTRIBUTING.md](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work. - [ ] Code follows the [module structure standards](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules/structure.md). - [ ] Wrote unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] Updated relevant documentation (`docs/`) or specification (`x/<module>/spec/`) - [ ] Added relevant `godoc` [comments](https://blog.golang.org/godoc-documenting-go-code). - [ ] Added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md` - [ ] Re-reviewed `Files changed` in the Github PR explorer - [ ] Review `Codecov Report` in the comment section below once CI passes |
||
|---|---|---|
| .. | ||
| .vuepress | ||
| architecture | ||
| basics | ||
| building-modules | ||
| cn | ||
| core | ||
| ibc | ||
| intro | ||
| kr | ||
| migrations | ||
| ru | ||
| run-node | ||
| spec | ||
| uml | ||
| using-the-sdk | ||
| DOCS_README.md | ||
| DOC_WRITING_GUIDELINES.md | ||
| README.md | ||
| cosmos-sdk-image.jpg | ||
| package-lock.json | ||
| package.json | ||
| post.sh | ||
| pre.sh | ||
| protodoc-markdown.tmpl | ||
| versions | ||
README.md
Cosmos SDK Documentation
Get Started
- SDK Intro: High-level overview of the Cosmos SDK.
- Starport: A developer-friendly interface to the Cosmos SDK to scaffold a standard Cosmos SDK blockchain app.
- 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.
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, thestore, or theserver. - Building Modules: Important concepts for module developers like
message,keeper,handler, andquerier. - IBC: Documentation for the IBC protocol integration and concepts.
- Running a Node, API, CLI: Documentation on how to run a node and interact with the node using the CLI and the API.
- Migrations: Migration guides for updating to Stargate.
Other Resources
- Module Directory: Cosmos SDK 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
gaiafull-node through REST.
Cosmos Hub
The Cosmos Hub (gaia) docs have moved to github.com/cosmos/gaia.
Languages
The Cosmos SDK is 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 the DOCS_README.md for details of the build process and considerations when making changes.