Skip to content

Commit 8e9bcf8

Browse files
authored
Graph explorer (#775)
* Edits * updated changes
1 parent f2384c4 commit 8e9bcf8

File tree

1 file changed

+67
-34
lines changed

1 file changed

+67
-34
lines changed

website/pages/en/network/explorer.mdx

Lines changed: 67 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,35 @@
22
title: Graph Explorer
33
---
44

5-
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):
5+
Learn about The Graph Explorer and access the world of subgraphs and network data.
6+
7+
Graph Explorer consists of multiple parts where you can interact with other subgraph developers, dapp developers, Curators, Indexers, and Delegators.
8+
9+
## Video Guide
10+
11+
For a general overview of Graph Explorer, check out the video below:
612

713
<VideoEmbed youtube="u224xf7rEBY" />
814

915
## Subgraphs
1016

11-
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.
17+
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:
18+
19+
- Your own finished subgraphs
20+
- Subgraphs published by others
21+
- The exact subgraph you want (based on the date created, signal amount, or name).
1222

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

15-
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.
25+
When you click into a subgraph, you will be able to do the following:
26+
27+
- Test queries in the playground and be able to leverage network details to make informed decisions.
28+
- Signal GRT on your own subgraph or the subgraphs of others to make indexers aware of its importance and quality.
29+
- This is critical because signaling on a subgraph incentivizes it to be indexed, meaning it’ll eventually surface on the network to serve queries.
1630

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

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

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

3246
## Participants
3347

34-
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.
48+
This section provides a bird' s-eye view of all "participants," which includes everyone participating in the network, such as Indexers, Delegators, and Curators.
3549

3650
### 1. Indexers
3751

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

40-
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:
54+
Indexers are the backbone of the protocol. They stake on subgraphs, index them, and serve queries to anyone consuming subgraphs.
55+
56+
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.
4157

42-
- Query Fee Cut - the % of the query fee rebates that the Indexer keeps when splitting with Delegators
43-
- 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
44-
- 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
45-
- Owned - This is the Indexer’s deposited stake, which may be slashed for malicious or incorrect behavior
46-
- Delegated - Stake from Delegators which can be allocated by the Indexer, but cannot be slashed
47-
- Allocated - Stake that Indexers are actively allocating towards the subgraphs they are indexing
48-
- Available Delegation Capacity - the amount of delegated stake the Indexers can still receive before they become over-delegated
58+
**Specifics**
59+
60+
- Query Fee Cut - the % of the query fee rebates that the Indexer keeps when splitting with Delegators.
61+
- 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.
62+
- 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.
63+
- Owned - This is the Indexer’s deposited stake, which may be slashed for malicious or incorrect behavior.
64+
- Delegated - Stake from Delegators which can be allocated by the Indexer, but cannot be slashed.
65+
- Allocated - Stake that Indexers are actively allocating towards the subgraphs they are indexing.
66+
- Available Delegation Capacity - the amount of delegated stake the Indexers can still receive before they become over-delegated.
4967
- 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.
50-
- Query Fees - this is the total fees that end users have paid for queries from an Indexer over all time
68+
- Query Fees - this is the total fees that end users have paid for queries from an Indexer over all time.
5169
- 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.
5270

53-
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.
71+
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.
72+
73+
- 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.
5474

5575
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/)
5676

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

5979
### 2. Curators
6080

61-
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.
81+
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.
82+
83+
- 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.
84+
- 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.
85+
- The bonding curve incentivizes Curators to curate the highest quality data sources.
6286

63-
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:
87+
In the The Curator table listed below you can see:
6488

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

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

71-
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)
95+
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/).
7296

7397
### 3. Delegators
7498

75-
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.
99+
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.
76100

77-
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/)!
101+
- 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.
102+
- Delegators select Indexers based on a number of different variables, such as past performance, indexing reward rates, and query fee cuts.
103+
- 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/)!
78104

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

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

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

90-
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).
116+
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).
91117

92118
## Network
93119

94-
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.
120+
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.
95121

96122
### Overview
97123

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

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

107-
A few key details that are worth mentioning:
133+
A few key details to note:
108134

109-
- **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.
110-
- **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).
135+
- **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.
136+
- **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).
111137

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

@@ -121,29 +147,34 @@ In the Epochs section, you can analyze on a per-epoch basis, metrics such as:
121147
- The active epoch is the one in which Indexers are currently allocating stake and collecting query fees
122148
- 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.
123149
- 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.
124-
- The finalized epochs are the epochs that have no query fee rebates left to claim by the Indexers, thus being finalized.
150+
- The finalized epochs are the epochs that have no query fee rebates left to claim by the Indexers.
125151

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

128154
## Your User Profile
129155

130-
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:
156+
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:
131157

132158
### Profile Overview
133159

134-
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).
160+
In this section, you can view the following:
161+
162+
- Any of your current actions you've done.
163+
- Your profile information, description, and website (if you added one).
135164

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

138167
### Subgraphs Tab
139168

140-
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.
169+
In the Subgraphs tab, you’ll see your published subgraphs.
170+
171+
> 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.
141172
142173
![Explorer Image 11](/img/Subgraphs-Overview.png)
143174

144175
### Indexing Tab
145176

146-
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.
177+
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.
147178

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

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

159190
### Delegating Tab
160191

161-
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.
192+
Delegators are important to the Graph Network. They must use their knowledge to choose an Indexer that will provide a healthy return on rewards.
193+
194+
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.
162195

163196
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.
164197

0 commit comments

Comments
 (0)