Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Transfer to The Graph Cookbook #803

Merged
merged 7 commits into from
Nov 15, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion website/next-env.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
/// <reference types="next/image-types/global" />

// NOTE: This file should not be edited
// see https://nextjs.org/docs/pages/building-your-application/configuring/typescript for more information.
// see https://nextjs.org/docs/basic-features/typescript for more information.
1 change: 1 addition & 0 deletions website/pages/en/cookbook/_meta.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ export default {
derivedfrom: 'Subgraph Best Practice 2: Manage Arrays with @derivedFrom',
'immutable-entities-bytes-as-ids': 'Subgraph Best Practice 3: Using Immutable Entities and Bytes as IDs',
'avoid-eth-calls': 'Subgraph Best Practice 4: Avoid eth_calls',
'transfer-to-the-graph': '',
}
167 changes: 167 additions & 0 deletions website/pages/en/cookbook/transfer-to-the-graph.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
---
title: Tranfer to The Graph
---

Learn how to 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

### Install the Graph CLI⁠

On your local machine, run the following commands:

Using [npm](https://www.npmjs.com/):
idalithb marked this conversation as resolved.
Show resolved Hide resolved

```sh
graph init --product subgraph-studio
```

> Alternatively, you can set up your environment using codespaces on your Github repo.
idalithb marked this conversation as resolved.
Show resolved Hide resolved

### Create a Subgraph in Subgraph Studio
idalithb marked this conversation as resolved.
Show resolved Hide resolved

- 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".
idalithb marked this conversation as resolved.
Show resolved Hide resolved

> Note: After publishing, the subgraph name will be editable but requires signing each time, so name it properly.
idalithb marked this conversation as resolved.
Show resolved Hide resolved

For additional information on subgraph creation and the Graph CLI, check out the subgraph [Quick Start](/quick-start/) and [Creating a Subgraph](/developing/creating-a-subgraph).

### 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

In The Graph CLI, run the following command:

```sh
graph deploy --studio <slug> --ipfs-hash <your-subgraph-ipfs-hash>
idalithb marked this conversation as resolved.
Show resolved Hide resolved
```

> Note: There is no coding required, simply use the **IPFS provided by your current host**. You’ll be prompted to enter a version (e.g., v0.0.1).

## 3. Publish Your Subgraph to The Graph Network

![publish button](https://edgeandnode.notion.site/image/https%3A%2F%2Fprod-files-secure.s3.us-west-2.amazonaws.com%2Fa7d6afae-8784-4b15-a90e-ee8f6ee007ba%2F2f9c4526-123d-4164-8ea8-39959c8babbf%2FUntitled.png?table=block&id=37005371-76b4-4780-b044-040a570e3af6&spaceId=a7d6afae-8784-4b15-a90e-ee8f6ee007ba&width=1420&userId=&cache=v2)
idalithb marked this conversation as resolved.
Show resolved Hide resolved

### 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 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:

![Query URL](https://lh7-us.googleusercontent.com/docsz/AD_4nXebivsPOUjPHAa3UVtvxoYTFXaGBao9pQOAJvFK0S7Uv0scfL6TcTVjmNCzT4DgsIloAQyrPTCqHjFPtmjyrzoKkfSeV28FjS32F9-aJJm0ILAHey2gqMr7Seu4IqPz2d__QotsWG3OKv2dEghiD74eypzs?key=fnI6SyFgXU9SZRNX5C5vPQ)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same with screenshot


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:

![API keys](https://lh7-us.googleusercontent.com/docsz/AD_4nXdz7H8hSRf2XqrU0jN3p3KbmuptHvQJbhRHOJh67nBfwh8RVnhTsCFDGA_JQUFizyMn7psQO0Vgk6Vy7cKYH47OyTq5PqycB0xxLyF4kSPsT7hYdMv2MEzAo433sJT6VlQbUAzgPnSxKI9a5Tn3ShSzaxI?key=fnI6SyFgXU9SZRNX5C5vPQ)
idalithb marked this conversation as resolved.
Show resolved Hide resolved

### Sample Query
idalithb marked this conversation as resolved.
Show resolved Hide resolved

This query shows the most expensive CryptoPunks sold.

```graphql
{
trades(orderBy: priceETH, orderDirection: desc) {
priceETH
tokenId
}
}
```

Passing this into the query URL returns this result:

```graphql
{
"data": {
"trades": [
{
"priceETH": "124457.067524886018255505",
"tokenId": "9998"
},
{
"priceETH": "8000",
"tokenId": "5822"
}
// ...
]
}
}
```

<aside />

### Sample code
idalithb marked this conversation as resolved.
Show resolved Hide resolved

```jsx
const axios = require('axios')

const graphqlQuery = `{
trades(orderBy: priceETH, orderDirection: desc) {
priceETH
tokenId
}
}`;
const queryUrl =
'https://gateway-arbitrum.network.thegraph.com/api/[api-key]/subgraphs/id/HdVdERFUe8h61vm2fDyycHgxjsde5PbB832NHgJfZNqK'

const graphQLRequest = {
method: 'post',
url: queryUrl,
data: {
query: graphqlQuery,
},
};

// Send the GraphQL query
axios(graphQLRequest)
.then((response) => {
// Handle the response here
const data = response.data.data;
console.log(data);
})
.catch(error) => {
// Handle any errors
console.error(error);
});
```

### 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 explore all the ways you can optimize & customize your subgraph for a better performance, read more about [creating a subgraph here](/developing/creating-a-subgraph/).
- For more information about querying data from your subgraph, read more [here](/querying/querying-the-graph/).
Loading