The Graph

https://thegraph.com/docs/en/
Admin
The Graph is a blockchain data solution that powers applications, analytics, and AI on 80+ chains...
Tokens:222,157
Snippets:2,241
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Initialize Subgraph from Example

Source: https://thegraph.com/docs/en/subgraphs/developing/creating/install-the-cli

Initializes a new subgraph project using a pre-defined example subgraph. This is useful for quickly starting a new project with a common structure.

```bash
graph init <SUBGRAPH_SLUG> --from-example=example-subgraph
```

--------------------------------

### Setup PostgreSQL Database for Graph Node

Source: https://thegraph.com/docs/en/indexing/overview

Initialize and start a PostgreSQL database server, and create a database named 'graph-node'. Ensure PostgreSQL is installed and accessible.

```bash
1initdb -D .postgres2pg_ctl -D .postgres -l logfile start3createdb graph-node
```

--------------------------------

### Setup PostgreSQL for Graph Node

Source: https://thegraph.com/docs/en/indexing/tooling/graph-node

Initializes a PostgreSQL database and starts the server. This is a required step before running Graph Node.

```bash
1initdb -D .postgres
2pg_ctl -D .postgres -l logfile start
3createdb graph-node
```

--------------------------------

### Install URQL and GraphQL

Source: https://thegraph.com/docs/en/subgraphs/querying/from-an-application

Install the necessary packages for using URQL to interact with GraphQL APIs.

```bash
npm install urql graphql
```

--------------------------------

### Install gnd binary

Source: https://thegraph.com/docs/en/subgraphs/developing/creating/graph-node-dev

Install the gnd binary using the Graph CLI. Ensure the installation directory is added to your system's PATH.

```bash
graph node install
```

--------------------------------

### Start Graph Client DevTool

Source: https://thegraph.com/docs/en/subgraphs/querying/graph-client/README

Run this command to start the local development tool with GraphiQL for experimenting with your GraphQL schema.

```bash
1graphclient serve-dev
```

--------------------------------

### Start Local Graph Node

Source: https://thegraph.com/docs/en/indexing/overview

Start a local Graph Node instance that will connect to your Ethereum endpoint.

```bash
docker-compose up
```

--------------------------------

### Install The Graph CLI with npm

Source: https://thegraph.com/docs/en/deploying/deploying-a-subgraph-to-studio

Use this command to install The Graph CLI globally using npm. Ensure Node.js and npm are installed.

```bash
npm install -g @graphprotocol/graph-cli
```

--------------------------------

### Install Ubuntu Prerequisites for Graph Node

Source: https://thegraph.com/docs/en/indexing/tooling/graph-node

Installs necessary packages on Ubuntu for building Graph Node from source. Ensure Rust, PostgreSQL, and IPFS are installed beforehand.

```bash
1sudo apt-get install -y clang libpq-dev libssl-dev pkg-config
```

--------------------------------

### Install Apollo Client and GraphQL

Source: https://thegraph.com/docs/en/subgraphs/querying/from-an-application

Install the necessary packages for using Apollo Client to interact with GraphQL APIs.

```bash
npm install @apollo/client graphql
```

--------------------------------

### Install libpq-dev on WSL

Source: https://thegraph.com/docs/en/developing/unit-testing-framework

Install the libpq-dev package on Windows Subsystem for Linux to ensure proper PostgreSQL connectivity.

```bash
sudo apt-get install libpq-dev
```

--------------------------------

### Install Indexer Agent and CLI

Source: https://thegraph.com/docs/en/indexing/overview

Install the Indexer agent globally using NPM. The Indexer CLI is a plugin for the Graph CLI, so both need to be installed.

```bash
npm install -g @graphprotocol/indexer-agent
npm install -g @graphprotocol/graph-cli
npm install -g @graphprotocol/indexer-cli
```

--------------------------------

### Install The Graph CLI with Yarn

Source: https://thegraph.com/docs/en/deploying/deploying-a-subgraph-to-studio

Use this command to install The Graph CLI globally using Yarn. Ensure Node.js and Yarn are installed.

```bash
yarn global add @graphprotocol/graph-cli
```

--------------------------------

### Install graph-cli

Source: https://thegraph.com/docs/en/subgraphs/developing/creating/graph-node-dev

Install the graph-cli package using npm. This is a prerequisite for installing gnd.

```bash
npm i @graphprotocol/graph-cli
```

--------------------------------

