@lodestar/beacon-node 1.38.0-dev.bc1fed4d3d → 1.38.0-dev.ebc352f211

package/lib/eth1/eth1MergeBlockTracker.js

@@ -1,262 +0,0 @@
-import { pruneSetToMax, toRootHex } from "@lodestar/utils";
-import { ZERO_HASH_HEX } from "../constants/index.js";
-import { enumToIndexMap } from "../util/enum.js";
-import { dataToRootHex, quantityToBigint, quantityToNum } from "./provider/utils.js";
-export var StatusCode;
-(function (StatusCode) {
-    StatusCode["STOPPED"] = "STOPPED";
-    StatusCode["SEARCHING"] = "SEARCHING";
-    StatusCode["FOUND"] = "FOUND";
-})(StatusCode || (StatusCode = {}));
-/** For metrics, index order = declaration order of StatusCode  */
-const statusCodeIdx = enumToIndexMap(StatusCode);
-/**
- * Bounds `blocksByHashCache` cache, imposing a max distance between highest and lowest block numbers.
- * In case of extreme forking the cache might grow unbounded.
- */
-const MAX_CACHE_POW_BLOCKS = 1024;
-const MAX_TD_RENDER_VALUE = Number.MAX_SAFE_INTEGER;
-// get_pow_block_at_total_difficulty
-/**
- * Follows the eth1 chain to find a (or multiple?) merge blocks that cross the threshold of total terminal difficulty
- *
- * Finding the mergeBlock could be done in demand when proposing pre-merge blocks. However, that would slow block
- * production during the weeks between BELLATRIX_EPOCH and TTD.
- */
-export class Eth1MergeBlockTracker {
-    eth1Provider;
-    config;
-    logger;
-    metrics;
-    blocksByHashCache = new Map();
-    intervals = [];
-    status;
-    latestEth1Block = null;
-    getTerminalPowBlockFromEth1Promise = null;
-    safeTDFactor;
-    constructor({ config, logger, signal, metrics }, eth1Provider) {
-        this.eth1Provider = eth1Provider;
-        this.config = config;
-        this.logger = logger;
-        this.metrics = metrics;
-        this.status = { code: StatusCode.STOPPED };
-        signal.addEventListener("abort", () => this.close(), { once: true });
-        this.safeTDFactor = getSafeTDFactor(this.config.TERMINAL_TOTAL_DIFFICULTY);
-        const scaledTTD = this.config.TERMINAL_TOTAL_DIFFICULTY / this.safeTDFactor;
-        // Only run metrics if necessary
-        if (metrics) {
-            // TTD can't be dynamically changed during execution, register metric once
-            metrics.eth1.eth1MergeTTD.set(Number(scaledTTD));
-            metrics.eth1.eth1MergeTDFactor.set(Number(this.safeTDFactor));
-            metrics.eth1.eth1MergeStatus.addCollect(() => {
-                // Set merge ttd, merge status and merge block status
-                metrics.eth1.eth1MergeStatus.set(statusCodeIdx[this.status.code]);
-                if (this.latestEth1Block !== null) {
-                    // Set latestBlock stats
-                    metrics.eth1.eth1LatestBlockNumber.set(this.latestEth1Block.number);
-                    metrics.eth1.eth1LatestBlockTD.set(Number(this.latestEth1Block.totalDifficulty / this.safeTDFactor));
-                    metrics.eth1.eth1LatestBlockTimestamp.set(this.latestEth1Block.timestamp);
-                }
-            });
-        }
-    }
-    /**
-     * Returns the most recent POW block that satisfies the merge block condition
-     */
-    async getTerminalPowBlock() {
-        switch (this.status.code) {
-            case StatusCode.STOPPED:
-                // If not module is not polling fetch the mergeBlock explicitly
-                return this.getTerminalPowBlockFromEth1();
-            case StatusCode.SEARCHING:
-                // Assume that polling would have found the block
-                return null;
-            case StatusCode.FOUND:
-                return this.status.mergeBlock;
-        }
-    }
-    getTDProgress() {
-        if (this.latestEth1Block === null) {
-            return this.latestEth1Block;
-        }
-        const tdDiff = this.config.TERMINAL_TOTAL_DIFFICULTY - this.latestEth1Block.totalDifficulty;
-        if (tdDiff > BigInt(0)) {
-            return {
-                ttdHit: false,
-                tdFactor: this.safeTDFactor,
-                tdDiffScaled: Number((tdDiff / this.safeTDFactor)),
-                ttd: this.config.TERMINAL_TOTAL_DIFFICULTY,
-                td: this.latestEth1Block.totalDifficulty,
-                timestamp: this.latestEth1Block.timestamp,
-            };
-        }
-        return {
-            ttdHit: true,
-        };
-    }
-    /**
-     * Get a POW block by hash checking the local cache first
-     */
-    async getPowBlock(powBlockHash) {
-        // Check cache first
-        const cachedBlock = this.blocksByHashCache.get(powBlockHash);
-        if (cachedBlock) {
-            return cachedBlock;
-        }
-        // Fetch from node
-        const blockRaw = await this.eth1Provider.getBlockByHash(powBlockHash);
-        if (blockRaw) {
-            const block = toPowBlock(blockRaw);
-            this.cacheBlock(block);
-            return block;
-        }
-        return null;
-    }
-    /**
-     * Should only start polling for mergeBlock if:
-     * - after BELLATRIX_FORK_EPOCH
-     * - Beacon node synced
-     * - head state not isMergeTransitionComplete
-     */
-    startPollingMergeBlock() {
-        if (this.status.code !== StatusCode.STOPPED) {
-            return;
-        }
-        this.status = { code: StatusCode.SEARCHING };
-        this.logger.info("Starting search for terminal POW block", {
-            TERMINAL_TOTAL_DIFFICULTY: this.config.TERMINAL_TOTAL_DIFFICULTY,
-        });
-        const interval = setInterval(() => {
-            // Preemptively try to find merge block and cache it if found.
-            // Future callers of getTerminalPowBlock() will re-use the cached found mergeBlock.
-            this.getTerminalPowBlockFromEth1().catch((e) => {
-                this.logger.error("Error on findMergeBlock", {}, e);
-                this.metrics?.eth1.eth1PollMergeBlockErrors.inc();
-            });
-        }, this.config.SECONDS_PER_ETH1_BLOCK * 1000);
-        this.intervals.push(interval);
-    }
-    close() {
-        this.intervals.forEach(clearInterval);
-    }
-    async getTerminalPowBlockFromEth1() {
-        if (!this.getTerminalPowBlockFromEth1Promise) {
-            this.getTerminalPowBlockFromEth1Promise = this.internalGetTerminalPowBlockFromEth1()
-                .then((mergeBlock) => {
-                // Persist found merge block here to affect both caller paths:
-                // - internal searcher
-                // - external caller if STOPPED
-                if (mergeBlock && this.status.code !== StatusCode.FOUND) {
-                    if (this.status.code === StatusCode.SEARCHING) {
-                        this.close();
-                    }
-                    this.logger.info("Terminal POW block found!", {
-                        hash: mergeBlock.blockHash,
-                        number: mergeBlock.number,
-                        totalDifficulty: mergeBlock.totalDifficulty,
-                    });
-                    this.status = { code: StatusCode.FOUND, mergeBlock };
-                    this.metrics?.eth1.eth1MergeBlockDetails.set({
-                        terminalBlockHash: mergeBlock.blockHash,
-                        // Convert all number/bigints to string labels
-                        terminalBlockNumber: mergeBlock.number.toString(10),
-                        terminalBlockTD: mergeBlock.totalDifficulty.toString(10),
-                    }, 1);
-                }
-                return mergeBlock;
-            })
-                .finally(() => {
-                this.getTerminalPowBlockFromEth1Promise = null;
-            });
-        }
-        else {
-            // This should no happen, since getTerminalPowBlockFromEth1() should resolve faster than SECONDS_PER_ETH1_BLOCK.
-            // else something is wrong: the el-cl comms are two slow, or the backsearch got stuck in a deep search.
-            this.metrics?.eth1.getTerminalPowBlockPromiseCacheHit.inc();
-        }
-        return this.getTerminalPowBlockFromEth1Promise;
-    }
-    /**
-     * **internal** + **unsafe** since it can create multiple backward searches that overload the eth1 client.
-     * Must be called in a wrapper to ensure that there's only once concurrent call to this fn.
-     */
-    async internalGetTerminalPowBlockFromEth1() {
-        // Search merge block by hash
-        // Terminal block hash override takes precedence over terminal total difficulty
-        const terminalBlockHash = toRootHex(this.config.TERMINAL_BLOCK_HASH);
-        if (terminalBlockHash !== ZERO_HASH_HEX) {
-            const block = await this.getPowBlock(terminalBlockHash);
-            if (block) {
-                return block;
-            }
-            // if a TERMINAL_BLOCK_HASH other than ZERO_HASH is configured and we can't find it, return NONE
-            return null;
-        }
-        // Search merge block by TTD
-        const latestBlockRaw = await this.eth1Provider.getBlockByNumber("latest");
-        if (!latestBlockRaw) {
-            throw Error("getBlockByNumber('latest') returned null");
-        }
-        let block = toPowBlock(latestBlockRaw);
-        this.latestEth1Block = { ...block, timestamp: quantityToNum(latestBlockRaw.timestamp) };
-        this.cacheBlock(block);
-        // This code path to look backwards for the merge block is only necessary if:
-        // - The network has not yet found the merge block
-        // - There are descendants of the merge block in the eth1 chain
-        // For the search below to require more than a few hops, multiple block proposers in a row must fail to detect
-        // an existing merge block. Such situation is extremely unlikely, so this search is left un-optimized. Since
-        // this class can start eagerly looking for the merge block when not necessary, startPollingMergeBlock() should
-        // only be called when there is certainty that a mergeBlock search is necessary.
-        while (true) {
-            if (block.totalDifficulty < this.config.TERMINAL_TOTAL_DIFFICULTY) {
-                // TTD not reached yet
-                return null;
-            }
-            // else block.totalDifficulty >= this.config.TERMINAL_TOTAL_DIFFICULTY
-            // Potential mergeBlock! Must find the first block that passes TTD
-            // Allow genesis block to reach TTD https://github.com/ethereum/consensus-specs/pull/2719
-            if (block.parentHash === ZERO_HASH_HEX) {
-                return block;
-            }
-            const parent = await this.getPowBlock(block.parentHash);
-            if (!parent) {
-                throw Error(`Unknown parent of block with TD>TTD ${block.parentHash}`);
-            }
-            this.metrics?.eth1.eth1ParentBlocksFetched.inc();
-            // block.td > TTD && parent.td < TTD => block is mergeBlock
-            if (parent.totalDifficulty < this.config.TERMINAL_TOTAL_DIFFICULTY) {
-                // Is terminal total difficulty block AND has verified block -> parent relationship
-                return block;
-            }
-            block = parent;
-        }
-    }
-    cacheBlock(block) {
-        this.blocksByHashCache.set(block.blockHash, block);
-        pruneSetToMax(this.blocksByHashCache, MAX_CACHE_POW_BLOCKS);
-    }
-}
-export function toPowBlock(block) {
-    // Validate untrusted data from API
-    return {
-        number: quantityToNum(block.number),
-        blockHash: dataToRootHex(block.hash),
-        parentHash: dataToRootHex(block.parentHash),
-        totalDifficulty: quantityToBigint(block.totalDifficulty),
-    };
-}
-/**
- * TTD values can be very large, for xDAI > 1e45. So scale down.
- * To be good, TTD should be rendered as a number < Number.MAX_TD_RENDER_VALUE ~= 9e15
- */
-export function getSafeTDFactor(ttd) {
-    const safeIntegerMult = ttd / BigInt(MAX_TD_RENDER_VALUE);
-    // TTD < MAX_TD_RENDER_VALUE, no need to scale down
-    if (safeIntegerMult === BigInt(0)) {
-        return BigInt(1);
-    }
-    // Return closest power of 10 to ensure TD < max
-    const safeIntegerMultDigits = safeIntegerMult.toString(10).length;
-    return BigInt(10) ** BigInt(safeIntegerMultDigits);
-}
-//# sourceMappingURL=eth1MergeBlockTracker.js.map

