oasisprotocol / oasisprotocol/oasis-core

Change Go OverlayTree implementation to behave like the Rust one

Open
#3,501 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

c:storage
Dominant language
Go
Stars
369
Forks
151
Avg merge
1d 3h
Merged PRs (30d)
6

Description

#3499 introduces a Rust OverlayTree implementation with some improvements over the Go one. We should make sure to also update the Go implementation with the improvements, specifically:

  • Using an in-memory B-Tree for the overlay (a B-Tree because we need to support iterators). Currently a regular Tree is used which may be suboptimal.
  • (maybe) Removing WriteLog support from the regular Tree and make sure that you need to use the OverlayTree if you want to get a WriteLog.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the Go OverlayTree and regular Tree implementations with the Rust OverlayTree introduced in issue #3499. Investigate the in-memory B-Tree and the proposed WriteLog separation, then verify that the Go implementation supports the required iterators and matches the intended Rust behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, rust
Domain
blockchain
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.