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/developing/developer-faqs.mdx
+71-57Lines changed: 71 additions & 57 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,66 +2,93 @@
2
2
title: Developer FAQs
3
3
---
4
4
5
-
## 1. What is a subgraph?
5
+
This page summarizes some of the common questions for developers building on The Graph.
6
6
7
-
A subgraph is a custom API built on blockchain data. Subgraphs are queried using the GraphQL query language and are deployed to a Graph Node using the Graph CLI. Once deployed and published to The Graph's decentralized network, Indexers process subgraphs and make them available to be queried by subgraph consumers.
7
+
## Subgraph Related
8
8
9
-
##2. Can I delete my subgraph?
9
+
### 1. What is a subgraph?
10
10
11
-
It is not possible to delete subgraphs once they are created.
11
+
A subgraph is a custom API built on blockchain data. Subgraphs are queried using the GraphQL query language and are deployed to a Graph Node using The Graph CLI. Once deployed and published to The Graph's decentralized network, Indexers process subgraphs and make them available for subgraph consumers to query them.
12
12
13
-
##3. Can I change my subgraph name?
13
+
### 2. What is the first step to create a subgraph?
14
14
15
-
No. Once a subgraph is created, the name cannot be changed. Make sure to think of this carefully before you create your subgraph so it is easily searchable and identifiable by other dapps.
15
+
To successfully create a subgraph and publish it on the decentralized network, you will need to install The Graph CLI. Review our [Creating a Subgraph](/developing/creating-a-subgraph/) page for detailed instructions.
16
16
17
-
##4. Am I still able to create a subgraph if my smart contracts don't have events?
17
+
### 3. Can I still create a subgraph if my smart contracts don't have events?
18
18
19
19
It is highly recommended that you structure your smart contracts to have events associated with data you are interested in querying. Event handlers in the subgraph are triggered by contract events and are by far the fastest way to retrieve useful data.
20
20
21
-
If the contracts you are working with do not contain events, your subgraph can use call and block handlers to trigger indexing, but this is not recommended as performance will be significantly slower.
21
+
If the contracts you work with do not contain events, your subgraph can use call and block handlers to trigger indexing. However, this is not recommended, as performance will be significantly slower.
22
22
23
-
##5. How are templates different from data sources?
23
+
### 4. Can I change the GitHub account associated with my subgraph?
24
24
25
-
Templates allow you to create data sources on the fly, while your subgraph is indexing. It might be the case that your contract will spawn new contracts as people interact with it, and since you know the shape of those contracts (ABI, events, etc) upfront you can define how you want to index them in a template and when they are spawned your subgraph will create a dynamic data source by supplying the contract address.
25
+
No. Once a subgraph is created, the associated GitHub account cannot be changed. Please make sure to carefully consider this before creating your subgraph.
26
26
27
-
Check out the "Instantiating a data source template" section on: [Data Source Templates](/developing/creating-a-subgraph#data-source-templates).
28
-
29
-
## 6. How do I make sure I'm using the latest version of graph-node for my local deployments?
27
+
### 5. How do I update a subgraph on mainnet?
30
28
31
-
You can run the following command:
29
+
You can deploy a new version of your subgraph to Subgraph Studio using the CLI. This action maintains your subgraph private, but once you’re happy with it, you can publish to Graph Explorer. This will create a new version of your subgraph that Curators can start signaling on.
32
30
33
-
```sh
34
-
docker pull graphprotocol/graph-node:latest
35
-
```
31
+
### 6. When listening to multiple contracts, is it possible to select the contract order to listen to events?
36
32
37
-
>Note: docker / docker-compose will always use whatever graph-node version was pulled the first time you ran it, so it is important to do this to make sure you are up to date with the latest version of graph-node.
33
+
Within a subgraph, the events are always processed in the order they appear in the blocks, regardless of whether that is across multiple contracts or not.
38
34
39
-
## 7. How do I call a contract function or access a public state variable from my subgraph mappings?
35
+
###7. How do I call a contract function or access a public state variable from my subgraph mappings?
40
36
41
37
Take a look at `Access to smart contract` state inside the section [AssemblyScript API](/developing/graph-ts/api/#access-to-smart-contract-state).
42
38
43
-
## 8. Is it possible to set up a subgraph using `graph init` from `graph-cli` with two contracts? Or should I manually add another datasource in `subgraph.yaml` after running `graph init`?
39
+
### 8. Can I import ethers.js or other JS libraries into my subgraph mappings?
40
+
41
+
Not currently, as mappings are written in AssemblyScript.
42
+
43
+
One possible alternative solution to this is to store raw data in entities and perform logic that requires JS libraries on the client.
44
+
45
+
### 9. Is it possible to duplicate a subgraph to another account or endpoint without redeploying?
46
+
47
+
You have to redeploy the subgraph, but if the subgraph ID (IPFS hash) doesn't change, it won't have to sync from the beginning.
48
+
49
+
### 10. How are templates different from data sources?
50
+
51
+
Templates allow you to create data sources on the quickly, while your subgraph is indexing. Your contract might spawn new contracts as people interact with it. Since you know the shape of those contracts (ABI, events, etc.) upfront, you can define how you want to index them in a template. When they are spawned, your subgraph will create a dynamic data source by supplying the contract address.
52
+
53
+
Check out the "Instantiating a data source template" section on: [Data Source Templates](/developing/creating-a-subgraph#data-source-templates).
54
+
55
+
### 11. Is it possible to set up a subgraph using `graph init` from `graph-cli` with two contracts? Or should I manually add another datasource in `subgraph.yaml` after running `graph init`?
44
56
45
57
Yes. On `graph init` command itself you can add multiple datasources by entering contracts one after the other.
46
58
47
59
You can also use `graph add` command to add new datasource.
48
60
49
-
##9. I want to contribute or add a GitHub issue. Where can I find the open source repositories?
61
+
### 12. In what order are the event, block, and call handlers triggered for a data source?
Event and call handlers are first ordered by transaction index within the block. Event and call handlers within the same transaction are ordered using a convention: event handlers first then call handlers, each type respecting the order they are defined in the manifest. Block handlers are run after event and call handlers, in the order they are defined in the manifest. Also these ordering rules are subject to change.
64
+
65
+
When new dynamic data source are created, the handlers defined for dynamic data sources will only start processing after all existing data source handlers are processed, and will repeat in the same sequence whenever triggered.
55
66
56
-
## 10. What is the recommended way to build "autogenerated" ids for an entity when handling events?
67
+
### 13. How do I make sure I'm using the latest version of graph-node for my local deployments?
68
+
69
+
You can run the following command:
70
+
71
+
```sh
72
+
docker pull graphprotocol/graph-node:latest
73
+
```
74
+
75
+
> Note: docker / docker-compose will always use whatever graph-node version was pulled the first time you ran it, so it is important to do this to make sure you are up to date with the latest version of graph-node.
76
+
77
+
### 14. What is the recommended way to build "autogenerated" ids for an entity when handling events?
57
78
58
79
If only one entity is created during the event and if there's nothing better available, then the transaction hash + log index would be unique. You can obfuscate these by converting that to Bytes and then piping it through `crypto.keccak256` but this won't make it more unique.
59
80
60
-
##11. When listening to multiple contracts, is it possible to select the contract order to listen to events?
81
+
### 15. Can I delete my subgraph?
61
82
62
-
Within a subgraph, the events are always processed in the order they appear in the blocks, regardless of whether that is across multiple contracts or not.
83
+
It is not possible to delete subgraphs once they are created. However, you can [transfer and deprecate your subgraph](/managing/transfer-and-deprecate-a-subgraph/)
84
+
85
+
## Network Related
63
86
64
-
## 12. Is it possible to differentiate between networks (mainnet, Sepolia, local) from within event handlers?
87
+
### 16. What networks are supported by The Graph?
88
+
89
+
You can find the list of the supported networks [here](/developing/supported-networks).
90
+
91
+
### 17. Is it possible to differentiate between networks (mainnet, Sepolia, local) from within event handlers?
65
92
66
93
Yes. You can do this by importing `graph-ts` as per the example below:
67
94
@@ -72,62 +99,49 @@ dataSource.network()
72
99
dataSource.address()
73
100
```
74
101
75
-
##13. Do you support block and call handlers on Sepolia?
102
+
### 18. Do you support block and call handlers on Sepolia?
76
103
77
104
Yes. Sepolia supports block handlers, call handlers and event handlers. It should be noted that event handlers are far more performant than the other two handlers, and they are supported on every EVM-compatible network.
78
105
79
-
## 14. Can I import ethers.js or other JS libraries into my subgraph mappings?
80
-
81
-
Not currently, as mappings are written in AssemblyScript.
106
+
## Indexing & Querying Related
82
107
83
-
One possible alternative solution to this is to store raw data in entities and perform logic that requires JS libraries on the client.
84
-
85
-
## 15. Is it possible to specify what block to start indexing on?
108
+
### 19. Is it possible to specify what block to start indexing on?
86
109
87
110
Yes. `dataSources.source.startBlock` in the `subgraph.yaml` file specifies the number of the block that the data source starts indexing from. In most cases, we suggest using the block in which the contract was created: [Start blocks](/developing/creating-a-subgraph#start-blocks)
88
111
89
-
##16. Are there some tips to increase the performance of indexing? My subgraph is taking a very long time to sync
112
+
### 20. Are there some tips to increase the performance of indexing? My subgraph is taking a very long time to sync
90
113
91
114
Yes, you should take a look at the optional start block feature to start indexing from the block that the contract was deployed: [Start blocks](/developing/creating-a-subgraph#start-blocks)
92
115
93
-
##17. Is there a way to query the subgraph directly to determine the latest block number it has indexed?
116
+
### 21. Is there a way to query the subgraph directly to determine the latest block number it has indexed?
94
117
95
118
Yes! Try the following command, substituting "organization/subgraphName" with the organization under it is published and the name of your subgraph:
96
119
97
120
```sh
98
121
curl -X POST -d '{ "query": "{indexingStatusForCurrentVersion(subgraphName: \"organization/subgraphName\") { chains { latestBlock { hash number }}}}"}' https://api.thegraph.com/index-node/graphql
99
122
```
100
123
101
-
## 18. What networks are supported by The Graph?
102
-
103
-
You can find the list of the supported networks [here](/developing/supported-networks).
104
-
105
-
## 19. Is it possible to duplicate a subgraph to another account or endpoint without redeploying?
106
-
107
-
You have to redeploy the subgraph, but if the subgraph ID (IPFS hash) doesn't change, it won't have to sync from the beginning.
108
-
109
-
## 20. Is this possible to use Apollo Federation on top of graph-node?
110
-
111
-
Federation is not supported yet, although we do want to support it in the future. At the moment, something you can do is use schema stitching, either on the client or via a proxy service.
112
-
113
-
## 21. Is there a limit to how many objects The Graph can return per query?
124
+
### 22. Is there a limit to how many objects The Graph can return per query?
114
125
115
126
By default, query responses are limited to 100 items per collection. If you want to receive more, you can go up to 1000 items per collection and beyond that, you can paginate with:
##22. If my dapp frontend uses The Graph for querying, do I need to write my query key into the frontend directly? What if we pay query fees for users – will malicious users cause our query fees to be very high?
132
+
### 23. If my dapp frontend uses The Graph for querying, do I need to write my query key into the frontend directly? What if we pay query fees for users – will malicious users cause our query fees to be very high?
122
133
123
134
Currently, the recommended approach for a dapp is to add the key to the frontend and expose it to end users. That said, you can limit that key to a hostname, like _yourdapp.io_ and subgraph. The gateway is currently being run by Edge & Node. Part of the responsibility of a gateway is to monitor for abusive behavior and block traffic from malicious clients.
124
135
125
-
## 23. How do I update a subgraph on mainnet?
136
+
Miscellaneous
126
137
127
-
You can deploy a new version of your subgraph to Subgraph Studio using the CLI. It’ll be private at that point, but if you’re happy with it, you can publish to Graph Explorer. This will create a new version of your subgraph that Curators can start signaling on.
138
+
### 24. Is this possible to use Apollo Federation on top of graph-node?
128
139
129
-
## 24. In what order are the event, block, and call handlers triggered for a data source?
140
+
Federation is not supported yet, although we do want to support it in the future. At the moment, something you can do is use schema stitching, either on the client or via a proxy service.
130
141
131
-
Event and call handlers are first ordered by transaction index within the block. Event and call handlers within the same transaction are ordered using a convention: event handlers first then call handlers, each type respecting the order they are defined in the manifest. Block handlers are run after event and call handlers, in the order they are defined in the manifest. Also these ordering rules are subject to change.
142
+
### 25. I want to contribute or add a GitHub issue. Where can I find the open source repositories?
132
143
133
-
When new dynamic data source are created, the handlers defined for dynamic data sources will only start processing after all existing data source handlers are processed, and will repeat in the same sequence whenever triggered.
0 commit comments