-
Notifications
You must be signed in to change notification settings - Fork 32
/
StratumSession.go
1607 lines (1339 loc) · 46 KB
/
StratumSession.go
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
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package main
import (
"bufio"
"encoding/json"
"errors"
"fmt"
"net"
"strconv"
"strings"
"sync"
"sync/atomic"
"time"
"github.com/golang/glog"
"github.com/samuel/go-zookeeper/zk"
)
// BTCAgent的客户端类型前缀
const btcAgentClientTypePrefix = "btccom-agent/"
// NiceHash的客户端类型前缀
const niceHashClientTypePrefix = "nicehash/"
// NiceHash Ethereum Stratum Protocol 的协议类型前缀
const ethereumStratumNiceHashPrefix = "ethereumstratum/"
// 响应中使用的 NiceHash Ethereum Stratum Protocol 的版本
const ethereumStratumNiceHashVersion = "EthereumStratum/1.0.0"
// 发送给sserver的ETHProxy协议版本字符串
const ethproxyVersion = "ETHProxy/1.0.0"
// BTCAgent的ex-message的magic number
const btcAgentExMessageMagicNumber = 0x7F
// 协议检测超时时间
const protocolDetectTimeoutSeconds = 15
// 矿工名获取超时时间
const findWorkerNameTimeoutSeconds = 60
// 服务器响应subscribe、authorize等消息的超时时间
const readServerResponseTimeoutSeconds = 10
// 纯代理模式下接收消息的超时时间
// 若长时间接收不到消息,就无法及时处理对端已断开事件,
// 因此设置接收超时时间,每隔一定时间就放弃接收,检查状态,并重新开始接收
const receiveMessageTimeoutSeconds = 15
// 服务器断开连接时的重试次数
const retryTimeWhenServerDown = 10
// 创建的 bufio Reader 的 buffer 大小
const bufioReaderBufSize = 128
// ProtocolType 代理的协议类型
type ProtocolType uint8
const (
// ProtocolBitcoinStratum 比特币Stratum协议
ProtocolBitcoinStratum ProtocolType = iota
// ProtocolEthereumStratum 以太坊普通Stratum协议
ProtocolEthereumStratum
// ProtocolEthereumStratumNiceHash NiceHash建议的以太坊Stratum协议
ProtocolEthereumStratumNiceHash
// ProtocolEthereumProxy EthProxy软件实现的以太坊Stratum协议
ProtocolEthereumProxy
// ProtocolUnknown 未知协议(无法处理)
ProtocolUnknown
)
// RunningStat 运行状态
type RunningStat uint8
const (
// StatRunning 正在运行
StatRunning RunningStat = iota
// StatStoped 已停止
StatStoped RunningStat = iota
// StatReconnecting 正在重连服务器
StatReconnecting RunningStat = iota
)
// AuthorizeStat 认证状态
type AuthorizeStat uint8
const (
// StatConnected 已连接(默认状态)
StatConnected AuthorizeStat = iota
// StatSubScribed 已订阅
StatSubScribed
// StatAuthorized 已认证
StatAuthorized
)
// StratumSession 是一个 Stratum 会话,包含了到客户端和到服务端的连接及状态信息
type StratumSession struct {
// 会话管理器
manager *StratumSessionManager
// Stratum协议类型
protocolType ProtocolType
// 是否为BTCAgent
isBTCAgent bool
// 是否为NiceHash客户端
isNiceHashClient bool
// JSON-RPC的版本
jsonRPCVersion int
// 比特币版本掩码(用于AsicBoost)
versionMask uint32
// 是否在运行
runningStat RunningStat
// 服务器重连计数器
reconnectCounter uint32
// 改变runningStat和switchCoinCount时要加的锁
lock sync.Mutex
clientConn net.Conn
clientReader *bufio.Reader
// 客户端IP地址及端口
clientIPPort string
serverConn net.Conn
serverReader *bufio.Reader
// sessionID 会话ID,也做为矿机挖矿时的 Extranonce1
sessionID uint32
sessionIDString string
fullWorkerName string // 完整的矿工名
subaccountName string // 子账户名部分
minerNameWithDot string // 矿机名部分(包含前导“.”)
stratumSubscribeRequest *JSONRPCRequest
stratumAuthorizeRequest *JSONRPCRequest
// 用户所挖的币种
miningCoin string
// 监控的Zookeeper路径
zkWatchPath string
// 监控的Zookeeper事件
zkWatchEvent <-chan zk.Event
}
// NewStratumSession 创建一个新的 Stratum 会话
func NewStratumSession(manager *StratumSessionManager, clientConn net.Conn, sessionID uint32) (session *StratumSession) {
session = new(StratumSession)
session.jsonRPCVersion = 1
session.runningStat = StatStoped
session.manager = manager
session.sessionID = sessionID
session.clientConn = clientConn
session.clientReader = bufio.NewReaderSize(clientConn, bufioReaderBufSize)
session.clientIPPort = clientConn.RemoteAddr().String()
switch manager.chainType {
case ChainTypeBitcoin:
session.sessionIDString = Uint32ToHex(session.sessionID)
case ChainTypeDecredNormal:
// reversed 12 bytes
session.sessionIDString = "0000000000000000" + Uint32ToHexLE(session.sessionID)
case ChainTypeDecredGoMiner:
// reversed 4 bytes
session.sessionIDString = Uint32ToHexLE(session.sessionID)
case ChainTypeEthereum:
// Ethereum uses 24 bit session id
session.sessionIDString = Uint32ToHex(session.sessionID)[2:8]
}
if glog.V(3) {
glog.Info("IP: ", session.clientIPPort, ", Session ID: ", session.sessionIDString)
}
return
}
// IsRunning 检查会话是否在运行(线程安全)
func (session *StratumSession) IsRunning() bool {
session.lock.Lock()
defer session.lock.Unlock()
return session.runningStat != StatStoped
}
// setStat 设置会话状态(线程安全)
func (session *StratumSession) setStat(stat RunningStat) {
session.lock.Lock()
session.runningStat = stat
session.lock.Unlock()
}
// setStatNonLock 设置会话状态(
func (session *StratumSession) setStatNonLock(stat RunningStat) {
session.runningStat = stat
}
// getStat 获取会话状态(线程安全)
func (session *StratumSession) getStat() RunningStat {
session.lock.Lock()
defer session.lock.Unlock()
return session.runningStat
}
// getStatNonLock 获取会话状态(无锁,非线程安全,用于在已加锁函数内部调用)
func (session *StratumSession) getStatNonLock() RunningStat {
return session.runningStat
}
// getReconnectCounter 获取币种切换计数(线程安全)
func (session *StratumSession) getReconnectCounter() uint32 {
session.lock.Lock()
defer session.lock.Unlock()
return session.reconnectCounter
}
// Run 启动一个 Stratum 会话
func (session *StratumSession) Run() {
session.lock.Lock()
if session.runningStat != StatStoped {
session.lock.Unlock()
return
}
session.runningStat = StatRunning
session.lock.Unlock()
session.protocolType = session.protocolDetect()
// 其实目前只有一种协议,即Stratum协议
// BTCAgent在认证完成之前走的也是Stratum协议
if session.protocolType == ProtocolUnknown {
session.Stop()
return
}
session.runProxyStratum()
}
// Resume 恢复一个Stratum会话
func (session *StratumSession) Resume(sessionData StratumSessionData, serverConn net.Conn) {
session.lock.Lock()
if session.runningStat != StatStoped {
session.lock.Unlock()
return
}
session.runningStat = StatRunning
session.lock.Unlock()
// 设置默认协议
session.protocolType = session.getDefaultStratumProtocol()
// 恢复服务器连接
session.serverConn = serverConn
session.serverReader = bufio.NewReaderSize(serverConn, bufioReaderBufSize)
stat := StatConnected
// 恢复版本位
session.versionMask = sessionData.VersionMask
if sessionData.StratumSubscribeRequest != nil {
_, stratumErr := session.stratumHandleRequest(sessionData.StratumSubscribeRequest, &stat)
if stratumErr != nil {
glog.Error("Resume session ", session.clientIPPort, " failed: ", stratumErr)
session.Stop()
return
}
}
if sessionData.StratumAuthorizeRequest != nil {
_, stratumErr := session.stratumHandleRequest(sessionData.StratumAuthorizeRequest, &stat)
if stratumErr != nil {
glog.Error("Resume session ", session.clientIPPort, " failed: ", stratumErr)
session.Stop()
return
}
}
if stat != StatAuthorized {
glog.Error("Resume session ", session.clientIPPort, " failed: stat should be StatAuthorized, but is ", stat)
session.Stop()
return
}
err := session.findMiningCoin(false)
if err != nil {
glog.Error("Resume session ", session.clientIPPort, " failed: ", err)
session.Stop()
return
}
if session.miningCoin != sessionData.MiningCoin {
glog.Error("Resume session ", session.clientIPPort, " failed: mining coin changed: ",
sessionData.MiningCoin, " -> ", session.miningCoin)
session.Stop()
return
}
glog.Info("Resume Session Success: ", session.clientIPPort, "; ", session.fullWorkerName, "; ", session.miningCoin)
// 此后转入纯代理模式
session.proxyStratum()
}
// Stop 停止一个 Stratum 会话
func (session *StratumSession) Stop() {
session.lock.Lock()
if session.runningStat == StatStoped {
session.lock.Unlock()
return
}
session.runningStat = StatStoped
session.lock.Unlock()
if session.serverConn != nil {
session.serverConn.Close()
}
if session.clientConn != nil {
session.clientConn.Close()
}
session.manager.ReleaseStratumSession(session)
session.manager = nil
if glog.V(2) {
glog.Info("Session Stoped: ", session.clientIPPort, "; ", session.fullWorkerName, "; ", session.miningCoin)
}
}
func (session *StratumSession) protocolDetect() ProtocolType {
magicNumber, err := session.peekFromClientWithTimeout(1, protocolDetectTimeoutSeconds*time.Second)
if err != nil {
glog.Warning("read failed: ", err)
return ProtocolUnknown
}
// 从客户端收到的第一个报文一定是Stratum协议的JSON字符串。
// BTC Agent在subscribe和authorize阶段发送的是标准Stratum协议JSON字符串,
// 只有在authorize完成之后才可能出现ex-message。
//
// 这也就是说,一方面,BTC Agent可以和普通矿机共享连接和认证流程,
// 另一方面,我们无法在最开始就检测出客户端是BTC Agent,我们要随时做好收到ex-message的准备。
if magicNumber[0] != '{' {
glog.Warning("Unknown Protocol")
return ProtocolUnknown
}
if glog.V(3) {
glog.Info("Found Stratum Protocol")
}
return session.getDefaultStratumProtocol()
}
func (session *StratumSession) getDefaultStratumProtocol() ProtocolType {
switch session.manager.chainType {
case ChainTypeBitcoin:
fallthrough
case ChainTypeDecredNormal:
fallthrough
case ChainTypeDecredGoMiner:
// DCR使用与比特币几乎完全相同的协议
return ProtocolBitcoinStratum
case ChainTypeEthereum:
// This is the default protocol. The protocol may change after further detection.
// The difference between ProtocolEthereumProxy and the other two Ethereum protocols is that
// ProtocolEthereumProxy is no "mining.subscribe" phase, so it is set as default to simplify the detection.
return ProtocolEthereumProxy
default:
return ProtocolUnknown
}
}
func (session *StratumSession) runProxyStratum() {
var err error
err = session.stratumFindWorkerName()
if err != nil {
session.Stop()
return
}
err = session.findMiningCoin(session.manager.enableUserAutoReg)
if err != nil {
session.Stop()
return
}
err = session.connectStratumServer()
if err != nil {
session.Stop()
return
}
// 此后转入纯代理模式
session.proxyStratum()
}
func (session *StratumSession) parseSubscribeRequest(request *JSONRPCRequest) (result interface{}, err *StratumError) {
// 保存原始订阅请求以便转发给Stratum服务器
session.stratumSubscribeRequest = request
// 生成响应
switch session.manager.chainType {
case ChainTypeBitcoin:
fallthrough
case ChainTypeDecredNormal:
fallthrough
case ChainTypeDecredGoMiner:
if len(request.Params) >= 1 {
userAgent, ok := session.stratumSubscribeRequest.Params[0].(string)
// 判断是否为BTCAgent
if ok && strings.HasPrefix(strings.ToLower(userAgent), btcAgentClientTypePrefix) {
session.isBTCAgent = true
}
}
result = JSONRPCArray{JSONRPCArray{JSONRPCArray{"mining.set_difficulty", session.sessionIDString}, JSONRPCArray{"mining.notify", session.sessionIDString}}, session.sessionIDString, 8}
return
case ChainTypeEthereum:
// only ProtocolEthereumStratum and ProtocolEthereumStratumNiceHash has the "mining.subscribe" phase
session.protocolType = ProtocolEthereumStratum
if len(request.Params) >= 1 {
userAgent, ok := session.stratumSubscribeRequest.Params[0].(string)
if ok {
// 判断是否为NiceHash客户端
if strings.HasPrefix(strings.ToLower(userAgent), niceHashClientTypePrefix) {
session.isNiceHashClient = true
}
// 判断是否为BTCAgent
if strings.HasPrefix(strings.ToLower(userAgent), btcAgentClientTypePrefix) {
session.isBTCAgent = true
session.protocolType = ProtocolEthereumStratumNiceHash
}
}
}
if len(request.Params) >= 2 {
// message example: {"id":1,"method":"mining.subscribe","params":["ethminer 0.15.0rc1","EthereumStratum/1.0.0"]}
protocol, ok := session.stratumSubscribeRequest.Params[1].(string)
// 判断是否为"EthereumStratum/xxx"
if ok && strings.HasPrefix(strings.ToLower(protocol), ethereumStratumNiceHashPrefix) {
session.protocolType = ProtocolEthereumStratumNiceHash
}
}
result = true
if session.protocolType == ProtocolEthereumStratumNiceHash {
extraNonce := session.sessionIDString
if session.isNiceHashClient {
// NiceHash以太坊客户端目前仅支持不超过2字节的ExtraNonce
extraNonce = extraNonce[0:4]
}
// message example: {"id":1,"jsonrpc":"2.0","result":[["mining.notify","01003f","EthereumStratum/1.0.0"],"01003f"],"error":null}
result = JSONRPCArray{JSONRPCArray{"mining.notify", session.sessionIDString, ethereumStratumNiceHashVersion}, extraNonce}
}
return
default:
glog.Fatal("Unknown Chain Type: ", session.manager.chainType)
err = StratumErrUnknownChainType
return
}
}
func (session *StratumSession) makeSubscribeMessageForEthProxy() {
// 为ETHProxy协议生成一个订阅请求
// 该订阅请求是为了向sserver发送session id、矿机IP等需要而创建的
session.stratumSubscribeRequest = new(JSONRPCRequest)
session.stratumSubscribeRequest.Method = "mining.subscribe"
session.stratumSubscribeRequest.SetParam("ETHProxy", ethproxyVersion)
}
func (session *StratumSession) parseAuthorizeRequest(request *JSONRPCRequest) (result interface{}, err *StratumError) {
// 保存原始请求以便转发给Stratum服务器
session.stratumAuthorizeRequest = request
// STRATUM / NICEHASH_STRATUM: {"id":3, "method":"mining.authorize", "params":["test.aaa", "x"]}
// ETH_PROXY (Claymore): {"worker": "eth1.0", "jsonrpc": "2.0", "params": ["0x00d8c82Eb65124Ea3452CaC59B64aCC230AA3482.test.aaa", "x"], "id": 2, "method": "eth_submitLogin"}
// ETH_PROXY (EthMiner, situation 1): {"id":1, "method":"eth_submitLogin", "params":["0x00d8c82Eb65124Ea3452CaC59B64aCC230AA3482"], "worker":"test.aaa"}
// ETH_PROXY (EthMiner, situation 2): {"id":1, "method":"eth_submitLogin", "params":["test"], "worker":"aaa"}
if len(request.Params) < 1 {
err = StratumErrTooFewParams
return
}
fullWorkerName, ok := request.Params[0].(string)
if !ok {
err = StratumErrWorkerNameMustBeString
return
}
// 矿工名
session.fullWorkerName = FilterWorkerName(fullWorkerName)
// 以太坊矿工名中可能包含钱包地址,且矿工名本身可能位于附加的worker字段
if session.protocolType != ProtocolBitcoinStratum {
if request.Worker != "" {
session.fullWorkerName += "." + FilterWorkerName(request.Worker)
}
session.fullWorkerName = StripEthAddrFromFullName(session.fullWorkerName)
}
if strings.Contains(session.fullWorkerName, ".") {
// 截取“.”之前的做为子账户名,“.”及之后的做矿机名
pos := strings.Index(session.fullWorkerName, ".")
session.subaccountName = session.manager.GetRegularSubaccountName(session.fullWorkerName[:pos])
session.minerNameWithDot = session.fullWorkerName[pos:]
session.fullWorkerName = session.subaccountName + session.minerNameWithDot
} else {
session.subaccountName = session.manager.GetRegularSubaccountName(session.fullWorkerName)
session.minerNameWithDot = ""
session.fullWorkerName = session.subaccountName
}
if len(session.subaccountName) < 1 {
err = StratumErrWorkerNameStartWrong
return
}
// 获取矿机名成功,但此处不需要返回内容给矿机
// 连接服务器后会将服务器发送的响应返回给矿机
result = nil
err = nil
return
}
func (session *StratumSession) parseConfigureRequest(request *JSONRPCRequest) (result interface{}, err *StratumError) {
// request:
// {"id":3,"method":"mining.configure","params":[["version-rolling"],{"version-rolling.mask":"1fffe000","version-rolling.min-bit-count":2}]}
// response:
// {"id":3,"result":{"version-rolling":true,"version-rolling.mask":"1fffe000"},"error":null}
// {"id":null,"method":"mining.set_version_mask","params":["1fffe000"]}
if len(request.Params) < 2 {
err = StratumErrTooFewParams
return
}
if options, ok := request.Params[1].(map[string]interface{}); ok {
if versionMaskI, ok := options["version-rolling.mask"]; ok {
if versionMaskStr, ok := versionMaskI.(string); ok {
versionMask, err := strconv.ParseUint(versionMaskStr, 16, 32)
if err == nil {
session.versionMask = uint32(versionMask)
}
}
}
}
if session.versionMask != 0 {
// 这里响应的是虚假的版本掩码。在连接服务器后将通过 mining.set_version_mask
// 更新为真实的版本掩码。
result = JSONRPCObj{
"version-rolling": true,
"version-rolling.mask": session.getVersionMaskStr()}
return
}
// 未知配置内容,不响应
return
}
func (session *StratumSession) stratumHandleRequest(request *JSONRPCRequest, stat *AuthorizeStat) (result interface{}, err *StratumError) {
switch request.Method {
case "mining.subscribe":
if *stat != StatConnected {
err = StratumErrDuplicateSubscribed
return
}
result, err = session.parseSubscribeRequest(request)
if err == nil {
*stat = StatSubScribed
}
return
case "eth_submitLogin":
if session.protocolType == ProtocolEthereumProxy {
session.makeSubscribeMessageForEthProxy()
*stat = StatSubScribed
// ETHProxy uses JSON-RPC 2.0
session.jsonRPCVersion = 2
}
fallthrough
case "mining.authorize":
if *stat != StatSubScribed {
err = StratumErrNeedSubscribed
return
}
result, err = session.parseAuthorizeRequest(request)
if err == nil {
*stat = StatAuthorized
}
return
case "mining.configure":
if session.protocolType == ProtocolBitcoinStratum {
result, err = session.parseConfigureRequest(request)
}
return
default:
// ignore unimplemented methods
return
}
}
func (session *StratumSession) stratumFindWorkerName() error {
e := make(chan error, 1)
go func() {
defer close(e)
response := new(JSONRPCResponse)
stat := StatConnected
// 循环结束说明认证成功
for stat != StatAuthorized {
requestJSON, err := session.clientReader.ReadBytes('\n')
if err != nil {
e <- errors.New("read line failed: " + err.Error())
return
}
request, err := NewJSONRPCRequest(requestJSON)
// ignore the json decode error
if err != nil {
if glog.V(3) {
glog.Info("JSON decode failed: ", err.Error(), string(requestJSON))
}
continue
}
// stat will be changed in stratumHandleRequest
result, stratumErr := session.stratumHandleRequest(request, &stat)
// 两个均为空说明没有想要返回的响应
if result != nil || stratumErr != nil {
response.ID = request.ID
response.Result = result
response.Error = stratumErr.ToJSONRPCArray(session.manager.serverID)
_, err = session.writeJSONResponseToClient(response)
if err != nil {
e <- errors.New("Write JSON Response Failed: " + err.Error())
return
}
}
} // for
// 发送一个空错误表示成功
e <- nil
return
}()
select {
case err := <-e:
if err != nil {
glog.Warning(err)
return err
}
if glog.V(2) {
glog.Info("FindWorkerName Success: ", session.fullWorkerName)
}
return nil
case <-time.After(findWorkerNameTimeoutSeconds * time.Second):
glog.Warning("FindWorkerName Timeout")
return errors.New("FindWorkerName Timeout")
}
}
func (session *StratumSession) findMiningCoin(autoReg bool) error {
// 从zookeeper读取用户想挖的币种
session.zkWatchPath = session.manager.zookeeperSwitcherWatchDir + session.subaccountName
data, event, err := session.manager.zookeeperManager.GetW(session.zkWatchPath, session.sessionID)
if err != nil {
if autoReg {
return session.tryAutoReg()
}
if glog.V(3) {
glog.Info("FindMiningCoin Failed: " + session.zkWatchPath + "; " + err.Error())
}
var response JSONRPCResponse
response.Error = NewStratumError(201, "Invalid Sub-account Name").ToJSONRPCArray(session.manager.serverID)
if session.stratumAuthorizeRequest != nil {
response.ID = session.stratumAuthorizeRequest.ID
}
session.writeJSONResponseToClient(&response)
return err
}
session.miningCoin = string(data)
session.zkWatchEvent = event
return nil
}
func (session *StratumSession) tryAutoReg() error {
glog.Info("Try to auto register sub-account, worker: ", session.fullWorkerName)
autoRegWatchPath := session.manager.zookeeperAutoRegWatchDir + session.subaccountName
_, event, err := session.manager.zookeeperManager.GetW(autoRegWatchPath, session.sessionID)
if err != nil {
// 检查自动注册等待人数是否超限
if atomic.LoadInt64(&session.manager.autoRegAllowUsers) < 1 {
glog.Warning("Too much pending auto reg request. worker: ", session.fullWorkerName)
return ErrTooMuchPendingAutoRegReq
}
// 没有加锁,大并发时允许短暂的超过上限。减小到负值是安全的
atomic.AddInt64(&session.manager.autoRegAllowUsers, -1)
defer atomic.AddInt64(&session.manager.autoRegAllowUsers, 1)
//--------- 提交全新的自动注册请求 ---------
type autoRegInfo struct {
SessionID uint32
Worker string
}
data := autoRegInfo{session.sessionID, session.fullWorkerName}
jsonBytes, _ := json.Marshal(data)
createErr := session.manager.zookeeperManager.Create(autoRegWatchPath, jsonBytes)
_, event, err = session.manager.zookeeperManager.GetW(autoRegWatchPath, session.sessionID)
if err != nil {
if createErr != nil {
glog.Error("Create auto register key failed, worker: ", session.fullWorkerName, ", errmsg: ", createErr)
} else {
glog.Info("Sub-account auto register failed, worker: ", session.fullWorkerName, ", errmsg: ", err)
}
return err
}
}
// waiting for register finished for remote process
<-event
return session.findMiningCoin(false)
}
func (session *StratumSession) connectStratumServer() error {
// 获取当前运行状态
runningStat := session.getStatNonLock()
// 寻找币种对应的服务器
serverInfo, ok := session.manager.stratumServerInfoMap[session.miningCoin]
var rpcID interface{}
if session.stratumAuthorizeRequest != nil {
rpcID = session.stratumAuthorizeRequest.ID
}
// 对应的服务器不存在
if !ok {
glog.Error("Stratum Server Not Found: ", session.miningCoin)
if runningStat != StatReconnecting {
response := JSONRPCResponse{rpcID, nil, StratumErrStratumServerNotFound.ToJSONRPCArray(session.manager.serverID)}
session.writeJSONResponseToClient(&response)
}
return StratumErrStratumServerNotFound
}
// 连接服务器
serverConn, err := net.Dial("tcp", serverInfo.URL)
if err != nil {
glog.Error("Connect Stratum Server Failed: ", session.miningCoin, "; ", serverInfo.URL, "; ", err)
if runningStat != StatReconnecting {
response := JSONRPCResponse{rpcID, nil, StratumErrConnectStratumServerFailed.ToJSONRPCArray(session.manager.serverID)}
session.writeJSONResponseToClient(&response)
}
return StratumErrConnectStratumServerFailed
}
if glog.V(3) {
glog.Info("Connect Stratum Server Success: ", session.miningCoin, "; ", serverInfo.URL)
}
session.serverConn = serverConn
session.serverReader = bufio.NewReaderSize(serverConn, bufioReaderBufSize)
return session.serverSubscribeAndAuthorize()
}
// 发送 mining.configure
func (session *StratumSession) sendMiningConfigureToServer() (err error) {
if session.versionMask == 0 {
return
}
// 请求 version mask
request := JSONRPCRequest{
"configure",
"mining.configure",
JSONRPCArray{
JSONRPCArray{"version-rolling"},
JSONRPCObj{"version-rolling.mask": session.getVersionMaskStr()}},
""}
_, err = session.writeJSONRequestToServer(&request)
return
}
// 发送 mining.subscribe
func (session *StratumSession) sendMiningSubscribeToServer() (userAgent string, protocol string, err error) {
userAgent = "stratumSwitcher"
protocol = "Stratum"
// 拷贝一个对象
request := session.stratumSubscribeRequest
request.ID = "subscribe"
// 发送订阅消息给服务器
switch session.protocolType {
case ProtocolBitcoinStratum:
// 为请求添加sessionID
// API格式:mining.subscribe("user agent/version", "extranonce1")
// <https://en.bitcoin.it/wiki/Stratum_mining_protocol>
// 获取原始的参数1(user agent)
if len(session.stratumSubscribeRequest.Params) >= 1 {
userAgent, _ = session.stratumSubscribeRequest.Params[0].(string)
}
if glog.V(3) {
glog.Info("UserAgent: ", userAgent)
}
// 为了保证Web侧“最近提交IP”显示正确,将矿机的IP做为第三个参数传递给Stratum Server
clientIP := session.clientIPPort[:strings.LastIndex(session.clientIPPort, ":")]
clientIPLong := IP2Long(clientIP)
// 不直接使用 session.sessionIDString,因为在DCR币种里,它已经进行了填充和字节序颠倒。
sessionIDString := Uint32ToHex(session.sessionID)
session.stratumSubscribeRequest.SetParam(userAgent, sessionIDString, clientIPLong)
case ProtocolEthereumStratum:
fallthrough
case ProtocolEthereumStratumNiceHash:
fallthrough
case ProtocolEthereumProxy:
// 获取原始的参数1(user agent)和参数2(protocol,可能存在)
if len(session.stratumSubscribeRequest.Params) >= 1 {
userAgent, _ = session.stratumSubscribeRequest.Params[0].(string)
}
if len(session.stratumSubscribeRequest.Params) >= 2 {
protocol, _ = session.stratumSubscribeRequest.Params[1].(string)
}
if glog.V(3) {
glog.Info("UserAgent: ", userAgent, "; Protocol: ", protocol)
}
clientIP := session.clientIPPort[:strings.LastIndex(session.clientIPPort, ":")]
clientIPLong := IP2Long(clientIP)
// Session ID 做为第三个参数传递
// 矿机IP做为第四个参数传递
session.stratumSubscribeRequest.SetParam(userAgent, protocol, session.sessionIDString, clientIPLong)
default:
glog.Fatal("Unimplemented Stratum Protocol: ", session.protocolType)
err = ErrParseSubscribeResponseFailed
return
}
// 发送mining.subscribe请求给服务器
// sessionID已包含在其中,一并发送给服务器
_, err = session.writeJSONRequestToServer(session.stratumSubscribeRequest)
if err != nil {
glog.Warning("Write Subscribe Request Failed: ", err)
}
return
}
// 获取认证时添加的子账户名后缀
func (session *StratumSession) getUserSuffix() string {
serverInfo, ok := session.manager.stratumServerInfoMap[session.miningCoin]
if !ok {
return session.miningCoin
}
return serverInfo.UserSuffix
}
// 发送 mining.subscribe
func (session *StratumSession) sendMiningAuthorizeToServer(withSuffix bool) (authWorkerName string, authWorkerPasswd string, err error) {
if withSuffix {
// 带币种后缀的矿机名
authWorkerName = session.subaccountName + "_" + session.getUserSuffix() + session.minerNameWithDot
} else {
// 无币种后缀的矿工名
authWorkerName = session.fullWorkerName
}
var request JSONRPCRequest
request.Method = session.stratumAuthorizeRequest.Method
request.Params = make([]interface{}, len(session.stratumAuthorizeRequest.Params))
// 深拷贝,防止这里参数的更改影响到session.stratumAuthorizeRequest的内容
copy(request.Params, session.stratumAuthorizeRequest.Params)
// 矿机发来的密码,仅用于返回
if len(request.Params) >= 2 {
authWorkerPasswd, _ = request.Params[1].(string)
}
// 设置为无币种后缀的矿工名
request.Params[0] = authWorkerName
request.ID = "auth"
// 发送mining.authorize请求给服务器
_, err = session.writeJSONRequestToServer(&request)
return
}
func (session *StratumSession) serverSubscribeAndAuthorize() (err error) {
// 发送请求
err = session.sendMiningConfigureToServer()
if err != nil {
return
}
userAgent, protocol, err := session.sendMiningSubscribeToServer()
if err != nil {
return
}
authWorkerName, authWorkerPasswd, err := session.sendMiningAuthorizeToServer(false)
if err != nil {
return
}
// 接收响应
e := make(chan error, 1)
go func() {
defer close(e)
var err error
var allowedVersionMask uint32
var authResponse JSONRPCResponse
authMsgCounter := 0
authSuccess := false
// 循环结束说明认证完成
for authMsgCounter < 2 {
json, err := session.serverReader.ReadBytes('\n')
if err != nil {
e <- errors.New("read line failed: " + err.Error())
return
}
// 服务器返回的JSON RPC响应
response, err := NewJSONRPCResponse(json)
// JSON解析在类型完全不匹配时也不会失败。ID为空说明是notify
if err == nil && response.ID != nil {
err = session.stratumHandleServerResponse(response, &authMsgCounter, &authSuccess, &authResponse)
if err != nil {
e <- err
return
}
// 首次认证(无币种后缀)不成功,发送第二次认证请求(带币种后缀)
if !authSuccess && authMsgCounter == 1 {
authWorkerName, authWorkerPasswd, err = session.sendMiningAuthorizeToServer(true)
if err != nil {
e <- err
return
}
}
continue
}
if err != nil && glog.V(3) {
glog.Info("JSON RPC Response decode failed: ", err.Error(), string(json))
}