hermez-node/node/node.go
node/node.goRaw
1package node
2
3import (
4 "context"
5 "errors"
6 "fmt"
7 "net"
8 "net/http"
9 "sync"
10 "time"
11
12 "github.com/ethereum/go-ethereum/accounts"
13 ethKeystore "github.com/ethereum/go-ethereum/accounts/keystore"
14 "github.com/ethereum/go-ethereum/ethclient"
15 "github.com/gin-contrib/cors"
16 "github.com/gin-gonic/gin"
17 "github.com/hermeznetwork/hermez-node/api"
18 "github.com/hermeznetwork/hermez-node/batchbuilder"
19 "github.com/hermeznetwork/hermez-node/common"
20 "github.com/hermeznetwork/hermez-node/config"
21 "github.com/hermeznetwork/hermez-node/coordinator"
22 dbUtils "github.com/hermeznetwork/hermez-node/db"
23 "github.com/hermeznetwork/hermez-node/db/historydb"
24 "github.com/hermeznetwork/hermez-node/db/l2db"
25 "github.com/hermeznetwork/hermez-node/db/statedb"
26 "github.com/hermeznetwork/hermez-node/eth"
27 "github.com/hermeznetwork/hermez-node/log"
28 "github.com/hermeznetwork/hermez-node/priceupdater"
29 "github.com/hermeznetwork/hermez-node/prover"
30 "github.com/hermeznetwork/hermez-node/synchronizer"
31 "github.com/hermeznetwork/hermez-node/test/debugapi"
32 "github.com/hermeznetwork/hermez-node/txprocessor"
33 "github.com/hermeznetwork/hermez-node/txselector"
34 "github.com/hermeznetwork/tracerr"
35 "github.com/jmoiron/sqlx"
36 "github.com/russross/meddler"
37)
38
39// Mode sets the working mode of the node (synchronizer or coordinator)
40type Mode string
41
42const (
43 // ModeCoordinator defines the mode of the HermezNode as Coordinator, which
44 // means that the node is set to forge (which also will be synchronizing with
45 // the L1 blockchain state)
46 ModeCoordinator Mode = "coordinator"
47
48 // ModeSynchronizer defines the mode of the HermezNode as Synchronizer, which
49 // means that the node is set to only synchronize with the L1 blockchain state
50 // and will not forge
51 ModeSynchronizer Mode = "synchronizer"
52)
53
54// Node is the Hermez Node
55type Node struct {
56 nodeAPI *NodeAPI
57 debugAPI *debugapi.DebugAPI
58 priceUpdater *priceupdater.PriceUpdater
59 // Coordinator
60 coord *coordinator.Coordinator
61
62 // Synchronizer
63 sync *synchronizer.Synchronizer
64
65 // General
66 cfg *config.Node
67 mode Mode
68 sqlConnRead *sqlx.DB
69 sqlConnWrite *sqlx.DB
70 ctx context.Context
71 wg sync.WaitGroup
72 cancel context.CancelFunc
73}
74
75// NewNode creates a Node
76func NewNode(mode Mode, cfg *config.Node) (*Node, error) {
77 meddler.Debug = cfg.Debug.MeddlerLogs
78 // Stablish DB connection
79 dbWrite, err := dbUtils.InitSQLDB(
80 cfg.PostgreSQL.PortWrite,
81 cfg.PostgreSQL.HostWrite,
82 cfg.PostgreSQL.UserWrite,
83 cfg.PostgreSQL.PasswordWrite,
84 cfg.PostgreSQL.NameWrite,
85 )
86 if err != nil {
87 return nil, tracerr.Wrap(fmt.Errorf("dbUtils.InitSQLDB: %w", err))
88 }
89 var dbRead *sqlx.DB
90 if cfg.PostgreSQL.HostRead == "" {
91 dbRead = dbWrite
92 } else if cfg.PostgreSQL.HostRead == cfg.PostgreSQL.HostWrite {
93 return nil, tracerr.Wrap(fmt.Errorf(
94 "PostgreSQL.HostRead and PostgreSQL.HostWrite must be different",
95 ))
96 } else {
97 dbRead, err = dbUtils.InitSQLDB(
98 cfg.PostgreSQL.PortRead,
99 cfg.PostgreSQL.HostRead,
100 cfg.PostgreSQL.UserRead,
101 cfg.PostgreSQL.PasswordRead,
102 cfg.PostgreSQL.NameRead,
103 )
104 if err != nil {
105 return nil, tracerr.Wrap(fmt.Errorf("dbUtils.InitSQLDB: %w", err))
106 }
107 }
108 var apiConnCon *dbUtils.APIConnectionController
109 if cfg.API.Explorer || mode == ModeCoordinator {
110 apiConnCon = dbUtils.NewAPICnnectionController(
111 cfg.API.MaxSQLConnections,
112 cfg.API.SQLConnectionTimeout.Duration,
113 )
114 }
115
116 historyDB := historydb.NewHistoryDB(dbRead, dbWrite, apiConnCon)
117
118 ethClient, err := ethclient.Dial(cfg.Web3.URL)
119 if err != nil {
120 return nil, tracerr.Wrap(err)
121 }
122 var ethCfg eth.EthereumConfig
123 var account *accounts.Account
124 var keyStore *ethKeystore.KeyStore
125 if mode == ModeCoordinator {
126 ethCfg = eth.EthereumConfig{
127 CallGasLimit: 0, // cfg.Coordinator.EthClient.CallGasLimit,
128 GasPriceDiv: 0, // cfg.Coordinator.EthClient.GasPriceDiv,
129 }
130
131 scryptN := ethKeystore.StandardScryptN
132 scryptP := ethKeystore.StandardScryptP
133 if cfg.Coordinator.Debug.LightScrypt {
134 scryptN = ethKeystore.LightScryptN
135 scryptP = ethKeystore.LightScryptP
136 }
137 keyStore = ethKeystore.NewKeyStore(cfg.Coordinator.EthClient.Keystore.Path,
138 scryptN, scryptP)
139
140 balance, err := ethClient.BalanceAt(context.TODO(), cfg.Coordinator.ForgerAddress, nil)
141 if err != nil {
142 return nil, tracerr.Wrap(err)
143 }
144
145 minForgeBalance := cfg.Coordinator.MinimumForgeAddressBalance
146 if minForgeBalance != nil && balance.Cmp(minForgeBalance) == -1 {
147 return nil, tracerr.Wrap(fmt.Errorf(
148 "forger account balance is less than cfg.Coordinator.MinimumForgeAddressBalance: %v < %v",
149 balance.Int64(), minForgeBalance))
150 }
151 log.Infow("forger ethereum account balance",
152 "addr", cfg.Coordinator.ForgerAddress,
153 "balance", balance.Int64(),
154 "minForgeBalance", minForgeBalance.Int64(),
155 )
156
157 // Unlock Coordinator ForgerAddr in the keystore to make calls
158 // to ForgeBatch in the smart contract
159 if !keyStore.HasAddress(cfg.Coordinator.ForgerAddress) {
160 return nil, tracerr.Wrap(fmt.Errorf(
161 "ethereum keystore doesn't have the key for address %v",
162 cfg.Coordinator.ForgerAddress))
163 }
164 account = &accounts.Account{
165 Address: cfg.Coordinator.ForgerAddress,
166 }
167 if err := keyStore.Unlock(*account,
168 cfg.Coordinator.EthClient.Keystore.Password); err != nil {
169 return nil, tracerr.Wrap(err)
170 }
171 log.Infow("Forger ethereum account unlocked in the keystore",
172 "addr", cfg.Coordinator.ForgerAddress)
173 }
174 client, err := eth.NewClient(ethClient, account, keyStore, ð.ClientConfig{
175 Ethereum: ethCfg,
176 Rollup: eth.RollupConfig{
177 Address: cfg.SmartContracts.Rollup,
178 },
179 Auction: eth.AuctionConfig{
180 Address: cfg.SmartContracts.Auction,
181 TokenHEZ: eth.TokenConfig{
182 Address: cfg.SmartContracts.TokenHEZ,
183 Name: cfg.SmartContracts.TokenHEZName,
184 },
185 },
186 WDelayer: eth.WDelayerConfig{
187 Address: cfg.SmartContracts.WDelayer,
188 },
189 })
190 if err != nil {
191 return nil, tracerr.Wrap(err)
192 }
193
194 chainID, err := client.EthChainID()
195 if err != nil {
196 return nil, tracerr.Wrap(err)
197 }
198 if !chainID.IsUint64() {
199 return nil, tracerr.Wrap(fmt.Errorf("chainID cannot be represented as uint64"))
200 }
201 chainIDU64 := chainID.Uint64()
202 const maxUint16 uint64 = 0xffff
203 if chainIDU64 > maxUint16 {
204 return nil, tracerr.Wrap(fmt.Errorf("chainID overflows uint16"))
205 }
206 chainIDU16 := uint16(chainIDU64)
207
208 const safeStateDBKeep = 128
209 if cfg.StateDB.Keep < safeStateDBKeep {
210 return nil, tracerr.Wrap(fmt.Errorf("cfg.StateDB.Keep = %v < %v, which is unsafe",
211 cfg.StateDB.Keep, safeStateDBKeep))
212 }
213 stateDB, err := statedb.NewStateDB(statedb.Config{
214 Path: cfg.StateDB.Path,
215 Keep: cfg.StateDB.Keep,
216 Type: statedb.TypeSynchronizer,
217 NLevels: statedb.MaxNLevels,
218 })
219 if err != nil {
220 return nil, tracerr.Wrap(err)
221 }
222
223 sync, err := synchronizer.NewSynchronizer(client, historyDB, stateDB, synchronizer.Config{
224 StatsRefreshPeriod: cfg.Synchronizer.StatsRefreshPeriod.Duration,
225 ChainID: chainIDU16,
226 })
227 if err != nil {
228 return nil, tracerr.Wrap(err)
229 }
230 initSCVars := sync.SCVars()
231
232 scConsts := synchronizer.SCConsts{
233 Rollup: *sync.RollupConstants(),
234 Auction: *sync.AuctionConstants(),
235 WDelayer: *sync.WDelayerConstants(),
236 }
237
238 var coord *coordinator.Coordinator
239 var l2DB *l2db.L2DB
240 if mode == ModeCoordinator {
241 l2DB = l2db.NewL2DB(
242 dbRead, dbWrite,
243 cfg.Coordinator.L2DB.SafetyPeriod,
244 cfg.Coordinator.L2DB.MaxTxs,
245 cfg.Coordinator.L2DB.MinFeeUSD,
246 cfg.Coordinator.L2DB.TTL.Duration,
247 apiConnCon,
248 )
249
250 // Unlock FeeAccount EthAddr in the keystore to generate the
251 // account creation authorization
252 if !keyStore.HasAddress(cfg.Coordinator.FeeAccount.Address) {
253 return nil, tracerr.Wrap(fmt.Errorf(
254 "ethereum keystore doesn't have the key for address %v",
255 cfg.Coordinator.FeeAccount.Address))
256 }
257 feeAccount := accounts.Account{
258 Address: cfg.Coordinator.FeeAccount.Address,
259 }
260 if err := keyStore.Unlock(feeAccount,
261 cfg.Coordinator.EthClient.Keystore.Password); err != nil {
262 return nil, tracerr.Wrap(err)
263 }
264 auth := &common.AccountCreationAuth{
265 EthAddr: cfg.Coordinator.FeeAccount.Address,
266 BJJ: cfg.Coordinator.FeeAccount.BJJ,
267 }
268 if err := auth.Sign(func(msg []byte) ([]byte, error) {
269 return keyStore.SignHash(feeAccount, msg)
270 }, chainIDU16, cfg.SmartContracts.Rollup); err != nil {
271 return nil, err
272 }
273 coordAccount := &txselector.CoordAccount{
274 Addr: cfg.Coordinator.FeeAccount.Address,
275 BJJ: cfg.Coordinator.FeeAccount.BJJ,
276 AccountCreationAuth: auth.Signature,
277 }
278 txSelector, err := txselector.NewTxSelector(coordAccount, cfg.Coordinator.TxSelector.Path, stateDB, l2DB)
279 if err != nil {
280 return nil, tracerr.Wrap(err)
281 }
282 batchBuilder, err := batchbuilder.NewBatchBuilder(cfg.Coordinator.BatchBuilder.Path,
283 stateDB, 0, uint64(cfg.Coordinator.Circuit.NLevels))
284 if err != nil {
285 return nil, tracerr.Wrap(err)
286 }
287 serverProofs := make([]prover.Client, len(cfg.Coordinator.ServerProofs))
288 for i, serverProofCfg := range cfg.Coordinator.ServerProofs {
289 serverProofs[i] = prover.NewProofServerClient(serverProofCfg.URL,
290 cfg.Coordinator.ProofServerPollInterval.Duration)
291 }
292
293 txProcessorCfg := txprocessor.Config{
294 NLevels: uint32(cfg.Coordinator.Circuit.NLevels),
295 MaxTx: uint32(cfg.Coordinator.Circuit.MaxTx),
296 ChainID: chainIDU16,
297 MaxFeeTx: common.RollupConstMaxFeeIdxCoordinator,
298 MaxL1Tx: common.RollupConstMaxL1Tx,
299 }
300 var verifierIdx int
301 if cfg.Coordinator.Debug.RollupVerifierIndex == nil {
302 verifierIdx, err = scConsts.Rollup.FindVerifierIdx(
303 cfg.Coordinator.Circuit.MaxTx,
304 cfg.Coordinator.Circuit.NLevels,
305 )
306 if err != nil {
307 return nil, tracerr.Wrap(err)
308 }
309 log.Infow("Found verifier that matches circuit config", "verifierIdx", verifierIdx)
310 } else {
311 verifierIdx = *cfg.Coordinator.Debug.RollupVerifierIndex
312 log.Infow("Using debug verifier index from config", "verifierIdx", verifierIdx)
313 if verifierIdx >= len(scConsts.Rollup.Verifiers) {
314 return nil, tracerr.Wrap(
315 fmt.Errorf("verifierIdx (%v) >= "+
316 "len(scConsts.Rollup.Verifiers) (%v)",
317 verifierIdx, len(scConsts.Rollup.Verifiers)))
318 }
319 verifier := scConsts.Rollup.Verifiers[verifierIdx]
320 if verifier.MaxTx != cfg.Coordinator.Circuit.MaxTx ||
321 verifier.NLevels != cfg.Coordinator.Circuit.NLevels {
322 return nil, tracerr.Wrap(
323 fmt.Errorf("Circuit config and verifier params don't match. "+
324 "circuit.MaxTx = %v, circuit.NLevels = %v, "+
325 "verifier.MaxTx = %v, verifier.NLevels = %v",
326 cfg.Coordinator.Circuit.MaxTx, cfg.Coordinator.Circuit.NLevels,
327 verifier.MaxTx, verifier.NLevels,
328 ))
329 }
330 }
331
332 coord, err = coordinator.NewCoordinator(
333 coordinator.Config{
334 ForgerAddress: cfg.Coordinator.ForgerAddress,
335 ConfirmBlocks: cfg.Coordinator.ConfirmBlocks,
336 L1BatchTimeoutPerc: cfg.Coordinator.L1BatchTimeoutPerc,
337 ForgeRetryInterval: cfg.Coordinator.ForgeRetryInterval.Duration,
338 ForgeDelay: cfg.Coordinator.ForgeDelay.Duration,
339 ForgeNoTxsDelay: cfg.Coordinator.ForgeNoTxsDelay.Duration,
340 SyncRetryInterval: cfg.Coordinator.SyncRetryInterval.Duration,
341 PurgeByExtDelInterval: cfg.Coordinator.PurgeByExtDelInterval.Duration,
342 EthClientAttempts: cfg.Coordinator.EthClient.Attempts,
343 EthClientAttemptsDelay: cfg.Coordinator.EthClient.AttemptsDelay.Duration,
344 EthNoReuseNonce: cfg.Coordinator.EthClient.NoReuseNonce,
345 EthTxResendTimeout: cfg.Coordinator.EthClient.TxResendTimeout.Duration,
346 MaxGasPrice: cfg.Coordinator.EthClient.MaxGasPrice,
347 GasPriceIncPerc: cfg.Coordinator.EthClient.GasPriceIncPerc,
348 TxManagerCheckInterval: cfg.Coordinator.EthClient.CheckLoopInterval.Duration,
349 DebugBatchPath: cfg.Coordinator.Debug.BatchPath,
350 Purger: coordinator.PurgerCfg{
351 PurgeBatchDelay: cfg.Coordinator.L2DB.PurgeBatchDelay,
352 InvalidateBatchDelay: cfg.Coordinator.L2DB.InvalidateBatchDelay,
353 PurgeBlockDelay: cfg.Coordinator.L2DB.PurgeBlockDelay,
354 InvalidateBlockDelay: cfg.Coordinator.L2DB.InvalidateBlockDelay,
355 },
356 ForgeBatchGasCost: cfg.Coordinator.EthClient.ForgeBatchGasCost,
357 VerifierIdx: uint8(verifierIdx),
358 TxProcessorConfig: txProcessorCfg,
359 },
360 historyDB,
361 l2DB,
362 txSelector,
363 batchBuilder,
364 serverProofs,
365 client,
366 &scConsts,
367 &synchronizer.SCVariables{
368 Rollup: *initSCVars.Rollup,
369 Auction: *initSCVars.Auction,
370 WDelayer: *initSCVars.WDelayer,
371 },
372 )
373 if err != nil {
374 return nil, tracerr.Wrap(err)
375 }
376 }
377 var nodeAPI *NodeAPI
378 if cfg.API.Address != "" {
379 if cfg.Debug.GinDebugMode {
380 gin.SetMode(gin.DebugMode)
381 } else {
382 gin.SetMode(gin.ReleaseMode)
383 }
384 if cfg.API.UpdateMetricsInterval.Duration == 0 {
385 return nil, tracerr.Wrap(fmt.Errorf("invalid cfg.API.UpdateMetricsInterval: %v",
386 cfg.API.UpdateMetricsInterval.Duration))
387 }
388 if cfg.API.UpdateRecommendedFeeInterval.Duration == 0 {
389 return nil, tracerr.Wrap(fmt.Errorf("invalid cfg.API.UpdateRecommendedFeeInterval: %v",
390 cfg.API.UpdateRecommendedFeeInterval.Duration))
391 }
392 server := gin.Default()
393 coord := false
394 if mode == ModeCoordinator {
395 coord = cfg.Coordinator.API.Coordinator
396 }
397 var err error
398 nodeAPI, err = NewNodeAPI(
399 cfg.API.Address,
400 coord, cfg.API.Explorer,
401 server,
402 historyDB,
403 stateDB,
404 l2DB,
405 &api.Config{
406 RollupConstants: scConsts.Rollup,
407 AuctionConstants: scConsts.Auction,
408 WDelayerConstants: scConsts.WDelayer,
409 ChainID: chainIDU16,
410 HermezAddress: cfg.SmartContracts.Rollup,
411 },
412 )
413 if err != nil {
414 return nil, tracerr.Wrap(err)
415 }
416 nodeAPI.api.SetRollupVariables(*initSCVars.Rollup)
417 nodeAPI.api.SetAuctionVariables(*initSCVars.Auction)
418 nodeAPI.api.SetWDelayerVariables(*initSCVars.WDelayer)
419 }
420 var debugAPI *debugapi.DebugAPI
421 if cfg.Debug.APIAddress != "" {
422 debugAPI = debugapi.NewDebugAPI(cfg.Debug.APIAddress, stateDB, sync)
423 }
424 priceUpdater, err := priceupdater.NewPriceUpdater(cfg.PriceUpdater.URL,
425 priceupdater.APIType(cfg.PriceUpdater.Type), historyDB)
426 if err != nil {
427 return nil, tracerr.Wrap(err)
428 }
429 ctx, cancel := context.WithCancel(context.Background())
430 return &Node{
431 nodeAPI: nodeAPI,
432 debugAPI: debugAPI,
433 priceUpdater: priceUpdater,
434 coord: coord,
435 sync: sync,
436 cfg: cfg,
437 mode: mode,
438 sqlConnRead: dbRead,
439 sqlConnWrite: dbWrite,
440 ctx: ctx,
441 cancel: cancel,
442 }, nil
443}
444
445// NodeAPI holds the node http API
446type NodeAPI struct { //nolint:golint
447 api *api.API
448 engine *gin.Engine
449 addr string
450}
451
452func handleNoRoute(c *gin.Context) {
453 c.JSON(http.StatusNotFound, gin.H{
454 "error": "404 page not found",
455 })
456}
457
458// NewNodeAPI creates a new NodeAPI (which internally calls api.NewAPI)
459func NewNodeAPI(
460 addr string,
461 coordinatorEndpoints, explorerEndpoints bool,
462 server *gin.Engine,
463 hdb *historydb.HistoryDB,
464 sdb *statedb.StateDB,
465 l2db *l2db.L2DB,
466 config *api.Config,
467) (*NodeAPI, error) {
468 engine := gin.Default()
469 engine.NoRoute(handleNoRoute)
470 engine.Use(cors.Default())
471 _api, err := api.NewAPI(
472 coordinatorEndpoints, explorerEndpoints,
473 engine,
474 hdb,
475 l2db,
476 config,
477 )
478 if err != nil {
479 return nil, tracerr.Wrap(err)
480 }
481 return &NodeAPI{
482 addr: addr,
483 api: _api,
484 engine: engine,
485 }, nil
486}
487
488// Run starts the http server of the NodeAPI. To stop it, pass a context with
489// cancelation.
490func (a *NodeAPI) Run(ctx context.Context) error {
491 server := &http.Server{
492 Handler: a.engine,
493 // TODO: Figure out best parameters for production
494 ReadTimeout: 30 * time.Second, //nolint:gomnd
495 WriteTimeout: 30 * time.Second, //nolint:gomnd
496 MaxHeaderBytes: 1 << 20, //nolint:gomnd
497 }
498 listener, err := net.Listen("tcp", a.addr)
499 if err != nil {
500 return tracerr.Wrap(err)
501 }
502 log.Infof("NodeAPI is ready at %v", a.addr)
503 go func() {
504 if err := server.Serve(listener); err != nil &&
505 tracerr.Unwrap(err) != http.ErrServerClosed {
506 log.Fatalf("Listen: %s\n", err)
507 }
508 }()
509
510 <-ctx.Done()
511 log.Info("Stopping NodeAPI...")
512 ctxTimeout, cancel := context.WithTimeout(context.Background(), 10*time.Second) //nolint:gomnd
513 defer cancel()
514 if err := server.Shutdown(ctxTimeout); err != nil {
515 return tracerr.Wrap(err)
516 }
517 log.Info("NodeAPI done")
518 return nil
519}
520
521func (n *Node) handleNewBlock(ctx context.Context, stats *synchronizer.Stats, vars synchronizer.SCVariablesPtr,
522 batches []common.BatchData) {
523 if n.mode == ModeCoordinator {
524 n.coord.SendMsg(ctx, coordinator.MsgSyncBlock{
525 Stats: *stats,
526 Vars: vars,
527 Batches: batches,
528 })
529 }
530 if n.nodeAPI != nil {
531 if vars.Rollup != nil {
532 n.nodeAPI.api.SetRollupVariables(*vars.Rollup)
533 }
534 if vars.Auction != nil {
535 n.nodeAPI.api.SetAuctionVariables(*vars.Auction)
536 }
537 if vars.WDelayer != nil {
538 n.nodeAPI.api.SetWDelayerVariables(*vars.WDelayer)
539 }
540
541 if stats.Synced() {
542 if err := n.nodeAPI.api.UpdateNetworkInfo(
543 stats.Eth.LastBlock, stats.Sync.LastBlock,
544 common.BatchNum(stats.Eth.LastBatchNum),
545 stats.Sync.Auction.CurrentSlot.SlotNum,
546 ); err != nil {
547 log.Errorw("API.UpdateNetworkInfo", "err", err)
548 }
549 } else {
550 n.nodeAPI.api.UpdateNetworkInfoBlock(
551 stats.Eth.LastBlock, stats.Sync.LastBlock,
552 )
553 }
554 }
555}
556
557func (n *Node) handleReorg(ctx context.Context, stats *synchronizer.Stats, vars synchronizer.SCVariablesPtr) {
558 if n.mode == ModeCoordinator {
559 n.coord.SendMsg(ctx, coordinator.MsgSyncReorg{
560 Stats: *stats,
561 Vars: vars,
562 })
563 }
564 if n.nodeAPI != nil {
565 vars := n.sync.SCVars()
566 n.nodeAPI.api.SetRollupVariables(*vars.Rollup)
567 n.nodeAPI.api.SetAuctionVariables(*vars.Auction)
568 n.nodeAPI.api.SetWDelayerVariables(*vars.WDelayer)
569 n.nodeAPI.api.UpdateNetworkInfoBlock(
570 stats.Eth.LastBlock, stats.Sync.LastBlock,
571 )
572 }
573}
574
575// TODO(Edu): Consider keeping the `lastBlock` inside synchronizer so that we
576// don't have to pass it around.
577func (n *Node) syncLoopFn(ctx context.Context, lastBlock *common.Block) (*common.Block, time.Duration, error) {
578 blockData, discarded, err := n.sync.Sync(ctx, lastBlock)
579 stats := n.sync.Stats()
580 if err != nil {
581 // case: error
582 return nil, n.cfg.Synchronizer.SyncLoopInterval.Duration, tracerr.Wrap(err)
583 } else if discarded != nil {
584 // case: reorg
585 log.Infow("Synchronizer.Sync reorg", "discarded", *discarded)
586 vars := n.sync.SCVars()
587 n.handleReorg(ctx, stats, vars)
588 return nil, time.Duration(0), nil
589 } else if blockData != nil {
590 // case: new block
591 vars := synchronizer.SCVariablesPtr{
592 Rollup: blockData.Rollup.Vars,
593 Auction: blockData.Auction.Vars,
594 WDelayer: blockData.WDelayer.Vars,
595 }
596 n.handleNewBlock(ctx, stats, vars, blockData.Rollup.Batches)
597 return &blockData.Block, time.Duration(0), nil
598 } else {
599 // case: no block
600 return lastBlock, n.cfg.Synchronizer.SyncLoopInterval.Duration, nil
601 }
602}
603
604// StartSynchronizer starts the synchronizer
605func (n *Node) StartSynchronizer() {
606 log.Info("Starting Synchronizer...")
607
608 // Trigger a manual call to handleNewBlock with the loaded state of the
609 // synchronizer in order to quickly activate the API and Coordinator
610 // and avoid waiting for the next block. Without this, the API and
611 // Coordinator will not react until the following block (starting from
612 // the last synced one) is synchronized
613 stats := n.sync.Stats()
614 vars := n.sync.SCVars()
615 n.handleNewBlock(n.ctx, stats, vars, []common.BatchData{})
616
617 n.wg.Add(1)
618 go func() {
619 var err error
620 var lastBlock *common.Block
621 waitDuration := time.Duration(0)
622 for {
623 select {
624 case <-n.ctx.Done():
625 log.Info("Synchronizer done")
626 n.wg.Done()
627 return
628 case <-time.After(waitDuration):
629 if lastBlock, waitDuration, err = n.syncLoopFn(n.ctx,
630 lastBlock); err != nil {
631 if n.ctx.Err() != nil {
632 continue
633 }
634 if errors.Is(err, eth.ErrBlockHashMismatchEvent) {
635 log.Warnw("Synchronizer.Sync", "err", err)
636 } else if errors.Is(err, synchronizer.ErrUnknownBlock) {
637 log.Warnw("Synchronizer.Sync", "err", err)
638 } else {
639 log.Errorw("Synchronizer.Sync", "err", err)
640 }
641 }
642 }
643 }
644 }()
645
646 n.wg.Add(1)
647 go func() {
648 for {
649 select {
650 case <-n.ctx.Done():
651 log.Info("PriceUpdater done")
652 n.wg.Done()
653 return
654 case <-time.After(n.cfg.PriceUpdater.Interval.Duration):
655 if err := n.priceUpdater.UpdateTokenList(); err != nil {
656 log.Errorw("PriceUpdater.UpdateTokenList()", "err", err)
657 }
658 n.priceUpdater.UpdatePrices(n.ctx)
659 }
660 }
661 }()
662}
663
664// StartDebugAPI starts the DebugAPI
665func (n *Node) StartDebugAPI() {
666 log.Info("Starting DebugAPI...")
667 n.wg.Add(1)
668 go func() {
669 defer func() {
670 log.Info("DebugAPI routine stopped")
671 n.wg.Done()
672 }()
673 if err := n.debugAPI.Run(n.ctx); err != nil {
674 if n.ctx.Err() != nil {
675 return
676 }
677 log.Fatalw("DebugAPI.Run", "err", err)
678 }
679 }()
680}
681
682// StartNodeAPI starts the NodeAPI
683func (n *Node) StartNodeAPI() {
684 log.Info("Starting NodeAPI...")
685 n.wg.Add(1)
686 go func() {
687 defer func() {
688 log.Info("NodeAPI routine stopped")
689 n.wg.Done()
690 }()
691 if err := n.nodeAPI.Run(n.ctx); err != nil {
692 if n.ctx.Err() != nil {
693 return
694 }
695 log.Fatalw("NodeAPI.Run", "err", err)
696 }
697 }()
698
699 n.wg.Add(1)
700 go func() {
701 // Do an initial update on startup
702 if err := n.nodeAPI.api.UpdateMetrics(); err != nil {
703 log.Errorw("API.UpdateMetrics", "err", err)
704 }
705 for {
706 select {
707 case <-n.ctx.Done():
708 log.Info("API.UpdateMetrics loop done")
709 n.wg.Done()
710 return
711 case <-time.After(n.cfg.API.UpdateMetricsInterval.Duration):
712 if err := n.nodeAPI.api.UpdateMetrics(); err != nil {
713 log.Errorw("API.UpdateMetrics", "err", err)
714 }
715 }
716 }
717 }()
718
719 n.wg.Add(1)
720 go func() {
721 // Do an initial update on startup
722 if err := n.nodeAPI.api.UpdateRecommendedFee(); err != nil {
723 log.Errorw("API.UpdateRecommendedFee", "err", err)
724 }
725 for {
726 select {
727 case <-n.ctx.Done():
728 log.Info("API.UpdateRecommendedFee loop done")
729 n.wg.Done()
730 return
731 case <-time.After(n.cfg.API.UpdateRecommendedFeeInterval.Duration):
732 if err := n.nodeAPI.api.UpdateRecommendedFee(); err != nil {
733 log.Errorw("API.UpdateRecommendedFee", "err", err)
734 }
735 }
736 }
737 }()
738}
739
740// Start the node
741func (n *Node) Start() {
742 log.Infow("Starting node...", "mode", n.mode)
743 if n.debugAPI != nil {
744 n.StartDebugAPI()
745 }
746 if n.nodeAPI != nil {
747 n.StartNodeAPI()
748 }
749 if n.mode == ModeCoordinator {
750 log.Info("Starting Coordinator...")
751 n.coord.Start()
752 }
753 n.StartSynchronizer()
754}
755
756// Stop the node
757func (n *Node) Stop() {
758 log.Infow("Stopping node...")
759 n.cancel()
760 n.wg.Wait()
761 if n.mode == ModeCoordinator {
762 log.Info("Stopping Coordinator...")
763 n.coord.Stop()
764 }
765 // Close kv DBs
766 n.sync.StateDB().Close()
767 if n.mode == ModeCoordinator {
768 n.coord.TxSelector().LocalAccountsDB().Close()
769 n.coord.BatchBuilder().LocalStateDB().Close()
770 }
771}