Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Graph explorer #775

Merged
merged 2 commits into from
Sep 19, 2024
Merged
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
101 changes: 67 additions & 34 deletions website/pages/en/network/explorer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,35 @@
title: Graph Explorer
---

Welcome to Graph Explorer, or as we like to call it, your decentralized portal into the world of subgraphs and network data. 👩🏽‍🚀 Graph Explorer consists of multiple parts where you can interact with other subgraph developers, dapp developers, Curators, Indexers, and Delegators. For a general overview of Graph Explorer, check out the video below (or keep reading below):
Learn about The Graph Explorer and access the world of subgraphs and network data.

Graph Explorer consists of multiple parts where you can interact with other subgraph developers, dapp developers, Curators, Indexers, and Delegators.

## Video Guide

For a general overview of Graph Explorer, check out the video below:

<VideoEmbed youtube="u224xf7rEBY" />

## Subgraphs

First things first, if you just finished deploying and publishing your subgraph in Subgraph Studio, the Subgraphs tab on the top of the navigation bar is the place to view your own finished subgraphs (and the subgraphs of others) on the decentralized network. Here, you’ll be able to find the exact subgraph you’re looking for based on the date created, signal amount, or name.
After you just finish deploying and publishing your subgraph in Subgraph Studio, click on the "subgraphs tab” at the top of the navigation bar to access the following:

- Your own finished subgraphs
- Subgraphs published by others
- The exact subgraph you want (based on the date created, signal amount, or name).

![Explorer Image 1](/img/Subgraphs-Explorer-Landing.png)

When you click into a subgraph, you’ll be able to test queries in the playground and be able to leverage network details to make informed decisions. You’ll also be able to signal GRT on your own subgraph or the subgraphs of others to make indexers aware of its importance and quality. This is critical because signaling on a subgraph incentivizes it to be indexed, which means that it’ll surface on the network to eventually serve queries.
When you click into a subgraph, you will be able to do the following:

- Test queries in the playground and be able to leverage network details to make informed decisions.
- Signal GRT on your own subgraph or the subgraphs of others to make indexers aware of its importance and quality.
- This is critical because signaling on a subgraph incentivizes it to be indexed, meaning it’ll eventually surface on the network to serve queries.

![Explorer Image 2](/img/Subgraph-Details.png)

On each subgraph’s dedicated page, several details are surfaced. These include:
On each subgraph’s dedicated page, you can do the following:

- Signal/Un-signal on subgraphs
- View more details such as charts, current deployment ID, and other metadata
Expand All @@ -31,71 +45,83 @@ On each subgraph’s dedicated page, several details are surfaced. These include

## Participants

Within this tab, you’ll get a bird’s eye view of all the people that are participating in the network activities, such as Indexers, Delegators, and Curators. Below, we’ll go into an in-depth review of what each tab means for you.
This section provides a bird' s-eye view of all "participants," which includes everyone participating in the network, such as Indexers, Delegators, and Curators.

### 1. Indexers

![Explorer Image 4](/img/Indexer-Pane.png)

Let’s start with the Indexers. Indexers are the backbone of the protocol, being the ones that stake on subgraphs, index them, and serve queries to anyone consuming subgraphs. In the Indexers table, you’ll be able to see an Indexers’ delegation parameters, their stake, how much they have staked to each subgraph, and how much revenue they have made off of query fees and indexing rewards. Deep dives below:
Indexers are the backbone of the protocol. They stake on subgraphs, index them, and serve queries to anyone consuming subgraphs.

In the Indexers table, you can see an Indexers’ delegation parameters, their stake, how much they have staked to each subgraph, and how much revenue they have made from query fees and indexing rewards.

