4 min read
Overview
In the fast-paced yet often unpredictable world of Web3 engineering, teams consistently face considerable challenges when running hosted subgraphs, such as downtime, data lag, sluggish reindexes, slow queries, and the lack of direct support.
Enter Zeeve, an enterprise-grade indexing tool for The Graph protocol, allowing for an easy, predictable and smooth experience for indexing and querying subgraphs. In this guide, we'll cover how to add the Zeeve add-on to your QuickNode endpoint and then show you how to create and deploy a subgraph using Zeeve. Let's get started!
What You Will Do
- Learn about Zeeve
- Add the Zeeve add-on to your QuickNode endpoint
- Create, deploy, and manage a subgraph using Zeeve
What You Will Need
- Basic understanding of The Graph
- Graph-CLI installed
- A subgraph project ready to be indexed and hosted (check out this guide to learn how)
- A QuickNode Account
| Dependency | Version |
|---|---|
| node.js | 18.13.0 |
| graph-cli | 0.49.0 |
What is Zeeve?
Zeeve is an enterprise-grade ready hosted graph solution that allows developers to deploy, index, and query subgraphs on a hosted service. Currently, if a network is not supported on The Graph's Hosted Service, you'll need to run your own graph node to index it. However, this can take extra engineering effort to set up and can be a mental burden to handle maintenance & issues. Zeeve solves this problem by allowing developers to quickly deploy subgraphs in less than 5 minutes.
Key Benefits of Zeeve
Features and key benefits of Zeeve include:
- Ultrafast Indexing: Experience minimal data lag with our rapid indexing capabilities.
- Zero Maintenance: Say goodbye to the hassle of node maintenance.
- Reliability: 99.9% API SLA uptime.
- Added Value Services : Benefit from additional features like Webhooks, metrics, and more, enhancing your standard subgraph functionalities.
- Flexibility: Easily migrate subgraphs from other platforms.
Additional features include advanced metrics & performance insights, plus direct access to logs emitted from your subgraph.
In the next section, we'll cover how to add the Zeeve add-on to your QuickNode account and walkthrough the Zeeve dashboard.
Enable Zeeve on a QuickNode Endpoint
First, log in to QuickNode (you can create a free account here), and then navigate to your endpoints. For this tutorial, you'll need an endpoint on Ethereum mainnet. Create one now if you don't yet have one.
Once you have your Ethereum mainnet endpoint set up, on your endpoint page, click the Add-ons tab and then click the Explore button on the Zeeve add-on. You'll see a pop-up box explaining pricing and which endpoints the add-on is compatible with. Once the add-on is enabled, you'll see it in your list of Installed Third-Party Add-Ons.
With the add-on installed, click the Dashboard button to be directed to Zeeve's dashboard:
Zeeve Dashboard:
The Zeeve dashboard above lets you quickly oversee the activity on your created subgraphs. In the following section, we'll show you how to create and deploy a subgraph on Zeeve.
Create a Subgraph with Zeeve
Now, within your Zeeve dashboard, click the Create Subgraphs button, and you'll be prompted to input details about the subgraph's name, blockchain network, workspace, and which RPC endpoint you want to use with the subgraph.
Upon creation of the subgraph, click your newly created subgraph on the dashboard, where you'll see statistics and the configuration of your subgraph:
At the top, you'll see a flag noting if your subgraph is deployed or not and a Sync Status bar displaying if the subgraph is synced with the latest tip of the chain. Additionally, there is a Logs button to view and filter through the events your subgraph emitted, as well as a Delete button to deactivate your subgraph.
In the Details section of your subgraph, you'll see information regarding when the subgraph was created, the blockchain network it is referencing, and your workspace (which should be a default workspace). The Deployment Command button explains the steps to host your subgraph (which we'll get into soon).
The Query URL section of your subgraph provides the URL you would use to query your hosted subgraph and also lets you interact with it on an interactive playground (via the Open button).
Deploy a Subgraph with Zeeve
Now, with our subgraph created on Zeeve, let's deploy it. Ensure your subgraph is compiled before moving on. If you don't have a subgraph project yet, or don't know what that is, check out this QuickNode Guide: How to Create and Deploy a Custom Subgraph with The Graph to get up and running fast.
Step 1: In the Details section within your subgraph on Zeeve's dashboard, click the Deployment Command button and update the network field in your subgraph.yaml (a YAML file containing the subgraph manifest within your subgraph proejct) with the name provided in Step 1 (e.g., ).
Once your subgraph.yaml is updated to include the network name shown in Step 1, you can move forward.
Step 2: Within your subgraph's root directory, run the command in Step 2 in your terminal, and you'll see an output similar too:
After your subgraph is deployed and you've confirmed its sync status is up to date with the chain, you can interact with it via the Open button in the Query section:
Then query via the GraphQL language to your subgraph's specified schema:
Note: you may see empty responses if your querying a block later than the subgraph has indexed and synced
Final Thoughts
That's it! You know now how to create, deploy, and manage your own subgraph using the Hosted Subgraphs add-on on the QuickNode Marketplace created by Zeeve. You don't need to maintain the subgraph and can quickly start to query from it with 99.9% uptime!
If you want to learn more, check out the following list of resources:
- Zeeve Documentation
- Guide: How to Create and Deploy a Custom Subgraph with The Graph
- QuickNode / Zeeve Marketplace Add-on
We would love to hear more about what you are building. Drop us a line in Discord, or give us a follow on Twitter to stay up to date on all the latest information!
We ❤️ Feedback!
Let us know if you have any feedback or requests for new topics. We'd love to hear from you.