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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
use async_std::net::{SocketAddr, TcpStream};
use async_std::sync::{Arc, Mutex, RwLock};
use chrono::Utc;
use futures::io::BufReader;
use futures::io::{AsyncBufReadExt, AsyncWriteExt};
use futures::io::{ReadHalf, WriteHalf};
use log::info;
use serde::Serialize;
use std::time::SystemTime;
use stratum_types::params::{ClientParam, PoolParam};
use stratum_types::traits::{
    AuthManager, Authorize, AuthorizeResult, BlockValidator, DataProvider, Notify, StratumManager,
    SubscribeResult,
};
use stratum_types::traits::{PoolParams, StratumParams};
use stratum_types::Result;
use stratum_types::{
    ClientPacket, Error, MinerAuth, MinerInfo, MinerJobStats, Request, Response, StratumError,
    StratumMethod,
};
use uuid::Uuid;

#[derive(PartialEq, Debug)]
pub enum State {
    Connected,
    Disconnect,
}

//@todo making difficulty variable would also be awesome.
//@todo Review which of these we need Mutexs/Arcs/etc. Might be over indulging here.
#[derive(Debug)]
pub struct Connection<SM: StratumManager> {
    pub id: String,
    pub write_half: Arc<Mutex<WriteHalf<TcpStream>>>,
    pub read_half: Arc<Mutex<BufReader<ReadHalf<TcpStream>>>>,
    pub authorized: Arc<Mutex<bool>>,
    pub data_provider: Arc<SM::DataProvider>,
    pub block_validator: Arc<SM::BlockValidator>,
    pub auth_manager: Arc<SM::AuthManager>,
    pub session_start: SystemTime,
    pub state: Mutex<State>,
    pub subscribed: Arc<Mutex<bool>>,
    pub subscriber_id: Arc<Mutex<String>>,
    pub miner_info: Arc<RwLock<MinerInfo>>,
    //Possibly pull these out into their own var.
    //Makes it easier to operate on them.
    pub difficulty: Arc<Mutex<f64>>,
    pub submissions: Arc<Mutex<u64>>,
    pub last_retarget: Arc<Mutex<SystemTime>>,
    pub next_difficulty: Arc<Mutex<f64>>,
    pub job_stats: Arc<Mutex<JobStats>>,
    pub options: Arc<MinerOptions>,
    pub stats: Arc<Mutex<MinerStats>>,
    pub var_diff: bool,
}

//@todo probably move these over to types.
#[derive(Debug, Default)]
pub struct JobStats {
    last_share_timestamp: i64,
    last_retarget: i64,
    times: Vec<i64>,
    current_difficulty: f64,
    job_difficulty: f64,
}

//@todo this should probably come from builder pattern
#[derive(Debug, Default)]
pub struct MinerOptions {
    retarget_time: i64,
    target_time: f64,
    min_diff: f64,
    max_delta: f64,
    variance_percent: u32,
    share_time_min: f64,
    share_time_max: f64,
}

#[derive(Debug, Default)]
pub struct MinerStats {
    //@todo not sure if effective is correct here.
    effective_hash_rate: f64,
    accepted_shares: u64,
    rejected_shares: u64,
}

