Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 14 additions & 10 deletions nginx.conf
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ http {
rewrite ^/docs/en/cookbook/transfer-to-the-graph/$ $scheme://$http_host/docs/en/subgraphs/best-practices/transfer-to-the-graph/ permanent;
rewrite ^/docs/en/subgraphs/cookbook/near/$ $scheme://$http_host/docs/en/supported-networks/ permanent;
rewrite ^/docs/en/curating/$ $scheme://$http_host/docs/en/subgraphs/developing/curating/ permanent;
rewrite ^/docs/en/delegating/$ $scheme://$http_host/docs/en/resources/delegating/delegating/ permanent;
rewrite ^/docs/en/delegating/$ $scheme://$http_host/docs/en/resources/delegating/ permanent;
rewrite ^/docs/en/deploying/deploy-using-subgraph-studio/$ $scheme://$http_host/docs/en/subgraphs/developing/deploying-publishing/using-subgraph-studio/ permanent;
rewrite ^/docs/en/deploying/deploying-a-subgraph-to-studio/$ $scheme://$http_host/docs/en/subgraphs/developing/deploying-publishing/using-subgraph-studio/ permanent;
rewrite ^/docs/en/deploying/multiple-networks/$ $scheme://$http_host/docs/en/subgraphs/developing/deploying-publishing/multiple-networks/ permanent;
Expand All @@ -103,7 +103,7 @@ http {
rewrite ^/docs/en/developing/graph-ts/CHANGELOG/$ $scheme://$http_host/docs/en/subgraphs/developing/creating/graph-ts/CHANGELOG/ permanent;
rewrite ^/docs/en/developing/graph-ts/common-issues/$ $scheme://$http_host/docs/en/subgraphs/developing/creating/graph-ts/common-issues/ permanent;
rewrite ^/docs/en/developing/graph-ts/README/$ $scheme://$http_host/docs/en/subgraphs/developing/creating/graph-ts/README/ permanent;
rewrite ^/docs/en/developing/substreams-powered-subgraphs-faq/$ $scheme://$http_host/docs/en/substreams/sps/faq/ permanent;
rewrite ^/docs/en/developing/substreams-powered-subgraphs-faq/$ $scheme://$http_host/docs/en/substreams/overview/ permanent;
rewrite ^/docs/en/developing/supported-networks/$ $scheme://$http_host/docs/en/supported-networks/ permanent;
rewrite ^/docs/en/developing/unit-testing-framework/$ $scheme://$http_host/docs/en/subgraphs/tooling/unit-testing-framework/ permanent;
rewrite ^/docs/en/explorer/$ $scheme://$http_host/docs/en/subgraphs/existing-subgraphs/explorer/ permanent;
Expand All @@ -117,7 +117,7 @@ http {
rewrite ^/docs/en/network/benefits/$ $scheme://$http_host/docs/en/subgraphs/best-practices/benefits/ permanent;
rewrite ^/docs/en/network/contracts/$ $scheme://$http_host/docs/en/contracts/ permanent;
rewrite ^/docs/en/network/curating/$ $scheme://$http_host/docs/en/subgraphs/developing/curating/ permanent;
rewrite ^/docs/en/network/delegating/$ $scheme://$http_host/docs/en/resources/delegating/delegating/ permanent;
rewrite ^/docs/en/network/delegating/$ $scheme://$http_host/docs/en/resources/delegating/ permanent;
rewrite ^/docs/en/network/developing/$ $scheme://$http_host/docs/en/subgraphs/developing/introduction/ permanent;
rewrite ^/docs/en/network/explorer/$ $scheme://$http_host/docs/en/subgraphs/existing-subgraphs/explorer/ permanent;
rewrite ^/docs/en/network/indexing/$ $scheme://$http_host/docs/en/indexing/overview/ permanent;
Expand All @@ -135,8 +135,8 @@ http {
rewrite ^/docs/en/querying/querying-the-graph/$ $scheme://$http_host/docs/en/subgraphs/querying/introduction/ permanent;
rewrite ^/docs/en/querying/querying-with-python/$ $scheme://$http_host/docs/en/subgraphs/querying/python/ permanent;
rewrite ^/docs/en/quick-start/$ $scheme://$http_host/docs/en/subgraphs/quick-start/ permanent;
rewrite ^/docs/en/sps/sps-faq/$ $scheme://$http_host/docs/en/substreams/sps/faq/ permanent;
rewrite ^/docs/en/sps/(.*)$ $scheme://$http_host/docs/en/substreams/sps/$1 permanent;
rewrite ^/docs/en/sps/sps-faq/$ $scheme://$http_host/docs/en/substreams/overview/ permanent;
rewrite ^/docs/en/sps/.*$ $scheme://$http_host/docs/en/substreams/overview/ permanent;
rewrite ^/docs/en/studio/billing/$ $scheme://$http_host/docs/en/subgraphs/providers/subgraph-studio/introduction/ permanent;
rewrite ^/docs/en/studio/deploy-subgraph-studio/$ $scheme://$http_host/docs/en/subgraphs/developing/deploying-publishing/using-subgraph-studio/ permanent;
rewrite ^/docs/en/studio/managing-api-keys/$ $scheme://$http_host/docs/en/subgraphs/providers/subgraph-studio/managing-api-keys/ permanent;
Expand All @@ -147,7 +147,7 @@ http {
rewrite ^/docs/en/subgraphs/$ $scheme://$http_host/docs/en/subgraphs/overview/ permanent;
rewrite ^/docs/en/substreams/$ $scheme://$http_host/docs/en/substreams/quick-start/ permanent;
rewrite ^/docs/en/substreams/developing/sinks/sinks/$ $scheme://$http_host/docs/en/substreams/developing/sinks/ permanent;
rewrite ^/docs/en/substreams/sps/$ $scheme://$http_host/docs/en/substreams/overview/ permanent;
rewrite ^/docs/en/substreams/sps/.*$ $scheme://$http_host/docs/en/substreams/overview/ permanent;
rewrite ^/docs/en/supported-network-requirements/$ $scheme://$http_host/docs/en/indexing/supported-network-requirements/ permanent;
rewrite ^/docs/en/supported-networks/arweave/$ $scheme://$http_host/docs/en/supported-networks/ permanent;
rewrite ^/docs/en/supported-networks/near/$ $scheme://$http_host/docs/en/supported-networks/ permanent;
Expand Down Expand Up @@ -245,10 +245,10 @@ http {
rewrite ^/docs/en/querying/graph-client/$ $scheme://$http_host/docs/en/subgraphs/querying/graph-client/README/ redirect;
rewrite ^/docs/en/developing/graph-ts/$ $scheme://$http_host/docs/en/subgraphs/developing/creating/graph-ts/README/ redirect;
# --- subgraphs section reorg (subgraph-reorg) ---
rewrite ^/docs/en/resources/roles/$ $scheme://$http_host/docs/en/resources/delegating/delegating/ permanent;
rewrite ^/docs/en/resources/roles/delegating/$ $scheme://$http_host/docs/en/resources/delegating/delegating/ permanent;
rewrite ^/docs/en/resources/roles/delegating/delegating/$ $scheme://$http_host/docs/en/resources/delegating/delegating/ permanent;
rewrite ^/docs/en/resources/roles/delegating/undelegating/$ $scheme://$http_host/docs/en/resources/delegating/undelegating/ permanent;
rewrite ^/docs/en/resources/roles/$ $scheme://$http_host/docs/en/resources/delegating/ permanent;
rewrite ^/docs/en/resources/roles/delegating/$ $scheme://$http_host/docs/en/resources/delegating/ permanent;
rewrite ^/docs/en/resources/roles/delegating/delegating/$ $scheme://$http_host/docs/en/resources/delegating/ permanent;
rewrite ^/docs/en/resources/roles/delegating/undelegating/$ "$scheme://$http_host/docs/en/resources/delegating/#how-to-undelegate-on-the-graph" permanent;
rewrite ^/docs/en/subgraphs/developing/managing/curating/$ $scheme://$http_host/docs/en/subgraphs/developing/curating/ permanent;
rewrite ^/docs/en/resources/benefits/$ $scheme://$http_host/docs/en/subgraphs/best-practices/benefits/ permanent;
rewrite ^/docs/en/resources/roles/curating/$ $scheme://$http_host/docs/en/subgraphs/developing/curating/ permanent;
Expand Down Expand Up @@ -333,6 +333,10 @@ http {
rewrite ^/docs/en/subgraphs/cookbook/(.*)$ $scheme://$http_host/docs/en/subgraphs/best-practices/$1 permanent;
rewrite ^/docs/en/subgraphs/guides/(.*)$ $scheme://$http_host/docs/en/subgraphs/best-practices/$1 permanent;

# --- resources: delegating/ folder flattened into resources/delegating/; undelegating merged into it ---
rewrite ^/docs/en/resources/delegating/delegating/$ $scheme://$http_host/docs/en/resources/delegating/ permanent;
rewrite ^/docs/en/resources/delegating/undelegating/$ "$scheme://$http_host/docs/en/resources/delegating/#how-to-undelegate-on-the-graph" permanent;

location / {
try_files $uri $uri.html $uri/index.html =404;
}
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/public/img/Delegation-Unbonding-v2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/public/img/Indexing-Reward-Cut-v2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/public/img/Share-Formula-v2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 1 addition & 2 deletions website/route-lockfile.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@
/en/indexing/tooling/graph-node/
/en/indexing/tooling/graphcast/
/en/resources/bridging-grt/
/en/resources/delegating/delegating/
/en/resources/delegating/undelegating/
/en/resources/delegating/
/en/resources/getting-grt/
/en/resources/glossary/
/en/resources/tokenomics/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Query routing and paying for queries (covered in [Routing Queries to Indexers](/

On chains where indexing rewards are enabled, the built-in mechanism is curation. Indexing rewards are funded by new GRT issuance (currently at 2-3% annually) and distributed to Subgraphs in proportion to the curation signal on them. Signaling on a Subgraph therefore does two things: it tells Indexers the Subgraph is worth indexing, and it directs a share of indexing rewards to whoever indexes it. More signal means more Indexers are willing to allocate to and sync that Subgraph.

Indexers also have to serve queries across a minimum number of Subgraphs to stay eligible for indexing rewards (see [Indexing Rewards Eligibility](/indexing/rewards-eligibility/)). Routing consistent query traffic to a Subgraph therefore makes it more useful to Indexers, alongside the signal on it.

For a Gateway Operator, the practical move is to signal (or encourage their consumers to signal) on the Subgraphs an Operator needs served, often paired with the publication flow when a Subgraph is first published (see [Enabling Publication Flows](/gateways/subgraphs/consumer-side/publication-flows/)). A select amount of self-signal at publishing time is a common way to bootstrap indexing on a fresh Subgraph. Aim for enough signal to attract at least three Indexers, so a Gateway's per-query selection is covered and no single Indexer's outage leaves the Subgraph unserved. For recommended signal amounts and curation costs, see [How Much Signal to Add](/subgraphs/developing/curating/#how-much-signal-to-add).

## Chains without Indexing Rewards
Expand Down
4 changes: 3 additions & 1 deletion website/src/pages/en/graph-horizon/what-changes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ Horizon does not change the way indexing rewards work, the rewards formula remai
- Legacy allocation 1 with 10k GRT + Legacy allocation 2 with 10k GRT
- Legacy allocation 1 with 10k GRT + Horizon allocation 1 with 10k GRT

> **Note:** A later protocol upgrade ([GIP-0088](https://github.com/graphprotocol/graph-improvement-proposals/blob/main/gips/0088.md)) added an eligibility condition to indexing rewards. The rewards formula is unchanged, but only Indexers that meet the Rewards Eligibility Oracle (REO) standard can collect them. See [Indexing Rewards Eligibility](/indexing/rewards-eligibility/).

### Serving queries and the gateway behavior

The gateway now exclusively uses TAPv2 (GraphTally) receipts. Indexers must run `indexer-service-rs` and `indexer-tap-agent` v2.0.0 or later, which require Graph Horizon to be enabled.
Expand Down Expand Up @@ -84,5 +86,5 @@ Fishermen can now reclaim their bonds if disputes aren't resolved within the dis
While Horizon brings significant improvements, several core elements remain unchanged:

- **Curation mechanism**: The way subgraphs are signaled and curated remains the same
- **Indexing rewards formula**: The calculation and distribution of indexing rewards follows the same formula
- **Indexing rewards formula**: The calculation and distribution of indexing rewards follows the same formula. Since the GIP-0088 upgrade, collecting rewards also requires [rewards eligibility](/indexing/rewards-eligibility/)
- **GRT token**: The Graph Token (GRT) remains unchanged
1 change: 1 addition & 0 deletions website/src/pages/en/indexing/_meta.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ export default {
overview: '',
tooling: titles.tooling ?? '',
tap: 'GraphTally for Indexers',
'rewards-eligibility': '',
'supported-network-requirements': 'Supported Networks and Node Requirements',
'new-chain-integration': '',
'chain-integration-overview': 'Chain Integration Process',
Expand Down
8 changes: 6 additions & 2 deletions website/src/pages/en/indexing/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The minimum stake for an Indexer is currently set to 100K GRT.

**Query fee rebates** - Payments for serving queries on the network. These payments are mediated via [GraphTally](/indexing/tap) between an Indexer and a gateway. Each query request from a gateway contains a signed receipt and the corresponding response a proof of query result validity.

**Indexing rewards** - Generated via a 3% annual protocol wide inflation, the indexing rewards are distributed to Indexers who are indexing Subgraph deployments for the network.
**Indexing rewards** - Generated via a 3% annual protocol wide inflation, the indexing rewards are distributed to Indexers who are indexing Subgraph deployments for the network. To receive indexing rewards, an Indexer must meet the eligibility standard set by the Rewards Eligibility Oracle (REO). See [Indexing Rewards Eligibility](/indexing/rewards-eligibility/).

### How are indexing rewards distributed?

Expand All @@ -31,6 +31,8 @@ Indexers must submit a valid POI before it becomes stale. The `maxPOIStaleness`

Rewards are distributed proportionally based on curation signal and the amount of GRT allocated to each subgraph deployment.

Rewards are paid only to Indexers that are eligible under the Rewards Eligibility Oracle (REO), which requires an Indexer to serve qualifying queries across a minimum number of Subgraphs. When an ineligible Indexer presents a POI that would otherwise pay, the transaction reverts and the rewards stay pending. See [Indexing Rewards Eligibility](/indexing/rewards-eligibility/) for the criteria and how to check your status.

> **Note:** During the current transition period, the indexer-agent continues to recycle allocations approximately every 28 days for compatibility. A future agent version will leverage long-lived allocations natively. Check the [Graph Horizon migration guide](/graph-horizon/migration-guide/) for current agent requirements.

Numerous tools have been created by the community for calculating rewards; you'll find a collection of them organized in the [Community Guides collection](https://www.notion.so/Community-Guides-abbb10f4dba040d5ba81648ca093e70c). You can also find an up to date list of tools in the #Delegators and #Indexers channels on the [Discord server](https://discord.gg/graphprotocol). Here we link a [recommended allocation optimiser](https://github.com/graphprotocol/allocation-optimizer) integrated with the indexer software stack.
Expand All @@ -53,6 +55,8 @@ The previous mechanism allowing Delegators to force-close allocations after 28 e

The RewardsManager contract has a read-only [getRewards](https://github.com/graphprotocol/contracts/blob/main/packages/contracts/contracts/rewards/RewardsManager.sol#L316) function that can be used to check the pending rewards for a specific allocation.

> **Note:** `getRewards` does not account for Indexer eligibility, which is checked when rewards are claimed. A pending balance can only be collected if the Indexer is eligible under the Rewards Eligibility Oracle at that time. See [Indexing Rewards Eligibility](/indexing/rewards-eligibility/).

Many of the community-made dashboards include pending rewards values and they can be easily checked manually by following these steps:

1. Query the [mainnet Subgraph](https://thegraph.com/explorer/subgraphs/9Co7EQe5PgW3ugCUJrJgRv4u9zdEuDJf8NvMWftNsBH8?view=Query&chain=arbitrum-one) to get the IDs for all active allocations:
Expand Down Expand Up @@ -143,7 +147,7 @@ Indexers may differentiate themselves by applying advanced techniques for making

## Infrastructure

At the center of an Indexer's infrastructure is the Graph Node which monitors the indexed networks, extracts and loads data per a Subgraph definition and serves it as a [GraphQL API](/about/#how-the-graph-works). The Graph Node needs to be connected to an endpoint exposing data from each indexed network; an IPFS node for sourcing data; a PostgreSQL database for its store; and Indexer components which facilitate its interactions with the network.
At the center of an Indexer's infrastructure is the Graph Node which monitors the indexed networks, extracts and loads data per a Subgraph definition and serves it as a [GraphQL API](/subgraphs/querying/graphql-api/). The Graph Node needs to be connected to an endpoint exposing data from each indexed network; an IPFS node for sourcing data; a PostgreSQL database for its store; and Indexer components which facilitate its interactions with the network.

- **PostgreSQL database** - The main store for the Graph Node, this is where Subgraph data is stored. The Indexer service, TAP agent, and Indexer agent also use the database to store receipt data, cost models, indexing rules, and allocation actions.

Expand Down
Loading
Loading