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
Ian Norden a3757e14a8
ADR 038: State Listening (#8012) 
* ADR-038 state listening

* updates/fixes

* review fixes/adjustments

* review fixes/adjustments part 2

* review updates part 3: refactor after review to coordinate store changes with block and tx messages and enable file pruning

* review updates part 4: additional details and fixes; addressing recent feedback; use binary protobuf encoding for kv pairs in files

* review updates part 5: formatting fixes; updated StreamingService/Hook interface

* auxiliary streaming/queue service

* review updates part 6: update StoreKVPair to differentiate between Set and Deletes on nil byte values; some minor adjustments

* typo fix
 		2021-02-04 18:09:28 -08:00
..
.vuepress docs: add enhanceApp.js to .vuepress for redirects (#8354) 2021-01-21 09:42:42 +01:00
architecture ADR 038: State Listening (#8012) 2021-02-04 18:09:28 -08:00
basics docs: Remove deprecated "Interfaces" section (#8294) 2021-01-18 00:11:26 +00:00
building-modules Misc documentation fixes (#8452) 2021-01-28 16:59:51 +00:00
cn docs: fix broken url in cn/basics/app-anatomy.md (master) (#7831) 2020-11-06 11:21:53 +00:00
core docs: Update x/staking spec (#8395) 2021-02-01 12:35:18 +00:00
ibc IBC Upgrade docs (#8298) 2021-01-20 14:25:32 +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 Robert/docs slashing (#8329) 2021-01-16 00:03:08 +01:00
ru Merge PR #5379: New docs V1 (merge master-docs to master) 2019-12-10 09:29:46 -05:00
run-node fixing typo at 'os' backend session (#8477) 2021-02-04 09:58:27 +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 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
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 v0.40.0 Changelog backport & docs publish (#8285) 2021-01-09 08:59:07 -03: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.