### Subgraph YAML Example

Source: https://thegraph.com/docs/en/subgraphs/developing/deploying/multiple-networks

Example `subgraph.yaml` configuration specifying a network for a data source.

```yaml
# ...
dataSources:
  - kind: ethereum/contract
    name: Gravity
    network: mainnet
    source:
      address: '0x123...'
      abi: Gravity
    mapping:
      kind: ethereum/events
```

--------------------------------

### Install Rust using curl

Source: https://thegraph.com/docs/en/ai-suite/subgraph-mcp/claude

Install Rust by running this curl command in your terminal. Follow the on-screen instructions for completion.

```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

--------------------------------

### Install @graphprotocol/client-x402

Source: https://thegraph.com/docs/en/subgraphs/guides/x402-payments

Install the official Graph x402 client library using npm. This is required for using x402 payment methods programmatically.

```shell
npm install @graphprotocol/client-x402
```

--------------------------------

### Install PostgreSQL on macOS

Source: https://thegraph.com/docs/en/developing/unit-testing-framework

Use Homebrew to install PostgreSQL. Ensure a symlink to libpq is created for compatibility.

```bash
brew install postgresql
```

```bash
ln -sf /usr/local/opt/postgresql@14/lib/postgresql@14/libpq.5.dylib /usr/local/opt/postgresql/lib/libpq.5.dylib
```

--------------------------------

### Start Indexer Agent

Source: https://thegraph.com/docs/en/indexing/overview

Start the Indexer agent. This command assumes you are in the correct directory and have the necessary configurations.

```bash
graph-indexer-agent start ...
```

--------------------------------

### Install and Authenticate Graph CLI

Source: https://thegraph.com/docs/en/resources/migration-guides/migrate-from-alchemy

Installs the Graph CLI and authenticates it with your access token. Authentication is required for deploying subgraphs.

```bash
npm install -g @graphprotocol/graph-cli
graph auth <YOUR_ACCESS_TOKEN>
```

--------------------------------

### Install Graph Node Dev Mode

Source: https://thegraph.com/docs/en/resources/migration-guides/migrate-from-alchemy

Installs the Graph Node development environment for local testing. Use `gnd --version` to verify the installation.

```bash
graph node install
gnd --version
```

--------------------------------

### gnd PostgreSQL URL Example

Source: https://thegraph.com/docs/en/subgraphs/developing/creating/graph-node-dev

Example of the PostgreSQL connection URL to be used with the --postgres-url flag when running gnd.

```bash
--postgres-url "postgresql://graph:yourpassword@localhost:5432/graph-nod2e"
```

--------------------------------

### Install Prerequisites for Graph Node on Ubuntu

Source: https://thegraph.com/docs/en/indexing/overview

Install necessary packages for running Graph Node on Ubuntu, including clang, libpg-dev, and libssl-dev.

```bash
1sudo apt-get install -y clang libpg-dev libssl-dev pkg-config
```

--------------------------------

### Install Subgrounds

Source: https://thegraph.com/docs/en/subgraphs/querying/python

Install or upgrade the subgrounds library using pip. Ensure you are using Python 3.10 or higher.

```bash
pip install --upgrade subgrounds2
```

```bash
python -m pip install --upgrade subgrounds
```

--------------------------------

### Successful Response Example

Source: https://thegraph.com/docs/en/token-api/monitoring/networks

This is an example of a successful response (200 OK) from the `/v1/networks` endpoint, detailing a specific network's metadata.

```json
{
  "networks": [
    {
      "id": "mainnet",
      "fullName": "Ethereum Mainnet",
      "shortName": "Ethereum",
      "networkType": "mainnet",
      "nativeToken": "ETH",
      "caip2Id": "eip155:1",
      "icon": {
        "web3Icons": {
          "name": "ethereum"
        }
      },
      "aliases": [
        "ethereum",
        "eth",
        "eth-mainnet",
        "evm-1"
      ],
      "indexed_to": [
        {
          "category": "transfers",
          "version": "0.2.2",
          "block_num": 24278225,
          "datetime": "2026-01-20 19:57:11",
          "timestamp": 1768939031
        }
      ]
    }
  ]
}
```

--------------------------------

### Install The Graph Client CLI

Source: https://thegraph.com/docs/en/subgraphs/querying/from-an-application

Install the Graph Client CLI as a development dependency in your project using Yarn or NPM.

```bash
yarn add -D @graphprotocol/client-cli
```

```bash
npm install --save-dev @graphprotocol/client-cli
```

--------------------------------

### Install OpenClaw Skills via ClawHub

Source: https://thegraph.com/docs/en/ai-suite/subgraph-skills

Install subgraph development, optimization, and testing skills via ClawHub for OpenClaw/Clawdbot.

```bash
1clawdbot skill install subgraph-dev2clawdbot skill install subgraph-optimization3clawdbot skill install subgraph-testing
```

--------------------------------

### Example Subgraph Query URL

Source: https://thegraph.com/docs/en/subgraphs/cookbook/transfer-to-the-graph

An example of a query URL for the CryptoPunks Ethereum Subgraph. Replace 'your-own-api-key' with your actual API key.

```bash
https://gateway-arbitrum.network.thegraph.com/api/`**your-own-api-key**`/subgraphs/id/HdVdERFUe8h61vm2fDyycgxjsde5PbB832NHgJfZNqK
```

--------------------------------

### Create Skill Directory and Download SKILL.md

Source: https://thegraph.com/docs/en/ai-suite/token-api-skills

Use these commands to create the necessary directory structure and download the skill definition file for the Token API. This is the initial setup step for using the skill.

```bash
1mkdir -p ~/.claude/skills/token-api2curl -o ~/.claude/skills/token-api/SKILL.md https://token-api.thegraph.com/skills.md
```

--------------------------------

### Install Substreams Skills Plugin for Claude

Source: https://thegraph.com/docs/en/ai-suite/substreams-skills

Install the Substreams Skills plugin from the marketplace for Claude Code. This command adds the plugin repository to your local setup.

```bash
1claude plugin marketplace add https://github.com/streamingfast/substreams-skills
```

--------------------------------

### Once Handler Implementation

Source: https://thegraph.com/docs/en/subgraphs/developing/creating/subgraph-manifest

Example implementation of an initialization handler using the 'once' filter. This function runs once at the start of indexing.

```typescript
export function handleOnce(block: ethereum.Block): void {
  let data = new InitialData(Bytes.fromUTF8('initial'))
  data.data = 'Setup data here'
  data.save()
}
```

--------------------------------

### Configure Cana CLI

Source: https://thegraph.com/docs/en/subgraphs/guides/contract-analyzer

Set up your blockchain environment for analysis by running the setup command. You will be prompted for block explorer API keys and endpoints.

```bash
cana setup
```

--------------------------------

### Local Development Setup for Substreams Skills

Source: https://thegraph.com/docs/en/ai-suite/substreams-skills

Clone the Substreams Skills repository locally and load it directly as a plugin for Claude. This is an alternative to installing from the marketplace.

```bash
1git clone https://github.com/streamingfast/substreams-skills.git
2claude --plugin-dir ./substreams-skills
```

--------------------------------

### Setup and Teardown with beforeEach and afterEach

Source: https://thegraph.com/docs/en/subgraphs/developing/creating/unit-testing-framework

Use `beforeEach` to set up test conditions and `afterEach` to clean up resources after each test. This example demonstrates setting and removing a Gravatar entity.

```typescript
import { describe, test, beforeEach, afterEach } from "matchstick-as/assembly/index"
import { handleUpdatedGravatar, handleNewGravatar } from "../../src/gravity"

