docs: point example subgraph placeholders at indexing-payments#672
Merged
Conversation
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.
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.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR makes the example config's subgraph placeholders say what belongs in them. Since release 0.1.6 dipper reads indexer URLs from the indexing-payments subgraph, but the config section holding that endpoint kept its legacy name, network, and the example filled it with a gateway-shaped URL around a bare REPLACE_ME. Read together they suggest the value is a Graph network subgraph deployment, which dipper no longer consumes at all; someone migrating an old config can plausibly paste a network subgraph hash there and get GraphQL schema errors at runtime.
Both subgraph_endpoint placeholders (network and chain_listener) now read REPLACE_ME_INDEXING_PAYMENTS_SUBGRAPH_URL, making it explicit that they take the same value: the indexing-payments subgraph query URL, gateway-served or self-hosted. The api_key placeholder now says it can be removed when the endpoint needs no auth, since the field became optional in 0.1.6.