evstack / evstack/apex

Track celestia-node API v1 migration (blob_v1, share_v1)

Aperta
#21 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Go
Stelle
4
Fork
0
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

## Summary

celestia-node is introducing versioned API modules (`blob_v1`, `share_v1`) with breaking changes to proof structures and method signatures. Apex must track these changes to maintain compatibility.

## Upstream issues

- [celestiaorg/celestia-node#4308](https://github.com/celestiaorg/celestia-node/issues/4308) — EPIC: API v1 release with dataroot proof structure
- [celestiaorg/celestia-node#4306](https://github.com/celestiaorg/celestia-node/issues/4306) — Create share_v1, blob_v1 API modules
- [celestiaorg/celestia-node#4307](https://github.com/celestiaorg/celestia-node/issues/4307) — Deprecate share and blob API v0
- [celestiaorg/celestia-node#3919](https://github.com/celestiaorg/celestia-node/issues/3919) — Deprecate `blob.Included()` method

## Breaking changes to track

### blob_v1
- `Get(height, namespace, commitment)` adds a `proofs_only` option — changes request signature
- `GetProof` is **removed** as a standalone method (folded into `Get` with `proofs_only=true`)
- `Included` is **deprecated** — replaced by proof validation methods
- Proof structure changes from namespace row proofs to "dataroot" proofs (more efficient)

### share_v1
- `GetRange`, `GetShare`, `GetEDS`, `GetSharesByNamespace` — new method signatures
- Index harmonization: EDS vs ODS indexes unified to ODS-only

### Deprecation timeline
- v0 gets deprecation warnings in response headers after v1 ships
- Migration guide published
- v0 eventually removed

## Action items

- [ ] Monitor upstream progress on #4308
- [ ] When blob_v1 ships, update apex #2 (JSON-RPC layer) to support both v0 and v1
- [ ] Update `GetProof` stub to match new proof-via-Get pattern
- [ ] Plan deprecation of `Included` from apex API
- [ ] Ensure apex response types include `app_version` for downstream consumers ([celestiaorg/celestia-node#3977](https://github.com/celestiaorg/celestia-node/issues/3977))

## Related apex issues

- #2 — JSON-RPC compatibility layer (must support v0 + v1)
- #14 — Subscription improvements (subscribe API may change in v1)

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia leggendo apex #2 e lo stub GetProof esistente, quindi esamina le issue #4308 e #4306 di celestia-node per conoscere lo stato dell'API v1. Tieni traccia delle modifiche alle signature e alle proof di blob_v1 e share_v1 e usa gli elementi d'azione elencati come checklist di completamento: compatibilità v0/v1, gestione aggiornata delle proof, pianificazione della deprecazione di Included e supporto per app_version.

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

Valutazione

Stack tecnologico
go
Ambito
api, backend-api-design
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.