README
¶
flowJuno
This branch is intended to be used with Flow Go SDK.
flowJuno is a Flow blockchain data aggregator and exporter that provides the ability for developers and clients to query for indexed chain data.
Table of Contents
Background
This version of flowJuno is a fork of FissionLabs's Juno.
The main reason behind the fork what to improve the original project by:
- allowing different databases types as data storage spaces;
- creating a highly modular code that allows for easy customization.
We achieved the first objective by supporting both PostgreSQL and MongoDB. We also reviewed the code design by using a database interface so that you can implement whatever database backend you prefer most.
On the other hand, to achieve a highly modular code, we implemented extension points through the worker.RegisterBlockHandler, worker.RegisterTxHandler and worker.RegisterMsgHandler methods. You can use those to extend the default working of the code (which simply parses and saves the data on the database) with whatever operation you want.
Usage
To know how to setup and run flowJuno, please refer to the docs folder.
Testing
If you want to test the code, you can do so by running
$ make test-unit
Note: Requires Docker.
This will:
- Create a Docker container running a PostgreSQL database.
- Run all the tests using that database as support.
GraphQL integration
If you want to know how to run a GraphQL server that allows to expose the parsed data, please refer to the following guides:
Contributing
Contributions are welcome! Please open an Issues or Pull Request for any changes.
Directories