1326fa2a7d
<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺ v ✰ Thanks for creating a PR! ✰ v Before smashing the submit button please review the checkboxes. v If a checkbox is n/a - please still include it but + a little note why ☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > --> ## Description <!-- Add a description of the changes that this PR introduces and the files that are the most critical to review. --> Hello 👋 this PR introduces the second stage of changes to support [ADR-038](https://github.com/cosmos/cosmos-sdk/pull/8012) state listening. This is rebased on top of the [first segment](https://github.com/cosmos/cosmos-sdk/pull/8551), which introduces the low level changes to the MultiStore and KVStore interfaces and implementations, the new WriteListener types, and the new listen.KVStore type. In this segment we introduce the StreamingService interface, an implementation that writes out to files, and it's integration and configuration at the BaseApp level. The idea was to have the first segment reviewed independently first but if people think it is easier/more time efficient to review both at the same time then we could start here. Thanks! This work is towards satisfying [ADR-038](https://github.com/cosmos/cosmos-sdk/blob/master/docs/architecture/adr-038-state-listening.md) --- Before we can merge this PR, please make sure that all the following items have been checked off. If any of the checklist items are not applicable, please leave them but write a little note why. - [x] Targeted PR against correct branch (see [CONTRIBUTING.md](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] Linked to Github issue with discussion and accepted design OR link to spec that describes this work. - [x] Code follows the [module structure standards](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules/structure.md). - [x] Wrote unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [x] Updated relevant documentation (`docs/`) or specification (`x/<module>/spec/`) - [x] Added relevant `godoc` [comments](https://blog.golang.org/godoc-documenting-go-code). - [x] Added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md` - [x] Re-reviewed `Files changed` in the Github PR explorer - [x] Review `Codecov Report` in the comment section below once CI passes |
||
|---|---|---|
| .. | ||
| .vuepress | ||
| architecture | ||
| basics | ||
| building-modules | ||
| core | ||
| ibc | ||
| intro | ||
| ko | ||
| migrations | ||
| ru | ||
| run-node | ||
| spec | ||
| uml | ||
| using-the-sdk | ||
| zh | ||
| 404.md | ||
| cosmos-sdk-image.jpg | ||
| DOC_WRITING_GUIDELINES.md | ||
| DOCS_README.md | ||
| package-lock.json | ||
| package.json | ||
| post.sh | ||
| pre.sh | ||
| protodoc-markdown.tmpl | ||
| README.md | ||
| versions | ||
Cosmos SDK Documentation
Get Started
- Cosmos SDK Intro: High-level overview of the Cosmos SDK.
- Starport: A developer-friendly interface to the Cosmos SDK to scaffold, launch, and maintain any crypto application on a sovereign and secured blockchain.
- SDK Tutorials: Tutorials that showcase how to build Cosmos SDK-based blockchains from scratch and explain the basic Cosmos SDK principles in the process.
Reference Docs
- Basics: Basic concepts of the Cosmos SDK, including the standard anatomy of an application, the transaction lifecycle, and accounts management.
- Core: Core concepts of the Cosmos SDK, including
baseapp, thestore, or theserver. - Building Modules: Important concepts for module developers like
message,keeper, andquerier. - IBC: IBC protocol integration and concepts.
- Running a Node, API, CLI: How to run a node and interact with the node using the CLI and the API.
- Migrations: Migration guides for updating to newer versions of Cosmos SDK.
Other Resources
- Module Directory: Cosmos SDK module implementations and their respective documentation.
- Specifications: Specifications of modules and other parts of the Cosmos SDK.
- Cosmos SDK API Reference: Godocs of the Cosmos SDK.
- REST and RPC Endpoints: List of endpoints to interact with a
gaiafull-node. - Rosetta API: Rosetta API integration.
Cosmos Hub
The Cosmos Hub (gaia) docs have moved to github.com/cosmos/gaia.
Languages
The Cosmos SDK is 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 the DOCS_README.md for details of the build process and considerations when making changes.