Skip to main content

Indexing-3rd-Party

What is a Subgraph?​

Subgraph is a customized, open-source solution for indexing and accessing real-time blockchain data through the GraphQL API. They provide developers with powerful tools to build, customize, and access blockchain data according to their needs.

This document will guide you through creating, deploying, and querying this subgraph. You can also see the document of Bifrost Subgraph Developer Guide

Prerequisites​

Before getting started, make sure you have:

  • Registered a Bifrost account and obtained an API key.
    • Please visit one of the following links and fill out the form to apply for an API key:
      • Apply for API key, after the review is approved, an apikey will be sent to your email
  • Installed the Graph CLI.
  • Installed the Yarn package manager.

Creating a Subgraph​

  1. Choose a subgraph name in the format <username>/<subgraph-name>, for example, "alice/mysubgraph".

    • <username>: This is your username on Bifrost.
    • <subgraph-name>: This is the specific name you choose for your subgraph, which usually reflects the functionality of the subgraph or the smart contract it indexes.

  2. Run the following command in your terminal, replacing {apikey} with your Bifrost API key obtained from the links above and <username/subgraph-name> with your chosen subgraph name:

graph create --node https://bitlayer.bfno.de/{apikey} <username/subgraph-name>

Removing a Subgraph​

  1. If you need to remove a subgraph, run the following command in your terminal, replacing {apikey} with your Bifrost API key and <username/subgraph-name> with the name of the subgraph you want to remove:
graph remove --node https://bitlayer.bfno.de/{apikey} <username/subgraph-name>

Deploying a Subgraph​

Run the following command in your terminal to deploy your subgraph, replacing {apikey} with your Bifrost API key and <username/subgraph-name> with your subgraph name:

graph deploy --node https://bitlayer.bfno.de/{apikey} --ipfs https://bitlayer.bfno.de <username/subgraph-name>

Querying a Subgraph​

Once deployed, you can use the following endpoints to query your subgraph:

  • GraphQL Endpoint:
https://bitlayer.bfno.de/{apikey}/subgraphs/name/<username/subgraph-name>/graphql
  • API Endpoint:
https://bitlayer.bfno.de/{apikey}/subgraphs/name/<username/subgraph-name>

Replace {apikey} with your Bifrost API key obtained from the links above and <username/subgraph-name> with your subgraph name.

You can now use the standard GraphQL query language to query your Subgraph

Support​

If you have any questions or feedback, please contact Bifrost support team at support@bfno.de.