db_test.go 44.5 KB
Newer Older
1 2 3
package logs

import (
4
	"encoding/binary"
5 6 7 8 9
	"io/fs"
	"os"
	"path/filepath"
	"testing"

10 11 12 13 14 15
	"github.com/stretchr/testify/require"

	"github.com/ethereum/go-ethereum/common"
	"github.com/ethereum/go-ethereum/crypto"
	"github.com/ethereum/go-ethereum/log"

16 17 18
	"github.com/ethereum-optimism/optimism/op-service/eth"
	"github.com/ethereum-optimism/optimism/op-service/testlog"
	"github.com/ethereum-optimism/optimism/op-supervisor/supervisor/backend/db/entrydb"
19
	"github.com/ethereum-optimism/optimism/op-supervisor/supervisor/types"
20 21 22
)

func createHash(i int) common.Hash {
23 24 25 26 27 28 29
	if i == -1 { // parent-hash of genesis is zero
		return common.Hash{}
	}
	var data [9]byte
	data[0] = 0xff
	binary.BigEndian.PutUint64(data[1:], uint64(i))
	return crypto.Keccak256Hash(data[:])
30 31 32 33
}

func TestErrorOpeningDatabase(t *testing.T) {
	dir := t.TempDir()
34
	_, err := NewFromFile(testlog.Logger(t, log.LvlInfo), &stubMetrics{}, filepath.Join(dir, "missing-dir", "file.db"), false)
35 36 37 38 39
	require.ErrorIs(t, err, os.ErrNotExist)
}

func runDBTest(t *testing.T, setup func(t *testing.T, db *DB, m *stubMetrics), assert func(t *testing.T, db *DB, m *stubMetrics)) {
	createDb := func(t *testing.T, dir string) (*DB, *stubMetrics, string) {
40
		logger := testlog.Logger(t, log.LvlTrace)
41 42
		path := filepath.Join(dir, "test.db")
		m := &stubMetrics{}
43
		db, err := NewFromFile(logger, m, path, false)
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
		require.NoError(t, err, "Failed to create database")
		t.Cleanup(func() {
			err := db.Close()
			if err != nil {
				require.ErrorIs(t, err, fs.ErrClosed)
			}
		})
		return db, m, path
	}

	t.Run("New", func(t *testing.T) {
		db, m, _ := createDb(t, t.TempDir())
		setup(t, db, m)
		assert(t, db, m)
	})

	t.Run("Existing", func(t *testing.T) {
		dir := t.TempDir()
		db, m, path := createDb(t, dir)
		setup(t, db, m)
		// Close and recreate the database
		require.NoError(t, db.Close())
		checkDBInvariants(t, path, m)

		db2, m, path := createDb(t, dir)
		assert(t, db2, m)
		checkDBInvariants(t, path, m)
	})
}

func TestEmptyDbDoesNotFindEntry(t *testing.T) {
	runDBTest(t,
		func(t *testing.T, db *DB, m *stubMetrics) {},
		func(t *testing.T, db *DB, m *stubMetrics) {
78 79
			requireFuture(t, db, 1, 0, createHash(1))
			requireFuture(t, db, 1, 0, common.Hash{})
80 81 82
		})
}

83 84 85 86 87 88 89 90 91
func TestLatestSealedBlockNum(t *testing.T) {
	t.Run("Empty case", func(t *testing.T) {
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {},
			func(t *testing.T, db *DB, m *stubMetrics) {
				n, ok := db.LatestSealedBlockNum()
				require.False(t, ok, "empty db expected")
				require.Zero(t, n)
				idx, err := db.searchCheckpoint(0, 0)
92
				require.ErrorIs(t, err, entrydb.ErrFuture, "no checkpoint in empty db")
93
				require.ErrorIs(t, err, entrydb.ErrFuture, "no checkpoint in empty db")
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
				require.Zero(t, idx)
			})
	})
	t.Run("Zero case", func(t *testing.T) {
		genesis := eth.BlockID{Hash: createHash(0), Number: 0}
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
				require.NoError(t, db.SealBlock(common.Hash{}, genesis, 5000), "seal genesis")
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
				n, ok := db.LatestSealedBlockNum()
				require.True(t, ok, "genesis block expected")
				require.Equal(t, genesis.Number, n)
				idx, err := db.searchCheckpoint(0, 0)
				require.NoError(t, err)
				require.Zero(t, idx, "genesis block as checkpoint 0")
			})
	})
	t.Run("Later genesis case", func(t *testing.T) {
		genesis := eth.BlockID{Hash: createHash(10), Number: 10}
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
				require.NoError(t, db.SealBlock(common.Hash{}, genesis, 5000), "seal genesis")
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
				n, ok := db.LatestSealedBlockNum()
				require.True(t, ok, "genesis block expected")
				require.Equal(t, genesis.Number, n)
				idx, err := db.searchCheckpoint(genesis.Number, 0)
				require.NoError(t, err)
				require.Zero(t, idx, "anchor block as checkpoint 0")
				_, err = db.searchCheckpoint(0, 0)
126
				require.ErrorIs(t, err, entrydb.ErrSkipped, "no checkpoint before genesis")
127
				require.ErrorIs(t, err, entrydb.ErrSkipped, "no checkpoint before genesis")
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
			})
	})
	t.Run("Block 1 case", func(t *testing.T) {
		genesis := eth.BlockID{Hash: createHash(0), Number: 0}
		block1 := eth.BlockID{Hash: createHash(1), Number: 1}
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
				require.NoError(t, db.SealBlock(common.Hash{}, genesis, 5000), "seal genesis")
				require.NoError(t, db.SealBlock(genesis.Hash, block1, 5001), "seal block 1")
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
				n, ok := db.LatestSealedBlockNum()
				require.True(t, ok, "block 1 expected")
				require.Equal(t, block1.Number, n)
				idx, err := db.searchCheckpoint(block1.Number, 0)
				require.NoError(t, err)
				require.Equal(t, entrydb.EntryIdx(0), idx, "checkpoint 0 still for block 1")
			})
	})
	t.Run("Using checkpoint case", func(t *testing.T) {
		genesis := eth.BlockID{Hash: createHash(0), Number: 0}
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
				require.NoError(t, db.SealBlock(common.Hash{}, genesis, 5000), "seal genesis")
				for i := 1; i <= 260; i++ {
					id := eth.BlockID{Hash: createHash(i), Number: uint64(i)}
					require.NoError(t, db.SealBlock(createHash(i-1), id, 5001), "seal block %d", i)
				}
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
				n, ok := db.LatestSealedBlockNum()
				require.True(t, ok, "latest block expected")
				expected := uint64(260)
				require.Equal(t, expected, n)
				idx, err := db.searchCheckpoint(expected, 0)
				require.NoError(t, err)
				// It costs 2 entries per block, so if we add more than 1 checkpoint worth of blocks,
				// then we get to checkpoint 2
				require.Equal(t, entrydb.EntryIdx(searchCheckpointFrequency*2), idx, "checkpoint 1 reached")
			})
	})
}

