feat: rawdb.InspectDatabaseOption

Author: ARR4N

core/rawdb/database.go

@@ -31,6 +31,7 @@ import (
 	"github.com/ava-labs/libevm/ethdb/leveldb"
 	"github.com/ava-labs/libevm/ethdb/memorydb"
 	"github.com/ava-labs/libevm/ethdb/pebble"
+	"github.com/ava-labs/libevm/libevm/options"
 	"github.com/ava-labs/libevm/log"
 	"github.com/olekukonko/tablewriter"
 )
@@ -451,7 +452,8 @@ func (s *stat) Count() string {
 
 // InspectDatabase traverses the entire database and checks the size
 // of all different categories of data.
-func InspectDatabase(db ethdb.Database, keyPrefix, keyStart []byte) error {
+func InspectDatabase(db ethdb.Database, keyPrefix, keyStart []byte, opts ...InspectDatabaseOption) error {
+	libevmConfig := options.As[inspectDatabaseConfig](opts...)
 	it := db.NewIterator(keyPrefix, keyStart)
 	defer it.Release()
 
@@ -549,6 +551,9 @@ func InspectDatabase(db ethdb.Database, keyPrefix, keyStart []byte) error {
 			bytes.HasPrefix(key, BloomTrieIndexPrefix) ||
 			bytes.HasPrefix(key, BloomTriePrefix): // Bloomtrie sub
 			bloomTrieNodes.Add(size)
+		case libevmConfig.recordStat(key, size):
+		case libevmConfig.isMetadata(key):
+			metadata.Add(size)
 		default:
 			var accounted bool
 			for _, meta := range [][]byte{
@@ -617,7 +622,7 @@ func InspectDatabase(db ethdb.Database, keyPrefix, keyStart []byte) error {
 	table := tablewriter.NewWriter(os.Stdout)
 	table.SetHeader([]string{"Database", "Category", "Size", "Items"})
 	table.SetFooter([]string{"", "Total", total.String(), " "})
-	table.AppendBulk(stats)
+	table.AppendBulk(libevmConfig.transformStats(stats))
 	table.Render()
 
 	if unaccounted.size > 0 {

core/rawdb/database.libevm.go

@@ -0,0 +1,89 @@
+// Copyright 2025 the libevm authors.
+//
+// The libevm additions to go-ethereum are free software: you can redistribute
+// them and/or modify them under the terms of the GNU Lesser General Public License
+// as published by the Free Software Foundation, either version 3 of the License,
+// or (at your option) any later version.
+//
+// The libevm additions are distributed in the hope that they will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
+// General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License
+// along with the go-ethereum library. If not, see
+// <http://www.gnu.org/licenses/>.
+
+package rawdb
+
+import (
+	"github.com/ava-labs/libevm/common"
+	"github.com/ava-labs/libevm/libevm/options"
+)
+
+// An InspectDatabaseOption configures the behaviour of [InspectDatabase]. For
+// each type of option, only one instance can be used in the same call to
+// InspectDatabase().
+type InspectDatabaseOption = options.Option[inspectDatabaseConfig]
+
+type inspectDatabaseConfig struct {
+	statRecorder     func([]byte, common.StorageSize) bool
+	isMeta           func([]byte) bool
+	statsTransformer func([][]string) [][]string
+}
+
+func (c inspectDatabaseConfig) recordStat(key []byte, size common.StorageSize) bool {
+	if r := c.statRecorder; r != nil {
+		return r(key, size)
+	}
+	return false
+}
+
+func (c inspectDatabaseConfig) isMetadata(key []byte) bool {
+	if m := c.isMeta; m != nil {
+		return m(key)
+	}
+	return false
+}
+
+func (c inspectDatabaseConfig) transformStats(stats [][]string) [][]string {
+	if f := c.statsTransformer; f != nil {
+		return f(stats)
+	}
+	return stats
+}
+
+func newInspectOpt(fn func(*inspectDatabaseConfig)) InspectDatabaseOption {
+	return options.Func[inspectDatabaseConfig](fn)
+}
+
+// WithDatabaseStatRecorder returns an option that results in `rec` being called
+// for every `key` not otherwise matched by the [InspectDatabase] iterator loop.
+// The returned boolean signals whether the recorder matches the key, thus
+// stopping further matches.
+func WithDatabaseStatRecorder(rec func(key []byte, _ common.StorageSize) bool) InspectDatabaseOption {
+	return newInspectOpt(func(c *inspectDatabaseConfig) {
+		c.statRecorder = rec
+	})
+}
+
+// A DatabaseStat stores total size and counts for a parameter measured by
+// [InspectDatabase]. It is exported for use with [WithDatabaseStatRecorder].
+type DatabaseStat = stat
+
+// WithDatabaseMetadataKeys returns an option that results in the `key` size
+// being counted with the metadata statistic i.f.f. the function returns true.
+func WithDatabaseMetadataKeys(isMetadata func(key []byte) bool) InspectDatabaseOption {
+	return newInspectOpt(func(c *inspectDatabaseConfig) {
+		c.isMeta = isMetadata
+	})
+}
+
+// WithDatabaseStatsTransformer returns an option that causes all statistics to
+// be passed to the provided function, with its return value being printed
+// instead of the original values.
+func WithDatabaseStatsTransformer(transform func([][]string) [][]string) InspectDatabaseOption {
+	return newInspectOpt(func(c *inspectDatabaseConfig) {
+		c.statsTransformer = transform
+	})
+}

core/rawdb/database.libevm_test.go

@@ -0,0 +1,40 @@
+// Copyright 2025 the libevm authors.
+//
+// The libevm additions to go-ethereum are free software: you can redistribute
+// them and/or modify them under the terms of the GNU Lesser General Public License
+// as published by the Free Software Foundation, either version 3 of the License,
+// or (at your option) any later version.
+//
+// The libevm additions are distributed in the hope that they will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
+// General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License
+// along with the go-ethereum library. If not, see
+// <http://www.gnu.org/licenses/>.
+
+package rawdb_test
+
+import (
+	"github.com/ava-labs/libevm/common"
+	// To ensure that all methods are available to importing packages, this test
+	// is defined in package `rawdb_test` instead of `rawdb`.
+	"github.com/ava-labs/libevm/core/rawdb"
+)
+
+// ExampleDatabaseStat demonstrates the method signatures of DatabaseStat, which
+// exposes an otherwise unexported type that won't have its methods documented.
+func ExampleDatabaseStat() {
+	var (
+		stat rawdb.DatabaseStat
+		size common.StorageSize
+	)
+
+	stat.Add(size)
+
+	var (
+		_ string = stat.Size()  // sum of all values passed to Add()
+		_ string = stat.Count() // number of calls to Add()
+	)
+}