spacemeshos/poet

Clean up the structure of round state.bin

Open

#384 opened on Sep 11, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Go (15 forks)auto 404
area/poetgood first issuerefactor

Repository metrics

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

Description

The round state file contains many fields that are not required anymore:

type persistedRoundState struct {
	SecurityParam uint8
	Members       [][]byte // Deprecated
	Statement     []byte
	ParkedNodes   [][]byte // Deprecated
	NumLeaves     uint64
	NIP           *shared.MerkleProof
}

To remove:

  • Members
  • ParkedNodes

Questionable fields:

  • NIP: The round data (including the state) is removed shortly after finishing,
  • SecurityParam: It's currently hardcoded in the PoET binary anyway, and it can be decided when the proof is created

Also, the serialization format could be changed to a human-readable format like JSON for:

  • easier maintenance (fixing hard failures),
  • easier structure changing without the need for extra migration code if not necessary.

💡 Migration will be required to make sure that already deployed poets can upgrade easily.

Contributor guide

Research direction
Examine current round state serialization in persistedRoundState, plan removal of deprecated fields (Members, ParkedNodes) and optional migration to JSON format, ensuring backward compatibility for deployed poets.
Tech stack
go
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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
Goserialization
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65