beforeEach(() => {
  let gravatar = new Gravatar("0x0")
  gravatar.displayName = “First Gravatar”
  gravatar.save()
})

afterEach(() => {
  store.remove("Gravatar", "0x0")
})

describe("handleNewGravatar", () => {
  // ...
})

describe("handleUpdatedGravatar", () => {
  test("Updates the displayName", () => {
     assert.fieldEquals("Gravatar", "0x0", "displayName", "First Gravatar")

    // code that should update the displayName to 1st Gravatar

    assert.fieldEquals("Gravatar", "0x0", "displayName", "1st Gravatar")
  })

  test("Updates the imageUrl", () => {
    assert.fieldEquals("Gravatar", "0x0", "imageUrl", "")

    // code that should changes the imageUrl to https://www.gravatar.com/avatar/0x0

    assert.fieldEquals("Gravatar", "0x0", "imageUrl", "https://www.gravatar.com/avatar/0x0")
  })
})
```

```typescript
import { describe, test, beforeEach, afterEach } from "matchstick-as/assembly/index"
import { handleUpdatedGravatar, handleNewGravatar } from "../../src/gravity"

describe("handleNewGravatar", () => {
  // ...
})

describe("handleUpdatedGravatar", () => {
  beforeEach(() => {
    let gravatar = new Gravatar("0x0")
    gravatar.displayName = "First Gravatar"
    gravatar.imageUrl = ""
    gravatar.save()
  })

  afterEach(() => {
    store.remove("Gravatar", "0x0")
  })

  test("Updates the displayName", () => {
     assert.fieldEquals("Gravatar", "0x0", "displayName", "First Gravatar")

    // code that should update the displayName to 1st Gravatar

    assert.fieldEquals("Gravatar", "0x0", "displayName", "1st Gravatar")
  })

  test("Updates the imageUrl", () => {
    assert.fieldEquals("Gravatar", "0x0", "imageUrl", "")

    // code that should changes the imageUrl to https://www.gravatar.com/avatar/0x0

    assert.fieldEquals("Gravatar", "0x0", "imageUrl", "https://www.gravatar.com/avatar/0x0")
  })
})
```

--------------------------------

### Start Indexer Agent with Configuration Parameters

Source: https://thegraph.com/docs/en/indexing/overview

Start the Indexer agent with detailed configuration parameters. Runtime configuration can be applied as command-line arguments or environment variables.

```bash
graph-indexer-agent start \
  --ethereum <MAINNET_ETH_ENDPOINT> \
  --ethereum-network mainnet \
  --mnemonic <MNEMONIC> \
  --indexer-address <INDEXER_ADDRESS> \
  --graph-node-query-endpoint http://localhost:8000/ \
  --graph-node-status-endpoint http://localhost:8030/graphql \
  --graph-node-admin-endpoint http://localhost:8020/ \
  --public-indexer-url http://localhost:7600/ \
  --indexer-geo-coordinates <YOUR_COORDINATES> \
  --index-node-ids default \
  --indexer-management-port 18000 \
  --metrics-port 7040 \
  --network-subgraph-endpoint http://query-node-0:8000/subgraphs/id/QmUzRg2HHMpbgf6Q4VHKNDbtBEJnyp5JWCh2gUX9AV6jXv \
  --default-allocation-amount 100 \
  --register true \
  --inject-dai true \
  --postgres-host localhost \
  --postgres-port 5432 \
  --postgres-username <DB_USERNAME> \
  --postgres-password <DB_PASSWORD> \
  --postgres-database indexer \
  --allocation-management auto \
  | pino-pretty
