Go to file
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
.github ci: setup cosmovisor goreleaser workflow (#10110) 2021-10-04 12:53:59 +00:00
baseapp feat: ADR-038 Part 2: StreamingService interface, file writing implementation, and configuration (#8664) 2021-10-24 21:37:37 +00:00
client revert: Remove SIGN_MODE_AMINO_AUX (#10322) 2021-10-18 10:32:43 +00:00
codec refactor: move from io/ioutil to io and os package (#10341) 2021-10-13 07:38:22 +00:00
container refactor(container)!: move logging and visualization options to DebugOption (#10302) 2021-10-14 16:49:50 +00:00
contrib refactor: migrate ante hanlders to middlewares (#10028) 2021-10-01 14:30:22 +00:00
cosmovisor fix: fix cosmovisor test (#10424) 2021-10-24 22:52:26 +02:00
crypto perf: avoid unnecessary byteslice->string before fmt %s verb (#10364) 2021-10-14 08:53:38 +00:00
db Fix dbtest util (#10403) 2021-10-19 13:52:49 +00:00
docs feat: ADR-038 Part 2: StreamingService interface, file writing implementation, and configuration (#8664) 2021-10-24 21:37:37 +00:00
internal feat: ADR-040: Implement KV Store with decoupled storage and SMT (#9892) 2021-10-19 11:58:06 +00:00
proto/cosmos revert: Remove SIGN_MODE_AMINO_AUX (#10322) 2021-10-18 10:32:43 +00:00
scripts feat: Introduce Cosmos Scalars (#9933) 2021-09-21 09:46:29 +00:00
server fix: rosetta getHeight function to use tmRPC.GenesisChunked() instead tmRPC.Genesis() (#10340) 2021-10-19 09:30:51 +00:00
simapp feat: ADR-038 Part 2: StreamingService interface, file writing implementation, and configuration (#8664) 2021-10-24 21:37:37 +00:00
snapshots refactor: move from io/ioutil to io and os package (#10341) 2021-10-13 07:38:22 +00:00
std Add ADR 031 BaseApp and codec infrastructure (#7519) 2020-10-15 13:07:59 +00:00
store feat: ADR-038 Part 2: StreamingService interface, file writing implementation, and configuration (#8664) 2021-10-24 21:37:37 +00:00
telemetry refactor!: Keyring migration (#9695) 2021-09-20 12:02:15 +00:00
tests test: fix mockgen version (#9127) 2021-05-25 09:18:59 +00:00
testutil feat: Add Table-Store (aka ORM) package - Table and Indexable (#9751) 2021-10-21 10:19:52 +00:00
third_party/proto feat: Introduce Cosmos Scalars (#9933) 2021-09-21 09:46:29 +00:00
types feat: Add fee.{payer,granter} and tip fields to StdSignDoc (#10348) 2021-10-22 15:13:37 +02:00
version refactor: Implementing sigs.k8s.io YAML to remove .proto yaml annotations (#9780) 2021-09-24 14:37:34 +00:00
x feat: Add fee.{payer,granter} and tip fields to StdSignDoc (#10348) 2021-10-22 15:13:37 +02:00
.build.sh fix library file path (#8301) 2021-01-12 10:08:42 +00:00
.clang-format Fix clang-format to specific version (#7350) 2020-10-27 10:04:34 +00:00
.codecov.yml CI: Fix codecov flag project config (#7994) 2020-11-20 09:13:25 -05:00
.deepsource.toml chore: refactor code quality issues (#8932) 2021-03-22 09:30:27 +00:00
.dockerignore Add basic Dockerfile to build all binaries and export gaiad 2018-04-10 12:39:47 +02:00
.gitattributes Merge PR #6426: Migrate API Server 2020-06-15 13:39:09 -04:00
.gitignore docs: fix cosmovisor quickstart (#9730) 2021-07-26 07:51:36 +00:00
.golangci.yml fix(CI): add golangci-lint to dependencies (#10112) 2021-09-14 11:05:30 +02:00
.goreleaser.yml ci: automate release post tag push (#6230) 2020-05-25 20:02:08 +02:00
.markdownlint.json chore: add markdownlint to lint commands (#9353) 2021-05-27 15:31:04 +00:00
.markdownlintignore chore: add markdownlint to lint commands (#9353) 2021-05-27 15:31:04 +00:00
.mergify.yml chore: update mergify for v0.44 backports (#10146) 2021-09-15 12:43:59 +02:00
buf.yaml refactor: Bring back deprecated proto fields to v1beta1 (#9534) 2021-06-23 13:03:33 +00:00
CHANGELOG.md feat: ADR-038 Part 2: StreamingService interface, file writing implementation, and configuration (#8664) 2021-10-24 21:37:37 +00:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md (#7381) 2020-09-28 11:28:30 +02:00
CODING_GUIDELINES.md docs: update contributing guidelines (#10223) 2021-10-01 11:36:22 +00:00
CONTRIBUTING.md chore: add meeting list and working groups to contributing doc (#10315) 2021-10-13 13:01:29 +00:00
docker-compose.yml perf: Change localnet CIDR from /16 (65k addresses) to /25 (128 addresses) to reduce docker network conflicts (#9667) 2021-07-12 08:51:36 +00:00
Dockerfile build: Update Dockerfile (#9839) 2021-08-03 09:46:16 -04:00
go.mod build(deps): Bump github.com/prometheus/common from 0.31.1 to 0.32.1 (#10419) 2021-10-21 17:03:09 +00:00
go.sum build(deps): Bump github.com/prometheus/common from 0.31.1 to 0.32.1 (#10419) 2021-10-21 17:03:09 +00:00
LICENSE docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
Makefile fix: issue #10258 related to segmentaiton fault on mac m1 arm64 (#10279) 2021-10-20 10:00:04 +00:00
README.md chore: add meeting list and working groups to contributing doc (#10315) 2021-10-13 13:01:29 +00:00
RELEASE_PROCESS.md docs: update contributing guidelines (#10223) 2021-10-01 11:36:22 +00:00
SECURITY.md docs: update contributing guidelines (#10223) 2021-10-01 11:36:22 +00:00

Cosmos SDK

banner

The Cosmos SDK is a framework for building blockchain applications. Tendermint Core (BFT Consensus) and the Cosmos SDK are written in the Golang programming language. Cosmos SDK is used to build Gaia, the first implementation of the Cosmos Hub.

WARNING: The Cosmos SDK has mostly stabilized, but we are still making some breaking changes.

Note: Requires Go 1.17+

Quick Start

To learn how the Cosmos SDK works from a high-level perspective, see the Cosmos SDK High-Level Intro.

If you want to get started quickly and learn how to build on top of Cosmos SDK, visit Cosmos SDK Tutorials. You can also fork the tutorial's repository to get started building your own Cosmos SDK application.

For more information, see the Cosmos SDK Documentation.

Contributing

See CONTRIBUTING.md for details how to contribute and participate in our dev calls. If you want to follow the updates or learn more about the latest design then join our Discord.

Tools and Frameworks

The Cosmos ecosystem is vast. We will only make a few notable mentions here.

  • Tools: notable frameworks and modules.
  • CosmJS: the Swiss Army knife to power JavaScript based client solutions.

Cosmos Hub Mainnet

The Cosmos Hub application, gaia, has moved to its own cosmos/gaia repository. Go there to join the Cosmos Hub mainnet and more.

Inter-Blockchain Communication (IBC)

The IBC module for the Cosmos SDK has moved to its own cosmos/ibc-go repository. Go there to build and integrate with the IBC module.

Starport

Starport is the all-in-one platform to build, launch, and maintain any crypto application on a sovereign and secured blockchain. If you are building a new app or a new module, use Starport to get started and speed up development.

Disambiguation

This Cosmos SDK project is not related to the React-Cosmos project (yet). Many thanks to Evan Coury and Ovidiu (@skidding) for this Github organization name. As per our agreement, this disambiguation notice will stay here.