- Query Fee Cut - the % of the query fee rebates that the Indexer keeps when splitting with Delegators
- Effective Reward Cut - the indexing reward cut applied to the delegation pool. If it’s negative, it means that the Indexer is giving away part of their rewards. If it’s positive, it means that the Indexer is keeping some of their rewards
- Cooldown Remaining - the time remaining until the Indexer can change the above delegation parameters. Cooldown periods are set up by Indexers when they update their delegation parameters
- Owned - This is the Indexer’s deposited stake, which may be slashed for malicious or incorrect behavior
- Delegated - Stake from Delegators which can be allocated by the Indexer, but cannot be slashed
- Allocated - Stake that Indexers are actively allocating towards the subgraphs they are indexing
- Available Delegation Capacity - the amount of delegated stake the Indexers can still receive before they become over-delegated
**Specifics**

- Query Fee Cut - the % of the query fee rebates that the Indexer keeps when splitting with Delegators.
- Effective Reward Cut - the indexing reward cut applied to the delegation pool. If it’s negative, it means that the Indexer is giving away part of their rewards. If it’s positive, it means that the Indexer is keeping some of their rewards.
- Cooldown Remaining - the time remaining until the Indexer can change the above delegation parameters. Cooldown periods are set up by Indexers when they update their delegation parameters.
- Owned - This is the Indexer’s deposited stake, which may be slashed for malicious or incorrect behavior.
- Delegated - Stake from Delegators which can be allocated by the Indexer, but cannot be slashed.
- Allocated - Stake that Indexers are actively allocating towards the subgraphs they are indexing.
- Available Delegation Capacity - the amount of delegated stake the Indexers can still receive before they become over-delegated.
- Max Delegation Capacity - the maximum amount of delegated stake the Indexer can productively accept. An excess delegated stake cannot be used for allocations or rewards calculations.
- Query Fees - this is the total fees that end users have paid for queries from an Indexer over all time
- Query Fees - this is the total fees that end users have paid for queries from an Indexer over all time.
- Indexer Rewards - this is the total indexer rewards earned by the Indexer and their Delegators over all time. Indexer rewards are paid through GRT issuance.

Indexers can earn both query fees and indexing rewards. Functionally, this happens when network participants delegate GRT to an Indexer. This enables Indexers to receive query fees and rewards depending on their Indexer parameters. Indexing parameters are set by clicking on the right-hand side of the table, or by going into an Indexer’s profile and clicking the “Delegate” button.
Indexers can earn both query fees and indexing rewards. Functionally, this happens when network participants delegate GRT to an Indexer. This enables Indexers to receive query fees and rewards depending on their Indexer parameters.

- Indexing parameters can be set by clicking on the right-hand side of the table or by going into an Indexer’s profile and clicking the “Delegate” button.

