Repository navigation
docs(indexers): add Pinax - #2372
chillsauce wants to merge 4 commits into
Conversation
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/.
|
Rebased onto Three things moved:
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. |
|
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.
|
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:
(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 Citation: https://pinax.network/chain/celo lists Celo with the services we run for it. The correctionThat same block stream reported Better you get that from us than from a developer who integrated expecting traces. Diff is now 3 files, +54/−1. |
GigaHierz
left a comment
There was a problem hiding this comment.
Thanks for the Pinax page, and for owning the endpoint check and the base-versus-extended correction. The structure fits the other indexer pages, and mint validate, mint broken-links --check-redirects and the orphan check pass on this head, which merges cleanly into main. The hostnames and chain IDs also check out: the Firehose and Substreams hosts accept connections on 443, and the mainnet and Sepolia RPC endpoints return 0xa4ec and 0xaa044c.
A few statements need a source or a softer wording before this goes in:
- Celo Sepolia. The Note says Firehose and Substreams are mainnet only. The Celo page on pinax.network (https://pinax.network/chain/celo) shows a "CeloSepolia" label above the Substreams, Firehose and RPC cards, so it doesn't back that up, and I can't tell which services apply to which network from it. Please link something that states the Sepolia coverage, or drop the Note and the Sepolia section's implication.
- Unsourced claims. "maintains the open source Firehose and Substreams stack alongside StreamingFast" and "It reads history far faster than sequential RPC calls" have no source on the page, and AGENTS.md section 4 rules out unsourced superlatives and comparisons. Link a source or cut them.
- Authentication column.
SUBSTREAMS_API_KEYis the name of an environment variable, not an authentication method, so the column mixes two things. Something like "API key (set asSUBSTREAMS_API_KEYfor the Substreams CLI)" would be accurate if that matches Pinax's docs. Separately, the RPC endpoints answered aneth_chainIdrequest with no key on both networks, while the table says "API key". Please say what a keyless call gets, for example a rate limit, or confirm the key is required. - Pages that go stale. The endpoint hostnames and the pricing link can change without us noticing. Please link https://pinax.network/chain/celo as the canonical place for the current endpoints, and keep the table as examples.
- CI. The broken-links check does not appear on this PR, probably because the workflow is waiting for approval on the fork. I ran it locally and it passes.
I could not run an authenticated Firehose or Substreams stream, so the authentication details are checked only against your description, not against a real stream.
Addresses the review on celo-org#2372. - Cut "reads history far faster than sequential RPC calls" (unsourced comparison) and the unsourced StreamingFast co-maintenance claim; the intro now links the Substreams docs, which list Pinax as a provider. - Cite The Graph's networks registry for the base-detail-level statement ("evmExtendedModel": false, "blockFeatures": ["base"]) so the strongest technical claim on the page has a third-party source. - Split authentication into method and mechanism: SUBSTREAMS_API_KEY is where the CLI reads the key from, not an auth method. - Document that the RPC endpoints answer without a key. They do, on both networks; those requests take a rate-limited anonymous path served only from Pinax's own nodes with no fallback capacity. - Link pinax.network/chain/celo as the canonical endpoint list so the tables here are examples rather than a second source of truth. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Preview approval requiredThis pull request comes from a fork, so Mintlify won't build a preview until someone with write access approves commit |
|
Thanks @GigaHierz — this was a good review. Four of the five were mine to fix; pushed in 1c54f4b. Point by point: 1. Celo Sepolia — the Note is right, but the page you checked is confusing.
The underlying coverage is RPC-only on Sepolia:
So I've kept the Note and left the Sepolia table at RPC. 2. Unsourced claims — cut both. "Reads history far faster than sequential RPC calls" is gone; it was an unsourced comparison and the sentence works without it. The StreamingFast co-maintenance line is replaced by a sourced one: the Substreams docs list Pinax among their providers. While I was at it I gave the base-detail statement a source too, since it's the strongest technical claim on the page: the registry records 3. Authentication column — you're right on both halves.
And your keyless 4. Staleness — done.
5. CI — understood. I ran both locally against this head: One thing I can't close from my side: you noted you couldn't run an authenticated Firehose or Substreams stream. If it's useful for verification I'm happy to arrange a key — otherwise the registry entry above is the closest third-party check on the streaming claims. |
Adds Pinax to the indexers section: a provider page at
tooling/indexers/pinax.mdx, an entry intooling/indexers/overview.mdx, and the nav entry indocs.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 1shallow 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.