translator_sv2 0.2.5

SV1 to SV2 translation proxy
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175

//! Monitoring integration for Translation Proxy (tProxy)
//!
//! This module implements the ServerMonitoring trait on `ChannelManager`.
//! tProxy has server channels (upstream to pool) but no SV2 clients
//! (SV1 clients are handled separately in sv1_monitoring.rs).

use stratum_apps::monitoring::server::{ServerExtendedChannelInfo, ServerInfo, ServerMonitoring};

use crate::{sv2::ChannelManager, utils::AGGREGATED_CHANNEL_ID, TproxyMode};

impl ServerMonitoring for ChannelManager {
    fn get_server(&self) -> ServerInfo {
        let mut extended_channels = Vec::new();
        let standard_channels = Vec::new(); // tProxy only uses extended channels
        let report_hashrate = self.report_hashrate;

        match self.mode {
            TproxyMode::Aggregated => {
                // In Aggregated mode: one shared channel to the server
                // stored under AGGREGATED_CHANNEL_ID
                if let Some(aggregated_extended_channel) =
                    self.extended_channels.get(&AGGREGATED_CHANNEL_ID)
                {
                    let channel_id = aggregated_extended_channel.get_channel_id();
                    let target = *aggregated_extended_channel.get_target();
                    let extranonce_prefix =
                        aggregated_extended_channel.get_extranonce_prefix().to_vec();
                    let user_identity = aggregated_extended_channel.get_user_identity().clone();
                    let full_extranonce_size =
                        aggregated_extended_channel.get_full_extranonce_size();
                    let rollable_extranonce_size =
                        aggregated_extended_channel.get_rollable_extranonce_size();
                    let version_rolling = aggregated_extended_channel.is_version_rolling();
                    let nominal_hashrate = aggregated_extended_channel.get_nominal_hashrate();
                    let share_accounting = aggregated_extended_channel.get_share_accounting();
                    let shares_rejected_by_reason = share_accounting.get_rejected_shares().clone();
                    let shares_rejected = shares_rejected_by_reason.values().copied().sum();

                    extended_channels.push(ServerExtendedChannelInfo {
                        channel_id,
                        user_identity,
                        nominal_hashrate: report_hashrate.then_some(nominal_hashrate),
                        target_hex: hex::encode(target.to_be_bytes()),
                        extranonce_prefix_hex: hex::encode(extranonce_prefix),
                        full_extranonce_size,
                        rollable_extranonce_size,
                        version_rolling,
                        shares_acknowledged: share_accounting.get_acknowledged_shares(),
                        shares_submitted: share_accounting.get_validated_shares(),
                        shares_rejected,
                        shares_rejected_by_reason,
                        share_work_sum: share_accounting.get_share_work_sum(),
                        best_diff: share_accounting.get_best_diff(),
                        blocks_found: share_accounting.get_blocks_found(),
                    });
                }
            }
            TproxyMode::NonAggregated => {
                // In NonAggregated mode: each downstream Sv1 miner has its own upstream Sv2
                // channel to the server
                for channel in self.extended_channels.iter() {
                    let extended_channel = channel.value();

                    let channel_id = extended_channel.get_channel_id();
                    let target = extended_channel.get_target();
                    let extranonce_prefix = extended_channel.get_extranonce_prefix();
                    let user_identity = extended_channel.get_user_identity();
                    let share_accounting = extended_channel.get_share_accounting();
                    let shares_rejected_by_reason = share_accounting.get_rejected_shares().clone();
                    let shares_rejected = shares_rejected_by_reason.values().copied().sum();

                    extended_channels.push(ServerExtendedChannelInfo {
                        channel_id,
                        user_identity: user_identity.clone(),
                        nominal_hashrate: if report_hashrate {
                            Some(extended_channel.get_nominal_hashrate())
                        } else {
                            None
                        },
                        target_hex: hex::encode(target.to_be_bytes()),
                        extranonce_prefix_hex: hex::encode(extranonce_prefix),
                        full_extranonce_size: extended_channel.get_full_extranonce_size(),
                        rollable_extranonce_size: extended_channel.get_rollable_extranonce_size(),
                        version_rolling: extended_channel.is_version_rolling(),
                        shares_acknowledged: share_accounting.get_acknowledged_shares(),
                        shares_submitted: share_accounting.get_validated_shares(),
                        shares_rejected,
                        shares_rejected_by_reason,
                        share_work_sum: share_accounting.get_share_work_sum(),
                        best_diff: share_accounting.get_best_diff(),
                        blocks_found: share_accounting.get_blocks_found(),
                    });
                }
            }
        }

        ServerInfo {
            extended_channels,
            standard_channels,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use async_channel::unbounded;
    use stratum_apps::stratum_core::{
        bitcoin::Target,
        channels_sv2::{client::extended::ExtendedChannel, extranonce_manager::ExtranoncePrefix},
    };

    fn create_test_channel_manager() -> ChannelManager {
        let (upstream_sender, _upstream_receiver) = unbounded();
        let (_upstream_sender2, upstream_receiver) = unbounded();
        let (sv1_server_sender, _sv1_server_receiver) = unbounded();
        let (_sv1_server_sender2, sv1_server_receiver) = unbounded();

        ChannelManager::new(
            upstream_sender,
            upstream_receiver,
            sv1_server_sender,
            sv1_server_receiver,
            vec![],
            vec![],
            TproxyMode::Aggregated,
            true,
        )
    }

    fn create_extended_channel(channel_id: u32, user_identity: &str) -> ExtendedChannel<'static> {
        let prefix = ExtranoncePrefix::from_wire(vec![0x01, channel_id as u8]).unwrap();
        ExtendedChannel::new(
            channel_id,
            user_identity.to_string(),
            prefix,
            Target::from_le_bytes([0xff; 32]),
            1.0,
            true,
            4,
        )
    }

    #[test]
    fn aggregated_monitoring_uses_only_upstream_channel_accounting() {
        let manager = create_test_channel_manager();

        manager.extended_channels.insert(
            AGGREGATED_CHANNEL_ID,
            create_extended_channel(42, "upstream"),
        );
        manager
            .extended_channels
            .insert(7, create_extended_channel(7, "downstream"));

        manager
            .extended_channels
            .get_mut(&AGGREGATED_CHANNEL_ID)
            .unwrap()
            .on_share_acknowledgement(2, 10.0);
        manager
            .extended_channels
            .get_mut(&7)
            .unwrap()
            .on_share_acknowledgement(5, 25.0);

        let server = manager.get_server();
        let aggregated = server.extended_channels.first().unwrap();

        assert_eq!(server.extended_channels.len(), 1);
        assert_eq!(aggregated.channel_id, 42);
        assert_eq!(aggregated.shares_acknowledged, 2);
        assert_eq!(aggregated.share_work_sum, 10.0);
    }
}