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

Query-Intro #848

Merged
merged 17 commits into from
Jan 13, 2025
Merged
Show file tree
Hide file tree
Changes from 2 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
56 changes: 38 additions & 18 deletions website/pages/en/subgraphs/explorer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@
title: Graph Explorer
---

Learn about The Graph Explorer and access the world of subgraphs and network data.
Unlock the world of subgraphs and network data with [Graph Explorer](https://thegraph.com/explorer).

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

## Video Guide
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.
idalithb marked this conversation as resolved.
Show resolved Hide resolved

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

<VideoEmbed youtube="u224xf7rEBY" />
The following is a breakdown of all the key features of [Graph Explorer](https://thegraph.com/explorer). For additional support, you can watch the [Graph Explorer video guide](/subgraphs/explorer/#video-guide).
idalithb marked this conversation as resolved.
Show resolved Hide resolved

## Subgraphs
### Subgraphs Tab
idalithb marked this conversation as resolved.
Show resolved Hide resolved

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:
After deploying and publishing your subgraph in Subgraph Studio, click the "[subgraphs](https://thegraph.com/explorer?chain=arbitrum-one)" tab at the top of the navigation bar in [Graph Explorer](https://thegraph.com/explorer) to access the following:
idalithb marked this conversation as resolved.
Show resolved Hide resolved

- Your own finished subgraphs
- Subgraphs published by others
Expand All @@ -26,7 +26,8 @@ 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.

- 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)

Expand All @@ -43,11 +44,22 @@ On each subgraph’s dedicated page, you can do the following:

![Explorer Image 3](/img/Explorer-Signal-Unsignal.png)

## Participants
### Delegate Tab
idalithb marked this conversation as resolved.
Show resolved Hide resolved

Under the [delegate tab](https://thegraph.com/explorer/delegate?chain=arbitrum-one), you can find information about delegating, acquiring GRT, and choosing an Indexer.
idalithb marked this conversation as resolved.
Show resolved Hide resolved

On this page, you can see the following:

- Top Indexers by most query fees
- Indexers with the highest estimated APR
idalithb marked this conversation as resolved.
Show resolved Hide resolved

Additionally, you can calculate your ROI and search for top Indexers by name, address, or subgraph.

### Participants Tab
idalithb marked this conversation as resolved.
Show resolved Hide resolved

This section provides a bird' s-eye view of all "participants," which includes everyone participating in the network, such as Indexers, Delegators, and Curators.
idalithb marked this conversation as resolved.
Show resolved Hide resolved

### 1. Indexers
#### 1. Indexers

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

Expand Down Expand Up @@ -76,7 +88,7 @@ To learn more about how to become an Indexer, you can take a look at the [offici

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

### 2. Curators
#### 2. 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.

Expand All @@ -94,32 +106,32 @@ In the The Curator table listed below you can see:

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
#### 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 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. Its recommended to connect with the selected Indexers via [The Graphs Discord](https://discord.gg/graphprotocol) or [The Graph Forum](https://forum.thegraph.com/)!
- 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)

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 Delegators original delegation
- A Delegator's original delegation
idalithb marked this conversation as resolved.
Show resolved Hide resolved
- 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

If you want to learn more about how to become a Delegator, check out the [official documentation](/resources/roles/delegating/) or [The Graph Academy](https://docs.thegraph.academy/official-docs/delegator/choosing-indexers).

## Network
### Network Tab
idalithb marked this conversation as resolved.
Show resolved Hide resolved

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.
idalithb marked this conversation as resolved.
Show resolved Hide resolved

### Overview
#### Overview

The overview section has both all the current network metrics and some cumulative metrics over time:

Expand All @@ -137,7 +149,7 @@ A few key details to note:

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

### Epochs
#### Epochs

In the Epochs section, you can analyze on a per-epoch basis, metrics such as:

Expand Down Expand Up @@ -222,7 +234,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.

Expand All @@ -234,3 +246,11 @@ Within your user profile, you’ll be able to manage your personal profile detai
As your official portal into the world of decentralized data, Graph Explorer allows you to take a variety of actions, no matter your role in the network. You can get to your profile settings by opening the dropdown menu next to your address, then clicking on the Settings button.

<div sx={{ mx: 'auto', maxWidth: '400px' }}>![Wallet details](/img/Wallet-Details.png)</div>

## Additional Resources

### Video Guide

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

<VideoEmbed youtube="u224xf7rEBY" />
24 changes: 17 additions & 7 deletions website/pages/en/subgraphs/querying/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,30 @@
title: Querying The Graph
---

When a subgraph is published to The Graph Network, you can visit its subgraph details page on [Graph Explorer](https://thegraph.com/explorer) and use the "query" tab to explore the deployed GraphQL API for the subgraph, issuing queries and viewing the schema.
To start querying right away, visit [The Graph Explorer](https://thegraph.com/explorer).

> Please see the [Query API](/subgraphs/querying/graphql-api/) for a complete reference on how to query the subgraph's entities. You can learn about GraphQL querying best practices [here](/subgraphs/querying/best-practices/)
## Overview

> Note: If you encounter 405 errors with a GET request to the Graph Explorer URL, please switch to a POST request instead.
When a subgraph is published to The Graph Network, you can visit its subgraph details page on [Graph Explorer](https://thegraph.com/explorer) and use the "query" tab to explore the deployed GraphQL API for each subgraph.
idalithb marked this conversation as resolved.
Show resolved Hide resolved

## Specifics

Each subgraph published to The Graph Network has a unique query URL in Graph Explorer for making direct queries that you can find by navigating to the subgraph details page and clicking on the "Query" button on the top right corner.
Each subgraph published to The Graph Network has a unique query URL in [Graph Explorer](https://thegraph.com/explorer) to make direct queries. You can find it by navigating to the subgraph details page and clicking on the "Query" button in the top right corner.
idalithb marked this conversation as resolved.
Show resolved Hide resolved

![Query Subgraph Button](/img/query-button-screenshot.png)

![Query Subgraph URL](/img/query-url-screenshot.png)

Learn more about querying from an application [here](/subgraphs/querying/from-an-application/).
You will notice that this query URL must use a unique API key. You can create and manage your API keys in [Subgraph Studio](https://thegraph.com/studio), under the "API Keys" section. Learn more about how to use Subgraph Studio [here](/deploying/subgraph-studio/).

- Subgraph Studio users start on a Free Plan, which allows them to make 100,000 queries per month. Additional queries are available on the Growth Plan, which offers usage based pricing for additional queries, payable by credit card, or GRT on Arbitrum. You can learn more about billing [here](/subgraphs/billing/).
idalithb marked this conversation as resolved.
Show resolved Hide resolved

> Please see the [Query API](/subgraphs/querying/graphql-api/) for a complete reference on how to query the subgraph's entities.

> Note: If you encounter 405 errors with a GET request to the Graph Explorer URL, please switch to a POST request instead.

As you can notice, this query URL must use a unique API key. You can create and manage your API keys in [Subgraph Studio](https://thegraph.com/studio), in the "API Keys" section. Learn more about how to use Subgraph Studio [here](/deploying/subgraph-studio/).
### Additional Resources

Subgraph Studio users start on a Free Plan, which allows them to make 100,000 queries per month. Additional queries are available on the Growth Plan, which offers usage based pricing for additional queries, payable by credit card, or GRT on Arbitrum. You can learn more about billing [here](/subgraphs/billing/).
- Use [GraphQL querying best practices](/subgraphs/querying/best-practices/).
- To query from an application, click [here](/subgraphs/querying/from-an-application/).
- View [querying examples](https://github.com/graphprotocol/query-examples/tree/main).
Loading