Add tests for plugin helpers

- Prevents code analysis from showing functions as unused
- Also address other code analysis issues

libraries/shared/README.md

@@ -0,0 +1,8 @@
+# Shared Tools
+
+## Description
+Code that is useful for or used by plugins writeen on top of VulcanizeDB.
+
+## Note
+Much code in this directory may not be used outside of the tests, but don't delete it - it could be used by a plugin.
+Renaming and/or deleting functions in this namespace requires a version bump to avoid breaking plugins.

libraries/shared/chunker/log_chunker_test.go

@@ -58,9 +58,9 @@ var _ = Describe("Log chunker", func() {
 	Describe("initialisation", func() {
 		It("creates lookup maps correctly", func() {
 			Expect(chunker.AddressToNames).To(Equal(map[string][]string{
-				"0x00000000000000000000000000000000000000a1": []string{"TransformerA"},
-				"0x00000000000000000000000000000000000000a2": []string{"TransformerA", "TransformerC"},
-				"0x00000000000000000000000000000000000000b1": []string{"TransformerB"},
+				"0x00000000000000000000000000000000000000a1": {"TransformerA"},
+				"0x00000000000000000000000000000000000000a2": {"TransformerA", "TransformerC"},
+				"0x00000000000000000000000000000000000000b1": {"TransformerB"},
 			}))
 
 			Expect(chunker.NameToTopic0).To(Equal(map[string]common.Hash{

libraries/shared/constants/data.go

@@ -18,5 +18,6 @@ package constants
 
 var DataItemLength = 32
 
-// TODO Grab this from DB, since it can change through governance
+// TODO: Move to Plugin
+// TODO: Grab this from DB, since it can change through governance
 var TTL = int64(10800) // 60 * 60 * 3 == 10800 seconds == 3 hours

libraries/shared/repository/repository.go

@@ -156,6 +156,7 @@ func CreateNotCheckedSQL(boolColumns []string, recheckHeaders constants.Transfor
 	return result.String()
 }
 
+// TODO: Move to plugin
 func GetTicInTx(headerID int64, tx *sql.Tx) (int64, error) {
 	var blockTimestamp int64
 	err := tx.QueryRow(`SELECT block_timestamp FROM public.headers WHERE id = $1;`, headerID).Scan(&blockTimestamp)

libraries/shared/repository/repository_test.go

@@ -19,6 +19,7 @@ package repository_test
 import (
 	"fmt"
 	"math/rand"
+	"strconv"
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
@@ -34,7 +35,83 @@ import (
 	"github.com/vulcanize/vulcanizedb/test_config"
 )
 
-var _ = Describe("Repository utilities", func() {
+var _ = Describe("Repository", func() {
+	Describe("MarkHeaderChecked", func() {
+		var (
+			checkedHeadersColumn string
+			db                   *postgres.DB
+		)
+
+		BeforeEach(func() {
+			db = test_config.NewTestDB(test_config.NewTestNode())
+			test_config.CleanTestDB(db)
+
+			checkedHeadersColumn = "test_column_checked"
+			_, migrateErr := db.Exec(`ALTER TABLE public.checked_headers
+				ADD COLUMN ` + checkedHeadersColumn + ` integer`)
+			Expect(migrateErr).NotTo(HaveOccurred())
+		})
+
+		AfterEach(func() {
+			_, cleanupMigrateErr := db.Exec(`ALTER TABLE public.checked_headers DROP COLUMN ` + checkedHeadersColumn)
+			Expect(cleanupMigrateErr).NotTo(HaveOccurred())
+		})
+
+		It("marks passed column as checked for passed header", func() {
+			headerRepository := repositories.NewHeaderRepository(db)
+			headerID, headerErr := headerRepository.CreateOrUpdateHeader(fakes.FakeHeader)
+			Expect(headerErr).NotTo(HaveOccurred())
+
+			err := shared.MarkHeaderChecked(headerID, db, checkedHeadersColumn)
+
+			Expect(err).NotTo(HaveOccurred())
+			var checkedCount int
+			fetchErr := db.Get(&checkedCount, `SELECT `+checkedHeadersColumn+` FROM public.checked_headers LIMIT 1`)
+			Expect(fetchErr).NotTo(HaveOccurred())
+			Expect(checkedCount).To(Equal(1))
+		})
+	})
+
+	Describe("MarkHeaderCheckedInTransaction", func() {
+		var (
+			checkedHeadersColumn string
+			db                   *postgres.DB
+		)
+
+		BeforeEach(func() {
+			db = test_config.NewTestDB(test_config.NewTestNode())
+			test_config.CleanTestDB(db)
+
+			checkedHeadersColumn = "test_column_checked"
+			_, migrateErr := db.Exec(`ALTER TABLE public.checked_headers
+				ADD COLUMN ` + checkedHeadersColumn + ` integer`)
+			Expect(migrateErr).NotTo(HaveOccurred())
+		})
+
+		AfterEach(func() {
+			_, cleanupMigrateErr := db.Exec(`ALTER TABLE public.checked_headers DROP COLUMN ` + checkedHeadersColumn)
+			Expect(cleanupMigrateErr).NotTo(HaveOccurred())
+		})
+
+		It("marks passed column as checked for passed header within a passed transaction", func() {
+			headerRepository := repositories.NewHeaderRepository(db)
+			headerID, headerErr := headerRepository.CreateOrUpdateHeader(fakes.FakeHeader)
+			Expect(headerErr).NotTo(HaveOccurred())
+			tx, txErr := db.Begin()
+			Expect(txErr).NotTo(HaveOccurred())
+
+			err := shared.MarkHeaderCheckedInTransaction(headerID, tx, checkedHeadersColumn)
+
+			Expect(err).NotTo(HaveOccurred())
+			commitErr := tx.Commit()
+			Expect(commitErr).NotTo(HaveOccurred())
+			var checkedCount int
+			fetchErr := db.Get(&checkedCount, `SELECT `+checkedHeadersColumn+` FROM public.checked_headers LIMIT 1`)
+			Expect(fetchErr).NotTo(HaveOccurred())
+			Expect(checkedCount).To(Equal(1))
+		})
+	})
+
 	Describe("MissingHeaders", func() {
 		var (
 			db                       *postgres.DB
@@ -116,6 +193,84 @@ var _ = Describe("Repository utilities", func() {
 		})
 	})
 
+	Describe("RecheckHeaders", func() {
+		var (
+			checkedHeadersColumn                                      string
+			db                                                        *postgres.DB
+			headerOneID, headerTwoID, headerThreeID, headerFourID     int64
+			headerOneErr, headerTwoErr, headerThreeErr, headerFourErr error
+		)
+
+		BeforeEach(func() {
+			db = test_config.NewTestDB(test_config.NewTestNode())
+			test_config.CleanTestDB(db)
+
+			// create header checked column
+			checkedHeadersColumn = "test_column_checked"
+			_, migrateErr := db.Exec(`ALTER TABLE public.checked_headers ADD COLUMN ` + checkedHeadersColumn + ` integer`)
+			Expect(migrateErr).NotTo(HaveOccurred())
+
+			// create headers
+			headerRepository := repositories.NewHeaderRepository(db)
+			headerOneID, headerOneErr = headerRepository.CreateOrUpdateHeader(fakes.GetFakeHeader(1))
+			Expect(headerOneErr).NotTo(HaveOccurred())
+			headerTwoID, headerTwoErr = headerRepository.CreateOrUpdateHeader(fakes.GetFakeHeader(2))
+			Expect(headerTwoErr).NotTo(HaveOccurred())
+			headerThreeID, headerThreeErr = headerRepository.CreateOrUpdateHeader(fakes.GetFakeHeader(3))
+			Expect(headerThreeErr).NotTo(HaveOccurred())
+			headerFourID, headerFourErr = headerRepository.CreateOrUpdateHeader(fakes.GetFakeHeader(4))
+			Expect(headerFourErr).NotTo(HaveOccurred())
+
+			// mark every header checked at least once, with one fully rechecked (headerThree)
+			maxCheckCount, intConversionErr := strconv.Atoi(constants.RecheckHeaderCap)
+			Expect(intConversionErr).NotTo(HaveOccurred())
+			_, markHeaderOneCheckedErr := db.Exec(
+				`INSERT INTO public.checked_headers (header_id, `+checkedHeadersColumn+`) VALUES ($1, $2)`,
+				headerOneID, maxCheckCount)
+			Expect(markHeaderOneCheckedErr).NotTo(HaveOccurred())
+			_, markHeaderTwoCheckedErr := db.Exec(
+				`INSERT INTO public.checked_headers (header_id, `+checkedHeadersColumn+`) VALUES ($1, $2)`,
+				headerTwoID, maxCheckCount)
+			Expect(markHeaderTwoCheckedErr).NotTo(HaveOccurred())
+			_, markHeaderThreeCheckedErr := db.Exec(
+				`INSERT INTO public.checked_headers (header_id, `+checkedHeadersColumn+`) VALUES ($1, $2)`,
+				headerThreeID, maxCheckCount+1)
+			Expect(markHeaderThreeCheckedErr).NotTo(HaveOccurred())
+			_, markHeaderFourCheckedErr := db.Exec(
+				`INSERT INTO public.checked_headers (header_id, `+checkedHeadersColumn+`) VALUES ($1, $2)`,
+				headerFourID, maxCheckCount)
+			Expect(markHeaderFourCheckedErr).NotTo(HaveOccurred())
+		})
+
+		AfterEach(func() {
+			_, cleanupMigrateErr := db.Exec(`ALTER TABLE public.checked_headers DROP COLUMN ` + checkedHeadersColumn)
+			Expect(cleanupMigrateErr).NotTo(HaveOccurred())
+		})
+
+		Describe("when no ending block number (ending block number == -1)", func() {
+			It("returns all headers since starting block where checked count is less than cap", func() {
+				headers, err := shared.RecheckHeaders(1, -1, db, checkedHeadersColumn)
+
+				Expect(err).NotTo(HaveOccurred())
+				Expect(len(headers)).To(Equal(3))
+				Expect(headers[0].Id).To(Or(Equal(headerOneID), Equal(headerTwoID), Equal(headerFourID)))
+				Expect(headers[1].Id).To(Or(Equal(headerOneID), Equal(headerTwoID), Equal(headerFourID)))
+				Expect(headers[2].Id).To(Or(Equal(headerOneID), Equal(headerTwoID), Equal(headerFourID)))
+			})
+		})
+
+		Describe("when ending block number specified", func() {
+			It("returns headers between starting and ending block where checked count is less than cap", func() {
+				headers, err := shared.RecheckHeaders(1, 3, db, checkedHeadersColumn)
+
+				Expect(err).NotTo(HaveOccurred())
+				Expect(len(headers)).To(Equal(2))
+				Expect(headers[0].Id).To(Or(Equal(headerOneID), Equal(headerTwoID)))
+				Expect(headers[1].Id).To(Or(Equal(headerOneID), Equal(headerTwoID)))
+			})
+		})
+	})
+
 	Describe("GetCheckedColumnNames", func() {
 		It("gets the column names from checked_headers", func() {
 			db := test_config.NewTestDB(test_config.NewTestNode())
@@ -162,33 +317,9 @@ var _ = Describe("Repository utilities", func() {
 
 func getExpectedColumnNames() []string {
 	return []string{
-		"price_feeds_checked",
-		"flip_kick_checked",
-		"frob_checked",
-		"tend_checked",
-		"bite_checked",
-		"dent_checked",
-		"pit_file_debt_ceiling_checked",
-		"pit_file_ilk_checked",
-		"vat_init_checked",
-		"drip_file_ilk_checked",
-		"drip_file_repo_checked",
-		"drip_file_vow_checked",
-		"deal_checked",
-		"drip_drip_checked",
-		"cat_file_chop_lump_checked",
-		"cat_file_flip_checked",
-		"cat_file_pit_vow_checked",
-		"flop_kick_checked",
-		"vat_move_checked",
-		"vat_fold_checked",
-		"vat_heal_checked",
-		"vat_toll_checked",
-		"vat_tune_checked",
-		"vat_grab_checked",
-		"vat_flux_checked",
-		"vat_slip_checked",
-		"vow_flog_checked",
-		"flap_kick_checked",
+		"column_1_checked",
+		"column_2_checked",
+		"column_3_checked",
+		"column_4_checked",
 	}
 }

libraries/shared/storage/mappings_test.go

@@ -0,0 +1,68 @@
+package storage_test
+
+import (
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/crypto"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+	"github.com/vulcanize/vulcanizedb/libraries/shared/storage"
+	"math/big"
+)
+
+var _ = Describe("Mappings", func() {
+	Describe("GetMapping", func() {
+		It("returns the storage key for a mapping when passed the mapping's index on the contract and the desired value's key", func() {
+			// ex. solidity:
+			//    	mapping (bytes32 => uint) public amounts
+			// pass in the index of the mapping on the contract + the bytes32 key for the uint val being looked up
+			indexOfMappingOnContract := storage.IndexZero
+			keyForDesiredValueInMapping := "fake_bytes32"
+
+			storageKey := storage.GetMapping(indexOfMappingOnContract, keyForDesiredValueInMapping)
+
+			expectedStorageKeyBytes := crypto.Keccak256(common.FromHex(keyForDesiredValueInMapping + indexOfMappingOnContract))
+			expectedStorageKey := common.BytesToHash(expectedStorageKeyBytes)
+			Expect(storageKey).To(Equal(expectedStorageKey))
+		})
+	})
+
+	Describe("GetNestedMapping", func() {
+		It("returns the storage key for a nested mapping when passed the mapping's index on the contract and the desired value's keys", func() {
+			// ex. solidity:
+			//    	mapping (address => mapping (uint => bytes32)) public addressNames
+			// pass in the index of the mapping on the contract + the address and uint keys for the bytes32 val being looked up
+			indexOfMappingOnContract := storage.IndexOne
+			keyForOuterMapping := "fake_address"
+			keyForInnerMapping := "123"
+
+			storageKey := storage.GetNestedMapping(indexOfMappingOnContract, keyForOuterMapping, keyForInnerMapping)
+
+			hashedOuterMappingStorageKey := crypto.Keccak256(common.FromHex(keyForOuterMapping + indexOfMappingOnContract))
+			fullStorageKeyBytes := crypto.Keccak256(common.FromHex(keyForInnerMapping), hashedOuterMappingStorageKey)
+			expectedStorageKey := common.BytesToHash(fullStorageKeyBytes)
+			Expect(storageKey).To(Equal(expectedStorageKey))
+		})
+	})
+
+	Describe("GetIncrementedKey", func() {
+		It("returns the storage key for later values sharing an index on the contract with other earlier values", func() {
+			// ex. solidity:
+			//    	struct Data {
+			//        uint256 quantity;
+			//        uint256 quality;
+			//    	}
+			//    	mapping (bytes32 => Data) public itemData;
+			// pass in the storage key for the zero-indexed value ("quantity") + the number of increments required.
+			// (For "quality", we must increment the storage key for the corresponding "quantity" by 1).
+			indexOfMappingOnContract := storage.IndexTwo
+			keyForDesiredValueInMapping := "fake_bytes32"
+			storageKeyForFirstPropertyOnStruct := storage.GetMapping(indexOfMappingOnContract, keyForDesiredValueInMapping)
+
+			storageKey := storage.GetIncrementedKey(storageKeyForFirstPropertyOnStruct, 1)
+
+			incrementedStorageKey := storageKeyForFirstPropertyOnStruct.Big().Add(storageKeyForFirstPropertyOnStruct.Big(), big.NewInt(1))
+			expectedStorageKey := common.BytesToHash(incrementedStorageKey.Bytes())
+			Expect(storageKey).To(Equal(expectedStorageKey))
+		})
+	})
+})

libraries/shared/storage/utils/value_test.go

@@ -0,0 +1,22 @@
+package utils_test
+
+import (
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+	"github.com/vulcanize/vulcanizedb/libraries/shared/storage/utils"
+)
+
+var _ = Describe("Storage value metadata getter", func() {
+	It("returns a storage value metadata instance with corresponding fields assigned", func() {
+		metadataName := "fake_name"
+		metadataKeys := map[utils.Key]string{"key": "value"}
+		metadataType := utils.Uint256
+
+		expectedMetadata := utils.StorageValueMetadata{
+			Name: metadataName,
+			Keys: metadataKeys,
+			Type: metadataType,
+		}
+		Expect(utils.GetStorageValueMetadata(metadataName, metadataKeys, metadataType)).To(Equal(expectedMetadata))
+	})
+})

libraries/shared/test_data/generic.go

@@ -49,7 +49,7 @@ var GenericTestConfig = transformer.TransformerConfig{
 }
 
 func randomString(length int) string {
-	var seededRand *rand.Rand = rand.New(
+	var seededRand = rand.New(
 		rand.NewSource(time.Now().UnixNano()))
 	charset := "abcdefghijklmnopqrstuvwxyz1234567890"
 	b := make([]byte, length)

libraries/shared/watcher/storage_watcher.go

@@ -50,8 +50,8 @@ func NewStorageWatcher(tailer fs.Tailer, db *postgres.DB) StorageWatcher {
 
 func (watcher StorageWatcher) AddTransformers(initializers []transformer.StorageTransformerInitializer) {
 	for _, initializer := range initializers {
-		transformer := initializer(watcher.db)
-		watcher.Transformers[transformer.ContractAddress()] = transformer
+		storageTransformer := initializer(watcher.db)
+		watcher.Transformers[storageTransformer.ContractAddress()] = storageTransformer
 	}
 }
 
@@ -65,12 +65,12 @@ func (watcher StorageWatcher) Execute() error {
 		if parseErr != nil {
 			return parseErr
 		}
-		transformer, ok := watcher.Transformers[row.Contract]
+		storageTransformer, ok := watcher.Transformers[row.Contract]
 		if !ok {
 			logrus.Warn(utils.ErrContractNotFound{Contract: row.Contract.Hex()}.Error())
 			continue
 		}
-		executeErr := transformer.Execute(row)
+		executeErr := storageTransformer.Execute(row)
 		if executeErr != nil {
 			if isKeyNotFound(executeErr) {
 				queueErr := watcher.Queue.Add(row)