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
+1-60
Original file line number
Diff line number
Diff line change
@@ -23,67 +23,8 @@ On The Graph, you can:
23
23
- Create custom subgraphs to fulfill specific data needs, allowing improved scalability and flexibility for other developers.
24
24
- Deploy, publish and signal your subgraphs within The Graph Network.
25
25
26
-
## Subgraph Specifics
27
-
28
26
### What are subgraphs?
29
27
30
28
A subgraph is a custom API built on blockchain data. It extracts data from a blockchain, processes it, and stores it so that it can be easily queried via GraphQL.
31
29
32
-
A subgraph primarily consists of the following files:
33
-
34
-
-`subgraph.yaml`: this YAML file contains the [subgraph manifest](/developing/creating-a-subgraph/#the-subgraph-manifest).
35
-
-`subgraph.graphql`: this GraphQL schema defines what data is stored for your subgraph, and how to query it via [GraphQL](/developing/creating-a-subgraph/#the-graphql-schema).
36
-
-`mappings`: this [AssemblyScript](https://github.com/AssemblyScript/assemblyscript) mappings file translates data from the event data to the entities defined in your schema.
37
-
38
-
Learn the detailed specifics to [create a subgraph](/developing/creating-a-subgraph/).
39
-
40
-
## Subgraph Lifecycle
41
-
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 on The Graph. They can also use [Graph TypeScript](/developing/graph-ts/) and [Matchstick](/developing/unit-testing-framework/) to create robust subgraphs.
49
-
50
-
### Deploy to Subgraph Studio
51
-
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
-
54
-
- Use its staging environment to index the deployed subgraph and make it available for review.
55
-
- Verify that your subgraph doesn't have any indexing errors and works as expected.
56
-
57
-
### Publish to the Network
58
-
59
-
When you're happy with your subgraph, you can [publish it](/publishing/publishing-a-subgraph/) to The Graph Network.
60
-
61
-
- This is an on-chain action, which registers the subgraph and makes it discoverable by Indexers.
62
-
- Published subgraphs have a corresponding NFT, which defines the ownership of the subgraph. You can [transfer the subgraph's ownership](/managing/transfer-a-subgraph/) by sending the NFT.
63
-
- Published subgraphs have associated metadata, which provides other network participants with useful context and information.
64
-
65
-
### Add Curation Signal for Indexing
66
-
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
-
69
-
#### What is signal?
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.
72
-
- Third party Curators may also signal on a given subgraph, if they deem the subgraph likely to drive query volume.
73
-
74
-
### Querying & Application Development
75
-
76
-
Subgraphs on The Graph Network receive 100,000 free queries per month, after which point developers can either [pay for queries with GRT or a credit card](/billing/).
77
-
78
-
Learn more about [querying subgraphs](/querying/querying-the-graph/).
79
-
80
-
### Updating Subgraphs
81
-
82
-
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.
83
-
84
-
- 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.
85
-
- This signal migration should prompt Indexers to start indexing the new version of the subgraph, so it should soon become available for querying.
86
-
87
-
### Deleting & Transferring Subgraphs
88
-
89
-
If you no longer need a published subgraph, you can [delete](/managing/delete-a-subgraph/) or [transfer](/managing/transfer-a-subgraph/) it. Deleting a subgraph returns any signaled GRT to [Curators](/network/curating/).
30
+
Check out the documentation on [subgraphs](/subgraphs/) to learn specifics.
1.[Create a subgraph](/developing/creating-a-subgraph/)
@@ -34,8 +40,47 @@ To learn more about each subgraph component, check out [creating a subgraph](/de
34
40
4.[Publish a subgraph](/publishing/publishing-a-subgraph/)
35
41
5.[Signal on a subgraph](/publishing/publishing-a-subgraph/#adding-signal-to-your-subgraph)
36
42
37
-
##Subgraph Lifecycle
43
+
### Build locally
38
44
39
-
Here is a general overview of a subgraph’s lifecycle:
45
+
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 on The Graph. They can also use [Graph TypeScript](/developing/graph-ts/) and [Matchstick](/developing/unit-testing-framework/) to create robust subgraphs.
Once defined, a subgraph can be [deployed to Subgraph Studio](/deploying/deploying-a-subgraph-to-studio/). In Subgraph Studio, you can do the following:
50
+
51
+
- Use its staging environment to index the deployed subgraph and make it available for review.
52
+
- Verify that your subgraph doesn't have any indexing errors and works as expected.
53
+
54
+
### Publish to the Network
55
+
56
+
When you're happy with your subgraph, you can [publish it](/publishing/publishing-a-subgraph/) to The Graph Network.
57
+
58
+
- This is an on-chain action, which registers the subgraph and makes it discoverable by Indexers.
59
+
- Published subgraphs have a corresponding NFT, which defines the ownership of the subgraph. You can [transfer the subgraph's ownership](/managing/transfer-a-subgraph/) by sending the NFT.
60
+
- Published subgraphs have associated metadata, which provides other network participants with useful context and information.
61
+
62
+
### Add Curation Signal for Indexing
63
+
64
+
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.
65
+
66
+
#### What is signal?
67
+
68
+
- 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.
69
+
- Third-party Curators may also signal on a given subgraph, if they deem the subgraph likely to drive query volume.
70
+
71
+
### Querying & Application Development
72
+
73
+
Subgraphs on The Graph Network receive 100,000 free queries per month, after which point developers can either [pay for queries with GRT or a credit card](/billing/).
74
+
75
+
Learn more about [querying subgraphs](/querying/querying-the-graph/).
76
+
77
+
### Updating Subgraphs
78
+
79
+
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.
80
+
81
+
- 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.
82
+
- This signal migration should prompt Indexers to start indexing the new version of the subgraph, so it should soon become available for querying.
83
+
84
+
### Deleting & Transferring Subgraphs
85
+
86
+
If you no longer need a published subgraph, you can [delete](/managing/delete-a-subgraph/) or [transfer](/managing/transfer-a-subgraph/) it. Deleting a subgraph returns any signaled GRT to [Curators](/network/curating/).
0 commit comments