To learn more about how to become an Indexer, you can take a look at the [official documentation](/network/indexing) or [The Graph Academy Indexer guides.](https://thegraph.academy/delegators/choosing-indexers/)

![Indexing details pane](/img/Indexing-Details-Pane.png)

### 2. Curators

Curators analyze subgraphs to identify which subgraphs are of the highest quality. Once a Curator has found a potentially attractive subgraph, they can curate it by signaling on its bonding curve. In doing so, Curators let Indexers know which subgraphs are high quality and should be indexed.
Curators analyze subgraphs to identify which subgraphs are of the highest quality. Once a Curator has found a potentially high-quality subgraph, they can curate it by signaling on its bonding curve. In doing so, Curators let Indexers know which subgraphs are high quality and should be indexed.

- Curators can be community members, data consumers, or even subgraph developers who signal on their own subgraphs by depositing GRT tokens into a bonding curve.
- By depositing GRT, Curators mint curation shares of a subgraph. As a result, they can earn a portion of the query fees generated by the subgraph they have signaled on.
- The bonding curve incentivizes Curators to curate the highest quality data sources.

Curators can be community members, data consumers, or even subgraph developers who signal on their own subgraphs by depositing GRT tokens into a bonding curve. By depositing GRT, Curators mint curation shares of a subgraph. As a result, Curators are eligible to earn a portion of the query fees that the subgraph they have signaled on generates. The bonding curve incentivizes Curators to curate the highest quality data sources. The Curator table in this section will allow you to see:
In the The Curator table listed below you can see:

- The date the Curator started curating
- The number of GRT that was deposited
- The number of shares a Curator owns

![Explorer Image 6](/img/Curation-Overview.png)

If you want to learn more about the Curator role, you can do so by visiting the following links of [The Graph Academy](https://thegraph.academy/curators/) or [official documentation.](/network/curating)
If you want to learn more about the Curator role, you can do so by visiting [official documentation.](/network/curating) or [The Graph Academy](https://thegraph.academy/curators/).

### 3. Delegators

Delegators play a key role in maintaining the security and decentralization of The Graph Network. They participate in the network by delegating (i.e., “staking”) GRT tokens to one or multiple indexers. Without Delegators, Indexers are less likely to earn significant rewards and fees. Therefore, Indexers seek to attract Delegators by offering them a portion of the indexing rewards and query fees that they earn.
Delegators play a key role in maintaining the security and decentralization of The Graph Network. They participate in the network by delegating (i.e., “staking”) GRT tokens to one or multiple indexers.

Delegators, in turn, select Indexers based on a number of different variables, such as past performance, indexing reward rates, and query fee cuts. Reputation within the community can also play a factor in this! It’s recommended to connect with the indexers selected via [The Graph’s Discord](https://discord.gg/graphprotocol) or [The Graph Forum](https://forum.thegraph.com/)!
- Without Delegators, Indexers are less likely to earn significant rewards and fees. Therefore, Indexers attract Delegators by offering them a portion of their indexing rewards and query fees.
- Delegators select Indexers based on a number of different variables, such as past performance, indexing reward rates, and query fee cuts.
- Reputation within the community can also play a factor in the selection process. It’s recommended to connect with the selected Indexers via [The Graph’s Discord](https://discord.gg/graphprotocol) or [The Graph Forum](https://forum.thegraph.com/)!

![Explorer Image 7](/img/Delegation-Overview.png)

The Delegators table will allow you to see the active Delegators in the community, as well as metrics such as:
In the Delegators table you can see the active Delegators in the community and important metrics:

- The number of Indexers a Delegator is delegating towards
- A Delegator’s original delegation
- The rewards they have accumulated but have not withdrawn from the protocol
- The realized rewards they withdrew from the protocol
- Total amount of GRT they have currently in the protocol
- The date they last delegated at
- The date they last delegated

If you want to learn more about how to become a Delegator, look no further! All you have to do is to head over to the [official documentation](/network/delegating) or [The Graph Academy](https://docs.thegraph.academy/official-docs/delegator/choosing-indexers).
If you want to learn more about how to become a Delegator, check out the [official documentation](/network/delegating) or [The Graph Academy](https://docs.thegraph.academy/official-docs/delegator/choosing-indexers).

## Network

In the Network section, you will see global KPIs as well as the ability to switch to a per-epoch basis and analyze network metrics in more detail. These details will give you a sense of how the network is performing over time.
In this section, you can see global KPIs and view the ability to switch to a per-epoch basis and analyze network metrics in more detail. These details will give you a sense of how the network is performing over time.

### Overview

The overview section has all the current network metrics as well as some cumulative metrics over time. Here you can see things like:
The overview section has both all the current network metrics and some cumulative metrics over time:

- The current total network stake
- The stake split between the Indexers and their Delegators
Expand All @@ -104,10 +130,10 @@ The overview section has all the current network metrics as well as some cumulat
- Protocol parameters such as curation reward, inflation rate, and more
- Current epoch rewards and fees

A few key details that are worth mentioning:
A few key details to note:

- **Query fees represent the fees generated by the consumers**, and they can be claimed (or not) by the Indexers after a period of at least 7 epochs (see below) after their allocations towards the subgraphs have been closed and the data they served has been validated by the consumers.
- **Indexing rewards represent the amount of rewards the Indexers claimed from the network issuance during the epoch.** Although the protocol issuance is fixed, the rewards only get minted once the Indexers close their allocations towards the subgraphs they’ve been indexing. Thus the per-epoch number of rewards varies (ie. during some epochs, Indexers might’ve collectively closed allocations that have been open for many days).
- **Query fees represent the fees generated by the consumers**. They can be claimed (or not) by the Indexers after a period of at least 7 epochs (see below) after their allocations towards the subgraphs have been closed and the data they served has been validated by the consumers.
- **Indexing rewards represent the amount of rewards the Indexers claimed from the network issuance during the epoch.** Although the protocol issuance is fixed, the rewards only get minted once Indexers close their allocations towards the subgraphs they’ve been indexing. So, the per-epoch number of rewards varies (ie. during some epochs, Indexers might’ve collectively closed allocations that have been open for many days).

![Explorer Image 8](/img/Network-Stats.png)

Expand All @@ -121,29 +147,34 @@ In the Epochs section, you can analyze on a per-epoch basis, metrics such as:
- The active epoch is the one in which Indexers are currently allocating stake and collecting query fees
- The settling epochs are the ones in which the state channels are being settled. This means that the Indexers are subject to slashing if the consumers open disputes against them.
- The distributing epochs are the epochs in which the state channels for the epochs are being settled and Indexers can claim their query fee rebates.
- The finalized epochs are the epochs that have no query fee rebates left to claim by the Indexers, thus being finalized.
- The finalized epochs are the epochs that have no query fee rebates left to claim by the Indexers.

![Explorer Image 9](/img/Epoch-Stats.png)

## Your User Profile

Now that we’ve talked about the network stats, let’s move on to your personal profile. Your personal profile is the place for you to see your network activity, no matter how you’re participating on the network. Your crypto wallet will act as your user profile, and with the User Dashboard, you’ll be able to see:
Your personal profile is the place where you can see your network activity, regardless of your role on the network. Your crypto wallet will act as your user profile, and with the User Dashboard, you’ll be able to see the following tabs:

### Profile Overview

This is where you can see any current actions you took. This is also where you can find your profile information, description, and website (if you added one).
In this section, you can view the following:

- Any of your current actions you've done.
- Your profile information, description, and website (if you added one).

![Explorer Image 10](/img/Profile-Overview.png)

### Subgraphs Tab

If you click into the Subgraphs tab, you’ll see your published subgraphs. This will not include any subgraphs deployed with the CLI for testing purposes – subgraphs will only show up when they are published to the decentralized network.
In the Subgraphs tab, you’ll see your published subgraphs.

> This will not include any subgraphs deployed with the CLI for testing purposes. Subgraphs will only show up when they are published to the decentralized network.

![Explorer Image 11](/img/Subgraphs-Overview.png)

### Indexing Tab

If you click into the Indexing tab, you’ll find a table with all the active and historical allocations towards the subgraphs, as well as charts that you can analyze and see your past performance as an Indexer.
In the Indexing tab, you’ll find a table with all the active and historical allocations towards subgraphs. You will also find charts where you can see and analyze your past performance as an Indexer.

This section will also include details about your net Indexer rewards and net query fees. You’ll see the following metrics:

Expand All @@ -158,7 +189,9 @@ This section will also include details about your net Indexer rewards and net qu

### Delegating Tab

Delegators are important to the Graph Network. A Delegator must use their knowledge to choose an Indexer that will provide a healthy return on rewards. Here you can find details of your active and historical delegations, along with the metrics of the Indexers that you delegated towards.
Delegators are important to the Graph Network. They must use their knowledge to choose an Indexer that will provide a healthy return on rewards.

In the Delegators tab, you can find the details of your active and historical delegations, along with the metrics of the Indexers that you delegated towards.

In the first half of the page, you can see your delegation chart, as well as the rewards-only chart. To the left, you can see the KPIs that reflect your current delegation metrics.

Expand Down
Loading