Skip to Content
Indexer

Public Interface and Indexer

Overview

The Reeve Indexer is a critical component that enables the reading and querying of financial data published on the Cardano blockchain. While the Reeve platform publishes accounting transactions and financial reports to the blockchain for transparency and immutability, the indexer provides the reverse capability - retrieving and making this on-chain data accessible and queryable.

Repository

For detailed installation instructions, configuration options, and running the indexer, please refer to the README  in the repository. GitHub Repository: cf-reeve-indexer 

Why is the Indexer Needed?

The indexer serves several essential purposes:

  1. Data Retrieval and Accessibility The Cardano blockchain stores data in a distributed, immutable ledger format. While this ensures transparency and auditability, it’s not optimized for direct querying or data retrieval. The indexer bridges this gap by:
  • Monitoring the Cardano blockchain for Reeve-specific transactions
  • Extracting and parsing the metadata from transactions tagged with label 1447
  • Making the data available through a queryable interface
  1. Public Transparency Organizations using Reeve publish their financial data on-chain for public verification. The indexer enables:
  • External auditors to verify published financial statements
  • Stakeholders to access and validate accounting records
  • Public accountability through transparent financial reporting
  1. Historical Data Access The indexer provides a way to:
  • Query historical transactions and reports
  • Track changes in financial statements over time
  • Audit the complete history of an organization’s published financial data
  1. Decoupling from the Main Platform The indexer operates independently from the Reeve platform, allowing:
  • Third-party developers to build tools and applications using published data
  • Independent verification without requiring access to the Reeve platform
  • Multiple consumers to access the same on-chain data simultaneously

How the Indexer Works

  1. Blockchain Monitoring: The indexer continuously monitors the Cardano blockchain for new transactions
  2. Metadata Filtering: It identifies transactions containing the metadata label 1447
  3. Data Extraction: Parses the JSON-formatted metadata from matching transactions
  4. Validation: Validates the structure and content against the expected schema
  5. Storage/Indexing: Stores the parsed data in a queryable format
  6. API Access: Provides interfaces for querying and retrieving the indexed data

On-Chain Data Format

The indexer reads financial data published in a specific format identified by the metadata label 1447. This format supports two main types of data:

  • Individual Transactions: Detailed accounting transaction records with line items, business context, and document details
  • Financial Reports: Balance sheets and income statements

For a complete explanation of the on-chain data format, structure, and all supported fields, see the On-Chain Data Format documentation.

Integration with Reeve Platform

The indexer complements the Reeve platform’s blockchain publisher module:

  • Publisher (in Reeve Platform): Writes financial data to the Cardano blockchain
  • Indexer (separate application): Reads financial data from the Cardano blockchain

This separation ensures that published data can be independently verified and accessed by any party, not just the publishing organization.

Additional Resources

Last updated on
OrganisationMetadata Format