Skip to content

refactor: payload envelope input -- pruneBelowParent #9326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jeffoodchain wants to merge 6 commits into
base: unstable
Choose a base branch
from
Open

refactor: payload envelope input -- pruneBelowParent #9326

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fa3ce8d
refactor: enhance pruning logic in SeenPayloadEnvelopeInput
jeffoodchain May 5, 2026
3068d8d
test: update SeenPayloadEnvelopeInput tests for pruning logic
jeffoodchain May 5, 2026
e5c4f3a
fix: comment typo
jeffoodchain May 5, 2026
6d4fe72
fix: prune both PENDING and FULL payload envelope entries
jeffoodchain May 14, 2026
956e829
fix: put the log inside the loop
jeffoodchain May 14, 2026
d0bbbfa
test: add two tests for PENDING and FULL ancestry
jeffoodchain May 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 17 additions & 11 deletions packages/beacon-node/src/chain/seenCache/seenPayloadEnvelopeInput.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import {ChainForkConfig} from "@lodestar/config";
import {CheckpointWithHex, IForkChoice, ProtoBlock} from "@lodestar/fork-choice";
import {CheckpointWithHex, IForkChoice, PayloadStatus, ProtoBlock} from "@lodestar/fork-choice";
import {computeStartSlotAtEpoch} from "@lodestar/state-transition";
import {RootHex} from "@lodestar/types";
import {Logger} from "@lodestar/utils";
Expand Down Expand Up @@ -136,16 +136,22 @@ export class SeenPayloadEnvelopeInput {
}

pruneBelowParent(parentBlock: ProtoBlock): void {
for (const block of this.forkChoice.getAllAncestorBlocks(parentBlock.blockRoot, parentBlock.payloadStatus)) {
if (block.slot < parentBlock.slot) {
const input = this.payloadInputs.get(block.blockRoot);
if (input) {
this.evictPayloadInput(input);
this.logger?.verbose("SeenPayloadEnvelopeInput.pruneBelowParent deleted", {
slot: block.slot,
root: block.blockRoot,
});
}
for (const input of this.payloadInputs.values()) {
if (
input.slot < parentBlock.slot &&
// Check if the cached PENDING/FULL variant is an ancestor of the current parent block
this.forkChoice.isDescendant(
input.blockRootHex,
input.hasPayloadEnvelope() ? PayloadStatus.FULL : PayloadStatus.PENDING,
parentBlock.blockRoot,
parentBlock.payloadStatus
)
) {
this.evictPayloadInput(input);
Copy link
Copy Markdown
Contributor

@twoeths twoeths May 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please keep the log inside this if similar to line 144 above

Copy link
Copy Markdown
Author

@jeffoodchain jeffoodchain May 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I fixed in the latest commits.

this.logger?.verbose("SeenPayloadEnvelopeInput.pruneBelowParent deleted", {
slot: input.slot,
root: input.blockRootHex,
});
}
}
}
Expand Down
61 changes: 56 additions & 5 deletions packages/beacon-node/test/unit/chain/seenCache/seenPayloadEnvelopeInput.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ describe("SeenPayloadEnvelopeInput", () => {
chainEvents = new ChainEventEmitter();
abortController = new AbortController();
forkChoice = {
getAllAncestorBlocks: vi.fn(),
isDescendant: vi.fn().mockReturnValue(false),
} as unknown as IForkChoice;
serializedCache = new SerializedCache();

Expand Down Expand Up @@ -50,7 +50,7 @@ describe("SeenPayloadEnvelopeInput", () => {
return rootHex;
}

function protoBlock(blockRoot: RootHex, slot: number): ProtoBlock {
function protoBlock(blockRoot: RootHex, slot: number, payloadStatus: PayloadStatus = PayloadStatus.FULL): ProtoBlock {
return {
slot,
blockRoot,
Expand All @@ -69,7 +69,7 @@ describe("SeenPayloadEnvelopeInput", () => {
executionPayloadBlockHash: null,
executionStatus: ExecutionStatus.PreMerge,
dataAvailabilityStatus: DataAvailabilityStatus.PreData,
payloadStatus: PayloadStatus.FULL,
payloadStatus,
parentBlockHash: null,
};
}
Expand All @@ -79,7 +79,8 @@ describe("SeenPayloadEnvelopeInput", () => {
const newRootHex = addPayloadInput(2);
const parentBlock = protoBlock(newRootHex, 2);

vi.mocked(forkChoice.getAllAncestorBlocks).mockReturnValue([parentBlock, protoBlock(oldRootHex, 1)]);
// Only the older entries are ancestors
vi.mocked(forkChoice.isDescendant).mockImplementation((ancestorRoot) => ancestorRoot === oldRootHex);
cache.pruneBelowParent(parentBlock);

expect(cache.get(oldRootHex)).toBeUndefined();
Expand All @@ -90,12 +91,62 @@ describe("SeenPayloadEnvelopeInput", () => {
const rootHex = addPayloadInput(1);
const parentBlock = protoBlock(rootHex, 1);

vi.mocked(forkChoice.getAllAncestorBlocks).mockReturnValue([parentBlock]);
vi.mocked(forkChoice.isDescendant).mockReturnValue(true);
cache.pruneBelowParent(parentBlock);

expect(cache.get(rootHex)).toBeDefined();
});

it("pruneBelowParent leaves non-ancestor entries on forks alone", () => {
const forkRootHex = addPayloadInput(1);
const headRootHex = addPayloadInput(2);
const parentBlock = protoBlock(headRootHex, 2);

vi.mocked(forkChoice.isDescendant).mockReturnValue(false);
cache.pruneBelowParent(parentBlock);

expect(cache.get(forkRootHex)).toBeDefined();
expect(cache.get(headRootHex)).toBeDefined();
});

it("pruneBelowParent checks PENDING ancestry when payload envelope is not cached", () => {
const oldRootHex = addPayloadInput(1);
const newRootHex = addPayloadInput(2);
const parentBlock = protoBlock(newRootHex, 2);

vi.mocked(forkChoice.isDescendant).mockReturnValue(true);
cache.pruneBelowParent(parentBlock);

expect(forkChoice.isDescendant).toHaveBeenCalledWith(
oldRootHex,
PayloadStatus.PENDING,
newRootHex,
PayloadStatus.FULL
);
expect(cache.get(oldRootHex)).toBeUndefined();
expect(cache.get(newRootHex)).toBeDefined();
});

it("pruneBelowParent checks FULL ancestry when payload envelope is cached", () => {
const oldRootHex = addPayloadInput(1);
// biome-ignore lint/style/noNonNullAssertion: input was just added on the line above
vi.spyOn(cache.get(oldRootHex)!, "hasPayloadEnvelope").mockReturnValue(true);
const newRootHex = addPayloadInput(2);
const parentBlock = protoBlock(newRootHex, 2);

vi.mocked(forkChoice.isDescendant).mockReturnValue(true);
cache.pruneBelowParent(parentBlock);

expect(forkChoice.isDescendant).toHaveBeenCalledWith(
oldRootHex,
PayloadStatus.FULL,
newRootHex,
PayloadStatus.FULL
);
expect(cache.get(oldRootHex)).toBeUndefined();
expect(cache.get(newRootHex)).toBeDefined();
});

it("add returns the existing entry on duplicate root", () => {
const {block, rootHex} = generateBlock({forkName: ForkName.gloas, slot: 1});
const props = {
Expand Down
Loading