cosmos-sdk/docs
colin axnér 1c6e267964
Remove IBC logic from x/upgrade (#8673)
* add zeroed custom fields check to tm client

* remove custom fields function from x/upgrade and fix tests

* use []byte in x/upgrade, move abci to 02-client

* remove x/ibc from types

* whoops, delete testing files

* fix upgrade tests

* fix tm tests

* fix tests

* update CHANGELOG

* revert proto breakage, use reserved field cc @amaurym

* add IBC Upgrade Proposal type

* remove IBC from upgrade types

* add IBC upgrade logic to 02-client

* fix all tests for x/upgrade

* Add CLI for IBC Upgrade Proposal

* Update x/ibc/core/02-client/types/proposal_test.go

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

* add gRPC for upgraded client state

* test fixes

* add HandleUpgradeProposal tests

* update docs and remove unnecessary code

* self review bug and test fixes

* neatness

* construct empty rest handler

* fix tests

* fix stringer tests

* Update docs/core/proto-docs.md

Co-authored-by: Christopher Goes <cwgoes@pluranimity.org>

* add key in ibc store tracking ibc upgrade heights

Add a new Key to the IBC client store to track the IBC Upgrade Height. This allows IBC upgrades to correctly remove old IBC upgrade states

* update abci and tests

* revert key storage after discussion with @AdityaSripal

Revert using a key to track IBC upgrades. By clearing any IBC state using an old plan in ScheduleUpgrade, IBC upgrades do not need to be tracked by IBC. This reduces code complexity and reduces potential for bugs.

* clear IBC states on cancelled upgrades

Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>
Co-authored-by: Christopher Goes <cwgoes@pluranimity.org>
2021-03-01 16:28:54 +00:00
..
.vuepress docs: update master docs (#8353) 2021-02-23 10:57:04 +00:00
architecture Merge branch 'master' into adr-epoched-staking 2021-02-25 21:48:57 -06:00
basics docs: Add mention to use gRPC v1.33.2 (#8658) 2021-02-25 07:57:06 +00:00
building-modules Misc documentation fixes (#8452) 2021-01-28 16:59:51 +00:00
cn change dir '.appd' to '.app' (#8695) 2021-02-25 07:52:17 +00:00
core Remove IBC logic from x/upgrade (#8673) 2021-03-01 16:28:54 +00:00
ibc Remove IBC logic from x/upgrade (#8673) 2021-03-01 16:28:54 +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 fix REST endpoints in migration docs (#8648) 2021-02-24 15:03:27 +00:00
ru Merge PR #5379: New docs V1 (merge master-docs to master) 2019-12-10 09:29:46 -05:00
run-node Update cosmovisor.md (#8552) 2021-02-10 09:52:57 +00:00
spec Robert/docs slashing (#8329) 2021-01-16 00:03:08 +01: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 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 docs: update master docs (#8353) 2021-02-23 10:57:04 +00:00
package.json build(deps): bump vuepress-theme-cosmos from 1.0.179 to 1.0.180 in /docs (#8356) 2021-01-18 12:47:24 +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
protodoc-markdown.tmpl Add script to generate proto-docs (#8238) 2020-12-31 16:10:13 +00:00
versions Update master CHANGELOG.md with v0.41, enable building docs for v0.41 (#8562) 2021-02-17 12:41:08 +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.