package/lib/eth1/eth1MergeBlockTracker.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"eth1MergeBlockTracker.js","sourceRoot":"","sources":["../../src/eth1/eth1MergeBlockTracker.ts"],"names":[],"mappings":"AAEA,OAAO,EAAS,aAAa,EAAE,SAAS,EAAC,MAAM,iBAAiB,CAAC;AACjE,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,cAAc,EAAC,MAAM,iBAAiB,CAAC;AAE/C,OAAO,EAAC,aAAa,EAAE,gBAAgB,EAAE,aAAa,EAAC,MAAM,qBAAqB,CAAC;AAEnF,MAAM,CAAN,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,iCAAmB,CAAA;IACnB,qCAAuB,CAAA;IACvB,6BAAe,CAAA;AACjB,CAAC,EAJW,UAAU,KAAV,UAAU,QAIrB;AAOD,kEAAkE;AAClE,MAAM,aAAa,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC;AAEjD;;;GAGG;AACH,MAAM,oBAAoB,GAAG,IAAI,CAAC;AAElC,MAAM,mBAAmB,GAAG,MAAM,CAAC,gBAAgB,CAAC;AASpD,oCAAoC;AAEpC;;;;;GAKG;AACH,MAAM,OAAO,qBAAqB;IAeb;IAdF,MAAM,CAAc;IACpB,MAAM,CAAS;IACf,OAAO,CAAiB;IAExB,iBAAiB,GAAG,IAAI,GAAG,EAA0B,CAAC;IACtD,SAAS,GAAqB,EAAE,CAAC;IAE1C,MAAM,CAAS;IACf,eAAe,GAAkC,IAAI,CAAC;IACtD,kCAAkC,GAAyC,IAAI,CAAC;IACvE,YAAY,CAAS;IAEtC,YACE,EAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAA+B,EAC9C,YAA2B;QAA3B,iBAAY,GAAZ,YAAY,CAAe;QAE5C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,IAAI,CAAC,MAAM,GAAG,EAAC,IAAI,EAAE,UAAU,CAAC,OAAO,EAAC,CAAC;QAEzC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,EAAC,IAAI,EAAE,IAAI,EAAC,CAAC,CAAC;QAEnE,IAAI,CAAC,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,yBAAyB,CAAC,CAAC;QAC3E,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,yBAAyB,GAAG,IAAI,CAAC,YAAY,CAAC;QAE5E,gCAAgC;QAChC,IAAI,OAAO,EAAE,CAAC;YACZ,0EAA0E;YAC1E,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,SAAmB,CAAC,CAAC,CAAC;YAC3D,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,YAAsB,CAAC,CAAC,CAAC;YAExE,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,GAAG,EAAE;gBAC3C,qDAAqD;gBACrD,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;gBAElE,IAAI,IAAI,CAAC,eAAe,KAAK,IAAI,EAAE,CAAC;oBAClC,wBAAwB;oBACxB,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;oBACpE,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,eAAe,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;oBACrG,OAAO,CAAC,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;gBAC5E,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB;QACvB,QAAQ,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YACzB,KAAK,UAAU,CAAC,OAAO;gBACrB,+DAA+D;gBAC/D,OAAO,IAAI,CAAC,2BAA2B,EAAE,CAAC;YAE5C,KAAK,UAAU,CAAC,SAAS;gBACvB,iDAAiD;gBACjD,OAAO,IAAI,CAAC;YAEd,KAAK,UAAU,CAAC,KAAK;gBACnB,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;QAClC,CAAC;IACH,CAAC;IAED,aAAa;QACX,IAAI,IAAI,CAAC,eAAe,KAAK,IAAI,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC,eAAe,CAAC;QAC9B,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,yBAAyB,GAAG,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC;QAE5F,IAAI,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;YACvB,OAAO;gBACL,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,IAAI,CAAC,YAAY;gBAC3B,YAAY,EAAE,MAAM,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,CAAW,CAAC;gBAC5D,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,yBAAyB;gBAC1C,EAAE,EAAE,IAAI,CAAC,eAAe,CAAC,eAAe;gBACxC,SAAS,EAAE,IAAI,CAAC,eAAe,CAAC,SAAS;aAC1C,CAAC;QACJ,CAAC;QACD,OAAO;YACL,MAAM,EAAE,IAAI;SACb,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CAAC,YAAoB;QACpC,oBAAoB;QACpB,MAAM,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAC7D,IAAI,WAAW,EAAE,CAAC;YAChB,OAAO,WAAW,CAAC;QACrB,CAAC;QAED,kBAAkB;QAClB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;QACtE,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;YACnC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACvB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,sBAAsB;QACpB,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC;YAC5C,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,EAAC,IAAI,EAAE,UAAU,CAAC,SAAS,EAAC,CAAC;QAC3C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,wCAAwC,EAAE;YACzD,yBAAyB,EAAE,IAAI,CAAC,MAAM,CAAC,yBAAyB;SACjE,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,EAAE;YAChC,8DAA8D;YAC9D,mFAAmF;YACnF,IAAI,CAAC,2BAA2B,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;gBAC7C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE,EAAE,EAAE,CAAU,CAAC,CAAC;gBAC7D,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,wBAAwB,CAAC,GAAG,EAAE,CAAC;YACpD,CAAC,CAAC,CAAC;QACL,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,sBAAsB,GAAG,IAAI,CAAC,CAAC;QAE9C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAChC,CAAC;IAEO,KAAK;QACX,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IACxC,CAAC;IAEO,KAAK,CAAC,2BAA2B;QACvC,IAAI,CAAC,IAAI,CAAC,kCAAkC,EAAE,CAAC;YAC7C,IAAI,CAAC,kCAAkC,GAAG,IAAI,CAAC,mCAAmC,EAAE;iBACjF,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE;gBACnB,8DAA8D;gBAC9D,sBAAsB;gBACtB,+BAA+B;gBAC/B,IAAI,UAAU,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,KAAK,EAAE,CAAC;oBACxD,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,SAAS,EAAE,CAAC;wBAC9C,IAAI,CAAC,KAAK,EAAE,CAAC;oBACf,CAAC;oBAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,EAAE;wBAC5C,IAAI,EAAE,UAAU,CAAC,SAAS;wBAC1B,MAAM,EAAE,UAAU,CAAC,MAAM;wBACzB,eAAe,EAAE,UAAU,CAAC,eAAe;qBAC5C,CAAC,CAAC;oBAEH,IAAI,CAAC,MAAM,GAAG,EAAC,IAAI,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,EAAC,CAAC;oBACnD,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAC1C;wBACE,iBAAiB,EAAE,UAAU,CAAC,SAAS;wBACvC,8CAA8C;wBAC9C,mBAAmB,EAAE,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;wBACnD,eAAe,EAAE,UAAU,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC;qBACzD,EACD,CAAC,CACF,CAAC;gBACJ,CAAC;gBAED,OAAO,UAAU,CAAC;YACpB,CAAC,CAAC;iBACD,OAAO,CAAC,GAAG,EAAE;gBACZ,IAAI,CAAC,kCAAkC,GAAG,IAAI,CAAC;YACjD,CAAC,CAAC,CAAC;QACP,CAAC;aAAM,CAAC;YACN,gHAAgH;YAChH,uGAAuG;YACvG,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,kCAAkC,CAAC,GAAG,EAAE,CAAC;QAC9D,CAAC;QAED,OAAO,IAAI,CAAC,kCAAkC,CAAC;IACjD,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,mCAAmC;QAC/C,6BAA6B;QAC7B,+EAA+E;QAC/E,MAAM,iBAAiB,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;QACrE,IAAI,iBAAiB,KAAK,aAAa,EAAE,CAAC;YACxC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;YACxD,IAAI,KAAK,EAAE,CAAC;gBACV,OAAO,KAAK,CAAC;YACf,CAAC;YACD,gGAAgG;YAChG,OAAO,IAAI,CAAC;QACd,CAAC;QAED,4BAA4B;QAC5B,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAC1E,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,MAAM,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,KAAK,GAAG,UAAU,CAAC,cAAc,CAAC,CAAC;QACvC,IAAI,CAAC,eAAe,GAAG,EAAC,GAAG,KAAK,EAAE,SAAS,EAAE,aAAa,CAAC,cAAc,CAAC,SAAS,CAAC,EAAC,CAAC;QACtF,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAEvB,6EAA6E;QAC7E,kDAAkD;QAClD,+DAA+D;QAC/D,8GAA8G;QAC9G,4GAA4G;QAC5G,+GAA+G;QAC/G,gFAAgF;QAEhF,OAAO,IAAI,EAAE,CAAC;YACZ,IAAI,KAAK,CAAC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,yBAAyB,EAAE,CAAC;gBAClE,sBAAsB;gBACtB,OAAO,IAAI,CAAC;YACd,CAAC;YAED,sEAAsE;YACtE,kEAAkE;YAElE,yFAAyF;YACzF,IAAI,KAAK,CAAC,UAAU,KAAK,aAAa,EAAE,CAAC;gBACvC,OAAO,KAAK,CAAC;YACf,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YACxD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,KAAK,CAAC,uCAAuC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC;YACzE,CAAC;YAED,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,uBAAuB,CAAC,GAAG,EAAE,CAAC;YAEjD,2DAA2D;YAC3D,IAAI,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,yBAAyB,EAAE,CAAC;gBACnE,mFAAmF;gBACnF,OAAO,KAAK,CAAC;YACf,CAAC;YACD,KAAK,GAAG,MAAM,CAAC;QACjB,CAAC;IACH,CAAC;IAEO,UAAU,CAAC,KAAoB;QACrC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACnD,aAAa,CAAC,IAAI,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,CAAC;IAC9D,CAAC;CACF;AAED,MAAM,UAAU,UAAU,CAAC,KAAyB;IAClD,mCAAmC;IACnC,OAAO;QACL,MAAM,EAAE,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC;QACnC,SAAS,EAAE,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC;QACpC,UAAU,EAAE,aAAa,CAAC,KAAK,CAAC,UAAU,CAAC;QAC3C,eAAe,EAAE,gBAAgB,CAAC,KAAK,CAAC,eAAe,CAAC;KACzD,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,GAAW;IACzC,MAAM,eAAe,GAAG,GAAG,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC;IAE1D,mDAAmD;IACnD,IAAI,eAAe,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;QAClC,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;IACnB,CAAC;IAED,gDAAgD;IAChD,MAAM,qBAAqB,GAAG,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC;IAClE,OAAO,MAAM,CAAC,EAAE,CAAC,IAAI,MAAM,CAAC,qBAAqB,CAAC,CAAC;AACrD,CAAC"}

