-
Notifications
You must be signed in to change notification settings - Fork 145
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Transfer to The Graph Cookbook (#803)
* Cookbook * updated version * tiny edits * Update website/pages/en/cookbook/transfer-to-the-graph.mdx Co-authored-by: Benoît Rouleau <[email protected]> * updating copy * updating * Adding to all lang & making final copy edits. --------- Co-authored-by: Benoît Rouleau <[email protected]>
- Loading branch information
Showing
25 changed files
with
2,497 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| --- | ||
| title: Tranfer to The Graph | ||
| --- | ||
|
|
||
| Quickly upgrade your subgraphs from any platform to [The Graph's decentralized network](https://thegraph.com/networks/). | ||
|
|
||
| ## Benefits of Switching to The Graph | ||
|
|
||
| - Use the same subgraph that your apps already use with zero-downtime migration. | ||
| - Increase reliability from a global network supported by 100+ Indexers. | ||
| - Receive lightning-fast support for subgraphs 24/7, with an on-call engineering team. | ||
|
|
||
| ## Upgrade Your Subgraph to The Graph in 3 Easy Steps | ||
|
|
||
| 1. [Set Up Your Studio Environment](/cookbook/transfer-to-the-graph/#1-set-up-your-studio-environment) | ||
| 2. [Deploy Your Subgraph to Studio](/cookbook/transfer-to-the-graph/#2-deploy-your-subgraph-to-studio) | ||
| 3. [Publish to The Graph Network](/cookbook/transfer-to-the-graph/#publish-your-subgraph-to-the-graphs-decentralized-network) | ||
|
|
||
| ## 1. Set Up Your Studio Environment | ||
|
|
||
| ### Create a Subgraph in Subgraph Studio | ||
|
|
||
| - Go to [Subgraph Studio](https://thegraph.com/studio/) and connect your wallet. | ||
| - Click "Create a Subgraph". It is recommended to name the subgraph in Title Case: "Subgraph Name Chain Name". | ||
|
|
||
| > Note: After publishing, the subgraph name will be editable but requires on-chain action each time, so name it properly. | ||
| ### Install the Graph CLI | ||
|
|
||
| You must have [Node.js](https://nodejs.org/) and a package manager of your choice (`npm` 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. | ||
|
|
||
| On your local machine, run the following command: | ||
|
|
||
| Using [npm](https://www.npmjs.com/): | ||
|
|
||
| ```sh | ||
| npm install -g @graphprotocol/graph-cli@latest | ||
| ``` | ||
|
|
||
| Use the following command to create a subgraph in Studio using the CLI: | ||
|
|
||
| ```sh | ||
| graph init --product subgraph-studio | ||
| ``` | ||
|
|
||
| ### Authenticate Your Subgraph | ||
|
|
||
| In The Graph CLI, use the auth command seen in Subgraph Studio: | ||
|
|
||
| ```sh | ||
| graph auth --studio <your-auth-code> | ||
| ``` | ||
|
|
||
| ## 2. Deploy Your Subgraph to Studio | ||
|
|
||
| If you have your source code, you can easily deploy it to Studio. If you don't have it, here's a quick way to deploy your subgraph. | ||
|
|
||
| In The Graph CLI, run the following command: | ||
|
|
||
| ```sh | ||
| graph deploy --studio <slug> --ipfs-hash <your-subgraph-ipfs-hash> | ||
|
|
||
| ``` | ||
|
|
||
| > **Note:** Every subgraph has an IPFS hash (Deployment ID), which looks like this: "Qmasdfad...". To deploy simply use this **IPFS hash**. You’ll be prompted to enter a version (e.g., v0.0.1). | ||
| ## 3. Publish Your Subgraph to The Graph Network | ||
|
|
||
|  | ||
|
|
||
| ### Query Your Subgraph | ||
|
|
||
| > To attract about 3 indexers to query your subgraph, it’s recommended to curate at least 3,000 GRT. To learn more about curating, check out [Curating](/network/curating/) on The Graph. | ||
| You can start [querying](/querying/querying-the-graph/) any subgraph by sending a GraphQL query into the subgraph’s query URL endpoint, which is located at the top of its Explorer page in Subgraph Studio. | ||
|
|
||
| #### Example | ||
|
|
||
| [CryptoPunks Ethereum subgraph](https://thegraph.com/explorer/subgraphs/HdVdERFUe8h61vm2fDyycHgxjsde5PbB832NHgJfZNqK) by Messari: | ||
|
|
||
|  | ||
|
|
||
| The query URL for this subgraph is: | ||
|
|
||
| ```sh | ||
| https://gateway-arbitrum.network.thegraph.com/api/`**your-own-api-key**`/subgraphs/id/HdVdERFUe8h61vm2fDyycgxjsde5PbB832NHgJfZNqK | ||
| ``` | ||
|
|
||
| Now, you simply need to fill in **your own API Key** to start sending GraphQL queries to this endpoint. | ||
|
|
||
| ### Getting your own API Key | ||
|
|
||
| You can create API Keys in Subgraph Studio under the “API Keys” menu at the top of the page: | ||
|
|
||
|  | ||
|
|
||
| ### Monitor Subgraph Status | ||
|
|
||
| Once you upgrade, you can access and manage your subgraphs in [Subgraph Studio](https://thegraph.com/studio/) and explore all subgraphs in [The Graph Explorer](https://thegraph.com/networks/). | ||
|
|
||
| ### Additional Resources | ||
|
|
||
| - To quickly create and publish a new subgraph, check out the [Quick Start](/quick-start/). | ||
| - To explore all the ways you can optimize and customize your subgraph for a better performance, read more about [creating a subgraph here](/developing/creating-a-subgraph/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| --- | ||
| title: Tranfer to The Graph | ||
| --- | ||
|
|
||
| Quickly upgrade your subgraphs from any platform to [The Graph's decentralized network](https://thegraph.com/networks/). | ||
|
|
||
| ## Benefits of Switching to The Graph | ||
|
|
||
| - Use the same subgraph that your apps already use with zero-downtime migration. | ||
| - Increase reliability from a global network supported by 100+ Indexers. | ||
| - Receive lightning-fast support for subgraphs 24/7, with an on-call engineering team. | ||
|
|
||
| ## Upgrade Your Subgraph to The Graph in 3 Easy Steps | ||
|
|
||
| 1. [Set Up Your Studio Environment](/cookbook/transfer-to-the-graph/#1-set-up-your-studio-environment) | ||
| 2. [Deploy Your Subgraph to Studio](/cookbook/transfer-to-the-graph/#2-deploy-your-subgraph-to-studio) | ||
| 3. [Publish to The Graph Network](/cookbook/transfer-to-the-graph/#publish-your-subgraph-to-the-graphs-decentralized-network) | ||
|
|
||
| ## 1. Set Up Your Studio Environment | ||
|
|
||
| ### Create a Subgraph in Subgraph Studio | ||
|
|
||
| - Go to [Subgraph Studio](https://thegraph.com/studio/) and connect your wallet. | ||
| - Click "Create a Subgraph". It is recommended to name the subgraph in Title Case: "Subgraph Name Chain Name". | ||
|
|
||
| > Note: After publishing, the subgraph name will be editable but requires on-chain action each time, so name it properly. | ||
| ### Install the Graph CLI | ||
|
|
||
| You must have [Node.js](https://nodejs.org/) and a package manager of your choice (`npm` 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. | ||
|
|
||
| On your local machine, run the following command: | ||
|
|
||
| Using [npm](https://www.npmjs.com/): | ||
|
|
||
| ```sh | ||
| npm install -g @graphprotocol/graph-cli@latest | ||
| ``` | ||
|
|
||
| Use the following command to create a subgraph in Studio using the CLI: | ||
|
|
||
| ```sh | ||
| graph init --product subgraph-studio | ||
| ``` | ||
|
|
||
| ### Authenticate Your Subgraph | ||
|
|
||
| In The Graph CLI, use the auth command seen in Subgraph Studio: | ||
|
|
||
| ```sh | ||
| graph auth --studio <your-auth-code> | ||
| ``` | ||
|
|
||
| ## 2. Deploy Your Subgraph to Studio | ||
|
|
||
| If you have your source code, you can easily deploy it to Studio. If you don't have it, here's a quick way to deploy your subgraph. | ||
|
|
||
| In The Graph CLI, run the following command: | ||
|
|
||
| ```sh | ||
| graph deploy --studio <slug> --ipfs-hash <your-subgraph-ipfs-hash> | ||
|
|
||
| ``` | ||
|
|
||
| > **Note:** Every subgraph has an IPFS hash (Deployment ID), which looks like this: "Qmasdfad...". To deploy simply use this **IPFS hash**. You’ll be prompted to enter a version (e.g., v0.0.1). | ||
| ## 3. Publish Your Subgraph to The Graph Network | ||
|
|
||
|  | ||
|
|
||
| ### Query Your Subgraph | ||
|
|
||
| > To attract about 3 indexers to query your subgraph, it’s recommended to curate at least 3,000 GRT. To learn more about curating, check out [Curating](/network/curating/) on The Graph. | ||
| You can start [querying](/querying/querying-the-graph/) any subgraph by sending a GraphQL query into the subgraph’s query URL endpoint, which is located at the top of its Explorer page in Subgraph Studio. | ||
|
|
||
| #### Example | ||
|
|
||
| [CryptoPunks Ethereum subgraph](https://thegraph.com/explorer/subgraphs/HdVdERFUe8h61vm2fDyycHgxjsde5PbB832NHgJfZNqK) by Messari: | ||
|
|
||
|  | ||
|
|
||
| The query URL for this subgraph is: | ||
|
|
||
| ```sh | ||
| https://gateway-arbitrum.network.thegraph.com/api/`**your-own-api-key**`/subgraphs/id/HdVdERFUe8h61vm2fDyycgxjsde5PbB832NHgJfZNqK | ||
| ``` | ||
|
|
||
| Now, you simply need to fill in **your own API Key** to start sending GraphQL queries to this endpoint. | ||
|
|
||
| ### Getting your own API Key | ||
|
|
||
| You can create API Keys in Subgraph Studio under the “API Keys” menu at the top of the page: | ||
|
|
||
|  | ||
|
|
||
| ### Monitor Subgraph Status | ||
|
|
||
| Once you upgrade, you can access and manage your subgraphs in [Subgraph Studio](https://thegraph.com/studio/) and explore all subgraphs in [The Graph Explorer](https://thegraph.com/networks/). | ||
|
|
||
| ### Additional Resources | ||
|
|
||
| - To quickly create and publish a new subgraph, check out the [Quick Start](/quick-start/). | ||
| - To explore all the ways you can optimize and customize your subgraph for a better performance, read more about [creating a subgraph here](/developing/creating-a-subgraph/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| --- | ||
| title: Tranfer to The Graph | ||
| --- | ||
|
|
||
| Quickly upgrade your subgraphs from any platform to [The Graph's decentralized network](https://thegraph.com/networks/). | ||
|
|
||
| ## Benefits of Switching to The Graph | ||
|
|
||
| - Use the same subgraph that your apps already use with zero-downtime migration. | ||
| - Increase reliability from a global network supported by 100+ Indexers. | ||
| - Receive lightning-fast support for subgraphs 24/7, with an on-call engineering team. | ||
|
|
||
| ## Upgrade Your Subgraph to The Graph in 3 Easy Steps | ||
|
|
||
| 1. [Set Up Your Studio Environment](/cookbook/transfer-to-the-graph/#1-set-up-your-studio-environment) | ||
| 2. [Deploy Your Subgraph to Studio](/cookbook/transfer-to-the-graph/#2-deploy-your-subgraph-to-studio) | ||
| 3. [Publish to The Graph Network](/cookbook/transfer-to-the-graph/#publish-your-subgraph-to-the-graphs-decentralized-network) | ||
|
|
||
| ## 1. Set Up Your Studio Environment | ||
|
|
||
| ### Create a Subgraph in Subgraph Studio | ||
|
|
||
| - Go to [Subgraph Studio](https://thegraph.com/studio/) and connect your wallet. | ||
| - Click "Create a Subgraph". It is recommended to name the subgraph in Title Case: "Subgraph Name Chain Name". | ||
|
|
||
| > Note: After publishing, the subgraph name will be editable but requires on-chain action each time, so name it properly. | ||
| ### Install the Graph CLI | ||
|
|
||
| You must have [Node.js](https://nodejs.org/) and a package manager of your choice (`npm` 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. | ||
|
|
||
| On your local machine, run the following command: | ||
|
|
||
| Using [npm](https://www.npmjs.com/): | ||
|
|
||
| ```sh | ||
| npm install -g @graphprotocol/graph-cli@latest | ||
| ``` | ||
|
|
||
| Use the following command to create a subgraph in Studio using the CLI: | ||
|
|
||
| ```sh | ||
| graph init --product subgraph-studio | ||
| ``` | ||
|
|
||
| ### Authenticate Your Subgraph | ||
|
|
||
| In The Graph CLI, use the auth command seen in Subgraph Studio: | ||
|
|
||
| ```sh | ||
| graph auth --studio <your-auth-code> | ||
| ``` | ||
|
|
||
| ## 2. Deploy Your Subgraph to Studio | ||
|
|
||
| If you have your source code, you can easily deploy it to Studio. If you don't have it, here's a quick way to deploy your subgraph. | ||
|
|
||
| In The Graph CLI, run the following command: | ||
|
|
||
| ```sh | ||
| graph deploy --studio <slug> --ipfs-hash <your-subgraph-ipfs-hash> | ||
|
|
||
| ``` | ||
|
|
||
| > **Note:** Every subgraph has an IPFS hash (Deployment ID), which looks like this: "Qmasdfad...". To deploy simply use this **IPFS hash**. You’ll be prompted to enter a version (e.g., v0.0.1). | ||
| ## 3. Publish Your Subgraph to The Graph Network | ||
|
|
||
|  | ||
|
|
||
| ### Query Your Subgraph | ||
|
|
||
| > To attract about 3 indexers to query your subgraph, it’s recommended to curate at least 3,000 GRT. To learn more about curating, check out [Curating](/network/curating/) on The Graph. | ||
| You can start [querying](/querying/querying-the-graph/) any subgraph by sending a GraphQL query into the subgraph’s query URL endpoint, which is located at the top of its Explorer page in Subgraph Studio. | ||
|
|
||
| #### Example | ||
|
|
||
| [CryptoPunks Ethereum subgraph](https://thegraph.com/explorer/subgraphs/HdVdERFUe8h61vm2fDyycHgxjsde5PbB832NHgJfZNqK) by Messari: | ||
|
|
||
|  | ||
|
|
||
| The query URL for this subgraph is: | ||
|
|
||
| ```sh | ||
| https://gateway-arbitrum.network.thegraph.com/api/`**your-own-api-key**`/subgraphs/id/HdVdERFUe8h61vm2fDyycgxjsde5PbB832NHgJfZNqK | ||
| ``` | ||
|
|
||
| Now, you simply need to fill in **your own API Key** to start sending GraphQL queries to this endpoint. | ||
|
|
||
| ### Getting your own API Key | ||
|
|
||
| You can create API Keys in Subgraph Studio under the “API Keys” menu at the top of the page: | ||
|
|
||
|  | ||
|
|
||
| ### Monitor Subgraph Status | ||
|
|
||
| Once you upgrade, you can access and manage your subgraphs in [Subgraph Studio](https://thegraph.com/studio/) and explore all subgraphs in [The Graph Explorer](https://thegraph.com/networks/). | ||
|
|
||
| ### Additional Resources | ||
|
|
||
| - To quickly create and publish a new subgraph, check out the [Quick Start](/quick-start/). | ||
| - To explore all the ways you can optimize and customize your subgraph for a better performance, read more about [creating a subgraph here](/developing/creating-a-subgraph/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.