[x/merkledb] Prefetcher interface (#2167)

ava-labs · Oct 13, 2023 · 50f131e · 50f131e
1 parent 007f98d
commit 50f131e
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 0 deletions.
diff --git a/x/merkledb/db.go b/x/merkledb/db.go
@@ -114,13 +114,27 @@ type RangeProofer interface {
 	CommitRangeProof(ctx context.Context, start, end maybe.Maybe[[]byte], proof *RangeProof) error
 }
 
+type Prefetcher interface {
+	// PrefetchPath attempts to load all trie nodes on the path of [key]
+	// into the cache.
+	PrefetchPath(key []byte) error
+
+	// PrefetchPaths attempts to load all trie nodes on the paths of [keys]
+	// into the cache.
+	//
+	// Using PrefetchPaths can be more efficient than PrefetchPath because
+	// the underlying view used to compute each path can be reused.
+	PrefetchPaths(keys [][]byte) error
+}
+
 type MerkleDB interface {
 	database.Database
 	Trie
 	MerkleRootGetter
 	ProofGetter
 	ChangeProofer
 	RangeProofer
+	Prefetcher
 }
 
 type Config struct {

diff --git a/x/merkledb/mock_db.go b/x/merkledb/mock_db.go