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

[KVStore] Improve the badger submodule #39

Open
7 tasks
h5law opened this issue Jan 10, 2024 · 0 comments
Open
7 tasks

[KVStore] Improve the badger submodule #39

h5law opened this issue Jan 10, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request kvstore

Comments

@h5law
Copy link
Collaborator

h5law commented Jan 10, 2024

Objective

Improve the badger submodule to make it more attractive to potential users

Goals

  • Improve the documentation
  • Improve the BadgerKVStore interface and wrapper in general
  • Research other KVStore implementations for desired features

Deliverables

  • Add runnable examples in the codebase
  • Add more features to the badger submodule's KVStore
  • Expose more of Badger v4's own features

Non-goals / Non-deliverables

  • Break compatibility with the MapStore interface
  • Disable its usage as a nodestore for the SMT

General deliverables

  • Comments: Add/update TODOs and comments alongside the source code so it is easier to follow.
  • Testing: Add new tests (unit/fuzz/benchmarks) 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: @h5law

@h5law h5law added enhancement New feature or request kvstore labels Jan 10, 2024
@h5law h5law self-assigned this Jan 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request kvstore
Projects
Status: Ready
Development

No branches or pull requests

1 participant