package/src/eth1/eth1MergeBlockTracker.ts

@@ -1,328 +0,0 @@
-import {ChainConfig} from "@lodestar/config";
-import {RootHex} from "@lodestar/types";
-import {Logger, pruneSetToMax, toRootHex} from "@lodestar/utils";
-import {ZERO_HASH_HEX} from "../constants/index.js";
-import {Metrics} from "../metrics/index.js";
-import {enumToIndexMap} from "../util/enum.js";
-import {EthJsonRpcBlockRaw, IEth1Provider, PowMergeBlock, PowMergeBlockTimestamp, TDProgress} from "./interface.js";
-import {dataToRootHex, quantityToBigint, quantityToNum} from "./provider/utils.js";
-
-export enum StatusCode {
-  STOPPED = "STOPPED",
-  SEARCHING = "SEARCHING",
-  FOUND = "FOUND",
-}
-
-type Status =
-  | {code: StatusCode.STOPPED}
-  | {code: StatusCode.SEARCHING}
-  | {code: StatusCode.FOUND; mergeBlock: PowMergeBlock};
-
-/** For metrics, index order = declaration order of StatusCode  */
-const statusCodeIdx = enumToIndexMap(StatusCode);
-
-/**
- * Bounds `blocksByHashCache` cache, imposing a max distance between highest and lowest block numbers.
- * In case of extreme forking the cache might grow unbounded.
- */
-const MAX_CACHE_POW_BLOCKS = 1024;
-
-const MAX_TD_RENDER_VALUE = Number.MAX_SAFE_INTEGER;
-
-export type Eth1MergeBlockTrackerModules = {
-  config: ChainConfig;
-  logger: Logger;
-  signal: AbortSignal;
-  metrics: Metrics | null;
-};
-
-// get_pow_block_at_total_difficulty
-
-/**
- * Follows the eth1 chain to find a (or multiple?) merge blocks that cross the threshold of total terminal difficulty
- *
- * Finding the mergeBlock could be done in demand when proposing pre-merge blocks. However, that would slow block
- * production during the weeks between BELLATRIX_EPOCH and TTD.
- */
-export class Eth1MergeBlockTracker {
-  private readonly config: ChainConfig;
-  private readonly logger: Logger;
-  private readonly metrics: Metrics | null;
-
-  private readonly blocksByHashCache = new Map<RootHex, PowMergeBlock>();
-  private readonly intervals: NodeJS.Timeout[] = [];
-
-  private status: Status;
-  private latestEth1Block: PowMergeBlockTimestamp | null = null;
-  private getTerminalPowBlockFromEth1Promise: Promise<PowMergeBlock | null> | null = null;
-  private readonly safeTDFactor: bigint;
-
-  constructor(
-    {config, logger, signal, metrics}: Eth1MergeBlockTrackerModules,
-    private readonly eth1Provider: IEth1Provider
-  ) {
-    this.config = config;
-    this.logger = logger;
-    this.metrics = metrics;
-
-    this.status = {code: StatusCode.STOPPED};
-
-    signal.addEventListener("abort", () => this.close(), {once: true});
-
-    this.safeTDFactor = getSafeTDFactor(this.config.TERMINAL_TOTAL_DIFFICULTY);
-    const scaledTTD = this.config.TERMINAL_TOTAL_DIFFICULTY / this.safeTDFactor;
-
-    // Only run metrics if necessary
-    if (metrics) {
-      // TTD can't be dynamically changed during execution, register metric once
-      metrics.eth1.eth1MergeTTD.set(Number(scaledTTD as bigint));
-      metrics.eth1.eth1MergeTDFactor.set(Number(this.safeTDFactor as bigint));
-
-      metrics.eth1.eth1MergeStatus.addCollect(() => {
-        // Set merge ttd, merge status and merge block status
-        metrics.eth1.eth1MergeStatus.set(statusCodeIdx[this.status.code]);
-
-        if (this.latestEth1Block !== null) {
-          // Set latestBlock stats
-          metrics.eth1.eth1LatestBlockNumber.set(this.latestEth1Block.number);
-          metrics.eth1.eth1LatestBlockTD.set(Number(this.latestEth1Block.totalDifficulty / this.safeTDFactor));
-          metrics.eth1.eth1LatestBlockTimestamp.set(this.latestEth1Block.timestamp);
-        }
-      });
-    }
-  }
-
-  /**
-   * Returns the most recent POW block that satisfies the merge block condition
-   */
-  async getTerminalPowBlock(): Promise<PowMergeBlock | null> {
-    switch (this.status.code) {
-      case StatusCode.STOPPED:
-        // If not module is not polling fetch the mergeBlock explicitly
-        return this.getTerminalPowBlockFromEth1();
-
-      case StatusCode.SEARCHING:
-        // Assume that polling would have found the block
-        return null;
-
-      case StatusCode.FOUND:
-        return this.status.mergeBlock;
-    }
-  }
-
-  getTDProgress(): TDProgress | null {
-    if (this.latestEth1Block === null) {
-      return this.latestEth1Block;
-    }
-
-    const tdDiff = this.config.TERMINAL_TOTAL_DIFFICULTY - this.latestEth1Block.totalDifficulty;
-
-    if (tdDiff > BigInt(0)) {
-      return {
-        ttdHit: false,
-        tdFactor: this.safeTDFactor,
-        tdDiffScaled: Number((tdDiff / this.safeTDFactor) as bigint),
-        ttd: this.config.TERMINAL_TOTAL_DIFFICULTY,
-        td: this.latestEth1Block.totalDifficulty,
-        timestamp: this.latestEth1Block.timestamp,
-      };
-    }
-    return {
-      ttdHit: true,
-    };
-  }
-
-  /**
-   * Get a POW block by hash checking the local cache first
-   */
-  async getPowBlock(powBlockHash: string): Promise<PowMergeBlock | null> {
-    // Check cache first
-    const cachedBlock = this.blocksByHashCache.get(powBlockHash);
-    if (cachedBlock) {
-      return cachedBlock;
-    }
-
-    // Fetch from node
-    const blockRaw = await this.eth1Provider.getBlockByHash(powBlockHash);
-    if (blockRaw) {
-      const block = toPowBlock(blockRaw);
-      this.cacheBlock(block);
-      return block;
-    }
-
-    return null;
-  }
-
-  /**
-   * Should only start polling for mergeBlock if:
-   * - after BELLATRIX_FORK_EPOCH
-   * - Beacon node synced
-   * - head state not isMergeTransitionComplete
-   */
-  startPollingMergeBlock(): void {
-    if (this.status.code !== StatusCode.STOPPED) {
-      return;
-    }
-
-    this.status = {code: StatusCode.SEARCHING};
-    this.logger.info("Starting search for terminal POW block", {
-      TERMINAL_TOTAL_DIFFICULTY: this.config.TERMINAL_TOTAL_DIFFICULTY,
-    });
-
-    const interval = setInterval(() => {
-      // Preemptively try to find merge block and cache it if found.
-      // Future callers of getTerminalPowBlock() will re-use the cached found mergeBlock.
-      this.getTerminalPowBlockFromEth1().catch((e) => {
-        this.logger.error("Error on findMergeBlock", {}, e as Error);
-        this.metrics?.eth1.eth1PollMergeBlockErrors.inc();
-      });
-    }, this.config.SECONDS_PER_ETH1_BLOCK * 1000);
-
-    this.intervals.push(interval);
-  }
-
-  private close(): void {
-    this.intervals.forEach(clearInterval);
-  }
-
-  private async getTerminalPowBlockFromEth1(): Promise<PowMergeBlock | null> {
-    if (!this.getTerminalPowBlockFromEth1Promise) {
-      this.getTerminalPowBlockFromEth1Promise = this.internalGetTerminalPowBlockFromEth1()
-        .then((mergeBlock) => {
-          // Persist found merge block here to affect both caller paths:
-          // - internal searcher
-          // - external caller if STOPPED
-          if (mergeBlock && this.status.code !== StatusCode.FOUND) {
-            if (this.status.code === StatusCode.SEARCHING) {
-              this.close();
-            }
-
-            this.logger.info("Terminal POW block found!", {
-              hash: mergeBlock.blockHash,
-              number: mergeBlock.number,
-              totalDifficulty: mergeBlock.totalDifficulty,
-            });
-
-            this.status = {code: StatusCode.FOUND, mergeBlock};
-            this.metrics?.eth1.eth1MergeBlockDetails.set(
-              {
-                terminalBlockHash: mergeBlock.blockHash,
-                // Convert all number/bigints to string labels
-                terminalBlockNumber: mergeBlock.number.toString(10),
-                terminalBlockTD: mergeBlock.totalDifficulty.toString(10),
-              },
-              1
-            );
-          }
-
-          return mergeBlock;
-        })
-        .finally(() => {
-          this.getTerminalPowBlockFromEth1Promise = null;
-        });
-    } else {
-      // This should no happen, since getTerminalPowBlockFromEth1() should resolve faster than SECONDS_PER_ETH1_BLOCK.
-      // else something is wrong: the el-cl comms are two slow, or the backsearch got stuck in a deep search.
-      this.metrics?.eth1.getTerminalPowBlockPromiseCacheHit.inc();
-    }
-
-    return this.getTerminalPowBlockFromEth1Promise;
-  }
-
-  /**
-   * **internal** + **unsafe** since it can create multiple backward searches that overload the eth1 client.
-   * Must be called in a wrapper to ensure that there's only once concurrent call to this fn.
-   */
-  private async internalGetTerminalPowBlockFromEth1(): Promise<PowMergeBlock | null> {
-    // Search merge block by hash
-    // Terminal block hash override takes precedence over terminal total difficulty
-    const terminalBlockHash = toRootHex(this.config.TERMINAL_BLOCK_HASH);
-    if (terminalBlockHash !== ZERO_HASH_HEX) {
-      const block = await this.getPowBlock(terminalBlockHash);
-      if (block) {
-        return block;
-      }
-      // if a TERMINAL_BLOCK_HASH other than ZERO_HASH is configured and we can't find it, return NONE
-      return null;
-    }
-
-    // Search merge block by TTD
-    const latestBlockRaw = await this.eth1Provider.getBlockByNumber("latest");
-    if (!latestBlockRaw) {
-      throw Error("getBlockByNumber('latest') returned null");
-    }
-
-    let block = toPowBlock(latestBlockRaw);
-    this.latestEth1Block = {...block, timestamp: quantityToNum(latestBlockRaw.timestamp)};
-    this.cacheBlock(block);
-
-    // This code path to look backwards for the merge block is only necessary if:
-    // - The network has not yet found the merge block
-    // - There are descendants of the merge block in the eth1 chain
-    // For the search below to require more than a few hops, multiple block proposers in a row must fail to detect
-    // an existing merge block. Such situation is extremely unlikely, so this search is left un-optimized. Since
-    // this class can start eagerly looking for the merge block when not necessary, startPollingMergeBlock() should
-    // only be called when there is certainty that a mergeBlock search is necessary.
-
-    while (true) {
-      if (block.totalDifficulty < this.config.TERMINAL_TOTAL_DIFFICULTY) {
-        // TTD not reached yet
-        return null;
-      }
-
-      // else block.totalDifficulty >= this.config.TERMINAL_TOTAL_DIFFICULTY
-      // Potential mergeBlock! Must find the first block that passes TTD
-
-      // Allow genesis block to reach TTD https://github.com/ethereum/consensus-specs/pull/2719
-      if (block.parentHash === ZERO_HASH_HEX) {
-        return block;
-      }
-
-      const parent = await this.getPowBlock(block.parentHash);
-      if (!parent) {
-        throw Error(`Unknown parent of block with TD>TTD ${block.parentHash}`);
-      }
-
-      this.metrics?.eth1.eth1ParentBlocksFetched.inc();
-
-      // block.td > TTD && parent.td < TTD => block is mergeBlock
-      if (parent.totalDifficulty < this.config.TERMINAL_TOTAL_DIFFICULTY) {
-        // Is terminal total difficulty block AND has verified block -> parent relationship
-        return block;
-      }
-      block = parent;
-    }
-  }
-
-  private cacheBlock(block: PowMergeBlock): void {
-    this.blocksByHashCache.set(block.blockHash, block);
-    pruneSetToMax(this.blocksByHashCache, MAX_CACHE_POW_BLOCKS);
-  }
-}
-
-export function toPowBlock(block: EthJsonRpcBlockRaw): PowMergeBlock {
-  // Validate untrusted data from API
-  return {
-    number: quantityToNum(block.number),
-    blockHash: dataToRootHex(block.hash),
-    parentHash: dataToRootHex(block.parentHash),
-    totalDifficulty: quantityToBigint(block.totalDifficulty),
-  };
-}
-
-/**
- * TTD values can be very large, for xDAI > 1e45. So scale down.
- * To be good, TTD should be rendered as a number < Number.MAX_TD_RENDER_VALUE ~= 9e15
- */
-export function getSafeTDFactor(ttd: bigint): bigint {
-  const safeIntegerMult = ttd / BigInt(MAX_TD_RENDER_VALUE);
-
-  // TTD < MAX_TD_RENDER_VALUE, no need to scale down
-  if (safeIntegerMult === BigInt(0)) {
-    return BigInt(1);
-  }
-
-  // Return closest power of 10 to ensure TD < max
-  const safeIntegerMultDigits = safeIntegerMult.toString(10).length;
-  return BigInt(10) ** BigInt(safeIntegerMultDigits);
-}