@graphprotocol/subgraph-service v0.3.5

🌅 Subgraph Service 🌅

The Subgraph Service is a data service designed to work with Graph Horizon that supports indexing subgraphs and serving queries to consumers.

Configuration

The following environment variables might be required:

You can set them using Hardhat:

npx hardhat vars set <variable>

Build

pnpm install
pnpm build

Deployment

Note that this instructions will help you deploy Graph Horizon contracts alongside the Subgraph Service. If you want to deploy just the core Horizon contracts please refer to the Horizon README for deploy instructions.

New deployment

To deploy Graph Horizon from scratch including the Subgraph Service run the following command:

npx hardhat deploy:protocol --network hardhat

Upgrade deployment

Usually you would run this against a network (or a fork) where the original Graph Protocol was previously deployed. To upgrade an existing deployment of the original Graph Protocol to Graph Horizon including the Subgraph Service, run the following commands. Note that some steps might need to be run by different accounts (deployer vs governor):

cd ../
cd horizon && npx hardhat deploy:migrate --network hardhat --step 1 && cd ..
cd subgraph-service && npx hardhat deploy:migrate --network hardhat --step 1 && cd ..
cd horizon && npx hardhat deploy:migrate --network hardhat --step 2 && cd .. # Run with governor. Optionally add --patch-config
cd horizon && npx hardhat deploy:migrate --network hardhat --step 3 && cd .. # Optionally add --patch-config
cd subgraph-service && npx hardhat deploy:migrate --network hardhat --step 2 && cd .. # Optionally add --patch-config
cd horizon && npx hardhat deploy:migrate --network hardhat --step 4 && cd .. # Run with governor. Optionally add --patch-config

Horizon Steps 2, 3 and 4, and Subgraph Service Step 2 require patching the configuration file with addresses from previous steps. The files are located in the ignition/configs directory and need to be manually edited. You can also pass --patch-config flag to the deploy command to automatically patch the configuration reading values from the address book. Note that this will NOT update the configuration file.

Testing

• unit: Unit tests can be run with pnpm test
• integration: Integration tests can be run with pnpm test:integration - Need to set BLOCKCHAIN_RPC for a chain where The Graph is already deployed - If no BLOCKCHAIN_RPC is detected it will try using ARBITRUM_SEPOLIA_RPC
• deployment: Deployment tests can be run with pnpm test:deployment --network <network>, the following environment variables allow customizing the test suite for different scenarios:
  • TEST_DEPLOYMENT_STEP (default: 1) - Specify the latest deployment step that has been executed. Tests for later steps will be skipped.
  • TEST_DEPLOYMENT_TYPE (default: migrate) - The deployment type protocol/migrate that is being tested. Test suite has been developed for migrate use case but can be run against a protocol deployment, likely with some failed tests.
  • TEST_DEPLOYMENT_CONFIG (default: hre.network.name) - The Ignition config file name to use for the test suite.

Verification

To verify contracts on a network, run the following commands:

./scripts/pre-verify <ignition-deployment-id>
npx hardhat ignition verify --network <network> --include-unrelated-contracts <ignition-deployment-id>
./scripts/post-verify