-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add reorg handler functionality and configuration options (#91)
### TL;DR Added a new reorg handler to detect and handle blockchain reorganizations. ### What changed? - Introduced a new `ReorgHandler` component with configuration options - Added reorg detection logic to scan for inconsistencies in block headers - Implemented a fork point detection mechanism - Created a process to handle reorgs by re-fetching and updating affected blocks - Added new metrics for tracking reorg handler performance - Updated the orchestrator to include the reorg handler in its workflow ### How to test? 1. Enable the reorg handler using the `--reorgHandler-enabled` flag or `REORGHANDLER_ENABLED` environment variable 2. Configure the reorg handler settings: - Interval: `--reorgHandler-interval` or `REORGHANDLER_INTERVAL` - Blocks per scan: `--reorgHandler-blocks-per-scan` or `REORGHANDLER_BLOCKSPERSCAN` - Starting block: `--reorgHandler-from-block` or `REORGHANDLER_FROMBLOCK` - Force starting block: `--reorgHandler-force-from-block` or `REORGHANDLER_FORCEFROMBLOCK` 3. Run the indexer and monitor the logs for reorg detection messages 4. Check the new metrics `reorg_handler_last_checked_block` and `reorg_handler_reorg_counter` for reorg handler activity ### Why make this change? Blockchain reorganizations can lead to inconsistencies in indexed data. The reorg handler ensures data integrity by detecting reorgs and updating the affected blocks, maintaining the accuracy of the indexed information.
- Loading branch information
Showing
6 changed files
with
298 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,200 @@ | ||
| package orchestrator | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "math/big" | ||
| "time" | ||
|
|
||
| "github.com/rs/zerolog/log" | ||
| config "github.com/thirdweb-dev/indexer/configs" | ||
| "github.com/thirdweb-dev/indexer/internal/common" | ||
| "github.com/thirdweb-dev/indexer/internal/metrics" | ||
| "github.com/thirdweb-dev/indexer/internal/rpc" | ||
| "github.com/thirdweb-dev/indexer/internal/storage" | ||
| "github.com/thirdweb-dev/indexer/internal/worker" | ||
| ) | ||
|
|
||
| type ReorgHandler struct { | ||
| rpc rpc.Client | ||
| storage storage.IStorage | ||
| triggerInterval int | ||
| blocksPerScan int | ||
| lastCheckedBlock *big.Int | ||
| worker *worker.Worker | ||
| } | ||
|
|
||
| const DEFAULT_REORG_HANDLER_INTERVAL = 1000 | ||
| const DEFAULT_REORG_HANDLER_BLOCKS_PER_SCAN = 100 | ||
|
|
||
| func NewReorgHandler(rpc rpc.Client, storage storage.IStorage) *ReorgHandler { | ||
| triggerInterval := config.Cfg.ReorgHandler.Interval | ||
| if triggerInterval == 0 { | ||
| triggerInterval = DEFAULT_REORG_HANDLER_INTERVAL | ||
| } | ||
| blocksPerScan := config.Cfg.ReorgHandler.BlocksPerScan | ||
| if blocksPerScan == 0 { | ||
| blocksPerScan = DEFAULT_REORG_HANDLER_BLOCKS_PER_SCAN | ||
| } | ||
| return &ReorgHandler{ | ||
| rpc: rpc, | ||
| storage: storage, | ||
| worker: worker.NewWorker(rpc), | ||
| triggerInterval: triggerInterval, | ||
| blocksPerScan: blocksPerScan, | ||
| lastCheckedBlock: getInitialCheckedBlockNumber(storage, rpc.ChainID), | ||
| } | ||
| } | ||
|
|
||
| func getInitialCheckedBlockNumber(storage storage.IStorage, chainId *big.Int) *big.Int { | ||
| bn := big.NewInt(int64(config.Cfg.ReorgHandler.FromBlock)) | ||
| if !config.Cfg.ReorgHandler.ForceFromBlock { | ||
| storedFromBlock, err := storage.OrchestratorStorage.GetLastReorgCheckedBlockNumber(chainId) | ||
| if err != nil { | ||
| log.Debug().Err(err).Msgf("Error getting last reorg checked block number, using configured: %s", bn) | ||
| return bn | ||
| } | ||
| if storedFromBlock.Sign() <= 0 { | ||
| log.Debug().Msgf("Last reorg checked block number not found, using configured: %s", bn) | ||
| return bn | ||
| } | ||
| log.Debug().Msgf("Last reorg checked block number found, using: %s", storedFromBlock) | ||
| return storedFromBlock | ||
| } | ||
| log.Debug().Msgf("Force from block reorg check flag set, using configured: %s", bn) | ||
| return bn | ||
| } | ||
|
|
||
| func (rh *ReorgHandler) Start() { | ||
| interval := time.Duration(rh.triggerInterval) * time.Millisecond | ||
| ticker := time.NewTicker(interval) | ||
|
|
||
| log.Debug().Msgf("Reorg handler running") | ||
| go func() { | ||
| for range ticker.C { | ||
| lookbackFrom := new(big.Int).Add(rh.lastCheckedBlock, big.NewInt(int64(rh.blocksPerScan))) | ||
| blockHeaders, err := rh.storage.MainStorage.LookbackBlockHeaders(rh.rpc.ChainID, rh.blocksPerScan, lookbackFrom) | ||
| if err != nil { | ||
| log.Error().Err(err).Msg("Error getting recent block headers") | ||
| continue | ||
| } | ||
| if len(blockHeaders) == 0 { | ||
| log.Warn().Msg("No block headers found") | ||
| continue | ||
| } | ||
| mostRecentBlockHeader := blockHeaders[0] | ||
| reorgEndIndex := findReorgEndIndex(blockHeaders) | ||
| if reorgEndIndex == -1 { | ||
| rh.lastCheckedBlock = mostRecentBlockHeader.Number | ||
| rh.storage.OrchestratorStorage.SetLastReorgCheckedBlockNumber(rh.rpc.ChainID, mostRecentBlockHeader.Number) | ||
| metrics.ReorgHandlerLastCheckedBlock.Set(float64(mostRecentBlockHeader.Number.Int64())) | ||
| continue | ||
| } | ||
| metrics.ReorgCounter.Inc() | ||
| forkPoint, err := rh.findForkPoint(blockHeaders[reorgEndIndex:]) | ||
| if err != nil { | ||
| log.Error().Err(err).Msg("Error while finding fork point") | ||
| continue | ||
| } | ||
| err = rh.handleReorg(forkPoint, lookbackFrom) | ||
| if err != nil { | ||
| log.Error().Err(err).Msg("Error while handling reorg") | ||
| continue | ||
| } | ||
| rh.lastCheckedBlock = mostRecentBlockHeader.Number | ||
| rh.storage.OrchestratorStorage.SetLastReorgCheckedBlockNumber(rh.rpc.ChainID, mostRecentBlockHeader.Number) | ||
| metrics.ReorgHandlerLastCheckedBlock.Set(float64(mostRecentBlockHeader.Number.Int64())) | ||
| } | ||
| }() | ||
|
|
||
| // Keep the program running (otherwise it will exit) | ||
| select {} | ||
| } | ||
|
|
||
| func findReorgEndIndex(reversedBlockHeaders []common.BlockHeader) (index int) { | ||
| for i := 0; i < len(reversedBlockHeaders)-1; i++ { | ||
| currentBlock := reversedBlockHeaders[i] | ||
| previousBlock := reversedBlockHeaders[i+1] | ||
|
|
||
| if currentBlock.ParentHash != previousBlock.Hash { | ||
| log.Debug(). | ||
| Str("currentBlockNumber", currentBlock.Number.String()). | ||
| Str("currentBlockHash", currentBlock.Hash). | ||
| Str("currentBlockParentHash", currentBlock.ParentHash). | ||
| Str("previousBlockNumber", previousBlock.Number.String()). | ||
| Str("previousBlockHash", previousBlock.Hash). | ||
| Msg("Reorg detected: parent hash mismatch") | ||
| return i | ||
| } | ||
| } | ||
| return -1 | ||
| } | ||
|
|
||
| func (rh *ReorgHandler) findForkPoint(reversedBlockHeaders []common.BlockHeader) (forkPoint *big.Int, err error) { | ||
| newBlocksByNumber, err := rh.getNewBlocksByNumber(reversedBlockHeaders) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| for i := 0; i < len(reversedBlockHeaders)-1; i++ { | ||
| blockHeader := reversedBlockHeaders[i] | ||
| block, ok := (*newBlocksByNumber)[blockHeader.Number.String()] | ||
| if !ok { | ||
| return nil, fmt.Errorf("block not found: %s", blockHeader.Number.String()) | ||
| } | ||
| if block.Hash == blockHeader.Hash { | ||
| previousBlock := reversedBlockHeaders[i+1] | ||
| return previousBlock.Number, nil | ||
| } | ||
| } | ||
| lookbackFrom := reversedBlockHeaders[len(reversedBlockHeaders)-1].Number | ||
| nextHeadersBatch, err := rh.storage.MainStorage.LookbackBlockHeaders(rh.rpc.ChainID, rh.blocksPerScan, lookbackFrom) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("error getting next headers batch: %w", err) | ||
| } | ||
| return rh.findForkPoint(nextHeadersBatch) | ||
| } | ||
|
|
||
| func (rh *ReorgHandler) getNewBlocksByNumber(reversedBlockHeaders []common.BlockHeader) (*map[string]common.Block, error) { | ||
| blockNumbers := make([]*big.Int, 0, len(reversedBlockHeaders)) | ||
| for _, header := range reversedBlockHeaders { | ||
| blockNumbers = append(blockNumbers, header.Number) | ||
| } | ||
| blockResults := rh.rpc.GetBlocks(blockNumbers) | ||
| fetchedBlocksByNumber := make(map[string]common.Block) | ||
| for _, blockResult := range blockResults { | ||
| if blockResult.Error != nil { | ||
| return nil, fmt.Errorf("error fetching block %s: %w", blockResult.BlockNumber.String(), blockResult.Error) | ||
| } | ||
| fetchedBlocksByNumber[blockResult.BlockNumber.String()] = blockResult.Data | ||
| } | ||
| return &fetchedBlocksByNumber, nil | ||
| } | ||
|
|
||
| func (rh *ReorgHandler) handleReorg(reorgStart *big.Int, reorgEnd *big.Int) error { | ||
| blockRange := make([]*big.Int, 0, new(big.Int).Sub(reorgEnd, reorgStart).Int64()) | ||
| for i := new(big.Int).Set(reorgStart); i.Cmp(reorgEnd) <= 0; i.Add(i, big.NewInt(1)) { | ||
| blockRange = append(blockRange, new(big.Int).Set(i)) | ||
| } | ||
|
|
||
| results := rh.worker.Run(blockRange) | ||
| data := make([]common.BlockData, 0, len(results)) | ||
| for _, result := range results { | ||
| if result.Error != nil { | ||
| return fmt.Errorf("cannot fix reorg: failed block %s: %w", result.BlockNumber.String(), result.Error) | ||
| } | ||
| data = append(data, common.BlockData{ | ||
| Block: result.Data.Block, | ||
| Logs: result.Data.Logs, | ||
| Transactions: result.Data.Transactions, | ||
| Traces: result.Data.Traces, | ||
| }) | ||
| } | ||
| // TODO make delete and insert atomic | ||
| if err := rh.storage.MainStorage.DeleteBlockData(rh.rpc.ChainID, blockRange); err != nil { | ||
| return fmt.Errorf("error deleting data for blocks %v: %w", blockRange, err) | ||
| } | ||
| if err := rh.storage.MainStorage.InsertBlockData(&data); err != nil { | ||
| return fmt.Errorf("error saving data to main storage: %w", err) | ||
| } | ||
| return nil | ||
| } |