Deploy Using Subgraph Studio

Reading time: 5 min

Learn how to deploy your subgraph to Subgraph Studio.

In Subgraph Studio, you can do the following:

• View a list of subgraphs you've created
• Manage, view details, and visualize the status of a specific subgraph
• Create and manage your API keys for specific subgraphs
• Restrict your API keys to specific domains and allow only certain Indexers to query with them
• Create your subgraph through the Studio UI
• Deploy your subgraph using the The Graph CLI
• Test your subgraph in the playground environment
• Integrate your subgraph in staging using the development query URL
• Publish your subgraph with the Studio UI
• Manage your billing

Before deploying, you must install The Graph CLI.

You must have Node.js and a package manager of your choice (npm, yarn or pnpm) installed to use The Graph CLI. Check for the most recent CLI version.

Install with yarn:

yarn global add @graphprotocol/graph-cli

Install with npm:

npm install -g @graphprotocol/graph-cli

Before deploying your subgraph you need to create an account in Subgraph Studio.

1. Open Subgraph Studio.
2. Connect your wallet to sign in.
   • You can do this via MetaMask, Coinbase Wallet, WalletConnect, or Safe.
3. After you sign in, your unique deploy key will be displayed on your subgraph details page.
   • The deploy key allows you to publish your subgraphs or manage your API keys and billing. It is unique but can be regenerated if you think it has been compromised.

In order to be supported by Indexers on The Graph Network, subgraphs must:

• Index a supported network
• Must not use any of the following features:
  • ipfs.cat & ipfs.map
  • Non-fatal errors
  • Grafting

Once your subgraph has been created in Subgraph Studio, you can initialize its code through the CLI using this command:

graph init --studio <SUBGRAPH_SLUG>

You can find the <SUBGRAPH_SLUG> value on your subgraph details page in Subgraph Studio, see image below:

After running graph init, you will be asked to input the contract address, network, and an ABI that you want to query. This will generate a new folder on your local machine with some basic code to start working on your subgraph. You can then finalize your subgraph to make sure it works as expected.

Before you can deploy your subgraph to Subgraph Studio, you need to login into your account within the CLI. To do this, you will need your deploy key, which you can find under your subgraph details page.

Then, use the following command to authenticate from the CLI:

graph auth --studio <DEPLOY KEY>

Once you are ready, you can deploy your subgraph to Subgraph Studio.

Use the following CLI command to deploy your subgraph:

graph deploy --studio <SUBGRAPH_SLUG>

After running this command, the CLI will ask for a version label.

• It's strongly recommended to use semver for versioning like 0.0.1. That said, you are free to choose any string as version such as v1, version1, or asdf.
• The labels you create will be visible in Graph Explorer and can be used by curators to decide if they want to signal on a specific version or not, so choose them wisely.

After deploying, you can test your subgraph (either in Subgraph Studio or in your own app, with the deployment query URL), deploy another version, update the metadata, and publish to Graph Explorer when you are ready.

Use Subgraph Studio to check the logs on the dashboard and look for any errors with your subgraph.

In order to publish your subgraph successfully, review publishing a subgraph.

If you want to update your subgraph, you can do the following:

• You can deploy a new version to Studio using the CLI (it will only be private at this point).
• Once you're happy with it, you can publish your new deployment to Graph Explorer.
• This action will create a new version of your subgraph that Curators can start signaling on and Indexers can index.

You can also update your subgraph's metadata without publishing a new version. You can update your subgraph details in Studio (under the profile picture, name, description, etc.) by checking an option called Update Details in Graph Explorer. If this is checked, an on-chain transaction will be generated that updates subgraph details in Explorer without having to publish a new version with a new deployment.

Whenever you deploy a new subgraph version in Subgraph Studio, the previous version will be archived. Archived versions won't be indexed/synced and therefore cannot be queried. You can unarchive an archived version of your subgraph in Subgraph Studio.