quantus-miner-api 0.3.0

API definitions for communication between Quantus node and external miners
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

# 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:

*   QUIC protocol messages (`MinerMessage`), including `Ready { token }` for miner auth.
*   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.

**External Miner** (published crate — preferred):
```toml
[dependencies]
quantus-miner-api = "0.3.0"
```

**Node / this monorepo** (path dependency):
```toml
[dependencies]
quantus-miner-api = { path = "../miner-api", default-features = false }
```

Then, import the types:

```rust
use quantus_miner_api::*;
```