Drydock
GRT
0

Lodestar Drydock

Test a subgraph on your own machine

Subgraph Studio's test indexer is going, chain by chain. Drydock is what you run in its place: one command starts a real graph-node on your machine, deploys your built subgraph to it, and serves a local page with the sync, any indexing error, your mapping's logs and a query box. Nothing is uploaded anywhere. When it syncs clean, you publish it from here.

Run it

You need Docker and a subgraph that graph build has built. Take the binary for your machine from the releases, then, in the subgraph's folder:

drydock up --rpc base:https://base-rpc.publicnode.com

Open http://localhost:8787. The part before the colon is the network name in your manifest; the rest is any RPC endpoint for that chain.

It asks the endpoint first

graph-node takes an RPC endpoint's abilities on trust, and what the endpoint cannot do shows up later as a sync that stops with nothing to say why. Drydock measures first, against what your subgraph actually needs: how far back the endpoint's history goes, how wide a log query it accepts, whether it has traces for call handlers, and how many contracts one query may name for a subgraph with templates.

drydock preflight --rpc base:https://base-rpc.publicnode.com

That last check exists because we hit it. A factory subgraph on a free Base endpoint synced until it had created its eleventh pair and then sat at one block, reporting itself healthy: the endpoint allows ten addresses in a query and graph-node sends up to 2,000. Drydock now measures the limit and tells graph-node.

What it does not do

  • It is not hosted. It runs on your machine, in Docker, and stops when you stop it.
  • It does not give you an RPC endpoint. A free public one carries most event subgraphs; call handlers need one with traces, which no free endpoint we tried has.
  • It has not been run on Windows or with Docker Desktop. It has on an Apple Silicon Mac under colima and on Debian with plain Docker.
  • It does not publish. That is one more command, and it brings you back to Lodestar.

The guide walks through a first run and what each failure means. The source is at nuthatch-org/drydock.