The Graph

Getting historical data on smart contracts can be frustrating when building a dapp. The Graph offers a powerful way to query smart contract data with open APIs known as subgraphs. Anyone can create or query subgraphs, making the data available to the entire ecosystem. The Graph is powered by hundreds of independent Indexers, enabling your dapp to become truly decentralized.

Developers can use 100,000 free queries per month by using The Graph Network.

Quickstart

Subgraphs index emitted events by default, but additional functionality can be added later. A subgraph can be created in just a few minutes by following these steps:

1. Initialize your subgraph
2. Publish your subgraph to The Graph Network
3. Query from your dapp with your unique API key

Here is a step-by-step walkthrough:

1. Initialize your subgraph

Create a subgraph in subgraph studio

Go to the Subgraph Studio and connect your wallet. Once your wallet is connected, you can begin by clicking "Create a Subgraph". When choosing a name, it's recommended to use Title Case, including the subgraph and chain name, e.g., "MyDapp Subgraph Linea".

Then, you will land on your subgraph's page. All the CLI commands you need will be visible on the right side of the page:

Install the Graph CLI⁠

On your local machine, run the following:

npm install -g @graphprotocol/graph-cli

Initialize your subgraph⁠

You can copy this directly from your subgraph page to include your specific subgraph slug:

graph init <SUBGRAPH_SLUG>

You'll be prompted to provide some info on your subgraph like this:

user@my-MacBook-Pro GRT-Subgraph % graph init
› Warning: In next major version, this flag will be removed. By default we will deploy to the Graph Studio.
› Learn more about Sunrise of Decentralized Data
› https://thegraph.com/blog/unveiling-updated-sunrise-decentralized-data/
› Warning: In next major version, this flag will be removed. By default we will stop initializing a Git repository.
✔ Protocol · ethereum
✔ Product for which to initialize · subgraph-studio
✔ Subgraph slug · GRT
✔ Directory to create the subgraph in · GRT
? Ethereum network …
? Ethereum network …
? Ethereum network …
✔ Ethereum network · arbitrum-one
✔ Contract address · 0x9623063377AD1B27544C965cCd7342f7EA7e88C7
✔ Fetching ABI from Etherscan
✖ Failed to fetch Start Block: Failed to fetch contract creation transaction hash
✔ Do you want to retry? (Y/n) · false
✖ Failed to fetch Contract Name: Failed to fetch contract source code
✔ Do you want to retry? (Y/n) · false
✔ Start Block · 42449274
✔ Contract Name · GRT
✔ Index contract events as entities (Y/n) · true
Generate subgraph
Write subgraph to directory
✔ Create subgraph scaffold
✔ Initialize networks config
✔ Initialize subgraph repository
✔ Install dependencies with yarn
✔ Generate ABI and schema types with yarn codegen
Add another contract? (y/n):
Subgraph GRT created in GRT

Next steps:

1. Run `graph auth` to authenticate with your deploy key.

2. Type `cd GRT` to enter the subgraph.

3. Run `yarn deploy` to deploy the subgraph.

Make sure to visit the documentation on https://thegraph.com/docs/ for further information.

user@my-MacBook-Pro GRT-Subgraph % cd GRT

Simply verify your contract on the block explorer, and the CLI will automatically obtain the ABI and set up your subgraph. The default settings will generate an entity for each event.

2. Deploy and publish

Deploy to Subgraph Studio

First, run these commands:

$ graph codegen
$ graph build

Then, run these to authenticate and deploy your subgraph. You can copy these commands directly from your subgraph's page in Studio to include your specific deploy key and subgraph slug:

$ graph auth <DEPLOY_KEY>
$ graph deploy <SUBGRAPH_SLUG>

You will be asked for a version label. You can enter something like v0.0.1, but you're free to choose the format.

Test your subgraph

You can test your subgraph by making a sample query in the playground section. The Details tab will show you an API endpoint. You can use that endpoint to test from your dapp.

Publish your subgraph to The Graph's decentralized network

Once your subgraph is ready to be put into production, you can publish it to the decentralized network. On your subgraph's page in Subgraph Studio, click on the Publish button:

Before you can query your subgraph, Indexers need to begin serving queries on it. In order to streamline this process, you can curate your own subgraph using GRT.

When publishing, you'll see the option to curate your subgraph. As of May 2024, it is recommended that you curate your own subgraph with at least 3,000 GRT to ensure that it is indexed and available for querying as soon as possible.

Note: The Graph's smart contracts are all on Arbitrum One, even though your subgraph is indexing data from Ethereum, BSC or any other supported chain.

3. Query your subgraph

Congratulations! You can now query your subgraph on the decentralized network!

To query any subgraph on the decentralized network, pass a GraphQL query into the subgraph's query URL, which can be found at the top of its Explorer page.

Here's an example from the CryptoPunks Ethereum subgraph by Messari:

The query URL for this subgraph is:

https://gateway-arbitrum.network.thegraph.com/api/[api-key]/subgraphs/id/HdVdERFUe8h61vm2fDyycgxjsde5PbB832NHgJfZNqK

Now, you simply need to fill in your own API Key to start sending GraphQL queries to this endpoint.

Get your own API key

In Subgraph Studio, you'll see the "API Keys" menu at the top of the page. Here, you can create API Keys.

Appendix

Sample query

This query shows the most expensive CryptoPunks sold.

{
  trades(orderBy: priceETH, orderDirection: desc) {
    priceETH
    tokenId
  }
}

Passing this into the query URL returns this result:

{
  "data": {
    "trades": [
      {
        "priceETH": "124457.067524886018255505",
        "tokenId": "9998"
      },
      {
        "priceETH": "8000",
        "tokenId": "5822"
      },
//      ...

Sample code

const axios = require("axios");

const graphqlQuery = `{
  trades(orderBy: priceETH, orderDirection: desc) {
    priceETH
    tokenId
  }
}`;
const queryUrl =
  "https://gateway-arbitrum.network.thegraph.com/api/[api-key]/subgraphs/id/HdVdERFUe8h61vm2fDyycHgxjsde5PbB832NHgJfZNqK";

const graphQLRequest = {
  method: "post",
  url: queryUrl,
  data: {
    query: graphqlQuery,
  },
};

// Send the GraphQL query
axios(graphQLRequest)
  .then((response) => {
    // Handle the response here
    const data = response.data.data;
    console.log(data);
  })
  .catch((error) => {
    // Handle any errors
    console.error(error);
  });

Additional resources

• To explore all the ways you can optimize and customize your subgraph for better performance, read more about creating a subgraph here.
• To learn more about querying data from your subgraph.
• Subgraph Studio.