cosmos-sdk/docs
John Adler 2bb9a241bb
ADR-027: Make rules more precise (#7220)
* Update changelog.

* Fix typos.

* Remove 'by default' from packed encoding rule.

* Further specify longer requirement.

* Clarify that bool must have value of 1 if included.

* Fix typo variant -> varint.

* Disambiguate rule 3.

* Add more reasoning for requirements on zeroes.

* Reword rules to make bit restrictions clearer. Add exception for negative int32.

* Add reference for signed integer encoding.

* Clarify rule for signed int requirement.

* Deterministic -> bijective.

* Normalize spacing in 'protobuf 3'.

* Add background to clarify 70 bits.

* Fix nit: all -> most.

* Clarify is -> must.

Co-authored-by: Alessio Treglia <alessio@tendermint.com>
2020-09-11 14:46:37 +00:00
..
.vuepress docs: Docs theme bump, Algolia DocSearch (#7164) 2020-08-25 20:10:20 +00:00
architecture ADR-027: Make rules more precise (#7220) 2020-09-11 14:46:37 +00:00
basics rename RegisterCodec to RegisterLegacyAminoCodec (#7243) 2020-09-07 14:47:12 +00:00
building-modules rename RegisterCodec to RegisterLegacyAminoCodec (#7243) 2020-09-07 14:47:12 +00:00
cn rename RegisterCodec to RegisterLegacyAminoCodec (#7243) 2020-09-07 14:47:12 +00:00
core rename RegisterCodec to RegisterLegacyAminoCodec (#7243) 2020-09-07 14:47:12 +00:00
ibc Add standard acknowledgement to channels and apply usage in ibc transfer (#7263) 2020-09-09 10:01:28 +00:00
interfaces context: remove verifier & trust node (#6805) 2020-07-23 06:44:18 +00:00
intro typo fix (#6223) 2020-05-14 22:14:08 -04:00
kr context: remove verifier & trust node (#6805) 2020-07-23 06:44:18 +00:00
ru Merge PR #5379: New docs V1 (merge master-docs to master) 2019-12-10 09:29:46 -05:00
spec x/ibc: IBC alpha (#5277) 2020-04-08 20:57:52 -04:00
using-the-sdk Merge PR #5604: docs: minor doc formatting & touchup of the scaffold section 2020-02-04 13:16:56 -05:00
DOCS_README.md Merge PR #5379: New docs V1 (merge master-docs to master) 2019-12-10 09:29:46 -05:00
README.md docs: update .vuepress/config.js (#6493) 2020-07-01 19:01:15 +02: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 from 1.0.169 to 1.0.172 in /docs (#7154) 2020-08-25 04:34:34 -04:00
package.json Bump vuepress-theme-cosmos from 1.0.169 to 1.0.172 in /docs (#7154) 2020-08-25 04:34:34 -04: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

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.
  • Interfaces: Documentation on building interfaces for Cosmos SDK applications.

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.