Cardano Blockchain Indexer Framework

Table of Contents

• Introduction
• Key features
• Quick start
• Documentation
  • User documentation
  • Haddock documentation
• Architecture overview
• CONTRIBUTING
  • How to contribute code (or documentation) to the project
  • How to submit an issue
• Roadmap
• Licensing

Introduction

Marconi is a lightweight customizable solution for indexing and querying the Cardano blockchain. Its original purpose is to provide a library that eases the tailored indexing of on-chain information. However, this repository also contains a set of indexers that are ready to use and some executables that group them. While we’d recommend defining indexers that fits your need, you can reuse the existing ones to test Marconi.

Key features

• Customizable backend. The core library comes with file:./marconi-core/src/Marconi/Core/Indexer/SQLiteIndexer.hs[SQLite backend], a file:./marconi-core/src/Marconi/Core/Indexer/FileIndexer.hs[file backend] or a file:./marconi-core/src/Marconi/Core/Indexer/ListIndexer.hs[in-memory backend].

• file:./marconi-core/src/Marconi/Core/Indexer/SQLiteAggregateQuery.hs[Group indexers] to query them,

• file:./marconi-core/src/Marconi/Core/Preprocessor/Resume.hs[Resume indexing] (new indexers don’t reset existing ones).

• file:./marconi-core/src/Marconi/Core/Transformer/WithCatchup.hs[Batch insert] to speed up synchronisation with the node.

• Logging using iohk-monitoring-framework.

• Indexers can be file:./marconi-core/src/Marconi/Core/Coordinator.hs[grouped].

A comparison with other chain-indexing projects is also available.

Quick start

To be completed…​

Documentation

User documentation

The more in-depth user documentation is available in our website.

Haddock documentation

The Haskell API documentation (Haddock) for the Marconi libraries is hosted here:

• marconi-core

• marconi-cardano-core

• marconi-cardano-indexers

• marconi-core-json-rpc

You may generate them directly with Cabal for each component:

cabal haddock marconi-core
cabal haddock marconi-core-json-rpc
cabal haddock marconi-cardano-chain-index

Architecture overview

See the Design and Architecture section the website for more in-depth explainations.

CONTRIBUTING

How to contribute code (or documentation) to the project

See CONTRIBUTING for comprehensive documentation on how to contribute to the project, including development, and how to submit changes.

How to submit an issue

Issues can be filed in the GitHub Issue tracker.

Roadmap

To be completed…​

Licensing

You are free to copy, modify, and distribute the Marconi project with under the terms of the Apache 2.0 license. See the LICENSE and NOTICE files for details.