Developing

Developer FAQs

1. What is a subgraph?Link to this section

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.

2. Can I delete my subgraph?Link to this section

It is not possible to delete subgraphs once they are created.

3. Can I change my subgraph name?Link to this section

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.

4. Can I change the GitHub account associated with my subgraph?Link to this section

No. Once a subgraph is created, the associated GitHub account cannot be changed. Make sure to think of this carefully before you create your subgraph.

5. Am I still able to create a subgraph if my smart contracts don't have events?Link to this section

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.

If the contracts you are working with do not contain events, your subgraph can use call and block handlers to trigger indexing. Although this is not recommended, as performance will be significantly slower.

6. Is it possible to deploy one subgraph with the same name for multiple networks?Link to this section

You will need separate names for multiple networks. While you can't have different subgraphs under the same name, there are convenient ways of having a single codebase for multiple networks. Find more on this in our documentation: Redeploying a Subgraph

7. How are templates different from data sources?Link to this section

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.

Check out the "Instantiating a data source template" section on: Data Source Templates.

8. How do I make sure I'm using the latest version of graph-node for my local deployments?Link to this section

You can run the following command:

docker pull graphprotocol/graph-node:latest

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.

9. How do I call a contract function or access a public state variable from my subgraph mappings?Link to this section

Take a look at Access to smart contract state inside the section AssemblyScript API.

10. 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?Link to this section

Unfortunately, this is currently not possible. graph init is intended as a basic starting point, from which you can then add more data sources manually.

11. I want to contribute or add a GitHub issue. Where can I find the open source repositories?Link to this section

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.

13. When listening to multiple contracts, is it possible to select the contract order to listen to events?Link to this section

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.

14. Is it possible to differentiate between networks (mainnet, Goerli, local) from within event handlers?Link to this section

Yes. You can do this by importing graph-ts as per the example below:

import { dataSource } from '@graphprotocol/graph-ts'
dataSource.network()
dataSource.address()

15. Do you support block and call handlers on Goerli?Link to this section

Yes. Goerli 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 network.

16. Can I import ethers.js or other JS libraries into my subgraph mappings?Link to this section

Not currently, as mappings are written in AssemblyScript. One possible alternative solution to this is to store raw data in entities and perform logic that requires JS libraries on the client.

17. Is it possible to specify what block to start indexing on?Link to this section

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

18. Are there some tips to increase the performance of indexing? My subgraph is taking a very long time to sync.Link to this section

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

19. Is there a way to query the subgraph directly to determine the latest block number it has indexed?Link to this section

Yes! Try the following command, substituting "organization/subgraphName" with the organization under it is published and the name of your subgraph:

curl -X POST -d '{ "query": "{indexingStatusForCurrentVersion(subgraphName: \"organization/subgraphName\") { chains { latestBlock { hash number }}}}"}' https://api.thegraph.com/index-node/graphql

20. What networks are supported by The Graph?Link to this section

You can find the list of the supported networks here.

21. Is it possible to duplicate a subgraph to another account or endpoint without redeploying?Link to this section

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.

22. Is this possible to use Apollo Federation on top of graph-node?Link to this section

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.

23. Is there a limit to how many objects The Graph can return per query?Link to this section

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:

someCollection(first: 1000, skip: <number>) { ... }

24. 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?Link to this section

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.

25. Where do I go to find my current subgraph on the Hosted Service?Link to this section

Head over to the Hosted Service in order to find subgraphs that you or others deployed to the Hosted Service. You can find it here.

26. Will the Hosted Service start charging query fees?Link to this section

The Graph will never charge for the Hosted Service. The Graph is a decentralized protocol, and charging for a centralized service is not aligned with The Graph’s values. The Hosted Service was always a temporary step to help get to the decentralized network. Developers will have a sufficient amount of time to migrate to the decentralized network as they are comfortable.

27. When will the Hosted Service be shut down?Link to this section

The Hosted Service will shut down in Q1 2023. Read the announcement blog post here. All dapps using the Hosted Service are encouraged to migrate to the decentralized network. Migration Grants are available for developers to help migrate their subgraph. If your dapp is migrating a subgraph you can apply here.

28. How do I upgrade a subgraph on mainnet?Link to this section

If you’re a subgraph developer, you can upgrade a new version of your subgraph to the Studio using the CLI. It’ll be private at that point, but if you’re happy with it, you can publish to the decentralized Graph Explorer. This will create a new version of your subgraph that Curators can start signaling on.

Edit page

Previous
Unit Testing Framework
Next
How to Use the Subgraph Studio