ChainGraph provides performant GraphQL APIs for blockchain applications featuring state of art subscriptions, advanced filtering, sorting, pagination and aggregations across multiple blockchains.
🚧 Note: This project is in active development - feel free to explore and contribute! 🏗️
- Real-Time GraphQL Subscriptions – Subscribe to blockchain state and transactions/instructions/actions
- Advanced Data Operations – Powerful search, filtering, sorting and aggregation capabilities
- Blockchain RPC Facade – Push through guarantees for reliable data access
- Multi-Blockchain Support – Read data from multiple contracts, tables and blockchains on a single request
- Microfork Handling – Subscribe to state on the clients not to deltas
- Developer Tools – CLI with high quality application starters to speed up go-to-market
Hasura is a high-performance GraphQL engine that exposes the GraphQL schema and optimizes subscriptions. It includes an API authentication service and real-time data indexing services, which are currently written in NodeJS.
For more information on scaling, read this blog post: Scaling to 1 Million Active GraphQL Subscriptions
- apps/chaingraph.io - Main website
- apps/supabase - Supabase support ( experimental )
- apps/hasura - GraphQL engine and database migrations using Hasura
- apps/indexer - Multi-threaded NodeJS service for real-time data deserialization and indexing
- packages/genql - GenQL client for type-safe GraphQL queries
- packages/mappings - Data mappings for indexing ( temporary )
- packages/tsconfig - TypeScript configuration
ChainGraph API nodes are light and index whitelisted data tables and actions. The project is split into separate micro-services to make it easier to scale:
- chaingraph-graphql: GraphQL engine and database migrations using Hasura
- chaingraph-indexer: Multi-threaded NodeJS service for real-time data deserialization and indexing
ChainGraph is currently using a contract mapping protocol that allows developers to define how the data is indexed. Through these mappings ChainGraph can index the data in a way that is good for introspection of the blockchain heuristics. We will iterate on the mapping protocol to achieve fully typed schemas in the future.
- Node.js 18+
- pnpm
npm install -g pnpm
git clone https://github.com/chaingraph/chaingraph.git
cd chaingraph
pnpm install# Hasura Setup and Management
pnpm hasura:start # Start Hasura services (GraphQL Engine, Postgres, Data Connector)
pnpm hasura:stop # Stop Hasura services
pnpm hasura:reset # Reset Hasura environment (removes volumes and restarts)
pnpm hasura:logs # View Hasura logs in real-time
pnpm psql # Connect to Postgres database directlyChainGraph runs with the following default configuration:
- GraphQL API: http://localhost:3333
- Hasura Console: http://localhost:3333/console
- Postgres Database: localhost:5432
Key environment variables:
HASURA_GRAPHQL_ADMIN_SECRET: Required for console access and admin operationsHASURA_GRAPHQL_METADATA_DATABASE_URL: Postgres connection for Hasura metadataPG_DATABASE_URL: Main database connection string
Note: In production, make sure to change the admin secret and secure your environment variables.
See CONTRIBUTING.md for development guidelines.
MIT License