Add Pit file stability fee event

- file event on the pit contract is overloaded and each implementation logs a note - existing Pit file transformer now specified as dealing with ilks
2018-09-05 11:36:13 -05:00
parent a30e5036fd
commit e1f609528d
31 changed files with 858 additions and 211 deletions
@@ -0,0 +1,27 @@
+package stability_fee
+
+import (
+	"bytes"
+	"encoding/json"
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/core/types"
+)
+
+type Converter interface {
+	ToModel(contractAddress string, contractAbi string, ethLog types.Log) (PitFileStabilityFeeModel, error)
+}
+
+type PitFileStabilityFeeConverter struct{}
+
+func (PitFileStabilityFeeConverter) ToModel(contractAddress string, contractAbi string, ethLog types.Log) (PitFileStabilityFeeModel, error) {
+	what := string(bytes.Trim(ethLog.Topics[2].Bytes(), "\x00"))
+	data := common.HexToAddress(ethLog.Topics[1].String()).Hex()
+
+	raw, err := json.Marshal(ethLog)
+	return PitFileStabilityFeeModel{
+		What:             what,
+		Data:             data,
+		TransactionIndex: ethLog.TxIndex,
+		Raw:              raw,
+	}, err
+}
@@ -0,0 +1,20 @@
+package stability_fee_test
+
+import (
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+	"github.com/vulcanize/vulcanizedb/pkg/transformers/pit_file/stability_fee"
+	"github.com/vulcanize/vulcanizedb/pkg/transformers/shared"
+	"github.com/vulcanize/vulcanizedb/pkg/transformers/test_data"
+)
+
+var _ = Describe("Pit file stability fee converter", func() {
+	It("converts a log to an model", func() {
+		converter := stability_fee.PitFileStabilityFeeConverter{}
+
+		model, err := converter.ToModel(test_data.PitAddress, shared.PitABI, test_data.EthPitFileStabilityFeeLog)
+
+		Expect(err).NotTo(HaveOccurred())
+		Expect(model).To(Equal(test_data.PitFileStabilityFeeModel))
+	})
+})
@@ -0,0 +1,8 @@
+package stability_fee
+
+type PitFileStabilityFeeModel struct {
+	What             string
+	Data             string
+	TransactionIndex uint   `db:"tx_idx"`
+	Raw              []byte `db:"raw_log"`
+}
@@ -0,0 +1,48 @@
+package stability_fee
+
+import (
+	"github.com/vulcanize/vulcanizedb/pkg/core"
+	"github.com/vulcanize/vulcanizedb/pkg/datastore/postgres"
+)
+
+type Repository interface {
+	Create(headerID int64, model PitFileStabilityFeeModel) error
+	MissingHeaders(startingBlockNumber, endingBlockNumber int64) ([]core.Header, error)
+}
+
+type PitFileStabilityFeeRepository struct {
+	db *postgres.DB
+}
+
+func NewPitFileStabilityFeeRepository(db *postgres.DB) PitFileStabilityFeeRepository {
+	return PitFileStabilityFeeRepository{
+		db: db,
+	}
+}
+
+func (repository PitFileStabilityFeeRepository) Create(headerID int64, model PitFileStabilityFeeModel) error {
+	_, err := repository.db.Exec(
+		`INSERT into maker.pit_file_stability_fee (header_id, what, data, tx_idx, raw_log)
+        VALUES($1, $2, $3, $4, $5)`,
+		headerID, model.What, model.Data, model.TransactionIndex, model.Raw,
+	)
+	return err
+}
+
+func (repository PitFileStabilityFeeRepository) MissingHeaders(startingBlockNumber, endingBlockNumber int64) ([]core.Header, error) {
+	var result []core.Header
+	err := repository.db.Select(
+		&result,
+		`SELECT headers.id, headers.block_number FROM headers
+               LEFT JOIN maker.pit_file_stability_fee on headers.id = header_id
+               WHERE header_id ISNULL
+               AND headers.block_number >= $1
+               AND headers.block_number <= $2
+               AND headers.eth_node_fingerprint = $3`,
+		startingBlockNumber,
+		endingBlockNumber,
+		repository.db.Node.ID,
+	)
+
+	return result, err
+}
@@ -0,0 +1,130 @@
+package stability_fee_test
+
+import (
+	"database/sql"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+
+	"github.com/vulcanize/vulcanizedb/pkg/core"
+	"github.com/vulcanize/vulcanizedb/pkg/datastore/postgres/repositories"
+	"github.com/vulcanize/vulcanizedb/pkg/transformers/pit_file/stability_fee"
+	"github.com/vulcanize/vulcanizedb/pkg/transformers/test_data"
+	"github.com/vulcanize/vulcanizedb/test_config"
+)
+
+var _ = Describe("", func() {
+	Describe("Create", func() {
+		It("adds a pit file stability fee event", func() {
+			db := test_config.NewTestDB(core.Node{})
+			test_config.CleanTestDB(db)
+			headerRepository := repositories.NewHeaderRepository(db)
+			headerID, err := headerRepository.CreateOrUpdateHeader(core.Header{})
+			Expect(err).NotTo(HaveOccurred())
+			pitFileRepository := stability_fee.NewPitFileStabilityFeeRepository(db)
+
+			err = pitFileRepository.Create(headerID, test_data.PitFileStabilityFeeModel)
+
+			Expect(err).NotTo(HaveOccurred())
+			var dbPitFile stability_fee.PitFileStabilityFeeModel
+			err = db.Get(&dbPitFile, `SELECT what, data, tx_idx, raw_log FROM maker.pit_file_stability_fee WHERE header_id = $1`, headerID)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(dbPitFile.What).To(Equal(test_data.PitFileStabilityFeeModel.What))
+			Expect(dbPitFile.Data).To(Equal(test_data.PitFileStabilityFeeModel.Data))
+			Expect(dbPitFile.TransactionIndex).To(Equal(test_data.PitFileStabilityFeeModel.TransactionIndex))
+			Expect(dbPitFile.Raw).To(MatchJSON(test_data.PitFileStabilityFeeModel.Raw))
+		})
+
+		It("does not duplicate pit file events", func() {
+			db := test_config.NewTestDB(core.Node{})
+			test_config.CleanTestDB(db)
+			headerRepository := repositories.NewHeaderRepository(db)
+			headerID, err := headerRepository.CreateOrUpdateHeader(core.Header{})
+			Expect(err).NotTo(HaveOccurred())
+			pitFileRepository := stability_fee.NewPitFileStabilityFeeRepository(db)
+			err = pitFileRepository.Create(headerID, test_data.PitFileStabilityFeeModel)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = pitFileRepository.Create(headerID, test_data.PitFileStabilityFeeModel)
+
+			Expect(err).To(HaveOccurred())
+			Expect(err.Error()).To(ContainSubstring("pq: duplicate key value violates unique constraint"))
+		})
+
+		It("removes pit file if corresponding header is deleted", func() {
+			db := test_config.NewTestDB(core.Node{})
+			test_config.CleanTestDB(db)
+			headerRepository := repositories.NewHeaderRepository(db)
+			headerID, err := headerRepository.CreateOrUpdateHeader(core.Header{})
+			Expect(err).NotTo(HaveOccurred())
+			pitFileRepository := stability_fee.NewPitFileStabilityFeeRepository(db)
+			err = pitFileRepository.Create(headerID, test_data.PitFileStabilityFeeModel)
+			Expect(err).NotTo(HaveOccurred())
+
+			_, err = db.Exec(`DELETE FROM headers WHERE id = $1`, headerID)
+
+			Expect(err).NotTo(HaveOccurred())
+			var dbPitFile stability_fee.PitFileStabilityFeeModel
+			err = db.Get(&dbPitFile, `SELECT what, data, tx_idx, raw_log FROM maker.pit_file_stability_fee WHERE header_id = $1`, headerID)
+			Expect(err).To(HaveOccurred())
+			Expect(err).To(MatchError(sql.ErrNoRows))
+		})
+	})
+
+	Describe("MissingHeaders", func() {
+		It("returns headers with no associated pit file event", func() {
+			db := test_config.NewTestDB(core.Node{})
+			test_config.CleanTestDB(db)
+			headerRepository := repositories.NewHeaderRepository(db)
+			startingBlockNumber := int64(1)
+			pitFileBlockNumber := int64(2)
+			endingBlockNumber := int64(3)
+			blockNumbers := []int64{startingBlockNumber, pitFileBlockNumber, endingBlockNumber, endingBlockNumber + 1}
+			var headerIDs []int64
+			for _, n := range blockNumbers {
+				headerID, err := headerRepository.CreateOrUpdateHeader(core.Header{BlockNumber: n})
+				headerIDs = append(headerIDs, headerID)
+				Expect(err).NotTo(HaveOccurred())
+			}
+			pitFileRepository := stability_fee.NewPitFileStabilityFeeRepository(db)
+			err := pitFileRepository.Create(headerIDs[1], test_data.PitFileStabilityFeeModel)
+			Expect(err).NotTo(HaveOccurred())
+
+			headers, err := pitFileRepository.MissingHeaders(startingBlockNumber, endingBlockNumber)
+
+			Expect(err).NotTo(HaveOccurred())
+			Expect(len(headers)).To(Equal(2))
+			Expect(headers[0].BlockNumber).To(Or(Equal(startingBlockNumber), Equal(endingBlockNumber)))
+			Expect(headers[1].BlockNumber).To(Or(Equal(startingBlockNumber), Equal(endingBlockNumber)))
+		})
+
+		It("only returns headers associated with the current node", func() {
+			db := test_config.NewTestDB(core.Node{})
+			test_config.CleanTestDB(db)
+			blockNumbers := []int64{1, 2, 3}
+			headerRepository := repositories.NewHeaderRepository(db)
+			dbTwo := test_config.NewTestDB(core.Node{ID: "second"})
+			headerRepositoryTwo := repositories.NewHeaderRepository(dbTwo)
+			var headerIDs []int64
+			for _, n := range blockNumbers {
+				headerID, err := headerRepository.CreateOrUpdateHeader(core.Header{BlockNumber: n})
+				Expect(err).NotTo(HaveOccurred())
+				headerIDs = append(headerIDs, headerID)
+				_, err = headerRepositoryTwo.CreateOrUpdateHeader(core.Header{BlockNumber: n})
+				Expect(err).NotTo(HaveOccurred())
+			}
+			pitFileRepository := stability_fee.NewPitFileStabilityFeeRepository(db)
+			pitFileRepositoryTwo := stability_fee.NewPitFileStabilityFeeRepository(dbTwo)
+			err := pitFileRepository.Create(headerIDs[0], test_data.PitFileStabilityFeeModel)
+			Expect(err).NotTo(HaveOccurred())
+
+			nodeOneMissingHeaders, err := pitFileRepository.MissingHeaders(blockNumbers[0], blockNumbers[len(blockNumbers)-1])
+			Expect(err).NotTo(HaveOccurred())
+			Expect(len(nodeOneMissingHeaders)).To(Equal(len(blockNumbers) - 1))
+
+			nodeTwoMissingHeaders, err := pitFileRepositoryTwo.MissingHeaders(blockNumbers[0], blockNumbers[len(blockNumbers)-1])
+			Expect(err).NotTo(HaveOccurred())
+			Expect(len(nodeTwoMissingHeaders)).To(Equal(len(blockNumbers)))
+		})
+	})
+})
@@ -0,0 +1,13 @@
+package stability_fee_test
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+)
+
+func TestStabilityFee(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "StabilityFee Suite")
+}
@@ -0,0 +1,57 @@
+package stability_fee
+
+import (
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/vulcanize/vulcanizedb/pkg/core"
+	"github.com/vulcanize/vulcanizedb/pkg/datastore/postgres"
+	"github.com/vulcanize/vulcanizedb/pkg/transformers/pit_file"
+	"github.com/vulcanize/vulcanizedb/pkg/transformers/shared"
+)
+
+type PitFileStabilityFeeTransformer struct {
+	Config     shared.TransformerConfig
+	Converter  Converter
+	Fetcher    shared.LogFetcher
+	Repository Repository
+}
+
+type PitFileStabilityFeeTransformerInitializer struct {
+	Config shared.TransformerConfig
+}
+
+func (initializer PitFileStabilityFeeTransformerInitializer) NewPitFileStabilityFeeTransformer(db *postgres.DB, blockChain core.BlockChain) shared.Transformer {
+	converter := PitFileStabilityFeeConverter{}
+	fetcher := shared.NewFetcher(blockChain)
+	repository := NewPitFileStabilityFeeRepository(db)
+	return PitFileStabilityFeeTransformer{
+		Config:     initializer.Config,
+		Converter:  converter,
+		Fetcher:    fetcher,
+		Repository: repository,
+	}
+}
+
+func (transformer PitFileStabilityFeeTransformer) Execute() error {
+	missingHeaders, err := transformer.Repository.MissingHeaders(transformer.Config.StartingBlockNumber, transformer.Config.EndingBlockNumber)
+	if err != nil {
+		return err
+	}
+	for _, header := range missingHeaders {
+		topics := [][]common.Hash{{common.HexToHash(shared.PitFileStabilityFeeSignature)}}
+		matchingLogs, err := transformer.Fetcher.FetchLogs(pit_file.PitFileConfig.ContractAddress, topics, header.BlockNumber)
+		if err != nil {
+			return err
+		}
+		for _, log := range matchingLogs {
+			model, err := transformer.Converter.ToModel(pit_file.PitFileConfig.ContractAddress, shared.PitABI, log)
+			if err != nil {
+				return err
+			}
+			err = transformer.Repository.Create(header.Id, model)
+			if err != nil {
+				return err
+			}
+		}
+	}
+	return nil
+}
@@ -0,0 +1,163 @@
+package stability_fee_test
+
+import (
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/core/types"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+
+	"github.com/vulcanize/vulcanizedb/pkg/core"
+	"github.com/vulcanize/vulcanizedb/pkg/fakes"
+	"github.com/vulcanize/vulcanizedb/pkg/transformers/pit_file"
+	"github.com/vulcanize/vulcanizedb/pkg/transformers/pit_file/stability_fee"
+	"github.com/vulcanize/vulcanizedb/pkg/transformers/shared"
+	"github.com/vulcanize/vulcanizedb/pkg/transformers/test_data"
+	"github.com/vulcanize/vulcanizedb/pkg/transformers/test_data/mocks"
+	stability_fee_mocks "github.com/vulcanize/vulcanizedb/pkg/transformers/test_data/mocks/pit_file/stability_fee"
+)
+
+var _ = Describe("", func() {
+	It("gets missing headers for block numbers specified in config", func() {
+		repository := &stability_fee_mocks.MockPitFileStabilityFeeRepository{}
+		transformer := stability_fee.PitFileStabilityFeeTransformer{
+			Config:     pit_file.PitFileConfig,
+			Fetcher:    &mocks.MockLogFetcher{},
+			Converter:  &stability_fee_mocks.MockPitFileStabilityFeeConverter{},
+			Repository: repository,
+		}
+
+		err := transformer.Execute()
+
+		Expect(err).NotTo(HaveOccurred())
+		Expect(repository.PassedStartingBlockNumber).To(Equal(pit_file.PitFileConfig.StartingBlockNumber))
+		Expect(repository.PassedEndingBlockNumber).To(Equal(pit_file.PitFileConfig.EndingBlockNumber))
+	})
+
+	It("returns error if repository returns error for missing headers", func() {
+		repository := &stability_fee_mocks.MockPitFileStabilityFeeRepository{}
+		repository.SetMissingHeadersErr(fakes.FakeError)
+		transformer := stability_fee.PitFileStabilityFeeTransformer{
+			Fetcher:    &mocks.MockLogFetcher{},
+			Converter:  &stability_fee_mocks.MockPitFileStabilityFeeConverter{},
+			Repository: repository,
+		}
+
+		err := transformer.Execute()
+
+		Expect(err).To(HaveOccurred())
+		Expect(err).To(MatchError(fakes.FakeError))
+	})
+
+	It("fetches logs for missing headers", func() {
+		fetcher := &mocks.MockLogFetcher{}
+		repository := &stability_fee_mocks.MockPitFileStabilityFeeRepository{}
+		repository.SetMissingHeaders([]core.Header{{BlockNumber: 1}, {BlockNumber: 2}})
+		transformer := stability_fee.PitFileStabilityFeeTransformer{
+			Fetcher:    fetcher,
+			Converter:  &stability_fee_mocks.MockPitFileStabilityFeeConverter{},
+			Repository: repository,
+		}
+
+		err := transformer.Execute()
+
+		Expect(err).NotTo(HaveOccurred())
+		Expect(fetcher.FetchedBlocks).To(Equal([]int64{1, 2}))
+		Expect(fetcher.FetchedContractAddress).To(Equal(pit_file.PitFileConfig.ContractAddress))
+		Expect(fetcher.FetchedTopics).To(Equal([][]common.Hash{{common.HexToHash(shared.PitFileStabilityFeeSignature)}}))
+	})
+
+	It("returns error if fetcher returns error", func() {
+		fetcher := &mocks.MockLogFetcher{}
+		fetcher.SetFetcherError(fakes.FakeError)
+		repository := &stability_fee_mocks.MockPitFileStabilityFeeRepository{}
+		repository.SetMissingHeaders([]core.Header{{BlockNumber: 1}})
+		transformer := stability_fee.PitFileStabilityFeeTransformer{
+			Fetcher:    fetcher,
+			Converter:  &stability_fee_mocks.MockPitFileStabilityFeeConverter{},
+			Repository: repository,
+		}
+
+		err := transformer.Execute()
+
+		Expect(err).To(HaveOccurred())
+		Expect(err).To(MatchError(fakes.FakeError))
+	})
+
+	It("converts matching logs", func() {
+		converter := &stability_fee_mocks.MockPitFileStabilityFeeConverter{}
+		fetcher := &mocks.MockLogFetcher{}
+		fetcher.SetFetchedLogs([]types.Log{test_data.EthPitFileStabilityFeeLog})
+		repository := &stability_fee_mocks.MockPitFileStabilityFeeRepository{}
+		repository.SetMissingHeaders([]core.Header{{BlockNumber: 1}})
+		transformer := stability_fee.PitFileStabilityFeeTransformer{
+			Fetcher:    fetcher,
+			Converter:  converter,
+			Repository: repository,
+		}
+
+		err := transformer.Execute()
+
+		Expect(err).NotTo(HaveOccurred())
+		Expect(converter.PassedContractAddress).To(Equal(pit_file.PitFileConfig.ContractAddress))
+		Expect(converter.PassedContractABI).To(Equal(pit_file.PitFileConfig.ContractAbi))
+		Expect(converter.PassedLog).To(Equal(test_data.EthPitFileStabilityFeeLog))
+	})
+
+	It("returns error if converter returns error", func() {
+		converter := &stability_fee_mocks.MockPitFileStabilityFeeConverter{}
+		converter.SetConverterError(fakes.FakeError)
+		fetcher := &mocks.MockLogFetcher{}
+		fetcher.SetFetchedLogs([]types.Log{test_data.EthPitFileStabilityFeeLog})
+		repository := &stability_fee_mocks.MockPitFileStabilityFeeRepository{}
+		repository.SetMissingHeaders([]core.Header{{BlockNumber: 1}})
+		transformer := stability_fee.PitFileStabilityFeeTransformer{
+			Fetcher:    fetcher,
+			Converter:  converter,
+			Repository: repository,
+		}
+
+		err := transformer.Execute()
+
+		Expect(err).To(HaveOccurred())
+		Expect(err).To(MatchError(fakes.FakeError))
+	})
+
+	It("persists pit file model", func() {
+		converter := &stability_fee_mocks.MockPitFileStabilityFeeConverter{}
+		fetcher := &mocks.MockLogFetcher{}
+		fetcher.SetFetchedLogs([]types.Log{test_data.EthPitFileStabilityFeeLog})
+		repository := &stability_fee_mocks.MockPitFileStabilityFeeRepository{}
+		fakeHeader := core.Header{BlockNumber: 1, Id: 2}
+		repository.SetMissingHeaders([]core.Header{fakeHeader})
+		transformer := stability_fee.PitFileStabilityFeeTransformer{
+			Fetcher:    fetcher,
+			Converter:  converter,
+			Repository: repository,
+		}
+
+		err := transformer.Execute()
+
+		Expect(err).NotTo(HaveOccurred())
+		Expect(repository.PassedHeaderID).To(Equal(fakeHeader.Id))
+		Expect(repository.PassedModel).To(Equal(test_data.PitFileStabilityFeeModel))
+	})
+
+	It("returns error if repository returns error for create", func() {
+		converter := &stability_fee_mocks.MockPitFileStabilityFeeConverter{}
+		fetcher := &mocks.MockLogFetcher{}
+		fetcher.SetFetchedLogs([]types.Log{test_data.EthPitFileStabilityFeeLog})
+		repository := &stability_fee_mocks.MockPitFileStabilityFeeRepository{}
+		repository.SetMissingHeaders([]core.Header{{BlockNumber: 1, Id: 2}})
+		repository.SetCreateError(fakes.FakeError)
+		transformer := stability_fee.PitFileStabilityFeeTransformer{
+			Fetcher:    fetcher,
+			Converter:  converter,
+			Repository: repository,
+		}
+
+		err := transformer.Execute()
+
+		Expect(err).To(HaveOccurred())
+		Expect(err).To(MatchError(fakes.FakeError))
+	})
+})