Skip to content

Commit

Permalink
Glossary page (#265)
Browse files Browse the repository at this point in the history
* Initial commit

* More definitions!

* Allocation phases

* POI

* Allocation defined and some editing

* Tweaks & navigation

* Update pages/en/glossary.mdx

Co-authored-by: Benoît Rouleau <benoit.rouleau@icloud.com>

* Update pages/en/glossary.mdx

Co-authored-by: Benoît Rouleau <benoit.rouleau@icloud.com>

* Update pages/en/glossary.mdx

Co-authored-by: Benoît Rouleau <benoit.rouleau@icloud.com>

* Update pages/en/glossary.mdx

Co-authored-by: Benoît Rouleau <benoit.rouleau@icloud.com>

* Update pages/en/glossary.mdx

Co-authored-by: Benoît Rouleau <benoit.rouleau@icloud.com>

* Update pages/en/glossary.mdx

Co-authored-by: Benoît Rouleau <benoit.rouleau@icloud.com>

* Revisions

* Update glossary.mdx

* Latest feedback

Co-authored-by: Benoît Rouleau <benoit.rouleau@icloud.com>
Co-authored-by: Web3Slimchance <73016650+Web3Slimchance@users.noreply.github.com>
  • Loading branch information
3 people authored Jan 24, 2023
1 parent a7f79a5 commit 32fc69d
Show file tree
Hide file tree
Showing 2 changed files with 83 additions and 1 deletion.
5 changes: 4 additions & 1 deletion navigation/navigation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,10 @@ export const navigation = (locale: AppLocale): NavItemDefinition[] => [
slug: 'network-transition-faq',
},
{
slug: 'tokenomics',
slug: 'glossary',
},
{
slug: 'tokenomics',
},
{
divider: true,
Expand Down
79 changes: 79 additions & 0 deletions pages/en/glossary.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
title: Glossary
---

- **The Graph**: A decentralized protocol for indexing and querying data.

- **Query**: A request for data. In the case of The Graph, a query is a request for data from a subgraph that will be answered by an Indexer.

- **GraphQL**: A query language for APIs and a runtime for fulfilling those queries with your existing data. The Graph uses GraphQL to query subgraphs.

- **Subgraph**: A custom API built on blockchain data that can be queried using [GraphQL](https://graphql.org/). Developers can build, deploy and publish subgraphs to The Graph's decentralized network. Then, Indexers can begin indexing subgraphs to make them available to be queried by subgraph consumers.

- **Hosted Service**: A temporary scaffold service for building and querying subgraphs as The Graph's decentralized network is maturing its cost of service, quality of service, and developer experience.

- **Indexers**: Network participants that run indexing nodes to index data from blockchains and serve GraphQL queries.

- **Indexer Revenue Streams**: Indexers are rewarded in GRT with two components: query fee rebates and indexing rewards.

1. **Query Fee Rebates**: Payments from subgraph consumers for serving queries on the network.

2. **Indexing Rewards**: The rewards that Indexers receive for indexing subgraphs. Indexing rewards are generated via new issuance of 3% GRT annually.

- **Indexer's Self Stake**: The amount of GRT that Indexers stake to participate in the decentralized network. The minimum is 100,000 GRT, and there is no upper limit.

- **Delegators**: Network participants who own GRT and delegate their GRT to Indexers. This allows Indexers to increase their stake in subgraphs on the network. In return, Delegators receive a portion of the Indexing Rewards that Indexers receive for processing subgraphs.

- **Delegation Tax**: A 0.5% fee paid by Delegators when they delegate GRT to Indexers. The GRT used to pay the fee is burned.

- **Curators**: Network participants that identify high-quality subgraphs, and “curate” them (i.e., signal GRT on them) in exchange for curation shares. When Indexers claim query fees on a subgraph, 10% is distributed to the Curators of that subgraph. Indexers earn indexing rewards proportional to the signal on a subgraph. We see a correlation between the amount of GRT signalled and the number of Indexers indexing a subgraph.

- **Curation Tax**: A 1% fee paid by Curators when they signal GRT on subgraphs. The GRT used to pay the fee is burned.

- **Subgraph Consumer**: Any application or user that queries a subgraph.

- **Subgraph Developer**: A developer who builds and deploys a subgraph to The Graph's decentralized network.

- **Subgraph Manifest**: A JSON file that describes the subgraph's GraphQL schema, data sources, and other metadata. [Here](https://ipfs.io/ipfs/QmVQdzeGdPUiLiACeqXRpKAYpyj8Z1yfWLMUq7A7WundUf) is an example.

- **Rebate Pool**: An economic security measure that holds query fees paid by subgraph consumers until they may be claimed by Indexers as query fee rebates. Residual GRT is burned.

- **Epoch**: A unit of time that in network. One epoch is currently 6,646 blocks or approximately 1 day.

- **Allocation**: An Indexer can allocate their total GRT stake (including Delegators' stake) towards subgraphs that have been published on The Graph's decentralized network. Allocations exist in one of four phases.

1. **Active**: An allocation is considered active when it is created on-chain. This is called opening an allocation, and indicates to the network that the Indexer is actively indexing and serving queries for a particular subgraph. Active allocations accrue indexing rewards proportional to the signal on the subgraph, and the amount of GRT allocated.

2. **Closed**: An Indexer may claim the accrued indexing rewards on a given subgraph by submitting a recent, and valid, Proof of Indexing (POI). This is known as closing an allocation. An allocation must have been open for a minimum of one epoch before it can be closed. The maximum allocation period is 28 epochs. If an indexer leaves an allocation open beyond 28 epochs, it is known as a stale allocation. When an allocation is in the **Closed** state, a fisherman can still open a dispute to challenge an Indexer for serving false data.

3. **Finalized**: The dispute period has ended, and query fee rebates are available to be claimed by Indexers.

4. **Claimed**: The final phase of an allocation, all eligible rewards have been distributed and its query fee rebates have been claimed.

- **Subgraph Studio**: A powerful dapp for building, deploying, and publishing subgraphs.

- **Fishermen**: Network participants may dispute Indexers' query responses and POIs. This is called being a Fisherman. A dispute resolved in the Fisherman’s favor results in a financial penalty for the Indexer, along with an award to the Fisherman, thus incentivizing the integrity of the indexing and query work performed by Indexers in the network. The penalty (slashing) is currently set at 2.5% of an Indexer's self stake, with 50% of the slashed GRT going to the Fisherman, and the other 50% being burned.

- **Arbitrators**: Arbitrators are network participants set via govarnence. The role of the Arbitrator is to decide the outcome of indexing and query disputes. Their goal is to maximize the utility and reliability of The Graph Network.

- **Slashing**: Indexers can have their staked GRT slashed for providing an incorrect proof of indexing (POI) or for serving inaccurate data. The slashing percentage is a protocol parameter currently set to 2.5% of an Indexer's self stake. 50% of the slashed GRT goes to the Fisherman that disputed the inaccurate data or incorrect POI. The other 50% is burned.

- **Indexing Rewards**: The rewards that Indexers receive for indexing subgraphs. Indexing rewards are distributed in GRT.

- **Delegation Rewards**: The rewards that Delegators receive for delegating GRT to Indexers. Delegation rewards are distributed in GRT.

- **GRT**: The Graph's work utility token. GRT provides economic incentives to network participants for contributing to the network.

- **POI or Proof of Indexing**: When an Indexer close their allocation and wants to claim their accrued indexer rewards on a given subgraph, they must provide a valid and recent Proof of Indexing (POI). Fishermen may dispute the POI provided by an Indexer. A dispute resolved in the Fisherman's favor will result in slashing of the Indexer.

- **Graph Node**: Graph Node is the component which indexes subgraphs, and makes the resulting data available to query via a GraphQL API. As such it is central to the indexer stack, and correct operation of Graph Node is crucial to running a successful indexer.

- **Indexer agent**: The Indexer agent is part of the indexer stack. It facilitates the Indexer's interactions on-chain, including registering on the network, managing subgraph deployments to its Graph Node(s), and managing allocations.

- **The Graph Client**: A library for building GraphQL-based dapps in a decentralized way.

- **Graph Explorer**: A dapp designed for network participants to explore subgraphs and interact with the protocol.

- **Graph CLI**: A command line interface tool for building and deploying to The Graph.

- **Cooldown Period**: The time remaining until an Indexer who changed their delegation parameters can do so again.

0 comments on commit 32fc69d

Please sign in to comment.