stratum 0.0.5

Stratum protocol types, helpers and client
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

<h1 align=center><code>stratum</code></h1>

<div align=center>
  <a href=https://crates.io/crates/stratum>
    <img src=https://img.shields.io/crates/v/stratum.svg alt="crates.io version">
  </a>
  <a href=https://github.com/parasitepool/para/actions/workflows/ci.yaml>
    <img src=https://github.com/parasitepool/para/actions/workflows/ci.yaml/badge.svg alt="build status">
  </a>
  <a href=https://crates.io/crates/stratum>
    <img src=https://img.shields.io/crates/d/stratum.svg alt=downloads>
  </a>
</div>
<br>

`stratum` is a Rust library for the Stratum mining protocol. It provides types
for protocol messages, some helpers, and an optional async client for connecting
to mining pools. This is experimental software with no warranty. See
[LICENSE](LICENSE) for more details.

Stratum Messages
----------------

### Standard Protocol

Methods defined in the [Stratum mining protocol](https://en.bitcoin.it/wiki/Stratum_mining_protocol).

| Method                       | Type         | Implemented |
|------------------------------|--------------|-------------|
| `mining.configure`           | Request      | ✅          |
| `mining.subscribe`           | Request      | ✅          |
| `mining.authorize`           | Request      | ✅          |
| `mining.notify`              | Notification | ✅          |
| `mining.submit`              | Request      | ✅          |
| `mining.suggest_difficulty`  | Request      | ✅          |
| `mining.set_difficulty`      | Notification | ✅          |
| `client.reconnect`           | Notification | ✅          |
| `client.get_version`         | Notification | ❌          |
| `client.show_message`        | Notification | ❌          |
| `mining.get_transactions`    | Request      | ❌          |
| `mining.extranonce.subscribe`| Request      | ❌          |
| `mining.suggest_target`      | Request      | ❌          |
| `mining.set_extranonce`      | Notification | ❌          |

### Experimental Extensions

| Method                       | Type         | Implemented |
|------------------------------|--------------|-------------|
| `mining.ping`                | Notification | ❌          |
| `mining.get_txnhashes`       | Request      | ❌          |
| `mining.capabilities`        | Request      | ❌          |
| `mining.set_goal`            | Request      | ❌          |

Types
-----

| Type         | Description                                    |
|--------------|------------------------------------------------|
| `Difficulty` | Mining difficulty with target conversion       |
| `Extranonce` | Extranonce bytes with hex encoding             |
| `JobId`      | Job identifier (hex-encoded u64)               |
| `MerkleNode` | Merkle tree node with natural big-endian hex   |
| `Nbits`      | Compact target (nBits) from block header       |
| `Nonce`      | 32-bit nonce (hex-encoded)                     |
| `Ntime`      | Block timestamp (hex-encoded u32)              |
| `PrevHash`   | Previous block hash (word-swapped encoding)    |
| `Username`   | Worker identity with Bitcoin address parsing   |
| `Version`    | Block version with bitmask operations          |

Helpers
-------

| Function          | Description                                         |
|-------------------|-----------------------------------------------------|
| `format_si`       | Format a value with SI prefixes (K, M, G, T, P, ...)|
| `parse_si`        | Parse SI-prefixed values (e.g., "1.5 TH/s")         |
| `merkle_root`     | Compute merkle root from coinbase and branches      |
| `merkle_branches` | Build merkle branches from non-coinbase txids       |

Feature Flags
-------------

| Flag    | Description                           | Default |
|---------|---------------------------------------|---------|
| `client`| Async Stratum client (requires tokio) | Off     |

Examples
--------

### Parsing Stratum Messages

```rust
use stratum::{Message, Notify, Submit, Difficulty, Id};

// Parse a mining.notify notification
let notify: Notify = serde_json::from_value(json!([
    "bf", "4d16b6f85af6e2198f44ae2a6de67f78487ae5611b77c6c0440b921e00000000",
    "01000000010000000000000000000000000000000000000000000000000000000000000000ffffffff",
    "ffffffff", "1a2b3c4d", [], "00000002", "1c2ac700", "62d5c9e3", false
])).unwrap();

// Parse a generic message
let msg: Message = serde_json::from_str(r#"{"id":1,"method":"mining.subscribe","params":[]}"#).unwrap();
```

### Async Client

```rust
use stratum::{Client, Username, Event, Difficulty};
use std::time::Duration;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new(
        "pool.example.com:3333".into(),
        Username::new("bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4.worker"),
        None,
        "my-miner/1.0".into(),
        Duration::from_secs(30),
    );

    let mut events = client.connect().await?;
    client.subscribe().await?;
    client.authorize().await?;

    while let Ok(event) = events.recv().await {
        match event {
            Event::Notify(notify) => println!("new job: {:?}", notify.job_id),
            Event::SetDifficulty(diff) => println!("difficulty: {}", diff),
            Event::Disconnected => break,
        }
    }

    Ok(())
}
```