[Enhancement] Reintroduce the MapStore interface and SimpleMap and make the Badger a submodules

.github/workflows/test.yml

@@ -45,8 +45,8 @@ jobs:
           # Run each of the tests (excluding benchmarks) outputting the JSON
           # to the test_results.json file for usage in later steps.
           set -euo pipefail
-          go test -v -json -p 1 ./ -mod=readonly -race -coverprofile=coverage1.txt -covermode=atomic 2>&1 | tee -a test_results.json
-          go test -v -json -p 1 ./kvstore/... -race -coverprofile=coverage2.txt -covermode=atomic 2>&1 | tee -a test_results.json
+          go test -v -json -p 1 ./ -mod=readonly -race -coverprofile=coverage1.txt -covermode=atomic 2>&1 | tee test_results.json
+          go test -v -json -p 1 ./kvstore/simplemap/... -mod=readonly -race -coverprofile=coverage2.txt -covermode=atomic 2>&1 | tee -a test_results.json
           go test -v -json -p 1 ./kvstore/badger/... -mod=readonly -race -coverprofile=coverage3.txt -covermode=atomic 2>&1 | tee -a test_results.json
           # Combine coverage reports
           gocovmerge coverage1.txt coverage2.txt coverage3.txt > coverage.txt

Makefile

@@ -40,12 +40,22 @@ go_docs: check_godoc ## Generate documentation for the project
 .PHONY: test_all
 test_all:  ## runs the test suite
 	go test -v -p 1 ./ -mod=readonly -race
-	go test -v -p 1 ./kvstore/... -race
+	go test -v -p 1 ./kvstore/simplemap/... -mod=readonly -race
 
 .PHONY: test_badger
 test_badger: ## runs the badger KVStore submodule's test suite
 	go test -v -p 1 ./kvstore/badger/... -mod=readonly -race
 
+
+#####################
+###    go mod     ###
+#####################
+.PHONY: mod_tidy
+mod_tidy:  ## runs go mod tidy for all (sub)modules
+	go mod tidy
+	cd kvstore/simplemap && go mod tidy
+	cd kvstore/badger && go mod tidy
+
 #####################
 ###   Benchmark   ###
 #####################

README.md

@@ -16,7 +16,7 @@
 
 <!-- tocstop -->
 
-**NOTE: Requires Go 1.20.12**
+**NOTE: Requires Go 1.20.12+**
 
 ## Overview
 
@@ -41,7 +41,7 @@ make test_all
 ```
 
 To test the `badger` submodule that provides a more fully featured key-value
-store run the following command:
+store, run the following command:
 
 ```sh
 make test_badger

benchmarks/bench_leaf_test.go

