cosmos-sdk/docs/core
Ian Norden 1326fa2a7d
feat: ADR-038 Part 2: StreamingService interface, file writing implementation, and configuration (#8664)
<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
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
2021-10-24 21:37:37 +00:00
..
README.md documentation for in-place migrations with x/upgrade module (#8967) 2021-04-14 08:49:17 +00:00
baseapp.md docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
baseapp_state-begin_block.png Merge PR #4748: Write-Through Inter-Block Cache 2019-09-04 13:33:32 -04:00
baseapp_state-checktx.png Merge PR #4748: Write-Through Inter-Block Cache 2019-09-04 13:33:32 -04:00
baseapp_state-commit.png Merge PR #4748: Write-Through Inter-Block Cache 2019-09-04 13:33:32 -04:00
baseapp_state-deliver_tx.png Merge PR #4748: Write-Through Inter-Block Cache 2019-09-04 13:33:32 -04:00
baseapp_state-initchain.png Merge PR #4748: Write-Through Inter-Block Cache 2019-09-04 13:33:32 -04:00
baseapp_state_types.png Merge PR #4748: Write-Through Inter-Block Cache 2019-09-04 13:33:32 -04:00
cli.md docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
context.md docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
encoding.md docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
events.md docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
grpc_rest.md docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
node.md docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
ocap.md docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
proto-docs.md revert: Remove SIGN_MODE_AMINO_AUX (#10322) 2021-10-18 10:32:43 +00:00
runtx_middleware.md docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
simulation.md docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
store.md feat: ADR-038 Part 2: StreamingService interface, file writing implementation, and configuration (#8664) 2021-10-24 21:37:37 +00:00
telemetry.md perf: Remove more telemetry ops, update docs (#10334) 2021-10-11 08:23:42 +00:00
transactions.md docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
upgrade.md chore(upgrade): cleaning (#10413) 2021-10-22 10:56:08 +00:00

README.md

Core Concepts

This repository contains reference documentation on the core concepts of the Cosmos SDK.

  1. BaseApp
  2. Transaction
  3. Context
  4. Node Client
  5. Store
  6. Encoding
  7. gRPC, REST and Tendermint Endpoints
  8. Command-Line Interface
  9. Events
  10. Telemetry
  11. Object-Capabilities
  12. RunTx recovery middleware
  13. Simulation
  14. Protobuf documentation
  15. In-Place Store Migrations

After reading about the core concepts, check the IBC documentation to learn more about the IBC core concepts and how to integrate IBC in your application.