171 172 173 174 175 176
func TestAddLog(t *testing.T) {
	t.Run("BlockZero", func(t *testing.T) {
		// There are no logs in the genesis block so recording an entry for block 0 should be rejected.
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {},
			func(t *testing.T, db *DB, m *stubMetrics) {
177
				genesis := eth.BlockID{Hash: createHash(15), Number: 0}
178
				err := db.AddLog(createHash(1), genesis, 0, nil)
179
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder)
180
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder)
181 182 183
			})
	})

184
	t.Run("FirstEntries", func(t *testing.T) {
185 186
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
187 188
				genesis := eth.BlockID{Hash: createHash(15), Number: 15}
				require.NoError(t, db.SealBlock(common.Hash{}, genesis, 5000), "seal genesis")
189
				err := db.AddLog(createHash(1), genesis, 0, nil)
190 191
				require.NoError(t, err, "first log after genesis")
				require.NoError(t, db.SealBlock(genesis.Hash, eth.BlockID{Hash: createHash(16), Number: 16}, 5001))
192 193
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
194
				requireContains(t, db, 16, 0, createHash(1))
195 196 197 198 199 200
			})
	})

	t.Run("MultipleEntriesFromSameBlock", func(t *testing.T) {
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
201 202 203 204 205 206 207
				// create 15 empty blocks
				for i := 0; i <= 15; i++ {
					bl := eth.BlockID{Hash: createHash(i), Number: uint64(i)}
					require.NoError(t, db.SealBlock(createHash(i-1), bl, 5000+uint64(i)), "seal blocks")
				}
				// Now apply 3 logs on top of that, contents for block 16
				bl15 := eth.BlockID{Hash: createHash(15), Number: 15}
208
				err := db.AddLog(createHash(1), bl15, 0, nil)
209
				require.NoError(t, err)
210
				err = db.AddLog(createHash(2), bl15, 1, nil)
211
				require.NoError(t, err)
212
				err = db.AddLog(createHash(3), bl15, 2, nil)
213
				require.NoError(t, err)
214 215 216
				// Now seal block 16
				bl16 := eth.BlockID{Hash: createHash(16), Number: 16}
				err = db.SealBlock(bl15.Hash, bl16, 5016)
217 218 219
				require.NoError(t, err)
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
220 221 222 223
				require.EqualValues(t, 16*2+3+2, m.entryCount, "empty blocks have logs")
				requireContains(t, db, 16, 0, createHash(1))
				requireContains(t, db, 16, 1, createHash(2))
				requireContains(t, db, 16, 2, createHash(3))
224 225 226 227 228 229
			})
	})

	t.Run("MultipleEntriesFromMultipleBlocks", func(t *testing.T) {
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
230 231
				bl14 := eth.BlockID{Hash: createHash(14), Number: 14}
				err := db.SealBlock(createHash(13), bl14, 5000)
232
				require.NoError(t, err)
233 234
				bl15 := eth.BlockID{Hash: createHash(15), Number: 15}
				err = db.SealBlock(createHash(14), bl15, 5001)
235
				require.NoError(t, err)
236
				err = db.AddLog(createHash(1), bl15, 0, nil)
237
				require.NoError(t, err)
238
				err = db.AddLog(createHash(2), bl15, 1, nil)
239 240 241 242
				require.NoError(t, err)
				bl16 := eth.BlockID{Hash: createHash(16), Number: 16}
				err = db.SealBlock(bl15.Hash, bl16, 5003)
				require.NoError(t, err)
243
				err = db.AddLog(createHash(3), bl16, 0, nil)
244
				require.NoError(t, err)
245
				err = db.AddLog(createHash(4), bl16, 1, nil)
246 247 248
				require.NoError(t, err)
				bl17 := eth.BlockID{Hash: createHash(17), Number: 17}
				err = db.SealBlock(bl16.Hash, bl17, 5003)
249 250 251
				require.NoError(t, err)
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
252 253 254 255 256
				require.EqualValues(t, 2+2+1+1+2+1+1+2, m.entryCount, "should not output new searchCheckpoint for every block")
				requireContains(t, db, 16, 0, createHash(1))
				requireContains(t, db, 16, 1, createHash(2))
				requireContains(t, db, 17, 0, createHash(3))
				requireContains(t, db, 17, 1, createHash(4))
257 258 259 260 261 262
			})
	})

	t.Run("ErrorWhenBeforeCurrentBlock", func(t *testing.T) {
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
263 264
				bl15 := eth.BlockID{Hash: createHash(15), Number: 15}
				err := db.SealBlock(common.Hash{}, bl15, 5001)
265 266 267
				require.NoError(t, err)
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
268 269
				bl14 := eth.BlockID{Hash: createHash(14), Number: 14}
				err := db.SealBlock(createHash(13), bl14, 5000)
270
				require.ErrorIs(t, err, entrydb.ErrConflict)
271
				require.ErrorIs(t, err, entrydb.ErrConflict)
272 273 274 275 276 277
			})
	})

	t.Run("ErrorWhenBeforeCurrentBlockButAfterLastCheckpoint", func(t *testing.T) {
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
278
				err := db.lastEntryContext.forceBlock(eth.BlockID{Hash: createHash(13), Number: 13}, 5000)
279
				require.NoError(t, err)
280 281 282
				err = db.SealBlock(createHash(13), eth.BlockID{Hash: createHash(14), Number: 14}, 5001)
				require.NoError(t, err)
				err = db.SealBlock(createHash(14), eth.BlockID{Hash: createHash(15), Number: 15}, 5002)
283 284 285
				require.NoError(t, err)
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
286
				onto := eth.BlockID{Hash: createHash(14), Number: 14}
287
				err := db.AddLog(createHash(1), onto, 0, nil)
288
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder, "cannot build logs on 14 when 15 is already sealed")
289
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder, "cannot build logs on 14 when 15 is already sealed")
290 291 292 293 294 295
			})
	})

	t.Run("ErrorWhenBeforeCurrentLogEvent", func(t *testing.T) {
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
296 297 298
				bl15 := eth.BlockID{Hash: createHash(15), Number: 15}
				err := db.lastEntryContext.forceBlock(bl15, 5000)
				require.NoError(t, err)
299 300
				require.NoError(t, db.AddLog(createHash(1), bl15, 0, nil))
				require.NoError(t, db.AddLog(createHash(1), bl15, 1, nil))
301 302
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
303
				bl15 := eth.BlockID{Hash: createHash(15), Number: 15}
304
				err := db.AddLog(createHash(1), bl15, 0, nil)
305
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder, "already at log index 2")
306
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder, "already at log index 2")
307 308 309
			})
	})

