romanz/electrs

Feature: decouple index DB from specific RPC implementation

Open

#554 opened on Oct 15, 2021

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Rust (551 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (1,366 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your feature request related to a problem? Please describe. Today, electrs only supports JSONRPC, so adding more RPC implementations is tricky (e.g. https://github.com/romanz/electrs/issues/257).

Describe the solution you'd like We should probably decouple all index build/query code into a separate library crate, allowing composing it with specific RPC protocols.

Describe alternatives you've considered Using cargo features (similar to how BWT allows both Electrum RPC and HTTP API).

Contributor guide

Research direction
Investigate the current codebase structure, especially the index DB and RPC modules. Study how BWT decouples (as mentioned in the issue). Propose a plan to extract index build/query into a separate crate.
Tech stack
rust
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40