Skip to content

README.md

Latest commit

 

History

History
129 lines (92 loc) · 3.73 KB

README.md

File metadata and controls

129 lines (92 loc) · 3.73 KB

Ogmios Example Worker

Overview

The Ogmios Example Worker demonstrates the capabilities of the Ogmios Client package, including:

  • Reading blocks from blockchain slots.
  • Accessing and monitoring mempool transactions.
  • Querying ledger state data (epoch, protocol parameters, treasury, governance proposals, stake pools).
  • Saving transaction data to a PostgreSQL database (in-memory in this example).

This application is open-source and designed for easy cloning, use, and extension.

Features

  • Chain Synchronization: Reads and processes blocks from the blockchain.
  • Mempool Monitoring: Tracks mempool transactions and metadata.
  • Ledger State Queries: Demonstrates querying live ledger state data from the Cardano blockchain including:
    • Current epoch and ledger tip
    • Protocol parameters (fee coefficients, version)
    • Treasury and reserves balances
    • Active governance proposals
    • Stake pool details (pledge, cost, margin, VRF key, reward account)
  • Transaction Evaluation: Demonstrates evaluating transactions to estimate execution units before submission.
  • Transaction Submission: Demonstrates submitting signed transactions to the Cardano blockchain.
  • Data Persistence: Saves transactions to an in-memory PostgreSQL database using Entity Framework.
  • Extendable Architecture: Easily customize or replace components.
  • Unit Testing: Includes tests for mocking data and validating database operations.

Getting Started

Prerequisites

  • .NET SDK 10.0 or later.
  • PostgreSQL database.
  • Access to an Ogmios server or mock data.

Installation

  1. Clone the repository:

    git clone <repository-url>
cd Ogmios.Example.Worker

  2. Configure the application: Update appsettings.json with:

    • Ogmios Server: 
      "Ogmios": {
  "Host": "https://demeter-run-authenticated-url",
  "Port": 443,
  "Tls": true,
  "MaxBlocksPerSecond": "35"
}
    • Starting Points: 
      "StartingPoints": [
  {
    "StartingPointIdOrOrigin": "4e58bb36837b32f894c8a57006e24b64c2d77bf4fc13b3b2c428fee8871e2491",
    "StartingPointSlot": "115545883"
  }
]

  3. Build and Run:

    dotnet build
dotnet run

Usage

  1. Chain Synchronization: Processes blocks from blockchain slots and saves transaction data.
  2. Mempool Monitoring: Tracks live mempool transactions and metadata.
  3. Ledger State Queries: Acquires ledger state and queries epoch, protocol parameters, treasury/reserves, governance proposals, and stake pool details.
  4. Transaction Evaluation: Evaluates transactions with CBOR-encoded data to estimate execution budgets and validator information.
  5. Transaction Submission: Submits CBOR-encoded signed transactions to the Cardano blockchain and returns the transactionId.
  6. Database Integration: Persists transaction data in a PostgreSQL database.

Testing

Run unit tests to validate functionality:

dotnet test

Tests include:

  • Mocking Ogmios data.
  • Mapping transactions to the database.
  • Validating data persistence.

Extensibility

  • Database: Replace or extend the PostgreSQL provider with any supported Entity Framework Provider.
  • Handlers: Customize logic for blockchain and mempool events.

Documentation and Demo

  • Demo Video: Showcases blockchain and mempool processing.
  • Documentation: Available in the repository for setup, usage, and testing.

Contribution

Contributions are welcome! Fork the repo, create a branch, and submit a pull request to improve the example worker application.

License

Licensed under the MIT License. See the LICENSE file for details.
⚡