spacemeshos/poet

Clean up the structure of round state.bin

Aberta

#384 aberto em 11 de set. de 2023

Ver no GitHub
 (1 comentário) (0 reação) (0 responsável)Go (15 forks)auto 404
area/poetgood first issuerefactor

Métricas do repositório

Stars
 (24 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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.

Guia do colaborador

Direção de pesquisa
Examine a serialização atual do estado da rodada em persistedRoundState, planeje a remoção dos campos obsoletos (Members, ParkedNodes) e a migração opcional para o formato JSON, garantindo compatibilidade retroativa para poetas já implantados.
Pilha de tecnologia
go
Domain
backend
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Goserialization
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65