From 3a11d06d75603cca852e26f470060dccd56ae14d Mon Sep 17 00:00:00 2001 From: Idalith Bustos Date: Thu, 12 Sep 2024 18:05:17 -0700 Subject: [PATCH 01/15] potential changes --- .../deploying-a-subgraph-to-studio.mdx | 96 ++++++++++++++++--- 1 file changed, 82 insertions(+), 14 deletions(-) diff --git a/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx b/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx index 003f158c4284..be4c87a29ee6 100644 --- a/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx +++ b/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx @@ -2,16 +2,34 @@ title: Deploying a Subgraph to Subgraph Studio --- -These are the steps to deploy your subgraph to Subgraph Studio: +> Before deploying, you must install The Graph CLI; please review [Creating a Subgraph]() -- Install The Graph CLI (with either yarn or npm) +When you deploy a subgraph, you push it to Subgraph Studio, where you'll be able to stage it. It's important to remember that deploying is not the same as publishing. When you publish a subgraph, you are publishing it on-chain. + +## What can you do in Subgraph Studio? + +[Subgraph Studio]() allows you to do the following: + +- Create and manage your API keys for specific subgraphs - Create your Subgraph in Subgraph Studio - Authenticate your account from the CLI -- Deploying a Subgraph to Subgraph Studio +- Deploy a Subgraph to Subgraph Studio +- Stage it in the playground environment +- Integrate it in staging using the query URL + +In Subgraph Studio, you can view the following: -## Installing Graph CLI +- Your user account controls +- A list of subgraphs you've created +- A section to manage your API keys +- A section to manage, view details, and visualize the status of a specific subgraph +- A section to manage your billing -There is a CLI to deploy subgraphs to [Subgraph Studio](https://thegraph.com/studio/). Here are the commands to install `graph-cli`. This can be done using npm or yarn. +Step-by-Step + +## 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:** @@ -27,7 +45,35 @@ npm install -g @graphprotocol/graph-cli ## Create your Subgraph in Subgraph Studio -Before deploying your actual subgraph you need to create a subgraph in [Subgraph Studio](https://thegraph.com/studio/). We recommend you read our [Studio documentation](/deploying/subgraph-studio) to learn more about this. +### Create an account + +Before deploying your subgraph you need to create a subgraph in [Subgraph Studio](https://thegraph.com/studio/). + +1. Open [Subgraph Studio](https://thegraph.com/studio/). +2. Connect your wallet. + - You can do this via MetaMask, WalletConnect, Coinbase Wallet, or Safe. +3. After you connect your wallet, your unique deploy key will be displayed on your "My Subgraphs" page or your “subgraph details” page in the Studio. + - 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. +4. You can create one or multiple API keys by clicking the API keys tab at the top of your homepage. See image below: + - You can limit API keys to a specific domain in the security section. + +> Important: You need API keys to query subgraphs + +#### How to create a subgraph in Subgraph Studio + + + +> For additional written detail, review the [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 @@ -37,17 +83,19 @@ Once your subgraph has been created in Subgraph Studio you can initialize the su graph init --studio ``` -The `` value can be found on your subgraph details page in Subgraph Studio: +You can view the `` 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 ABI that you want to query. Doing 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. +After running `graph init`, you will be asked to input the contract address, network, and 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 being able to 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 that you can find on your "My Subgraphs" page or your subgraph details page. +Before can deploy your subgraph to Subgraph Studio, you must login into your account using the CLI. To do this, you will need your deploy key (you can find it on your "My Subgraphs" page or under your subgraph details page). -Here is the command that you need to use to authenticate from the CLI: +Then, use the following command to authenticate from the CLI: ```bash graph auth --studio @@ -55,14 +103,34 @@ graph auth --studio ## Deploying a Subgraph to Subgraph Studio -Once you are ready, you can deploy your subgraph to Subgraph Studio. Doing this won't publish your subgraph to the decentralized network, it will only deploy it to your Studio account where you will be able to test it and update the metadata. +Once you are ready, you can deploy your subgraph to Subgraph Studio. -Here is the CLI command that you need to use to deploy your subgraph. +> 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 ``` -After running this command, the CLI will ask for a version label, you can name it however you want, you can use labels such as `0.1` and `0.2` or use letters as well such as `uniswap-v2-0.1`. Those labels will be visible in Graph Explorer and can be used by curators to decide if they want to signal on this version or not, so choose them wisely. +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`, `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/stage your subgraph in Subgraph Studio, deploy another version, update the metadata, and publish to Graph Explorer when you are ready. + +Use Subgraph Studio’s playground to: + +- Check your subgraph logs +- The subgraph logs will indicate if and where a subgraph fails. + +## Publish your Subgraph in Subgraph Studio + +You are now ready to publish your subgraph! + +In order to publish your subgraph successfully, review [publishing a subgraph] (/publishing/publishing-a-subgraph/). -Once deployed, you can test your subgraph in Subgraph Studio using the playground, deploy another version if needed, update the metadata, and when you are ready, publish your subgraph to Graph Explorer. + From a1dc3bea54c37d719ae893158b15fac3b1e0bfdc Mon Sep 17 00:00:00 2001 From: Idalith Bustos Date: Wed, 2 Oct 2024 16:45:52 -0700 Subject: [PATCH 02/15] Deploying-a -subgraph --- .../deploying-a-subgraph-to-studio.mdx | 53 ++++++++----------- 1 file changed, 23 insertions(+), 30 deletions(-) diff --git a/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx b/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx index be4c87a29ee6..e9639616b8a8 100644 --- a/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx +++ b/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx @@ -1,23 +1,23 @@ --- -title: Deploying a Subgraph to Subgraph Studio +title: Deploy Using Subgraph Studio --- -> Before deploying, you must install The Graph CLI; please review [Creating a Subgraph]() +Learn how to deploy your subgraph in Subgraph Studio. -When you deploy a subgraph, you push it to Subgraph Studio, where you'll be able to stage it. It's important to remember that deploying is not the same as publishing. When you publish a subgraph, you are publishing it on-chain. +> Note: When you deploy a subgraph, you push it to Subgraph Studio, where you'll be able to stage it. It's important to remember that deploying is not the same as publishing. When you publish a subgraph, you are publishing it on-chain. -## What can you do in Subgraph Studio? +## Subgraph Studio Overview -[Subgraph Studio]() allows you to do the following: +In [Subgraph Studio](https://thegraph.com/studio/), you can do the following: - Create and manage your API keys for specific subgraphs -- Create your Subgraph in Subgraph Studio +- Create your subgraph - Authenticate your account from the CLI -- Deploy a Subgraph to Subgraph Studio -- Stage it in the playground environment -- Integrate it in staging using the query URL +- Deploy your subgraph +- Stage your subgraph in the playground environment +- Integrate your subgraph in staging using the query URL -In Subgraph Studio, you can view the following: +In [Subgraph Studio](https://thegraph.com/studio/), you can view the following: - Your user account controls - A list of subgraphs you've created @@ -25,10 +25,10 @@ In Subgraph Studio, you can view the following: - A section to manage, view details, and visualize the status of a specific subgraph - A section to manage your billing -Step-by-Step - ## 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:** @@ -43,7 +43,7 @@ yarn global add @graphprotocol/graph-cli npm install -g @graphprotocol/graph-cli ``` -## Create your Subgraph in Subgraph Studio +## Create your subgraph ### Create an account @@ -63,7 +63,7 @@ Before deploying your subgraph you need to create a subgraph in [Subgraph Studio -> For additional written detail, review the [quick-start]() +> For additional written detail, review the [quick-start](/quick-start/) #### Subgraph Compatibility with The Graph Network @@ -75,7 +75,7 @@ In order to be supported by Indexers on The Graph Network, subgraphs must: - Non-fatal errors - Grafting -## Initialize your Subgraph +## Initialize your subgraph Once your subgraph has been created in Subgraph Studio you can initialize the subgraph code using this command: @@ -87,13 +87,11 @@ You can view the `` value on your subgraph details page in Subgra ![Subgraph Studio - Slug](/img/doc-subgraph-slug.png) -After running `graph init`, you will be asked to input the contract address, network, and 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. +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 can deploy your subgraph to Subgraph Studio, you must login into your account using the CLI. To do this, you will need your deploy key (you can find it on your "My Subgraphs" page or under your subgraph details page). +Before can deploy your subgraph to Subgraph Studio, you must login into your account using the CLI. To do this, you will need your deploy key, which you can find on your "My Subgraphs" page or under your subgraph details page. Then, use the following command to authenticate from the CLI: @@ -101,7 +99,7 @@ Then, use the following command to authenticate from the CLI: graph auth --studio ``` -## Deploying a Subgraph to Subgraph Studio +## Deploying a subgraph Once you are ready, you can deploy your subgraph to Subgraph Studio. @@ -118,19 +116,14 @@ 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`, `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 +## Testing your subgraph -After deploying, you can test/stage your subgraph in Subgraph Studio, deploy another version, update the metadata, and publish to Graph Explorer when you are ready. +After deploying, you can test/stage your subgraph in Subgraph Studio, deploy another version, update the metadata, and publish to [Graph Explorer](https://thegraph.com/explorer) when you are ready. -Use Subgraph Studio’s playground to: +Use Subgraph Studio’s playground to check your subgraph logs and see where a subgraph fails. -- Check your subgraph logs -- The subgraph logs will indicate if and where a subgraph fails. - -## Publish your Subgraph in Subgraph Studio +## Publish your subgraph You are now ready to publish your subgraph! -In order to publish your subgraph successfully, review [publishing a subgraph] (/publishing/publishing-a-subgraph/). - - +In order to publish your subgraph successfully, review [publishing a subgraph](/publishing/publishing-a-subgraph/). From 5c0c663961ff0b890d2f09771b2f17e0d3fac39b Mon Sep 17 00:00:00 2001 From: Idalith Bustos Date: Thu, 3 Oct 2024 16:22:36 -0700 Subject: [PATCH 03/15] Edits --- .../deploying-a-subgraph-to-studio.mdx | 57 ++++++++++++------- 1 file changed, 36 insertions(+), 21 deletions(-) diff --git a/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx b/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx index e9639616b8a8..1a0f25ab998e 100644 --- a/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx +++ b/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx @@ -4,18 +4,19 @@ title: Deploy Using Subgraph Studio Learn how to deploy your subgraph in Subgraph Studio. -> Note: When you deploy a subgraph, you push it to Subgraph Studio, where you'll be able to stage it. It's important to remember that deploying is not the same as publishing. When you publish a subgraph, you are publishing it on-chain. +> Note: When you deploy a subgraph, you push it to Subgraph Studio, where you'll be able to stage 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: - Create and manage your API keys for specific subgraphs -- Create your subgraph -- Authenticate your account from the CLI -- Deploy your subgraph +- Create your subgraph through Studio UI +- Deploy your subgraph using the CLI +- Publish your subgraph with the Studio UI - Stage your subgraph in the playground environment - Integrate your subgraph in staging using the query URL +- Restrict your API keys to specific domains and allow only certain Indexers to query with them In [Subgraph Studio](https://thegraph.com/studio/), you can view the following: @@ -43,23 +44,21 @@ yarn global add @graphprotocol/graph-cli npm install -g @graphprotocol/graph-cli ``` -## Create your subgraph +## Create your Subgraph -### Create an account +### Create an Account Before deploying your subgraph you need to create a subgraph in [Subgraph Studio](https://thegraph.com/studio/). 1. Open [Subgraph Studio](https://thegraph.com/studio/). -2. Connect your wallet. - - You can do this via MetaMask, WalletConnect, Coinbase Wallet, or Safe. -3. After you connect your wallet, your unique deploy key will be displayed on your "My Subgraphs" page or your “subgraph details” page in the 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 account home 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. -4. You can create one or multiple API keys by clicking the API keys tab at the top of your homepage. See image below: - - You can limit API keys to a specific domain in the security section. > Important: You need API keys to query subgraphs -#### How to create a subgraph in Subgraph Studio +#### How to Create a Subgraph in Subgraph Studio @@ -75,15 +74,15 @@ In order to be supported by Indexers on The Graph Network, subgraphs must: - Non-fatal errors - Grafting -## Initialize your subgraph +## Initialize your Subgraph -Once your subgraph has been created in Subgraph Studio you can initialize the subgraph code using this command: +Once your subgraph has been created in Subgraph Studio, you can initialize the subgraph code through the CLI using this command: ```bash graph init --studio ``` -You can view the `` value on your subgraph details page in Subgraph Studio, see image below: +You can find the `` value on your subgraph details page in Subgraph Studio, see image below: ![Subgraph Studio - Slug](/img/doc-subgraph-slug.png) @@ -91,7 +90,7 @@ After running `graph init`, you will be asked to input the contract address, net ## Graph Auth -Before can deploy your subgraph to Subgraph Studio, you must login into your account using the CLI. To do this, you will need your deploy key, which you can find on your "My Subgraphs" page or under your subgraph details page. +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 on your "My Subgraphs" page or under your subgraph details page. Then, use the following command to authenticate from the CLI: @@ -99,7 +98,7 @@ Then, use the following command to authenticate from the CLI: graph auth --studio ``` -## Deploying a subgraph +## Deploying a Subgraph Once you are ready, you can deploy your subgraph to Subgraph Studio. @@ -116,14 +115,30 @@ 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`, `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 +## Testing your Subgraph After deploying, you can test/stage your subgraph in Subgraph Studio, deploy another version, update the metadata, and publish to [Graph Explorer](https://thegraph.com/explorer) when you are ready. Use Subgraph Studio’s playground to check your subgraph logs and see where a subgraph fails. -## Publish your subgraph - -You are now ready to publish 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 the 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 subgraphs' metadata without publishing a new version. You can update your subgraph details in the 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 the 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 on the risks of curation, 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 the Studio UI. + +> Note: Previous versions of non-published subgraphs deployed to the Studio will be automatically archived. From d1a319f3c0ecf1366dccacf2c60ae3a9c11f382e Mon Sep 17 00:00:00 2001 From: Idalith Bustos Date: Thu, 3 Oct 2024 16:24:42 -0700 Subject: [PATCH 04/15] added image --- website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx b/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx index 1a0f25ab998e..fed6ff6b6ce2 100644 --- a/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx +++ b/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx @@ -142,3 +142,5 @@ You can also update your subgraphs' metadata without publishing a new version. Y 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 the Studio UI. > Note: Previous versions of non-published subgraphs deployed to the Studio will be automatically archived. + +![Subgraph Studio - Unarchive](/img/Unarchive.png) From 09dcb08b0364dd1f4363ee3f97f51e8c06755ede Mon Sep 17 00:00:00 2001 From: Idalith Bustos Date: Thu, 3 Oct 2024 16:27:17 -0700 Subject: [PATCH 05/15] deleting page --- website/pages/en/deploying/_meta.js | 1 - .../pages/en/deploying/subgraph-studio.mdx | 89 ------------------- 2 files changed, 90 deletions(-) delete mode 100644 website/pages/en/deploying/subgraph-studio.mdx diff --git a/website/pages/en/deploying/_meta.js b/website/pages/en/deploying/_meta.js index a4787de382ba..0915f1b7ace5 100644 --- a/website/pages/en/deploying/_meta.js +++ b/website/pages/en/deploying/_meta.js @@ -1,5 +1,4 @@ export default { - 'subgraph-studio': '', 'deploying-a-subgraph-to-studio': '', 'subgraph-studio-faqs': '', } diff --git a/website/pages/en/deploying/subgraph-studio.mdx b/website/pages/en/deploying/subgraph-studio.mdx deleted file mode 100644 index f2da63abff0b..000000000000 --- a/website/pages/en/deploying/subgraph-studio.mdx +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: How to Use Subgraph Studio ---- - -Welcome to your new launchpad 👩🏽‍🚀 - -Subgraph Studio is your place to build and create subgraphs, add metadata, and publish them to the new decentralized Explorer (more on that [here](/network/explorer)). - -What you can do in Subgraph Studio: - -- Create a subgraph through the Studio UI -- Deploy a subgraph using the CLI -- Publish a subgraph with the Studio UI -- Test it in the playground -- Integrate it in staging using the query URL -- Create and manage your API keys for specific subgraphs - -Here in Subgraph Studio, you have full control over your subgraphs. Not only can you test your subgraphs before you publish them, but you can also restrict your API keys to specific domains and only allow certain Indexers to query from their API keys. - -Querying subgraphs generates query fees, used to reward [Indexers](/network/indexing) on the Graph network. If you’re a dapp developer or subgraph developer, the Studio will empower you to build better subgraphs to power your or your community’s queries. The Studio is comprised of 5 main parts: - -- Your user account controls -- A list of subgraphs that you’ve created -- A section to manage, view details and visualize the status of a specific subgraph -- A section to manage your API keys that you will need to query a subgraph -- A section to manage your billing - -## How to Create Your Account - -1. Sign in with your wallet - you can do this via MetaMask, WalletConnect, Coinbase Wallet or Safe. -1. Once you sign in, you will see your unique deploy key on your account home page. This will allow you to either publish your subgraphs or manage your API keys + billing. You will have a unique deploy key that can be re-generated if you think it has been compromised. - -## How to Create a Subgraph in Subgraph Studio - - - -## 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 - -More features & networks will be added to The Graph Network incrementally. - -### Subgraph lifecycle flow - -![Subgraph Lifecycle](/img/subgraph-lifecycle.png) - -After you have created your subgraph, you will be able to deploy it using the [CLI](https://github.com/graphprotocol/graph-tooling/tree/main/packages/cli), or command-line interface. Deploying a subgraph with the CLI will push the subgraph to the Studio where you’ll be able to test subgraphs using the playground. This will eventually allow you to publish to the Graph Network. For more information on CLI setup, [check this out](/developing/defining-a-subgraph#install-the-graph-cli) (psst, make sure you have your deploy key on hand). Remember, deploying is **not the same as** publishing. When you deploy a subgraph, you just push it to the Studio where you’re able to test it. Versus, when you publish a subgraph, you are publishing it on-chain. - -## Testing your Subgraph in Subgraph Studio - -If you’d like to test your subgraph before publishing it to the network, you can do this in the Subgraph **Playground** or look at your logs. The Subgraph logs will tell you **where** your subgraph fails in the case that it does. - -## Publish your Subgraph in Subgraph Studio - -You’ve made it this far - congrats! - -In order to publish your subgraph successfully, you’ll need to go through the following steps outlined in this [section](/publishing/publishing-a-subgraph/). - -Check out the video overview below as well: - - - -Remember, while you’re going through your publishing flow, you’ll be able to push to either Arbitrum One or Arbitrum Sepolia. If you’re a first-time subgraph developer, we highly suggest you start with publishing to Arbitrum Sepolia, which is free to do. This will allow you to see how the subgraph will work in Graph Explorer and will allow you to test curation elements. - -Indexers need to submit mandatory Proof of Indexing records as of a specific block hash. Because publishing a subgraph is an action taken on-chain, remember that the transaction can take up to a few minutes to go through. Any address you use to publish the contract will be the only one able to publish future versions. Choose wisely! - -Subgraphs with curation signal are shown to Indexers so that they can be indexed on the decentralized network. You can publish subgraphs and signal in one transaction, which allows you to mint the first curation signal on the subgraph and saves on gas costs. By adding your signal to the signal later provided by Curators, your subgraph will also have a higher chance of ultimately serving queries. - -**Now that you’ve published your subgraph, let’s get into how you’ll manage them on a regular basis.** Note that you cannot publish your subgraph to the network if it has failed syncing. This is usually because the subgraph has bugs - the logs will tell you where those issues exist! - -## Versioning your Subgraph with the CLI - -Developers might want to update their subgraph, for a variety of reasons. When this is the case, you can deploy a new version of your subgraph to the Studio using the CLI (it will only be private at this point) and if you are happy with it, you can publish this new deployment to Graph Explorer. This will create a new version of your subgraph that curators can start signaling on and Indexers will be able to index this new version. - -Up until recently, developers were forced to deploy and publish a new version of their subgraph to the Explorer to update the metadata of their subgraphs. Now, developers can update the metadata of their subgraphs **without having to publish a new version**. Developers can update their subgraph details in the 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 the Explorer without having to publish a new version with a new deployment. - -Please note that there are costs associated with publishing a new version of a subgraph to the network. In addition to the transaction fees, developers 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 on the risks of curation, 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 the Studio UI. Please note that previous versions of non-published subgraphs deployed to the Studio will be automatically archived. - -![Subgraph Studio - Unarchive](/img/Unarchive.png) From bec2d525e97454525aace109fb127b79461dc5d5 Mon Sep 17 00:00:00 2001 From: Idalith Bustos Date: Mon, 7 Oct 2024 09:52:08 -0700 Subject: [PATCH 06/15] some updates --- .../deploying-a-subgraph-to-studio.mdx | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx b/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx index fed6ff6b6ce2..0fd110fb9cff 100644 --- a/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx +++ b/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx @@ -11,14 +11,14 @@ Learn how to deploy your subgraph in Subgraph Studio. In [Subgraph Studio](https://thegraph.com/studio/), you can do the following: - Create and manage your API keys for specific subgraphs -- Create your subgraph through Studio UI -- Deploy your subgraph using the CLI +- Create your subgraph through the Studio UI +- Deploy your subgraph using the The Graph CLI - Publish your subgraph with the Studio UI - Stage your subgraph in the playground environment - Integrate your subgraph in staging using the query URL - Restrict your API keys to specific domains and allow only certain Indexers to query with them -In [Subgraph Studio](https://thegraph.com/studio/), you can view the following: +You can also view the following: - Your user account controls - A list of subgraphs you've created @@ -26,11 +26,11 @@ In [Subgraph Studio](https://thegraph.com/studio/), you can view the following: - A section to manage, view details, and visualize the status of a specific subgraph - A section to manage your billing -## Install the Graph CLI +## 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. +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:** @@ -56,13 +56,13 @@ Before deploying your subgraph you need to create a subgraph in [Subgraph Studio 3. After you sign in, your unique deploy key will be displayed on your account home 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 API keys to query subgraphs +> Important: You need an API key to query subgraphs #### How to Create a Subgraph in Subgraph Studio -> For additional written detail, review the [quick-start](/quick-start/) +> For additional written detail, review the [Quick-Start](/quick-start/). #### Subgraph Compatibility with The Graph Network @@ -76,7 +76,7 @@ In order to be supported by Indexers on The Graph Network, subgraphs must: ## Initialize your Subgraph -Once your subgraph has been created in Subgraph Studio, you can initialize the subgraph code through the CLI using this command: +Once your subgraph has been created in Subgraph Studio, you can initialize its code through the CLI using this command: ```bash graph init --studio @@ -90,7 +90,7 @@ After running `graph init`, you will be asked to input the contract address, net ## 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 on your "My Subgraphs" page or under your subgraph details page. +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: @@ -112,12 +112,12 @@ graph deploy --studio 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`, `asdf`. +- 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/stage your subgraph in Subgraph Studio, deploy another version, update the metadata, and publish to [Graph Explorer](https://thegraph.com/explorer) when you are ready. +After deploying, you can test/stage 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’s playground to check your subgraph logs and see where a subgraph fails. @@ -129,18 +129,18 @@ 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 the Studio using the CLI (it will only be private at this point). +- 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 subgraphs' metadata without publishing a new version. You can update your subgraph details in the 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 the Explorer without having to publish a new version with a new deployment. +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 on the risks of curation, please read more [here](/network/curating/). +> 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 on the risks of curation, 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 the Studio UI. +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 Studio UI. -> Note: Previous versions of non-published subgraphs deployed to the Studio will be automatically archived. +> Note: Previous versions of non-published subgraphs deployed to Studio will be automatically archived. ![Subgraph Studio - Unarchive](/img/Unarchive.png) From 5ba486ef3209de84107d34f300a493f7006e3af8 Mon Sep 17 00:00:00 2001 From: Idalith Bustos Date: Tue, 8 Oct 2024 16:13:15 -0700 Subject: [PATCH 07/15] updating --- .../deploying-a-subgraph-to-studio.mdx | 33 ++++++++----------- 1 file changed, 13 insertions(+), 20 deletions(-) diff --git a/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx b/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx index 0fd110fb9cff..617eb7ccef36 100644 --- a/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx +++ b/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx @@ -4,7 +4,7 @@ title: Deploy Using Subgraph Studio Learn how to deploy your subgraph in Subgraph Studio. -> Note: When you deploy a subgraph, you push it to Subgraph Studio, where you'll be able to stage 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. +> 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 @@ -13,18 +13,13 @@ In [Subgraph Studio](https://thegraph.com/studio/), you can do the following: - Create and manage your API keys for specific subgraphs - Create your subgraph through the Studio UI - Deploy your subgraph using the The Graph CLI -- Publish your subgraph with the Studio UI -- Stage your subgraph in the playground environment - Integrate your subgraph in staging using the query URL +- Publish your subgraph with the Studio UI +- Test your subgraph in the playground environment - Restrict your API keys to specific domains and allow only certain Indexers to query with them - -You can also view the following: - -- Your user account controls -- A list of subgraphs you've created -- A section to manage your API keys -- A section to manage, view details, and visualize the status of a specific subgraph -- A section to manage your billing +- View a list of subgraphs you've created +- Manage, view details, and visualize the status of a specific subgraph +- Manage your billing ## Install The Graph CLI @@ -46,25 +41,23 @@ npm install -g @graphprotocol/graph-cli ## Create your Subgraph -### Create an Account - Before deploying your subgraph you need to create a subgraph 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 account home page. +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 +### How to Create a Subgraph in Subgraph Studio > For additional written detail, review the [Quick-Start](/quick-start/). -#### Subgraph Compatibility with The Graph Network +### Subgraph Compatibility with The Graph Network In order to be supported by Indexers on The Graph Network, subgraphs must: @@ -117,9 +110,9 @@ After running this command, the CLI will ask for a version label. ## Testing your Subgraph -After deploying, you can test/stage 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. +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’s playground to check your subgraph logs and see where a subgraph fails. +Use Subgraph Studio to check the logs on the dashboard and look for any errors with your subgraph. ## Publish your Subgraph @@ -131,11 +124,11 @@ 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. +- 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 on the risks of curation, please read more [here](/network/curating/). +> 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 From a92c6e38e1e2f58fd6c3de733b7234038df7f823 Mon Sep 17 00:00:00 2001 From: Idalith Bustos Date: Thu, 10 Oct 2024 11:21:39 -0700 Subject: [PATCH 08/15] updates --- nginx.conf | 2 +- website/pages/en/deploying/_meta.js | 2 +- ...o.mdx => deploy-using-subgraph-studio.mdx} | 26 +++++++++---------- 3 files changed, 15 insertions(+), 15 deletions(-) rename website/pages/en/deploying/{deploying-a-subgraph-to-studio.mdx => deploy-using-subgraph-studio.mdx} (94%) diff --git a/nginx.conf b/nginx.conf index 5c622a5541fa..2e1eaae3e7eb 100644 --- a/nginx.conf +++ b/nginx.conf @@ -94,7 +94,7 @@ http { rewrite ^/docs/([a-zA-Z][a-zA-Z])/managing/transferring-subgraph-ownership/$ $scheme://$http_host/docs/$1/managing/transfer-and-deprecate-a-subgraph/ 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/en/deploying/_meta.js b/website/pages/en/deploying/_meta.js index 0915f1b7ace5..d91e50f0186b 100644 --- a/website/pages/en/deploying/_meta.js +++ b/website/pages/en/deploying/_meta.js @@ -1,4 +1,4 @@ export default { - 'deploying-a-subgraph-to-studio': '', + 'deploy-using-subgraph-studio': '', 'subgraph-studio-faqs': '', } diff --git a/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx b/website/pages/en/deploying/deploy-using-subgraph-studio.mdx similarity index 94% rename from website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx rename to website/pages/en/deploying/deploy-using-subgraph-studio.mdx index 617eb7ccef36..502169b4ccfa 100644 --- a/website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx +++ b/website/pages/en/deploying/deploy-using-subgraph-studio.mdx @@ -2,7 +2,7 @@ title: Deploy Using Subgraph Studio --- -Learn how to deploy your subgraph in 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. @@ -10,15 +10,15 @@ Learn how to deploy your subgraph in Subgraph Studio. 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 -- Integrate your subgraph in staging using the query URL -- Publish your subgraph with the Studio UI - Test your subgraph in the playground environment -- Restrict your API keys to specific domains and allow only certain Indexers to query with them -- View a list of subgraphs you've created -- Manage, view details, and visualize the status of a specific subgraph +- Integrate your subgraph in staging using the development query URL +- Publish your subgraph with the Studio UI - Manage your billing ## Install The Graph CLI @@ -39,9 +39,9 @@ yarn global add @graphprotocol/graph-cli npm install -g @graphprotocol/graph-cli ``` -## Create your Subgraph +## Create Your Subgraph -Before deploying your subgraph you need to create a subgraph in [Subgraph Studio](https://thegraph.com/studio/). +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. @@ -67,7 +67,7 @@ In order to be supported by Indexers on The Graph Network, subgraphs must: - Non-fatal errors - Grafting -## Initialize your Subgraph +## Initialize Your Subgraph Once your subgraph has been created in Subgraph Studio, you can initialize its code through the CLI using this command: @@ -108,17 +108,17 @@ 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 +## 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 +## Publish Your Subgraph In order to publish your subgraph successfully, review [publishing a subgraph](/publishing/publishing-a-subgraph/). -## Versioning your Subgraph with the CLI +## Versioning Your Subgraph with the CLI If you want to update your subgraph, you can do the following: @@ -132,7 +132,7 @@ You can also update your subgraph's metadata without publishing a new version. Y ## 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 Studio UI. +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. From 08b2f2345c142f7c9a968ddcb09e07281c06a772 Mon Sep 17 00:00:00 2001 From: Idalith Bustos Date: Thu, 10 Oct 2024 11:49:21 -0700 Subject: [PATCH 09/15] updating pages --- .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploying-a-subgraph-to-studio.mdx | 68 --------- .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ .../deploy-using-subgraph-studio.mdx | 139 ++++++++++++++++++ 24 files changed, 3197 insertions(+), 68 deletions(-) create mode 100644 website/pages/ar/deploying/deploy-using-subgraph-studio.mdx delete mode 100644 website/pages/ar/deploying/deploying-a-subgraph-to-studio.mdx create mode 100644 website/pages/cs/deploying/deploy-using-subgraph-studio.mdx create mode 100644 website/pages/de/deploying/deploy-using-subgraph-studio.mdx create mode 100644 website/pages/es/deploying/deploy-using-subgraph-studio.mdx create mode 100644 website/pages/fr/deploying/deploy-using-subgraph-studio.mdx create mode 100644 website/pages/ha/deploying/deploy-using-subgraph-studio.mdx create mode 100644 website/pages/hi/deploying/deploy-using-subgraph-studio.mdx create mode 100644 website/pages/it/deploying/deploy-using-subgraph-studio.mdx create mode 100644 website/pages/ja/deploying/deploy-using-subgraph-studio.mdx create mode 100644 website/pages/ko/deploying/deploy-using-subgraph-studio.mdx create mode 100644 website/pages/mr/deploying/deploy-using-subgraph-studio.mdx create mode 100644 website/pages/nl/deploying/deploy-using-subgraph-studio.mdx create mode 100644 website/pages/pl/deploying/deploy-using-subgraph-studio.mdx create mode 100644 website/pages/pt/deploying/deploy-using-subgraph-studio.mdx create mode 100644 website/pages/ro/deploying/deploy-using-subgraph-studio.mdx create mode 100644 website/pages/ru/deploying/deploy-using-subgraph-studio.mdx create mode 100644 website/pages/sv/deploying/deploy-using-subgraph-studio.mdx create mode 100644 website/pages/tr/deploying/deploy-using-subgraph-studio.mdx create mode 100644 website/pages/uk/deploying/deploy-using-subgraph-studio.mdx create mode 100644 website/pages/ur/deploying/deploy-using-subgraph-studio.mdx create mode 100644 website/pages/vi/deploying/deploy-using-subgraph-studio.mdx create mode 100644 website/pages/yo/deploying/deploy-using-subgraph-studio.mdx create mode 100644 website/pages/zh/deploying/deploy-using-subgraph-studio.mdx diff --git a/website/pages/ar/deploying/deploy-using-subgraph-studio.mdx b/website/pages/ar/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ 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 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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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 deleted file mode 100644 index 27e20896b559..000000000000 --- a/website/pages/ar/deploying/deploying-a-subgraph-to-studio.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: Deploying a Subgraph to Subgraph Studio ---- - -These are the steps to deploy your subgraph to Subgraph Studio: - -- Install The Graph CLI (with either yarn or npm) -- Create your Subgraph in Subgraph Studio -- Authenticate your account from the CLI -- Deploying a Subgraph to Subgraph Studio - -## Installing Graph CLI - -There is a CLI to deploy subgraphs to [Subgraph Studio](https://thegraph.com/studio/). Here are the commands to install `graph-cli`. This can be done using npm or yarn. - -**التثبيت بواسطة yarn:** - -```bash -yarn global add @graphprotocol/graph-cli -``` - -**التثبيت بواسطة npm:** - -```bash -npm install -g @graphprotocol/graph-cli -``` - -## Create your Subgraph in Subgraph Studio - -Before deploying your actual subgraph you need to create a subgraph in [Subgraph Studio](https://thegraph.com/studio/). We recommend you read our [Studio documentation](/deploying/subgraph-studio) to learn more about this. - -## Initialize your Subgraph - -Once your subgraph has been created in Subgraph Studio you can initialize the subgraph code using this command: - -```bash -graph init --studio -``` - -The `` value can be found on your subgraph details page in Subgraph Studio: - -![Subgraph Studio - Slug](/img/doc-subgraph-slug.png) - -After running `graph init`, you will be asked to input the contract address, network, and ABI that you want to query. Doing 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 being able to 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 that you can find on your "My Subgraphs" page or your subgraph details page. - -Here is the command that you need to use to authenticate from the CLI: - -```bash -graph auth --studio -``` - -## Deploying a Subgraph to Subgraph Studio - -Once you are ready, you can deploy your subgraph to Subgraph Studio. Doing this won't publish your subgraph to the decentralized network, it will only deploy it to your Studio account where you will be able to test it and update the metadata. - -Here is the CLI command that you need to use to deploy your subgraph. - -```bash -graph deploy --studio -``` - -After running this command, the CLI will ask for a version label, you can name it however you want, you can use labels such as `0.1` and `0.2` or use letters as well such as `uniswap-v2-0.1`. Those labels will be visible in Graph Explorer and can be used by curators to decide if they want to signal on this version or not, so choose them wisely. - -Once deployed, you can test your subgraph in Subgraph Studio using the playground, deploy another version if needed, update the metadata, and when you are ready, publish your subgraph to Graph Explorer. diff --git a/website/pages/cs/deploying/deploy-using-subgraph-studio.mdx b/website/pages/cs/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ 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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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/de/deploying/deploy-using-subgraph-studio.mdx b/website/pages/de/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ b/website/pages/de/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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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/es/deploying/deploy-using-subgraph-studio.mdx b/website/pages/es/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ b/website/pages/es/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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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/fr/deploying/deploy-using-subgraph-studio.mdx b/website/pages/fr/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ b/website/pages/fr/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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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/ha/deploying/deploy-using-subgraph-studio.mdx b/website/pages/ha/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ b/website/pages/ha/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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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/hi/deploying/deploy-using-subgraph-studio.mdx b/website/pages/hi/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ b/website/pages/hi/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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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/it/deploying/deploy-using-subgraph-studio.mdx b/website/pages/it/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ b/website/pages/it/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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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/ja/deploying/deploy-using-subgraph-studio.mdx b/website/pages/ja/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ b/website/pages/ja/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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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/ko/deploying/deploy-using-subgraph-studio.mdx b/website/pages/ko/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ b/website/pages/ko/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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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/mr/deploying/deploy-using-subgraph-studio.mdx b/website/pages/mr/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ b/website/pages/mr/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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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/nl/deploying/deploy-using-subgraph-studio.mdx b/website/pages/nl/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ b/website/pages/nl/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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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/pl/deploying/deploy-using-subgraph-studio.mdx b/website/pages/pl/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ b/website/pages/pl/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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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/pt/deploying/deploy-using-subgraph-studio.mdx b/website/pages/pt/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ b/website/pages/pt/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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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/ro/deploying/deploy-using-subgraph-studio.mdx b/website/pages/ro/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ b/website/pages/ro/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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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/ru/deploying/deploy-using-subgraph-studio.mdx b/website/pages/ru/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ b/website/pages/ru/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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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/sv/deploying/deploy-using-subgraph-studio.mdx b/website/pages/sv/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ b/website/pages/sv/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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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/tr/deploying/deploy-using-subgraph-studio.mdx b/website/pages/tr/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ b/website/pages/tr/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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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/uk/deploying/deploy-using-subgraph-studio.mdx b/website/pages/uk/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ b/website/pages/uk/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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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/ur/deploying/deploy-using-subgraph-studio.mdx b/website/pages/ur/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ b/website/pages/ur/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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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/vi/deploying/deploy-using-subgraph-studio.mdx b/website/pages/vi/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ b/website/pages/vi/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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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/yo/deploying/deploy-using-subgraph-studio.mdx b/website/pages/yo/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ b/website/pages/yo/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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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/zh/deploying/deploy-using-subgraph-studio.mdx b/website/pages/zh/deploying/deploy-using-subgraph-studio.mdx new file mode 100644 index 000000000000..502169b4ccfa --- /dev/null +++ b/website/pages/zh/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 + + + +> 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 +``` + +You can find the `` 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 +``` + +## 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 +``` + +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) From 1daf3ac12769168cc3fbd8279f071cb19807136d Mon Sep 17 00:00:00 2001 From: Idalith <126833353+idalithb@users.noreply.github.com> Date: Fri, 11 Oct 2024 10:24:06 -0700 Subject: [PATCH 10/15] Update website/pages/ar/deploying/deploy-using-subgraph-studio.mdx MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Benoît Rouleau --- website/pages/ar/deploying/deploy-using-subgraph-studio.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/pages/ar/deploying/deploy-using-subgraph-studio.mdx b/website/pages/ar/deploying/deploy-using-subgraph-studio.mdx index 502169b4ccfa..13dbe2c02e7e 100644 --- a/website/pages/ar/deploying/deploy-using-subgraph-studio.mdx +++ b/website/pages/ar/deploying/deploy-using-subgraph-studio.mdx @@ -14,7 +14,7 @@ In [Subgraph Studio](https://thegraph.com/studio/), you can do the following: - 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 +- Create a new subgraph - 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 From b00c0cd06637c71067e47cbfa149955f31d802f3 Mon Sep 17 00:00:00 2001 From: Idalith <126833353+idalithb@users.noreply.github.com> Date: Fri, 11 Oct 2024 10:24:18 -0700 Subject: [PATCH 11/15] Update website/pages/ar/deploying/deploy-using-subgraph-studio.mdx MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Benoît Rouleau --- website/pages/ar/deploying/deploy-using-subgraph-studio.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/pages/ar/deploying/deploy-using-subgraph-studio.mdx b/website/pages/ar/deploying/deploy-using-subgraph-studio.mdx index 13dbe2c02e7e..feeb4d7ffa6a 100644 --- a/website/pages/ar/deploying/deploy-using-subgraph-studio.mdx +++ b/website/pages/ar/deploying/deploy-using-subgraph-studio.mdx @@ -15,7 +15,7 @@ In [Subgraph Studio](https://thegraph.com/studio/), you can do the following: - 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 The Graph CLI +- 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 with the Studio UI From 0c1ec01fb30e0d67cec9084269a3dda3cb56eff9 Mon Sep 17 00:00:00 2001 From: Idalith <126833353+idalithb@users.noreply.github.com> Date: Fri, 11 Oct 2024 10:24:43 -0700 Subject: [PATCH 12/15] Update website/pages/ar/deploying/deploy-using-subgraph-studio.mdx MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Benoît Rouleau --- website/pages/ar/deploying/deploy-using-subgraph-studio.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/pages/ar/deploying/deploy-using-subgraph-studio.mdx b/website/pages/ar/deploying/deploy-using-subgraph-studio.mdx index feeb4d7ffa6a..91edf3d58ab3 100644 --- a/website/pages/ar/deploying/deploy-using-subgraph-studio.mdx +++ b/website/pages/ar/deploying/deploy-using-subgraph-studio.mdx @@ -18,7 +18,7 @@ In [Subgraph Studio](https://thegraph.com/studio/), you can do the following: - 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 with the Studio UI +- Publish your subgraph to The Graph Network - Manage your billing ## Install The Graph CLI From f114d3950d58c552614167abe4cf05c96d6e3942 Mon Sep 17 00:00:00 2001 From: Idalith <126833353+idalithb@users.noreply.github.com> Date: Fri, 11 Oct 2024 10:25:29 -0700 Subject: [PATCH 13/15] Update website/pages/ar/deploying/deploy-using-subgraph-studio.mdx MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Benoît Rouleau --- website/pages/ar/deploying/deploy-using-subgraph-studio.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/pages/ar/deploying/deploy-using-subgraph-studio.mdx b/website/pages/ar/deploying/deploy-using-subgraph-studio.mdx index 91edf3d58ab3..1e6e22de7282 100644 --- a/website/pages/ar/deploying/deploy-using-subgraph-studio.mdx +++ b/website/pages/ar/deploying/deploy-using-subgraph-studio.mdx @@ -49,7 +49,7 @@ Before deploying your subgraph you need to create an account in [Subgraph Studio 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 +> Important: You need an API key to query subgraphs. ### How to Create a Subgraph in Subgraph Studio From 52a4059701f3200969340bd23f0a1e848bb52d43 Mon Sep 17 00:00:00 2001 From: Idalith Bustos Date: Fri, 11 Oct 2024 16:05:45 -0700 Subject: [PATCH 14/15] minor adjustments --- .../deploy-using-subgraph-studio.mdx | 22 +++++++++---------- 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/website/pages/en/deploying/deploy-using-subgraph-studio.mdx b/website/pages/en/deploying/deploy-using-subgraph-studio.mdx index 502169b4ccfa..1533ca9b86c3 100644 --- a/website/pages/en/deploying/deploy-using-subgraph-studio.mdx +++ b/website/pages/en/deploying/deploy-using-subgraph-studio.mdx @@ -14,11 +14,11 @@ In [Subgraph Studio](https://thegraph.com/studio/), you can do the following: - 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 +- Create your 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 with the Studio UI +- Publish your subgraph to The Graph Network - Manage your billing ## Install The Graph CLI @@ -27,21 +27,19 @@ 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:** +### Install with yarn ```bash yarn global add @graphprotocol/graph-cli ``` -**Install with npm:** +### 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/). +## Get Started 1. Open [Subgraph Studio](https://thegraph.com/studio/). 2. Connect your wallet to sign in. @@ -55,7 +53,7 @@ Before deploying your subgraph you need to create an account in [Subgraph Studio -> For additional written detail, review the [Quick-Start](/quick-start/). +> For additional written detail, review the [Quick Start](/quick-start/). ### Subgraph Compatibility with The Graph Network @@ -83,7 +81,7 @@ After running `graph init`, you will be asked to input the contract address, net ## 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. +Before you can deploy your subgraph to Subgraph Studio, you need to log 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: @@ -95,7 +93,7 @@ graph auth --studio 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. +> Deploying a subgraph with the CLI pushes it to the Studio, where you can test it and update the metadata. This action won't publish your subgraph to the decentralized network. Use the following CLI command to deploy your subgraph: @@ -126,7 +124,7 @@ If you want to update your subgraph, you can do the following: - 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. +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](https://thegraph.com/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/). From 0302801af50c910f9e676412a82aa7d6339bd047 Mon Sep 17 00:00:00 2001 From: Idalith Bustos Date: Fri, 11 Oct 2024 16:10:18 -0700 Subject: [PATCH 15/15] attempting to fix --- nginx.conf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nginx.conf b/nginx.conf index 2e1eaae3e7eb..4eb5e12b5e8e 100644 --- a/nginx.conf +++ b/nginx.conf @@ -94,7 +94,7 @@ http { rewrite ^/docs/([a-zA-Z][a-zA-Z])/managing/transferring-subgraph-ownership/$ $scheme://$http_host/docs/$1/managing/transfer-and-deprecate-a-subgraph/ 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; + 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;