https://github.com/forbole/juno

A Cosmos Hub data aggregator and exporter.
https://github.com/forbole/juno

blockchain cosmosnetwork hacktoberfest

Last synced: about 2 months ago
JSON representation

A Cosmos Hub data aggregator and exporter.

• Host: GitHub
• URL: https://github.com/forbole/juno
• Owner: forbole
• License: cc0-1.0
• Created: 2020-02-25T13:05:59.000Z (over 4 years ago)
• Default Branch: cosmos/v0.50.x
• Last Pushed: 2024-06-24T06:02:05.000Z (3 months ago)
• Last Synced: 2024-06-25T06:48:39.211Z (3 months ago)
• Topics: blockchain, cosmosnetwork, hacktoberfest
• Language: Go
• Homepage:
• Size: 2.14 MB
• Stars: 74
• Watchers: 5
• Forks: 72
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ccamel - forbole/juno - A Cosmos Hub data aggregator and exporter. (Go)

README

        


  
 Juno 



![banner](.docs/.img/logo.png)

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/desmos-labs/juno/Tests)](https://github.com/forbole/juno/actions?query=workflow%3ATests)

[![Go Report Card](https://goreportcard.com/badge/github.com/forbole/juno)](https://goreportcard.com/report/github.com/forbole/juno)

![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/forbole/juno)

> Juno is a Cosmos Hub blockchain data aggregator and exporter that provides the ability for developers and clients to query for indexed chain data.

## Table of Contents

  - [Background](#background)

  - [Usage](#usage)

  - [GraphQL integration](#graphql-integration)

  - [Contributing](#contributing)

  - [License](#license)

## Background

This version of Juno is a fork of [FissionLabs's Juno](https://github.com/fissionlabsio/juno). 

The main reason behind the fork what to improve the original project by: 

1. allowing different databases types as data storage spaces;

2. 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.    

## Compatibility table

Since the Cosmos SDK has evolved a lot, we have different versions of Juno available.

|               Cosmos SDK Version                |   Juno branch    |

|:-----------------------------------------------:|:----------------:|

|         `v0.43.x`, `v0.44.x`, `v0.45.1`         | `cosmos/v0.44.x` |

|                   `v0.45.x`                     | `cosmos/v0.45.x` |

|                   `v0.46.x`                     | `cosmos/v0.46.x` |

|                   `v0.47.x`                     | `cosmos/v0.47.x` |

|                   `v0.50.x`                     | `cosmos/v0.50.x` |

## Usage

To know how to setup and run Juno, please refer to the [docs folder](.docs).

## Testing

If you want to test the code, you can do so by running

```shell

$ make test-unit

```

**Note**: Requires [Docker](https://docker.com).

This will:

1. Create a Docker container running a PostgreSQL database.

2. 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: 

- [PostgreSQL setup with GraphQL](.docs/postgres-graphql-setup.md)

## Contributing

Contributions are welcome! Please open an Issues or Pull Request for any changes.

## License

[CCC0 1.0 Universal](https://creativecommons.org/share-your-work/public-domain/cc0/)