Skip to main content
Home

Built and signed on GitHub Actions

Lib to build an indexer on cardano blockchain. Uses Kafka and A producer/Consumer pattern. Currently setup with MongoDB as the backend storage

This package works with DenoIt is unknown whether this package works with Cloudflare Workers, Node.js, Bun, Browsers
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Node.js
This package works with Deno
It is unknown whether this package works with Bun
It is unknown whether this package works with Browsers
JSR Score
70%
Published
10 months ago (0.0.4)

Cardano Indexer

A Cardano event-driven indexer, implemented in Deno and built upon the Ogmios solution.

Report Bug ยท Request Feature


About

  • Indexer: Developed using Ogmios and Deno, this Cardano indexer serves as the core of our project.
  • Message Transfer: We employ Apache Kafka for efficient communication between the indexer and processor components.
  • Data Storage: MongoDB is utilized to store block data and other relevant information, ensuring flexibility and swift adjustments based on custom requirements.
  • API & Dashboard: Hono facilitates a straightforward API, while HTMX enables creation of a basic yet functional dashboard.
  • Monitoring: Prometheus is integrated for comprehensive tracking of metrics and ensuring smooth project operation.

Documentation: https://cardano.studiowebux.com


Contributing

  1. Fork the project
  2. Create a Feature Branch
  3. Commit your changes
  4. Push your changes
  5. Create a PR
Working with your local branch

Branch Checkout:

git checkout -b <feature|fix|release|chore|hotfix>/prefix-name

Your branch name must starts with [feature|fix|release|chore|hotfix] and use a / before the name; Use hyphens as separator; The prefix correspond to your Kanban tool id (e.g. abc-123)

Keep your branch synced:

git fetch origin
git rebase origin/master

Commit your changes:

git add .
git commit -m "<feat|ci|test|docs|build|chore|style|refactor|perf|BREAKING CHANGE>: commit message"

Follow this convention commitlint for your commit message structure

Push your changes:

git push origin <feature|fix|release|chore|hotfix>/prefix-name

Examples:

git checkout -b release/v1.15.5
git checkout -b feature/abc-123-something-awesome
git checkout -b hotfix/abc-432-something-bad-to-fix
git commit -m "docs: added awesome documentation"
git commit -m "feat: added new feature"
git commit -m "test: added tests"

License

Distributed under the MIT License. See LICENSE for more information.

Contact

| Buy Me A Coffee | Webux Logo Webux Lab |
Built and signed on
GitHub Actions

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@studiowebux/cardano-indexer

Import symbol

import * as cardano_indexer from "@studiowebux/cardano-indexer";
or

Import directly with a jsr specifier

import * as cardano_indexer from "jsr:@studiowebux/cardano-indexer";

Add Package

pnpm i jsr:@studiowebux/cardano-indexer
or (using pnpm 10.8 or older)
pnpm dlx jsr add @studiowebux/cardano-indexer

Import symbol

import * as cardano_indexer from "@studiowebux/cardano-indexer";

Add Package

yarn add jsr:@studiowebux/cardano-indexer
or (using Yarn 4.8 or older)
yarn dlx jsr add @studiowebux/cardano-indexer

Import symbol

import * as cardano_indexer from "@studiowebux/cardano-indexer";

Add Package

vlt install jsr:@studiowebux/cardano-indexer

Import symbol

import * as cardano_indexer from "@studiowebux/cardano-indexer";

Add Package

npx jsr add @studiowebux/cardano-indexer

Import symbol

import * as cardano_indexer from "@studiowebux/cardano-indexer";

Add Package

bunx jsr add @studiowebux/cardano-indexer

Import symbol

import * as cardano_indexer from "@studiowebux/cardano-indexer";