Skip to content

Commit

Permalink
[ix]: minor chore updates (#645)
Browse files Browse the repository at this point in the history
* [ix]: minor chore updates

* add missing link

* [fix] latest updates

* [fix] pnpm check:fix
  • Loading branch information
yash251 authored Apr 23, 2024
1 parent 836e363 commit 8b1fa6e
Show file tree
Hide file tree
Showing 10 changed files with 27 additions and 25 deletions.
2 changes: 1 addition & 1 deletion website/pages/en/about.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ The flow follows these steps:

In the following sections we will go into more detail on how to define subgraphs, how to deploy them, and how to query data from the indexes that Graph Node builds.

Before you start writing your own subgraph, you might want to have a look at the Graph Explorer and explore some of the subgraphs that have already been deployed. The page for each subgraph contains a playground that lets you query that subgraph's data with GraphQL.
Before you start writing your own subgraph, you might want to have a look at [Graph Explorer](https://thegraph.com/explorer) and explore some of the subgraphs that have already been deployed. The page for each subgraph contains a playground that lets you query that subgraph's data with GraphQL.
2 changes: 1 addition & 1 deletion website/pages/en/arbitrum/arbitrum-faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Please help [test the network](https://testnet.thegraph.com/explorer) on L2 and

## Are there any risks associated with scaling the network to L2?

All smart contracts have been thoroughly [audited](https://github.com/graphprotocol/contracts/blob/dev/audits/OpenZeppelin/2022-07-graph-arbitrum-bridge-audit.pdf).
All smart contracts have been thoroughly [audited](https://github.com/graphprotocol/contracts/blob/main/packages/contracts/audits/OpenZeppelin/2022-07-graph-arbitrum-bridge-audit.pdf).

Everything has been tested thoroughly, and a contingency plan is in place to ensure a safe and seamless transition. Details can be found [here](https://forum.thegraph.com/t/gip-0037-the-graph-arbitrum-deployment-with-linear-rewards-minted-in-l2/3551#risks-and-security-considerations-20).

Expand Down
2 changes: 0 additions & 2 deletions website/pages/en/developing/supported-networks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ export const getStaticProps = getStaticPropsForSupportedNetworks(__filename)

The hosted service relies on the stability and reliability of the underlying technologies, namely the provided JSON RPC endpoints.

Ropsten, Rinkeby and Kovan are being deprecated. Read more on the [Ethereum Foundation Blog](https://blog.ethereum.org/2022/06/21/testnet-deprecation). As of Feb 25th 2023, Ropsten, Rinkeby and Kovan are no longer supported by the hosted service. Goerli will be maintained by client developers post-merge, and is also supported by the hosted service. Developers who currently use Ropsten, Rinkeby or Kovan as their staging/testing environment are encouraged to migrate to Goerli.

Subgraphs indexing Gnosis Chain can now be deployed with the `gnosis` network identifier. `xdai` is still supported for existing hosted service subgraphs.

For a full list of which features are supported on the decentralized network, see [this page](https://github.com/graphprotocol/indexer/blob/main/docs/feature-support-matrix.md).
Expand Down
2 changes: 1 addition & 1 deletion website/pages/en/glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ title: Glossary

- **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.
- **Subgraph Manifest**: A JSON file that describes the subgraph's GraphQL schema, data sources, and other metadata. [Here](https://github.com/graphprotocol/example-subgraph/blob/master/subgraph.yaml) is an example.

- **Epoch**: A unit of time within the network. Currently, one epoch is 6,646 blocks or approximately 1 day.

Expand Down
4 changes: 2 additions & 2 deletions website/pages/en/network/explorer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,9 @@ If you want to learn more about how to become a Delegator, look no further! All

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.

### Activity
### Overview

The activity 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 all the current network metrics as well as some cumulative metrics over time. Here you can see things like:

- The current total network stake
- The stake split between the Indexers and their Delegators
Expand Down
30 changes: 17 additions & 13 deletions website/pages/en/network/indexing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The minimum stake for an Indexer is currently set to 100K GRT.

Indexing rewards come from protocol inflation which is set to 3% annual issuance. They are distributed across subgraphs based on the proportion of all curation signal on each, then distributed proportionally to Indexers based on their allocated stake on that subgraph. **An allocation must be closed with a valid proof of indexing (POI) that meets the standards set by the arbitration charter in order to be eligible for rewards.**

Numerous tools have been created by the community for calculating rewards; you'll find a collection of them organized in the [Community Guides collection](https://www.notion.so/Community-Guides-abbb10f4dba040d5ba81648ca093e70c). You can also find an up to date list of tools in the #Delegators and #Indexers channels on the [Discord server](https://discord.gg/graphprotocol). Here we link a [recommended allocation optimiser](https://github.com/graphprotocol/AllocationOpt.jl) integrated with the indexer software stack.
Numerous tools have been created by the community for calculating rewards; you'll find a collection of them organized in the [Community Guides collection](https://www.notion.so/Community-Guides-abbb10f4dba040d5ba81648ca093e70c). You can also find an up to date list of tools in the #Delegators and #Indexers channels on the [Discord server](https://discord.gg/graphprotocol). Here we link a [recommended allocation optimiser](https://github.com/graphprotocol/allocation-optimizer) integrated with the indexer software stack.

### What is a proof of indexing (POI)?

Expand All @@ -38,7 +38,7 @@ Allocations are continuously accruing rewards while they're active and allocated

### Can pending indexing rewards be monitored?

The RewardsManager contract has a read-only [getRewards](https://github.com/graphprotocol/contracts/blob/master/contracts/rewards/RewardsManager.sol#L317) function that can be used to check the pending rewards for a specific allocation.
The RewardsManager contract has a read-only [getRewards](https://github.com/graphprotocol/contracts/blob/main/packages/contracts/contracts/rewards/RewardsManager.sol#L316) function that can be used to check the pending rewards for a specific allocation.

Many of the community-made dashboards include pending rewards values and they can be easily checked manually by following these steps:

Expand All @@ -63,7 +63,7 @@ Use Etherscan to call `getRewards()`:
- Navigate to [Etherscan interface to Rewards contract](https://etherscan.io/address/0x9Ac758AB77733b4150A901ebd659cbF8cB93ED66#readProxyContract)

* To call `getRewards()`:
- Expand the **10. getRewards** dropdown.
- Expand the **9. getRewards** dropdown.
- Enter the **allocationID** in the input.
- Click the **Query** button.

Expand Down Expand Up @@ -182,9 +182,9 @@ Note: To support agile scaling, it is recommended that query and indexing concer

#### Create a Google Cloud Project

- Clone or navigate to the Indexer repository.
- Clone or navigate to the [Indexer repository](https://github.com/graphprotocol/indexer).

- Navigate to the ./terraform directory, this is where all commands should be executed.
- Navigate to the `./terraform` directory, this is where all commands should be executed.

```sh
cd terraform
Expand Down Expand Up @@ -297,7 +297,7 @@ Deploy all resources with `kubectl apply -k $dir`.

### Graph Node

[Graph Node](https://github.com/graphprotocol/graph-node) is an open source Rust implementation that event sources the Ethereum blockchain to deterministically update a data store that can be queried via the GraphQL endpoint. Developers use subgraphs to define their schema, and a set of mappings for transforming the data sourced from the block chain and the Graph Node handles syncing the entire chain, monitoring for new blocks, and serving it via a GraphQL endpoint.
[Graph Node](https://github.com/graphprotocol/graph-node) is an open source Rust implementation that event sources the Ethereum blockchain to deterministically update a data store that can be queried via the GraphQL endpoint. Developers use subgraphs to define their schema, and a set of mappings for transforming the data sourced from the blockchain and the Graph Node handles syncing the entire chain, monitoring for new blocks, and serving it via a GraphQL endpoint.

#### Getting started from source

Expand Down Expand Up @@ -750,7 +750,9 @@ indexer cost set model my_model.agora

### Stake in the protocol

The first steps to participating in the network as an Indexer are to approve the protocol, stake funds, and (optionally) set up an operator address for day-to-day protocol interactions. _ **Note**: For the purposes of these instructions Remix will be used for contract interaction, but feel free to use your tool of choice ([OneClickDapp](https://oneclickdapp.com/), [ABItopic](https://abitopic.io/), and [MyCrypto](https://www.mycrypto.com/account) are a few other known tools)._
The first steps to participating in the network as an Indexer are to approve the protocol, stake funds, and (optionally) set up an operator address for day-to-day protocol interactions.

> Note: For the purposes of these instructions Remix will be used for contract interaction, but feel free to use your tool of choice ([OneClickDapp](https://oneclickdapp.com/), [ABItopic](https://abitopic.io/), and [MyCrypto](https://www.mycrypto.com/account) are a few other known tools).
Once an Indexer has staked GRT in the protocol, the [Indexer components](/network/indexing#indexer-components) can be started up and begin their interactions with the network.

Expand All @@ -760,7 +762,7 @@ Once an Indexer has staked GRT in the protocol, the [Indexer components](/networ

2. In the `File Explorer` create a file named **GraphToken.abi** with the [token ABI](https://raw.githubusercontent.com/graphprotocol/contracts/mainnet-deploy-build/build/abis/GraphToken.json).

3. With `GraphToken.abi` selected and open in the editor, switch to the Deploy and `Run Transactions` section in the Remix interface.
3. With `GraphToken.abi` selected and open in the editor, switch to the `Deploy and run transactions` section in the Remix interface.

4. Under environment select `Injected Web3` and under `Account` select your Indexer address.

Expand All @@ -774,7 +776,7 @@ Once an Indexer has staked GRT in the protocol, the [Indexer components](/networ

2. In the `File Explorer` create a file named **Staking.abi** with the staking ABI.

3. With `Staking.abi` selected and open in the editor, switch to the `Deploy` and `Run Transactions` section in the Remix interface.
3. With `Staking.abi` selected and open in the editor, switch to the `Deploy and run transactions` section in the Remix interface.

4. Under environment select `Injected Web3` and under `Account` select your Indexer address.

Expand All @@ -792,7 +794,7 @@ setDelegationParameters(950000, 600000, 500)

### Setting delegation parameters

The `setDelegationParameters()` function in the [staking contract](https://github.com/graphprotocol/contracts/blob/main/contracts/staking/Staking.sol) is essential for Indexers, allowing them to set parameters that define their interactions with Delegators, influencing their reward sharing and delegation capacity.
The `setDelegationParameters()` function in the [staking contract](https://github.com/graphprotocol/contracts/blob/main/packages/contracts/contracts/staking/Staking.sol) is essential for Indexers, allowing them to set parameters that define their interactions with Delegators, influencing their reward sharing and delegation capacity.

### How to set delegation parameters

Expand All @@ -802,14 +804,16 @@ To set the delegation parameters using the Graph Explorer interface, follow thes
2. Connect your wallet. Choose multisig (such as Gnosis Safe) and then select mainnet. Note: You will need to repeat this process for Arbitrum One.
3. Connect the wallet you have as a signer.
4. Navigate to the 'Settings' section and select 'Delegation Parameters'. These parameters should be configured to achieve an effective cut within the desired range. Upon entering values in the provided input fields, the interface will automatically calculate the effective cut. Adjust these values as necessary to attain the desired effective cut percentage.
5. Submit the transaction to the network. Note: This transaction will need to be confirmed by the multisig wallet signers.
5. Submit the transaction to the network.

> Note: This transaction will need to be confirmed by the multisig wallet signers.
### The life of an allocation

After being created by an Indexer a healthy allocation goes through four states.

- **Active** - Once an allocation is created on-chain ([allocateFrom()](https://github.com/graphprotocol/contracts/blob/master/contracts/staking/Staking.sol#L873)) it is considered **active**. A portion of the Indexer's own and/or delegated stake is allocated towards a subgraph deployment, which allows them to claim indexing rewards and serve queries for that subgraph deployment. The Indexer agent manages creating allocations based on the Indexer rules.
- **Active** - Once an allocation is created on-chain ([allocateFrom()](https://github.com/graphprotocol/contracts/blob/main/packages/contracts/contracts/staking/Staking.sol#L316)) it is considered **active**. A portion of the Indexer's own and/or delegated stake is allocated towards a subgraph deployment, which allows them to claim indexing rewards and serve queries for that subgraph deployment. The Indexer agent manages creating allocations based on the Indexer rules.

- **Closed** - An Indexer is free to close an allocation once 1 epoch has passed ([closeAllocation()](https://github.com/graphprotocol/contracts/blob/master/contracts/staking/Staking.sol#L873)) or their Indexer agent will automatically close the allocation after the **maxAllocationEpochs** (currently 28 days). When an allocation is closed with a valid proof of indexing (POI) their indexing rewards are distributed to the Indexer and its Delegators (see "how are rewards distributed?" below to learn more).
- **Closed** - An Indexer is free to close an allocation once 1 epoch has passed ([closeAllocation()](https://github.com/graphprotocol/contracts/blob/main/packages/contracts/contracts/staking/Staking.sol#L335)) or their Indexer agent will automatically close the allocation after the **maxAllocationEpochs** (currently 28 days). When an allocation is closed with a valid proof of indexing (POI) their indexing rewards are distributed to the Indexer and its Delegators ([learn more](https://thegraph.com/docs/en/network/indexing/#how-are-indexing-rewards-distributed)).

Indexers are recommended to utilize offchain syncing functionality to sync subgraph deployments to chainhead before creating the allocation on-chain. This feature is especially useful for subgraphs that may take longer than 28 epochs to sync or have some chances of failing undeterministically.
2 changes: 1 addition & 1 deletion website/pages/en/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This guide is written assuming that you have:

Go to the [Subgraph Studio](https://thegraph.com/studio/) and connect your wallet.

Once connected, you can begin by clicking “create a subgraph.” Select the network of your choice and click continue.
Once connected, you can begin by clicking “Create a Subgraph”.

## 2. Install the Graph CLI

Expand Down
6 changes: 3 additions & 3 deletions website/pages/en/sunrise.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,15 @@ To upgrade a hosted service subgraph, you can visit the subgraph dashboard on th
2. Select the receiving wallet (the wallet that will become the owner of the subgraph).
3. Click the "Upgrade" button.

Once your subgraph is published, the [upgrade Indexer](#what-is-an-upgrade-indexer) will begin serving queries on it, so you can begin making queries immediately, once you have generated an API key ([learn more](/cookbook/upgrading-a-subgraph/#what-next)).
Once your subgraph is published, the [upgrade Indexer](#what-is-the-upgrade-indexer) will begin serving queries on it, so you can begin making queries immediately, once you have generated an API key ([learn more](/cookbook/upgrading-a-subgraph/#what-next)).

### How can I get support with the upgrade process?

The Graph community is here to support developers as they move to The Graph Network. Join The Graph's [Discord server](https://discord.gg/vtvv7FP) and request help in the #upgrade-decentralized-network channel.

### How can I ensure high quality of service and redundancy for subgraphs on The Graph Network?

All subgraphs will be supported by the upgrade indexer. Developers can add GRT signal to Subgraphs eligible for indexing rewards in order to attract additional Indexers, for redundancy and improved quality of service ([learn more about adding signal to your subgraph](/publishing/publishing-a-subgraph/#curating-your-subgraph))
All subgraphs will be supported by the upgrade indexer. Developers can add GRT signal to Subgraphs eligible for indexing rewards in order to attract additional Indexers, for redundancy and improved quality of service ([learn more about adding signal to your subgraph](/publishing/publishing-a-subgraph/#adding-signal-to-your-subgraph))

Subgraphs which are not eligible for indexing rewards may have difficulty attracting further Indexers. For example, indexing rewards may not be available for subgraphs on certain chains (check support [here](/developing/supported-networks)).

Expand Down Expand Up @@ -148,7 +148,7 @@ Other Indexers are incentivized to support subgraphs with ongoing query volume,

### Do I need to run my own infrastructure?

No, all infrastructure is operated by independent Indexers on The Graph Network, including the upgrade Indexer ([read more below](#what-is-an-upgrade-indexer)).
No, all infrastructure is operated by independent Indexers on The Graph Network, including the upgrade Indexer ([read more below](#what-is-the-upgrade-indexer)).

You can use the [Subgraph Studio](https://thegraph.com/studio/) to create, test, and publish your subgraph. All hosted service users must upgrade their subgraph to The Graph Network before the end of the upgrade window ending on June 12th 2024.

Expand Down
2 changes: 1 addition & 1 deletion website/pages/en/tokenomics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Tokenomics of The Graph Network
description: The Graph Network is incentivized by powerful tokenomics. Here’s how GRT, The Graph’s native work utility token works.
---

- GRT Token Address: [0xc944e90c64b2c07662a292be6244bdf05cda44a7](https://etherscan.io/token/0xc944e90c64b2c07662a292be6244bdf05cda44a7)
- GRT Token Address on Mainnet: [0xc944e90c64b2c07662a292be6244bdf05cda44a7](https://etherscan.io/token/0xc944e90c64b2c07662a292be6244bdf05cda44a7)

- GRT Token Address on Arbitrum One: [0x9623063377AD1B27544C965cCd7342f7EA7e88C7](https://arbiscan.io/token/0x9623063377ad1b27544c965ccd7342f7ea7e88c7)

Expand Down
Binary file modified website/public/img/Network-Stats.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8b1fa6e

Please sign in to comment.