Change UnixFS dag-pb protobuf field ordering

Aperta
#533 0 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla

Direzione di ricerca

Inizia leggendo la specifica collegata del formato di serializzazione dag-pb e i riferimenti alle pull request IPIP-499 e specs per comprendere il contesto di compatibilità e dei profili. Il lavoro è completato quando la proposta di ordinamento, le sue implicazioni per il wire format e qualsiasi percorso di aggiornamento a unixfs-v1-2026 sono chiaramente specificati e accettati.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

need/triage

The .proto definition of a PBNode is this (spec):

message PBNode {
  // refs to other objects
  repeated PBLink Links = 2;

  // opaque user data
  optional bytes Data = 1;
}

Implementations are expected to write the repeated Links messages to the output buffer first, then the Data field, even though the field IDs are ordered the opposite way (not disallowed by the protobuf spec, though some off the shelf encoders will write in ID order).

When the PBNode represents a directory, the Links objects could be either flat directory entries, or HAMT shard entries - the information needed to ascertain this is contained in the Data field.

This means when processing an incoming PBNode message, we typically read all of the Links, and then use the Data to decide how to process them.

If we are performing a graph traversal, a streaming parser would let us process the PBNode message as it arrives, and to select the Link message we wish to traverse through or resolve to, however this is not currently possible since we need to process the Data field before we can return a Link. This can add significant overhead when there are many thousands of Links.

We should allow ordering the Data field first, this would enable the streaming use-case and help with IPFS code running in resource-constrained environments such as web browsers.

Since IPIP-499 we now have CID profiles which could be an upgrade path for the network. This proposal could be part of a unixfs-v1-2026 profile.

Lingua principale
HTML
Stelle
1.2k
Fork
250
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ipfs/specs

Tutte le issue di ipfs/specs

Issue simili

Altre issue su Distributed Systems

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.