Skip to content

Updating Quick-Start #1004

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

Merged
merged 1 commit into from
Jul 9, 2025
Merged

Updating Quick-Start #1004

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
100 changes: 70 additions & 30 deletions website/src/pages/en/subgraphs/quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ By the end, you'll have:

- Initialized a Subgraph from a smart contract
- Deployed it to Subgraph Studio for testing
- Published to The Graph Network for decentralized indexing
- Published to The Graph Network for decentralized indexing using Studio or CLI

## Prerequisites

Expand Down Expand Up @@ -51,7 +51,7 @@ graph --version

> You can find commands for your specific Subgraph in [Subgraph Studio](https://thegraph.com/studio/).
The following command initializes your Subgraph from an existing contract and indexes events:
Initialize your Subgraph from an existing contract:

```sh
graph init
Expand All @@ -63,7 +63,7 @@ When you initialize your Subgraph, the CLI will ask you for the following inform
- **Subgraph slug**: Create a name for your Subgraph. Your Subgraph slug is an identifier for your Subgraph.
- **Directory**: Choose a directory to create your Subgraph in.
- **Ethereum network** (optional): You may need to specify which EVM-compatible network your Subgraph will be indexing data from.
- **Contract address**: Locate the smart contract address you’d like to query data from.
- **Contract address**: Locate the smart contract address you'd like to query data from.
- **ABI**: If the ABI is not auto-populated, you will need to input it manually as a JSON file.
- **Start Block**: You should input the start block where the contract was deployed to optimize Subgraph indexing of blockchain data.
- **Contract Name**: Input the name of your contract.
Expand All @@ -76,67 +76,107 @@ See the following screenshot for an example of what to expect when initializing

### 4. Edit your Subgraph

When making changes to the Subgraph, you will mainly work with three files:
When making changes to the Subgraph, you will primarily work with three files:

- Manifest (`subgraph.yaml`) - defines what data sources your Subgraph will index.
- Schema (`schema.graphql`) - defines what data you wish to retrieve from the Subgraph.
- AssemblyScript Mappings (`mapping.ts`) - translates data from your data sources to the entities defined in the schema.
- Manifest (`subgraph.yaml`): Defines what data sources your Subgraph will index.
- Schema (`schema.graphql`): Defines what data you wish to retrieve from the Subgraph.
- AssemblyScript Mappings (`mapping.ts`): Translates data from your data sources to the entities defined in the schema.

For a detailed breakdown on how to write your Subgraph, check out [Creating a Subgraph](/developing/creating-a-subgraph/).
For a detailed breakdown on how to write your Subgraph, refer to [Creating a Subgraph](/subgraphs/developing/creating/starting-your-subgraph/).

### 5. Deploy your Subgraph
## Path 1: Studio Approach

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. 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.
### 5. Build your Subgraph

Run the following:

```sh
graph codegen && graph build
```

Once your Subgraph is written, run the following commands:
### 6. Deploy your Subgraph to Subgraph Studio

```sh
graph codegen && graph build
```
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. 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.

Authenticate and deploy your Subgraph. The deploy key can be found on the Subgraph's page in Subgraph Studio.
> [!IMPORTANT] You do not need to use Subgraph Studio to publish your Subgraph to The Graph Network. Studio is only required for testing and staging your Subgraph prior to publishing.
1. Get your deploy key from the Subgraph page in Studio

![Deploy key](/img/subgraph-studio-deploy-key.jpg)

```sh
2. Authenticate:

graph auth <DEPLOY_KEY>
```sh

graph deploy <SUBGRAPH_SLUG>
```
graph auth <DEPLOY_KEY>
```

### 6. Review your Subgraph
3. Deploy:

If you’d like to test your Subgraph before publishing it, you can use [Subgraph Studio](https://thegraph.com/studio/) to do the following:
```sh
graph deploy <SUBGRAPH_SLUG>
```

### 7. Review in Studio

Use the Studio to:

- Run a sample query.
- Analyze your Subgraph in the dashboard to check information.
- Check the logs on the dashboard to see if there are any errors with your Subgraph. The logs of an operational Subgraph will look like this:

![Subgraph logs](/img/subgraph-logs-image.png)

### 7. Publish your Subgraph to The Graph Network
### 8. Publish to The Graph Network

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 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 add curation signal.

To publish your Subgraph, click the Publish button in the dashboard and select your network.
1. Click **Publish** in Studio
2. Select network
3. (Recommended) Add curation during the same transaction to save on gas costs: ![Subgraph publish](/img/studio-publish-modal.png)

![Publish a Subgraph on Subgraph Studio](/img/publish-sub-transfer.png)

> It is recommended that you curate your own Subgraph with at least 3,000 GRT to incentivize indexing.
> Curation with 3,000+ GRT is recommended to incentivize indexing.
## Path 2: CLI Approach

1. Open the `graph-cli`.
2. Run the following commands to build and publish your Subgraph: `graph codegen && graph build` then `graph publish`.
3. A browser window will prompt you to connect your wallet, add metadata, and publish your Subgraph to the network of your choice.

![cli-ui](/img/cli-ui.png)

To save on gas costs, you can curate your Subgraph in the same transaction you publish it by selecting this option:
### Custom Options

You can customize the deployment by uploading to a specific IPFS node and using additional flags:

```
USAGE
$ graph publish [SUBGRAPH-MANIFEST] [-h] [--protocol-network arbitrum-one|arbitrum-sepolia --subgraph-id <value>] [-i <value>] [--ipfs-hash <value>] [--webapp-url
<value>]
FLAGS
-h, --help Show CLI help.
-i, --ipfs=<value> [default: https://ipfs.thegraph.com/api/v0] Upload build results to an IPFS node.
--ipfs-hash=<value> IPFS hash of the subgraph manifest to deploy.
--protocol-network=<option> [default: arbitrum-one] The network to use for the subgraph deployment.
<options: arbitrum-one|arbitrum-sepolia>
--subgraph-id=<value> Subgraph ID to publish to.
--webapp-url=<value> [default: https://cli.thegraph.com/publish] URL of the web UI you want to use to deploy.
```

![Subgraph publish](/img/studio-publish-modal.png)
> [!NOTE] Add GRT signal to your Subgraph to incentivize Indexers to query your Subgraph. Refer to [Adding Signal](developing/publishing/publishing-a-subgraph/#adding-signal-to-your-subgraph) for specifics.
### 8. Query your Subgraph
### Final Step: Query your Subgraph

You now have access to 100,000 free queries per month with your Subgraph on The Graph Network!
After publishing, access your Subgraph's Query URL from [Graph Explorer](https://thegraph.com/explorer/). You can query your Subgraph by sending GraphQL queries to its Query URL, which you can find by clicking the Query button.

You can query your Subgraph by sending GraphQL queries to its Query URL, which you can find by clicking the Query button.
You get access to 100,000 free queries/month with your Subgraph on The Graph Network.

For more information about querying data from your Subgraph, read [Querying The Graph](/subgraphs/querying/introduction/).
Refer to [Querying The Graph](/subgraphs/querying/introduction/) to structure GraphQL queries.