// VulcanizeDB // Copyright © 2019 Vulcanize // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU Affero General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Affero General Public License for more details. // You should have received a copy of the GNU Affero General Public License // along with this program. If not, see . package watcher import ( "fmt" "time" "github.com/ethereum/go-ethereum/common" "github.com/sirupsen/logrus" "github.com/vulcanize/vulcanizedb/libraries/shared/fetcher" "github.com/vulcanize/vulcanizedb/libraries/shared/storage" "github.com/vulcanize/vulcanizedb/libraries/shared/storage/utils" "github.com/vulcanize/vulcanizedb/libraries/shared/transformer" "github.com/vulcanize/vulcanizedb/pkg/datastore/postgres" ) type IStorageWatcher interface { AddTransformers(initializers []transformer.StorageTransformerInitializer) Execute(queueRecheckInterval time.Duration, backFill bool) BackFill(backFiller storage.BackFiller, minDeploymentBlock int) } type StorageWatcher struct { db *postgres.DB StorageFetcher fetcher.IStorageFetcher Queue storage.IStorageQueue KeccakAddressTransformers map[common.Hash]transformer.StorageTransformer // keccak hash of an address => transformer DiffsChan chan utils.StorageDiff ErrsChan chan error StartingSyncBlockChan chan int } func NewStorageWatcher(fetcher fetcher.IStorageFetcher, db *postgres.DB) StorageWatcher { queue := storage.NewStorageQueue(db) transformers := make(map[common.Hash]transformer.StorageTransformer) return StorageWatcher{ db: db, StorageFetcher: fetcher, DiffsChan: make(chan utils.StorageDiff), ErrsChan: make(chan error), StartingSyncBlockChan: make(chan int), Queue: queue, KeccakAddressTransformers: transformers, } } func (storageWatcher StorageWatcher) AddTransformers(initializers []transformer.StorageTransformerInitializer) { for _, initializer := range initializers { storageTransformer := initializer(storageWatcher.db) storageWatcher.KeccakAddressTransformers[storageTransformer.KeccakContractAddress()] = storageTransformer } } // BackFill configures the StorageWatcher to backfill missed storage diffs using a modified archival geth client func (storageWatcher StorageWatcher) BackFill(backFiller storage.BackFiller, minDeploymentBlock int) { // need to learn which block to perform the backfill process up to // this blocks until the Execute process sends us the first block number it sees startingSyncBlock := <-storageWatcher.StartingSyncBlockChan backFilledDiffs, err := backFiller.BackFill(uint64(minDeploymentBlock), uint64(startingSyncBlock)) if err != nil { storageWatcher.ErrsChan <- err } for _, storageDiff := range backFilledDiffs { storageWatcher.DiffsChan <- storageDiff } } func (storageWatcher StorageWatcher) Execute(queueRecheckInterval time.Duration, backFill bool) { ticker := time.NewTicker(queueRecheckInterval) go storageWatcher.StorageFetcher.FetchStorageDiffs(storageWatcher.DiffsChan, storageWatcher.ErrsChan) start := true for { select { case fetchErr := <-storageWatcher.ErrsChan: logrus.Warn(fmt.Sprintf("error fetching storage diffs: %s", fetchErr)) case diff := <-storageWatcher.DiffsChan: if start && backFill { storageWatcher.StartingSyncBlockChan <- diff.BlockHeight - 1 start = false } storageWatcher.processRow(diff) case <-ticker.C: storageWatcher.processQueue() } } } func (storageWatcher StorageWatcher) getTransformer(diff utils.StorageDiff) (transformer.StorageTransformer, bool) { storageTransformer, ok := storageWatcher.KeccakAddressTransformers[diff.HashedAddress] return storageTransformer, ok } func (storageWatcher StorageWatcher) processRow(diff utils.StorageDiff) { storageTransformer, ok := storageWatcher.getTransformer(diff) if !ok { logrus.Debug("ignoring a diff from an unwatched contract") return } executeErr := storageTransformer.Execute(diff) if executeErr != nil { logrus.Warn(fmt.Sprintf("error executing storage transformer: %s", executeErr)) queueErr := storageWatcher.Queue.Add(diff) if queueErr != nil { logrus.Warn(fmt.Sprintf("error queueing storage diff: %s", queueErr)) } } } func (storageWatcher StorageWatcher) processQueue() { diffs, fetchErr := storageWatcher.Queue.GetAll() if fetchErr != nil { logrus.Warn(fmt.Sprintf("error getting queued storage: %s", fetchErr)) } for _, diff := range diffs { storageTransformer, ok := storageWatcher.getTransformer(diff) if !ok { // delete diff from queue if address no longer watched storageWatcher.deleteRow(diff.ID) continue } executeErr := storageTransformer.Execute(diff) if executeErr == nil { storageWatcher.deleteRow(diff.ID) } } } func (storageWatcher StorageWatcher) deleteRow(id int) { deleteErr := storageWatcher.Queue.Delete(id) if deleteErr != nil { logrus.Warn(fmt.Sprintf("error deleting persisted diff from queue: %s", deleteErr)) } }