RGB-Tools / RGB-Tools/rust-lightning
Abstract RGB File Persistence to KVStore
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 9
- Forks
- 18
- PR merge metrics
- No merged PRs in 30d
Description
This proposal discusses abstracting the RGB-related file persistence in lightning/src/rgb_utils/mod.rs to use the existing KVStoreSync trait instead of direct filesystem operations. This would allow RGB data to be stored in a database (or any KVStoreSync implementation) alongside other LDK data.
Currently, RGB-related data is persisted directly to the filesystem using std::fs operations, while other LDK data (channel monitors, channel manager, etc.) uses the KVStoreSync trait abstraction. This creates an inconsistency:
- LDK data: Uses
KVStoreSync→ can be backed by filesystem, database, or custom storage - RGB data: Hardcoded to filesystem → limited to file-based storage only
For applications that want to use a database backend (e.g., SQLite via Sea-ORM) for all LDK persistence, the RGB files remain on the filesystem, requiring hybrid storage management.
Proposal
- Refactor RGB persistence functions to use
KVStoreSyncwith RGB-specific namespaces or fallback to fs for backwards compatibility. - Functions would change from path-based to KVStore-based or keep both for backwards compatibility.
The main question for discussion is whether this change should be backwards compatible or a clean break.
Once we agree on the approach, I can prepare and submit a PR.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with lightning/src/rgb_utils/mod.rs and compare its std::fs persistence with existing KVStoreSync implementations used for channel monitors and the channel manager. Resolve whether storage should use RGB-specific namespaces, retain filesystem fallback, or make a clean break. Done means the agreed persistence approach supports the intended KVStoreSync backend and its compatibility behavior is documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- databases
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100