-
Notifications
You must be signed in to change notification settings - Fork 0
/
reactor.go
654 lines (578 loc) · 16.5 KB
/
reactor.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
package mempool
import (
"bytes"
"fmt"
"math"
"reflect"
"sync"
"time"
"github.com/ethereum/go-ethereum/common"
abci "github.com/furyaxyz/fuxchain/libs/tendermint/abci/types"
cfg "github.com/furyaxyz/fuxchain/libs/tendermint/config"
"github.com/furyaxyz/fuxchain/libs/tendermint/libs/clist"
"github.com/furyaxyz/fuxchain/libs/tendermint/libs/log"
"github.com/furyaxyz/fuxchain/libs/tendermint/p2p"
"github.com/furyaxyz/fuxchain/libs/tendermint/types"
"github.com/tendermint/go-amino"
)
const (
MempoolChannel = byte(0x30)
aminoOverheadForTxMessage = 8
peerCatchupSleepIntervalMS = 100 // If peer is behind, sleep this amount
// UnknownPeerID is the peer ID to use when running CheckTx when there is
// no peer (e.g. RPC)
UnknownPeerID uint16 = 0
maxActiveIDs = math.MaxUint16
)
// Reactor handles mempool tx broadcasting amongst peers.
// It maintains a map from peer ID to counter, to prevent gossiping txs to the
// peers you received it from.
type Reactor struct {
p2p.BaseReactor
config *cfg.MempoolConfig
mempool *CListMempool
ids *mempoolIDs
nodeKey *p2p.NodeKey
nodeKeyWhitelist map[string]struct{}
enableWtx bool
}
func (memR *Reactor) SetNodeKey(key *p2p.NodeKey) {
memR.nodeKey = key
}
type mempoolIDs struct {
mtx sync.RWMutex
peerMap map[p2p.ID]uint16
nextID uint16 // assumes that a node will never have over 65536 active peers
activeIDs map[uint16]struct{} // used to check if a given peerID key is used, the value doesn't matter
}
// Reserve searches for the next unused ID and assigns it to the
// peer.
func (ids *mempoolIDs) ReserveForPeer(peer p2p.Peer) {
ids.mtx.Lock()
defer ids.mtx.Unlock()
curID := ids.nextPeerID()
ids.peerMap[peer.ID()] = curID
ids.activeIDs[curID] = struct{}{}
}
// nextPeerID returns the next unused peer ID to use.
// This assumes that ids's mutex is already locked.
func (ids *mempoolIDs) nextPeerID() uint16 {
if len(ids.activeIDs) == maxActiveIDs {
panic(fmt.Sprintf("node has maximum %d active IDs and wanted to get one more", maxActiveIDs))
}
_, idExists := ids.activeIDs[ids.nextID]
for idExists {
ids.nextID++
_, idExists = ids.activeIDs[ids.nextID]
}
curID := ids.nextID
ids.nextID++
return curID
}
// Reclaim returns the ID reserved for the peer back to unused pool.
func (ids *mempoolIDs) Reclaim(peer p2p.Peer) {
ids.mtx.Lock()
defer ids.mtx.Unlock()
removedID, ok := ids.peerMap[peer.ID()]
if ok {
delete(ids.activeIDs, removedID)
delete(ids.peerMap, peer.ID())
}
}
// GetForPeer returns an ID reserved for the peer.
func (ids *mempoolIDs) GetForPeer(peer p2p.Peer) uint16 {
ids.mtx.RLock()
defer ids.mtx.RUnlock()
return ids.peerMap[peer.ID()]
}
func newMempoolIDs() *mempoolIDs {
return &mempoolIDs{
peerMap: make(map[p2p.ID]uint16),
activeIDs: map[uint16]struct{}{0: {}},
nextID: 1, // reserve unknownPeerID(0) for mempoolReactor.BroadcastTx
}
}
// NewReactor returns a new Reactor with the given config and mempool.
func NewReactor(config *cfg.MempoolConfig, mempool *CListMempool) *Reactor {
memR := &Reactor{
config: config,
mempool: mempool,
ids: newMempoolIDs(),
nodeKeyWhitelist: make(map[string]struct{}),
enableWtx: cfg.DynamicConfig.GetEnableWtx(),
}
for _, nodeKey := range config.GetNodeKeyWhitelist() {
memR.nodeKeyWhitelist[nodeKey] = struct{}{}
}
memR.BaseReactor = *p2p.NewBaseReactor("Mempool", memR)
memR.press()
return memR
}
// InitPeer implements Reactor by creating a state for the peer.
func (memR *Reactor) InitPeer(peer p2p.Peer) p2p.Peer {
memR.ids.ReserveForPeer(peer)
return peer
}
// SetLogger sets the Logger on the reactor and the underlying mempool.
func (memR *Reactor) SetLogger(l log.Logger) {
memR.Logger = l
memR.mempool.SetLogger(l)
}
// OnStart implements p2p.BaseReactor.
func (memR *Reactor) OnStart() error {
if !memR.config.Broadcast {
memR.Logger.Info("Tx broadcasting is disabled")
}
return nil
}
// GetChannels implements Reactor.
// It returns the list of channels for this reactor.
func (memR *Reactor) GetChannels() []*p2p.ChannelDescriptor {
return []*p2p.ChannelDescriptor{
{
ID: MempoolChannel,
Priority: 5,
},
}
}
// AddPeer implements Reactor.
// It starts a broadcast routine ensuring all txs are forwarded to the given peer.
func (memR *Reactor) AddPeer(peer p2p.Peer) {
go memR.broadcastTxRoutine(peer)
}
// RemovePeer implements Reactor.
func (memR *Reactor) RemovePeer(peer p2p.Peer, reason interface{}) {
memR.ids.Reclaim(peer)
// broadcast routine checks if peer is gone and returns
}
// txMessageDecodePool is a sync.Pool of *TxMessage.
// memR.decodeMsg will call txMessageDeocdePool.Get, and memR.Receive will reset the Msg after use, then call txMessageDeocdePool.Put.
var txMessageDeocdePool = &sync.Pool{
New: func() interface{} {
return &TxMessage{}
},
}
var logParamsPool = &sync.Pool{
New: func() interface{} {
return &[6]interface{}{}
},
}
func (memR *Reactor) logReceive(peer p2p.Peer, chID byte, msg Message) {
logParams := logParamsPool.Get().(*[6]interface{})
logParams[0] = "src"
logParams[1] = peer
logParams[2] = "chId"
logParams[3] = chID
logParams[4] = "msg"
logParams[5] = msg
memR.Logger.Debug("Receive", logParams[:]...)
logParamsPool.Put(logParams)
}
var txIDStringerPool = &sync.Pool{
New: func() interface{} {
return &txIDStringer{}
},
}
func (memR *Reactor) logCheckTxError(tx []byte, height int64, err error) {
logParams := logParamsPool.Get().(*[6]interface{})
txStr := txIDStringerPool.Get().(*txIDStringer)
txStr.tx = tx
txStr.height = height
logParams[0] = "tx"
logParams[1] = txStr
logParams[2] = "err"
logParams[3] = err
memR.Logger.Info("Could not check tx", logParams[:4]...)
txIDStringerPool.Put(txStr)
logParamsPool.Put(logParams)
}
// Receive implements Reactor.
// It adds any received transactions to the mempool.
func (memR *Reactor) Receive(chID byte, src p2p.Peer, msgBytes []byte) {
if memR.mempool.config.Sealed {
return
}
msg, err := memR.decodeMsg(msgBytes)
if err != nil {
memR.Logger.Error("Error decoding message", "src", src, "chId", chID, "msg", msg, "err", err, "bytes", msgBytes)
memR.Switch.StopPeerForError(src, err)
return
}
memR.logReceive(src, chID, msg)
txInfo := TxInfo{SenderID: memR.ids.GetForPeer(src)}
if src != nil {
txInfo.SenderP2PID = src.ID()
}
var tx types.Tx
switch msg := msg.(type) {
case *TxMessage:
tx = msg.Tx
if _, isInWhiteList := memR.nodeKeyWhitelist[string(src.ID())]; isInWhiteList && msg.From != "" {
txInfo.from = msg.From
}
*msg = TxMessage{}
txMessageDeocdePool.Put(msg)
case *WtxMessage:
tx = msg.Wtx.Payload
if err := msg.Wtx.verify(memR.nodeKeyWhitelist); err != nil {
memR.Logger.Error("wtx.verify", "error", err, "txhash",
common.BytesToHash(types.Tx(msg.Wtx.Payload).Hash()),
)
} else {
txInfo.wtx = msg.Wtx
txInfo.checkType = abci.CheckTxType_WrappedCheck
}
// broadcasting happens from go routines per peer
default:
memR.Logger.Error(fmt.Sprintf("Unknown message type %v", reflect.TypeOf(msg)))
return
}
err = memR.mempool.CheckTx(tx, nil, txInfo)
if err != nil {
memR.logCheckTxError(tx, memR.mempool.height, err)
}
}
// PeerState describes the state of a peer.
type PeerState interface {
GetHeight() int64
}
// Send new mempool txs to peer.
func (memR *Reactor) broadcastTxRoutine(peer p2p.Peer) {
if !memR.config.Broadcast {
return
}
_, isInWhiteList := memR.nodeKeyWhitelist[string(peer.ID())]
peerID := memR.ids.GetForPeer(peer)
var next *clist.CElement
for {
// In case of both next.NextWaitChan() and peer.Quit() are variable at the same time
if !memR.IsRunning() || !peer.IsRunning() {
return
}
// This happens because the CElement we were looking at got garbage
// collected (removed). That is, .NextWait() returned nil. Go ahead and
// start from the beginning.
if next == nil {
select {
case <-memR.mempool.TxsWaitChan(): // Wait until a tx is available
if next = memR.mempool.BroadcastTxsFront(); next == nil {
continue
}
case <-peer.Quit():
return
case <-memR.Quit():
return
}
}
memTx := next.Value.(*mempoolTx)
// make sure the peer is up to date
peerState, ok := peer.Get(types.PeerStateKey).(PeerState)
if !ok {
// Peer does not have a state yet. We set it in the consensus reactor, but
// when we add peer in Switch, the order we call reactors#AddPeer is
// different every time due to us using a map. Sometimes other reactors
// will be initialized before the consensus reactor. We should wait a few
// milliseconds and retry.
time.Sleep(peerCatchupSleepIntervalMS * time.Millisecond)
continue
}
if peerState.GetHeight() < memTx.Height()-1 { // Allow for a lag of 1 block
time.Sleep(peerCatchupSleepIntervalMS * time.Millisecond)
continue
}
// ensure peer hasn't already sent us this tx
memTx.senderMtx.RLock()
_, ok = memTx.senders[peerID]
memTx.senderMtx.RUnlock()
if !ok {
var getFromPool bool
// send memTx
var msg Message
if memTx.nodeKey != nil && memTx.signature != nil {
msg = &WtxMessage{
Wtx: &WrappedTx{
Payload: memTx.tx,
From: memTx.from,
Signature: memTx.signature,
NodeKey: memTx.nodeKey,
},
}
} else if memR.enableWtx {
if wtx, err := memR.wrapTx(memTx.tx, memTx.from); err == nil {
msg = &WtxMessage{
Wtx: wtx,
}
}
} else {
txMsg := txMessageDeocdePool.Get().(*TxMessage)
txMsg.Tx = memTx.tx
if isInWhiteList {
txMsg.From = memTx.from
} else {
txMsg.From = ""
}
msg = txMsg
getFromPool = true
}
msgBz := memR.encodeMsg(msg)
if getFromPool {
getFromPool = false
txMessageDeocdePool.Put(msg)
}
success := peer.Send(MempoolChannel, msgBz)
if !success {
time.Sleep(peerCatchupSleepIntervalMS * time.Millisecond)
continue
}
}
select {
case <-next.NextWaitChan():
// see the start of the for loop for nil check
next = next.Next()
case <-peer.Quit():
return
case <-memR.Quit():
return
}
}
}
//-----------------------------------------------------------------------------
// Messages
// Message is a message sent or received by the Reactor.
type Message interface{}
func RegisterMessages(cdc *amino.Codec) {
cdc.RegisterInterface((*Message)(nil), nil)
cdc.RegisterConcrete(&TxMessage{}, "tendermint/mempool/TxMessage", nil)
cdc.RegisterConcrete(&WtxMessage{}, "tendermint/mempool/WtxMessage", nil)
cdc.RegisterConcreteMarshaller("tendermint/mempool/TxMessage", func(codec *amino.Codec, i interface{}) ([]byte, error) {
txmp, ok := i.(*TxMessage)
if ok {
return txmp.MarshalToAmino(codec)
}
txm, ok := i.(TxMessage)
if ok {
return txm.MarshalToAmino(codec)
}
return nil, fmt.Errorf("%T is not a TxMessage", i)
})
cdc.RegisterConcreteUnmarshaller("tendermint/mempool/TxMessage", func(cdc *amino.Codec, bz []byte) (interface{}, int, error) {
m := &TxMessage{}
err := m.UnmarshalFromAmino(cdc, bz)
if err != nil {
return nil, 0, err
}
return m, len(bz), nil
})
}
// decodeMsg decodes the bz bytes into a Message,
// if err is nil and Message is a TxMessage, you must put Message to txMessageDeocdePool after use.
func (memR *Reactor) decodeMsg(bz []byte) (Message, error) {
maxMsgSize := calcMaxMsgSize(memR.config.MaxTxBytes)
l := len(bz)
if l > maxMsgSize {
return nil, ErrTxTooLarge{maxMsgSize, l}
}
tp := getTxMessageAminoTypePrefix()
if l >= len(tp) && bytes.Equal(bz[:len(tp)], tp) {
txmsg := txMessageDeocdePool.Get().(*TxMessage)
err := txmsg.UnmarshalFromAmino(cdc, bz[len(tp):])
if err == nil {
return txmsg, nil
}
txmsg.Tx = nil
txMessageDeocdePool.Put(txmsg)
}
var msg Message
err := cdc.UnmarshalBinaryBare(bz, &msg)
return msg, err
}
func (memR *Reactor) encodeMsg(msg Message) []byte {
var ok bool
var txmp *TxMessage
var txm TxMessage
if txmp, ok = msg.(*TxMessage); !ok {
txmp = nil
if txm, ok = msg.(TxMessage); ok {
txmp = &txm
}
}
if txmp != nil {
buf := &bytes.Buffer{}
tp := getTxMessageAminoTypePrefix()
buf.Grow(len(tp) + txmp.AminoSize(cdc))
// we manually assemble the encoded bytes for performance
buf.Write(tp)
err := txmp.MarshalAminoTo(cdc, buf)
if err == nil {
return buf.Bytes()
}
}
return cdc.MustMarshalBinaryBare(msg)
}
//-------------------------------------
// TxMessage is a Message containing a transaction.
type TxMessage struct {
Tx types.Tx
From string
}
func (m TxMessage) AminoSize(_ *amino.Codec) int {
size := 0
if len(m.Tx) > 0 {
size += 1 + amino.ByteSliceSize(m.Tx)
}
if m.From != "" {
size += 1 + amino.EncodedStringSize(m.From)
}
return size
}
func (m TxMessage) MarshalToAmino(cdc *amino.Codec) ([]byte, error) {
buf := new(bytes.Buffer)
buf.Grow(m.AminoSize(cdc))
err := m.MarshalAminoTo(cdc, buf)
if err != nil {
return nil, err
}
return buf.Bytes(), nil
}
func (m TxMessage) MarshalAminoTo(_ *amino.Codec, buf *bytes.Buffer) error {
if len(m.Tx) != 0 {
const pbKey = byte(1<<3 | amino.Typ3_ByteLength)
err := amino.EncodeByteSliceWithKeyToBuffer(buf, m.Tx, pbKey)
if err != nil {
return err
}
}
if m.From != "" {
const pbKey = byte(2<<3 | amino.Typ3_ByteLength)
err := amino.EncodeStringWithKeyToBuffer(buf, m.From, pbKey)
if err != nil {
return err
}
}
return nil
}
func (m *TxMessage) UnmarshalFromAmino(_ *amino.Codec, data []byte) error {
const fieldCount = 2
var currentField int
var currentType amino.Typ3
var err error
for cur := 1; cur <= fieldCount; cur++ {
if len(data) != 0 && (currentField == 0 || currentField < cur) {
var nextField int
if nextField, currentType, err = amino.ParseProtoPosAndTypeMustOneByte(data[0]); err != nil {
return err
}
if nextField < currentField {
return fmt.Errorf("next field should greater than %d, got %d", currentField, nextField)
} else {
currentField = nextField
}
}
if len(data) == 0 || currentField != cur {
switch cur {
case 1:
m.Tx = nil
case 2:
m.From = ""
default:
return fmt.Errorf("unexpect feild num %d", cur)
}
} else {
pbk := data[0]
data = data[1:]
var subData []byte
if currentType == amino.Typ3_ByteLength {
if subData, err = amino.DecodeByteSliceWithoutCopy(&data); err != nil {
return err
}
}
switch pbk {
case 1<<3 | byte(amino.Typ3_ByteLength):
if len(subData) == 0 {
m.Tx = nil
} else {
m.Tx = make([]byte, len(subData))
copy(m.Tx, subData)
}
case 2<<3 | byte(amino.Typ3_ByteLength):
m.From = string(subData)
default:
return fmt.Errorf("unexpect pb key %d", pbk)
}
}
}
if len(data) != 0 {
return fmt.Errorf("unexpect data remain %X", data)
}
return nil
}
// String returns a string representation of the TxMessage.
func (m *TxMessage) String() string {
return fmt.Sprintf("[TxMessage %v]", m.Tx)
}
// calcMaxMsgSize returns the max size of TxMessage
// account for amino overhead of TxMessage
func calcMaxMsgSize(maxTxSize int) int {
return maxTxSize + aminoOverheadForTxMessage
}
// WtxMessage is a Message containing a transaction.
type WtxMessage struct {
Wtx *WrappedTx
}
// String returns a string representation of the WtxMessage.
func (m *WtxMessage) String() string {
return fmt.Sprintf("[WtxMessage %v]", m.Wtx)
}
type WrappedTx struct {
Payload []byte `json:"payload"` // std tx or evm tx
From string `json:"from"` // from address of evm tx or ""
Signature []byte `json:"signature"` // signature for payload
NodeKey []byte `json:"nodeKey"` // pub key of the node who signs the tx
}
func (wtx *WrappedTx) GetPayload() []byte {
if wtx != nil {
return wtx.Payload
}
return nil
}
func (wtx *WrappedTx) GetSignature() []byte {
if wtx != nil {
return wtx.Signature
}
return nil
}
func (wtx *WrappedTx) GetNodeKey() []byte {
if wtx != nil {
return wtx.NodeKey
}
return nil
}
func (wtx *WrappedTx) GetFrom() string {
if wtx != nil {
return wtx.From
}
return ""
}
func (w *WrappedTx) verify(whitelist map[string]struct{}) error {
pub := p2p.BytesToPubKey(w.NodeKey)
if _, ok := whitelist[string(p2p.PubKeyToID(pub))]; !ok {
return fmt.Errorf("node key [%s] not in whitelist", p2p.PubKeyToID(pub))
}
if !pub.VerifyBytes(append(w.Payload, w.From...), w.Signature) {
return fmt.Errorf("invalid signature of wtx")
}
return nil
}
func (memR *Reactor) wrapTx(tx types.Tx, from string) (*WrappedTx, error) {
wtx := &WrappedTx{
Payload: tx,
From: from,
NodeKey: memR.nodeKey.PubKey().Bytes(),
}
sig, err := memR.nodeKey.PrivKey.Sign(append(wtx.Payload, from...))
if err != nil {
return nil, err
}
wtx.Signature = sig
return wtx, nil
}