310
	t.Run("ErrorWhenBeforeBlockSeal", func(t *testing.T) {
311 312
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
313 314
				bl15 := eth.BlockID{Hash: createHash(15), Number: 15}
				err := db.lastEntryContext.forceBlock(bl15, 5000)
315
				require.NoError(t, err)
316 317
				require.NoError(t, db.AddLog(createHash(1), bl15, 0, nil))
				require.NoError(t, db.AddLog(createHash(1), bl15, 1, nil))
318 319
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
320
				err := db.AddLog(createHash(1), eth.BlockID{Hash: createHash(16), Number: 16}, 0, nil)
321
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder)
322
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder)
323 324 325 326 327 328
			})
	})

	t.Run("ErrorWhenAtCurrentLogEvent", func(t *testing.T) {
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
329 330 331
				bl15 := eth.BlockID{Hash: createHash(15), Number: 15}
				err := db.lastEntryContext.forceBlock(bl15, 5000)
				require.NoError(t, err)
332 333
				require.NoError(t, db.AddLog(createHash(1), bl15, 0, nil))
				require.NoError(t, db.AddLog(createHash(1), bl15, 1, nil))
334 335
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
336
				bl15 := eth.BlockID{Hash: createHash(15), Number: 15}
337
				err := db.AddLog(createHash(1), bl15, 1, nil)
338
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder, "already at log index 2")
339
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder, "already at log index 2")
340 341 342 343 344 345
			})
	})

	t.Run("ErrorWhenAtCurrentLogEventButAfterLastCheckpoint", func(t *testing.T) {
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
346 347 348
				bl15 := eth.BlockID{Hash: createHash(15), Number: 15}
				err := db.lastEntryContext.forceBlock(bl15, 5000)
				require.NoError(t, err)
349 350
				require.NoError(t, db.AddLog(createHash(1), bl15, 0, nil))
				require.NoError(t, db.AddLog(createHash(1), bl15, 1, nil))
351 352
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
353
				bl15 := eth.BlockID{Hash: createHash(16), Number: 16}
354
				err := db.AddLog(createHash(1), bl15, 2, nil)
355
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder)
356
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder)
357 358 359 360 361 362
			})
	})

	t.Run("ErrorWhenSkippingLogEvent", func(t *testing.T) {
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
363 364
				bl15 := eth.BlockID{Hash: createHash(15), Number: 15}
				err := db.lastEntryContext.forceBlock(bl15, 5000)
365
				require.NoError(t, err)
366
				require.NoError(t, db.AddLog(createHash(1), bl15, 0, nil))
367 368
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
369
				bl15 := eth.BlockID{Hash: createHash(15), Number: 15}
370
				err := db.AddLog(createHash(1), bl15, 2, nil)
371
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder)
372
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder)
373 374 375 376
			})
	})

	t.Run("ErrorWhenFirstLogIsNotLogIdxZero", func(t *testing.T) {
377 378 379 380 381
		runDBTest(t, func(t *testing.T, db *DB, m *stubMetrics) {
			bl15 := eth.BlockID{Hash: createHash(15), Number: 15}
			err := db.lastEntryContext.forceBlock(bl15, 5000)
			require.NoError(t, err)
		},
382
			func(t *testing.T, db *DB, m *stubMetrics) {
383
				bl15 := eth.BlockID{Hash: createHash(15), Number: 15}
384
				err := db.AddLog(createHash(1), bl15, 5, nil)
385
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder)
386
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder)
387 388 389 390 391 392
			})
	})

	t.Run("ErrorWhenFirstLogOfNewBlockIsNotLogIdxZero", func(t *testing.T) {
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
393 394 395
				bl15 := eth.BlockID{Hash: createHash(15), Number: 15}
				err := db.lastEntryContext.forceBlock(bl15, 5000)
				require.NoError(t, err)
396
				err = db.AddLog(createHash(1), bl15, 0, nil)
397
				require.NoError(t, err)
398 399
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
400
				bl15 := eth.BlockID{Hash: createHash(15), Number: 15}
401
				err := db.AddLog(createHash(1), bl15, 1, nil)
402 403 404 405
				require.NoError(t, err)
				bl16 := eth.BlockID{Hash: createHash(16), Number: 16}
				err = db.SealBlock(bl15.Hash, bl16, 5001)
				require.NoError(t, err)
406
				err = db.AddLog(createHash(1), bl16, 1, nil)
407
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder)
408
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder)
409 410 411 412
			})
	})

	t.Run("MultipleSearchCheckpoints", func(t *testing.T) {
413
		block0 := eth.BlockID{Hash: createHash(10), Number: 10}
414 415
		block1 := eth.BlockID{Hash: createHash(11), Number: 11}
		block2 := eth.BlockID{Hash: createHash(12), Number: 12}
416 417 418 419 420
		block3 := eth.BlockID{Hash: createHash(13), Number: 13}
		block4 := eth.BlockID{Hash: createHash(14), Number: 14}
		// Ignoring seal-checkpoints in checkpoint counting comments here;
		// First search-checkpoint is at entry idx 0
		// Block 1 logs don't reach the second search-checkpoint
421
		block1LogCount := searchCheckpointFrequency - 10
422 423 424 425
		// Block 2 logs extend to just after the third search-checkpoint
		block2LogCount := searchCheckpointFrequency + 16
		// Block 3 logs extend to immediately before the fourth search-checkpoint
		block3LogCount := searchCheckpointFrequency - 19
426 427 428
		block4LogCount := 2
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
429 430 431 432 433 434 435
				// force in block 0
				require.NoError(t, db.lastEntryContext.forceBlock(block0, 3000))
				expectedIndex := entrydb.EntryIdx(2)
				t.Logf("block 0 complete, at entry %d", db.lastEntryContext.NextIndex())
				require.Equal(t, expectedIndex, db.lastEntryContext.NextIndex())
				{ // create block 1
					for i := 0; i < block1LogCount; i++ {
436
						err := db.AddLog(createHash(i), block0, uint32(i), nil)
437 438 439 440
						require.NoError(t, err)
					}
					err := db.SealBlock(block0.Hash, block1, 3001) // second seal-checkpoint
					require.NoError(t, err)
441
				}
442 443 444 445 446 447
				expectedIndex += entrydb.EntryIdx(block1LogCount) + 2
				t.Logf("block 1 complete, at entry %d", db.lastEntryContext.NextIndex())
				require.Equal(t, expectedIndex, db.lastEntryContext.NextIndex(), "added logs and a seal checkpoint")
				{ // create block 2
					for i := 0; i < block2LogCount; i++ {
						// two of these imply a search checkpoint, the second and third search-checkpoint
448
						err := db.AddLog(createHash(i), block1, uint32(i), nil)
449 450 451 452
						require.NoError(t, err)
					}
					err := db.SealBlock(block1.Hash, block2, 3002) // third seal-checkpoint
					require.NoError(t, err)
453
				}
454 455 456 457 458
				expectedIndex += entrydb.EntryIdx(block2LogCount) + 2 + 2 + 2
				t.Logf("block 2 complete, at entry %d", db.lastEntryContext.NextIndex())
				require.Equal(t, expectedIndex, db.lastEntryContext.NextIndex(), "added logs, two search checkpoints, and a seal checkpoint")
				{ // create block 3
					for i := 0; i < block3LogCount; i++ {
459
						err := db.AddLog(createHash(i), block2, uint32(i), nil)
460 461 462 463
						require.NoError(t, err)
					}
					err := db.SealBlock(block2.Hash, block3, 3003)
					require.NoError(t, err)
464
				}
465 466 467 468 469
				expectedIndex += entrydb.EntryIdx(block3LogCount) + 2
				t.Logf("block 3 complete, at entry %d", db.lastEntryContext.NextIndex())
				require.Equal(t, expectedIndex, db.lastEntryContext.NextIndex(), "added logs, and a seal checkpoint")

				// Verify that we're right before the fourth search-checkpoint will be written.
470 471
				// entryCount is the number of entries, so given 0 based indexing is the index of the next entry
				// the first checkpoint is at entry 0, the second at entry searchCheckpointFrequency etc
472 473 474 475 476
				// so the fourth is at entry 3*searchCheckpointFrequency.
				require.EqualValues(t, 3*searchCheckpointFrequency-1, m.entryCount)
				{ // create block 4
					for i := 0; i < block4LogCount; i++ {
						// includes a fourth search checkpoint
477
						err := db.AddLog(createHash(i), block3, uint32(i), nil)
478 479 480 481
						require.NoError(t, err)
					}
					err := db.SealBlock(block3.Hash, block4, 3003) // fourth seal checkpoint
					require.NoError(t, err)
482
				}
483 484 485
				expectedIndex += entrydb.EntryIdx(block4LogCount) + 2 + 2
				require.Equal(t, expectedIndex, db.lastEntryContext.NextIndex(), "added logs, a search checkpoint, and a seal checkpoint")
				t.Logf("block 4 complete, at entry %d", db.lastEntryContext.NextIndex())
486 487
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
488 489
				// Check that we wrote additional search checkpoints and seal checkpoints
				expectedCheckpointCount := 4 + 4
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
				expectedEntryCount := block1LogCount + block2LogCount + block3LogCount + block4LogCount + (2 * expectedCheckpointCount)
				require.EqualValues(t, expectedEntryCount, m.entryCount)
				// Check we can find all the logs.
				for i := 0; i < block1LogCount; i++ {
					requireContains(t, db, block1.Number, uint32(i), createHash(i))
				}
				// Block 2 logs extend to just after the third checkpoint
				for i := 0; i < block2LogCount; i++ {
					requireContains(t, db, block2.Number, uint32(i), createHash(i))
				}
				// Block 3 logs extend to immediately before the fourth checkpoint
				for i := 0; i < block3LogCount; i++ {
					requireContains(t, db, block3.Number, uint32(i), createHash(i))
				}
				// Block 4 logs start immediately after the fourth checkpoint
				for i := 0; i < block4LogCount; i++ {
					requireContains(t, db, block4.Number, uint32(i), createHash(i))
				}
			})
	})
}

