Merge pull request #50 from initia-labs/chore/update-cache-unit

change cache unit to MiB

CHANGELOG.md

@@ -36,6 +36,8 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ## [Unreleased]
 
+* (cache) Change cache-capacity unit to MiB
+
 ## [v0.1.5](https://github.com/initia-labs/kvindexer/releases/tag/v0.1.5) - 2024-07-16
 
 ### KVIndexer breaking 

config/config.go

@@ -59,7 +59,7 @@ func (c IndexerConfig) IsEnabled() bool {
 func DefaultConfig() IndexerConfig {
 	return IndexerConfig{
 		Enable:        true,
-		CacheCapacity: 500 * 1024 * 1024, // 500MiB
+		CacheCapacity: 500, // 500 MiB
 		BackendConfig: store.DefaultConfig(),
 	}
 }

config/types.go

@@ -20,11 +20,12 @@ const DefaultConfigTemplate = `
 # Enable defines whether the indexer is enabled.
 enable = {{ .IndexerConfig.Enable }}
 
-# CacheCapacity defines the size of the cache. (unit: bytes)
+# CacheCapacity defines the size of the cache. (unit: MiB)
 cache-capacity = {{ .IndexerConfig.CacheCapacity }}
 
 # Backend defines the type of the backend store and its options.
 # It should have a key-value pair named 'type', and the value should exist in store supported by cosmos-db.
+# Recommend to use default value unless you know about backend db storage.
 # supported type: "goleveldb" only in current
 [indexer.backend]
 {{ range $key, $value := .IndexerConfig.BackendConfig.AllSettings }}{{ printf "%s = \"%v\"\n" $key $value }}{{end}}

x/kvindexer/keeper/keeper.go

@@ -99,7 +99,7 @@ func (k *Keeper) Seal() error {
 
 	k.schema = &schema
 
-	k.store = store.NewCacheStore(dbadapter.Store{DB: k.db}, k.config.CacheCapacity)
+	k.store = store.NewCacheStore(dbadapter.Store{DB: k.db}, k.config.CacheCapacity*1024*1024)
 	k.sealed = true
 
 	return nil