impl<SM> Connection<SM>
where
    SM: StratumManager,
{
    pub fn new(
        addr: SocketAddr,
        rh: BufReader<ReadHalf<TcpStream>>,
        wh: WriteHalf<TcpStream>,
        data_provider: Arc<SM::DataProvider>,
        auth_manager: Arc<SM::AuthManager>,
        block_validator: Arc<SM::BlockValidator>,
        var_diff: bool,
        initial_difficulty: f64,
    ) -> Self {
        //@todo could store this as a UUID type as well.
        let id = Uuid::new_v4().to_string();

        info!("Accepting new miner. ID: {}", &id);

        let info = MinerInfo {
            ip: addr.ip(),
            auth: None,
            sid: None,
            job_stats: None,
        };

        let options = MinerOptions {
            retarget_time: 120,
            target_time: 6.0,
            min_diff: 0.0001,
            max_delta: 1.0, //@todo make this adjustable, not sure if this is solid or not.
            //@todo probably don't store, get from above and then calcualte the others.
            variance_percent: 30,
            share_time_min: 4.2,
            share_time_max: 7.8,
        };

        Connection {
            id,
            write_half: Arc::new(Mutex::new(wh)),
            read_half: Arc::new(Mutex::new(rh)),
            authorized: Arc::new(Mutex::new(false)),
            data_provider,
            auth_manager,
            block_validator,
            session_start: SystemTime::now(),
            state: Mutex::new(State::Connected),
            subscribed: Arc::new(Mutex::new(false)),
            //@todo this should be passed in.
            difficulty: Arc::new(Mutex::new(initial_difficulty)),
            subscriber_id: Arc::new(Mutex::new(String::new())),
            miner_info: Arc::new(RwLock::new(info)),
            submissions: Arc::new(Mutex::new(0)),
            last_retarget: Arc::new(Mutex::new(SystemTime::now())),
            next_difficulty: Arc::new(Mutex::new(0.0)),
            job_stats: Arc::new(Mutex::new(Default::default())),
            options: Arc::new(options),
            stats: Arc::new(Mutex::new(Default::default())),
            var_diff,
        }
    }

    pub async fn start(&self) -> Result<()> {
        loop {
            if *self.state.lock().await == State::Disconnect {
                break;
            }

            let msg: ClientPacket<SM::PoolParams, SM::StratumParams> = self.next_message().await?;

            match msg {
                ClientPacket::Request(req) => self.handle_requests(req).await?,
                ClientPacket::Response(res) => self.handle_responses(res).await?,
            };
        }

        Ok(())
    }

    pub async fn handle_requests(
        &self,
        req: Request<ClientParam<SM::PoolParams, SM::StratumParams>>,
    ) -> Result<()> {
        if let ClientParam::Authorize(auth) = &req.params {
            return Ok(self.handle_authorize(auth).await?);
        }

        //let authorized = self.authorized.lock().await;
        //if !*authorized {
        //    //This would be a huge ban
        //    // return Err(Error::;
        //    //@todo needs to return an error here.
        //    return Ok(());
        //}

        match &req.params {
            ClientParam::Submit(value) => self.handle_submit(value).await?,
            ClientParam::Subscribe(value) => self.handle_subscribe(value).await?,
            ClientParam::Unknown(value) => self.handle_unknown(value).await?,
            ClientParam::Authorize(_) => {}
        };
        Ok(())
    }

    pub async fn handle_responses(
        &self,
        _res: Response<ClientParam<SM::PoolParams, SM::StratumParams>>,
    ) -> Result<()> {
        //@todo maybe throw this into a function - "checkAuth" then error is easier to throw
        let authorized = self.authorized.lock().await;
        if !*authorized {
            //This would be a huge ban
            // return Err(Error::;
            //@todo needs to return an error here.
            return Ok(());
        }

        Ok(())
    }

    pub async fn next_message(&self) -> Result<ClientPacket<SM::PoolParams, SM::StratumParams>> {
        loop {
            let mut stream = self.read_half.lock().await;

            let mut buf = String::new();
            let num_bytes = stream.read_line(&mut buf).await?;

            if num_bytes == 0 {
                self.shutdown().await?;
                //Make this our own?
                return Err(Error::StreamClosed);
            }

            if !buf.is_empty() {
                //@smells
                buf = buf.trim().to_owned();
                let msg: ClientPacket<SM::PoolParams, SM::StratumParams> =
                    serde_json::from_str(&buf)?;

                return Ok(msg);
            };
        }
    }

    async fn send<T: Serialize>(&self, message: T) -> Result<()> {
        let msg = serde_json::to_vec(&message)?;

        let mut stream = self.write_half.lock().await;

        stream.write_all(&msg).await?;
        stream.write_all(b"\n").await?;

        Ok(())
    }

    //Helper function to make sending requests more simple.
    async fn send_request(
        &self,
        method: StratumMethod,
        params: PoolParam<SM::PoolParams, SM::StratumParams>,
    ) -> Result<()> {
        let request = Request {
            id: self.id.clone(),
            method,
            params,
        };

        Ok(self.send(request).await?)
    }

    async fn send_response(
        &self,
        method: StratumMethod,
        result: PoolParam<SM::PoolParams, SM::StratumParams>,
    ) -> Result<()> {
        let response = Response {
            id: self.id.clone(),
            method,
            result: Some(result),
            error: None,
        };

        Ok(self.send(response).await?)
    }

    async fn send_error(&self, method: StratumMethod, error: StratumError) -> Result<()> {
        let response: Response<PoolParam<SM::PoolParams, SM::StratumParams>> = Response {
            id: self.id.clone(),
            method,
            result: None,
            error: Some(error),
        };

        Ok(self.send(response).await?)
    }

    pub async fn shutdown(&self) -> Result<()> {
        *self.state.lock().await = State::Disconnect;

        //Only returning a result here because we might want to add more functionality in the
        //future.
        //Here is where we actually will write upstream to KILL the connection if we are using that
        //proxy.
        Ok(())
    }

    // ===== Handler Functions ===== //
    pub async fn handle_authorize(
        &self,
        auth: &<SM::PoolParams as PoolParams>::Authorize,
    ) -> Result<()> {
        let result = self
            .auth_manager
            .authorize(self.miner_info.read().await.clone(), &auth)
            .await;

        match result {
            Ok(auth_result) => {
                self.send_response(
                    StratumMethod::Authorize,
                    PoolParam::AuthorizeResult(auth_result.clone()),
                )
                .await?;

                if auth_result.authorized() {
                    info!("Authorized Miner: {}", &self.id);
                    *self.authorized.lock().await = true;
                    let miner_auth = MinerAuth {
                        username: auth.username(),
                        id: auth_result.id(),
                    };

                    self.miner_info.write().await.auth = Some(miner_auth);
                } else {
                    self.shutdown().await?;
                }
            }
            Err(e) => {
                self.send_error(StratumMethod::Authorize, e).await?;
            }
        }

        Ok(())
    }

    //@todo can make these this same as below.
    pub async fn send_initial_work(&self) -> Result<()> {
        let job = self.data_provider.get_job().await;

        let mut job_stats = self.job_stats.lock().await;
        job_stats.last_share_timestamp = Utc::now().timestamp();
        job_stats.last_retarget = Utc::now().timestamp();
        job_stats.times = Vec::new();
        job_stats.job_difficulty = job.get_difficulty();
        job_stats.current_difficulty = *self.difficulty.lock().await;

        let info_job_stats = MinerJobStats {
            expected_difficulty: job_stats.current_difficulty,
        };

        self.miner_info.write().await.job_stats = Some(info_job_stats);

        self.send_request(StratumMethod::Notify, PoolParam::Notify(job))
            .await?;

        Ok(())
    }

    pub async fn send_work(&self) -> Result<()> {
        let job = self.data_provider.get_job().await;
        let job_difficulty = job.get_difficulty();

        self.send_request(StratumMethod::Notify, PoolParam::Notify(job))
            .await?;

        let mut job_stats = self.job_stats.lock().await;
        job_stats.last_share_timestamp = Utc::now().timestamp();
        job_stats.last_retarget = Utc::now().timestamp();
        job_stats.times = Vec::new();
        job_stats.job_difficulty = job_difficulty;
        job_stats.current_difficulty = *self.difficulty.lock().await;

        let info_job_stats = MinerJobStats {
            expected_difficulty: job_stats.current_difficulty,
        };

        self.miner_info.write().await.job_stats = Some(info_job_stats);

        Ok(())
    }

    pub async fn handle_submit(
        &self,
        share: &<SM::StratumParams as StratumParams>::Submit,
    ) -> Result<()> {
        info!("Received share from miner: {}", &self.id);

        let result = self
            .block_validator
            .validate_share(self.miner_info.read().await.clone(), share.clone())
            .await;

        match result {
            Ok(valid) => {
                info!("Accepted share from miner: {}", &self.id);

                self.send_response(StratumMethod::Submit, PoolParam::SubmitResult(valid))
                    .await?;

                if self.var_diff {
                    //@todo come back to if we want this or not.
                    let mut job_stats = self.job_stats.lock().await;
                    //self.stats.valid_shares += 1;
                    //@todo make sure this is initialized in notify.
                    let now = Utc::now().timestamp();
                    let duration_since_last_share = now - job_stats.last_share_timestamp;

                    job_stats.times.push(duration_since_last_share);
                    job_stats.last_share_timestamp = now;

                    let time_total: i64 = job_stats.times.iter().sum();
                    let avg = time_total as f64 / job_stats.times.len() as f64;

                    if now - job_stats.last_retarget >= self.options.retarget_time
                        || avg < self.options.share_time_min && avg > self.options.share_time_max
                    {
                        self.retarget(avg, &mut job_stats).await?
                    }
                }
            }
            Err(e) => {
                info!("Rejecting share from miner: {}. Reason: {}", &self.id, e);
                self.send_error(StratumMethod::Submit, e).await?;
            }
        }

        Ok(())
    }

    pub async fn handle_subscribe(
        &self,
        subscribe: &<SM::PoolParams as PoolParams>::Subscribe,
    ) -> Result<()> {
        let result = self
            .auth_manager
            .subscribe(self.miner_info.read().await.clone(), subscribe)
            .await;

        match result {
            Ok(sub_info) => {
                //@todo remove this I think. since we have it in miner_info.
                *self.subscriber_id.lock().await = sub_info.id();

                *self.subscribed.lock().await = true;

                self.miner_info.write().await.sid = Some(sub_info.id());

                //2. Send the miner Subsription ID aka SubscribeResult response. save that the miner is
                //   subcribed
                self.send_response(
                    StratumMethod::Subscribe,
                    PoolParam::SubscribeResult(sub_info),
                )
                .await?;

                //3. Send the miner Set Difficulty and save it internally
                self.set_difficulty(*self.difficulty.lock().await).await?;

                //4. Send the miner the current work
                self.send_initial_work().await?;
            }
            Err(e) => {
                self.send_error(StratumMethod::Subscribe, e).await?;
            }
        }

        Ok(())
    }

    //This function sets the difficulty for this connection, and sends a set difficulty message to
    //the client.
    async fn set_difficulty(&self, difficulty: f64) -> Result<()> {
        self.send_request(
            StratumMethod::SetDifficulty,
            PoolParam::SetDifficulty(difficulty),
        )
        .await?;

        Ok(())
    }

    //Can probably not send avg here either.
    async fn retarget(&self, avg: f64, stats: &mut JobStats) -> Result<()> {
        // let mut stats = self.job_stats.lock().await;

        let mut new_difficulty = stats.current_difficulty * (self.options.target_time / avg);

        let delta = (new_difficulty - stats.current_difficulty).abs();

        if delta > self.options.max_delta {
            if new_difficulty > stats.current_difficulty {
                //@smells come back here later.
                new_difficulty = new_difficulty - (delta - self.options.max_delta);
            } else if new_difficulty < stats.current_difficulty {
                new_difficulty = new_difficulty + (delta - self.options.max_delta);
            }
        }

        if new_difficulty < self.options.min_diff {
            new_difficulty = self.options.min_diff;
        } else if new_difficulty > stats.job_difficulty {
            new_difficulty = stats.job_difficulty;
        }

        if new_difficulty < stats.current_difficulty || new_difficulty > stats.current_difficulty {
            stats.last_retarget = Utc::now().timestamp();

            //Clear some of the stats.
            stats.times = Vec::new();
            stats.current_difficulty = new_difficulty;
            let job_stats = MinerJobStats {
                expected_difficulty: new_difficulty,
            };
            self.miner_info.write().await.job_stats = Some(job_stats);

            self.set_difficulty(stats.current_difficulty).await?;
        }

        Ok(())
    }

    //Unimplemented - Probably just log the value, and see what's going on.
    //Make a handle_unknown function that exists in stratum manager - then the pool can decide what
    //to do.
    pub async fn handle_unknown(&self, _msg: &serde_json::Value) -> Result<()> {
        Ok(())
    }
}