ipld-eth-server/pkg/repositories/testing/helpers.go

package testing

import (
	"sort"

	"github.com/8thlight/vulcanizedb/pkg/core"
	"github.com/8thlight/vulcanizedb/pkg/repositories"
	. "github.com/onsi/ginkgo"
	. "github.com/onsi/gomega"
)

func ClearData(postgres repositories.Postgres) {
	postgres.Db.MustExec("DELETE FROM watched_contracts")
	postgres.Db.MustExec("DELETE FROM transactions")
	postgres.Db.MustExec("DELETE FROM blocks")
	postgres.Db.MustExec("DELETE FROM logs")
}

func AssertRepositoryBehavior(buildRepository func(node core.Node) repositories.Repository) {
	var repository repositories.Repository

	BeforeEach(func() {
		node := core.Node{GenesisBlock: "GENESIS", NetworkId: 1}
		repository = buildRepository(node)
	})

	Describe("Saving blocks", func() {
		It("starts with no blocks", func() {
			count := repository.BlockCount()
			Expect(count).Should(Equal(0))
		})

		It("increments the block count", func() {
			block := core.Block{Number: 123}

			repository.CreateBlock(block)

			Expect(repository.BlockCount()).To(Equal(1))
		})

		It("associates blocks to a node", func() {
			block := core.Block{
				Number: 123,
			}
			repository.CreateBlock(block)
			nodeTwo := core.Node{
				GenesisBlock: "0x456",
				NetworkId:    1,
			}
			repositoryTwo := buildRepository(nodeTwo)

			_, err := repositoryTwo.FindBlockByNumber(123)
			Expect(err).To(HaveOccurred())
		})

		It("saves the attributes of the block", func() {
			blockNumber := int64(123)
			gasLimit := int64(1000000)
			gasUsed := int64(10)
			blockHash := "x123"
			blockParentHash := "x456"
			blockNonce := "0x881db2ca900682e9a9"
			blockTime := int64(1508981640)
			uncleHash := "x789"
			blockSize := int64(1000)
			difficulty := int64(10)
			block := core.Block{
				Difficulty: difficulty,
				GasLimit:   gasLimit,
				GasUsed:    gasUsed,
				Hash:       blockHash,
				Nonce:      blockNonce,
				Number:     blockNumber,
				ParentHash: blockParentHash,
				Size:       blockSize,
				Time:       blockTime,
				UncleHash:  uncleHash,
			}

			repository.CreateBlock(block)

			savedBlock, err := repository.FindBlockByNumber(blockNumber)
			Expect(err).NotTo(HaveOccurred())
			Expect(savedBlock.Difficulty).To(Equal(difficulty))
			Expect(savedBlock.GasLimit).To(Equal(gasLimit))
			Expect(savedBlock.GasUsed).To(Equal(gasUsed))
			Expect(savedBlock.Hash).To(Equal(blockHash))
			Expect(savedBlock.Nonce).To(Equal(blockNonce))
			Expect(savedBlock.Number).To(Equal(blockNumber))
			Expect(savedBlock.ParentHash).To(Equal(blockParentHash))
			Expect(savedBlock.Size).To(Equal(blockSize))
			Expect(savedBlock.Time).To(Equal(blockTime))
			Expect(savedBlock.UncleHash).To(Equal(uncleHash))
		})

		It("does not find a block when searching for a number that does not exist", func() {
			_, err := repository.FindBlockByNumber(111)

			Expect(err).To(HaveOccurred())
		})

		It("saves one transaction associated to the block", func() {
			block := core.Block{
				Number:       123,
				Transactions: []core.Transaction{{}},
			}

			repository.CreateBlock(block)

			savedBlock, _ := repository.FindBlockByNumber(123)
			Expect(len(savedBlock.Transactions)).To(Equal(1))
		})

		It("saves two transactions associated to the block", func() {
			block := core.Block{
				Number:       123,
				Transactions: []core.Transaction{{}, {}},
			}

			repository.CreateBlock(block)

			savedBlock, _ := repository.FindBlockByNumber(123)
			Expect(len(savedBlock.Transactions)).To(Equal(2))
		})

		It("saves the attributes associated to a transaction", func() {
			gasLimit := int64(5000)
			gasPrice := int64(3)
			nonce := uint64(10000)
			to := "1234567890"
			from := "0987654321"
			value := int64(10)
			transaction := core.Transaction{
				Hash:     "x1234",
				GasPrice: gasPrice,
				GasLimit: gasLimit,
				Nonce:    nonce,
				To:       to,
				From:     from,
				Value:    value,
			}
			block := core.Block{
				Number:       123,
				Transactions: []core.Transaction{transaction},
			}

			repository.CreateBlock(block)

			savedBlock, _ := repository.FindBlockByNumber(123)
			Expect(len(savedBlock.Transactions)).To(Equal(1))
			savedTransaction := savedBlock.Transactions[0]
			Expect(savedTransaction.Hash).To(Equal(transaction.Hash))
			Expect(savedTransaction.To).To(Equal(to))
			Expect(savedTransaction.From).To(Equal(from))
			Expect(savedTransaction.Nonce).To(Equal(nonce))
			Expect(savedTransaction.GasLimit).To(Equal(gasLimit))
			Expect(savedTransaction.GasPrice).To(Equal(gasPrice))
			Expect(savedTransaction.Value).To(Equal(value))
		})

	})

	Describe("The missing block numbers", func() {
		It("is empty the starting block number is the highest known block number", func() {
			repository.CreateBlock(core.Block{Number: 1})

			Expect(len(repository.MissingBlockNumbers(1, 1))).To(Equal(0))
		})

		It("is the only missing block number", func() {
			repository.CreateBlock(core.Block{Number: 2})

			Expect(repository.MissingBlockNumbers(1, 2)).To(Equal([]int64{1}))
		})

		It("is both missing block numbers", func() {
			repository.CreateBlock(core.Block{Number: 3})

			Expect(repository.MissingBlockNumbers(1, 3)).To(Equal([]int64{1, 2}))
		})

		It("goes back to the starting block number", func() {
			repository.CreateBlock(core.Block{Number: 6})

			Expect(repository.MissingBlockNumbers(4, 6)).To(Equal([]int64{4, 5}))
		})

		It("only includes missing block numbers", func() {
			repository.CreateBlock(core.Block{Number: 4})
			repository.CreateBlock(core.Block{Number: 6})

			Expect(repository.MissingBlockNumbers(4, 6)).To(Equal([]int64{5}))
		})

		It("is a list with multiple gaps", func() {
			repository.CreateBlock(core.Block{Number: 4})
			repository.CreateBlock(core.Block{Number: 5})
			repository.CreateBlock(core.Block{Number: 8})
			repository.CreateBlock(core.Block{Number: 10})

			Expect(repository.MissingBlockNumbers(3, 10)).To(Equal([]int64{3, 6, 7, 9}))
		})

		It("returns empty array when lower bound exceeds upper bound", func() {
			Expect(repository.MissingBlockNumbers(10000, 1)).To(Equal([]int64{}))
		})

		It("only returns requested range even when other gaps exist", func() {
			repository.CreateBlock(core.Block{Number: 3})
			repository.CreateBlock(core.Block{Number: 8})

			Expect(repository.MissingBlockNumbers(1, 5)).To(Equal([]int64{1, 2, 4, 5}))
		})
	})

	Describe("The max block numbers", func() {
		It("returns the block number when a single block", func() {
			repository.CreateBlock(core.Block{Number: 1})

			Expect(repository.MaxBlockNumber()).To(Equal(int64(1)))
		})

		It("returns highest known block number when multiple blocks", func() {
			repository.CreateBlock(core.Block{Number: 1})
			repository.CreateBlock(core.Block{Number: 10})

			Expect(repository.MaxBlockNumber()).To(Equal(int64(10)))
		})
	})

	Describe("Creating contracts", func() {
		It("returns the contract when it exists", func() {
			repository.CreateContract(core.Contract{Hash: "x123"})

			contract, err := repository.FindContract("x123")
			Expect(err).NotTo(HaveOccurred())
			Expect(contract.Hash).To(Equal("x123"))

			Expect(repository.ContractExists("x123")).To(BeTrue())
			Expect(repository.ContractExists("x456")).To(BeFalse())
		})

		It("returns err if contract does not exist", func() {
			_, err := repository.FindContract("x123")
			Expect(err).To(HaveOccurred())
		})

		It("returns empty array when no transactions 'To' a contract", func() {
			repository.CreateContract(core.Contract{Hash: "x123"})
			contract, err := repository.FindContract("x123")
			Expect(err).ToNot(HaveOccurred())
			Expect(contract.Transactions).To(BeEmpty())
		})

		It("returns transactions 'To' a contract", func() {
			block := core.Block{
				Number: 123,
				Transactions: []core.Transaction{
					{Hash: "TRANSACTION1", To: "x123"},
					{Hash: "TRANSACTION2", To: "x345"},
					{Hash: "TRANSACTION3", To: "x123"},
				},
			}
			repository.CreateBlock(block)

			repository.CreateContract(core.Contract{Hash: "x123"})
			contract, err := repository.FindContract("x123")
			Expect(err).ToNot(HaveOccurred())
			Expect(contract.Transactions).To(
				Equal([]core.Transaction{
					{Hash: "TRANSACTION1", To: "x123"},
					{Hash: "TRANSACTION3", To: "x123"},
				}))
		})

		It("stores the ABI of the contract", func() {
			repository.CreateContract(core.Contract{
				Abi:  "{\"some\": \"json\"}",
				Hash: "x123",
			})
			contract, err := repository.FindContract("x123")
			Expect(err).ToNot(HaveOccurred())
			Expect(contract.Abi).To(Equal("{\"some\": \"json\"}"))
		})

		It("updates the ABI of the contract if hash already present", func() {
			repository.CreateContract(core.Contract{
				Abi:  "{\"some\": \"json\"}",
				Hash: "x123",
			})
			repository.CreateContract(core.Contract{
				Abi:  "{\"some\": \"different json\"}",
				Hash: "x123",
			})
			contract, err := repository.FindContract("x123")
			Expect(err).ToNot(HaveOccurred())
			Expect(contract.Abi).To(Equal("{\"some\": \"different json\"}"))
		})
	})

	Describe("Saving logs", func() {
		It("returns the log when it exists", func() {
			repository.CreateLogs([]core.Log{{
				BlockNumber: 1,
				Index:       0,
				Address:     "x123",
				TxHash:      "x456",
				Topics:      map[int]string{0: "x777", 1: "x888", 2: "x999"},
				Data:        "xabc",
			}},
			)

			log := repository.FindLogs("x123", 1)

			Expect(log).NotTo(BeNil())
			Expect(log[0].BlockNumber).To(Equal(int64(1)))
			Expect(log[0].Address).To(Equal("x123"))
			Expect(log[0].Index).To(Equal(int64(0)))
			Expect(log[0].TxHash).To(Equal("x456"))
			Expect(log[0].Topics[0]).To(Equal("x777"))
			Expect(log[0].Topics[1]).To(Equal("x888"))
			Expect(log[0].Topics[2]).To(Equal("x999"))
			Expect(log[0].Data).To(Equal("xabc"))
		})

		It("returns nil if log does not exist", func() {
			log := repository.FindLogs("x123", 1)
			Expect(log).To(BeNil())
		})

		It("updates the log when log with when log with same block number and index is already present", func() {
			repository.CreateLogs([]core.Log{{
				BlockNumber: 1,
				Index:       0,
				Address:     "x123",
				TxHash:      "x456",
				Topics:      map[int]string{0: "x777", 1: "x888", 2: "x999"},
				Data:        "xABC",
			},
			})
			repository.CreateLogs([]core.Log{{
				BlockNumber: 1,
				Index:       0,
				Address:     "x123",
				TxHash:      "x456",
				Topics:      map[int]string{0: "x777", 1: "x888", 2: "x999"},
				Data:        "xXYZ",
			},
			})

			log := repository.FindLogs("x123", 1)
			Expect(log[0].Data).To(Equal("xXYZ"))
		})

		It("filters to the correct block number and address", func() {
			repository.CreateLogs([]core.Log{{
				BlockNumber: 1,
				Index:       0,
				Address:     "x123",
				TxHash:      "x456",
				Topics:      map[int]string{0: "x777", 1: "x888", 2: "x999"},
				Data:        "xabc",
			}},
			)
			repository.CreateLogs([]core.Log{{
				BlockNumber: 1,
				Index:       1,
				Address:     "x123",
				TxHash:      "x789",
				Topics:      map[int]string{0: "x111", 1: "x222", 2: "x333"},
				Data:        "xdef",
			}},
			)
			repository.CreateLogs([]core.Log{{
				BlockNumber: 2,
				Index:       0,
				Address:     "x123",
				TxHash:      "x456",
				Topics:      map[int]string{0: "x777", 1: "x888", 2: "x999"},
				Data:        "xabc",
			}},
			)

			log := repository.FindLogs("x123", 1)

			type logIndex struct {
				blockNumber int64
				Index       int64
			}
			var uniqueBlockNumbers []logIndex
			for _, log := range log {
				uniqueBlockNumbers = append(uniqueBlockNumbers,
					logIndex{log.BlockNumber, log.Index})
			}
			sort.Slice(uniqueBlockNumbers, func(i, j int) bool {
				if uniqueBlockNumbers[i].blockNumber < uniqueBlockNumbers[j].blockNumber {
					return true
				}
				if uniqueBlockNumbers[i].blockNumber > uniqueBlockNumbers[j].blockNumber {
					return false
				}
				return uniqueBlockNumbers[i].Index < uniqueBlockNumbers[j].Index
			})

			Expect(log).NotTo(BeNil())
			Expect(len(log)).To(Equal(2))
			Expect(uniqueBlockNumbers).To(Equal(
				[]logIndex{
					{blockNumber: 1, Index: 0},
					{blockNumber: 1, Index: 1}},
			))
		})
	})
}