@@ -9,13 +9,13 @@ import (
 	"github.com/stretchr/testify/require"
 
 	"github.com/pokt-network/smt"
-	"github.com/pokt-network/smt/kvstore"
+	"github.com/pokt-network/smt/kvstore/simplemap"
 )
 
 func BenchmarkSMTLeafSizes_Fill(b *testing.B) {
 	trieSizes := []int{100000, 500000, 1000000, 5000000, 10000000} // number of leaves
 	leafSizes := []int{256, 512, 1024, 2048, 4096, 8192, 16384}    // number of bytes per leaf
-	nodes := kvstore.NewSimpleMap()
+	nodes := simplemap.NewSimpleMap()
 	for _, trieSize := range trieSizes {
 		for _, leafSize := range leafSizes {
 			leaf := make([]byte, leafSize)
@@ -44,7 +44,7 @@ func BenchmarkSMTLeafSizes_Fill(b *testing.B) {
 func BenchmarkSMSTLeafSizes_Fill(b *testing.B) {
 	trieSizes := []int{100000, 500000, 1000000, 5000000, 10000000} // number of leaves
 	leafSizes := []int{256, 512, 1024, 2048, 4096, 8192, 16384}    // number of bytes per leaf
-	nodes := kvstore.NewSimpleMap()
+	nodes := simplemap.NewSimpleMap()
 	for _, trieSize := range trieSizes {
 		for _, leafSize := range leafSizes {
 			leaf := make([]byte, leafSize)

benchmarks/bench_smst_test.go

@@ -11,65 +11,65 @@ import (
 
 func BenchmarkSparseMerkleSumTrie_Fill(b *testing.B) {
 	testCases := []struct {
-		name     string
+		desc     string
 		trieSize int
 		commit   bool
 	}{
 		{
-			name:     "Fill (100000)",
+			desc:     "Fill (100000)",
 			trieSize: 100000,
 			commit:   false,
 		},
 		{
-			name:     "Fill & Commit (100000)",
+			desc:     "Fill & Commit (100000)",
 			trieSize: 100000,
 			commit:   true,
 		},
 		{
-			name:     "Fill (500000)",
+			desc:     "Fill (500000)",
 			trieSize: 500000,
 			commit:   false,
 		},
 		{
-			name:     "Fill & Commit (500000)",
+			desc:     "Fill & Commit (500000)",
 			trieSize: 500000,
 			commit:   true,
 		},
 		{
-			name:     "Fill (1000000)",
+			desc:     "Fill (1000000)",
 			trieSize: 1000000,
 			commit:   false,
 		},
 		{
-			name:     "Fill & Commit (1000000)",
+			desc:     "Fill & Commit (1000000)",
 			trieSize: 1000000,
 			commit:   true,
 		},
 		{
-			name:     "Fill (5000000)",
+			desc:     "Fill (5000000)",
 			trieSize: 5000000,
 			commit:   false,
 		},
 		{
-			name:     "Fill & Commit (5000000)",
+			desc:     "Fill & Commit (5000000)",
 			trieSize: 5000000,
 			commit:   true,
 		},
 		{
-			name:     "Fill (10000000)",
+			desc:     "Fill (10000000)",
 			trieSize: 10000000,
 			commit:   false,
 		},
 		{
-			name:     "Fill & Commit (10000000)",
+			desc:     "Fill & Commit (10000000)",
 			trieSize: 10000000,
 			commit:   true,
 		},
 	}
 
 	for _, tc := range testCases {
 		b.ResetTimer()
-		b.Run(tc.name, func(b *testing.B) {
+		b.Run(tc.desc, func(b *testing.B) {
 			trie := setupSMST(b, tc.trieSize)
 			b.ResetTimer()
 			b.StartTimer()
@@ -90,67 +90,67 @@ func BenchmarkSparseMerkleSumTrie_Fill(b *testing.B) {
 
 func BenchmarkSparseMerkleSumTrie_Update(b *testing.B) {
 	testCases := []struct {
-		name     string
+		desc     string
 		trieSize int
 		commit   bool
 		fn       func(*smt.SMST, uint64) error
 	}{
 		{
-			name:     "Update (Prefilled: 100000)",
+			desc:     "Update (Prefilled: 100000)",
 			trieSize: 100000,
 			commit:   false,
 			fn:       updSMST,
 		},
 		{
-			name:     "Update & Commit (Prefilled: 100000)",
+			desc:     "Update & Commit (Prefilled: 100000)",
 			trieSize: 100000,
 			commit:   true,
 			fn:       updSMST,
 		},
 		{
-			name:     "Update (Prefilled: 500000)",
+			desc:     "Update (Prefilled: 500000)",
 			trieSize: 500000,
 			commit:   false,
 			fn:       updSMST,
 		},
 		{
-			name:     "Update & Commit (Prefilled: 500000)",
+			desc:     "Update & Commit (Prefilled: 500000)",
 			trieSize: 500000,
 			commit:   true,
 			fn:       updSMST,
 		},
 		{
-			name:     "Update (Prefilled: 1000000)",
+			desc:     "Update (Prefilled: 1000000)",
 			trieSize: 1000000,
 			commit:   false,
 			fn:       updSMST,
 		},
 		{
-			name:     "Update & Commit (Prefilled: 1000000)",
+			desc:     "Update & Commit (Prefilled: 1000000)",
 			trieSize: 1000000,
 			commit:   true,
 			fn:       updSMST,
 		},
 		{
-			name:     "Update (Prefilled: 5000000)",
+			desc:     "Update (Prefilled: 5000000)",
 			trieSize: 5000000,
 			commit:   false,
 			fn:       updSMST,
 		},
 		{
-			name:     "Update & Commit (Prefilled: 5000000)",
+			desc:     "Update & Commit (Prefilled: 5000000)",
 			trieSize: 5000000,
 			commit:   true,
 			fn:       updSMST,
 		},
 		{
-			name:     "Update (Prefilled: 10000000)",
+			desc:     "Update (Prefilled: 10000000)",
 			trieSize: 10000000,
 			commit:   false,
 			fn:       updSMST,
 		},
 		{
-			name:     "Update & Commit (Prefilled: 10000000)",
+			desc:     "Update & Commit (Prefilled: 10000000)",
 			trieSize: 10000000,
 			commit:   true,
 			fn:       updSMST,
@@ -159,7 +159,7 @@ func BenchmarkSparseMerkleSumTrie_Update(b *testing.B) {
 
 	for _, tc := range testCases {
 		b.ResetTimer()
-		b.Run(tc.name, func(b *testing.B) {
+		b.Run(tc.desc, func(b *testing.B) {
 			trie := setupSMST(b, tc.trieSize)
 			benchmarkSMST(b, trie, tc.commit, tc.fn)
 		})
@@ -168,37 +168,37 @@ func BenchmarkSparseMerkleSumTrie_Update(b *testing.B) {
 
 func BenchmarkSparseMerkleSumTrie_Get(b *testing.B) {
 	testCases := []struct {
-		name     string
+		desc     string
 		trieSize int
 		commit   bool
 		fn       func(*smt.SMST, uint64) error
 	}{
 		{
-			name:     "Get (Prefilled: 100000)",
+			desc:     "Get (Prefilled: 100000)",
 			trieSize: 100000,
 			commit:   false,
 			fn:       getSMST,
 		},
 		{
-			name:     "Get (Prefilled: 500000)",
+			desc:     "Get (Prefilled: 500000)",
 			trieSize: 500000,
 			commit:   false,
 			fn:       getSMST,
 		},
 		{
-			name:     "Get (Prefilled: 1000000)",
+			desc:     "Get (Prefilled: 1000000)",
 			trieSize: 1000000,
 			commit:   false,
 			fn:       getSMST,
 		},
 		{
-			name:     "Get (Prefilled: 5000000)",
+			desc:     "Get (Prefilled: 5000000)",
 			trieSize: 5000000,
 			commit:   false,
 			fn:       getSMST,
 		},
 		{
-			name:     "Get (Prefilled: 10000000)",
+			desc:     "Get (Prefilled: 10000000)",
 			trieSize: 10000000,
 			commit:   false,
 			fn:       getSMST,
@@ -207,7 +207,7 @@ func BenchmarkSparseMerkleSumTrie_Get(b *testing.B) {
 
 	for _, tc := range testCases {
 		b.ResetTimer()
-		b.Run(tc.name, func(b *testing.B) {
+		b.Run(tc.desc, func(b *testing.B) {
 			trie := setupSMST(b, tc.trieSize)
 			benchmarkSMST(b, trie, tc.commit, tc.fn)
 		})
@@ -216,25 +216,25 @@ func BenchmarkSparseMerkleSumTrie_Get(b *testing.B) {
 
 func BenchmarkSparseMerkleSumTrie_Prove(b *testing.B) {
 	testCases := []struct {
-		name     string
+		desc     string
 		trieSize int
 		commit   bool
 		fn       func(*smt.SMST, uint64) error
 	}{
 		{
-			name:     "Prove (Prefilled: 100000)",
+			desc:     "Prove (Prefilled: 100000)",
 			trieSize: 100000,
 			commit:   false,
 			fn:       proSMST,
 		},
 		{
-			name:     "Prove (Prefilled: 500000)",
+			desc:     "Prove (Prefilled: 500000)",
 			trieSize: 500000,
 			commit:   false,
 			fn:       proSMST,
 		},
 		{
-			name:     "Prove (Prefilled: 1000000)",
+			desc:     "Prove (Prefilled: 1000000)",
 			trieSize: 1000000,
 			commit:   false,
 			fn:       proSMST,