quantus-miner-api

Crates.ioquantus-miner-api
lib.rsquantus-miner-api
version0.0.3
created_at2025-09-22 12:24:43.043208+00
updated_at2025-09-22 12:24:43.043208+00
descriptionAPI definitions for communication between Quantus node and external miners
homepagehttps://quantus.com/
repositoryhttps://github.com/quantus-network/chain#
max_upload_size
id1849964
size6,231
Quantus Network CI (quantus-network-ci)

documentation

README

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::*;
Commit count: 0

cargo fmt