Deploying an Indexer (Subgraph) on zkLink with The Graph
Step-by-step guide on deploying a subgraph on zkLink using using The Graph for optimized blockchain data indexing.
Deploying a subgraph on zkLink Nova using Mobula’s infrastructure is a straightforward process. This guide will walk you through the steps to get your subgraph up and running on the zkLink network.
What you’ll need
- Basic knowledge of The Graph and subgraphs
- Your subgraph project files
- The Graph CLI installed
- A Mobula API key (for authentication)
Walkthrough
Prepare Your Subgraph
Ensure your subgraph is configured for zkLink Nova. Update your subgraph.yaml file to reference zkLink-specific contracts and events. If you don’t have any subgraph, you can clone the Uniswap V2 (Linkswap) subgraph template and modify it for zkLink:
Install Dependencies
Make sure you have The Graph CLI installed
Build Your Subgraph
Compile your subgraph before deployment
Create the Subgraph
Use the following command to deploy your subgraph
Deploy to Mobula's zkLink Node
Use the following command to deploy your subgraph
Authenticate
When prompted, provide your Mobula API key for authentication. Refer to the authentication section for more details on obtaining and using your API key.
Monitor Deployment
After deployment, you’ll receive a URL to monitor your subgraph’s indexing progress and status.
Best Practices
- Regularly update your subgraph to ensure compatibility with the latest zkLink Nova network changes.
- Test your subgraph thoroughly on a testnet before deploying to mainnet.
- Monitor your subgraph’s performance and optimize queries for efficiency.
Troubleshooting
If you encounter issues during deployment:
- Double-check your
subgraph.yamlconfiguration. - Ensure you’re using the correct network name and Mobula node URLs.
- Verify your API key is valid and has the necessary permissions.
Need Assistance? Our support team is ready to help you with any questions or deployment challenges.