-
Notifications
You must be signed in to change notification settings - Fork 264
Expand file tree
/
Copy pathfull.go
More file actions
540 lines (467 loc) · 16.2 KB
/
full.go
File metadata and controls
540 lines (467 loc) · 16.2 KB
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
package node
import (
"context"
"encoding/base64"
"encoding/json"
"errors"
"fmt"
"net/http"
"net/http/pprof"
"sync"
"time"
ds "github.com/ipfs/go-datastore"
ktds "github.com/ipfs/go-datastore/keytransform"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/rs/zerolog"
"github.com/evstack/ev-node/block"
coreda "github.com/evstack/ev-node/core/da"
coreexecutor "github.com/evstack/ev-node/core/execution"
coresequencer "github.com/evstack/ev-node/core/sequencer"
"github.com/evstack/ev-node/pkg/config"
genesispkg "github.com/evstack/ev-node/pkg/genesis"
"github.com/evstack/ev-node/pkg/p2p"
rpcserver "github.com/evstack/ev-node/pkg/rpc/server"
"github.com/evstack/ev-node/pkg/service"
"github.com/evstack/ev-node/pkg/signer"
"github.com/evstack/ev-node/pkg/store"
evsync "github.com/evstack/ev-node/pkg/sync"
)
// prefixes used in KV store to separate rollkit data from execution environment data (if the same data base is reused)
var EvPrefix = "0"
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
)
var _ Node = &FullNode{}
// FullNode represents a client node in Rollkit network.
// It connects all the components and orchestrates their work.
type FullNode struct {
service.BaseService
genesis genesispkg.Genesis
// cache of chunked genesis data.
genChunks []string
nodeConfig config.Config
da coreda.DA
p2pClient *p2p.Client
hSyncService *evsync.HeaderSyncService
dSyncService *evsync.DataSyncService
Store store.Store
blockManager *block.Manager
reaper *block.Reaper
prometheusSrv *http.Server
pprofSrv *http.Server
rpcServer *http.Server
}
// newFullNode creates a new Rollkit full node.
func newFullNode(
ctx context.Context,
nodeConfig config.Config,
p2pClient *p2p.Client,
signer signer.Signer,
genesis genesispkg.Genesis,
database ds.Batching,
exec coreexecutor.Executor,
sequencer coresequencer.Sequencer,
da coreda.DA,
metricsProvider MetricsProvider,
logger zerolog.Logger,
nodeOpts NodeOptions,
) (fn *FullNode, err error) {
seqMetrics, _ := metricsProvider(genesis.ChainID)
mainKV := newPrefixKV(database, EvPrefix)
headerSyncService, err := initHeaderSyncService(mainKV, nodeConfig, genesis, p2pClient, logger)
if err != nil {
return nil, err
}
dataSyncService, err := initDataSyncService(mainKV, nodeConfig, genesis, p2pClient, logger)
if err != nil {
return nil, err
}
rktStore := store.New(mainKV)
blockManager, err := initBlockManager(
ctx,
signer,
exec,
nodeConfig,
genesis,
rktStore,
sequencer,
da,
logger,
headerSyncService,
dataSyncService,
seqMetrics,
nodeOpts.ManagerOptions,
)
if err != nil {
return nil, err
}
reaper := block.NewReaper(
ctx,
exec,
sequencer,
genesis.ChainID,
nodeConfig.Node.BlockTime.Duration,
logger.With().Str("component", "Reaper").Logger(), // Get Reaper's own logger
mainKV,
)
// Connect the reaper to the manager for transaction notifications
reaper.SetManager(blockManager)
node := &FullNode{
genesis: genesis,
nodeConfig: nodeConfig,
p2pClient: p2pClient,
blockManager: blockManager,
reaper: reaper,
da: da,
Store: rktStore,
hSyncService: headerSyncService,
dSyncService: dataSyncService,
}
node.BaseService = *service.NewBaseService(logger, "Node", node)
return node, nil
}
func initHeaderSyncService(
mainKV ds.Batching,
nodeConfig config.Config,
genesis genesispkg.Genesis,
p2pClient *p2p.Client,
logger zerolog.Logger,
) (*evsync.HeaderSyncService, error) {
headerSyncService, err := evsync.NewHeaderSyncService(mainKV, nodeConfig, genesis, p2pClient, logger.With().Str("component", "HeaderSyncService").Logger())
if err != nil {
return nil, fmt.Errorf("error while initializing HeaderSyncService: %w", err)
}
return headerSyncService, nil
}
func initDataSyncService(
mainKV ds.Batching,
nodeConfig config.Config,
genesis genesispkg.Genesis,
p2pClient *p2p.Client,
logger zerolog.Logger,
) (*evsync.DataSyncService, error) {
dataSyncService, err := evsync.NewDataSyncService(mainKV, nodeConfig, genesis, p2pClient, logger.With().Str("component", "DataSyncService").Logger())
if err != nil {
return nil, fmt.Errorf("error while initializing DataSyncService: %w", err)
}
return dataSyncService, nil
}
// initBlockManager initializes the block manager.
// It requires:
// - signingKey: the private key of the validator
// - nodeConfig: the node configuration
// - genesis: the genesis document
// - store: the store
// - seqClient: the sequencing client
// - da: the DA
func initBlockManager(
ctx context.Context,
signer signer.Signer,
exec coreexecutor.Executor,
nodeConfig config.Config,
genesis genesispkg.Genesis,
store store.Store,
sequencer coresequencer.Sequencer,
da coreda.DA,
logger zerolog.Logger,
headerSyncService *evsync.HeaderSyncService,
dataSyncService *evsync.DataSyncService,
seqMetrics *block.Metrics,
managerOpts block.ManagerOptions,
) (*block.Manager, error) {
logger.Debug().Bytes("address", genesis.ProposerAddress).Msg("Proposer address")
blockManager, err := block.NewManager(
ctx,
signer,
nodeConfig,
genesis,
store,
exec,
sequencer,
da,
logger.With().Str("component", "BlockManager").Logger(), // Get BlockManager's own logger
headerSyncService.Store(),
dataSyncService.Store(),
headerSyncService,
dataSyncService,
seqMetrics,
managerOpts,
)
if err != nil {
return nil, fmt.Errorf("error while initializing BlockManager: %w", err)
}
return blockManager, nil
}
// initGenesisChunks creates a chunked format of the genesis document to make it easier to
// iterate through larger genesis structures.
func (n *FullNode) initGenesisChunks() error {
if n.genChunks != nil {
return nil
}
data, err := json.Marshal(n.genesis)
if err != nil {
return err
}
for i := 0; i < len(data); i += genesisChunkSize {
end := min(i+genesisChunkSize, len(data))
n.genChunks = append(n.genChunks, base64.StdEncoding.EncodeToString(data[i:end]))
}
return nil
}
// startInstrumentationServer starts HTTP servers for instrumentation (Prometheus metrics and pprof).
// Returns the primary server (Prometheus if enabled, otherwise pprof) and optionally a secondary server.
func (n *FullNode) startInstrumentationServer() (*http.Server, *http.Server) {
var prometheusServer, pprofServer *http.Server
// Check if Prometheus is enabled
if n.nodeConfig.Instrumentation.IsPrometheusEnabled() {
prometheusMux := http.NewServeMux()
// Register Prometheus metrics handler
prometheusMux.Handle("/metrics", promhttp.InstrumentMetricHandler(
prometheus.DefaultRegisterer, promhttp.HandlerFor(
prometheus.DefaultGatherer,
promhttp.HandlerOpts{MaxRequestsInFlight: n.nodeConfig.Instrumentation.MaxOpenConnections},
),
))
prometheusServer = &http.Server{
Addr: n.nodeConfig.Instrumentation.PrometheusListenAddr,
Handler: prometheusMux,
ReadHeaderTimeout: readHeaderTimeout,
}
go func() {
if err := prometheusServer.ListenAndServe(); err != nil && !errors.Is(err, http.ErrServerClosed) {
n.Logger.Error().Err(err).Msg("Prometheus HTTP server ListenAndServe")
}
}()
n.Logger.Info().Str("addr", n.nodeConfig.Instrumentation.PrometheusListenAddr).Msg("Started Prometheus HTTP server")
}
// Check if pprof is enabled
if n.nodeConfig.Instrumentation.IsPprofEnabled() {
pprofMux := http.NewServeMux()
// Register pprof handlers
pprofMux.HandleFunc("/debug/pprof/", pprof.Index)
pprofMux.HandleFunc("/debug/pprof/cmdline", pprof.Cmdline)
pprofMux.HandleFunc("/debug/pprof/profile", pprof.Profile)
pprofMux.HandleFunc("/debug/pprof/symbol", pprof.Symbol)
pprofMux.HandleFunc("/debug/pprof/trace", pprof.Trace)
// Register other pprof handlers
pprofMux.Handle("/debug/pprof/goroutine", pprof.Handler("goroutine"))
pprofMux.Handle("/debug/pprof/heap", pprof.Handler("heap"))
pprofMux.Handle("/debug/pprof/threadcreate", pprof.Handler("threadcreate"))
pprofMux.Handle("/debug/pprof/block", pprof.Handler("block"))
pprofMux.Handle("/debug/pprof/mutex", pprof.Handler("mutex"))
pprofMux.Handle("/debug/pprof/allocs", pprof.Handler("allocs"))
pprofServer = &http.Server{
Addr: n.nodeConfig.Instrumentation.GetPprofListenAddr(),
Handler: pprofMux,
ReadHeaderTimeout: readHeaderTimeout,
}
go func() {
if err := pprofServer.ListenAndServe(); err != nil && !errors.Is(err, http.ErrServerClosed) {
n.Logger.Error().Err(err).Msg("pprof HTTP server ListenAndServe")
}
}()
n.Logger.Info().Str("addr", n.nodeConfig.Instrumentation.GetPprofListenAddr()).Msg("Started pprof HTTP server")
}
// Return the primary server (for backward compatibility) and the secondary server
if prometheusServer != nil {
return prometheusServer, pprofServer
}
return pprofServer, nil
}
// Run implements the Service interface.
// It starts all subservices and manages the node's lifecycle.
func (n *FullNode) Run(parentCtx context.Context) error {
ctx, cancelNode := context.WithCancel(parentCtx)
defer cancelNode() // safety net
// begin prometheus metrics gathering if it is enabled
if n.nodeConfig.Instrumentation != nil &&
(n.nodeConfig.Instrumentation.IsPrometheusEnabled() || n.nodeConfig.Instrumentation.IsPprofEnabled()) {
n.prometheusSrv, n.pprofSrv = n.startInstrumentationServer()
}
// Start RPC server
handler, err := rpcserver.NewServiceHandler(n.Store, n.p2pClient, n.Logger)
if err != nil {
return fmt.Errorf("error creating RPC handler: %w", err)
}
n.rpcServer = &http.Server{
Addr: n.nodeConfig.RPC.Address,
Handler: handler,
ReadTimeout: 10 * time.Second,
WriteTimeout: 10 * time.Second,
IdleTimeout: 120 * time.Second,
}
go func() {
n.Logger.Info().Str("addr", n.nodeConfig.RPC.Address).Msg("started RPC server")
if err := n.rpcServer.ListenAndServe(); err != nil && !errors.Is(err, http.ErrServerClosed) {
n.Logger.Error().Err(err).Msg("RPC server error")
}
}()
n.Logger.Info().Msg("starting P2P client")
err = n.p2pClient.Start(ctx)
if err != nil {
return fmt.Errorf("error while starting P2P client: %w", err)
}
if err = n.hSyncService.Start(ctx); err != nil {
return fmt.Errorf("error while starting header sync service: %w", err)
}
if err = n.dSyncService.Start(ctx); err != nil {
return fmt.Errorf("error while starting data sync service: %w", err)
}
// only the first error is propagated
// any error is an issue, so blocking is not a problem
errCh := make(chan error, 1)
// prepare to join the go routines later
var wg sync.WaitGroup
spawnWorker := func(f func()) {
wg.Add(1)
go func() {
defer wg.Done()
f()
}()
}
if n.nodeConfig.Node.Aggregator {
n.Logger.Info().Dur("block_time", n.nodeConfig.Node.BlockTime.Duration).Msg("working in aggregator mode")
spawnWorker(func() { n.blockManager.AggregationLoop(ctx, errCh) })
spawnWorker(func() { n.reaper.Start(ctx) })
spawnWorker(func() { n.blockManager.HeaderSubmissionLoop(ctx) })
spawnWorker(func() { n.blockManager.DataSubmissionLoop(ctx) })
spawnWorker(func() { n.blockManager.DAIncluderLoop(ctx, errCh) })
} else {
spawnWorker(func() { n.blockManager.RetrieveLoop(ctx) })
spawnWorker(func() { n.blockManager.HeaderStoreRetrieveLoop(ctx) })
spawnWorker(func() { n.blockManager.DataStoreRetrieveLoop(ctx) })
spawnWorker(func() { n.blockManager.SyncLoop(ctx, errCh) })
spawnWorker(func() { n.blockManager.DAIncluderLoop(ctx, errCh) })
}
select {
case err := <-errCh:
if err != nil {
n.Logger.Error().Err(err).Msg("unrecoverable error in one of the go routines")
cancelNode() // propagate shutdown to all child goroutines
}
case <-parentCtx.Done():
// Block until parent context is canceled
n.Logger.Info().Msg("context canceled, stopping node")
cancelNode() // propagate shutdown to all child goroutines
}
// Perform cleanup
n.Logger.Info().Msg("halting full node and its sub services...")
// wait for all worker Go routines to finish so that we have
// no in-flight tasks while shutting down
wg.Wait()
// Use a timeout context to ensure shutdown doesn't hang
shutdownCtx, cancel := context.WithTimeout(context.Background(), 9*time.Second)
defer cancel()
var multiErr error // Use a multierror variable
// Stop Header Sync Service
err = n.hSyncService.Stop(shutdownCtx)
if err != nil {
// Log context canceled errors at a lower level if desired, or handle specific non-cancel errors
if !errors.Is(err, context.Canceled) && !errors.Is(err, context.DeadlineExceeded) {
n.Logger.Error().Err(err).Msg("error stopping header sync service")
multiErr = errors.Join(multiErr, fmt.Errorf("stopping header sync service: %w", err))
} else {
n.Logger.Debug().Err(err).Msg("header sync service stop context ended") // Log cancellation as debug
}
}
// Stop Data Sync Service
err = n.dSyncService.Stop(shutdownCtx)
if err != nil {
// Log context canceled errors at a lower level if desired, or handle specific non-cancel errors
if !errors.Is(err, context.Canceled) && !errors.Is(err, context.DeadlineExceeded) {
n.Logger.Error().Err(err).Msg("error stopping data sync service")
multiErr = errors.Join(multiErr, fmt.Errorf("stopping data sync service: %w", err))
} else {
n.Logger.Debug().Err(err).Msg("data sync service stop context ended") // Log cancellation as debug
}
}
// Stop P2P Client
err = n.p2pClient.Close()
if err != nil {
multiErr = errors.Join(multiErr, fmt.Errorf("closing P2P client: %w", err))
}
// Shutdown Prometheus Server
if n.prometheusSrv != nil {
err = n.prometheusSrv.Shutdown(shutdownCtx)
// http.ErrServerClosed is expected on graceful shutdown
if err != nil && !errors.Is(err, http.ErrServerClosed) {
multiErr = errors.Join(multiErr, fmt.Errorf("shutting down Prometheus server: %w", err))
} else {
n.Logger.Debug().Err(err).Msg("Prometheus server shutdown context ended")
}
}
// Shutdown Pprof Server
if n.pprofSrv != nil {
err = n.pprofSrv.Shutdown(shutdownCtx)
if err != nil && !errors.Is(err, http.ErrServerClosed) {
multiErr = errors.Join(multiErr, fmt.Errorf("shutting down pprof server: %w", err))
} else {
n.Logger.Debug().Err(err).Msg("pprof server shutdown context ended")
}
}
// Shutdown RPC Server
if n.rpcServer != nil {
err = n.rpcServer.Shutdown(shutdownCtx)
if err != nil && !errors.Is(err, http.ErrServerClosed) {
multiErr = errors.Join(multiErr, fmt.Errorf("shutting down RPC server: %w", err))
} else {
n.Logger.Debug().Err(err).Msg("RPC server shutdown context ended")
}
}
// Ensure Store.Close is called last to maximize chance of data flushing
if err = n.Store.Close(); err != nil {
multiErr = errors.Join(multiErr, fmt.Errorf("closing store: %w", err))
} else {
n.Logger.Debug().Msg("store closed")
}
// Save caches if needed
if err := n.blockManager.SaveCache(); err != nil {
multiErr = errors.Join(multiErr, fmt.Errorf("saving caches: %w", err))
} else {
n.Logger.Debug().Msg("caches saved")
}
// Log final status
if multiErr != nil {
for _, err := range multiErr.(interface{ Unwrap() []error }).Unwrap() {
n.Logger.Error().Err(err).Msg("error during shutdown")
}
} else {
n.Logger.Info().Msg("full node halted successfully")
}
// Return the original context error if it exists (e.g., context cancelled)
// or the combined shutdown error if the context cancellation was clean.
if ctx.Err() != nil {
return ctx.Err()
}
return multiErr // Return shutdown errors if context was okay
}
// GetGenesis returns entire genesis doc.
func (n *FullNode) GetGenesis() genesispkg.Genesis {
return n.genesis
}
// GetGenesisChunks returns chunked version of genesis.
func (n *FullNode) GetGenesisChunks() ([]string, error) {
err := n.initGenesisChunks()
if err != nil {
return nil, err
}
return n.genChunks, nil
}
// IsRunning returns true if the node is running.
func (n *FullNode) IsRunning() bool {
return n.blockManager != nil
}
// SetLogger sets the logger used by node.
func (n *FullNode) SetLogger(logger zerolog.Logger) {
n.Logger = logger
}
// GetLogger returns logger.
func (n *FullNode) GetLogger() zerolog.Logger {
return n.Logger
}
func newPrefixKV(kvStore ds.Batching, prefix string) ds.Batching {
return ktds.Wrap(kvStore, ktds.PrefixTransform{Prefix: ds.NewKey(prefix)})
}