cosmos-sdk/docs
Ian Norden feed37dc56
ADR-038 Part 1: WriteListener, listen.KVStore, MultiStore and KVStore updates (#8551)
* StoreKVPair protobuf message definition and generated go types

* store WriteListener

* update MultiStore, CacheWrap, CacheWrapper interfaces

* adjust KVStores to fit new CacheWrapper interface

* new ListenKVStore

* adjust multistores to fit new MultiStore interface and enable wrapping returned KVStores with the new ListenKVStore

* typo fixes in adr

* ListenKV Store test

* update server mock KVStore and MultiStore

* multistore unit test; fix multistore constructor

* update changelog

* fix bug identified in CI

* improve codecov, minor fixes/adjustments

* review fixes

* review updates; flip set to delete in KVStorePair, updated proto-docs from running 'make proto-gen'
2021-03-30 16:13:51 -04:00
..
.vuepress docs: update dropdown 0.41 → 0.42 (#8884) 2021-03-15 19:21:08 +00:00
architecture ADR-038 Part 1: WriteListener, listen.KVStore, MultiStore and KVStore updates (#8551) 2021-03-30 16:13:51 -04:00
basics docs: update bech32 account docs (#9006) 2021-03-29 11:22:30 +00:00
building-modules Docs: Anys Usage, Events & small cleanups (#8895) 2021-03-17 12:15:20 +00:00
cn docs: added deprecation notes (#9021) 2021-03-30 09:19:31 +00:00
core ADR-038 Part 1: WriteListener, listen.KVStore, MultiStore and KVStore updates (#8551) 2021-03-30 16:13:51 -04:00
ibc docs: IBC overview edits and rewrites for clarity (#9001) 2021-03-30 08:08:33 +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 docs: update bech32 account docs (#9006) 2021-03-29 11:22:30 +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
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 build(deps): bump vuepress-theme-cosmos from 1.0.180 to 1.0.181 in /docs (#8955) 2021-03-24 09:32:46 +00:00
package.json build(deps): bump vuepress-theme-cosmos from 1.0.180 to 1.0.181 in /docs (#8955) 2021-03-24 09:32:46 +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 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.
  • 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.