🚀 Nexus Protocol Subgraphs

Subgraphs for indexing Nexus Protocol smart contracts using The Graph. Useful for querying on-chain data with GraphQL.

---

🧠 TL;DR

• Subgraphs index blockchain data so you can query it via GraphQL.
• Edit the config file with contract addresses + start blocks.
• Authenticate with your deploy key from The Graph Studio.
• Deploy using the scripts in package.json.

---

🌍 Active Deployments

Test Networks

V2

• Ethereum Sepolia
• Base Sepolia
• BSC Chapel

V3

• Ethereum Sepolia
• Base Sepolia
• BSC Chapel

Mainnet

• Ethereum Mainnet

---

⚙️ Getting Started

1. Install dependencies

yarn install

🔧 Configuring a Deployment

2. Set up your config file

Find the file for your target network under /config. Example: /config/sepolia-v3.json

Fill it out with the correct data:

{
  "network": "sepolia",
  "AaveOracleAddress": "0xB7c437D99bD1EEd8E8D0eC4fE865b70EfBFAc1f3",
  "AaveOracleStartBlock": 8320405,
  "PoolAddressesProviderRegistryAddress": "0xdBDa92ca3C9B618dE766c3E68Ff8e12a54347bcD",
  "PoolAddressesProviderRegistryStartBlock": 8320373,
  "RewardsControllerAddress": "",
  "RewardsControllerStartBlock": 8320373
}

💡 Tip: You can find block numbers using Etherscan or your preferred block explorer

3. Authenticate with The Graph Studio

Get your deploy key from The Graph Studio and run:

npx graph auth <your-deploy-key>

🚀 Deploying a Subgraph

You can now deploy using the available scripts:

Examples:

# Deploy V2 on Sepolia
yarn subgraph:deploy:sepolia

# Deploy V3 on Sepolia
yarn deploy:sepolia:v3

⚠️ Important: Make sure the slug you use matches exactly the "Display Name" in The Graph Studio.

Manual deployment example:

VERSION=v3 BLOCKCHAIN=v3 NETWORK=mainnet env-cmd npm run prepare:subgraph && SLUG=nexus-mm-mainnet env-cmd npm run subgraph:deploy

During deployment, you'll be asked to enter a version name. If you're unsure what to enter, just check existing versions in Studio and follow the naming pattern.