-
-
Notifications
You must be signed in to change notification settings - Fork 266
/
proof_provider.ts
209 lines (176 loc) Β· 6.86 KB
/
proof_provider.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
import {Api, getClient} from "@lodestar/api/beacon";
import {ChainForkConfig, createChainForkConfig} from "@lodestar/config";
import {NetworkName, networksChainConfig} from "@lodestar/config/networks";
import {Lightclient, LightclientEvent, RunStatusCode} from "@lodestar/light-client";
import {LightClientRestTransport} from "@lodestar/light-client/transport";
import {isForkWithdrawals} from "@lodestar/params";
import {allForks, capella} from "@lodestar/types";
import {Logger} from "@lodestar/utils";
import {LCTransport, RootProviderInitOptions} from "../interfaces.js";
import {assertLightClient} from "../utils/assertion.js";
import {
getExecutionPayloads,
getGenesisData,
getSyncCheckpoint,
getUnFinalizedRangeForPayloads,
} from "../utils/consensus.js";
import {bufferToHex} from "../utils/conversion.js";
import {PayloadStore} from "./payload_store.js";
type RootProviderOptions = Omit<RootProviderInitOptions, "transport"> & {
transport: LightClientRestTransport;
api: Api;
config: ChainForkConfig;
};
export class ProofProvider {
private store: PayloadStore;
private logger: Logger;
// Make sure readyPromise doesn't throw unhandled exceptions
private readyPromise?: Promise<void>;
readonly config: ChainForkConfig;
readonly network: NetworkName;
readonly api: Api;
lightClient?: Lightclient;
constructor(readonly opts: RootProviderOptions) {
this.store = new PayloadStore({api: opts.api, logger: opts.logger});
this.logger = opts.logger;
this.config = opts.config;
this.api = opts.api;
this.network = opts.config.PRESET_BASE as NetworkName;
}
async waitToBeReady(): Promise<void> {
return this.readyPromise;
}
static init(opts: RootProviderInitOptions): ProofProvider {
if (opts.transport === LCTransport.P2P) {
throw new Error("P2P mode not supported yet");
}
opts.logger.info("Creating ProofProvider instance with REST APIs", {
network: opts.network,
urls: opts.urls.join(","),
});
const config = opts.network
? createChainForkConfig(networksChainConfig[opts.network])
: createChainForkConfig(opts.config);
const api = getClient({urls: opts.urls}, {config});
const transport = new LightClientRestTransport(api);
const provider = new ProofProvider({
...opts,
config,
api,
transport,
});
provider.readyPromise = provider.sync(opts.wsCheckpoint).catch((e) => {
opts.logger.error("Error while syncing", e);
return Promise.reject(e);
});
return provider;
}
private async sync(wsCheckpoint?: string): Promise<void> {
if (this.lightClient !== undefined) {
throw Error("Light client already initialized and syncing.");
}
this.logger.info("Starting sync for proof provider");
const {api, config, transport} = this.opts;
const checkpointRoot = await getSyncCheckpoint(api, wsCheckpoint);
const genesisData = await getGenesisData(api);
this.logger.info("Initializing lightclient", {checkpointRoot: bufferToHex(checkpointRoot)});
this.lightClient = await Lightclient.initializeFromCheckpointRoot({
checkpointRoot,
config,
transport,
genesisData,
});
assertLightClient(this.lightClient);
this.logger.info("Initiating lightclient");
// Wait for the lightclient to start
await this.lightClient?.start();
this.logger.info("Lightclient synced", this.getStatus());
this.registerEvents();
// Load the payloads from the CL
this.logger.info("Building EL payload history");
const {start, end} = await getUnFinalizedRangeForPayloads(this.lightClient);
const payloads = await getExecutionPayloads({
api: this.opts.api,
startSlot: start,
endSlot: end,
logger: this.logger,
});
for (const payload of Object.values(payloads)) {
this.store.set(payload, false);
}
// Load the finalized payload from the CL
const finalizedSlot = this.lightClient.getFinalized().beacon.slot;
this.logger.debug("Getting finalized slot from lightclient", {finalizedSlot});
const finalizedPayload = await getExecutionPayloads({
api: this.opts.api,
startSlot: finalizedSlot,
endSlot: finalizedSlot,
logger: this.logger,
});
this.store.set(finalizedPayload[finalizedSlot], true);
this.logger.info("Proof provider ready");
}
getStatus(): {latest: number; finalized: number; status: RunStatusCode} {
if (!this.lightClient) {
return {
latest: 0,
finalized: 0,
status: RunStatusCode.uninitialized,
};
}
return {
latest: this.lightClient.getHead().beacon.slot,
finalized: this.lightClient.getFinalized().beacon.slot,
status: this.lightClient.status,
};
}
async getExecutionPayload(blockNumber: number | string | "finalized" | "latest"): Promise<allForks.ExecutionPayload> {
assertLightClient(this.lightClient);
if (typeof blockNumber === "string" && blockNumber === "finalized") {
const payload = this.store.finalized;
if (!payload) throw new Error("No finalized payload");
return payload;
}
if (typeof blockNumber === "string" && blockNumber === "latest") {
const payload = this.store.latest;
if (!payload) throw new Error("No latest payload");
return payload;
}
if ((typeof blockNumber === "string" && blockNumber.startsWith("0x")) || typeof blockNumber === "number") {
const payload = await this.store.get(blockNumber);
if (!payload) throw new Error(`No payload for blockNumber ${blockNumber}`);
return payload;
}
throw new Error(`Invalid blockNumber "${blockNumber}"`);
}
async processLCHeader(lcHeader: allForks.LightClientHeader, finalized = false): Promise<void> {
const fork = this.opts.config.getForkName(lcHeader.beacon.slot);
if (!isForkWithdrawals(fork)) {
return;
}
const sszType = this.opts.config.getExecutionForkTypes(lcHeader.beacon.slot).ExecutionPayloadHeader;
if (
isForkWithdrawals(fork) &&
(!("execution" in lcHeader) || sszType.equals(lcHeader.execution, sszType.defaultValue()))
) {
throw new Error("Execution payload is required for execution fork");
}
await this.store.processLCHeader(lcHeader as capella.LightClientHeader, finalized);
}
private registerEvents(): void {
assertLightClient(this.lightClient);
this.opts.signal.addEventListener("abort", () => {
this.lightClient?.stop();
});
this.lightClient.emitter.on(LightclientEvent.lightClientFinalityHeader, async (data) => {
await this.processLCHeader(data, true).catch((e) => {
this.logger.error("Error processing finality update", null, e);
});
});
this.lightClient.emitter.on(LightclientEvent.lightClientOptimisticHeader, async (data) => {
await this.processLCHeader(data).catch((e) => {
this.logger.error("Error processing optimistic update", null, e);
});
});
}
}