spacemeshos/poet

Consider migrating from XDR

Open

#386 opened on Sep 12, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (15 forks)auto 404
area/poetgood first issueoptimizationrefactor

Repository metrics

Stars
 (24 stars)
PR merge metrics
 (PR metrics pending)

Description

The github.com/nullstyle/go-xdr/xdr is used for:

  • serializing state (server and rounds in-progress)
  • serializing values to store in leveldb

XDR usefulness is questionable. We could migrate the state files to something like JSON for easier maintainability (it's human-readable and easily editable). The DBs could be migrated to https://github.com/spacemeshos/go-scale which should be faster.

Contributor guide

Research direction
Investigate the XDR usage in state serialization and leveldb storage, then plan a migration to JSON for state files and go scale for the database.
Tech stack
go
Domain
backenddatabase
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75