```

--------------------------------

### Get EVM Balances

Source: https://thegraph.com/docs/en/token-api/quick-start

This example shows how to retrieve the balances of a specific Ethereum address using the Token API. Ensure you replace 'YOUR_TOKEN' with your actual API token.

```APIDOC
## Get EVM Balances

### Description
Retrieves the token balances for a given Ethereum address on a specified network.

### Method
GET

### Endpoint
/v1/evm/balances

### Parameters
#### Query Parameters
- **network** (string) - Required - The blockchain network (e.g., 'mainnet').
- **address** (string) - Required - The Ethereum address to query.

### Request Example
```bash
curl --request GET \
    --url "https://token-api.thegraph.com/v1/evm/balances?network=mainnet&address=0x2a0c0dbecc7e4d658f48e01e3fa353f44050c208" \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer YOUR_TOKEN'
```

### Response
#### Success Response (200)
- **data** (object) - Contains the balance information.
  - **network** (string) - The blockchain network.
  - **address** (string) - The queried address.
  - **balances** (array) - An array of token balance objects.
    - **token_address** (string) - The address of the token.
    - **balance** (string) - The balance of the token.
    - **decimals** (integer) - The number of decimals for the token.
    - **symbol** (string) - The symbol of the token.
    - **name** (string) - The name of the token.

