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/network/developing.mdx
+16-19Lines changed: 16 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: Developing
3
3
---
4
4
5
-
Learn developer fundamentals and review the basics of a subgraph’s lifecycle. To start coding right away and build on The Graph, go to [Developer Quick Start](/quick-start/).
5
+
To start coding right away and build on The Graph, go to [Developer Quick Start](/quick-start/).
6
6
7
7
## Overview
8
8
@@ -17,11 +17,11 @@ On The Graph, you can:
17
17
18
18
-[GraphQL](https://graphql.org/learn/) is the query language for APIs and a runtime for executing those queries with your existing data. The Graph uses GraphQL to query subgraphs.
19
19
20
-
### Developer Capabilities
20
+
### Developer Actions
21
21
22
22
- Query subgraphs built by other developers in [The Graph Network](https://thegraph.com/explorer) and integrate them into your own dapps.
23
23
- Create custom subgraphs to fulfill specific data needs, allowing improved scalability and flexibility for other developers.
24
-
- Deploy, publish, and signal your subgraphs within The Graph Network.
24
+
- Deploy, publish and signal your subgraphs within The Graph Network.
25
25
26
26
## Subgraph Specifics
27
27
@@ -37,57 +37,54 @@ A subgraph primarily consists of the following files:
37
37
38
38
Learn the detailed specifics to [create a subgraph](/developing/creating-a-subgraph/).
39
39
40
-
###Subgraph Lifecycle
40
+
## Subgraph Lifecycle
41
41
42
-
Here is a general view of a subgraph’s lifecycle:
42
+
Here is a general overview of a subgraph’s lifecycle:
Great subgraphs start with a local development environment and unit tests. Developers use [Graph CLI](https://github.com/graphprotocol/graph-tooling/tree/main/packages/cli), a command-line interface tool for building and deploying subgraphs in The Graph. They can also use [Graph TypeScript](/developing/graph-ts/) and [Matchstick](/developing/unit-testing-framework/) to create robust subgraphs that deploy to The Graph Network.
49
49
50
-
## Deploy to Subgraph Studio
50
+
###Deploy to Subgraph Studio
51
51
52
52
Once defined, a subgraph can be [deployed to Subgraph Studio](/deploying/deploying-a-subgraph-to-studio/). In Subgraph Studio, you can do the following:
53
53
54
54
- Use its staging environment to index the deployed subgraph and make it available for review.
55
55
- Verify that your subgraph doesn't have any indexing errors and works as expected.
56
56
57
-
## Publish to the Network
57
+
###Publish to the Network
58
58
59
-
When you are happy with your subgraph, you can put it into production and [publish it](/publishing/publishing-a-subgraph/) to The Graph Network. This ensures Indexers can index it.
59
+
When you're happy with your subgraph, you can put it into production and [publish it](/publishing/publishing-a-subgraph/) to The Graph Network. This ensures Indexers can index it.
60
60
61
61
- This is an on-chain action, which registers the subgraph and makes it discoverable by Indexers.
62
62
- Published subgraphs have a corresponding NFT, which defines the ownership of the subgraph. You can [transfer the subgraph's ownership](/managing/transfer-and-deprecate-a-subgraph/) by sending the NFT.
63
63
- Published subgraphs have associated metadata, which provides other network participants with useful context and information.
64
64
65
-
## Add Curation Signal for Indexing
65
+
###Add Curation Signal for Indexing
66
66
67
67
Published subgraphs are unlikely to be picked up by Indexers without curation signal. To encourage indexing you should add signal to your subgraph. Learn more about signaling and [curating](/network/curating/) on The Graph.
68
68
69
-
### What is signal?
69
+
####What is signal?
70
70
71
-
- Signal is locked GRT associated with a given subgraph. It indicates to indexers that a given subgraph will receive query volume and it contributes to the indexing rewards available for processing it.
71
+
- Signal is locked GRT associated with a given subgraph. It indicates to Indexers that a given subgraph will receive query volume and it contributes to the indexing rewards available for processing it.
72
72
- Third party Curators may also signal on a given subgraph, if they deem the subgraph likely to drive query volume.
73
73
74
-
## Querying & Application Development
74
+
###Querying & Application Development
75
75
76
76
Once a subgraph has been processed by Indexers and is ready to [query](/querying/querying-the-graph/), developers can start using their subgraph in their dapps.
77
77
78
78
- When a query is made, The Graph Network selects an Indexer who has processed the subgraph to serve that query. Query fees are paid in GRT.
79
79
- Developers must generate an API key and fund it with GRT to make queries, which can be done in [Subgraph Studio](https://thegraph.com/studio/).
80
-
- Developers can set a maximum query fee, in order to control their costs, and limit their API key to a given subgraph or origin domain.
81
-
- Subgraph Studio provides API key usage data.
82
-
- Developers can express an Indexer preference to the gateway, for example preferring Indexers whose query response is faster, or whose data is most up to date. These controls are set in Subgraph Studio.
83
80
84
-
## Updating Subgraphs
81
+
###Updating Subgraphs
85
82
86
83
To update your subgraph with bug fixes or new functionalities, initiate a transaction to point it to the new version. You can deploy new versions of your subgraphs to [Subgraph Studio](https://thegraph.com/studio/) for development and testing.
87
84
88
85
- If you selected "auto-migrate" when you applied the signal, updating the subgraph will migrate any signal to the new version and incur a migration tax.
89
86
- This signal migration should prompt Indexers to start indexing the new version of the subgraph, so it should soon become available for querying.
90
87
91
-
## Deprecating & Transferring Subgraphs
88
+
###Deprecating & Transferring Subgraphs
92
89
93
-
If you no longer need a published subgraph, you can deprecate or transfer a subgraph. Deprecating a subgraph returns any signaled GRT to [Curators](/network/curating/). To deprecate or transfer a subgraph, check out [this guide](/managing/transfer-and-deprecate-a-subgraph/#deprecating-a-subgraph).
90
+
If you no longer need a published subgraph, you can [deprecate or transfer a subgraph](managing/transfer-and-deprecate-a-subgraph/). Deprecating a subgraph returns any signaled GRT to [Curators](/network/curating/). To deprecate or transfer a subgraph, check out [this guide](/managing/transfer-and-deprecate-a-subgraph/#deprecating-a-subgraph).
0 commit comments