-
Notifications
You must be signed in to change notification settings - Fork 61
/
node.go
431 lines (361 loc) · 12.7 KB
/
node.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
package node
import (
"context"
"encoding/base64"
"encoding/json"
"fmt"
"net/http"
"sync"
"time"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/libp2p/go-libp2p/core/crypto"
llcfg "github.com/tendermint/tendermint/config"
"github.com/tendermint/tendermint/libs/log"
"github.com/tendermint/tendermint/libs/pubsub"
"github.com/tendermint/tendermint/libs/service"
"github.com/tendermint/tendermint/proxy"
tmtypes "github.com/tendermint/tendermint/types"
"github.com/dymensionxyz/dymint/block"
"github.com/dymensionxyz/dymint/config"
"github.com/dymensionxyz/dymint/da"
daregsitry "github.com/dymensionxyz/dymint/da/registry"
"github.com/dymensionxyz/dymint/mempool"
mempoolv1 "github.com/dymensionxyz/dymint/mempool/v1"
"github.com/dymensionxyz/dymint/node/events"
nodemempool "github.com/dymensionxyz/dymint/node/mempool"
"github.com/dymensionxyz/dymint/p2p"
"github.com/dymensionxyz/dymint/settlement"
slregistry "github.com/dymensionxyz/dymint/settlement/registry"
"github.com/dymensionxyz/dymint/state/indexer"
blockidxkv "github.com/dymensionxyz/dymint/state/indexer/block/kv"
"github.com/dymensionxyz/dymint/state/txindex"
"github.com/dymensionxyz/dymint/state/txindex/kv"
"github.com/dymensionxyz/dymint/store"
"github.com/dymensionxyz/dymint/utils"
)
// prefixes used in KV store to separate main node data from DALC data
var (
mainPrefix = []byte{0}
dalcPrefix = []byte{1}
indexerPrefix = []byte{2}
)
const (
// genesisChunkSize is the maximum size, in bytes, of each
// chunk in the genesis structure for the chunked API
genesisChunkSize = 16 * 1024 * 1024 // 16 MiB
)
// BaseLayersHealthStatus contains information about health of base layers.
type BaseLayersHealthStatus struct {
settlementHealthy bool
daHealthy bool
mutex sync.RWMutex
}
func (bl *BaseLayersHealthStatus) setSettlementHealth(isHealthy bool) {
bl.mutex.Lock()
defer bl.mutex.Unlock()
bl.settlementHealthy = isHealthy
}
func (bl *BaseLayersHealthStatus) setDAHealth(isHealthy bool) {
bl.mutex.Lock()
defer bl.mutex.Unlock()
bl.daHealthy = isHealthy
}
func (bl *BaseLayersHealthStatus) get() (settlementHealthy bool, daHealthy bool) {
bl.mutex.RLock()
defer bl.mutex.RUnlock()
return bl.settlementHealthy, bl.daHealthy
}
// Node represents a client node in Dymint network.
// It connects all the components and orchestrates their work.
type Node struct {
service.BaseService
eventBus *tmtypes.EventBus
pubsubServer *pubsub.Server
proxyApp proxy.AppConns
genesis *tmtypes.GenesisDoc
// cache of chunked genesis data.
genChunks []string
conf config.NodeConfig
P2P *p2p.Client
// TODO(tzdybal): consider extracting "mempool reactor"
Mempool mempool.Mempool
mempoolIDs *nodemempool.MempoolIDs
incomingTxCh chan *p2p.GossipMessage
Store store.Store
blockManager *block.Manager
dalc da.DataAvailabilityLayerClient
settlementlc settlement.LayerI
TxIndexer txindex.TxIndexer
BlockIndexer indexer.BlockIndexer
IndexerService *txindex.IndexerService
baseLayersHealthStatus BaseLayersHealthStatus
// keep context here only because of API compatibility
// - it's used in `OnStart` (defined in service.Service interface)
ctx context.Context
}
// NewNode creates new Dymint node.
func NewNode(ctx context.Context, conf config.NodeConfig, p2pKey crypto.PrivKey, signingKey crypto.PrivKey, clientCreator proxy.ClientCreator, genesis *tmtypes.GenesisDoc, logger log.Logger) (*Node, error) {
proxyApp := proxy.NewAppConns(clientCreator)
proxyApp.SetLogger(logger.With("module", "proxy"))
if err := proxyApp.Start(); err != nil {
return nil, fmt.Errorf("error starting proxy app connections: %w", err)
}
eventBus := tmtypes.NewEventBus()
eventBus.SetLogger(logger.With("module", "events"))
if err := eventBus.Start(); err != nil {
return nil, err
}
pubsubServer := pubsub.NewServer()
var baseKV store.KVStore
if conf.RootDir == "" && conf.DBPath == "" { // this is used for testing
logger.Info("WARNING: working in in-memory mode")
baseKV = store.NewDefaultInMemoryKVStore()
} else {
// TODO(omritoptx): Move dymint to const
baseKV = store.NewDefaultKVStore(conf.RootDir, conf.DBPath, "dymint")
}
mainKV := store.NewPrefixKV(baseKV, mainPrefix)
// TODO: dalcKV is needed for mock only. Initilize only if mock used
dalcKV := store.NewPrefixKV(baseKV, dalcPrefix)
indexerKV := store.NewPrefixKV(baseKV, indexerPrefix)
s := store.New(mainKV)
dalc := daregsitry.GetClient(conf.DALayer)
if dalc == nil {
return nil, fmt.Errorf("couldn't get data availability client named '%s'", conf.DALayer)
}
err := dalc.Init([]byte(conf.DAConfig), pubsubServer, dalcKV, logger.With("module", string(dalc.GetClientType())))
if err != nil {
return nil, fmt.Errorf("data availability layer client initialization error: %w", err)
}
// Init the settlement layer client
settlementlc := slregistry.GetClient(slregistry.Client(conf.SettlementLayer))
if settlementlc == nil {
return nil, fmt.Errorf("couldn't get settlement client named '%s'", conf.SettlementLayer)
}
if conf.SettlementLayer == "mock" {
conf.SettlementConfig.KeyringHomeDir = conf.RootDir
}
err = settlementlc.Init(conf.SettlementConfig, pubsubServer, logger.With("module", "settlement_client"))
if err != nil {
return nil, fmt.Errorf("settlement layer client initialization error: %w", err)
}
indexerService, txIndexer, blockIndexer, err := createAndStartIndexerService(conf, indexerKV, eventBus, logger)
if err != nil {
return nil, err
}
mp := mempoolv1.NewTxMempool(logger, llcfg.DefaultMempoolConfig(), proxyApp.Mempool(), 0)
mpIDs := nodemempool.NewMempoolIDs()
// Set p2p client and it's validators
p2pValidator := p2p.NewValidator(logger.With("module", "p2p_validator"), pubsubServer)
p2pClient, err := p2p.NewClient(conf.P2P, p2pKey, genesis.ChainID, logger.With("module", "p2p"))
if err != nil {
return nil, err
}
p2pClient.SetTxValidator(p2pValidator.TxValidator(mp, mpIDs))
p2pClient.SetBlockValidator(p2pValidator.BlockValidator())
blockManager, err := block.NewManager(signingKey, conf.BlockManagerConfig, genesis, s, mp, proxyApp, dalc, settlementlc, eventBus, pubsubServer, p2pClient, logger.With("module", "BlockManager"))
if err != nil {
return nil, fmt.Errorf("BlockManager initialization error: %w", err)
}
node := &Node{
proxyApp: proxyApp,
eventBus: eventBus,
pubsubServer: pubsubServer,
genesis: genesis,
conf: conf,
P2P: p2pClient,
blockManager: blockManager,
dalc: dalc,
settlementlc: settlementlc,
Mempool: mp,
mempoolIDs: mpIDs,
incomingTxCh: make(chan *p2p.GossipMessage),
Store: s,
TxIndexer: txIndexer,
IndexerService: indexerService,
BlockIndexer: blockIndexer,
ctx: ctx,
}
node.BaseService = *service.NewBaseService(logger, "Node", node)
return node, nil
}
// initGenesisChunks creates a chunked format of the genesis document to make it easier to
// iterate through larger genesis structures.
func (n *Node) initGenesisChunks() error {
if n.genChunks != nil {
return nil
}
if n.genesis == nil {
return nil
}
data, err := json.Marshal(n.genesis)
if err != nil {
return err
}
for i := 0; i < len(data); i += genesisChunkSize {
end := i + genesisChunkSize
if end > len(data) {
end = len(data)
}
n.genChunks = append(n.genChunks, base64.StdEncoding.EncodeToString(data[i:end]))
}
return nil
}
// OnStart is a part of Service interface.
func (n *Node) OnStart() error {
n.Logger.Info("starting P2P client")
err := n.P2P.Start(n.ctx)
if err != nil {
return fmt.Errorf("error while starting P2P client: %w", err)
}
// start the pubsub server
err = n.pubsubServer.Start()
if err != nil {
return fmt.Errorf("error while starting pubsub server: %w", err)
}
// Start the da client
err = n.dalc.Start()
if err != nil {
return fmt.Errorf("error while starting data availability layer client: %w", err)
}
// Start the settlement layer client
err = n.settlementlc.Start()
if err != nil {
return fmt.Errorf("error while starting settlement layer client: %w", err)
}
go func() {
if err := n.startPrometheusServer(); err != nil {
panic(err)
}
}()
n.baseLayersHealthStatus = BaseLayersHealthStatus{
settlementHealthy: true,
daHealthy: true,
}
n.eventListener()
// start the block manager
err = n.blockManager.Start(n.ctx, n.conf.Aggregator)
if err != nil {
return fmt.Errorf("error while starting block manager: %w", err)
}
return nil
}
// GetGenesis returns entire genesis doc.
func (n *Node) GetGenesis() *tmtypes.GenesisDoc {
return n.genesis
}
// GetGenesisChunks returns chunked version of genesis.
func (n *Node) GetGenesisChunks() ([]string, error) {
err := n.initGenesisChunks()
if err != nil {
return nil, err
}
return n.genChunks, err
}
// OnStop is a part of Service interface.
func (n *Node) OnStop() {
err := n.dalc.Stop()
if err != nil {
n.Logger.Error("error while stopping data availability layer client", "error", err)
}
err = n.settlementlc.Stop()
if err != nil {
n.Logger.Error("error while stopping settlement layer client", "error", err)
}
err = n.P2P.Close()
if err != nil {
n.Logger.Error("error while stopping P2P client", "error", err)
}
}
// OnReset is a part of Service interface.
func (n *Node) OnReset() error {
panic("OnReset - not implemented!")
}
// SetLogger sets the logger used by node.
func (n *Node) SetLogger(logger log.Logger) {
n.Logger = logger
}
// GetLogger returns logger.
func (n *Node) GetLogger() log.Logger {
return n.Logger
}
// EventBus gives access to Node's event bus.
func (n *Node) EventBus() *tmtypes.EventBus {
return n.eventBus
}
// PubSubServer gives access to the Node's pubsub server
func (n *Node) PubSubServer() *pubsub.Server {
return n.pubsubServer
}
// ProxyApp returns ABCI proxy connections to communicate with application.
func (n *Node) ProxyApp() proxy.AppConns {
return n.proxyApp
}
func createAndStartIndexerService(
conf config.NodeConfig,
kvStore store.KVStore,
eventBus *tmtypes.EventBus,
logger log.Logger,
) (*txindex.IndexerService, txindex.TxIndexer, indexer.BlockIndexer, error) {
var (
txIndexer txindex.TxIndexer
blockIndexer indexer.BlockIndexer
)
txIndexer = kv.NewTxIndex(kvStore)
blockIndexer = blockidxkv.New(store.NewPrefixKV(kvStore, []byte("block_events")))
indexerService := txindex.NewIndexerService(txIndexer, blockIndexer, eventBus)
indexerService.SetLogger(logger.With("module", "txindex"))
if err := indexerService.Start(); err != nil {
return nil, nil, nil, err
}
return indexerService, txIndexer, blockIndexer, nil
}
// All events listeners should be registered here
func (n *Node) eventListener() {
go utils.SubscribeAndHandleEvents(n.ctx, n.pubsubServer, "settlementHealthStatusHandler", settlement.EventQuerySettlementHealthStatus, n.healthStatusEventCallback, n.Logger)
go utils.SubscribeAndHandleEvents(n.ctx, n.pubsubServer, "daHealthStatusHandler", da.EventQueryDAHealthStatus, n.healthStatusEventCallback, n.Logger)
}
// Event handling callback function for health status events
func (n *Node) healthStatusEventCallback(event pubsub.Message) {
switch e := event.Data().(type) {
case *settlement.EventDataSettlementHealthStatus:
n.baseLayersHealthStatus.setSettlementHealth(e.Healthy)
n.healthStatusHandler(e.Error)
case *da.EventDataDAHealthStatus:
n.baseLayersHealthStatus.setDAHealth(e.Healthy)
n.healthStatusHandler(e.Error)
}
}
// handler for health status change
func (n *Node) healthStatusHandler(err error) {
daHealthy, settlementHealthy := n.baseLayersHealthStatus.get()
if daHealthy && settlementHealthy {
n.Logger.Info("All base layers are healthy")
healthStatusEvent := &events.EventDataHealthStatus{Healthy: true}
if err = n.pubsubServer.PublishWithEvents(n.ctx, healthStatusEvent, map[string][]string{events.EventNodeTypeKey: {events.EventHealthStatus}}); err != nil {
panic(err)
}
// Only if err is not nil, we publish the event. Otherwise it could come from a previous unhealthy state.
} else if err != nil {
n.Logger.Info("Base layer is unhealthy")
healthStatusEvent := &events.EventDataHealthStatus{Healthy: false, Error: err}
if err = n.pubsubServer.PublishWithEvents(n.ctx, healthStatusEvent, map[string][]string{events.EventNodeTypeKey: {events.EventHealthStatus}}); err != nil {
panic(err)
}
}
}
func (n *Node) startPrometheusServer() error {
if n.conf.Instrumentation != nil && n.conf.Instrumentation.Prometheus {
http.Handle("/metrics", promhttp.Handler())
srv := &http.Server{
Addr: n.conf.Instrumentation.PrometheusListenAddr,
ReadTimeout: 5 * time.Second,
WriteTimeout: 10 * time.Second,
Handler: http.DefaultServeMux,
}
if err := srv.ListenAndServe(); err != nil {
return err
}
}
return nil
}