Skip to content
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.

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

Remove intermediary event ChainEvent.forkChoiceReorg #4972

Merged
merged 1 commit into from
Jan 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 1 addition & 13 deletions packages/beacon-node/src/api/impl/events/index.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import {capella} from "@lodestar/types";
import {computeEpochAtSlot} from "@lodestar/state-transition";
import {routes} from "@lodestar/api";
import {toHexString} from "@chainsafe/ssz";
import {ApiModules} from "../types.js";
Expand Down Expand Up @@ -50,18 +49,7 @@ export function getEventsApi({chain, config}: Pick<ApiModules, "chain" | "config
executionOptimistic: false,
},
],
[routes.events.EventType.chainReorg]: (oldHead, newHead, depth, executionOptimistic) => [
{
depth,
epoch: computeEpochAtSlot(newHead.slot),
slot: newHead.slot,
newHeadBlock: newHead.blockRoot,
oldHeadBlock: oldHead.blockRoot,
newHeadState: newHead.stateRoot,
oldHeadState: oldHead.stateRoot,
executionOptimistic,
},
],
[routes.events.EventType.chainReorg]: (data) => [data],
[routes.events.EventType.contributionAndProof]: (contributionAndProof) => [contributionAndProof],
[routes.events.EventType.lightClientOptimisticUpdate]: (headerUpdate) => [headerUpdate],
[routes.events.EventType.lightClientFinalityUpdate]: (headerUpdate) => [headerUpdate],
Expand Down
11 changes: 10 additions & 1 deletion packages/beacon-node/src/chain/blocks/importBlock.ts
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,16 @@ export async function importBlock(
newSlot: newHead.slot,
});

pendingEvents.push(ChainEvent.forkChoiceReorg, newHead, oldHead, distance, executionOptimistic);
pendingEvents.push(ChainEvent.forkChoiceReorg, {
depth: distance,
epoch: computeEpochAtSlot(newHead.slot),
slot: newHead.slot,
newHeadBlock: newHead.blockRoot,
oldHeadBlock: oldHead.blockRoot,
newHeadState: newHead.stateRoot,
oldHeadState: oldHead.stateRoot,
executionOptimistic,
});

this.metrics?.forkChoice.reorg.inc();
this.metrics?.forkChoice.reorgDistance.observe(distance);
Expand Down
10 changes: 3 additions & 7 deletions packages/beacon-node/src/chain/emitter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import StrictEventEmitter from "strict-event-emitter-types";

import {routes} from "@lodestar/api";
import {phase0, Epoch, Slot, allForks, altair} from "@lodestar/types";
import {CheckpointWithHex, ProtoBlock} from "@lodestar/fork-choice";
import {CheckpointWithHex} from "@lodestar/fork-choice";
import {CachedBeaconStateAllForks} from "@lodestar/state-transition";

/**
Expand Down Expand Up @@ -100,6 +100,7 @@ export enum ChainEvent {
}

export type HeadEventData = routes.events.EventData[routes.events.EventType.head];
export type ReorgEventData = routes.events.EventData[routes.events.EventType.chainReorg];

export interface IChainEvents {
[ChainEvent.attestation]: (attestation: phase0.Attestation) => void;
Expand All @@ -118,12 +119,7 @@ export interface IChainEvents {
[ChainEvent.clockEpoch]: (epoch: Epoch) => void;

[ChainEvent.head]: (data: HeadEventData) => void;
[ChainEvent.forkChoiceReorg]: (
head: ProtoBlock,
oldHead: ProtoBlock,
depth: number,
executionOptimistic: boolean
) => void;
[ChainEvent.forkChoiceReorg]: (data: ReorgEventData) => void;
[ChainEvent.forkChoiceJustified]: (checkpoint: CheckpointWithHex) => void;
[ChainEvent.forkChoiceFinalized]: (checkpoint: CheckpointWithHex) => void;

Expand Down
18 changes: 1 addition & 17 deletions packages/beacon-node/test/unit/api/impl/events/events.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ describe("Events api impl", function () {

const headBlock = generateProtoBlock();
stateCacheStub.get.withArgs(headBlock.stateRoot).returns(generateCachedState({slot: 1000}));
chainEventEmmitter.emit(ChainEvent.forkChoiceReorg, headBlock, headBlock, 2, false);
chainEventEmmitter.emit(ChainEvent.attestation, ssz.phase0.Attestation.defaultValue());
chainEventEmmitter.emit(ChainEvent.head, headEventData);

expect(events).to.have.length(1, "Wrong num of received events");
Expand Down Expand Up @@ -133,21 +133,5 @@ describe("Events api impl", function () {
expect(events[0].type).to.equal(routes.events.EventType.finalizedCheckpoint);
expect(events[0].message).to.not.be.null;
});

it("should process chain reorg event", async function () {
const events = getEvents([routes.events.EventType.chainReorg]);

const depth = 3;
const oldHead = generateProtoBlock({slot: 4});
const newHead = generateProtoBlock({slot: 3});
chainEventEmmitter.emit(ChainEvent.forkChoiceReorg, oldHead, newHead, depth, false);

expect(events).to.have.length(1, "Wrong num of received events");
const event = events[0];
if (event.type !== routes.events.EventType.chainReorg) throw Error(`Wrong event type ${event.type}`);
expect(events[0].type).to.equal(routes.events.EventType.chainReorg);
expect(event.message).to.not.be.null;
expect(event.message.depth).to.equal(depth, "Wrong depth");
});
});
});