You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx
+13-20Lines changed: 13 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ title: Deploy Using Subgraph Studio
4
4
5
5
Learn how to deploy your subgraph in Subgraph Studio.
6
6
7
-
> 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.
7
+
> 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.
8
8
9
9
## Subgraph Studio Overview
10
10
@@ -13,18 +13,13 @@ In [Subgraph Studio](https://thegraph.com/studio/), you can do the following:
13
13
- Create and manage your API keys for specific subgraphs
14
14
- Create your subgraph through the Studio UI
15
15
- Deploy your subgraph using the The Graph CLI
16
-
- Publish your subgraph with the Studio UI
17
-
- Stage your subgraph in the playground environment
18
16
- Integrate your subgraph in staging using the query URL
17
+
- Publish your subgraph with the Studio UI
18
+
- Test your subgraph in the playground environment
19
19
- Restrict your API keys to specific domains and allow only certain Indexers to query with them
20
-
21
-
You can also view the following:
22
-
23
-
- Your user account controls
24
-
- A list of subgraphs you've created
25
-
- A section to manage your API keys
26
-
- A section to manage, view details, and visualize the status of a specific subgraph
27
-
- A section to manage your billing
20
+
- View a list of subgraphs you've created
21
+
- Manage, view details, and visualize the status of a specific subgraph
Before deploying your subgraph you need to create a subgraph in [Subgraph Studio](https://thegraph.com/studio/).
52
45
53
46
1. Open [Subgraph Studio](https://thegraph.com/studio/).
54
47
2. Connect your wallet to sign in.
55
48
- You can do this via MetaMask, Coinbase Wallet, WalletConnect, or Safe.
56
-
3. After you sign in, your unique deploy key will be displayed on your account home page.
49
+
3. After you sign in, your unique deploy key will be displayed on your subgraph details page.
57
50
- 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.
58
51
59
52
> Important: You need an API key to query subgraphs
60
53
61
-
####How to Create a Subgraph in Subgraph Studio
54
+
### How to Create a Subgraph in Subgraph Studio
62
55
63
56
<VideoEmbedyoutube="nGIFuC69bSA" />
64
57
65
58
> For additional written detail, review the [Quick-Start](/quick-start/).
66
59
67
-
####Subgraph Compatibility with The Graph Network
60
+
### Subgraph Compatibility with The Graph Network
68
61
69
62
In order to be supported by Indexers on The Graph Network, subgraphs must:
70
63
@@ -117,9 +110,9 @@ After running this command, the CLI will ask for a version label.
117
110
118
111
## Testing your Subgraph
119
112
120
-
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.
113
+
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.
121
114
122
-
Use Subgraph Studio’s playground to check your subgraph logs and see where a subgraph fails.
115
+
Use Subgraph Studioto check the logs on the dashboard and look for any errors with your subgraph.
123
116
124
117
## Publish your Subgraph
125
118
@@ -131,11 +124,11 @@ If you want to update your subgraph, you can do the following:
131
124
132
125
- You can deploy a new version to Studio using the CLI (it will only be private at this point).
133
126
- Once you're happy with it, you can publish your new deployment to [Graph Explorer](https://thegraph.com/explorer).
134
-
- This action will create a new version of your subgraph that curators can start signaling on and Indexers can index.
127
+
- This action will create a new version of your subgraph that Curators can start signaling on and Indexers can index.
135
128
136
129
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.
137
130
138
-
> 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/).
131
+
> 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/).
0 commit comments