refactor: entryCache -> blockCache

Author: DracoLi

x/blockdb/config.go

@@ -11,8 +11,8 @@ const DefaultMaxDataFileSize = 500 * 1024 * 1024 * 1024
 // DefaultMaxDataFiles is the default maximum number of data files descriptors cached.
 const DefaultMaxDataFiles = 10
 
-// DefaultEntryCacheSize is the default size of the entry cache.
-const DefaultEntryCacheSize = 256
+// DefaultBlockCacheSize is the default size of the block cache.
+const DefaultBlockCacheSize = 256
 
 // DatabaseConfig contains configuration parameters for BlockDB.
 type DatabaseConfig struct {
@@ -31,8 +31,8 @@ type DatabaseConfig struct {
 	// MaxDataFiles is the maximum number of data files descriptors cached.
 	MaxDataFiles int
 
-	// EntryCacheSize is the size of the entry cache (default: 256).
-	EntryCacheSize int
+	// BlockCacheSize is the size of the block cache (default: 256).
+	BlockCacheSize int
 
 	// CheckpointInterval defines how frequently (in blocks) the index file header is updated (default: 1024).
 	CheckpointInterval uint64
@@ -49,7 +49,7 @@ func DefaultConfig() DatabaseConfig {
 		MinimumHeight:      0,
 		MaxDataFileSize:    DefaultMaxDataFileSize,
 		MaxDataFiles:       DefaultMaxDataFiles,
-		EntryCacheSize:     DefaultEntryCacheSize,
+		BlockCacheSize:     DefaultBlockCacheSize,
 		CheckpointInterval: 1024,
 		SyncToDisk:         true,
 	}
@@ -98,9 +98,9 @@ func (c DatabaseConfig) WithMaxDataFiles(maxFiles int) DatabaseConfig {
 	return c
 }
 
-// WithEntryCacheSize returns a copy of the config with EntryCacheSize set to the given value.
-func (c DatabaseConfig) WithEntryCacheSize(size int) DatabaseConfig {
-	c.EntryCacheSize = size
+// WithBlockCacheSize returns a copy of the config with BlockCacheSize set to the given value.
+func (c DatabaseConfig) WithBlockCacheSize(size int) DatabaseConfig {
+	c.BlockCacheSize = size
 	return c
 }
 
@@ -127,8 +127,8 @@ func (c DatabaseConfig) Validate() error {
 	if c.MaxDataFileSize == 0 {
 		return errors.New("MaxDataFileSize must be positive")
 	}
-	if c.EntryCacheSize < 1 {
-		return errors.New("EntryCacheSize cannot be less than 1")
+	if c.BlockCacheSize < 1 {
+		return errors.New("BlockCacheSize cannot be less than 1")
 	}
 	return nil
 }

x/blockdb/database.go

@@ -177,7 +177,7 @@ type Database struct {
 	log        logging.Logger
 	closed     bool
 	fileCache  *lru.Cache[int, *os.File]
-	entryCache *lru.Cache[BlockHeight, BlockData]
+	blockCache *lru.Cache[BlockHeight, BlockData]
 	compressor compression.Compressor
 
 	// closeMu prevents the database from being closed while in use and prevents
@@ -225,7 +225,7 @@ func New(config DatabaseConfig, log logging.Logger) (*Database, error) {
 				f.Close()
 			}
 		}),
-		entryCache: lru.NewCache[BlockHeight, BlockData](config.EntryCacheSize),
+		blockCache: lru.NewCache[BlockHeight, BlockData](config.BlockCacheSize),
 		compressor: compressor,
 	}
 
@@ -234,7 +234,7 @@ func New(config DatabaseConfig, log logging.Logger) (*Database, error) {
 		zap.String("dataDir", config.DataDir),
 		zap.Uint64("maxDataFileSize", config.MaxDataFileSize),
 		zap.Int("maxDataFiles", config.MaxDataFiles),
-		zap.Int("entryCacheSize", config.EntryCacheSize),
+		zap.Int("blockCacheSize", config.BlockCacheSize),
 	)
 
 	if err := s.openAndInitializeIndex(); err != nil {
@@ -279,7 +279,7 @@ func (s *Database) Close() error {
 	}
 
 	s.closeFiles()
-	s.entryCache.Flush()
+	s.blockCache.Flush()
 
 	s.log.Info("Block database closed successfully")
 	return err
@@ -376,7 +376,7 @@ func (s *Database) Put(height BlockHeight, block BlockData) error {
 		)
 		return err
 	}
-	s.entryCache.Put(height, slices.Clone(block))
+	s.blockCache.Put(height, slices.Clone(block))
 
 	s.log.Debug("Block written successfully",
 		zap.Uint64("height", height),
@@ -441,7 +441,7 @@ func (s *Database) Get(height BlockHeight) (BlockData, error) {
 		return nil, database.ErrClosed
 	}
 
-	if c, ok := s.entryCache.Get(height); ok {
+	if c, ok := s.blockCache.Get(height); ok {
 		return slices.Clone(c), nil
 	}
 
@@ -495,7 +495,7 @@ func (s *Database) Get(height BlockHeight) (BlockData, error) {
 		return nil, fmt.Errorf("checksum mismatch: calculated %d, stored %d", calculatedChecksum, bh.Checksum)
 	}
 
-	s.entryCache.Put(height, slices.Clone(decompressed))
+	s.blockCache.Put(height, slices.Clone(decompressed))
 	return decompressed, nil
 }
 
@@ -509,7 +509,7 @@ func (s *Database) Has(height BlockHeight) (bool, error) {
 		return false, database.ErrClosed
 	}
 
-	if _, ok := s.entryCache.Get(height); ok {
+	if _, ok := s.blockCache.Get(height); ok {
 		return true, nil
 	}
 	_, err := s.readBlockIndex(height)

x/blockdb/entry_cache_test.go

@@ -17,13 +17,13 @@ func TestCacheOnMiss(t *testing.T) {
 	require.NoError(t, db.Put(height, block))
 
 	// Evict the entry from cache to simulate a cache miss
-	db.entryCache.Evict(height)
+	db.blockCache.Evict(height)
 
 	// Read the block - should populate the cache on cache miss
 	_, err := db.Get(height)
 	require.NoError(t, err)
 
-	_, ok := db.entryCache.Get(height)
+	_, ok := db.blockCache.Get(height)
 	require.True(t, ok)
 }
 
@@ -33,7 +33,7 @@ func TestCacheGet(t *testing.T) {
 	block := randomBlock(t)
 
 	// Populate cache directly without writing to database
-	db.entryCache.Put(height, block)
+	db.blockCache.Put(height, block)
 
 	// Get should return the block from cache
 	data, err := db.Get(height)
@@ -47,7 +47,7 @@ func TestCacheHas(t *testing.T) {
 	block := randomBlock(t)
 
 	// Populate cache directly without writing to database
-	db.entryCache.Put(height, block)
+	db.blockCache.Put(height, block)
 
 	// Has should return true from cache even though block is not in database
 	has, err := db.Has(height)
@@ -66,7 +66,7 @@ func TestCachePutStoresClone(t *testing.T) {
 	clone[0] = 99
 
 	// Cache should have the original unmodified data
-	cached, ok := db.entryCache.Get(height)
+	cached, ok := db.blockCache.Get(height)
 	require.True(t, ok)
 	require.Equal(t, block, cached)
 }
@@ -83,7 +83,7 @@ func TestCacheGetReturnsClone(t *testing.T) {
 	data[0] = 99
 
 	// Cache should still have the original unmodified data
-	cached, ok := db.entryCache.Get(height)
+	cached, ok := db.blockCache.Get(height)
 	require.True(t, ok)
 	require.Equal(t, block, cached)
 
@@ -100,14 +100,14 @@ func TestCachePutOverridesSameHeight(t *testing.T) {
 	require.NoError(t, db.Put(height, b1))
 
 	// Verify first block is in cache
-	cached, ok := db.entryCache.Get(height)
+	cached, ok := db.blockCache.Get(height)
 	require.True(t, ok)
 	require.Equal(t, b1, cached)
 
 	// Put second block at same height and verify it overrides the first one
 	b2 := randomBlock(t)
 	require.NoError(t, db.Put(height, b2))
-	cached, ok = db.entryCache.Get(height)
+	cached, ok = db.blockCache.Get(height)
 	require.True(t, ok)
 	require.Equal(t, b2, cached)
 	require.NotEqual(t, b1, cached)

x/blockdb/readblock_test.go

@@ -51,7 +51,7 @@ func TestReadOperations(t *testing.T) {
 				MaxDataFileSize:    DefaultMaxDataFileSize,
 				CheckpointInterval: 1024,
 				MaxDataFiles:       DefaultMaxDataFileSize,
-				EntryCacheSize:     DefaultEntryCacheSize,
+				BlockCacheSize:     DefaultBlockCacheSize,
 			},
 		},
 		{
@@ -70,7 +70,7 @@ func TestReadOperations(t *testing.T) {
 				MaxDataFileSize:    DefaultMaxDataFileSize,
 				CheckpointInterval: 1024,
 				MaxDataFiles:       DefaultMaxDataFileSize,
-				EntryCacheSize:     DefaultEntryCacheSize,
+				BlockCacheSize:     DefaultBlockCacheSize,
 			},
 			wantErr: ErrInvalidBlockHeight,
 		},