@lodestar/beacon-node 1.35.0-dev.f80d2d52da → 1.35.0-dev.fd1dac853d

package/lib/sync/unknownBlock.d.ts

@@ -1,14 +1,45 @@
 import { ChainForkConfig } from "@lodestar/config";
 import { Logger } from "@lodestar/utils";
-import { BlockInput, NullBlockInput } from "../chain/blocks/types.js";
+import { IBlockInput } from "../chain/blocks/blockInput/types.js";
 import { IBeaconChain } from "../chain/index.js";
 import { Metrics } from "../metrics/index.js";
 import { INetwork } from "../network/index.js";
 import { PeerSyncMeta } from "../network/peers/peersData.js";
-import { CustodyConfig } from "../util/dataColumns.js";
 import { PeerIdStr } from "../util/peerId.js";
 import { SyncOptions } from "./options.js";
-export declare class UnknownBlockSync {
+/**
+ * BlockInputSync is a class that handles ReqResp to find blocks and data related to a specific blockRoot.  The
+ * blockRoot may have been found via object gossip, or the API.  Gossip objects that can trigger a search are block,
+ * blobs, columns, attestations, etc.  In the case of blocks and data this is generally during the current slot but
+ * can also be for items that are received late but are not fully verified and thus not in fork-choice (old blocks on
+ * an unknown fork). It can also be triggered via an attestation (or sync committee message or any other item that
+ * gets gossiped) that references a blockRoot that is not in fork-choice.  In rare (and realistically should not happen)
+ * situations it can get triggered via the API when the validator attempts to publish a block, attestation, aggregate
+ * and proof or a sync committee contribution that has unknown information included (parentRoot for instance).
+ *
+ * The goal of the class is to make sure that all information that is necessary for import into fork-choice is pulled
+ * from peers so that the block and data can be processed, and thus the object that triggered the search can be
+ * referenced and validated.
+ *
+ * The most common case for this search is a set of block/data that comes across gossip for the current slot, during
+ * normal chain operation, but not everything was received before the gossip cutoff window happens so it is necessary
+ * to pull remaining data via req/resp so that fork-choice can be updated prior to making an attestation for the
+ * current slot.
+ *
+ * Event sources for old UnknownBlock
+ *
+ * - publishBlock
+ * - gossipHandlers
+ * - searchUnknownSlotRoot
+ *    = produceSyncCommitteeContribution
+ *    = validateGossipFnRetryUnknownRoot
+ *        * submitPoolAttestationsV2
+ *        * publishAggregateAndProofsV2
+ *    = onPendingGossipsubMessage
+ *        * NetworkEvent.pendingGossipsubMessage
+ *            - onGossipsubMessage
+ */
+export declare class BlockInputSync {
     private readonly config;
     private readonly network;
     private readonly chain;
@@ -20,11 +51,8 @@ export declare class UnknownBlockSync {
      */
     private readonly pendingBlocks;
     private readonly knownBadBlocks;
-    private readonly proposerBoostSecWindow;
     private readonly maxPendingBlocks;
     private subscribedToNetworkEvents;
-    private engineGetBlobsCache;
-    private blockInputsRetryTrackerCache;
     private peerBalancer;
     constructor(config: ChainForkConfig, network: INetwork, chain: IBeaconChain, logger: Logger, metrics: Metrics | null, opts?: SyncOptions | undefined);
     subscribeToNetwork(): void;
@@ -34,24 +62,17 @@ export declare class UnknownBlockSync {
     /**
      * Process an unknownBlock event and register the block in `pendingBlocks` Map.
      */
-    private onUnknownBlock;
+    private onUnknownBlockRoot;
     /**
      * Process an unknownBlockInput event and register the block in `pendingBlocks` Map.
      */
-    private onUnknownBlockInput;
+    private onIncompleteBlockInput;
     /**
      * Process an unknownBlockParent event and register the block in `pendingBlocks` Map.
      */
     private onUnknownParent;
-    /**
-     * When a blockInput comes with  an unknown parent:
-     * - add the block to pendingBlocks with status downloaded or pending blockRootHex as key. This is similar to
-     * an `onUnknownBlock` event, but the blocks is downloaded.
-     * - add the parent root to pendingBlocks with status pending, parentBlockRootHex as key. This is
-     * the same to an `onUnknownBlock` event with parentBlockRootHex as root.
-     */
-    private addUnknownParent;
-    private addUnknownBlock;
+    private addByRootHex;
+    private addByBlockInput;
     private onPeerConnected;
     private onPeerDisconnected;
     /**
@@ -74,21 +95,14 @@ export declare class UnknownBlockSync {
      * prefulu, will attempt a max of `MAX_ATTEMPTS_PER_BLOCK` on different peers, postfulu we may attempt more as defined in `getMaxDownloadAttempts()` function
      * Also verifies the received block root + returns the peer that provided the block for future downscoring.
      */
-    private fetchUnknownBlockRoot;
-    /**
-     * We have partial block input:
-     * - we have block but not have all blobs (deneb) or needed columns (fulu)
-     * - we don't have block and have some blobs (deneb) or some columns (fulu)
-     * Fetches missing block/data columns/block for the blockinput. This function returns either preData or availableData BlockInput.
-     */
-    private fetchUnavailableBlockInput;
+    private fetchBlockInput;
     /**
      * Gets all descendant blocks of `block` recursively from `pendingBlocks`.
      * Assumes that if a parent block does not exist or is not processable, all descendant blocks are bad too.
      * Downscore all peers that have referenced any of this bad blocks. May report peers multiple times if they have
      * referenced more than one bad block.
      */
-    private removeAndDownscoreAllDescendants;
+    private removeAndDownScoreAllDescendants;
     private removeAllDescendants;
     private getMaxDownloadAttempts;
 }
@@ -98,8 +112,7 @@ export declare class UnknownBlockSync {
 export declare class UnknownBlockPeerBalancer {
     readonly peersMeta: Map<PeerIdStr, PeerSyncMeta>;
     readonly activeRequests: Map<PeerIdStr, number>;
-    private readonly custodyConfig;
-    constructor(custodyConfig: CustodyConfig);
+    constructor();
     /** Trigger on each peer re-status */
     onPeerConnected(peerId: PeerIdStr, syncMeta: PeerSyncMeta): void;
     onPeerDisconnected(peerId: PeerIdStr): void;
@@ -113,7 +126,7 @@ export declare class UnknownBlockPeerBalancer {
      * called from fetchUnavailableBlockInput() where we have either BlockInput or NullBlockInput
      * excludedPeers are the peers that we requested already so we don't want to try again
      */
-    bestPeerForBlockInput(unavailableBlockInput: BlockInput | NullBlockInput, excludedPeers: Set<PeerIdStr>): PeerSyncMeta | null;
+    bestPeerForBlockInput(blockInput: IBlockInput, excludedPeers: Set<PeerIdStr>): PeerSyncMeta | null;
     /**
      * Consumers don't need to call this method directly, it is called internally by bestPeer*() methods
      * make this public for testing

package/lib/sync/unknownBlock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unknownBlock.d.ts","sourceRoot":"","sources":["../../src/sync/unknownBlock.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,EAAC,MAAM,kBAAkB,CAAC;AAKjD,OAAO,EAAC,MAAM,EAA2C,MAAM,iBAAiB,CAAC;AAEjF,OAAO,EAAmB,WAAW,EAAC,MAAM,qCAAqC,CAAC;AAElF,OAAO,EAA6B,YAAY,EAAC,MAAM,mBAAmB,CAAC;AAC3E,OAAO,EAAC,OAAO,EAAC,MAAM,qBAAqB,CAAC;AAC5C,OAAO,EAAC,QAAQ,EAAuD,MAAM,qBAAqB,CAAC;AACnG,OAAO,EAAC,YAAY,EAAC,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAC,SAAS,EAAC,MAAM,mBAAmB,CAAC;AAK5C,OAAO,EAAC,WAAW,EAAC,MAAM,cAAc,CAAC;AAyBzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,qBAAa,cAAc;IAWvB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;IAfxB;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA+C;IAC7E,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAsB;IACrD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IAClC,OAAO,CAAC,yBAAyB,CAAS;IAC1C,OAAO,CAAC,YAAY,CAA2B;gBAG5B,MAAM,EAAE,eAAe,EACvB,OAAO,EAAE,QAAQ,EACjB,KAAK,EAAE,YAAY,EACnB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,OAAO,GAAG,IAAI,EACvB,IAAI,CAAC,EAAE,WAAW,YAAA;IAerC,kBAAkB,IAAI,IAAI;IAkB1B,sBAAsB,IAAI,IAAI;IAU9B,KAAK,IAAI,IAAI;IAIb,qBAAqB,IAAI,OAAO;IAIhC;;OAEG;IACH,OAAO,CAAC,kBAAkB,CASxB;IAEF;;OAEG;IACH,OAAO,CAAC,sBAAsB,CAS5B;IAEF;;OAEG;IACH,OAAO,CAAC,eAAe,CAUrB;IAEF,OAAO,CAAC,YAAY,CA2BlB;IAEF,OAAO,CAAC,eAAe,CA4BrB;IAEF,OAAO,CAAC,eAAe,CASrB;IAEF,OAAO,CAAC,kBAAkB,CAGxB;IAEF;;OAEG;IACH,OAAO,CAAC,yBAAyB,CA2C/B;YAEY,aAAa;IA6D3B;;;;OAIG;YACW,YAAY;IA4G1B;;;;;;;;OAQG;YACW,eAAe;IAmJ7B;;;;;OAKG;IACH,OAAO,CAAC,gCAAgC;IA4BxC,OAAO,CAAC,oBAAoB;IAqB5B,OAAO,CAAC,sBAAsB;CAY/B;AAED;;GAEG;AACH,qBAAa,wBAAwB;IACnC,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IACjD,QAAQ,CAAC,cAAc,EAAE,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;;IAOhD,qCAAqC;IACrC,eAAe,CAAC,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,YAAY,GAAG,IAAI;IAQhE,kBAAkB,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI;IAK3C;;;;OAIG;IACH,yBAAyB,CAAC,cAAc,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,IAAI,EAAE,aAAa,EAAE,GAAG,CAAC,SAAS,CAAC,GAAG,YAAY,GAAG,IAAI;IAiBjH;;;OAGG;IACH,qBAAqB,CAAC,UAAU,EAAE,WAAW,EAAE,aAAa,EAAE,GAAG,CAAC,SAAS,CAAC,GAAG,YAAY,GAAG,IAAI;IA2BlG;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI;IAIlC;;OAEG;IACH,kBAAkB,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI;IAI3C,sBAAsB,IAAI,MAAM;IAShC,OAAO,CAAC,WAAW;CAiDpB"}