diff --git a/website/public/img/Curation-Overview.png b/website/public/img/Curation-Overview.png deleted file mode 100644 index afb8d43c4e6d..000000000000 Binary files a/website/public/img/Curation-Overview.png and /dev/null differ diff --git a/website/public/img/Delegation-Overview.png b/website/public/img/Delegation-Overview.png deleted file mode 100644 index 9ad2c82dadaa..000000000000 Binary files a/website/public/img/Delegation-Overview.png and /dev/null differ diff --git a/website/public/img/Epoch-Stats.png b/website/public/img/Epoch-Stats.png deleted file mode 100644 index 02f0f5a18996..000000000000 Binary files a/website/public/img/Epoch-Stats.png and /dev/null differ diff --git a/website/public/img/Explorer-Signal-Unsignal.png b/website/public/img/Explorer-Signal-Unsignal.png deleted file mode 100644 index 7bd66704d556..000000000000 Binary files a/website/public/img/Explorer-Signal-Unsignal.png and /dev/null differ diff --git a/website/public/img/Indexer-Pane.png b/website/public/img/Indexer-Pane.png deleted file mode 100644 index b17e98ee42c1..000000000000 Binary files a/website/public/img/Indexer-Pane.png and /dev/null differ diff --git a/website/public/img/Network-Stats.png b/website/public/img/Network-Stats.png deleted file mode 100644 index 95d841b2f455..000000000000 Binary files a/website/public/img/Network-Stats.png and /dev/null differ diff --git a/website/public/img/Subgraph-Details.png b/website/public/img/Subgraph-Details.png deleted file mode 100644 index b876e87898bd..000000000000 Binary files a/website/public/img/Subgraph-Details.png and /dev/null differ diff --git a/website/public/img/Subgraphs-Explorer-Landing.png b/website/public/img/Subgraphs-Explorer-Landing.png deleted file mode 100644 index 3af3c15c9039..000000000000 Binary files a/website/public/img/Subgraphs-Explorer-Landing.png and /dev/null differ diff --git a/website/public/img/explorer-curators.png b/website/public/img/explorer-curators.png new file mode 100644 index 000000000000..908705c20edb Binary files /dev/null and b/website/public/img/explorer-curators.png differ diff --git a/website/public/img/explorer-delegators.png b/website/public/img/explorer-delegators.png new file mode 100644 index 000000000000..3af21f21521a Binary files /dev/null and b/website/public/img/explorer-delegators.png differ diff --git a/website/public/img/explorer-epochs.png b/website/public/img/explorer-epochs.png new file mode 100644 index 000000000000..592082551241 Binary files /dev/null and b/website/public/img/explorer-epochs.png differ diff --git a/website/public/img/explorer-indexers.png b/website/public/img/explorer-indexers.png new file mode 100644 index 000000000000..982d33226d92 Binary files /dev/null and b/website/public/img/explorer-indexers.png differ diff --git a/website/public/img/explorer-network.png b/website/public/img/explorer-network.png new file mode 100644 index 000000000000..96c07328b9c7 Binary files /dev/null and b/website/public/img/explorer-network.png differ diff --git a/website/public/img/explorer-search.png b/website/public/img/explorer-search.png new file mode 100644 index 000000000000..91b92151b1f4 Binary files /dev/null and b/website/public/img/explorer-search.png differ diff --git a/website/public/img/explorer-signal.png b/website/public/img/explorer-signal.png new file mode 100644 index 000000000000..ad05e00d3383 Binary files /dev/null and b/website/public/img/explorer-signal.png differ diff --git a/website/public/img/explorer-subgraph-details.png b/website/public/img/explorer-subgraph-details.png new file mode 100644 index 000000000000..15ca8fea8f1f Binary files /dev/null and b/website/public/img/explorer-subgraph-details.png differ diff --git a/website/public/img/explorer-subgraphs-tab.png b/website/public/img/explorer-subgraphs-tab.png new file mode 100644 index 000000000000..8e297d4dfa6b Binary files /dev/null and b/website/public/img/explorer-subgraphs-tab.png differ diff --git a/website/src/pages/en/subgraphs/explorer.mdx b/website/src/pages/en/subgraphs/explorer.mdx index 499fcede88d3..06cc22c5139c 100644 --- a/website/src/pages/en/subgraphs/explorer.mdx +++ b/website/src/pages/en/subgraphs/explorer.mdx @@ -2,83 +2,103 @@ title: Graph Explorer --- -Unlock the world of Subgraphs and network data with [Graph Explorer](https://thegraph.com/explorer). +Use [Graph Explorer](https://thegraph.com/explorer) and take full advantage of its core features. ## Overview -Graph Explorer consists of multiple parts where you can interact with [Subgraphs](https://thegraph.com/explorer?chain=arbitrum-one), [delegate](https://thegraph.com/explorer/delegate?chain=arbitrum-one), engage [participants](https://thegraph.com/explorer/participants?chain=arbitrum-one), view [network information](https://thegraph.com/explorer/network?chain=arbitrum-one), and access your user profile. +This guide explains how to use [Graph Explorer](https://thegraph.com/explorer) to quickly discover and interact with Subgraphs on The Graph Network, delegate GRT, view participant metrics, and analyze network performance. -## Inside Explorer +> When you visit Graph Explorer, you can also access the link to [explore Substreams](https://substreams.dev/). -The following is a breakdown of all the key features of Graph Explorer. For additional support, you can watch the [Graph Explorer video guide](/subgraphs/explorer/#video-guide). +## Prerequisites -### Subgraphs Page +- To perform actions, a need wallet (e.g., MetaMask) connected to [Graph Explorer](https://thegraph.com/explorer). + > Make sure your wallet is connected to the correct network (e.g., Arbitrum). Features and data shown are network specific. +- GRT tokens if you plan to delegate or curate. +- Basic knowledge of Subgraphs -After deploying and publishing your Subgraph in Subgraph Studio, go to [Graph Explorer](https://thegraph.com/explorer) and click on the "[Subgraphs](https://thegraph.com/explorer?chain=arbitrum-one)" link in the navigation bar to access the following: +## Navigating Graph Explorer -- Your own finished Subgraphs -- Subgraphs published by others -- The exact Subgraph you want (based on the date created, signal amount, or name). +### Step 1. Explore Subgraphs -![Explorer Image 1](/img/Subgraphs-Explorer-Landing.png) +> For additional support, you can watch the [Graph Explorer video guide](/subgraphs/explorer/#video-guide). -When you click into a Subgraph, you will be able to do the following: +Go to the Subgraphs tab in [Graph Explorer](https://thegraph.com/explorer). -- 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. +- If you've deployed and published your Subgraph in Subgraph Studio, you can view it here. +- Search all published Subgraphs and filter them by indexed network, specific categories (such as DeFI, NFTs, and DAOs), and **most queried, most curated, recently created, and recently updated**. + +![Graph Explorer Subgraphs tab](/img/explorer-subgraphs-tab.png) + +To find Subgraphs indexing a specific contract, enter the contract address into the search bar. + +- For example, you can enter the L2GNS contract on Artbitrum (`0xec9A7fb6CbC2E41926127929c2dcE6e9c5D33Bec`) and this returns all Subgraphs indexing that contract: + +![Search by Indexing Contract](/img/explorer-search.png) + +> Looking for indexing contracts? Check out [this Subgraph](https://thegraph.com/explorer/subgraphs/FMTUN6d7sY2bLnAmNEPJTqiU3iuQht6ZXurpBh71wbWR?view=About&chain=arbitrum-one) which indexes contract addresses listed in its manifest. It shows all current deployments indexing those contracts on Arbitrum One, along with the signal allocated to each. + +You can click into any Subgraph, to: - - This is critical because signaling on a Subgraph incentivizes it to be indexed, meaning it’ll eventually surface on the network to serve queries. +- 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) +![Subgraph Details](/img/explorer-subgraph-details.png) 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 -- Switch versions to explore past iterations of the Subgraph - Query Subgraphs via GraphQL +- View Subgraph ID, current deployment ID, Query URL, and other metadata +- Signal/Un-signal on Subgraphs - Test Subgraphs in the playground - View the Indexers that are indexing on a certain Subgraph - Subgraph stats (allocations, Curators, etc) -- View the entity who published the Subgraph +- View query fees and charts +- Change versions to explore past iterations of the Subgraph +- View entity types +- View Subgraph activity -![Explorer Image 3](/img/Explorer-Signal-Unsignal.png) +![Signal/Un-signal on Subgraph](/img/explorer-signal.png) -### Delegate Page +### Step 2. Delegate GRT -On the [Delegate page](https://thegraph.com/explorer/delegate?chain=arbitrum-one), you can find information about delegating, acquiring GRT, and choosing an Indexer. +Go to the [Delegate](https://thegraph.com/explorer/delegate?chain=arbitrum-one) tab to learn how to delegate, get GRT, and choose and Indexer. -On this page, you can see the following: +Here, you can: -- Indexers who collected the most query fees -- Indexers with the highest estimated APR +- Compare Indexers by most query fees earned and highest estimated APR +- Use the built-in ROI calculator or search by Indexer name or address. +- Click **"Delegate"** next to an Indexer to stake your GRT -Additionally, you can calculate your ROI and search for top Indexers by name, address, or Subgraph. +### Step 3. Monitor Participants in the Network -### Participants Page +Go to the [Participants](https://thegraph.com/explorer/participants?chain=arbitrum-one) tab to view: -This page provides a bird's-eye view of all "participants," which includes everyone participating in the network, such as Indexers, Delegators, and Curators. +- Indexers: stakes, allocations, rewards, and delegation parameters +- Curators: signal amounts, Subgraph shares, and activity history +- Delegators: current and historical delegations, rewards, and Indexer metrics -#### 1. Indexers +#### Indexers -![Explorer Image 4](/img/Indexer-Pane.png) +![Indexers Table](/img/explorer-indexers.png) 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. +In the Indexers table, you can see an Indexer's 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. **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. -- 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. +- 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. +- Indexing Rewards: This is the total indexing 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. @@ -86,9 +106,9 @@ Indexers can earn both query fees and indexing rewards. Functionally, this happe To learn more about how to become an Indexer, you can take a look at the [official documentation](/indexing/overview/) or [The Graph Academy Indexer guides.](https://thegraph.academy/delegators/choosing-indexers/) -![Indexing details pane](/img/Indexing-Details-Pane.png) +![Indexing Details Pane](/img/Indexing-Details-Pane.png) -#### 2. Curators +#### Curators 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. @@ -102,19 +122,19 @@ In the The Curator table listed below you can see: - The number of GRT that was deposited - The number of shares a Curator owns -![Explorer Image 6](/img/Curation-Overview.png) +![Curators Table](/img/explorer-curators.png) If you want to learn more about the Curator role, you can do so by visiting [official documentation.](/resources/roles/curating/) or [The Graph Academy](https://thegraph.academy/curators/). -#### 3. Delegators +#### 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. +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 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) +![Delegators Table](/img/explorer-delegators.png) In the Delegators table you can see the active Delegators in the community and important metrics: @@ -127,9 +147,9 @@ In the Delegators table you can see the active Delegators in the community and i If you want to learn more about how to become a Delegator, check out the [official documentation](/resources/roles/delegating/delegating/) or [The Graph Academy](https://docs.thegraph.academy/official-docs/delegator/choosing-indexers). -### Network Page +### Step 4. Analyze Network Performance -On this page, you can see global KPIs and have 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. +On the [Network](https://thegraph.com/explorer/network?chain=arbitrum-one) tab, you can see global KPIs and have 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 @@ -147,7 +167,7 @@ A few key details to note: - **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) +![Network Overview](/img/explorer-network.png) #### Epochs @@ -161,69 +181,77 @@ In the Epochs section, you can analyze on a per-epoch basis, metrics such as: - 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. -![Explorer Image 9](/img/Epoch-Stats.png) +![Epochs](/img/explorer-epochs.png) + +## Access and Manage Your User Profile -## Your User Profile +### Step 1. Access Your Profile -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: +- Click your wallet address in the top right corner +- Your wallet acts as your user profile +- In your profile dashboard, you can view and interact with several useful tabs -### Profile Overview +### Step 2. Explore the Tabs + +#### Profile Overview 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). +- Your activity +- Your profile information: total query fees, total shares value, owned stake. stake delegating ![Explorer Image 10](/img/Profile-Overview.png) -### Subgraphs Tab +#### Subgraphs Tab -In the Subgraphs tab, you’ll see your published Subgraphs. +The Subgraphs tab displays all 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. +> Subgraphs deployed with the CLI for testing purposes will not show up here. Subgraphs will only show up when they are published to the decentralized network. ![Explorer Image 11](/img/Subgraphs-Overview.png) -### Indexing Tab +#### Indexing Tab -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. +> If you haven't indexed, you see links to stake to index Subgraphs and browse Subgraphs on Graph Explorer. -This section will also include details about your net Indexer rewards and net query fees. You’ll see the following metrics: +The Indexing tab displays a table where you can review active and historical allocations to Subgraphs. -- Delegated Stake - the stake from Delegators that can be allocated by you but cannot be slashed -- Total Query Fees - the total fees that users have paid for queries served by you over time -- Indexer Rewards - the total amount of Indexer rewards you have received, in GRT -- Fee Cut - the % of query fee rebates that you will keep when you split with Delegators -- Rewards Cut - the % of Indexer rewards that you will keep when splitting with Delegators -- Owned - your deposited stake, which could be slashed for malicious or incorrect behavior +Track your Indexer performance with visual charts and key metrics, including: -![Explorer Image 12](/img/Indexer-Stats.png) +- Delegated Stake - Stake from Delegators that can be allocated by you but cannot be slashed +- Total Query Fees - Cumulative fees from served queries +- Indexer Rewards (in GRT) - Total rewards earned +- Fee Cut & Rewards Cut - the % of query fee rebates and Indexer rewards you'll keep when you split with Delegators +- Owned Stake - your deposited stake, which could be slashed for malicious or incorrect behavior -### Delegating Tab +![Explorer Image 12](/img/Indexer-Stats.png) -Delegators are important to the Graph Network. They must use their knowledge to choose an Indexer that will provide a healthy return on rewards. +#### Delegating Tab -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. +> To learn more about the benefits of delegating, check out [delegating](/resources/roles/delegating/delegating/) -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. +The Delegators tab displays your active and historical delegations, along with the metrics for the Indexers you've delegated to. -The Delegator metrics you’ll see here in this tab include: +Top Section: +- View delegation and rewards-only charts +- Track key metrics: - Total delegation rewards -- Total unrealized rewards -- Total realized rewards +- Unrealized rewards +- Realized Rewards -In the second half of the page, you have the delegations table. Here you can see the Indexers that you delegated towards, as well as their details (such as rewards cuts, cooldown, etc). +Bottom Section: -With the buttons on the right side of the table, you can manage your delegation - delegate more, undelegate, or withdraw your delegation after the thawing period. +- Explore a table of your Indexer delegations, including reward cuts, cooldowns, and more +- Use the buttons on the right side of the table to manage your delegation - delegate more, undelegate, or withdraw it after the thawing period -Keep in mind that this chart is horizontally scrollable, so if you scroll all the way to the right, you can also see the status of your delegation (delegating, undelegating, withdrawable). +> This table is horizontal scrollable, so scroll right to see delegation status: delegating, undelegating, or withdrawable. ![Explorer Image 13](/img/Delegation-Stats.png) -### Curating Tab +#### Curating Tab -In the Curation tab, you’ll find all the Subgraphs you’re signaling on (thus enabling you to receive query fees). Signaling allows Curators to highlight to Indexers which Subgraphs are valuable and trustworthy, thus signaling that they need to be indexed on. +The Curation tab displays all the Subgraphs you’re signaling on (thus enabling you to receive query fees). Signaling allows Curators to highlight to Indexers which Subgraphs are valuable and trustworthy, thus signaling that they need to be indexed on. Within this tab, you’ll find an overview of: @@ -234,7 +262,7 @@ Within this tab, you’ll find an overview of: ![Explorer Image 14](/img/Curation-Stats.png) -### Your Profile Settings +#### Your Profile Settings Within your user profile, you’ll be able to manage your personal profile details (like setting up an ENS name). If you’re an Indexer, you have even more access to settings at your fingertips. In your user profile, you’ll be able to set up your delegation parameters and operators. @@ -247,7 +275,7 @@ As your official portal into the world of decentralized data, Graph Explorer all ![Wallet details](/img/Wallet-Details.png) -## Additional Resources +### Additional Resources ### Video Guide