cosmos-sdk/docs
Robert Zaremba be4a965599
codec: Rename codec and marshaler interfaces (#9226)
* codec: Rename codec and marshaler interfaces, ref: 8413

* codec: remove BinaryBare

* changelog update

* Update comments and documentation

* adding doc string comments

* Update CHANGELOG.md

Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>

* Update codec/codec.go

Co-authored-by: Marko <marbar3778@yahoo.com>

Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>
Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>
Co-authored-by: Marko <marbar3778@yahoo.com>
2021-04-29 10:46:22 +00:00
..
.vuepress docs: update dropdown 0.41 → 0.42 (#8884) 2021-03-15 19:21:08 +00:00
architecture codec: Rename codec and marshaler interfaces (#9226) 2021-04-29 10:46:22 +00:00
basics docs: update bech32 account docs (#9006) 2021-03-29 11:22:30 +00:00
building-modules codec: Rename codec and marshaler interfaces (#9226) 2021-04-29 10:46:22 +00:00
cn docs: added deprecation notes (#9021) 2021-03-30 09:19:31 +00:00
core codec: Rename codec and marshaler interfaces (#9226) 2021-04-29 10:46:22 +00:00
ibc codec: Rename codec and marshaler interfaces (#9226) 2021-04-29 10:46:22 +00:00
intro ascii scheme didn't fit view area (#8892) 2021-03-17 08:46:00 +00:00
kr docs: added deprecation notes (#9021) 2021-03-30 09:19:31 +00:00
migrations codec: Rename codec and marshaler interfaces (#9226) 2021-04-29 10:46:22 +00:00
ru docs: added deprecation notes (#9021) 2021-03-30 09:19:31 +00:00
run-node Prefer sending tx_bytes to Simulate gRPC endpoint (#8926) 2021-03-25 10:52:54 +00:00
spec docs: update bech32 account docs (#9006) 2021-03-29 11:22:30 +00:00
uml docs: uml hotfix (#9124) 2021-04-16 07:59:21 +00:00
using-the-sdk docs: Remove deprecated "Interfaces" section (#8294) 2021-01-18 00:11:26 +00:00
DOCS_README.md docs: Remove legacy Msg/queriers in "Basics" section (#7782) 2020-11-27 12:57:14 +00:00
README.md Update README.md (#9181) 2021-04-22 21:02:53 +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 bump vuepress-theme-cosmos (#9099) 2021-04-13 12:18:47 +00:00
package.json bump vuepress-theme-cosmos (#9099) 2021-04-13 12:18:47 +00:00
post.sh Final updates for new docs website (#5388) 2019-12-11 18:35:27 +01:00
pre.sh docs: uml hotfix (#9124) 2021-04-16 07:59:21 +00:00
protodoc-markdown.tmpl Add script to generate proto-docs (#8238) 2020-12-31 16:10:13 +00:00
versions add newline at end of docs/versions file (#8900) 2021-03-17 08:53:51 +00:00

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, the store, or the server.
  • Building Modules: Important concepts for module developers like message, keeper, handler, and querier.
  • 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

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.