Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Joystream/hydra
A Substrate indexing framework
https://github.com/Joystream/hydra
substrate
Last synced: about 1 month ago
JSON representation
A Substrate indexing framework
- Host: GitHub
- URL: https://github.com/Joystream/hydra
- Owner: Joystream
- Created: 2020-08-17T09:05:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-19T11:42:25.000Z (9 months ago)
- Last Synced: 2024-11-08T07:43:03.324Z (about 1 month ago)
- Topics: substrate
- Language: TypeScript
- Homepage:
- Size: 6.47 MB
- Stars: 49
- Watchers: 10
- Forks: 44
- Open Issues: 85
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
- awesome-substrate - Hydra - A GraphQL framework for Substrate nodes. (Tools)
- awesome-substrate - Hydra - A GraphQL framework for Substrate nodes. (Tools)
README
# Hydra
A Substrate query node framework. Inspired by [TheGraph](http://thegraph.com/), it gives a smooth way to provide powerful GraphQL queries to app developers over your Substrate blockchain state and history.
## What's Hydra?
[Hydra](https://joystream.org/hydra) is a query node for Substrate-based blockchains. A query node ingests data from a substrate chain and provides rich, domain-specific, and highly customizable access to the blockchain data, far beyond the scope of direct RPC calls. For example, expired [Kusama Treasury](https://wiki.polkadot.network/docs/en/learn-treasury) spending [proposals](https://kusama.subscan.io/event?module=Treasury&event=Proposed) are pruned from the state of the [Kusama blockchain](https://polkascan.io/kusama), so querying, say, one-year-old proposals is problematic. Indeed, one has to track the evolution of the state by sequentially applying the Treasury events and extrinsics in each historical block.
That's where Hydra gets you covered. Define your data model and the Hydra indexer will get it in sync with the chain. On top of that, you get a batteries-included GraphQL server with comprehensive filtering, pagination, and even full-text search capabilities.
## Architecture one-liner
A Hydra query node ingests substrate events in a multi-step pipeline:
```text
Substrate Chain => Hydra Indexer => Indexer GraphQL gateway => Hydra Processor => Database => Query Node GraphQL endpoint
```
For popular chains, one can use an already in-sync publicly available Indexer endpoint. For other chains, a self-hosted [indexer](https://github.com/Joystream/hydra/tree/master/packages/hydra-indexer) should be set up.
## Hydra CLI quickstart
Run
```text
$ npx @joystream/hydra-cli@next scaffold
```
and answer the prompts. It will generate a sample project and README with setup instructions.
## Monorepo structure
The monorepo contains the following sub-packages:
* [Hydra CLI](hydra-cli.md): Codegen tools to set up and run a Hydra pipeline
* [Hydra Indexer](hydra-indexer.md): Hydra indexer for ingesting raw events and extrinsics
* [Hydra Indexer Gateway](hydra-indexer-gateway.md): GraphQL interface for the Indexer
* [Hydra Processor](hydra-processor.md): Processing part of the pipeline for transforming events into rich business-level objects
* [Hydra Typegen](hydra-typegen.md): A tool for generating typesafe typescript classes for events and extrinsics from the runtime metadata. No more manual deserialization of the event data.
* [Sample Project](packages/sample): A quickstart Hydra project set up against a publicly available Kusama indexer. Good starting point.
* [Docs](https://dzhelezov.gitbook.io/hydra/): In-depth documentation covering the Hydra pipeline and API features, such as full-text search, pagination, extensive filtering and a rich GraphQL dialect defining your schema!