certusone
/
cosmos-sdk
mirror of https://github.com/certusone/cosmos-sdk.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
cosmos-sdk/docs
History
colin axner 5dfc4a2ec9
Standardize connection versioning + channel versioning docs (#6640) 
* update connection versions with feature set flag

* make connection version modular to support channel versioning and registering

* revert IBCVersion renaming, add channel versioning logic

* fix channel version flag

* remove unnecessary godoc

* remove unused func

* fix lint and version test

* add test and fix error

* revert changes

* update docs

* remove unnecessary godoc

* Apply suggestions from code review

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

* update doc

* add test cases for unchecked lines

* go fmt

* begin migration to standardized version

* revert proto changes

* restructure versioning to go from string to proto

* update versionStr to encodedVersion naming

* fix version test build

* fix keeper tests

* fix various tests

* fixes from self review

* update docs

* fix lint

* add more code cov

* rename ToString funcs to Encode/DecodeVersion + GetCompatibleEncodedVersions renaming

* update spec docs

Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>
 		2020-07-14 08:43:26 +00:00
..
.vuepress docs: update .vuepress/config.js (#6493) 2020-07-01 19:01:15 +02:00
architecture rename blacklist to blocked (#6455) 2020-06-17 13:32:49 +00:00
basics Fixed typos. (#6376) 2020-06-09 12:11:13 +02:00
building-modules x/distribution: CLI & Module Tweaks (#6684) 2020-07-10 19:59:26 +00:00
cn docs(cn): match new docs in intro and basics 2020-04-01 20:52:04 +08:00
core docs: improve IBC guide (#6472) 2020-07-07 06:19:36 -04:00
ibc Standardize connection versioning + channel versioning docs (#6640) 2020-07-14 08:43:26 +00:00
interfaces client: rename CliContext to Context (#6290) 2020-06-01 12:46:03 +00:00
intro typo fix (#6223) 2020-05-14 22:14:08 -04:00
kr Update docs/kr/intro and fix typo in docs/intro (#5979) 2020-05-04 22:05:28 +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 docs: improve IBC guide (#6472) 2020-07-07 06:19:36 -04:00
package.json docs: update .vuepress/config.js (#6493) 2020-07-01 19:01:15 +02: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.