qu-miner-api 0.0.2

API definitions for communication between Quantus node and external miners
Documentation
  • Coverage
  • 38.46%
    10 out of 26 items documented0 out of 4 items with examples
  • Size
  • Source code size: 6.21 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 536.45 kB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 15s Average build duration of successful builds.
  • all releases: 15s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Homepage
  • Quantus-Network/chain
    28 13 31
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • czareko

Quantus Miner API

This crate defines the shared data structures and API contract used for communication between a Quantus Network node and external miner services.

It includes:

  • Request structures (e.g., MiningRequest).
  • Response structures (e.g., MiningResponse, MiningResult).
  • Status enums (ApiResponseStatus) used in responses.

By using this crate, both the node and external miner implementations can ensure they are using compatible data formats for submitting jobs and retrieving results.

Usage

Add this crate as a dependency in the Cargo.toml of both the node and the external miner implementation.

Node:

[dependencies]
quantus-miner-api = { path = "../miner-api", default-features = false } 
# ... other dependencies

External Miner:

[dependencies]
quantus-miner-api = { path = "../miner-api" }
# Or if published:
# quantus-miner-api = "0.1.0"
# ... other dependencies

Then, import the types:

use quantus_miner_api::*;