cosmos-sdk/docs
Simon Warta 1b9f144b9d
Propose ADR 027: Deterministic Protobuf Serialization (#6979)
* Add ADR 026: Protocol Buffer Regencode

* Use Regencode in ADR-020

* Apply suggestions from code review

Co-authored-by: Aaron Craelius <aaron@regen.network>

* Add reasoning behind omitting empty fields

* Rename to ADR 026: Deterministic Protobuf Serialization

* i++

* explicitely -> explicitly

* Fix description of optional values

* Update reasoning behind omitting default values

* Fix empty -> defaut

* Update docs/architecture/adr-027-deterministic-protobuf-serialization.md

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

* Add rules to avoid duplicate encoding and specify packed fields

* Add rule for variant encoding

* Add surrogate pair to test UTF-8 encoding

Co-authored-by: Aaron Craelius <aaron@regen.network>
Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>
2020-08-19 17:22:15 +00:00
..
.vuepress Docs config (#6846) 2020-07-25 03:55:55 -04:00
architecture Propose ADR 027: Deterministic Protobuf Serialization (#6979) 2020-08-19 17:22:15 +00:00
basics Fixed typos. (#6376) 2020-06-09 12:11:13 +02:00
building-modules Rename *codec.Codec to *codec.LegacyAmino (#6991) 2020-08-10 19:41:21 +00:00
cn context: remove verifier & trust node (#6805) 2020-07-23 06:44:18 +00:00
core tendermint: update to rc3 (#6892) 2020-08-14 13:58:53 -04:00
ibc Update IBC events docs and code (#6798) 2020-07-21 12:56:14 -04: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 build(deps): [security] bump prismjs from 1.20.0 to 1.21.0 in /docs (#6990) 2020-08-10 03:38:19 -04:00
package.json Docs config (#6846) 2020-07-25 03:55:55 -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 Merge PR #4984: Switch docs version to master 2019-09-03 12:43:33 -04: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.
  • 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.