Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature]: Consider using schema/appdata event model in core/app #21312

Open
Tracked by #20352
aaronc opened this issue Aug 15, 2024 · 1 comment · Fixed by #21719 · May be fixed by #22684
Open
Tracked by #20352

[Feature]: Consider using schema/appdata event model in core/app #21312

aaronc opened this issue Aug 15, 2024 · 1 comment · Fixed by #21719 · May be fixed by #22684

Comments

@aaronc
Copy link
Member

aaronc commented Aug 15, 2024

Summary

We can adopt a more flexible and performant event model by using cosmossdk.io/schema/appdata events in core/app and code which implements that API.

Problem Definition

The event model in core/app simply replicates the key-value Comet/Tendermint event model that we have had for years. While some users may be totally satisfied with this model, many are not as evidenced by ADR 032 which came from representatives three important organizations in the ecosystem.

The major blockers in adopting the resulting typed events more widely were:

  • the implementation pushed JSON marshaling into the state machine layer which was a performance layer
  • the mapping of protobuf JSON to Comet key-value pairs was a bit awkward (it quotes strings for instance)

We have even heard that some users would like the SDK to manage its own events and not send any events to Comet at all.

Proposed Feature

The event model in cosmossdk.io/schema introduces an alternative which allows:

We could adopt it in core/app and consequently STF and AppManager and then implementors can choose whether they render events as key-value pairs, JSON, or skip rendering events at all depending on their performance and UX needs.

@github-project-automation github-project-automation bot moved this to 📋 Backlog in Cosmos-SDK Aug 15, 2024
@aaronc aaronc changed the title [Feature]: Consider schema/appdata event model for core/app [Feature]: Consider using schema/appdata event model in core/app Aug 15, 2024
@julienrbrt julienrbrt mentioned this issue Aug 15, 2024
15 tasks
@github-project-automation github-project-automation bot moved this from 📋 Backlog to 🥳 Done in Cosmos-SDK Sep 16, 2024
@julienrbrt julienrbrt reopened this Sep 17, 2024
@github-project-automation github-project-automation bot moved this from 🥳 Done to 📋 Backlog in Cosmos-SDK Sep 17, 2024
@julienrbrt
Copy link
Member

Re-opening as it hasn't been implemented in stf yet.

@julienrbrt julienrbrt self-assigned this Nov 28, 2024
@julienrbrt julienrbrt moved this from 📋 Backlog to 🤸‍♂️ In Progress in Cosmos-SDK Nov 28, 2024
@julienrbrt julienrbrt linked a pull request Nov 28, 2024 that will close this issue
14 tasks
@julienrbrt julienrbrt moved this from 🤸‍♂️ In Progress to 👀 Waiting / In review in Cosmos-SDK Nov 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 👀 Waiting / In review
2 participants