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

[Off-chain] Consolidate and expose off-chain persistence #1014

Open
7 tasks
bryanchriswhite opened this issue Dec 18, 2024 · 0 comments
Open
7 tasks

[Off-chain] Consolidate and expose off-chain persistence #1014

bryanchriswhite opened this issue Dec 18, 2024 · 0 comments
Assignees
Labels
code health Cleans up some code off-chain Off-chain business logic tooling Tooling - CLI, scripts, helpers, off-chain, etc...

Comments

@bryanchriswhite
Copy link
Contributor

Objective

Consolidate all off-chain persistent storage into a single "multi-store".

Origin Document

image

Goals

  • Eliminate feature-specific and/or generally duplicated off-chain persistence artifacts.
  • Provide an conventional pathway for new features to integrate with off-chain persistence.
  • Minimize maintenance and operational complexity.

Deliverables

  • A PR which adds a generic, off-chain, "multi-store" persistence interface and initial implementation using existing off-chain persistence tooling (badgerdb, I think).
  • A PR which adds developer documentation detailing how to use the multi-store to add and interact with a new sub-store.
  • A PR(s) which consolidate(s) existing off-chain persistence to "multi-store" usage.

Non-goals / Non-deliverables

  • Refactoring existing persistence logic or mechanisms beyond what is necessary to achieve the outlined goals.

General deliverables

  • Comments: Add/update TODOs and comments alongside the source code so it is easier to follow.
  • Testing: Add new tests (unit and/or E2E) to the test suite.
  • Makefile: Add new targets to the Makefile to make the new functionality easier to use.
  • Documentation: Update architectural or development READMEs; use mermaid diagrams where appropriate.

Creator: @bryanchriswhite
Co-Owners: @red-0ne

@bryanchriswhite bryanchriswhite added off-chain Off-chain business logic code health Cleans up some code tooling Tooling - CLI, scripts, helpers, off-chain, etc... labels Dec 18, 2024
@bryanchriswhite bryanchriswhite added this to the Shannon MainNet milestone Dec 18, 2024
@bryanchriswhite bryanchriswhite self-assigned this Dec 18, 2024
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Shannon Dec 18, 2024
@bryanchriswhite bryanchriswhite changed the title [REPLACE_WITH_IDENTIFIER] Provide a descriptive title [Off-chain] Consolidate and expose off-chain persistence Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code health Cleans up some code off-chain Off-chain business logic tooling Tooling - CLI, scripts, helpers, off-chain, etc...
Projects
Status: 📋 Backlog
Development

No branches or pull requests

1 participant