staging -> master (will be v0.0.13-rc1) (#56)

* (VDB-1164) Get node name from web3_clientVersion

Use IPC path as node ID

* 1189 new move transformer interfaces (#48)

* Move storage Transformer interface to storage pkg

* Handle new storage transformer interface in plugin writer

* Add additional storage value loader logging

* Move event transformer interface to factories/event pkg

* Handle new event transformer interface location in plugin writer

* Memoize an transformer's keccakedAddress

* Update resetHeaderCheckCount docker setup (#50)

* 1189 fix (#52)

* Update ITransformer.GetStorageKeysLookup to return a KeysLookup

* Update custom-transformers.md with new transformer paths

* TO-879:docker ci (#40)

* dockerhub via travis

* add extract-diffs

* add reset-header-check

* (VDB-1207) Remove non-essential smart comments (#53)

- configure via postgraphile.tags.json5 instead

* Update postgres version in travis build (#54)

* Update postgres version in travis build to 11.6

this is the most recent posgres version available in RDS at the moment

* update travis secrets (#55)

Co-authored-by: Gabe Laughlin <gabe@bistrotech.net>
Co-authored-by: daimesava <56128157+daimesava@users.noreply.github.com>
Co-authored-by: Rob Mulholand <rmulholand@8thlight.com>

.travis.yml

@@ -4,8 +4,9 @@ go:
 - 1.12
 services:
 - postgresql
+- docker
 addons:
-  postgresql: '11.2'
+  postgresql: '11.6'
 go_import_path: github.com/makerdao/vulcanizedb
 before_install:
 - make installtools
@@ -16,8 +17,22 @@ before_install:
 script:
 - env GO111MODULE=on make test
 - env GO111MODULE=on make integrationtest
+deploy:
+- provider: script
+  script: bash ./.travis/deploy.sh staging
+  on:
+    branch: staging
+- provider: script
+  script: bash ./.travis/deploy.sh prod
+  on:
+    branch: master
 notifications:
   email: false
 env:
   matrix:
     secure: Bm0u6E0esyVjJ2SMg5kVKkTJI+q0vSTOlRUFsfYQG6xAPqaxPH3iXiIwtUIuWK/pKwGtMsXDTiLuoFFASdu+AWRto2I9FisgO/foZhnsfHc1wBLOj1PCukwYl1LUPrS21QAigoZ24YQi1PHx1INjjSX+2cAIoSsj1LD74L6GcwxZi4A0yh3Ntmtv5ttn6mtDr3GeKh6iaw2vS9OeHRUb4ARlz+pxgNULyYF8AR5cKp2gDX8SrDCikwjJm/i2fKOTfWSxKD/EenaeHKciBnakDAWGs90EOhNlakM5DGFhgGhGKKL/DTImb56VfQfOAJEgxIdNPSUPUJV6WLBGhRKOawfZem/8bV54j89QfVg2H4wKtU62OA4eT5IRKiyTPh1sk7QfVZAHWDnmjUsThaXIErNIHOwEMU+uaXY1bOgXBYG2dqsE0rOGZ+TxzrIzOVAr/4pU6b2qmI60OrjnX9dgX9jcm79FHiLtBYkuu12MrYUcuOt2n8bsqeZ/GkrcaEL25hQghaDsziWkthqciierTwzXZrleLARARjitv04aOV0/FQrawkxEysQXPVklWv9JVlk63+BGp6Wb5YVSDKfCYetPF9e31nwG8gIrglFpE5hgAycUkA6ms+EOJ+6UrUBRQt5JxCaxJ58n7QHOFscRWGfW90oIQ3jftyscKERMn/c=
+  global:
+  - secure: tz62S53XiFomz/R/X0Rl143KLugl/cBCP8C2us5v5qbJhqbVrOUXPKsK6HZThl20S8EqHC/yaXUWrL6+mhTFH3Ee4GILvchMpAHfqOWYZOWtxcgoO/2UcOKzjBORMJK/Oosp/OAYrR86Om1T4P1gatsbIm90dnE6ausBsNxLtCjCr+Ozbx4yDJ37X327o4uvm+0O0+SbxJw8/aVgtNUJDXqNp1CjwtXwrUTH6PbxNiRGgFrZ24lSS0+0ESCJ5GVZSVSWKDUf4ML5gLCA5/JxKooZisUpbbtHPa9CYzbK8jF4eSYbWrg9W3zJ5Xv2+fN7uFBut/DJbg9RWboSo2txWcv/z1Jdao4q0boOgGgYGf8pphKsx2oNVc5ZKgnygAlN1wma7dwddfiTh3u4WB3zzWbjgj0ONhYkMFhKOjMLqNdAdNjOfFUZB2+Xf/FPUKc5MfL0b2GWpEf/sKhJ1xkf8ZpQgbiyCpaDDIQHoGUsrFVQKk8/frEsLWgdJQlZciuNHDThdHntEQx38EcvotKWss5Mc2tcF+HNr32ob0PuQl6aHkuAX9JwR9hYg6UcoG3MTcCta/e4kZ0PmcltXzbvVVM0+NzcQv6vVsBqH3CNY+Uhhd2uIYluescJNhwfK5g+PHDPgQsT0iGJTXDVmR0H658joBTNniYBsWujJ0o6rSg=
+  - secure: qJYh+sEjGmDb4SyXnHkvu+1JEYExaRDbapwVdfx/U8e+AK7ZNno4wsHEEA8aMZVkNW7JOfsRjx3Dp1B6Rgd/2QH6J40yz7hMbCZWbres7KnBD3ib8iwHT5TeQ+DndNZh5wDGgNkxgyDWB05fdtAVu6fH77dWaiCkvejI/Jsl0HSUyv+B+TeoC4SkgQgfWSiHOdQ6Q47LVgmL7Yu64+AwwGBawqFvwZdy6pYk0nJtmliYxA3Uaucaml2O1U/fR4bYejzpqz6mnJsuSsLjZKuzrjPFwRVtpc1MsKYyX/Vs7DYnETi+fbCqxB6zbJjelsKMsq83tN6Gk+zk49AWPehQ/UAE3HdOdJo31JJ5MUt8DLL5oczDdTWIaRiNa+Oidoemmf+8w1TwUQavgBe3ubMwPtBf/m+jPUDTpCsykYjwQDyPCl8W3vI+rxgXQcwIn9v0JCdcM+lmPaQ0v41WXxEBxbQriYHeOAbRyU9RR68rnvQQ7Ly2yUne2onEASW8dEGepelvk4Wddc7Oa58fOXzWK2pM1g0K2MtR1weLsRQiDrI0IFQqXJQzXsrXLoYkSeU/FP/j9RP21sd7b4gXcnSRuV3Z6PeoAgbGegrrIQm3bnFdxZs47mov8c01cG7ExdhT78dp1TvKe90JI82DYK/aZOEK9jKoT+sbZsHpojVxOJI=
+  - secure: c9L/ZJY5JmPlDDlwDPh+guvzY07FUAr3Kh6xenWalzbVzRscFyUtaJTFpjaxzQmI4ICWXQh08A7kEpE/7nd87raBaLRj29KkCjHgKWWgV0x/30Uzu15GiKl7BbhiAukRLTT84abtb7KqTxkBsXyGLIn/xBszE9cNPRXiFb84EEGlNNb9saDV+e8fir3quHxdwCWGHzfl/Li8n5pY/v3wIioDnGU20O16QtL0vTChI8jLaZxvdwB52Je8YgzFPEPz0bJbmHHdV892VPI3P6XyWBJ2Dz94a0tOrFUCBDXFG7rZUBOXcJwtJFNn9c8jAGXdaz7BhAGICAHRqcnxf4N/d10I7cZM8IXQXPb6U1T93KUvn8cKyfPGiSRkmxuc8zkrkRPBVzqDuIFvjOfZ+RkmAQF8+3SnjFuMFWrCDUPy/WkU3sa6JbW4cFkMtc03E8zpzVmeB3MxMbwAtO+wohg83/YTNe6l2sBcMVBxn3zfUAn+uen3KJ3xlXShkMgYFYnhJ7Y26M+kMHuZ1uR8t9Htsx7dCOJM/0IPMTKVk4AhB0vzE3h2SMD91EdScYjmGXrr/xCuGxKeJawow3+CAQZlgq5QwUMsYo2yEDrqm7/FEQbilkVEtdi0V15oL9EEnyOiDWnS6Fjp2R+CN7oKtJU2EYbFXTEmlFtuh4KG75Jmn/E=
+  - secure: kh8o0PUc5zQfvQ1zaX9mKY+EJW5T9PWxGbVTR/ui30yh6UlSjAYHW3dySUT6kqfuZW8CPsSbFQg5DOgSJquYXf2CzHYdb9pUWgX+7bwUCRArndDS84JpgHw8Am9NHfJzegs2+gOX8ul+pbnc4xkYsBaLzh3paIQAr4IZbfqvSfiQiqNKtcAxB2j2ZYBbhxG7pLHmYIp3rB4UUzoMO7jdcPxA2+YxoNJVYjekayk/LFfmpP70BTe9rKCJkyaap+/kl+lAyVR0f1hyRYbwQVOrLRLWga5avYZetFV5XyrqLFwBghfnzDOGWH9J8/iRXWKoWYTO+1G4Cka/74UCqCoYrm5mi/j3GFX0KRjgX7vxcyWjab8uu6L2ictRQq8wP2gE+wuftySDgCtqf2rijsUGFtiA3h2sqUPtKnQD9Zu+e4XnuyHJPtJ1jwviBUgx1N1t5uskx1h5VS+xVG4gc+9zQq3LI+RYOOlVyWfDhK0WxVPbtwH/s9nFibVnNdA2X6fs409toEq9aEbdg9I9Xtz3U6qPYM88BMC6FnrySFFydNxfKCtVldUQmA5Tj3mCexbeTMRS57WmXZLRlWIIisFkTKNYUP9x8RtwOM1OtbiM9HyVs4l7rBIw7iVmidEdb5PYlfFfK7sc32qrQtz5Pr+e9y6ogAMK3u7WEl5EP/ozeOI=

.travis/deploy.sh

@@ -0,0 +1,49 @@
+#! /usr/bin/env bash
+
+set -e
+
+function message() {
+    echo
+    echo -----------------------------------
+    echo "$@"
+    echo -----------------------------------
+    echo
+}
+
+ENVIRONMENT=$1
+if [ "$ENVIRONMENT" == "prod" ]; then
+TAG=latest
+elif [ "$ENVIRONMENT" == "staging" ]; then
+TAG=staging
+else
+   message UNKNOWN ENVIRONMENT
+fi
+
+if [ -z "$ENVIRONMENT" ]; then
+    echo 'You must specifiy an envionrment (bash deploy.sh <ENVIRONMENT>).'
+    echo 'Allowed values are "staging" or "prod"'
+    exit 1
+fi
+
+message BUILDING HEADER-SYNC
+docker build -f dockerfiles/header_sync/Dockerfile . -t makerdao/vdb-headersync:$TAG
+
+message BUILDING EXTRACT-DIFFS
+docker build -f dockerfiles/extract_diffs/Dockerfile . -t makerdao/vdb-extract-diffs:$TAG
+
+message BUILDING RESET-HEADER-CHECK
+docker build -f dockerfiles/reset_header_check_count/Dockerfile . -t makerdao/vdb-reset-header-check:$TAG
+
+message LOGGING INTO DOCKERHUB
+echo "$DOCKER_PASSWORD" | docker login --username "$DOCKER_USER" --password-stdin
+
+message PUSHING HEADER-SYNC
+docker push makerdao/vdb-headersync:$TAG
+
+message PUSHING EXTRACT-DIFFS
+docker push makerdao/vdb-extract-diffs:$TAG
+
+message PUSHING RESET-HEADER-CHECK
+docker push makerdao/vdb-reset-header-check:$TAG
+
+# message DEPLOYING SERVICE

cmd/execute.go

@@ -21,6 +21,8 @@ import (
 	"time"
 
 	"github.com/makerdao/vulcanizedb/libraries/shared/constants"
+	"github.com/makerdao/vulcanizedb/libraries/shared/factories/event"
+	"github.com/makerdao/vulcanizedb/libraries/shared/factories/storage"
 	"github.com/makerdao/vulcanizedb/libraries/shared/logs"
 	"github.com/makerdao/vulcanizedb/libraries/shared/transformer"
 	"github.com/makerdao/vulcanizedb/libraries/shared/watcher"
@@ -118,7 +120,7 @@ func executeTransformers() {
 }
 
 type Exporter interface {
-	Export() ([]transformer.EventTransformerInitializer, []transformer.StorageTransformerInitializer, []transformer.ContractTransformerInitializer)
+	Export() ([]event.TransformerInitializer, []storage.TransformerInitializer, []transformer.ContractTransformerInitializer)
 }
 
 func watchEthEvents(w *watcher.EventWatcher, wg *sync.WaitGroup) {
@@ -139,7 +141,7 @@ func watchEthEvents(w *watcher.EventWatcher, wg *sync.WaitGroup) {
 
 func watchEthStorage(w watcher.IStorageWatcher, wg *sync.WaitGroup) {
 	defer wg.Done()
-	// Execute over the StorageTransformerInitializer set using the storage watcher
+	// Execute over the storage.TransformerInitializer set using the storage watcher
 	LogWithCommand.Info("executing storage transformers")
 	ticker := time.NewTicker(pollingInterval)
 	defer ticker.Stop()

cmd/getStorageValue.go

@@ -1,17 +1,3 @@
-// Copyright © 2020 NAME HERE <EMAIL ADDRESS>
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
 package cmd
 
 import (

cmd/root.go

@@ -26,6 +26,8 @@ import (
 
 	"github.com/ethereum/go-ethereum/ethclient"
 	"github.com/ethereum/go-ethereum/rpc"
+	"github.com/makerdao/vulcanizedb/libraries/shared/factories/event"
+	"github.com/makerdao/vulcanizedb/libraries/shared/factories/storage"
 	"github.com/makerdao/vulcanizedb/libraries/shared/transformer"
 	"github.com/makerdao/vulcanizedb/pkg/config"
 	"github.com/makerdao/vulcanizedb/pkg/eth"
@@ -223,7 +225,7 @@ func prepConfig() error {
 	return nil
 }
 
-func exportTransformers() ([]transformer.EventTransformerInitializer, []transformer.StorageTransformerInitializer, []transformer.ContractTransformerInitializer, error) {
+func exportTransformers() ([]event.TransformerInitializer, []storage.TransformerInitializer, []transformer.ContractTransformerInitializer, error) {
 	// Build plugin generator config
 	configErr := prepConfig()
 	if configErr != nil {

db/migrations/00001_create_nodes_table.sql

@@ -6,11 +6,8 @@ CREATE TABLE eth_nodes
     genesis_block VARCHAR(66),
     network_id    NUMERIC,
     eth_node_id   VARCHAR(128),
-    UNIQUE (genesis_block, network_id, eth_node_id)
+    UNIQUE (genesis_block, network_id, eth_node_id, client_name)
 );
 
-COMMENT ON TABLE public.eth_nodes
-    IS E'@omit';
-
 -- +goose Down
 DROP TABLE eth_nodes;

db/migrations/00004_create_checked_headers_table.sql

@@ -5,8 +5,5 @@ CREATE TABLE public.checked_headers
     header_id INTEGER UNIQUE NOT NULL REFERENCES headers (id) ON DELETE CASCADE
 );
 
-COMMENT ON TABLE public.checked_headers
-    IS E'@omit';
-
 -- +goose Down
 DROP TABLE public.checked_headers;

db/migrations/00007_create_receipts_table.sql

@@ -19,9 +19,6 @@ CREATE INDEX receipts_contract_address
 CREATE INDEX receipts_transaction
     ON public.receipts (transaction_id);
 
-COMMENT ON TABLE public.receipts
-    IS E'@omit';
-
 -- +goose Down
 DROP INDEX receipts_transaction;
 DROP INDEX receipts_contract_address;

db/migrations/00009_create_watched_logs_table.sql

@@ -7,9 +7,6 @@ CREATE TABLE public.watched_logs
     topic_zero       VARCHAR(66)
 );
 
-COMMENT ON TABLE public.watched_logs
-    IS E'@omit';
-
 -- +goose Down
 -- SQL in this section is executed when the migration is rolled back.
 DROP TABLE public.watched_logs;

db/schema.sql

@@ -2,8 +2,8 @@
 -- PostgreSQL database dump
 --
 
--- Dumped from database version 12.1
--- Dumped by pg_dump version 12.1
+-- Dumped from database version 11.6
+-- Dumped by pg_dump version 11.6
 
 SET statement_timeout = 0;
 SET lock_timeout = 0;
@@ -32,7 +32,7 @@ $$;
 
 SET default_tablespace = '';
 
-SET default_table_access_method = heap;
+SET default_with_oids = false;
 
 --
 -- Name: addresses; Type: TABLE; Schema: public; Owner: -
@@ -75,13 +75,6 @@ CREATE TABLE public.checked_headers (
 );
 
 
---
--- Name: TABLE checked_headers; Type: COMMENT; Schema: public; Owner: -
---
-
-COMMENT ON TABLE public.checked_headers IS '@omit';
-
-
 --
 -- Name: checked_headers_id_seq; Type: SEQUENCE; Schema: public; Owner: -
 --
@@ -115,13 +108,6 @@ CREATE TABLE public.eth_nodes (
 );
 
 
---
--- Name: TABLE eth_nodes; Type: COMMENT; Schema: public; Owner: -
---
-
-COMMENT ON TABLE public.eth_nodes IS '@omit';
-
-
 --
 -- Name: eth_nodes_id_seq; Type: SEQUENCE; Schema: public; Owner: -
 --
@@ -269,13 +255,6 @@ CREATE TABLE public.receipts (
 );
 
 
---
--- Name: TABLE receipts; Type: COMMENT; Schema: public; Owner: -
---
-
-COMMENT ON TABLE public.receipts IS '@omit';
-
-
 --
 -- Name: receipts_id_seq; Type: SEQUENCE; Schema: public; Owner: -
 --
@@ -382,13 +361,6 @@ CREATE TABLE public.watched_logs (
 );
 
 
---
--- Name: TABLE watched_logs; Type: COMMENT; Schema: public; Owner: -
---
-
-COMMENT ON TABLE public.watched_logs IS '@omit';
-
-
 --
 -- Name: watched_logs_id_seq; Type: SEQUENCE; Schema: public; Owner: -
 --
@@ -512,11 +484,11 @@ ALTER TABLE ONLY public.checked_headers
 
 
 --
--- Name: eth_nodes eth_nodes_genesis_block_network_id_eth_node_id_key; Type: CONSTRAINT; Schema: public; Owner: -
+-- Name: eth_nodes eth_nodes_genesis_block_network_id_eth_node_id_client_name_key; Type: CONSTRAINT; Schema: public; Owner: -
 --
 
 ALTER TABLE ONLY public.eth_nodes
-    ADD CONSTRAINT eth_nodes_genesis_block_network_id_eth_node_id_key UNIQUE (genesis_block, network_id, eth_node_id);
+    ADD CONSTRAINT eth_nodes_genesis_block_network_id_eth_node_id_client_name_key UNIQUE (genesis_block, network_id, eth_node_id, client_name);
 
 
 --
@@ -690,7 +662,7 @@ CREATE INDEX transactions_header ON public.transactions USING btree (header_id);
 -- Name: headers header_updated; Type: TRIGGER; Schema: public; Owner: -
 --
 
-CREATE TRIGGER header_updated BEFORE UPDATE ON public.headers FOR EACH ROW EXECUTE FUNCTION public.set_header_updated();
+CREATE TRIGGER header_updated BEFORE UPDATE ON public.headers FOR EACH ROW EXECUTE PROCEDURE public.set_header_updated();
 
 
 --

dockerfiles/README.md

@@ -53,7 +53,7 @@ docker build -f dockerfiles/reset_header_check_count/Dockerfile . -t reset_heade
 
 ### Run
 ```
-docker run -e CLIENT_IPCPATH=ipc_path -e DATABASE_USER=user -e DATABASE_PASSWORD=password -e DATABASE_HOSTNAME=host -e DATABASE_PORT=port -e DATABASE_NAME=name -e HEADER_BLOCK_NUMBER=0 -it reset_header_check_count:latest
+docker run -e CLIENT_IPCPATH=ipc_path -e DATABASE_USER=user -e DATABASE_PASSWORD=password -e DATABASE_HOSTNAME=host -e DATABASE_PORT=port -e DATABASE_NAME=name -e RESET_HEADER_COUNT_BLOCK_NUMBER=block-number -it reset_header_check_count:latest
 ```
 Notes:
 - `HEADER_BLOCK_NUMBER` variable is required

dockerfiles/reset_header_check_count/startup_script.sh

@@ -4,9 +4,9 @@
 # Verify required args present
 MISSING_VAR_MESSAGE=" is required and no value was given"
 
-if test -z "$HEADER_BLOCK_NUMBER"
+if test -z "$RESET_HEADER_COUNT_BLOCK_NUMBER"
 then
-    echo HEADER_BLOCK_NUMBER $MISSING_VAR_MESSAGE
+    echo RESET_HEADER_COUNT_BLOCK_NUMBER $MISSING_VAR_MESSAGE
     exit 1
 fi
 
@@ -36,4 +36,4 @@ fi
 # Run resetHeaderCheckCount
 echo "Running resetHeaderCheckCount..."
 echo header_block_number: $HEADER_BLOCK_NUMBER
-./vulcanizedb resetHeaderCheckCount --header-block-number=$HEADER_BLOCK_NUMBER
+./vulcanizedb resetHeaderCheckCount --reset-header-count-block-number=$RESET_HEADER_COUNT_BLOCK_NUMBER

documentation/custom-transformers.md

@@ -5,17 +5,18 @@ purpose can be leveraged.
 Individual custom transformers can be composed together from any number of external repositories and executed as a
 single process using the `compose` and `execute` commands or the `composeAndExecute` command. This is accomplished by
 generating a Go plugin which allows the `vulcanizedb` binary to link to the external transformers, so long as they
-abide by one of the standard [interfaces](../staging/libraries/shared/transformer).
+abide by the [event transformer interface](../libraries/shared/factories/event/transformer.go) or the
+[storage transformer interface](../libraries/shared/factories/storage/transformer.go).
 
 ## Writing custom transformers
 For help with writing different types of custom transformers please see below:
 
 Storage Transformers: transform data derived from contract storage tries
-   * [Guide](../../staging/libraries/shared/factories/storage/README.md)
-   * [Example](../../staging/libraries/shared/factories/storage/EXAMPLE.md)
+   * [Guide](../libraries/shared/factories/storage/README.md)
+   * [Example](../libraries/shared/factories/storage/EXAMPLE.md)
 
 Event Transformers: transform data derived from Ethereum log events
-   * [Guide](../../staging/libraries/shared/factories/event/README.md)
+   * [Guide](../libraries/shared/factories/event/README.md)
    * [Example 1](https://github.com/vulcanize/ens_transformers/tree/master/transformers/registar)
    * [Example 2](https://github.com/vulcanize/ens_transformers/tree/master/transformers/registry)
    * [Example 3](https://github.com/vulcanize/ens_transformers/tree/master/transformers/resolver)
@@ -27,12 +28,13 @@ Contract Transformers: transform data derived from Ethereum log events and use i
 ## Preparing custom transformers to work as part of a plugin
 To plug in an external transformer we need to:
 
-1. Create a package that exports a variable `TransformerInitializer`, `StorageTransformerInitializer`, or `ContractTransformerInitializer` that are of type [TransformerInitializer](../staging/libraries/shared/transformer/event_transformer.go#L33)
-or [StorageTransformerInitializer](../../staging/libraries/shared/transformer/storage_transformer.go#L31),
-or [ContractTransformerInitializer](../../staging/libraries/shared/transformer/contract_transformer.go#L31), respectively
-2. Design the transformers to work in the context of their [event](../staging/libraries/shared/watcher/event_watcher.go#L83),
-[storage](../../staging/libraries/shared/watcher/storage_watcher.go#L53),
-or [contract](../../staging/libraries/shared/watcher/contract_watcher.go#L68) watcher execution modes
+1. Create a package that exports a variable `EventTransformerInitializer`, `StorageTransformerInitializer`, or `ContractTransformerInitializer`
+that are of type [event.TransformerInitializer](../libraries/shared/factories/event/transformer.go#L31)
+or [storage.TransformerInitializer](../libraries/shared/factories/storage/transformer.go#L33),
+or [ContractTransformerInitializer](../libraries/shared/transformer/contract_transformer.go#L31), respectively
+2. Design the transformers to work in the context of their [event](../libraries/shared/watcher/event_watcher.go),
+[storage](../libraries/shared/watcher/storage_watcher.go),
+or [contract](../libraries/shared/watcher/contract_watcher.go) watcher `Execute` methods
 3. Create db migrations to run against vulcanizeDB so that we can store the transformer output
     * Do not `goose fix` the transformer migrations, this is to ensure they are always ran after the core vulcanizedb migrations which are kept in their fixed form
     * Specify migration locations for each transformer in the config with the `exporter.transformer.migrations` fields
@@ -140,12 +142,12 @@ The config provides information for composing a set of transformers from externa
     - `path` is the relative path from `repository` to the transformer's `TransformerInitializer` directory (initializer package).
         - Transformer repositories need to be cloned into the user's $GOPATH (`go get`)
     - `type` is the type of the transformer; indicating which type of watcher it works with (for now, there are only two options: `eth_event` and `eth_storage`)
-        - `eth_storage` indicates the transformer works with the [storage watcher](../../staging/libraries/shared/watcher/storage_watcher.go)
+        - `eth_storage` indicates the transformer works with the [storage watcher](../libraries/shared/watcher/storage_watcher.go)
          that fetches state and storage diffs from an ETH node (instead of, for example, from IPFS)
-        - `eth_event` indicates the transformer works with the [event watcher](../../staging/libraries/shared/watcher/event_watcher.go)
+        - `eth_event` indicates the transformer works with the [event watcher](../libraries/shared/watcher/event_watcher.go)
          that fetches event logs from an ETH node
-        - `eth_contract` indicates the transformer works with the [contract watcher](../staging/libraries/shared/watcher/contract_watcher.go)
-        that is made to work with [contract_watcher pkg](../../staging/pkg/contract_watcher)
+        - `eth_contract` indicates the transformer works with the [contract watcher](../libraries/shared/watcher/contract_watcher.go)
+        that is made to work with [contract_watcher pkg](../pkg/contract_watcher)
         based transformers which work with vDB to watch events and poll public methods ([example1](https://github.com/vulcanize/account_transformers/tree/master/transformers/account/light), [example2](https://github.com/vulcanize/ens_transformers/tree/working/transformers/domain_records))
     - `migrations` is the relative path from `repository` to the db migrations directory for the transformer
     - `rank` determines the order that migrations are ran, with lower ranked migrations running first
@@ -167,7 +169,9 @@ The general structure of a plugin .go file, and what we would see built with the
 package main
 
 import (
-	interface1 "github.com/makerdao/vulcanizedb/libraries/shared/transformer"
+	"github.com/makerdao/vulcanizedb/libraries/shared/factories/event"
+    "github.com/makerdao/vulcanizedb/libraries/shared/factories/storage"
+    interface1 "github.com/makerdao/vulcanizedb/libraries/shared/transformer"
 	transformer1 "github.com/account/repo/path/to/transformer1"
 	transformer2 "github.com/account/repo/path/to/transformer2"
 	transformer3 "github.com/account/repo/path/to/transformer3"