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.

Sign up for GitHub

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

Subgraph quickstart updates #851

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Subgraph quickstart updates #851

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3b8ad7b
quickstart updates
marcusrein Jan 14, 2025
cf4ffe8
small edits
marcusrein Jan 14, 2025
370dc90
Update subgraphs/quick-start.mdx: Improve clarity. Referenced PR comm…
marcusrein Jan 14, 2025
2624db6
Update website/pages/en/subgraphs/quick-start.mdx
benface Jan 14, 2025
d98d73b
Update website/pages/en/subgraphs/quick-start.mdx
benface Jan 14, 2025
5cdde7d
Update website/pages/en/subgraphs/quick-start.mdx
benface Jan 14, 2025
fb52260
Update website/pages/en/subgraphs/quick-start.mdx
benface Jan 14, 2025
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
12 changes: 5 additions & 7 deletions website/pages/en/subgraphs/quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any reason to remove this? If we don't mention Etherscan, devs might not know where a contract gets "verified"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed it because there's many kinds of blockscanners. Maybe simply saying a blockscanner instead of "Etherscan"?

If your contract was verified, then the ABI will automatically be created in the CLI.

When you initialize your subgraph, the CLI will ask you for the following information:

Expand Down Expand Up @@ -82,11 +82,7 @@ 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.

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/) a single Indexer owned and operated by Edge & Node, not 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.
benface marked this conversation as resolved.
Show resolved Hide resolved
benface marked this conversation as resolved.
Show resolved Hide resolved

Once your subgraph is written, run the following commands:

Expand Down Expand Up @@ -119,7 +115,9 @@ 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 a subgraph means that your subgraph becomes availble to index by the decentralized Indexers on The Graph Network. Publishing also removes rate limits, and makes your subgraph publicly searchable and queriable on [The Graph Explorer](https://thegraph.com/explorer/).
benface marked this conversation as resolved.
Show resolved Hide resolved
benface marked this conversation as resolved.
Show resolved Hide resolved

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

#### Publishing with Subgraph Studio

Expand Down
Loading