func TestAddDependentLog(t *testing.T) {
	execMsg := types.ExecutingMessage{
		Chain:     3,
		BlockNum:  42894,
		LogIdx:    42,
		Timestamp: 8742482,
518
		Hash:      createHash(8844),
519 520 521 522
	}
	t.Run("FirstEntry", func(t *testing.T) {
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
523 524
				bl15 := eth.BlockID{Hash: createHash(15), Number: 15}
				require.NoError(t, db.lastEntryContext.forceBlock(bl15, 5000))
525
				err := db.AddLog(createHash(1), bl15, 0, &execMsg)
526 527 528
				require.NoError(t, err)
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
529
				requireContains(t, db, 16, 0, createHash(1), execMsg)
530 531 532
			})
	})

533
	t.Run("BlockSealSearchCheckpointOverlap", func(t *testing.T) {
534 535
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
536 537
				bl15 := eth.BlockID{Hash: createHash(15), Number: 15}
				require.NoError(t, db.lastEntryContext.forceBlock(bl15, 5000))
538
				for i := uint32(0); m.entryCount < searchCheckpointFrequency-1; i++ {
539
					require.NoError(t, db.AddLog(createHash(9), bl15, i, nil))
540
				}
541 542 543 544
				bl16 := eth.BlockID{Hash: createHash(16), Number: 16}
				require.NoError(t, db.SealBlock(bl15.Hash, bl16, 5001))
				// added 3 entries: seal-checkpoint, then a search-checkpoint, then the canonical hash
				require.Equal(t, m.entryCount, int64(searchCheckpointFrequency+2))
545
				err := db.AddLog(createHash(1), bl16, 0, &execMsg)
546 547 548
				require.NoError(t, err)
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
549 550
				requireContains(t, db, 16, 0, createHash(9))
				requireContains(t, db, 17, 0, createHash(1), execMsg)
551 552 553
			})
	})

554
	t.Run("AvoidCheckpointOverlapWithExecutingCheck", func(t *testing.T) {
555 556
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
557 558 559 560
				bl15 := eth.BlockID{Hash: createHash(15), Number: 15}
				require.NoError(t, db.lastEntryContext.forceBlock(bl15, 5000))
				// we add 256 - 2 (start) - 2 (init msg, exec link) = 252 entries
				for i := uint32(0); i < 252; i++ {
561
					require.NoError(t, db.AddLog(createHash(9), bl15, i, nil))
562
				}
563
				// add an executing message
564
				err := db.AddLog(createHash(1), bl15, 252, &execMsg)
565
				require.NoError(t, err)
566 567 568 569 570 571 572 573 574 575 576
				// 0,1: start
				// 2..252+2: initiating logs without exec message
				// 254 = inferred padding - 3 entries for exec msg would overlap with checkpoint
				// 255 = inferred padding
				// 256 = search checkpoint - what would be the exec check without padding
				// 257 = canonical hash
				// 258 = initiating message
				// 259 = executing message link
				// 260 = executing message check
				require.Equal(t, int64(261), m.entryCount)
				db.debugTip()
577 578
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
579 580
				requireContains(t, db, 16, 251, createHash(9))
				requireContains(t, db, 16, 252, createHash(1), execMsg)
581 582 583
			})
	})

584
	t.Run("AvoidCheckpointOverlapWithExecutingLink", func(t *testing.T) {
585 586
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
587 588 589 590
				bl15 := eth.BlockID{Hash: createHash(15), Number: 15}
				require.NoError(t, db.lastEntryContext.forceBlock(bl15, 5000))
				// we add 256 - 2 (start) - 1 (init msg) = 253 entries
				for i := uint32(0); i < 253; i++ {
591
					require.NoError(t, db.AddLog(createHash(9), bl15, i, nil))
592
				}
593
				// add an executing message
594
				err := db.AddLog(createHash(1), bl15, 253, &execMsg)
595
				require.NoError(t, err)
596 597 598 599 600 601 602 603 604 605
				// 0,1: start
				// 2..253+2: initiating logs without exec message
				// 255 = inferred padding - 3 entries for exec msg would overlap with checkpoint
				// 256 = search checkpoint - what would be the exec link without padding
				// 257 = canonical hash
				// 258 = initiating message
				// 259 = executing message link
				// 260 = executing message check
				db.debugTip()
				require.Equal(t, int64(261), m.entryCount)
606 607
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
608 609
				requireContains(t, db, 16, 252, createHash(9))
				requireContains(t, db, 16, 253, createHash(1), execMsg)
610 611 612 613 614 615 616
			})
	})
}

func TestContains(t *testing.T) {
	runDBTest(t,
		func(t *testing.T, db *DB, m *stubMetrics) {
617 618
			bl50 := eth.BlockID{Hash: createHash(50), Number: 50}
			require.NoError(t, db.lastEntryContext.forceBlock(bl50, 5000))
619 620 621
			require.NoError(t, db.AddLog(createHash(1), bl50, 0, nil))
			require.NoError(t, db.AddLog(createHash(3), bl50, 1, nil))
			require.NoError(t, db.AddLog(createHash(2), bl50, 2, nil))
622 623 624 625
			bl51 := eth.BlockID{Hash: createHash(51), Number: 51}
			require.NoError(t, db.SealBlock(bl50.Hash, bl51, 5001))
			bl52 := eth.BlockID{Hash: createHash(52), Number: 52}
			require.NoError(t, db.SealBlock(bl51.Hash, bl52, 5001))
626 627
			require.NoError(t, db.AddLog(createHash(1), bl52, 0, nil))
			require.NoError(t, db.AddLog(createHash(3), bl52, 1, nil))
628 629 630
		},
		func(t *testing.T, db *DB, m *stubMetrics) {
			// Should find added logs
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
			requireContains(t, db, 51, 0, createHash(1))
			requireContains(t, db, 51, 1, createHash(3))
			requireContains(t, db, 51, 2, createHash(2))
			requireContains(t, db, 53, 0, createHash(1))
			requireContains(t, db, 53, 1, createHash(3))

			// 52 was sealed as empty
			requireConflicts(t, db, 52, 0, createHash(1))

			// 53 only contained 2 logs, not 3, and is not sealed yet
			requireFuture(t, db, 53, 2, createHash(3))
			// 54 doesn't exist yet
			requireFuture(t, db, 54, 0, createHash(3))

			// 51 only contained 3 logs, not 4
			requireConflicts(t, db, 51, 3, createHash(2))
647 648 649 650 651 652 653 654 655
		})
}

func TestExecutes(t *testing.T) {
	execMsg1 := types.ExecutingMessage{
		Chain:     33,
		BlockNum:  22,
		LogIdx:    99,
		Timestamp: 948294,
656
		Hash:      createHash(332299),
657 658 659 660 661 662
	}
	execMsg2 := types.ExecutingMessage{
		Chain:     44,
		BlockNum:  55,
		LogIdx:    66,
		Timestamp: 77777,
663
		Hash:      createHash(445566),
664 665 666 667 668 669
	}
	execMsg3 := types.ExecutingMessage{
		Chain:     77,
		BlockNum:  88,
		LogIdx:    89,
		Timestamp: 6578567,
670
		Hash:      createHash(778889),
671 672 673
	}
	runDBTest(t,
		func(t *testing.T, db *DB, m *stubMetrics) {
674 675
			bl50 := eth.BlockID{Hash: createHash(50), Number: 50}
			require.NoError(t, db.lastEntryContext.forceBlock(bl50, 500))
676 677 678
			require.NoError(t, db.AddLog(createHash(1), bl50, 0, nil))
			require.NoError(t, db.AddLog(createHash(3), bl50, 1, &execMsg1))
			require.NoError(t, db.AddLog(createHash(2), bl50, 2, nil))
679 680 681 682
			bl51 := eth.BlockID{Hash: createHash(51), Number: 51}
			require.NoError(t, db.SealBlock(bl50.Hash, bl51, 5001))
			bl52 := eth.BlockID{Hash: createHash(52), Number: 52}
			require.NoError(t, db.SealBlock(bl51.Hash, bl52, 5001))
683 684
			require.NoError(t, db.AddLog(createHash(1), bl52, 0, &execMsg2))
			require.NoError(t, db.AddLog(createHash(3), bl52, 1, &execMsg3))
685 686 687
		},
		func(t *testing.T, db *DB, m *stubMetrics) {
			// Should find added logs
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703
			requireExecutingMessage(t, db, 51, 0, types.ExecutingMessage{})
			requireExecutingMessage(t, db, 51, 1, execMsg1)
			requireExecutingMessage(t, db, 51, 2, types.ExecutingMessage{})
			requireExecutingMessage(t, db, 53, 0, execMsg2)
			requireExecutingMessage(t, db, 53, 1, execMsg3)

			// 52 was sealed without logs
			requireConflicts(t, db, 52, 0, createHash(1))

			// 53 only contained 2 logs, not 3, and is not sealed yet
			requireFuture(t, db, 53, 2, createHash(3))
			// 54 doesn't exist yet
			requireFuture(t, db, 54, 0, createHash(3))

			// 51 only contained 3 logs, not 4
			requireConflicts(t, db, 51, 3, createHash(2))
704 705 706 707
		})
}

func TestGetBlockInfo(t *testing.T) {
708
	t.Run("ReturnsErrFutureWhenEmpty", func(t *testing.T) {
709 710 711
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {},
			func(t *testing.T, db *DB, m *stubMetrics) {
712 713
				_, err := db.FindSealedBlock(10)
				require.ErrorIs(t, err, entrydb.ErrFuture)
714 715
				_, err = db.FindSealedBlock(10)
				require.ErrorIs(t, err, entrydb.ErrFuture)
716 717 718
			})
	})

719
	t.Run("ReturnsErrFutureWhenRequestedBlockBeforeFirstSearchCheckpoint", func(t *testing.T) {
720 721
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
722 723
				bl11 := eth.BlockID{Hash: createHash(11), Number: 11}
				require.NoError(t, db.lastEntryContext.forceBlock(bl11, 500))
724
				err := db.AddLog(createHash(1), bl11, 0, nil)
725 726 727
				require.NoError(t, err)
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
728
				// if the DB starts at 11, then shouldn't find 10
729 730
				_, err := db.FindSealedBlock(10)
				require.ErrorIs(t, err, entrydb.ErrSkipped)
731 732
				_, err = db.FindSealedBlock(10)
				require.ErrorIs(t, err, entrydb.ErrSkipped)
733 734 735 736 737 738 739
			})
	})

	t.Run("ReturnFirstBlockInfo", func(t *testing.T) {
		block := eth.BlockID{Hash: createHash(11), Number: 11}
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
740
				require.NoError(t, db.SealBlock(common.Hash{}, block, 500))
741 742
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
743 744
				_, err := db.FindSealedBlock(block.Number)
				require.NoError(t, err)
745
				seal, err := db.FindSealedBlock(block.Number)
746
				require.NoError(t, err)
747 748
				require.Equal(t, block, seal.ID())
				require.Equal(t, uint64(500), seal.Timestamp)
749 750
				require.Equal(t, block, seal.ID())
				require.Equal(t, uint64(500), seal.Timestamp)
751 752 753 754 755 756 757 758
			})
	})
}

func requireContains(t *testing.T, db *DB, blockNum uint64, logIdx uint32, logHash common.Hash, execMsg ...types.ExecutingMessage) {
	require.LessOrEqual(t, len(execMsg), 1, "cannot have multiple executing messages for a single log")
	m, ok := db.m.(*stubMetrics)
	require.True(t, ok, "Did not get the expected metrics type")
759
	_, err := db.Contains(blockNum, logIdx, logHash)
760
	require.NoErrorf(t, err, "Error searching for log %v in block %v", logIdx, blockNum)
761
	require.LessOrEqual(t, m.entriesReadForSearch, int64(searchCheckpointFrequency*2), "Should not need to read more than between two checkpoints")
762 763 764 765 766 767 768 769 770
	require.NotZero(t, m.entriesReadForSearch, "Must read at least some entries to find the log")

	var expectedExecMsg types.ExecutingMessage
	if len(execMsg) == 1 {
		expectedExecMsg = execMsg[0]
	}
	requireExecutingMessage(t, db, blockNum, logIdx, expectedExecMsg)
}

771
func requireConflicts(t *testing.T, db *DB, blockNum uint64, logIdx uint32, logHash common.Hash) {
772 773
	m, ok := db.m.(*stubMetrics)
	require.True(t, ok, "Did not get the expected metrics type")
774
	_, err := db.Contains(blockNum, logIdx, logHash)
775
	require.ErrorIs(t, err, entrydb.ErrConflict, "canonical chain must not include this log")
776
	require.ErrorIs(t, err, entrydb.ErrConflict, "canonical chain must not include this log")
777
	require.LessOrEqual(t, m.entriesReadForSearch, int64(searchCheckpointFrequency*2), "Should not need to read more than between two checkpoints")
778 779
}

780
func requireFuture(t *testing.T, db *DB, blockNum uint64, logIdx uint32, logHash common.Hash) {
781 782
	m, ok := db.m.(*stubMetrics)
	require.True(t, ok, "Did not get the expected metrics type")
783
	_, err := db.Contains(blockNum, logIdx, logHash)
784
	require.ErrorIs(t, err, entrydb.ErrFuture, "canonical chain does not yet include this log")
785
	require.ErrorIs(t, err, entrydb.ErrFuture, "canonical chain does not yet include this log")
786
	require.LessOrEqual(t, m.entriesReadForSearch, int64(searchCheckpointFrequency*2), "Should not need to read more than between two checkpoints")
787 788
}

789
func requireExecutingMessage(t *testing.T, db *DB, blockNum uint64, logIdx uint32, execMsg types.ExecutingMessage) {
790 791
	m, ok := db.m.(*stubMetrics)
	require.True(t, ok, "Did not get the expected metrics type")
792
	_, iter, err := db.findLogInfo(blockNum, logIdx)
793
	require.NoError(t, err, "Error when searching for executing message")
794 795 796 797 798 799 800 801 802
	actualExecMsg := iter.ExecMessage() // non-nil if not just an initiating message, but also an executing message
	if execMsg == (types.ExecutingMessage{}) {
		require.Nil(t, actualExecMsg)
	} else {
		require.NotNil(t, actualExecMsg)
		require.Equal(t, execMsg, *actualExecMsg, "Should return matching executing message")
	}
	require.LessOrEqual(t, m.entriesReadForSearch, int64(searchCheckpointFrequency*2), "Should not need to read more than between two checkpoints")
	require.NotZero(t, m.entriesReadForSearch, "Must read at least some entries to find the log")
803 804 805
}

func TestRecoverOnCreate(t *testing.T) {
806
	createDb := func(t *testing.T, store *entrydb.MemEntryStore[EntryType, Entry]) (*DB, *stubMetrics, error) {
807 808
		logger := testlog.Logger(t, log.LvlInfo)
		m := &stubMetrics{}
809
		db, err := NewFromEntryStore(logger, m, store, true)
810 811 812
		return db, m, err
	}

813 814 815
	storeWithEvents := func(evts ...Entry) *entrydb.MemEntryStore[EntryType, Entry] {
		store := &entrydb.MemEntryStore[EntryType, Entry]{}
		_ = store.Append(evts...)
816
		return store
817
	}
818 819 820 821
	t.Run("NoTruncateWhenLastEntryIsLogWithNoExecMessageSealed", func(t *testing.T) {
		store := storeWithEvents(
			// seal 0, 1, 2, 3
			newSearchCheckpoint(0, 0, 100).encode(),
822
			newCanonicalHash(createHash(300)).encode(),
823
			newSearchCheckpoint(1, 0, 101).encode(),
824
			newCanonicalHash(createHash(301)).encode(),
825
			newSearchCheckpoint(2, 0, 102).encode(),
826
			newCanonicalHash(createHash(302)).encode(),
827
			newSearchCheckpoint(3, 0, 103).encode(),
828
			newCanonicalHash(createHash(303)).encode(),
829
			// open and seal 4
830
			newInitiatingEvent(createHash(1), false).encode(),
831
			newSearchCheckpoint(4, 0, 104).encode(),
832
			newCanonicalHash(createHash(304)).encode(),
833 834 835 836 837 838 839 840 841 842 843 844 845
		)
		db, m, err := createDb(t, store)
		require.NoError(t, err)
		require.EqualValues(t, int64(4*2+3), m.entryCount)
		requireContains(t, db, 4, 0, createHash(1))
	})

	t.Run("NoTruncateWhenLastEntryIsExecutingCheckSealed", func(t *testing.T) {
		execMsg := types.ExecutingMessage{
			Chain:     4,
			BlockNum:  10,
			LogIdx:    4,
			Timestamp: 1288,
846
			Hash:      createHash(4),
847
		}
848 849 850 851
		linkEvt, err := newExecutingLink(execMsg)
		require.NoError(t, err)
		store := storeWithEvents(
			newSearchCheckpoint(0, 0, 100).encode(),
852
			newCanonicalHash(createHash(300)).encode(),
853
			newSearchCheckpoint(1, 0, 101).encode(),
854
			newCanonicalHash(createHash(301)).encode(),
855
			newSearchCheckpoint(2, 0, 102).encode(),
856 857
			newCanonicalHash(createHash(302)).encode(),
			newInitiatingEvent(createHash(1111), true).encode(),
858 859 860
			linkEvt.encode(),
			newExecutingCheck(execMsg.Hash).encode(),
			newSearchCheckpoint(3, 0, 103).encode(),
861
			newCanonicalHash(createHash(303)).encode(),
862 863 864 865 866 867
		)
		db, m, err := createDb(t, store)
		require.NoError(t, err)
		require.EqualValues(t, int64(3*2+5), m.entryCount)
		requireContains(t, db, 3, 0, createHash(1111), execMsg)
	})
868

869 870 871 872 873 874 875 876
	t.Run("TruncateWhenLastEntrySearchCheckpoint", func(t *testing.T) {
		// A checkpoint, without a canonical blockhash, is useless, and thus truncated.
		store := storeWithEvents(
			newSearchCheckpoint(0, 0, 100).encode())
		_, m, err := createDb(t, store)
		require.NoError(t, err)
		require.EqualValues(t, int64(0), m.entryCount)
	})
877

878 879 880 881
	t.Run("NoTruncateWhenLastEntryCanonicalHash", func(t *testing.T) {
		// A completed seal is fine to have as last entry.
		store := storeWithEvents(
			newSearchCheckpoint(0, 0, 100).encode(),
882
			newCanonicalHash(createHash(344)).encode(),
883 884 885 886 887
		)
		_, m, err := createDb(t, store)
		require.NoError(t, err)
		require.EqualValues(t, int64(2), m.entryCount)
	})
888

889 890 891 892 893
	t.Run("TruncateWhenLastEntryInitEventWithExecMsg", func(t *testing.T) {
		// An initiating event that claims an executing message,
		// without said executing message, is dropped.
		store := storeWithEvents(
			newSearchCheckpoint(0, 0, 100).encode(),
894
			newCanonicalHash(createHash(344)).encode(),
895
			// both pruned because we go back to a seal
896 897
			newInitiatingEvent(createHash(0), false).encode(),
			newInitiatingEvent(createHash(1), true).encode(),
898 899 900 901 902
		)
		_, m, err := createDb(t, store)
		require.NoError(t, err)
		require.EqualValues(t, int64(2), m.entryCount)
	})
903

904 905 906 907 908
	t.Run("NoTruncateWhenLastEntrySealed", func(t *testing.T) {
		// An initiating event that claims an executing message,
		// without said executing message, is dropped.
		store := storeWithEvents(
			newSearchCheckpoint(0, 0, 100).encode(),
909
			newCanonicalHash(createHash(300)).encode(),
910
			// pruned because we go back to a seal
911
			newInitiatingEvent(createHash(0), false).encode(),
912
			newSearchCheckpoint(1, 0, 100).encode(),
913
			newCanonicalHash(createHash(301)).encode(),
914 915 916 917 918
		)
		_, m, err := createDb(t, store)
		require.NoError(t, err)
		require.EqualValues(t, int64(5), m.entryCount)
	})
919

920 921 922 923 924 925
	t.Run("TruncateWhenLastEntryInitEventWithExecLink", func(t *testing.T) {
		execMsg := types.ExecutingMessage{
			Chain:     4,
			BlockNum:  10,
			LogIdx:    4,
			Timestamp: 1288,
926
			Hash:      createHash(4),
927 928 929 930 931
		}
		linkEvt, err := newExecutingLink(execMsg)
		require.NoError(t, err)
		store := storeWithEvents(
			newSearchCheckpoint(3, 0, 100).encode(),
932 933
			newCanonicalHash(createHash(344)).encode(),
			newInitiatingEvent(createHash(1), true).encode(),
934 935 936 937 938 939
			linkEvt.encode(),
		)
		_, m, err := createDb(t, store)
		require.NoError(t, err)
		require.EqualValues(t, int64(2), m.entryCount)
	})
940 941 942 943 944 945
}

func TestRewind(t *testing.T) {
	t.Run("WhenEmpty", func(t *testing.T) {
		runDBTest(t, func(t *testing.T, db *DB, m *stubMetrics) {},
			func(t *testing.T, db *DB, m *stubMetrics) {
946
				require.ErrorIs(t, db.Rewind(100), entrydb.ErrFuture)
947
				require.ErrorIs(t, db.Rewind(100), entrydb.ErrFuture)
948
				// Genesis is a block to, not present in an empty DB
949
				require.ErrorIs(t, db.Rewind(0), entrydb.ErrFuture)
950
				require.ErrorIs(t, db.Rewind(0), entrydb.ErrFuture)
951 952 953 954 955 956
			})
	})

	t.Run("AfterLastBlock", func(t *testing.T) {
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
957 958
				bl50 := eth.BlockID{Hash: createHash(50), Number: 50}
				require.NoError(t, db.SealBlock(createHash(49), bl50, 500))
959 960
				require.NoError(t, db.AddLog(createHash(1), bl50, 0, nil))
				require.NoError(t, db.AddLog(createHash(2), bl50, 1, nil))
961 962
				bl51 := eth.BlockID{Hash: createHash(51), Number: 51}
				require.NoError(t, db.SealBlock(bl50.Hash, bl51, 502))
963
				require.NoError(t, db.AddLog(createHash(3), bl51, 0, nil))
964 965
				bl52 := eth.BlockID{Hash: createHash(52), Number: 52}
				require.NoError(t, db.SealBlock(bl51.Hash, bl52, 504))
966
				require.NoError(t, db.AddLog(createHash(4), bl52, 0, nil))
967
				// cannot rewind to a block that is not sealed yet
968
				require.ErrorIs(t, db.Rewind(53), entrydb.ErrFuture)
969
				require.ErrorIs(t, db.Rewind(53), entrydb.ErrFuture)
970 971
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
972 973 974 975 976
				requireContains(t, db, 51, 0, createHash(1))
				requireContains(t, db, 51, 1, createHash(2))
				requireContains(t, db, 52, 0, createHash(3))
				// Still have the pending log of unsealed block if the rewind to unknown sealed block fails
				requireContains(t, db, 53, 0, createHash(4))
977 978 979 980 981 982
			})
	})

	t.Run("BeforeFirstBlock", func(t *testing.T) {
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
983 984
				bl50 := eth.BlockID{Hash: createHash(50), Number: 50}
				require.NoError(t, db.SealBlock(createHash(49), bl50, 500))
985 986
				require.NoError(t, db.AddLog(createHash(1), bl50, 0, nil))
				require.NoError(t, db.AddLog(createHash(2), bl50, 1, nil))
987
				// cannot go back to an unknown block
988
				require.ErrorIs(t, db.Rewind(25), entrydb.ErrSkipped)
989
				require.ErrorIs(t, db.Rewind(25), entrydb.ErrSkipped)
990 991
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
992 993
				requireContains(t, db, 51, 0, createHash(1))
				requireContains(t, db, 51, 0, createHash(1))
994 995 996 997 998 999
			})
	})

	t.Run("AtFirstBlock", func(t *testing.T) {
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
1000 1001
				bl50 := eth.BlockID{Hash: createHash(50), Number: 50}
				require.NoError(t, db.SealBlock(createHash(49), bl50, 500))
1002 1003
				require.NoError(t, db.AddLog(createHash(1), bl50, 0, nil))
				require.NoError(t, db.AddLog(createHash(2), bl50, 1, nil))
1004 1005
				bl51 := eth.BlockID{Hash: createHash(51), Number: 51}
				require.NoError(t, db.SealBlock(bl50.Hash, bl51, 502))
1006 1007
				require.NoError(t, db.AddLog(createHash(1), bl51, 0, nil))
				require.NoError(t, db.AddLog(createHash(2), bl51, 1, nil))
1008 1009 1010
				bl52 := eth.BlockID{Hash: createHash(52), Number: 52}
				require.NoError(t, db.SealBlock(bl51.Hash, bl52, 504))
				require.NoError(t, db.Rewind(51))
1011 1012
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
1013 1014 1015 1016
				requireContains(t, db, 51, 0, createHash(1))
				requireContains(t, db, 51, 1, createHash(2))
				requireFuture(t, db, 52, 0, createHash(1))
				requireFuture(t, db, 52, 1, createHash(2))
1017 1018 1019
			})
	})

1020
	t.Run("AfterSecondCheckpoint", func(t *testing.T) {
1021 1022
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
1023 1024
				bl50 := eth.BlockID{Hash: createHash(50), Number: 50}
				require.NoError(t, db.SealBlock(createHash(49), bl50, 500))
1025
				for i := uint32(0); m.entryCount < searchCheckpointFrequency; i++ {
1026
					require.NoError(t, db.AddLog(createHash(1), bl50, i, nil))
1027
				}
1028 1029 1030 1031 1032 1033
				// The checkpoint is added automatically,
				// it will be there as soon as it reaches 255 with log events.
				// Thus add 2 for the checkpoint.
				require.EqualValues(t, searchCheckpointFrequency+2, m.entryCount)
				bl51 := eth.BlockID{Hash: createHash(51), Number: 51}
				require.NoError(t, db.SealBlock(bl50.Hash, bl51, 502))
1034
				require.NoError(t, db.AddLog(createHash(1), bl51, 0, nil))
1035
				require.EqualValues(t, searchCheckpointFrequency+2+3, m.entryCount, "Should have inserted new checkpoint and extra log")
1036
				require.NoError(t, db.AddLog(createHash(2), bl51, 1, nil))
1037 1038 1039
				bl52 := eth.BlockID{Hash: createHash(52), Number: 52}
				require.NoError(t, db.SealBlock(bl51.Hash, bl52, 504))
				require.NoError(t, db.Rewind(51))
1040 1041
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
1042 1043 1044 1045 1046
				require.EqualValues(t, searchCheckpointFrequency+2+2, m.entryCount, "Should have deleted second checkpoint")
				requireContains(t, db, 51, 0, createHash(1))
				requireContains(t, db, 51, 1, createHash(1))
				requireFuture(t, db, 52, 0, createHash(1))
				requireFuture(t, db, 52, 1, createHash(2))
1047 1048 1049
			})
	})

1050
	t.Run("BetweenBlockEntries", func(t *testing.T) {
1051 1052
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
1053 1054 1055 1056 1057
				// create many blocks, and all the odd blocks get 2 logs
				for i := uint32(0); i < 30; i++ {
					bl := eth.BlockID{Hash: createHash(int(i)), Number: uint64(i)}
					require.NoError(t, db.SealBlock(createHash(int(i)-1), bl, 500+uint64(i)))
					if i%2 == 0 {
1058 1059
						require.NoError(t, db.AddLog(createHash(1), bl, 0, nil))
						require.NoError(t, db.AddLog(createHash(2), bl, 1, nil))
1060 1061 1062
					}
				}
				require.NoError(t, db.Rewind(15))
1063 1064
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
1065 1066 1067 1068
				requireContains(t, db, 15, 0, createHash(1))
				requireContains(t, db, 15, 1, createHash(2))
				requireFuture(t, db, 16, 0, createHash(1))
				requireFuture(t, db, 16, 1, createHash(2))
1069 1070 1071 1072 1073 1074
			})
	})

	t.Run("AtLastEntry", func(t *testing.T) {
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
1075 1076 1077 1078 1079
				// create many blocks, and all the even blocks get 2 logs
				for i := uint32(0); i <= 30; i++ {
					bl := eth.BlockID{Hash: createHash(int(i)), Number: uint64(i)}
					require.NoError(t, db.SealBlock(createHash(int(i)-1), bl, 500+uint64(i)))
					if i%2 == 1 {
1080 1081
						require.NoError(t, db.AddLog(createHash(1), bl, 0, nil))
						require.NoError(t, db.AddLog(createHash(2), bl, 1, nil))
1082 1083 1084 1085
					}
				}
				// We ended at 30, and sealed it, nothing left to prune
				require.NoError(t, db.Rewind(30))
1086 1087
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
1088 1089 1090 1091 1092
				requireContains(t, db, 20, 0, createHash(1))
				requireContains(t, db, 20, 1, createHash(2))
				// built on top of 29, these are in sealed block 30, still around
				requireContains(t, db, 30, 0, createHash(1))
				requireContains(t, db, 30, 1, createHash(2))
1093 1094 1095
			})
	})

1096
	t.Run("ReadDeletedBlocks", func(t *testing.T) {
1097 1098
		runDBTest(t,
			func(t *testing.T, db *DB, m *stubMetrics) {
1099 1100 1101 1102 1103
				// create many blocks, and all the odd blocks get 2 logs
				for i := uint32(0); i < 30; i++ {
					bl := eth.BlockID{Hash: createHash(int(i)), Number: uint64(i)}
					require.NoError(t, db.SealBlock(createHash(int(i)-1), bl, 500+uint64(i)))
					if i%2 == 0 {
1104 1105
						require.NoError(t, db.AddLog(createHash(1), bl, 0, nil))
						require.NoError(t, db.AddLog(createHash(2), bl, 1, nil))
1106 1107 1108
					}
				}
				require.NoError(t, db.Rewind(16))
1109 1110
			},
			func(t *testing.T, db *DB, m *stubMetrics) {
1111 1112
				bl29 := eth.BlockID{Hash: createHash(29), Number: 29}
				// 29 was deleted
1113
				err := db.AddLog(createHash(2), bl29, 1, nil)
1114
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder, "Cannot add log on removed block")
1115
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder, "Cannot add log on removed block")
1116 1117 1118
				// 15 is older, we have up to 16
				bl15 := eth.BlockID{Hash: createHash(15), Number: 15}
				// try to add a third log to 15
1119
				err = db.AddLog(createHash(10), bl15, 2, nil)
1120
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder)
1121
				require.ErrorIs(t, err, entrydb.ErrOutOfOrder)
1122 1123
				bl16 := eth.BlockID{Hash: createHash(16), Number: 16}
				// try to add a log to 17, on top of 16
1124
				err = db.AddLog(createHash(42), bl16, 0, nil)
1125 1126
				require.NoError(t, err)
				requireContains(t, db, 17, 0, createHash(42))
1127 1128 1129 1130 1131 1132 1133 1134 1135
			})
	})
}

type stubMetrics struct {
	entryCount           int64
	entriesReadForSearch int64
}

1136
func (s *stubMetrics) RecordDBEntryCount(kind string, count int64) {
1137 1138 1139 1140 1141 1142 1143 1144 1145
	s.entryCount = count
}

func (s *stubMetrics) RecordDBSearchEntriesRead(count int64) {
	s.entriesReadForSearch = count
}

var _ Metrics = (*stubMetrics)(nil)

1146
var _ entrydb.EntryStore[EntryType, Entry] = (*entrydb.MemEntryStore[EntryType, Entry])(nil)