Skip to content

docs(indexers): add Pinax - #2372

Open
chillsauce wants to merge 3 commits into
celo-org:mainfrom
chillsauce:fix/add-pinax-indexer
Open

chillsauce wants to merge 3 commits into
celo-org:mainfrom
chillsauce:fix/add-pinax-indexer

Conversation

@chillsauce

Copy link
Copy Markdown

Adds Pinax to the indexers section: a provider page at tooling/indexers/pinax.mdx, an entry in tooling/indexers/overview.mdx, and the nav entry in docs.json.

Replaces #2371, which I broke. Same change, 3 files, +51/−1.

What happened there: I amended the commit to correct its author email (it was recorded against a local hostname address that GitHub couldn't map to an account, so the commit showed no author). I did that inside a --depth 1 shallow clone, and the amend lost the parent, turning it into a root commit. The force-push then closed the PR and the diff ballooned to 446 files. Entirely self-inflicted and nothing to do with the content.

This branch is cut cleanly from main (50ed71d) with the original change cherry-picked onto it, so the diff is exactly what #2371 intended to propose.

Sorry for the noise.

Pinax serves Celo mainnet over Firehose, Substreams and archive JSON-RPC,
and Celo Sepolia over RPC, but was not listed under Indexers.

Adds the provider page, registers it in docs.json, and adds the bullet to
the indexers overview.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Celo restructured tooling/ into build/tools/. Relocates the Pinax page,
re-adds it to docs.json under the new path, and updates the internal
links in both the page and the indexers overview from /tooling/indexers/
to /build/tools/indexers/.
@chillsauce

Copy link
Copy Markdown
Author

Rebased onto main — the tooling/ → build/tools/ restructure had put this into conflict.

Three things moved:

  • The page is now build/tools/indexers/pinax.mdx
  • docs.json registers it under the new path, alongside build/tools/indexers/codex
  • Internal links in both the page and the indexers overview updated from /tooling/indexers/… to /build/tools/indexers/…, matching how overview.mdx links to Envio

Diff is back to the original 3 files (+52/−1) and all four link targets resolve. @GigaHierz no action needed on your side — flagging in case you'd already started looking.

@GigaHierz

Copy link
Copy Markdown
Contributor

Thanks for the PR, and for sorting out the rebase onto the new paths. Pinax is a good fit for the Indexers list. Before we merge, can you confirm two things for Celo specifically: (1) Firehose and Substreams are live on Celo mainnet today, not only RPC, and (2) the Celo Firehose and Substreams endpoints in the table are the ones a new user would use with a standard API key. A link to the Pinax page that lists Celo among supported networks would be enough for us to cite.

Celo blocks are served at Firehose's base detail level. The page claimed
call traces and balance changes, which require extended blocks from an
instrumented node — Pinax does not run one for Celo. Verified against
the live stream, which reports DETAILLEVEL_BASE.
@chillsauce

Copy link
Copy Markdown
Author

Thanks @GigaHierz — both confirmed, and your question surfaced something I needed to correct. Pushed a fix.

(1) Firehose and Substreams are live on Celo mainnet today, not just RPC. Verified just now against the live endpoints:

Service Endpoint Check
Firehose celo.firehose.pinax.network:443 serves sf.firehose.v2.Stream, Fetch, EndpointInfo
Substreams celo.substreams.pinax.network:443 serves sf.substreams.rpc.v2/v3/v4.Stream
RPC https://celo.rpc.pinax.network eth_chainId → 0xa4ec (42220)

(2) Those are the endpoints a new user would use with a standard API key. I streamed a live Celo block end to end with nothing but an X-Api-Key header on a normal key — no allowlisting, no special provisioning. The auth column in the table is accurate: X-Api-Key for Firehose, SUBSTREAMS_API_KEY for Substreams, API key for RPC.

Citation: https://pinax.network/chain/celo lists Celo with the services we run for it.

The correction

That same block stream reported detailLevel: DETAILLEVEL_BASE, and the page claimed Firehose carries "call traces, and balance changes". Those are extended block fields — they need an instrumented node, and we don't run one for Celo. The page now says what base blocks actually contain (transactions, receipts, logs, with cursors for resume) and states the limitation explicitly rather than leaving a reader to discover it.

Better you get that from us than from a developer who integrated expecting traces. Diff is now 3 files, +54/−1.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants