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