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.NewAPIConnectionController(
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, minForgeBalance))
150 }
151 log.Infow("forger ethereum account balance",
152 "addr", cfg.Coordinator.ForgerAddress,
153 "balance", balance,
154 "minForgeBalance", minForgeBalance,
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 var l2DB *l2db.L2DB
224 if mode == ModeCoordinator {
225 l2DB = l2db.NewL2DB(
226 dbRead, dbWrite,
227 cfg.Coordinator.L2DB.SafetyPeriod,
228 cfg.Coordinator.L2DB.MaxTxs,
229 cfg.Coordinator.L2DB.MinFeeUSD,
230 cfg.Coordinator.L2DB.TTL.Duration,
231 apiConnCon,
232 )
233 }
234
235 sync, err := synchronizer.NewSynchronizer(client, historyDB, l2DB, stateDB, synchronizer.Config{
236 StatsRefreshPeriod: cfg.Synchronizer.StatsRefreshPeriod.Duration,
237 ChainID: chainIDU16,
238 })
239 if err != nil {
240 return nil, tracerr.Wrap(err)
241 }
242 initSCVars := sync.SCVars()
243
244 scConsts := synchronizer.SCConsts{
245 Rollup: *sync.RollupConstants(),
246 Auction: *sync.AuctionConstants(),
247 WDelayer: *sync.WDelayerConstants(),
248 }
249
250 var coord *coordinator.Coordinator
251 if mode == ModeCoordinator {
252 // Unlock FeeAccount EthAddr in the keystore to generate the
253 // account creation authorization
254 if !keyStore.HasAddress(cfg.Coordinator.FeeAccount.Address) {
255 return nil, tracerr.Wrap(fmt.Errorf(
256 "ethereum keystore doesn't have the key for address %v",
257 cfg.Coordinator.FeeAccount.Address))
258 }
259 feeAccount := accounts.Account{
260 Address: cfg.Coordinator.FeeAccount.Address,
261 }
262 if err := keyStore.Unlock(feeAccount,
263 cfg.Coordinator.EthClient.Keystore.Password); err != nil {
264 return nil, tracerr.Wrap(err)
265 }
266 auth := &common.AccountCreationAuth{
267 EthAddr: cfg.Coordinator.FeeAccount.Address,
268 BJJ: cfg.Coordinator.FeeAccount.BJJ,
269 }
270 if err := auth.Sign(func(msg []byte) ([]byte, error) {
271 return keyStore.SignHash(feeAccount, msg)
272 }, chainIDU16, cfg.SmartContracts.Rollup); err != nil {
273 return nil, tracerr.Wrap(err)
274 }
275 coordAccount := &txselector.CoordAccount{
276 Addr: cfg.Coordinator.FeeAccount.Address,
277 BJJ: cfg.Coordinator.FeeAccount.BJJ,
278 AccountCreationAuth: auth.Signature,
279 }
280 txSelector, err := txselector.NewTxSelector(coordAccount,
281 cfg.Coordinator.TxSelector.Path, stateDB, l2DB)
282 if err != nil {
283 return nil, tracerr.Wrap(err)
284 }
285 batchBuilder, err := batchbuilder.NewBatchBuilder(cfg.Coordinator.BatchBuilder.Path,
286 stateDB, 0, uint64(cfg.Coordinator.Circuit.NLevels))
287 if err != nil {
288 return nil, tracerr.Wrap(err)
289 }
290 serverProofs := make([]prover.Client, len(cfg.Coordinator.ServerProofs))
291 for i, serverProofCfg := range cfg.Coordinator.ServerProofs {
292 serverProofs[i] = prover.NewProofServerClient(serverProofCfg.URL,
293 cfg.Coordinator.ProofServerPollInterval.Duration)
294 }
295
296 txProcessorCfg := txprocessor.Config{
297 NLevels: uint32(cfg.Coordinator.Circuit.NLevels),
298 MaxTx: uint32(cfg.Coordinator.Circuit.MaxTx),
299 ChainID: chainIDU16,
300 MaxFeeTx: common.RollupConstMaxFeeIdxCoordinator,
301 MaxL1Tx: common.RollupConstMaxL1Tx,
302 }
303 var verifierIdx int
304 if cfg.Coordinator.Debug.RollupVerifierIndex == nil {
305 verifierIdx, err = scConsts.Rollup.FindVerifierIdx(
306 cfg.Coordinator.Circuit.MaxTx,
307 cfg.Coordinator.Circuit.NLevels,
308 )
309 if err != nil {
310 return nil, tracerr.Wrap(err)
311 }
312 log.Infow("Found verifier that matches circuit config", "verifierIdx", verifierIdx)
313 } else {
314 verifierIdx = *cfg.Coordinator.Debug.RollupVerifierIndex
315 log.Infow("Using debug verifier index from config", "verifierIdx", verifierIdx)
316 if verifierIdx >= len(scConsts.Rollup.Verifiers) {
317 return nil, tracerr.Wrap(
318 fmt.Errorf("verifierIdx (%v) >= "+
319 "len(scConsts.Rollup.Verifiers) (%v)",
320 verifierIdx, len(scConsts.Rollup.Verifiers)))
321 }
322 verifier := scConsts.Rollup.Verifiers[verifierIdx]
323 if verifier.MaxTx != cfg.Coordinator.Circuit.MaxTx ||
324 verifier.NLevels != cfg.Coordinator.Circuit.NLevels {
325 return nil, tracerr.Wrap(
326 fmt.Errorf("Circuit config and verifier params don't match. "+
327 "circuit.MaxTx = %v, circuit.NLevels = %v, "+
328 "verifier.MaxTx = %v, verifier.NLevels = %v",
329 cfg.Coordinator.Circuit.MaxTx, cfg.Coordinator.Circuit.NLevels,
330 verifier.MaxTx, verifier.NLevels,
331 ))
332 }
333 }
334
335 coord, err = coordinator.NewCoordinator(
336 coordinator.Config{
337 ForgerAddress: cfg.Coordinator.ForgerAddress,
338 ConfirmBlocks: cfg.Coordinator.ConfirmBlocks,
339 L1BatchTimeoutPerc: cfg.Coordinator.L1BatchTimeoutPerc,
340 ForgeRetryInterval: cfg.Coordinator.ForgeRetryInterval.Duration,
341 ForgeDelay: cfg.Coordinator.ForgeDelay.Duration,
342 ForgeNoTxsDelay: cfg.Coordinator.ForgeNoTxsDelay.Duration,
343 SyncRetryInterval: cfg.Coordinator.SyncRetryInterval.Duration,
344 PurgeByExtDelInterval: cfg.Coordinator.PurgeByExtDelInterval.Duration,
345 EthClientAttempts: cfg.Coordinator.EthClient.Attempts,
346 EthClientAttemptsDelay: cfg.Coordinator.EthClient.AttemptsDelay.Duration,
347 EthNoReuseNonce: cfg.Coordinator.EthClient.NoReuseNonce,
348 EthTxResendTimeout: cfg.Coordinator.EthClient.TxResendTimeout.Duration,
349 MaxGasPrice: cfg.Coordinator.EthClient.MaxGasPrice,
350 GasPriceIncPerc: cfg.Coordinator.EthClient.GasPriceIncPerc,
351 TxManagerCheckInterval: cfg.Coordinator.EthClient.CheckLoopInterval.Duration,
352 DebugBatchPath: cfg.Coordinator.Debug.BatchPath,
353 Purger: coordinator.PurgerCfg{
354 PurgeBatchDelay: cfg.Coordinator.L2DB.PurgeBatchDelay,
355 InvalidateBatchDelay: cfg.Coordinator.L2DB.InvalidateBatchDelay,
356 PurgeBlockDelay: cfg.Coordinator.L2DB.PurgeBlockDelay,
357 InvalidateBlockDelay: cfg.Coordinator.L2DB.InvalidateBlockDelay,
358 },
359 ForgeBatchGasCost: cfg.Coordinator.EthClient.ForgeBatchGasCost,
360 VerifierIdx: uint8(verifierIdx),
361 TxProcessorConfig: txProcessorCfg,
362 },
363 historyDB,
364 l2DB,
365 txSelector,
366 batchBuilder,
367 serverProofs,
368 client,
369 &scConsts,
370 &synchronizer.SCVariables{
371 Rollup: *initSCVars.Rollup,
372 Auction: *initSCVars.Auction,
373 WDelayer: *initSCVars.WDelayer,
374 },
375 )
376 if err != nil {
377 return nil, tracerr.Wrap(err)
378 }
379 }
380 var nodeAPI *NodeAPI
381 if cfg.API.Address != "" {
382 if cfg.Debug.GinDebugMode {
383 gin.SetMode(gin.DebugMode)
384 } else {
385 gin.SetMode(gin.ReleaseMode)
386 }
387 if cfg.API.UpdateMetricsInterval.Duration == 0 {
388 return nil, tracerr.Wrap(fmt.Errorf("invalid cfg.API.UpdateMetricsInterval: %v",
389 cfg.API.UpdateMetricsInterval.Duration))
390 }
391 if cfg.API.UpdateRecommendedFeeInterval.Duration == 0 {
392 return nil, tracerr.Wrap(fmt.Errorf("invalid cfg.API.UpdateRecommendedFeeInterval: %v",
393 cfg.API.UpdateRecommendedFeeInterval.Duration))
394 }
395 server := gin.Default()
396 coord := false
397 if mode == ModeCoordinator {
398 coord = cfg.Coordinator.API.Coordinator
399 }
400 var err error
401 nodeAPI, err = NewNodeAPI(
402 cfg.API.Address,
403 coord, cfg.API.Explorer,
404 server,
405 historyDB,
406 stateDB,
407 l2DB,
408 &api.Config{
409 RollupConstants: scConsts.Rollup,
410 AuctionConstants: scConsts.Auction,
411 WDelayerConstants: scConsts.WDelayer,
412 ChainID: chainIDU16,
413 HermezAddress: cfg.SmartContracts.Rollup,
414 },
415 cfg.Coordinator.ForgeDelay.Duration,
416 )
417 if err != nil {
418 return nil, tracerr.Wrap(err)
419 }
420 nodeAPI.api.SetRollupVariables(*initSCVars.Rollup)
421 nodeAPI.api.SetAuctionVariables(*initSCVars.Auction)
422 nodeAPI.api.SetWDelayerVariables(*initSCVars.WDelayer)
423 }
424 var debugAPI *debugapi.DebugAPI
425 if cfg.Debug.APIAddress != "" {
426 debugAPI = debugapi.NewDebugAPI(cfg.Debug.APIAddress, stateDB, sync)
427 }
428 priceUpdater, err := priceupdater.NewPriceUpdater(
429 cfg.PriceUpdater.DefaultUpdateMethod,
430 cfg.PriceUpdater.TokensConfig,
431 historyDB,
432 cfg.PriceUpdater.URLBitfinexV2,
433 cfg.PriceUpdater.URLCoinGeckoV3,
434 )
435 if err != nil {
436 return nil, tracerr.Wrap(err)
437 }
438 ctx, cancel := context.WithCancel(context.Background())
439 return &Node{
440 nodeAPI: nodeAPI,
441 debugAPI: debugAPI,
442 priceUpdater: priceUpdater,
443 coord: coord,
444 sync: sync,
445 cfg: cfg,
446 mode: mode,
447 sqlConnRead: dbRead,
448 sqlConnWrite: dbWrite,
449 ctx: ctx,
450 cancel: cancel,
451 }, nil
452}
453
454// NodeAPI holds the node http API
455type NodeAPI struct { //nolint:golint
456 api *api.API
457 engine *gin.Engine
458 addr string
459}
460
461func handleNoRoute(c *gin.Context) {
462 c.JSON(http.StatusNotFound, gin.H{
463 "error": "404 page not found",
464 })
465}
466
467// NewNodeAPI creates a new NodeAPI (which internally calls api.NewAPI)
468func NewNodeAPI(
469 addr string,
470 coordinatorEndpoints, explorerEndpoints bool,
471 server *gin.Engine,
472 hdb *historydb.HistoryDB,
473 sdb *statedb.StateDB,
474 l2db *l2db.L2DB,
475 config *api.Config,
476 forgeDelay time.Duration,
477) (*NodeAPI, error) {
478 engine := gin.Default()
479 engine.NoRoute(handleNoRoute)
480 engine.Use(cors.Default())
481 _api, err := api.NewAPI(
482 coordinatorEndpoints, explorerEndpoints,
483 engine,
484 hdb,
485 l2db,
486 config,
487 &api.NodeConfig{
488 ForgeDelay: forgeDelay.Seconds(),
489 },
490 )
491 if err != nil {
492 return nil, tracerr.Wrap(err)
493 }
494 return &NodeAPI{
495 addr: addr,
496 api: _api,
497 engine: engine,
498 }, nil
499}
500
501// Run starts the http server of the NodeAPI. To stop it, pass a context
502// with cancellation.
503func (a *NodeAPI) Run(ctx context.Context) error {
504 server := &http.Server{
505 Handler: a.engine,
506 // TODO: Figure out best parameters for production
507 ReadTimeout: 30 * time.Second, //nolint:gomnd
508 WriteTimeout: 30 * time.Second, //nolint:gomnd
509 MaxHeaderBytes: 1 << 20, //nolint:gomnd
510 }
511 listener, err := net.Listen("tcp", a.addr)
512 if err != nil {
513 return tracerr.Wrap(err)
514 }
515 log.Infof("NodeAPI is ready at %v", a.addr)
516 go func() {
517 if err := server.Serve(listener); err != nil &&
518 tracerr.Unwrap(err) != http.ErrServerClosed {
519 log.Fatalf("Listen: %s\n", err)
520 }
521 }()
522
523 <-ctx.Done()
524 log.Info("Stopping NodeAPI...")
525 ctxTimeout, cancel := context.WithTimeout(context.Background(), 10*time.Second) //nolint:gomnd
526 defer cancel()
527 if err := server.Shutdown(ctxTimeout); err != nil {
528 return tracerr.Wrap(err)
529 }
530 log.Info("NodeAPI done")
531 return nil
532}
533
534func (n *Node) handleNewBlock(ctx context.Context, stats *synchronizer.Stats,
535 vars synchronizer.SCVariablesPtr, batches []common.BatchData) {
536 if n.mode == ModeCoordinator {
537 n.coord.SendMsg(ctx, coordinator.MsgSyncBlock{
538 Stats: *stats,
539 Vars: vars,
540 Batches: batches,
541 })
542 }
543 if n.nodeAPI != nil {
544 if vars.Rollup != nil {
545 n.nodeAPI.api.SetRollupVariables(*vars.Rollup)
546 }
547 if vars.Auction != nil {
548 n.nodeAPI.api.SetAuctionVariables(*vars.Auction)
549 }
550 if vars.WDelayer != nil {
551 n.nodeAPI.api.SetWDelayerVariables(*vars.WDelayer)
552 }
553
554 if stats.Synced() {
555 if err := n.nodeAPI.api.UpdateNetworkInfo(
556 stats.Eth.LastBlock, stats.Sync.LastBlock,
557 common.BatchNum(stats.Eth.LastBatchNum),
558 stats.Sync.Auction.CurrentSlot.SlotNum,
559 ); err != nil {
560 log.Errorw("API.UpdateNetworkInfo", "err", err)
561 }
562 } else {
563 n.nodeAPI.api.UpdateNetworkInfoBlock(
564 stats.Eth.LastBlock, stats.Sync.LastBlock,
565 )
566 }
567 }
568}
569
570func (n *Node) handleReorg(ctx context.Context, stats *synchronizer.Stats,
571 vars synchronizer.SCVariablesPtr) {
572 if n.mode == ModeCoordinator {
573 n.coord.SendMsg(ctx, coordinator.MsgSyncReorg{
574 Stats: *stats,
575 Vars: vars,
576 })
577 }
578 if n.nodeAPI != nil {
579 vars := n.sync.SCVars()
580 n.nodeAPI.api.SetRollupVariables(*vars.Rollup)
581 n.nodeAPI.api.SetAuctionVariables(*vars.Auction)
582 n.nodeAPI.api.SetWDelayerVariables(*vars.WDelayer)
583 n.nodeAPI.api.UpdateNetworkInfoBlock(
584 stats.Eth.LastBlock, stats.Sync.LastBlock,
585 )
586 }
587}
588
589// TODO(Edu): Consider keeping the `lastBlock` inside synchronizer so that we
590// don't have to pass it around.
591func (n *Node) syncLoopFn(ctx context.Context, lastBlock *common.Block) (*common.Block,
592 time.Duration, error) {
593 blockData, discarded, err := n.sync.Sync(ctx, lastBlock)
594 stats := n.sync.Stats()
595 if err != nil {
596 // case: error
597 return nil, n.cfg.Synchronizer.SyncLoopInterval.Duration, tracerr.Wrap(err)
598 } else if discarded != nil {
599 // case: reorg
600 log.Infow("Synchronizer.Sync reorg", "discarded", *discarded)
601 vars := n.sync.SCVars()
602 n.handleReorg(ctx, stats, vars)
603 return nil, time.Duration(0), nil
604 } else if blockData != nil {
605 // case: new block
606 vars := synchronizer.SCVariablesPtr{
607 Rollup: blockData.Rollup.Vars,
608 Auction: blockData.Auction.Vars,
609 WDelayer: blockData.WDelayer.Vars,
610 }
611 n.handleNewBlock(ctx, stats, vars, blockData.Rollup.Batches)
612 return &blockData.Block, time.Duration(0), nil
613 } else {
614 // case: no block
615 return lastBlock, n.cfg.Synchronizer.SyncLoopInterval.Duration, nil
616 }
617}
618
619// StartSynchronizer starts the synchronizer
620func (n *Node) StartSynchronizer() {
621 log.Info("Starting Synchronizer...")
622
623 // Trigger a manual call to handleNewBlock with the loaded state of the
624 // synchronizer in order to quickly activate the API and Coordinator
625 // and avoid waiting for the next block. Without this, the API and
626 // Coordinator will not react until the following block (starting from
627 // the last synced one) is synchronized
628 stats := n.sync.Stats()
629 vars := n.sync.SCVars()
630 n.handleNewBlock(n.ctx, stats, vars, []common.BatchData{})
631
632 n.wg.Add(1)
633 go func() {
634 var err error
635 var lastBlock *common.Block
636 waitDuration := time.Duration(0)
637 for {
638 select {
639 case <-n.ctx.Done():
640 log.Info("Synchronizer done")
641 n.wg.Done()
642 return
643 case <-time.After(waitDuration):
644 if lastBlock, waitDuration, err = n.syncLoopFn(n.ctx,
645 lastBlock); err != nil {
646 if n.ctx.Err() != nil {
647 continue
648 }
649 if errors.Is(err, eth.ErrBlockHashMismatchEvent) {
650 log.Warnw("Synchronizer.Sync", "err", err)
651 } else if errors.Is(err, synchronizer.ErrUnknownBlock) {
652 log.Warnw("Synchronizer.Sync", "err", err)
653 } else {
654 log.Errorw("Synchronizer.Sync", "err", err)
655 }
656 }
657 }
658 }
659 }()
660
661 n.wg.Add(1)
662 go func() {
663 for {
664 select {
665 case <-n.ctx.Done():
666 log.Info("PriceUpdater done")
667 n.wg.Done()
668 return
669 case <-time.After(n.cfg.PriceUpdater.Interval.Duration):
670 if err := n.priceUpdater.UpdateTokenList(); err != nil {
671 log.Errorw("PriceUpdater.UpdateTokenList()", "err", err)
672 }
673 n.priceUpdater.UpdatePrices(n.ctx)
674 }
675 }
676 }()
677}
678
679// StartDebugAPI starts the DebugAPI
680func (n *Node) StartDebugAPI() {
681 log.Info("Starting DebugAPI...")
682 n.wg.Add(1)
683 go func() {
684 defer func() {
685 log.Info("DebugAPI routine stopped")
686 n.wg.Done()
687 }()
688 if err := n.debugAPI.Run(n.ctx); err != nil {
689 if n.ctx.Err() != nil {
690 return
691 }
692 log.Fatalw("DebugAPI.Run", "err", err)
693 }
694 }()
695}
696
697// StartNodeAPI starts the NodeAPI
698func (n *Node) StartNodeAPI() {
699 log.Info("Starting NodeAPI...")
700 n.wg.Add(1)
701 go func() {
702 defer func() {
703 log.Info("NodeAPI routine stopped")
704 n.wg.Done()
705 }()
706 if err := n.nodeAPI.Run(n.ctx); err != nil {
707 if n.ctx.Err() != nil {
708 return
709 }
710 log.Fatalw("NodeAPI.Run", "err", err)
711 }
712 }()
713
714 n.wg.Add(1)
715 go func() {
716 // Do an initial update on startup
717 if err := n.nodeAPI.api.UpdateMetrics(); err != nil {
718 log.Errorw("API.UpdateMetrics", "err", err)
719 }
720 for {
721 select {
722 case <-n.ctx.Done():
723 log.Info("API.UpdateMetrics loop done")
724 n.wg.Done()
725 return
726 case <-time.After(n.cfg.API.UpdateMetricsInterval.Duration):
727 if err := n.nodeAPI.api.UpdateMetrics(); err != nil {
728 log.Errorw("API.UpdateMetrics", "err", err)
729 }
730 }
731 }
732 }()
733
734 n.wg.Add(1)
735 go func() {
736 // Do an initial update on startup
737 if err := n.nodeAPI.api.UpdateRecommendedFee(); err != nil {
738 log.Errorw("API.UpdateRecommendedFee", "err", err)
739 }
740 for {
741 select {
742 case <-n.ctx.Done():
743 log.Info("API.UpdateRecommendedFee loop done")
744 n.wg.Done()
745 return
746 case <-time.After(n.cfg.API.UpdateRecommendedFeeInterval.Duration):
747 if err := n.nodeAPI.api.UpdateRecommendedFee(); err != nil {
748 log.Errorw("API.UpdateRecommendedFee", "err", err)
749 }
750 }
751 }
752 }()
753}
754
755// Start the node
756func (n *Node) Start() {
757 log.Infow("Starting node...", "mode", n.mode)
758 if n.debugAPI != nil {
759 n.StartDebugAPI()
760 }
761 if n.nodeAPI != nil {
762 n.StartNodeAPI()
763 }
764 if n.mode == ModeCoordinator {
765 log.Info("Starting Coordinator...")
766 n.coord.Start()
767 }
768 n.StartSynchronizer()
769}
770
771// Stop the node
772func (n *Node) Stop() {
773 log.Infow("Stopping node...")
774 n.cancel()
775 n.wg.Wait()
776 if n.mode == ModeCoordinator {
777 log.Info("Stopping Coordinator...")
778 n.coord.Stop()
779 }
780 // Close kv DBs
781 n.sync.StateDB().Close()
782 if n.mode == ModeCoordinator {
783 n.coord.TxSelector().LocalAccountsDB().Close()
784 n.coord.BatchBuilder().LocalStateDB().Close()
785 }
786}