[WIP][Persistence][Core][Savepoints/Rollbacks] Implement KISS SavePoints - Serialize WorldState from Persistence - KV Stores POC - (Issue #327)

go.mod

@@ -207,7 +207,7 @@ require (
 	github.com/magiconair/properties v1.8.7 // indirect
 	github.com/mailru/easyjson v0.7.7 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
-	github.com/mattn/go-isatty v0.0.16 // indirect
+	github.com/mattn/go-isatty v0.0.17 // indirect
 	github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 // indirect
 	github.com/pelletier/go-toml v1.9.5 // indirect
 	github.com/pelletier/go-toml/v2 v2.0.5 // indirect

go.sum

@@ -546,8 +546,9 @@ github.com/mattn/go-isatty v0.0.5/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hd
 github.com/mattn/go-isatty v0.0.7/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=
 github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
 github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94=
-github.com/mattn/go-isatty v0.0.16 h1:bq3VjFmv/sOjHtdEhmkEV4x1AJtvUvOJ2PFAZ5+peKQ=
 github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
+github.com/mattn/go-isatty v0.0.17 h1:BTarxUcIeDqL27Mc+vyvdWYSL28zpIhv3RoTdsLMPng=
+github.com/mattn/go-isatty v0.0.17/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
 github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0=
 github.com/matttproud/golang_protobuf_extensions v1.0.4 h1:mmDVorXM7PCGKw94cs5zkfA9PSy5pEvNWRP0ET0TIVo=
 github.com/matttproud/golang_protobuf_extensions v1.0.4/go.mod h1:BSXmuO+STAnVfrANrmjBb36TMTDstsz7MSK+HVaYKv4=

persistence/context.go

@@ -33,11 +33,6 @@ type PostgresContext struct {
 	stateTrees *stateTrees
 }
 
-func (p *PostgresContext) NewSavePoint(bytes []byte) error {
-	p.logger.Info().Bool("TODO", true).Msg("NewSavePoint not implemented")
-	return nil
-}
-
 // TECHDEBT(#327): Guarantee atomicity betweens `prepareBlock`, `insertBlock` and `storeBlock` for save points & rollbacks.
 func (p *PostgresContext) RollbackToSavePoint(bytes []byte) error {
 	p.logger.Info().Bool("TODO", true).Msg("RollbackToSavePoint not fully implemented")

persistence/gov.go

@@ -60,7 +60,7 @@ func (p *PostgresContext) GetParameter(paramName string, height int64) (v any, e
 	case "[]uint8": // []byte
 		v, _, err = getParamOrFlag[[]byte](p, types.ParamsTableName, paramName, height)
 	default:
-		return nil, fmt.Errorf("unhandled type for param: got %s.", paramType)
+		return nil, fmt.Errorf("unhandled type for param: got %s", paramType)
 	}
 	return v, err
 }

persistence/indexer/indexer.go

@@ -94,7 +94,7 @@ func NewTxIndexer(databasePath string) (TxIndexer, error) {
 
 func NewMemTxIndexer() (TxIndexer, error) {
 	return &txIndexer{
-		db: kvstore.NewMemKVStore(),
+		db: kvstore.NewMemKVStore("txIndexer"),
 	}, nil
 }
 

persistence/kvstore/kvstore.go

@@ -4,14 +4,18 @@ package kvstore
 
 import (
 	"errors"
+	"fmt"
+	"io"
 	"log"
+	"strings"
 
 	"github.com/celestiaorg/smt"
 	badger "github.com/dgraph-io/badger/v3"
 )
 
 type KVStore interface {
 	smt.MapStore // Get, Set, Delete
+	BackupableKVStore
 
 	// Lifecycle methods
 	Stop() error
@@ -24,6 +28,11 @@ type KVStore interface {
 	ClearAll() error
 }
 
+type BackupableKVStore interface {
+	GetName() string
+	Backup(w io.Writer, since uint64) (uint64, error)
+}
+
 const (
 	BadgerKeyNotFoundError = "Key not found"
 )
@@ -39,23 +48,36 @@ var (
 )
 
 type badgerKVStore struct {
-	db *badger.DB
+	db   *badger.DB
+	name string
 }
 
 func NewKVStore(path string) (KVStore, error) {
 	db, err := badger.Open(badgerOptions(path))
 	if err != nil {
 		return nil, err
 	}
-	return &badgerKVStore{db: db}, nil
+
+	name, err := extractNameFromPath(path)
+	if err != nil {
+		return nil, err
+	}
+
+	return &badgerKVStore{
+		db:   db,
+		name: name,
+	}, nil
 }
 
-func NewMemKVStore() KVStore {
+func NewMemKVStore(name string) KVStore {
 	db, err := badger.Open(badgerOptions("").WithInMemory(true))
 	if err != nil {
 		log.Fatal(err)
 	}
-	return &badgerKVStore{db: db}
+	return &badgerKVStore{
+		db:   db,
+		name: name,
+	}
 }
 
 func (store *badgerKVStore) Set(key, value []byte) error {
@@ -148,6 +170,15 @@ func (store *badgerKVStore) Stop() error {
 	return store.db.Close()
 }
 
+// Backup writes a backup of the database to the given writer.
+func (store *badgerKVStore) Backup(w io.Writer, since uint64) (uint64, error) {
+	return store.db.Backup(w, since)
+}
+
+func (store *badgerKVStore) GetName() string {
+	return store.name
+}
+
 // PrefixEndBytes returns the end byteslice for a noninclusive range
 // that would include all byte slices for which the input is the prefix
 func prefixEndBytes(prefix []byte) []byte {
@@ -171,3 +202,19 @@ func badgerOptions(path string) badger.Options {
 	opts.Logger = nil // disable badger's logger since it's very noisy
 	return opts
 }
+
+func extractNameFromPath(path string) (string, error) {
+	if path == "" {
+		return "", fmt.Errorf("path is empty")
+	}
+
+	parts := strings.Split(path, "/")
+	nodesPart := parts[len(parts)-1]
+	name := strings.TrimSuffix(nodesPart, "_nodes")
+
+	if name == "" {
+		return "", fmt.Errorf("invalid path format, name not found in %s", path)
+	}
+
+	return name, nil
+}

persistence/kvstore_backup.go

@@ -0,0 +1,10 @@
+package persistence
+
+import (
+	"github.com/pokt-network/pocket/persistence/kvstore"
+)
+
+// GetBackupableKVStores returns the node and value kv stores allowing the ability to backup them
+func (p *PostgresContext) GetBackupableKVStores() (nodeStores, valueStores map[int]kvstore.BackupableKVStore) {
+	return p.stateTrees.GetBackupableKVStores()
+}

persistence/module.go

@@ -233,7 +233,7 @@ func (m *persistenceModule) NewWriteContext() modules.PersistenceRWContext {
 
 func initializeBlockStore(blockStorePath string) (kvstore.KVStore, error) {
 	if blockStorePath == "" {
-		return kvstore.NewMemKVStore(), nil
+		return kvstore.NewMemKVStore("blockStore"), nil
 	}
 	return kvstore.NewKVStore(blockStorePath)
 }