-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
pool.go
441 lines (377 loc) · 13.7 KB
/
pool.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
package client
import (
"context"
"fmt"
"math/big"
"sync"
"time"
"github.com/ethereum/go-ethereum"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/core/types"
"github.com/ethereum/go-ethereum/rpc"
"github.com/pkg/errors"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promauto"
"github.com/smartcontractkit/chainlink/v2/core/config"
evmtypes "github.com/smartcontractkit/chainlink/v2/core/chains/evm/types"
"github.com/smartcontractkit/chainlink/v2/core/logger"
"github.com/smartcontractkit/chainlink/v2/core/services"
"github.com/smartcontractkit/chainlink/v2/core/utils"
)
var (
// PromEVMPoolRPCNodeStates reports current RPC node state
PromEVMPoolRPCNodeStates = promauto.NewGaugeVec(prometheus.GaugeOpts{
Name: "evm_pool_rpc_node_states",
Help: "The number of RPC nodes currently in the given state for the given chain",
}, []string{"evmChainID", "state"})
)
const (
NodeSelectionMode_HighestHead = "HighestHead"
NodeSelectionMode_RoundRobin = "RoundRobin"
NodeSelectionMode_TotalDifficulty = "TotalDifficulty"
NodeSelectionMode_PriorityLevel = "PriorityLevel"
)
// NodeSelector represents a strategy to select the next node from the pool.
type NodeSelector interface {
// Select returns a Node, or nil if none can be selected.
// Implementation must be thread-safe.
Select() Node
// Name returns the strategy name, e.g. "HighestHead" or "RoundRobin"
Name() string
}
// PoolConfig represents settings for the Pool
type PoolConfig interface {
NodeSelectionMode() string
NodeNoNewHeadsThreshold() time.Duration
}
// Pool represents an abstraction over one or more primary nodes
// It is responsible for liveness checking and balancing queries across live nodes
type Pool struct {
utils.StartStopOnce
nodes []Node
sendonlys []SendOnlyNode
chainID *big.Int
chainType config.ChainType
logger logger.Logger
selectionMode string
noNewHeadsThreshold time.Duration
nodeSelector NodeSelector
activeMu sync.RWMutex
activeNode Node
chStop utils.StopChan
wg sync.WaitGroup
}
func NewPool(logger logger.Logger, selectionMode string, noNewHeadsTreshold time.Duration, nodes []Node, sendonlys []SendOnlyNode, chainID *big.Int, chainType config.ChainType) *Pool {
if chainID == nil {
panic("chainID is required")
}
nodeSelector := func() NodeSelector {
switch selectionMode {
case NodeSelectionMode_HighestHead:
return NewHighestHeadNodeSelector(nodes)
case NodeSelectionMode_RoundRobin:
return NewRoundRobinSelector(nodes)
case NodeSelectionMode_TotalDifficulty:
return NewTotalDifficultyNodeSelector(nodes)
case NodeSelectionMode_PriorityLevel:
return NewPriorityLevelNodeSelector(nodes)
default:
panic(fmt.Sprintf("unsupported NodeSelectionMode: %s", selectionMode))
}
}()
lggr := logger.Named("Pool").With("evmChainID", chainID.String())
p := &Pool{
nodes: nodes,
sendonlys: sendonlys,
chainID: chainID,
chainType: chainType,
logger: lggr,
selectionMode: selectionMode,
noNewHeadsThreshold: noNewHeadsTreshold,
nodeSelector: nodeSelector,
chStop: make(chan struct{}),
}
p.logger.Debugf("The pool is configured to use NodeSelectionMode: %s", selectionMode)
return p
}
// Dial starts every node in the pool
//
// Nodes handle their own redialing and runloops, so this function does not
// return any error if the nodes aren't available
func (p *Pool) Dial(ctx context.Context) error {
return p.StartOnce("Pool", func() (merr error) {
if len(p.nodes) == 0 {
return errors.Errorf("no available nodes for chain %s", p.chainID.String())
}
var ms services.MultiStart
for _, n := range p.nodes {
if n.ChainID().Cmp(p.chainID) != 0 {
return ms.CloseBecause(errors.Errorf("node %s has chain ID %s which does not match pool chain ID of %s", n.String(), n.ChainID().String(), p.chainID.String()))
}
rawNode, ok := n.(*node)
if ok {
// This is a bit hacky but it allows the node to be aware of
// pool state and prevent certain state transitions that might
// otherwise leave no nodes available. It is better to have one
// node in a degraded state than no nodes at all.
rawNode.nLiveNodes = p.nLiveNodes
}
// node will handle its own redialing and automatic recovery
if err := ms.Start(ctx, n); err != nil {
return err
}
}
for _, s := range p.sendonlys {
if s.ChainID().Cmp(p.chainID) != 0 {
return ms.CloseBecause(errors.Errorf("sendonly node %s has chain ID %s which does not match pool chain ID of %s", s.String(), s.ChainID().String(), p.chainID.String()))
}
if err := ms.Start(ctx, s); err != nil {
return err
}
}
p.wg.Add(1)
go p.runLoop()
return nil
})
}
// nLiveNodes returns the number of currently alive nodes, as well as the highest block number and greatest total difficulty.
// totalDifficulty will be 0 if all nodes return nil.
func (p *Pool) nLiveNodes() (nLiveNodes int, blockNumber int64, totalDifficulty *utils.Big) {
totalDifficulty = utils.NewBigI(0)
for _, n := range p.nodes {
if s, num, td := n.StateAndLatest(); s == NodeStateAlive {
nLiveNodes++
if num > blockNumber {
blockNumber = num
}
if td != nil && td.Cmp(totalDifficulty) > 0 {
totalDifficulty = td
}
}
}
return
}
func (p *Pool) runLoop() {
defer p.wg.Done()
p.report()
// Prometheus' default interval is 15s, set this to under 7.5s to avoid
// aliasing (see: https://en.wikipedia.org/wiki/Nyquist_frequency)
reportInterval := 6500 * time.Millisecond
monitor := time.NewTicker(utils.WithJitter(reportInterval))
defer monitor.Stop()
for {
select {
case <-monitor.C:
p.report()
case <-p.chStop:
return
}
}
}
func (p *Pool) report() {
type nodeWithState struct {
Node string
State string
}
var total, dead int
counts := make(map[NodeState]int)
nodeStates := make([]nodeWithState, len(p.nodes))
for i, n := range p.nodes {
state := n.State()
nodeStates[i] = nodeWithState{n.String(), state.String()}
total++
if state != NodeStateAlive {
dead++
}
counts[state]++
}
for _, state := range allNodeStates {
count := counts[state]
PromEVMPoolRPCNodeStates.WithLabelValues(p.chainID.String(), state.String()).Set(float64(count))
}
live := total - dead
p.logger.Tracew(fmt.Sprintf("Pool state: %d/%d nodes are alive", live, total), "nodeStates", nodeStates)
if total == dead {
rerr := fmt.Errorf("no EVM primary nodes available: 0/%d nodes are alive", total)
p.logger.Criticalw(rerr.Error(), "nodeStates", nodeStates)
p.SvcErrBuffer.Append(rerr)
} else if dead > 0 {
p.logger.Errorw(fmt.Sprintf("At least one EVM primary node is dead: %d/%d nodes are alive", live, total), "nodeStates", nodeStates)
}
}
// Close tears down the pool and closes all nodes
func (p *Pool) Close() error {
return p.StopOnce("Pool", func() error {
close(p.chStop)
p.wg.Wait()
return services.CloseAll(services.MultiCloser(p.nodes), services.MultiCloser(p.sendonlys))
})
}
func (p *Pool) ChainID() *big.Int {
return p.selectNode().ChainID()
}
func (p *Pool) ChainType() config.ChainType {
return p.chainType
}
// selectNode returns the active Node, if it is still NodeStateAlive, otherwise it selects a new one from the NodeSelector.
func (p *Pool) selectNode() (node Node) {
p.activeMu.RLock()
node = p.activeNode
p.activeMu.RUnlock()
if node != nil && node.State() == NodeStateAlive {
return // still alive
}
// select a new one
p.activeMu.Lock()
defer p.activeMu.Unlock()
node = p.activeNode
if node != nil && node.State() == NodeStateAlive {
return // another goroutine beat us here
}
p.activeNode = p.nodeSelector.Select()
if p.activeNode == nil {
p.logger.Criticalw("No live RPC nodes available", "NodeSelectionMode", p.nodeSelector.Name())
errmsg := fmt.Errorf("no live nodes available for chain %s", p.chainID.String())
p.SvcErrBuffer.Append(errmsg)
return &erroringNode{errMsg: errmsg.Error()}
}
return p.activeNode
}
func (p *Pool) CallContext(ctx context.Context, result interface{}, method string, args ...interface{}) error {
return p.selectNode().CallContext(ctx, result, method, args...)
}
func (p *Pool) BatchCallContext(ctx context.Context, b []rpc.BatchElem) error {
return p.selectNode().BatchCallContext(ctx, b)
}
// BatchCallContextAll calls BatchCallContext for every single node including
// sendonlys.
// CAUTION: This should only be used for mass re-transmitting transactions, it
// might have unexpected effects to use it for anything else.
func (p *Pool) BatchCallContextAll(ctx context.Context, b []rpc.BatchElem) error {
var wg sync.WaitGroup
defer wg.Wait()
main := p.selectNode()
var all []SendOnlyNode
for _, n := range p.nodes {
all = append(all, n)
}
all = append(all, p.sendonlys...)
for _, n := range all {
if n == main {
// main node is used at the end for the return value
continue
}
// Parallel call made to all other nodes with ignored return value
wg.Add(1)
go func(n SendOnlyNode) {
defer wg.Done()
err := n.BatchCallContext(ctx, b)
if err != nil {
p.logger.Debugw("Secondary node BatchCallContext failed", "err", err)
} else {
p.logger.Trace("Secondary node BatchCallContext success")
}
}(n)
}
return main.BatchCallContext(ctx, b)
}
// Wrapped Geth client methods
func (p *Pool) SendTransaction(ctx context.Context, tx *types.Transaction) error {
main := p.selectNode()
var all []SendOnlyNode
for _, n := range p.nodes {
all = append(all, n)
}
all = append(all, p.sendonlys...)
for _, n := range all {
if n == main {
// main node is used at the end for the return value
continue
}
// Parallel send to all other nodes with ignored return value
// Async - we do not want to block the main thread with secondary nodes
// in case they are unreliable/slow.
// It is purely a "best effort" send.
// Resource is not unbounded because the default context has a timeout.
ok := p.IfNotStopped(func() {
// Must wrap inside IfNotStopped to avoid waitgroup racing with Close
p.wg.Add(1)
go func(n SendOnlyNode) {
defer p.wg.Done()
sendCtx, cancel := p.chStop.CtxCancel(ContextWithDefaultTimeout())
defer cancel()
err := NewSendError(n.SendTransaction(sendCtx, tx))
p.logger.Debugw("Sendonly node sent transaction", "name", n.String(), "tx", tx, "err", err)
if err == nil || err.IsNonceTooLowError() || err.IsTransactionAlreadyMined() || err.IsTransactionAlreadyInMempool() {
// Nonce too low or transaction known errors are expected since
// the primary SendTransaction may well have succeeded already
return
}
p.logger.Warnw("Eth client returned error", "name", n.String(), "err", err, "tx", tx)
}(n)
})
if !ok {
p.logger.Debug("Cannot send transaction on sendonly node; pool is stopped", "node", n.String())
}
}
return main.SendTransaction(ctx, tx)
}
func (p *Pool) PendingCodeAt(ctx context.Context, account common.Address) ([]byte, error) {
return p.selectNode().PendingCodeAt(ctx, account)
}
func (p *Pool) PendingNonceAt(ctx context.Context, account common.Address) (uint64, error) {
return p.selectNode().PendingNonceAt(ctx, account)
}
func (p *Pool) NonceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (uint64, error) {
return p.selectNode().NonceAt(ctx, account, blockNumber)
}
func (p *Pool) TransactionReceipt(ctx context.Context, txHash common.Hash) (*types.Receipt, error) {
return p.selectNode().TransactionReceipt(ctx, txHash)
}
func (p *Pool) TransactionByHash(ctx context.Context, txHash common.Hash) (*types.Transaction, error) {
return p.selectNode().TransactionByHash(ctx, txHash)
}
func (p *Pool) BlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error) {
return p.selectNode().BlockByNumber(ctx, number)
}
func (p *Pool) BlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error) {
return p.selectNode().BlockByHash(ctx, hash)
}
func (p *Pool) BlockNumber(ctx context.Context) (uint64, error) {
return p.selectNode().BlockNumber(ctx)
}
func (p *Pool) BalanceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (*big.Int, error) {
return p.selectNode().BalanceAt(ctx, account, blockNumber)
}
func (p *Pool) FilterLogs(ctx context.Context, q ethereum.FilterQuery) ([]types.Log, error) {
return p.selectNode().FilterLogs(ctx, q)
}
func (p *Pool) SubscribeFilterLogs(ctx context.Context, q ethereum.FilterQuery, ch chan<- types.Log) (ethereum.Subscription, error) {
return p.selectNode().SubscribeFilterLogs(ctx, q, ch)
}
func (p *Pool) EstimateGas(ctx context.Context, call ethereum.CallMsg) (uint64, error) {
return p.selectNode().EstimateGas(ctx, call)
}
func (p *Pool) SuggestGasPrice(ctx context.Context) (*big.Int, error) {
return p.selectNode().SuggestGasPrice(ctx)
}
func (p *Pool) CallContract(ctx context.Context, msg ethereum.CallMsg, blockNumber *big.Int) ([]byte, error) {
return p.selectNode().CallContract(ctx, msg, blockNumber)
}
func (p *Pool) CodeAt(ctx context.Context, account common.Address, blockNumber *big.Int) ([]byte, error) {
return p.selectNode().CodeAt(ctx, account, blockNumber)
}
// bind.ContractBackend methods
func (p *Pool) HeaderByNumber(ctx context.Context, n *big.Int) (*types.Header, error) {
return p.selectNode().HeaderByNumber(ctx, n)
}
func (p *Pool) HeaderByHash(ctx context.Context, h common.Hash) (*types.Header, error) {
return p.selectNode().HeaderByHash(ctx, h)
}
func (p *Pool) SuggestGasTipCap(ctx context.Context) (*big.Int, error) {
return p.selectNode().SuggestGasTipCap(ctx)
}
// EthSubscribe implements evmclient.Client
func (p *Pool) EthSubscribe(ctx context.Context, channel chan<- *evmtypes.Head, args ...interface{}) (ethereum.Subscription, error) {
return p.selectNode().EthSubscribe(ctx, channel, args...)
}