cosmos-sdk/docs
Amaury e4e39234c8
docs: Add grpc & rest endpoints overview (#8064)
* docs: Add grpc & rest endpoints overview

* Finish overview

* -Merge branch 'master' of ssh://github.com/cosmos/cosmos-sdk into am-7657-grpc

* Update READMEs

* Add grpcurl

* Finish docs

* Add gRPC historical blocks

* Add historical queries

* Small tweaks

* Update docs/core/grpc_rest.md

Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>

Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2020-12-14 10:51:32 +00:00
..
.vuepress docs: docs-staging → master (#8084) 2020-12-08 12:53:33 +00:00
architecture ADR template: add Further Discussions (#8108) 2020-12-09 10:36:48 +00:00
basics docs: Remove legacy Msg/queriers in "Basics" section (#7782) 2020-11-27 12:57:14 +00:00
building-modules Robert/api clientctx (#8107) 2020-12-08 20:17:40 +00:00
cn docs: fix broken url in cn/basics/app-anatomy.md (master) (#7831) 2020-11-06 11:21:53 +00:00
core docs: Add grpc & rest endpoints overview (#8064) 2020-12-14 10:51:32 +00:00
ibc counterParty -> counterparty (#7946) 2020-11-16 15:06:55 +00:00
interfaces docs: Add grpc & rest endpoints overview (#8064) 2020-12-14 10:51:32 +00:00
intro [docs]: update building modules section to reflect ADR31 (#7702) 2020-11-17 20:41:43 +00:00
kr context: remove verifier & trust node (#6805) 2020-07-23 06:44:18 +00:00
migrations docs: Add grpc & rest endpoints overview (#8064) 2020-12-14 10:51:32 +00:00
ru Merge PR #5379: New docs V1 (merge master-docs to master) 2019-12-10 09:29:46 -05:00
run-node docs: Add grpc & rest endpoints overview (#8064) 2020-12-14 10:51:32 +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 docs: Remove legacy Msg/queriers in "Basics" section (#7782) 2020-11-27 12:57:14 +00:00
README.md docs: Add grpc & rest endpoints overview (#8064) 2020-12-14 10:51:32 +00: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.178 to 1.0.179 in /docs (#8125) 2020-12-10 16:33:59 +00:00
package.json build(deps): bump vuepress-theme-cosmos from 1.0.178 to 1.0.179 in /docs (#8125) 2020-12-10 16:33:59 +00: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: add newline to versions file (#7938) 2020-11-17 19:25:32 +00: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.
  • 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

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.