#### Response Example
```json
{
  "data": {
    "network": "mainnet",
    "address": "0x2a0c0dbecc7e4d658f48e01e3fa353f44050c208",
    "balances": [
      {
        "token_address": "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
        "balance": "1000000000000000000",
        "decimals": 18,
        "symbol": "ETH",
        "name": "Ether"
      }
    ]
  }
}
```
```

--------------------------------

### Successful Response Example

Source: https://thegraph.com/docs/en/token-api/svm-dexs/dexes

This JSON structure represents a successful response from the GET /v1/svm/dexes endpoint, detailing a specific DEX, its program ID, name, associated AMM, and transaction count.

```json
{
  "data": [
    {
      "program_id": "JUP6LkbZbjS1jKKwapdHNy74zcZ3tLUZoi5QNyVTaV4",
      "program_name": "Jupiter Aggregator v6",
      "amm": "675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8",
      "amm_name": "Raydium Liquidity Pool V4",
      "is_aggregator": true,
      "transactions": 1008573050
    }
  ]
}
```

--------------------------------

### Setup Before All Tests (File Level)

Source: https://thegraph.com/docs/en/developing/unit-testing-framework

Use beforeAll() to execute setup code once before all tests in the file. If placed inside a describe block, it runs before tests in that block.

```typescript
import { describe, test, beforeAll } from "matchstick-as/assembly/index"
import { handleUpdatedGravatar, handleNewGravatar } from "../../src/gravity"
import { Gravatar } from "../../generated/schema"

beforeAll(() => {
  let gravatar = new Gravatar("0x0")
  gravatar.displayName = “First Gravatar”
  gravatar.save()
  ...
})

describe("When the entity does not exist", () => {
  test("it should create a new Gravatar with id 0x1", () => {
    ...
  })
})

describe("When entity already exists", () => {
  test("it should update the Gravatar with id 0x0", () => {
    ...
  })
})
```

--------------------------------

### Get Historical Native Balances (cURL)

Source: https://thegraph.com/docs/en/token-api/evm-tokens-native/balances-historical-native

Example cURL request to fetch historical native balance changes for a specific Ethereum address. Ensure to replace `{token}` with your actual API token.

```curl
curl --request GET \
  --url 'https://token-api.thegraph.com/v1/evm/balances/historical/native?network=mainnet&address=0xd8da6bf26964af9d7eed9e03e53415d37aa96045&interval=1d&limit=10&page=1' \
  --header 'Authorization: Bearer {token}'
```

--------------------------------

### Networks Configuration for Multiple Networks

Source: https://thegraph.com/docs/en/subgraphs/developing/deploying/multiple-networks

Example `networks.json` content for deploying to 'mainnet' and 'sepolia'.

```json
{
  "mainnet": {
    "Gravity": {
      "address": "0x123..."
    }
  },
  "sepolia": {
    "Gravity": {
      "address": "0xabc..."
    }
  }
}
```

--------------------------------

### Access Data Source Context in Mapping

Source: https://thegraph.com/docs/en/subgraphs/developing/creating/subgraph-manifest

Retrieve context data within a template's mapping. This example shows how to get a string value associated with a specific key from the data source context.

```typescript
import { dataSource } from '@graphprotocol/graph-ts'

let context = dataSource.context()
let tradingPair = context.getString('tradingPair')
```

--------------------------------

### PostgreSQL Setup Commands

Source: https://thegraph.com/docs/en/subgraphs/developing/creating/graph-node-dev

Execute these commands within the psql terminal to create a user, database, and necessary extensions for Graph Node.

```sql
create user graph with password 'yourpassword';
create database "graph-node" with owner=graph template=template0 encodi
ng='UTF8' locale='C';
\c graph-node
create extension pg_trgm;
create extension btree_gist;
create extension postgres_fdw;
grant usage on foreign data wrapper postgres_fdw to graph;
```

--------------------------------

### Initialize and Apply Terraform Configuration

Source: https://thegraph.com/docs/en/indexing/overview

Initialize Terraform, view the plan for resource creation, and apply the configuration to create the infrastructure. This process may take up to 30 minutes.

```bash
1# Install required plugins2terraform init34# View plan for resources to be created5terraform plan67# Create the resources (expect it to take up to 30 minutes)8terraform apply
```

--------------------------------

### Verify Graph CLI Installation

Source: https://thegraph.com/docs/en/subgraphs/quick-start

Check the installed version of the Graph CLI to ensure the installation was successful.

```bash
graph --version
```

--------------------------------

### Build and Use Typed SDK with x402

Source: https://thegraph.com/docs/en/subgraphs/guides/x402-payments

Build your typed SDK and execute queries after configuring it for x402. Ensure the X402_PRIVATE_KEY and X402_CHAIN environment variables are set.

```shell
export X402_PRIVATE_KEY=0xabc123...
export X402_CHAIN=base
npx graphclient build
```

```javascript
import { execute, GetPairsDocument } from './.graphclient'

