cardano-foundation / cf-ledger-sync

An open-source Java application designed to facilitate access to indexed Cardano blockchain data
Apache License 2.0
20 stars 2 forks source link
[![Clean, Build](https://github.com/cardano-foundation/cf-ledger-sync/actions/workflows/build.yml/badge.svg)](https://github.com/cardano-foundation/cf-ledger-sync/actions/workflows/build.yml) [![CodeQL](https://github.com/cardano-foundation/cf-ledger-sync/actions/workflows/codeql.yml/badge.svg)](https://github.com/cardano-foundation/cf-ledger-sync/actions/workflows/codeql.yml) [![License](https://img.shields.io:/github/license/cardano-foundation/cf-ledger-sync?color=blue&label=license)](https://github.com/cardano-foundation/cf-ledger-sync/blob/master/LICENSE)

This repository contains the following applications:

  1. Ledger Sync: The main indexer application that reads data from the Cardano blockchain and writes to a PostgreSQL database.

  2. Ledger Sync - Scheduler App: An optional application for scheduling jobs in Ledger Sync. By default, specific Ledger Sync scheduled jobs are executed as part of the main Ledger Sync application, but you can also run them independently using this application.

  3. Ledger Sync - Streaming App: This app reads data from a Cardano node and publishes blockchain data to messaging middleware like Kafka or RabbitMQ. It publishes blockchain data in the form of events. Various types of events can be published by the streaming app, and you can configure which events you want to publish. This is useful if you want to listen to blockchain events but build your own storage layer.

For more details about the Streaming App, please check here.

Documentation

Check out Ledger Sync documentation site for more information.

Building from source

Prerequisites

Build JAR

./gradlew clean build -x test

Contributing to Ledger Sync

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

Please check the details here.