Install the Graph CLI

Overview

The Graph CLI⁠ is a command-line interface that facilitates developers’ commands for The Graph. It processes a Subgraph manifest and compiles the mappings to create the files you will need to deploy the Subgraph to Subgraph Studio and the network.

Getting Started

Install the Graph CLI

The Graph CLI is written in TypeScript, and you must have node and either npm or yarn installed to use it. Check for the most recent⁠ CLI version.

On your local machine, run one of the following commands:

Using npm⁠

1npm install -g @graphprotocol/graph-cli@latest

Using yarn⁠

1yarn global add @graphprotocol/graph-cli

The graph init command can be used to set up a new Subgraph project, either from an existing contract or from an example Subgraph. If you already have a smart contract deployed to your preferred network, you can bootstrap a new Subgraph from that contract to get started.

Create a Subgraph

From an Existing Contract

The following command creates a Subgraph that indexes all events of an existing contract:

1graph init \2  --product subgraph-studio3  --from-contract <CONTRACT_ADDRESS> \4  [--network <ETHEREUM_NETWORK>] \5  [--abi <FILE>] \6  <SUBGRAPH_SLUG> [<DIRECTORY>]

• The command tries to retrieve the contract ABI from Etherscan.

  • The Graph CLI relies on a public RPC endpoint. While occasional failures are expected, retries typically resolve this issue. If failures persist, consider using a local ABI.

• If any of the optional arguments are missing, it guides you through an interactive form.

• The <SUBGRAPH_SLUG> is the ID of your Subgraph in Subgraph Studio. It can be found on your Subgraph details page.

From an Example Subgraph

The following command initializes a new project from an example Subgraph:

1graph init <SUBGRAPH_SLUG> --from-example=example-subgraph

• The example Subgraph⁠ is based on the Gravity contract by Dani Grant, which manages user avatars and emits NewGravatar or UpdateGravatar events whenever avatars are created or updated.

• The Subgraph handles these events by writing Gravatar entities to the Graph Node store and ensuring these are updated according to the events.

Add New dataSources to an Existing Subgraph

dataSources are key components of Subgraphs. They define the sources of data that the Subgraph indexes and processes. A dataSource specifies which smart contract to listen to, which events to process, and how to handle them.

Recent versions of the Graph CLI supports adding new dataSources to an existing Subgraph through the graph add command:

1graph add <address> [<subgraph-manifest default: "./subgraph.yaml">]23Options:45      --abi <path>              Path to the contract ABI (default: download from Etherscan)6      --contract-name           Name of the contract (default: Contract)7      --merge-entities          Whether to merge entities with the same name (default: false)8      --network-file <path>     Networks config file path (default: "./networks.json")

Specifics

The graph add command will fetch the ABI from Etherscan (unless an ABI path is specified with the --abi option) and creates a new dataSource, similar to how the graph init command creates a dataSource --from-contract, updating the schema and mappings accordingly. This allows you to index implementation contracts from their proxy contracts.

• The --merge-entities option identifies how the developer would like to handle entity and event name conflicts:

  • If true: the new dataSource should use existing eventHandlers & entities.

  • If false: a new entity & event handler should be created with ${dataSourceName}{EventName}.

• The contract address will be written to the networks.json for the relevant network.

Getting The ABIs

The ABI file(s) must match your contract(s). There are a few ways to obtain ABI files:

• If you are building your own project, you will likely have access to your most current ABIs.
• If you are building a Subgraph for a public project, you can download that project to your computer and get the ABI by using npx hardhat compile⁠ or using solc to compile.
• You can also find the ABI on Etherscan⁠, but this isn’t always reliable, as the ABI that is uploaded there may be out of date. Make sure you have the right ABI, otherwise running your Subgraph will fail.