Deploy subgraph (#788)

* Merging "Deploying a Subgraph to Subgraph Studio" with "How to Use Subgraph Studio." * Updating copy * Included redirects Co-authored-by: Benoît Rouleau <[email protected]>
graphprotocol · Oct 11, 2024 · 7453307 · 7453307
1 parent 80b8a89
commit 7453307
Show file tree

Hide file tree

Showing 29 changed files with 3,337 additions and 227 deletions.
diff --git a/nginx.conf b/nginx.conf
@@ -92,6 +92,8 @@ http {
         rewrite ^/docs/([a-zA-Z][a-zA-Z])/developing/assemblyscript-api/$               $scheme://$http_host/docs/$1/developing/graph-ts/api/                       permanent;
         rewrite ^/docs/en/substreams/(?!index\.).+$                                     https://substreams.streamingfast.io                                         permanent;
         rewrite ^/docs/en/firehose/(?!index\.).+$                                       https://firehose.streamingfast.io                                           permanent;
+        rewrite ^/docs/([a-zA-Z][a-zA-Z])/deploying/deploying-a-subgraph-to-studio/$    $scheme://$http_host/docs/$1/deploying/deploy-using-subgraph-studio/        permanent;
+
         # Temporary redirects (302)
         rewrite ^/docs/en/querying/graph-client/$                                       $scheme://$http_host/docs/en/querying/graph-client/README/                  redirect;
         rewrite ^/docs/en/developing/graph-ts/$                                         $scheme://$http_host/docs/en/developing/graph-ts/README/                    redirect;

diff --git a/website/pages/ar/deploying/deploy-using-subgraph-studio.mdx b/website/pages/ar/deploying/deploy-using-subgraph-studio.mdx
@@ -0,0 +1,139 @@
+---
+title: Deploy Using Subgraph Studio
+---
+
+Learn how to deploy your subgraph to Subgraph Studio.
+
+> Note: When you deploy a subgraph, you push it to Subgraph Studio, where you'll be able to test it. It's important to remember that deploying is not the same as publishing. When you publish a subgraph, you're publishing it on-chain.
+
+## Subgraph Studio Overview
+
+In [Subgraph Studio](https://thegraph.com/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 a new subgraph
+- Deploy your subgraph using The Graph CLI
+- Test your subgraph in the playground environment
+- Integrate your subgraph in staging using the development query URL
+- Publish your subgraph to The Graph Network
+- Manage your billing
+
+## Install The Graph CLI
+
+Before deploying, you must install The Graph CLI.
+
+You must have [Node.js](https://nodejs.org/) and a package manager of your choice (`npm`, `yarn` or `pnpm`) installed to use The Graph CLI. Check for the [most recent](https://github.com/graphprotocol/graph-tooling/releases?q=%40graphprotocol%2Fgraph-cli&expanded=true) CLI version.
+
+**Install with yarn:**
+
+```bash
+yarn global add @graphprotocol/graph-cli
+```
+
+**Install with npm:**
+
+```bash
+npm install -g @graphprotocol/graph-cli
+```
+
+## Create Your Subgraph
+
+Before deploying your subgraph you need to create an account in [Subgraph Studio](https://thegraph.com/studio/).
+
+1. Open [Subgraph Studio](https://thegraph.com/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.
+
+> Important: You need an API key to query subgraphs.
+
+### How to Create a Subgraph in Subgraph Studio
+
+<VideoEmbed youtube="nGIFuC69bSA" />
+
+> For additional written detail, review the [Quick-Start](/quick-start/).
+
+### Subgraph Compatibility with The Graph Network
+
+In order to be supported by Indexers on The Graph Network, subgraphs must:
+
+- Index a [supported network](/developing/supported-networks)
+- Must not use any of the following features:
+  - ipfs.cat & ipfs.map
+  - Non-fatal errors
+  - Grafting
+
+## Initialize Your Subgraph
+
+Once your subgraph has been created in Subgraph Studio, you can initialize its code through the CLI using this command:
+
+```bash
+graph init --studio <SUBGRAPH_SLUG>
+```
+
+You can find the `<SUBGRAPH_SLUG>` value on your subgraph details page in Subgraph Studio, see image below:
+
+![Subgraph Studio - Slug](/img/doc-subgraph-slug.png)
+
+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.
+
+## Graph Auth
+
+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:
+
+```bash
+graph auth --studio <DEPLOY KEY>
+```
+
+## Deploying a Subgraph
+
+Once you are ready, you can deploy your subgraph to Subgraph Studio.
+
+> Deploying a subgraph with the CLI pushes it to the Studio, where you can test it and and update the metadata. This action won't publish your subgraph to the decentralized network.
+
+Use the following CLI command to deploy your subgraph:
+
+```bash
+graph deploy --studio <SUBGRAPH_SLUG>
+```
+
+After running this command, the CLI will ask for a version label.
+
+- It's strongly recommended to use [semver](https://semver.org/) 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.
+
+## Testing Your Subgraph
+
+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](https://thegraph.com/explorer) when you are ready.
+
+Use Subgraph Studio to check the logs on the dashboard and look for any errors with your subgraph.
+
+## Publish Your Subgraph
+
+In order to publish your subgraph successfully, review [publishing a subgraph](/publishing/publishing-a-subgraph/).
+
+## Versioning Your Subgraph with the CLI
+
+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](https://thegraph.com/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.
+
+> Note: There are costs associated with publishing a new version of a subgraph to the network. In addition to the transaction fees, you must also fund a part of the curation tax on the auto-migrating signal. You cannot publish a new version of your subgraph if Curators have not signaled on it. For more information, please read more [here](/network/curating/).
+
+## Automatic Archiving of Subgraph Versions
+
+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.
+
+> Note: Previous versions of non-published subgraphs deployed to Studio will be automatically archived.
+
+![Subgraph Studio - Unarchive](/img/Unarchive.png)
diff --git a/website/pages/ar/deploying/deploying-a-subgraph-to-studio.mdx b/website/pages/ar/deploying/deploying-a-subgraph-to-studio.mdx
diff --git a/website/pages/cs/deploying/deploy-using-subgraph-studio.mdx b/website/pages/cs/deploying/deploy-using-subgraph-studio.mdx
@@ -0,0 +1,139 @@
+---
+title: Deploy Using Subgraph Studio
+---
+
+Learn how to deploy your subgraph to Subgraph Studio.
+
+> Note: When you deploy a subgraph, you push it to Subgraph Studio, where you'll be able to test it. It's important to remember that deploying is not the same as publishing. When you publish a subgraph, you're publishing it on-chain.
+
+## Subgraph Studio Overview
+
+In [Subgraph Studio](https://thegraph.com/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
+
+## Install The Graph CLI
+
+Before deploying, you must install The Graph CLI.
+
+You must have [Node.js](https://nodejs.org/) and a package manager of your choice (`npm`, `yarn` or `pnpm`) installed to use The Graph CLI. Check for the [most recent](https://github.com/graphprotocol/graph-tooling/releases?q=%40graphprotocol%2Fgraph-cli&expanded=true) CLI version.
+
+**Install with yarn:**
+
+```bash
+yarn global add @graphprotocol/graph-cli
+```
+
+**Install with npm:**
+
+```bash
+npm install -g @graphprotocol/graph-cli
+```
+
+## Create Your Subgraph
+
+Before deploying your subgraph you need to create an account in [Subgraph Studio](https://thegraph.com/studio/).
+
+1. Open [Subgraph Studio](https://thegraph.com/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.
+
+> Important: You need an API key to query subgraphs
+
+### How to Create a Subgraph in Subgraph Studio
+
+<VideoEmbed youtube="nGIFuC69bSA" />
+
+> For additional written detail, review the [Quick-Start](/quick-start/).
+
+### Subgraph Compatibility with The Graph Network
+
+In order to be supported by Indexers on The Graph Network, subgraphs must:
+
+- Index a [supported network](/developing/supported-networks)
+- Must not use any of the following features:
+  - ipfs.cat & ipfs.map
+  - Non-fatal errors
+  - Grafting
+
+## Initialize Your Subgraph
+
+Once your subgraph has been created in Subgraph Studio, you can initialize its code through the CLI using this command:
+
+```bash
+graph init --studio <SUBGRAPH_SLUG>
+```
+
+You can find the `<SUBGRAPH_SLUG>` value on your subgraph details page in Subgraph Studio, see image below:
+
+![Subgraph Studio - Slug](/img/doc-subgraph-slug.png)
+
+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.
+
+## Graph Auth
+
+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:
+
+```bash
+graph auth --studio <DEPLOY KEY>
+```
+
+## Deploying a Subgraph
+
+Once you are ready, you can deploy your subgraph to Subgraph Studio.
+
+> Deploying a subgraph with the CLI pushes it to the Studio, where you can test it and and update the metadata. This action won't publish your subgraph to the decentralized network.
+
+Use the following CLI command to deploy your subgraph:
+
+```bash
+graph deploy --studio <SUBGRAPH_SLUG>
+```
+
+After running this command, the CLI will ask for a version label.
+
+- It's strongly recommended to use [semver](https://semver.org/) 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.
+
+## Testing Your Subgraph
+
+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](https://thegraph.com/explorer) when you are ready.
+
+Use Subgraph Studio to check the logs on the dashboard and look for any errors with your subgraph.
+
+## Publish Your Subgraph
+
+In order to publish your subgraph successfully, review [publishing a subgraph](/publishing/publishing-a-subgraph/).
+
+## Versioning Your Subgraph with the CLI
+
+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](https://thegraph.com/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.
+
+> Note: There are costs associated with publishing a new version of a subgraph to the network. In addition to the transaction fees, you must also fund a part of the curation tax on the auto-migrating signal. You cannot publish a new version of your subgraph if Curators have not signaled on it. For more information, please read more [here](/network/curating/).
+
+## Automatic Archiving of Subgraph Versions
+
+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.
+
+> Note: Previous versions of non-published subgraphs deployed to Studio will be automatically archived.
+
+![Subgraph Studio - Unarchive](/img/Unarchive.png)