Skip to content

refactor: rename the network config section to indexer_urls#673

Merged
MoonBoi9001 merged 1 commit into
mb9/clarify-example-subgraph-placeholdersfrom
mb9/rename-network-config-to-indexer-urls
Jul 14, 2026
Merged

refactor: rename the network config section to indexer_urls#673
MoonBoi9001 merged 1 commit into
mb9/clarify-example-subgraph-placeholdersfrom
mb9/rename-network-config-to-indexer-urls

Conversation

@MoonBoi9001

Copy link
Copy Markdown
Member

This PR renames the config section that points dipper at indexer URLs from network to indexer_urls, in the config struct and the example configmap. Deployments upgrading past this change must rename that key in their config.json; the 4 fields inside (subgraph_endpoint, api_key, update_interval, allow_empty_at_startup) are unchanged.

Since release 0.1.6 dipper looks up indexer URLs in the indexing-payments subgraph, and the section holds that subgraph's query endpoint. Its legacy name, network, dates from when it configured the Graph network subgraph via the gateway, and it kept suggesting exactly that: an operator filling in the config can reasonably paste a network subgraph endpoint there, which dipper can no longer use. Nothing runs release 0.1.6 in a deployed environment yet, so renaming now folds into the config migration operators already have to do for 0.1.6 instead of creating a second migration later.

Stacked on #672 (self-describing placeholder values in the same example file); this PR carries only the rename.

@MoonBoi9001 MoonBoi9001 added the config-migration Config schema changed; update config.json when upgrading past this release label Jul 14, 2026
Since 0.1.6 the section configures the indexer URL lookup against the indexing-payments
subgraph, but its legacy name suggested it wanted the Graph network subgraph, inviting the
wrong endpoint. Deployments upgrading past this change must rename the key in config.json.
@MoonBoi9001
MoonBoi9001 force-pushed the mb9/rename-network-config-to-indexer-urls branch from 90237fd to 35e821a Compare July 14, 2026 11:14
@MoonBoi9001
MoonBoi9001 merged commit 1e0797d into mb9/clarify-example-subgraph-placeholders Jul 14, 2026
11 checks passed
MoonBoi9001 added a commit that referenced this pull request Jul 14, 2026
* docs(k8s): name the indexing-payments subgraph in example placeholders

The network section's legacy name plus a gateway-shaped placeholder read as if it wanted a
Graph network subgraph deployment, which dipper no longer consumes. Both subgraph_endpoint
placeholders now say the value is the indexing-payments subgraph query URL, same in both.

* docs(k8s): show the studio query URL shape in subgraph placeholders

The bare sentinel said which subgraph belongs in the endpoint but not what a real value looks
like. The placeholder now carries the Subgraph Studio query URL format, with the user id and
slug segments left as REPLACE_ME markers.

* refactor(config): rename the network section to indexer_urls (#673)

Since 0.1.6 the section configures the indexer URL lookup against the indexing-payments
subgraph, but its legacy name suggested it wanted the Graph network subgraph, inviting the
wrong endpoint. Deployments upgrading past this change must rename the key in config.json.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

config-migration Config schema changed; update config.json when upgrading past this release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant