Skip to content

Commit 352c436

Browse files
Cleaning up supported networks (#276)
* Cleaning up supported networks * small fix * Update deploying-a-subgraph-to-hosted.mdx * Latest updates -Fixed suggestions -Ensured all hosted service chains are listed -Chains became networks * small update - Added a comment showing that Gnosis is considered `In Beta` on the decentralized network. - All Rinkeby, Ropsten and Kovan subgraphs will be archived on February 25, 2023. Subgraphs indexing the above three testnets will no longer be queryable after this date. Updated the copy to make it clearer that the three networks are no longer supported (.. as of 4 days from now, anyway) --------- Co-authored-by: Web3Slimchance <[email protected]>
1 parent bb71f3d commit 352c436

5 files changed

+68
-89
lines changed

pages/en/deploying/deploying-a-subgraph-to-hosted.mdx

+2-58
Original file line numberDiff line numberDiff line change
@@ -2,66 +2,10 @@
22
title: Deploying a Subgraph to the Hosted Service
33
---
44

5-
To see instructions on how to deploy your subgraph to the Hosted Service, [click here](#create-a-hosted-service-account).
6-
7-
If you have not checked out already, check out how to write the files that make up a [subgraph manifest](/developing/creating-a-subgraph#the-subgraph-manifest) and how to install the [Graph CLI](https://github.com/graphprotocol/graph-cli) to generate code for your subgraph. Now, it's time to deploy your subgraph to the Hosted Service.
8-
9-
## Supported networks
10-
11-
The following networks are fully supported on the Hosted Service:
12-
13-
- `mainnet` (Ethereum)
14-
- `gnosis`
15-
16-
The following networks are supported in beta on the Hosted Service:
17-
18-
- `goerli`
19-
- `poa-core`
20-
- `poa-sokol`
21-
- `matic` (now known as Polygon)
22-
- `mumbai`
23-
- `fantom`
24-
- `bsc` (now known as BNB Chain)
25-
- `chapel`
26-
- `clover`
27-
- `avalanche`
28-
- `fuji`
29-
- `celo`
30-
- `celo-alfajores`
31-
- `fuse`
32-
- `moonriver`
33-
- `mbase`
34-
- `arbitrum-one`
35-
- `arbitrum-rinkeby`
36-
- `arbitrum-goerli`
37-
- `optimism`
38-
- `optimism-goerli`
39-
- `aurora`
40-
- `aurora-testnet`
41-
- `boba`
42-
- `harmony`
43-
- `zkSync2-testnet`
44-
45-
> Ropsten, Rinkeby and Kovan are being deprecated, and are no longer supported by the Hosted Service. Read more on the [Ethereum Foundation Blog](https://blog.ethereum.org/2022/06/21/testnet-deprecation). 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.
46-
47-
> Subgraphs indexing Gnosis Chain can now be deployed with the `gnosis` network identifier. `xdai` is still supported for existing hosted service subgraphs.
5+
This page explains how to deploy a subgraph to the Hosted Service. To deploy a subgraph you need to first install the [Graph CLI](https://github.com/graphprotocol/graph-cli). If you have not created a subgraph already, see [creating a subgraph](/developing/creating-a-subgraph).
486

497
> If an EVM compatible chain is not supported on the Hosted Service, you can run your own [graph-node](https://github.com/graphprotocol/graph-node) to index it.
508
51-
### Near
52-
53-
- `near-mainnet`
54-
- `near-testnet`
55-
56-
### Cosmos
57-
58-
- `cosmoshub-4`
59-
- `theta-testnet-001` (this is the current Cosmos Hub testnet)
60-
61-
### Arweave
62-
63-
- `arweave-mainnet`
64-
659
## Create a Hosted Service account
6610

6711
Before using the Hosted Service, create an account in our Hosted Service. You will need a [Github](https://github.com/) account for that; if you don't have one, you need to create that first. Then, navigate to the [Hosted Service](https://thegraph.com/hosted-service/), click on the _'Sign up with Github'_ button, and complete Github's authorization flow.
@@ -295,7 +239,7 @@ A working example of this can be found [here](https://github.com/graphprotocol/e
295239

296240
## Checking subgraph health
297241

298-
If a subgraph syncs successfully, that is a good sign that it will continue to run well forever. However, new triggers on the chain might cause your subgraph to hit an untested error condition or it may start to fall behind due to performance issues or issues with the node operators.
242+
If a subgraph syncs successfully, that is a good sign that it will continue to run well forever. However, new triggers on the network might cause your subgraph to hit an untested error condition or it may start to fall behind due to performance issues or issues with the node operators.
299243

300244
Graph Node exposes a graphql endpoint which you can query to check the status of your subgraph. On the Hosted Service, it is available at `https://api.thegraph.com/index-node/graphql`. On a local node, it is available on port `8030/graphql` by default. The full schema for this endpoint can be found [here](https://github.com/graphprotocol/graph-node/blob/master/server/index-node/src/schema.graphql). Here is an example query that checks the status of the current version of a subgraph:
301245

pages/en/deploying/deploying-a-subgraph-to-studio.mdx

+3-9
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,11 @@
22
title: Deploying a Subgraph to the Subgraph Studio
33
---
44

5-
## Supported Networks
5+
> Ensure the network your subgraph is indexing data from is [supported](/developing/supported-chains) on the decentralized network.
66
7-
The Graph Network supports subgraphs indexing the following chain:
7+
These are the steps to deploy your subgraph to the Subgraph Studio:
88

9-
### Ethereum
10-
11-
- `mainnet`
12-
13-
Deploying a Subgraph to the Subgraph Studio is quite simple. This will take you through the steps to:
14-
15-
- Install The Graph CLI (with both yarn and npm)
9+
- Install The Graph CLI (with either yarn or npm)
1610
- Create your Subgraph in the Subgraph Studio
1711
- Authenticate your account from the CLI
1812
- Deploying a Subgraph to the Subgraph Studio

pages/en/deploying/hosted-service.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: What is the Hosted Service?
33
---
44

5-
> Please note, the Hosted Service will begin sunsetting in Q1 2023, but it will remain available to chains that are not supported on the decentralized network. Developers are encouraged to [migrate their subgraphs](https://thegraph.com/blog/how-to-migrate-ethereum-subgraph) as more chains are supported. Each chain will have their hosted service equivalents gradually sunset to ensure developers have enough time to migrate subgraphs to the decentralized network. Read more about the sunsetting of the Hosted Service [here](https://thegraph.com/blog/sunsetting-hosted-service).
5+
> Please note, the Hosted Service will begin sunsetting in Q1 2023, but it will remain available to networks that are not supported on the decentralized network. Developers are encouraged to [migrate their subgraphs](https://thegraph.com/blog/how-to-migrate-ethereum-subgraph) as more networks are supported. Each network will have their hosted service equivalents gradually sunset to ensure developers have enough time to migrate subgraphs to the decentralized network. Read more about the sunsetting of the Hosted Service [here](https://thegraph.com/blog/sunsetting-hosted-service).
66
77
This section will walk you through deploying a subgraph to the [Hosted Service](https://thegraph.com/hosted-service/).
88

pages/en/deploying/subgraph-studio.mdx

+5-5
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ What you can do in the Subgraph Studio:
1515
- Integrate it in staging using the query URL
1616
- Create and manage your API keys for specific subgraphs
1717

18-
Here in the Subgraph Studio, you have full control over your subgraphs. Not only can you test your subgraphs before you publish them, but you can also restrict your API keys to specific domains and only allow certain indexers to query from their API keys.
18+
Here in the Subgraph Studio, you have full control over your subgraphs. Not only can you test your subgraphs before you publish them, but you can also restrict your API keys to specific domains and only allow certain Indexers to query from their API keys.
1919

20-
Querying subgraphs generates query fees, used to reward [indexers](/network/indexing) on the Graph network. If you’re a dapp developer or subgraph developer, the Studio will empower you to build better subgraphs to power your or your community’s queries. The Studio is comprised of 5 main parts:
20+
Querying subgraphs generates query fees, used to reward [Indexers](/network/indexing) on the Graph network. If you’re a dapp developer or subgraph developer, the Studio will empower you to build better subgraphs to power your or your community’s queries. The Studio is comprised of 5 main parts:
2121

2222
- Your user account controls
2323
- A list of subgraphs that you’ve created
@@ -42,7 +42,7 @@ The best part! When you first create a subgraph, you’ll be directed to fill ou
4242

4343
## Subgraph Compatibility with The Graph Network
4444

45-
The Graph Network is not yet able to support all of the data-sources & features available on the Hosted Service. In order to be supported by indexers on the network, subgraphs must:
45+
The Graph Network is not yet able to support all of the data-sources & features available on the Hosted Service. In order to be supported by Indexers on the network, subgraphs must:
4646

4747
- Index mainnet Ethereum
4848
- Must not use any of the following features:
@@ -70,15 +70,15 @@ You’ve made it this far - congrats! Publishing your subgraph means that an IPF
7070

7171
Remember, while you’re going through your publishing flow, you’ll be able to push to either mainnet or Goerli, the testnet we support. If you’re a first-time subgraph developer, we highly suggest you start with publishing to Goerli, which is free to do. This will allow you to see how the subgraph will work in The Graph Explorer and will allow you to test curation elements.
7272

73-
You’ll only be able to index data from mainnet (even if your subgraph was published to a testnet) because only subgraphs that are indexing mainnet data can be published to the network. This is because indexers need to submit mandatory Proof of Indexing records as of a specific block hash. Because publishing a subgraph is an action taken on-chain, remember that the transaction can take up to a few minutes to go through. Any address you use to publish the contract will be the only one able to publish future versions. Choose wisely!
73+
You’ll only be able to index data from mainnet (even if your subgraph was published to a testnet) because only subgraphs that are indexing mainnet data can be published to the network. This is because Indexers need to submit mandatory Proof of Indexing records as of a specific block hash. Because publishing a subgraph is an action taken on-chain, remember that the transaction can take up to a few minutes to go through. Any address you use to publish the contract will be the only one able to publish future versions. Choose wisely!
7474

7575
Subgraphs with curation signal are shown to Indexers so that they can be indexed on the decentralized network. You can publish subgraphs and signal in one transaction, which allows you to mint the first curation signal on the subgraph and saves on gas costs. By adding your signal to the signal later provided by Curators, your subgraph will also have a higher chance of ultimately serving queries.
7676

7777
**Now that you’ve published your subgraph, let’s get into how you’ll manage them on a regular basis.** Note that you cannot publish your subgraph to the network if it has failed syncing. This is usually because the subgraph has bugs - the logs will tell you where those issues exist!
7878

7979
## Versioning your Subgraph with the CLI
8080

81-
Developers might want to update their subgraph, for a variety of reasons. When this is the case, you can deploy a new version of your subgraph to the Studio using the CLI (it will only be private at this point) and if you are happy with it, you can publish this new deployment to The Graph Explorer. This will create a new version of your subgraph that curators can start signaling on and indexers will be able to index this new version.
81+
Developers might want to update their subgraph, for a variety of reasons. When this is the case, you can deploy a new version of your subgraph to the Studio using the CLI (it will only be private at this point) and if you are happy with it, you can publish this new deployment to The Graph Explorer. This will create a new version of your subgraph that curators can start signaling on and Indexers will be able to index this new version.
8282

8383
Up until recently, developers were forced to deploy and publish a new version of their subgraph to the Explorer to update the metadata of their subgraphs. Now, developers can update the metadata of their subgraphs **without having to publish a new version**. Developers can update their subgraph details in the Studio (under the profile picture, name, description, etc) by checking an option called **Update Details** in The Graph Explorer. If this is checked, an on-chain transaction will be generated that updates subgraph details in the Explorer without having to publish a new version with a new deployment.
8484

pages/en/developing/supported-networks.mdx

+57-16
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,72 @@
22
title: Supported Networks
33
---
44

5-
## The Graph Decentralized Network
5+
## The Graph's Decentralized Network
66

7-
The following protocols are supported on The Graph Decentralized Network:
7+
The following networks are supported on The Graph's Decentralized Network:
88

9-
- Ethereum
9+
- `mainnet` (Ethereum)
10+
- `gnosis`*
1011

11-
Indexers on The Graph Network can offer full support & security for mainnet Ethereum subgraphs. See which networks are supported and more information on deploying to the network [here](/deploying/deploying-a-subgraph-to-studio).
12+
*In beta.
1213

13-
Remember that you will **not be able** to publish a subgraph that indexes a non-mainnet network to the decentralized Graph Network in [Subgraph Studio](/deploying/subgraph-studio).
14+
## Hosted Service
1415

15-
## Graph Node
16+
> The hosted service relies on the stability and reliability of the underlying technologies, namely the provided JSON RPC endpoints.
1617
17-
You can run your own Graph Node to index any EVM-compatible chain. Make sure that the [version](https://github.com/graphprotocol/graph-node/releases) you are using supports the network and you have the needed configuration.
18+
The following networks are supported in beta on the Hosted Service:
1819

19-
Graph Node can also index other protocols, via a Firehose integration. Firehose integrations have been created for NEAR, Arweave and Cosmos-based chains.
20+
- `goerli`
21+
- `poa-core`
22+
- `poa-sokol`
23+
- `matic` (now known as Polygon)
24+
- `mumbai`
25+
- `fantom`
26+
- `fantom-testnet`
27+
- `bsc` (now known as BNB Chain)
28+
- `chapel`
29+
- `clover`
30+
- `avalanche`
31+
- `fuji`
32+
- `celo`
33+
- `celo-alfajores`
34+
- `fuse`
35+
- `moonriver`
36+
- `moonbeam`
37+
- `mbase`
38+
- `arbitrum-one`
39+
- `arbitrum-goerli`
40+
- `optimism`
41+
- `optimism-goerli`
42+
- `aurora`
43+
- `aurora-testnet`
44+
- `boba`
45+
- `harmony`
46+
- `zkSync2-testnet`
47+
- `osmosis-1`
2048

21-
## Hosted Service
49+
### Near
50+
51+
- `near-mainnet`
52+
- `near-testnet`
53+
54+
### Cosmos
55+
56+
- `cosmoshub-4`
57+
- `theta-testnet-001` (this is the current Cosmos Hub testnet)
2258

23-
The following protocols are supported on the Hosted Service:
59+
### Arweave
2460

25-
- Ethereum
26-
- Near
27-
- Cosmos
28-
- Arweave
61+
- `arweave-mainnet`
62+
63+
You will **not be able** to publish a subgraph that indexes a non-mainnet network to the decentralized Graph Network in [Subgraph Studio](/deploying/subgraph-studio).
64+
65+
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.
66+
67+
Subgraphs indexing Gnosis Chain can now be deployed with the `gnosis` network identifier. `xdai` is still supported for existing hosted service subgraphs.
68+
69+
## Graph Node
2970

30-
See the list of which networks are supported [here](/deploying/deploying-a-subgraph-to-hosted).
71+
If your preferred network isn't support on The Graph's decentralized network, you can run your own Graph Node to index any EVM-compatible network. Make sure that the [version](https://github.com/graphprotocol/graph-node/releases) you are using supports the network and you have the needed configuration.
3172

32-
> The Graph's Hosted Service relies on the stability and reliability of the underlying technologies, namely the provided JSON RPC endpoints. Newer networks will be marked as being in beta until the network has proven itself in terms of stability, reliability, and scalability. During this beta period, there is a risk of downtime and unexpected behaviour.
73+
Graph Node can also index other protocols, via a Firehose integration. Firehose integrations have been created for NEAR, Arweave and Cosmos-based networks.

0 commit comments

Comments
 (0)