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

Open
#21 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
go

Research direction

Start by reading apex #2 and the existing GetProof stub, then review celestia-node issues #4308 and #4306 for the v1 API status. Track the blob_v1 and share_v1 signature and proof changes, and use the listed action items as the completion checklist: v0/v1 compatibility, updated proof handling, Included deprecation planning, and app_version support.

Written by the indexing model from the issue text.

Description

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

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)

Related apex issues

  • #2 — JSON-RPC compatibility layer (must support v0 + v1)
  • #14 — Subscription improvements (subscribe API may change in v1)
Dominant language
Go
Stars
4
Forks
0
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from evstack/apex

All issues in evstack/apex

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.