const result = await execute(GetPairsDocument, { first: 5 })
```

--------------------------------

### Verify gnd installation

Source: https://thegraph.com/docs/en/subgraphs/developing/creating/graph-node-dev

Verify the gnd installation by checking its version. This also confirms that the installation directory is in your system's PATH.

```bash
gnd --version
```

--------------------------------

### Initialize a Subgraph

Source: https://thegraph.com/docs/en/subgraphs/quick-start

Start a new subgraph project by initializing it from an existing smart contract. The CLI will prompt for necessary details like protocol, contract address, and ABI.

```bash
graph init
```

--------------------------------

### Indexer Configuration Example

Source: https://thegraph.com/docs/en/indexing/tap

This TOML configuration file sets up essential parameters for an indexer, including network addresses, database connection strings, Graph Node endpoints, and blockchain-specific details for TAP and Horizon.

```toml
1[indexer]2indexer_address = "0x1111111111111111111111111111111111111111"3operator_mnemonic = "your twelve word mnemonic phrase here ..."45# For key rotation, you can specify multiple mnemonics.6# All configured mnemonics are tried when creating attestation signers,7# allowing allocations created with different operator keys to work.8# The first mnemonic is used as the primary identity on the /info endpoint.9# operator_mnemonics = [10#     "previous mnemonic phrase here if you rotated keys"11# ]1213[database]14postgres_url = "postgresql://user:password@localhost:5432/indexer_db"1516[graph_node]17query_url = "http://graph-node:8000"18status_url = "http://graph-node:8000/graphql"1920[subgraphs.network]21# The Graph Network Subgraph (includes escrow data for Horizon)22# Use query_url for hosted service, or deployment_id for local indexing (recommended)23query_url = "https://api.thegraph.com/subgraphs/name/graphprotocol/graph-network-arbitrum"24# deployment_id = "QmUVskWrz1ZiQZ76AtyhcfFDEH1ELnRpoyEhVL8p6NFTbR"2526[blockchain]27chain_id = 4216128receipts_verifier_address_v2 = "0x8f69F5C07477Ac46FBc491B1E6D91E2be0111A9e"29subgraph_service_address = "0xb2Bb92d0DE618878E438b55D5846cfecD9301105"30# Legacy V1 verifier (deprecated in v2.0.0, can be removed from your config):31# receipts_verifier_address = "0x33f9E93266ce0E108fc85DdE2f71dab555A0F05a"3233# For testnet:34# chain_id = 42161435# receipts_verifier_address_v2 = "0x382863e7B662027117449bd2c49285582bbBd21B"36# subgraph_service_address = "0xc24A3dAC5d06d771f657A48B20cE1a671B78f26b"3738[tap]39max_amount_willing_to_lose_grt = "0.1"4041[tap.sender_aggregator_endpoints]42# Mainnet gateways43"0xDDE4cfFd3D9052A9cb618fC05a1Cd02be1f2F467" = "https://tap-aggregator.network.thegraph.com"44"0xDD6a6f76eb36B873C1C184e8b9b9e762FE216490" = "https://tap-aggregator-arbitrum-one.graphops.xyz"4546# For testnet:47# "0xC3dDf37906724732FfD748057FEBe23379b0710D" = "https://tap-aggregator.testnet.thegraph.com"4849[horizon]50enabled = true
```

--------------------------------

### Install Cana CLI Globally

Source: https://thegraph.com/docs/en/subgraphs/guides/contract-analyzer

Install the Cana CLI tool globally using npm. Ensure Node.js v16+ and npm v6+ are installed.

```bash
npm install -g contract-analyzer
```

--------------------------------

### Setup Before All Tests (Describe Block Level)

Source: https://thegraph.com/docs/en/developing/unit-testing-framework

Place beforeAll() inside a describe block to run setup code once before all tests within that specific describe block.

```typescript
import { describe, test, beforeAll } from "matchstick-as/assembly/index"
import { handleUpdatedGravatar, handleNewGravatar } from "../../src/gravity"
import { Gravatar } from "../../generated/schema"

describe("handleUpdatedGravatar()", () => {
  beforeAll(() => {
    let gravatar = new Gravatar("0x0")
    gravatar.displayName = “First Gravatar”
    gravatar.save()
    ...
  })

  test("updates Gravatar with id 0x0", () => {
    ...
  })

  test("creates new Gravatar with id 0x1", () => {
    ...
  })
})
```
Tokens:
Raw