Document issuanceRewards field as canonical source (part of replacing indexers' feature support matrix)#173
Merged
YaroShkvorets merged 3 commits intographprotocol:mainfrom Nov 5, 2025
Conversation
Collaborator
|
@p-diogo How do we plan to update this field? The way it works right now, basically on every PR and on every daily maintenance check we validate that the list of chains with rewards in the registry matches with EBO subgraph, and flag if not, prompting to update the registry. I suppose going forward the process could look like this:
Makes sense? |
Contributor
Author
|
@YaroShkvorets , that makes total sense to me, yes. |
YaroShkvorets
approved these changes
Nov 5, 2025
- Clarify this applies to subgraphs specifically (registry tracks multiple services) - Explain what arbitration is and its purpose - Document historical duplication with Feature Support Matrix - Establish registry as source of truth for issuanceRewards - Clarify governance structure per GGP-0062 - Add references to GIP-0008 and Arbitration Charter - Update README with link to new documentation - Part 1 of feature matrix simplification effort
1feb370 to
66d8a33
Compare
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
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.
Problem
The
issuanceRewardsfield exists in network JSON files but lacks documentation about:Meanwhile, this data is duplicated in the indexer repo's Feature Support Matrix, creating maintenance burden when networks are added or updated.
Proposed solution
Add documentation establishing this registry as the canonical source for the
issuanceRewardsfield. This allows other repositories (like the indexer repo) to reference this registry instead of maintaining duplicate copies of network data.Changes
New documentation (
docs/subgraphs-arbitration-policy.md):issuanceRewardsmeans in The Graph ecosystemUpdated README:
Why Arbitration Documentation?
TL;DR: This adds new docs on arbitration because we're restructuring how the Feature Support Matrix works (and cleaning it up), and this registry should now become the central reference point.
The Feature Support Matrix in the indexer repo currently documents both:
We're splitting these concerns:
issuanceRewards)The arbitration policy doc explains how
issuanceRewardsis used in the broader ecosystem (specifically for subgraph dispute resolution), which helps users understand why this field matters and why the Feature Support Matrix references it.Review Notes
This is purely additive documentation:
issuanceRewardsvaluesCorresponding PR on the feature support matrix: graphprotocol/indexer#1143