From cd4630adb59e6d66055782de53e986ef18bf0253 Mon Sep 17 00:00:00 2001 From: Marcus Rein <64141593+marcusrein@users.noreply.github.com> Date: Thu, 16 Jan 2025 15:55:28 -0500 Subject: [PATCH] Subgraph quickstart updates (#851) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * quickstart updates * small edits * Update subgraphs/quick-start.mdx: Improve clarity. Referenced PR comments. * Update website/pages/en/subgraphs/quick-start.mdx Co-authored-by: Idalith <126833353+idalithb@users.noreply.github.com> * Update website/pages/en/subgraphs/quick-start.mdx * Update website/pages/en/subgraphs/quick-start.mdx * Update website/pages/en/subgraphs/quick-start.mdx --------- Co-authored-by: Benoît Rouleau Co-authored-by: Idalith <126833353+idalithb@users.noreply.github.com> --- website/pages/en/subgraphs/quick-start.mdx | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/website/pages/en/subgraphs/quick-start.mdx b/website/pages/en/subgraphs/quick-start.mdx index 7e50fd69be14..176b59d4133d 100644 --- a/website/pages/en/subgraphs/quick-start.mdx +++ b/website/pages/en/subgraphs/quick-start.mdx @@ -49,7 +49,7 @@ The following command initializes your subgraph from an existing contract: graph init ``` -If your contract was verified on Etherscan, then the ABI will automatically be created in the CLI. +If your contract is verified on the respective blockscanner where it is deployed (such as [Etherscan](https://etherscan.io/)), then the ABI will automatically be created in the CLI. When you initialize your subgraph, the CLI will ask you for the following information: @@ -82,11 +82,9 @@ For a detailed breakdown on how to write your subgraph, check out [Creating a Su ### 5. Deploy your subgraph -Remember, deploying is not the same as publishing. +> Remember, deploying is not the same as publishing. -When you deploy a subgraph, you push it to [Subgraph Studio](https://thegraph.com/studio/), where you can test, stage and review it. - -When you publish a subgraph, you are publishing it onchain to the decentralized network. +When you **deploy** a subgraph, you push it to [Subgraph Studio](https://thegraph.com/studio/), where you can test, stage and review it. A deployed subgraph's indexing is performed by the [Upgrade Indexer](https://thegraph.com/blog/upgrade-indexer/), which is a single Indexer owned and operated by Edge & Node, rather than by the many decentralized Indexers in The Graph Network. A **deployed** subgraph is free to use, rate-limited, not visible to the public, and meant to be used for development, staging, and testing purposes. Once your subgraph is written, run the following commands: @@ -119,7 +117,13 @@ If you’d like to test your subgraph before publishing it, you can use [Subgrap ### 7. Publish your subgraph to The Graph Network -Publishing a subgraph to the decentralized network is an onchain action that makes your subgraph available for [Curators](/resources/roles/curating/) to curate it and [Indexers](/indexing/overview/) to index it. +When your subgraph is ready for a production environment, you can publish it to the decentralized network. Publishing is an onchain action that does the following: + +- It makes your subgraph available to be to indexed by the decentralized [Indexers](/indexing/overview/) on The Graph Network. +- It removes rate limits and makes your subgraph publicly searchable and queryable in [Graph Explorer](https://thegraph.com/explorer/). +- It makes your subgraph available for [Curators](/resources/roles/curating/) to curate it. + +> The greater the amount of GRT you and others curate on your subgraph, the more Indexers will be incentivized to index your subgraph, improving the quality of service, reducing latency, and enhancing network redundancy for your subgraph. #### Publishing with Subgraph Studio