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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
package finality
import (
"context"
"errors"
"math/rand" // nosemgrep
"testing"
"github.com/stretchr/testify/require"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/log"
"github.com/ethereum-optimism/optimism/op-node/rollup"
"github.com/ethereum-optimism/optimism/op-node/rollup/derive"
"github.com/ethereum-optimism/optimism/op-node/rollup/engine"
"github.com/ethereum-optimism/optimism/op-service/eth"
"github.com/ethereum-optimism/optimism/op-service/testlog"
"github.com/ethereum-optimism/optimism/op-service/testutils"
)
func TestEngineQueue_Finalize(t *testing.T) {
rng := rand.New(rand.NewSource(1234))
l1Time := uint64(2)
refA := testutils.RandomBlockRef(rng)
refB := eth.L1BlockRef{
Hash: testutils.RandomHash(rng),
Number: refA.Number + 1,
ParentHash: refA.Hash,
Time: refA.Time + l1Time,
}
refC := eth.L1BlockRef{
Hash: testutils.RandomHash(rng),
Number: refB.Number + 1,
ParentHash: refB.Hash,
Time: refB.Time + l1Time,
}
refD := eth.L1BlockRef{
Hash: testutils.RandomHash(rng),
Number: refC.Number + 1,
ParentHash: refC.Hash,
Time: refC.Time + l1Time,
}
refE := eth.L1BlockRef{
Hash: testutils.RandomHash(rng),
Number: refD.Number + 1,
ParentHash: refD.Hash,
Time: refD.Time + l1Time,
}
refF := eth.L1BlockRef{
Hash: testutils.RandomHash(rng),
Number: refE.Number + 1,
ParentHash: refE.Hash,
Time: refE.Time + l1Time,
}
refG := eth.L1BlockRef{
Hash: testutils.RandomHash(rng),
Number: refF.Number + 1,
ParentHash: refF.Hash,
Time: refF.Time + l1Time,
}
refH := eth.L1BlockRef{
Hash: testutils.RandomHash(rng),
Number: refG.Number + 1,
ParentHash: refG.Hash,
Time: refG.Time + l1Time,
}
//refI := eth.L1BlockRef{
// Hash: testutils.RandomHash(rng),
// Number: refH.Number + 1,
// ParentHash: refH.Hash,
// Time: refH.Time + l1Time,
//}
refA0 := eth.L2BlockRef{
Hash: testutils.RandomHash(rng),
Number: 0,
ParentHash: common.Hash{},
Time: refA.Time,
L1Origin: refA.ID(),
SequenceNumber: 0,
}
cfg := &rollup.Config{
Genesis: rollup.Genesis{
L1: refA.ID(),
L2: refA0.ID(),
L2Time: refA0.Time,
},
BlockTime: 1,
SeqWindowSize: 2,
}
refA1 := eth.L2BlockRef{
Hash: testutils.RandomHash(rng),
Number: refA0.Number + 1,
ParentHash: refA0.Hash,
Time: refA0.Time + cfg.BlockTime,
L1Origin: refA.ID(),
SequenceNumber: 1,
}
refB0 := eth.L2BlockRef{
Hash: testutils.RandomHash(rng),
Number: refA1.Number + 1,
ParentHash: refA1.Hash,
Time: refA1.Time + cfg.BlockTime,
L1Origin: refB.ID(),
SequenceNumber: 0,
}
refB1 := eth.L2BlockRef{
Hash: testutils.RandomHash(rng),
Number: refB0.Number + 1,
ParentHash: refB0.Hash,
Time: refB0.Time + cfg.BlockTime,
L1Origin: refB.ID(),
SequenceNumber: 1,
}
refC0 := eth.L2BlockRef{
Hash: testutils.RandomHash(rng),
Number: refB1.Number + 1,
ParentHash: refB1.Hash,
Time: refB1.Time + cfg.BlockTime,
L1Origin: refC.ID(),
SequenceNumber: 0,
}
refC1 := eth.L2BlockRef{
Hash: testutils.RandomHash(rng),
Number: refC0.Number + 1,
ParentHash: refC0.Hash,
Time: refC0.Time + cfg.BlockTime,
L1Origin: refC.ID(),
SequenceNumber: 1,
}
refD0 := eth.L2BlockRef{
Hash: testutils.RandomHash(rng),
Number: refC1.Number + 1,
ParentHash: refC1.Hash,
Time: refC1.Time + cfg.BlockTime,
L1Origin: refD.ID(),
SequenceNumber: 0,
}
refD1 := eth.L2BlockRef{
Hash: testutils.RandomHash(rng),
Number: refD0.Number + 1,
ParentHash: refD0.Hash,
Time: refD0.Time + cfg.BlockTime,
L1Origin: refD.ID(),
SequenceNumber: 1,
}
refE0 := eth.L2BlockRef{
Hash: testutils.RandomHash(rng),
Number: refD1.Number + 1,
ParentHash: refD1.Hash,
Time: refD1.Time + cfg.BlockTime,
L1Origin: refE.ID(),
SequenceNumber: 0,
}
refE1 := eth.L2BlockRef{
Hash: testutils.RandomHash(rng),
Number: refE0.Number + 1,
ParentHash: refE0.Hash,
Time: refE0.Time + cfg.BlockTime,
L1Origin: refE.ID(),
SequenceNumber: 1,
}
refF0 := eth.L2BlockRef{
Hash: testutils.RandomHash(rng),
Number: refE1.Number + 1,
ParentHash: refE1.Hash,
Time: refE1.Time + cfg.BlockTime,
L1Origin: refF.ID(),
SequenceNumber: 0,
}
refF1 := eth.L2BlockRef{
Hash: testutils.RandomHash(rng),
Number: refF0.Number + 1,
ParentHash: refF0.Hash,
Time: refF0.Time + cfg.BlockTime,
L1Origin: refF.ID(),
SequenceNumber: 1,
}
_ = refF1
// We expect the L1 block that the finalized L2 data was derived from to be checked,
// to be sure it is part of the canonical chain, after the finalization signal.
t.Run("basic", func(t *testing.T) {
logger := testlog.Logger(t, log.LevelInfo)
l1F := &testutils.MockL1Source{}
defer l1F.AssertExpectations(t)
l1F.ExpectL1BlockRefByNumber(refD.Number, refD, nil)
l1F.ExpectL1BlockRefByNumber(refD.Number, refD, nil)
emitter := &testutils.MockEmitter{}
fi := NewFinalizer(context.Background(), logger, &rollup.Config{}, l1F)
fi.AttachEmitter(emitter)
// now say C1 was included in D and became the new safe head
fi.OnEvent(engine.SafeDerivedEvent{Safe: refC1, DerivedFrom: refD})
fi.OnEvent(derive.DeriverIdleEvent{Origin: refD})
emitter.AssertExpectations(t)
// now say D0 was included in E and became the new safe head
fi.OnEvent(engine.SafeDerivedEvent{Safe: refD0, DerivedFrom: refE})
fi.OnEvent(derive.DeriverIdleEvent{Origin: refE})
emitter.AssertExpectations(t)
// Let's finalize D from which we fully derived C1, but not D0
// This will trigger an attempt of L2 finalization.
emitter.ExpectOnce(TryFinalizeEvent{})
fi.OnEvent(FinalizeL1Event{FinalizedL1: refD})
emitter.AssertExpectations(t)
// C1 was included in finalized D, and should now be finalized
emitter.ExpectOnce(engine.PromoteFinalizedEvent{Ref: refC1})
fi.OnEvent(TryFinalizeEvent{})
emitter.AssertExpectations(t)
})
// Finality signal is received, but couldn't immediately be checked
t.Run("retry", func(t *testing.T) {
logger := testlog.Logger(t, log.LevelInfo)
l1F := &testutils.MockL1Source{}
defer l1F.AssertExpectations(t)
l1F.ExpectL1BlockRefByNumber(refD.Number, refD, errors.New("fake error"))
l1F.ExpectL1BlockRefByNumber(refD.Number, refD, nil) // to check finality signal
l1F.ExpectL1BlockRefByNumber(refD.Number, refD, nil) // to check what was derived from (same in this case)
emitter := &testutils.MockEmitter{}
fi := NewFinalizer(context.Background(), logger, &rollup.Config{}, l1F)
fi.AttachEmitter(emitter)
// now say C1 was included in D and became the new safe head
fi.OnEvent(engine.SafeDerivedEvent{Safe: refC1, DerivedFrom: refD})
fi.OnEvent(derive.DeriverIdleEvent{Origin: refD})
emitter.AssertExpectations(t)
// now say D0 was included in E and became the new safe head
fi.OnEvent(engine.SafeDerivedEvent{Safe: refD0, DerivedFrom: refE})
fi.OnEvent(derive.DeriverIdleEvent{Origin: refE})
emitter.AssertExpectations(t)
// let's finalize D from which we fully derived C1, but not D0
emitter.ExpectOnce(TryFinalizeEvent{})
fi.OnEvent(FinalizeL1Event{FinalizedL1: refD})
emitter.AssertExpectations(t)
// C1 was included in finalized D, but finality could not be verified yet, due to temporary test error
emitter.ExpectOnceType("L1TemporaryErrorEvent")
fi.OnEvent(TryFinalizeEvent{})
emitter.AssertExpectations(t)
// upon the next signal we should schedule a finalization re-attempt
emitter.ExpectOnce(TryFinalizeEvent{})
fi.OnEvent(derive.DeriverIdleEvent{Origin: refF})
emitter.AssertExpectations(t)
// C1 was included in finalized D, and should now be finalized, as check can succeed when revisited
emitter.ExpectOnce(engine.PromoteFinalizedEvent{Ref: refC1})
fi.OnEvent(TryFinalizeEvent{})
emitter.AssertExpectations(t)
})
// Test that finality progression can repeat a few times.
t.Run("repeat", func(t *testing.T) {
logger := testlog.Logger(t, log.LevelInfo)
l1F := &testutils.MockL1Source{}
defer l1F.AssertExpectations(t)
emitter := &testutils.MockEmitter{}
fi := NewFinalizer(context.Background(), logger, &rollup.Config{}, l1F)
fi.AttachEmitter(emitter)
fi.OnEvent(engine.SafeDerivedEvent{Safe: refC1, DerivedFrom: refD})
fi.OnEvent(derive.DeriverIdleEvent{Origin: refD})
emitter.AssertExpectations(t)
fi.OnEvent(engine.SafeDerivedEvent{Safe: refD0, DerivedFrom: refE})
fi.OnEvent(derive.DeriverIdleEvent{Origin: refE})
emitter.AssertExpectations(t)
// L1 finality signal will trigger L2 finality attempt
emitter.ExpectOnce(TryFinalizeEvent{})
fi.OnEvent(FinalizeL1Event{FinalizedL1: refD})
emitter.AssertExpectations(t)
// C1 was included in D, and should be finalized now
emitter.ExpectOnce(engine.PromoteFinalizedEvent{Ref: refC1})
l1F.ExpectL1BlockRefByNumber(refD.Number, refD, nil)
l1F.ExpectL1BlockRefByNumber(refD.Number, refD, nil)
fi.OnEvent(TryFinalizeEvent{})
emitter.AssertExpectations(t)
l1F.AssertExpectations(t)
// Another L1 finality event, trigger L2 finality attempt again
emitter.ExpectOnce(TryFinalizeEvent{})
fi.OnEvent(FinalizeL1Event{FinalizedL1: refE})
emitter.AssertExpectations(t)
// D0 was included in E, and should be finalized now
emitter.ExpectOnce(engine.PromoteFinalizedEvent{Ref: refD0})
l1F.ExpectL1BlockRefByNumber(refE.Number, refE, nil)
l1F.ExpectL1BlockRefByNumber(refE.Number, refE, nil)
fi.OnEvent(TryFinalizeEvent{})
emitter.AssertExpectations(t)
l1F.AssertExpectations(t)
// D0 is still there in the buffer, and may be finalized again, if it were not for the latest forkchoice update.
fi.OnEvent(engine.ForkchoiceUpdateEvent{FinalizedL2Head: refD0})
emitter.AssertExpectations(t) // should trigger no events
// we expect a finality attempt, since we have not idled on something yet
emitter.ExpectOnce(TryFinalizeEvent{})
fi.OnEvent(derive.DeriverIdleEvent{Origin: refG})
emitter.AssertExpectations(t)
fi.OnEvent(engine.SafeDerivedEvent{Safe: refD1, DerivedFrom: refH})
fi.OnEvent(engine.SafeDerivedEvent{Safe: refE0, DerivedFrom: refH})
fi.OnEvent(engine.SafeDerivedEvent{Safe: refE1, DerivedFrom: refH})
fi.OnEvent(engine.SafeDerivedEvent{Safe: refF0, DerivedFrom: refH})
fi.OnEvent(engine.SafeDerivedEvent{Safe: refF1, DerivedFrom: refH})
emitter.AssertExpectations(t) // above updates add data, but no attempt is made until idle or L1 signal
// We recently finalized already, and there is no new L1 finality data
fi.OnEvent(derive.DeriverIdleEvent{Origin: refH})
emitter.AssertExpectations(t)
// D1-F1 were included in L1 blocks that have not been finalized yet.
// D0 is known to be finalized already.
fi.OnEvent(TryFinalizeEvent{})
emitter.AssertExpectations(t)
// Now L1 block H is actually finalized, and we can proceed with another attempt
emitter.ExpectOnce(TryFinalizeEvent{})
fi.OnEvent(FinalizeL1Event{FinalizedL1: refH})
emitter.AssertExpectations(t)
// F1 should be finalized now, since it was included in H
emitter.ExpectOnce(engine.PromoteFinalizedEvent{Ref: refF1})
l1F.ExpectL1BlockRefByNumber(refH.Number, refH, nil)
l1F.ExpectL1BlockRefByNumber(refH.Number, refH, nil)
fi.OnEvent(TryFinalizeEvent{})
emitter.AssertExpectations(t)
l1F.AssertExpectations(t)
})
// In this test the finality signal is for a block more than
// 1 L1 block later than what the L2 data was included in.
t.Run("older-data", func(t *testing.T) {
logger := testlog.Logger(t, log.LevelInfo)
l1F := &testutils.MockL1Source{}
defer l1F.AssertExpectations(t)
l1F.ExpectL1BlockRefByNumber(refD.Number, refD, nil) // check the signal
l1F.ExpectL1BlockRefByNumber(refC.Number, refC, nil) // check what we derived the L2 block from
emitter := &testutils.MockEmitter{}
fi := NewFinalizer(context.Background(), logger, &rollup.Config{}, l1F)
fi.AttachEmitter(emitter)
// now say B1 was included in C and became the new safe head
fi.OnEvent(engine.SafeDerivedEvent{Safe: refB1, DerivedFrom: refC})
fi.OnEvent(derive.DeriverIdleEvent{Origin: refC})
emitter.AssertExpectations(t)
// now say C0 was included in E and became the new safe head
fi.OnEvent(engine.SafeDerivedEvent{Safe: refC0, DerivedFrom: refE})
fi.OnEvent(derive.DeriverIdleEvent{Origin: refE})
emitter.AssertExpectations(t)
// let's finalize D, from which we fully derived B1, but not C0 (referenced L1 origin in L2 block != inclusion of L2 block in L1 chain)
emitter.ExpectOnce(TryFinalizeEvent{})
fi.OnEvent(FinalizeL1Event{FinalizedL1: refD})
emitter.AssertExpectations(t)
// B1 was included in finalized D, and should now be finalized
emitter.ExpectOnce(engine.PromoteFinalizedEvent{Ref: refB1})
fi.OnEvent(TryFinalizeEvent{})
emitter.AssertExpectations(t)
})
// Test that reorg race condition is handled.
t.Run("reorg-safe", func(t *testing.T) {
logger := testlog.Logger(t, log.LevelInfo)
l1F := &testutils.MockL1Source{}
defer l1F.AssertExpectations(t)
l1F.ExpectL1BlockRefByNumber(refF.Number, refF, nil) // check signal
l1F.ExpectL1BlockRefByNumber(refD.Number, refD, nil) // shows reorg to Finalize attempt
l1F.ExpectL1BlockRefByNumber(refF.Number, refF, nil) // check signal
l1F.ExpectL1BlockRefByNumber(refD.Number, refD, nil) // shows reorg to OnDerivationL1End attempt
l1F.ExpectL1BlockRefByNumber(refF.Number, refF, nil) // check signal
l1F.ExpectL1BlockRefByNumber(refE.Number, refE, nil) // post-reorg
emitter := &testutils.MockEmitter{}
fi := NewFinalizer(context.Background(), logger, &rollup.Config{}, l1F)
fi.AttachEmitter(emitter)
// now say B1 was included in C and became the new safe head
fi.OnEvent(engine.SafeDerivedEvent{Safe: refB1, DerivedFrom: refC})
fi.OnEvent(derive.DeriverIdleEvent{Origin: refC})
emitter.AssertExpectations(t)
// temporary fork of the L1, and derived safe L2 blocks from.
refC0Alt := eth.L2BlockRef{
Hash: testutils.RandomHash(rng),
Number: refB1.Number + 1,
ParentHash: refB1.Hash,
Time: refB1.Time + cfg.BlockTime,
L1Origin: refC.ID(),
SequenceNumber: 0,
}
refC1Alt := eth.L2BlockRef{
Hash: testutils.RandomHash(rng),
Number: refC0Alt.Number + 1,
ParentHash: refC0Alt.Hash,
Time: refC0Alt.Time + cfg.BlockTime,
L1Origin: refC.ID(),
SequenceNumber: 1,
}
refDAlt := eth.L1BlockRef{
Hash: testutils.RandomHash(rng),
Number: refC.Number + 1,
ParentHash: refC.Hash,
Time: refC.Time + l1Time,
}
fi.OnEvent(engine.SafeDerivedEvent{Safe: refC0Alt, DerivedFrom: refDAlt})
fi.OnEvent(engine.SafeDerivedEvent{Safe: refC1Alt, DerivedFrom: refDAlt})
// We get an early finality signal for F, of the chain that did not include refC0Alt and refC1Alt,
// as L1 block F does not build on DAlt.
// The finality signal was for a new chain, while derivation is on an old stale chain.
// It should be detected that C0Alt and C1Alt cannot actually be finalized,
// even though they are older than the latest finality signal.
emitter.ExpectOnce(TryFinalizeEvent{})
fi.OnEvent(FinalizeL1Event{FinalizedL1: refF})
emitter.AssertExpectations(t)
// cannot verify refC0Alt and refC1Alt, and refB1 is older and not checked
emitter.ExpectOnceType("ResetEvent")
fi.OnEvent(TryFinalizeEvent{})
emitter.AssertExpectations(t) // no change in finality
// And process DAlt, still stuck on old chain.
emitter.ExpectOnce(TryFinalizeEvent{})
fi.OnEvent(derive.DeriverIdleEvent{Origin: refDAlt})
emitter.AssertExpectations(t)
// no new finalized L2 blocks after early finality signal with stale chain
emitter.ExpectOnceType("ResetEvent")
fi.OnEvent(TryFinalizeEvent{})
emitter.AssertExpectations(t)
// Now reset, because of the reset error
fi.OnEvent(rollup.ResetEvent{})
require.Equal(t, refF, fi.FinalizedL1(), "remember the new finality signal for later however")
// And process the canonical chain, with empty block D (no post-processing of canonical C0 blocks yet)
emitter.ExpectOnce(TryFinalizeEvent{})
fi.OnEvent(derive.DeriverIdleEvent{Origin: refD})
emitter.AssertExpectations(t)
fi.OnEvent(TryFinalizeEvent{})
emitter.AssertExpectations(t) // no new finality
// Include C0 in E
fi.OnEvent(engine.SafeDerivedEvent{Safe: refC0, DerivedFrom: refE})
fi.OnEvent(derive.DeriverIdleEvent{Origin: refE})
// Due to the "finalityDelay" we don't repeat finality checks shortly after one another,
// and don't expect a finality attempt.
emitter.AssertExpectations(t)
// if we reset the attempt, then we can finalize however.
fi.triedFinalizeAt = 0
emitter.ExpectOnce(TryFinalizeEvent{})
fi.OnEvent(derive.DeriverIdleEvent{Origin: refE})
emitter.AssertExpectations(t)
emitter.ExpectOnce(engine.PromoteFinalizedEvent{Ref: refC0})
fi.OnEvent(TryFinalizeEvent{})
emitter.AssertExpectations(t)
})
}