Interface change in node.RegisterApis

* Add log while serving getBlockByNumber

* Update GQL API to return empty result when header not found for hash

.github/workflows/on-pr-publish.yaml

@@ -0,0 +1,79 @@
+name: Test, Build, and/or Publish
+on:
+  release:
+    types: [published]
+  pull_request:
+
+jobs:
+  pre_job:
+    # continue-on-error: true # Uncomment once integration is finished
+    runs-on: ubuntu-latest
+    # Map a step output to a job output
+    outputs:
+      should_skip: ${{ steps.skip_check.outputs.should_skip }}
+    steps:
+      - id: skip_check
+        uses: fkirc/skip-duplicate-actions@v4
+        with:
+          # All of these options are optional, so you can remove them if you are happy with the defaults
+          concurrent_skipping: "never"
+          skip_after_successful_duplicate: "true"
+          do_not_skip: '["workflow_dispatch", "schedule"]'
+  run-tests:
+    uses: ./.github/workflows/tests.yaml
+    if: ${{ needs.pre_job.outputs.should_skip != 'true' }}
+    needs: pre_job
+    secrets:
+      BUILD_HOSTNAME: ${{ secrets.BUILD_HOSTNAME }}
+      BUILD_USERNAME: ${{ secrets.BUILD_USERNAME }}
+      BUILD_KEY: ${{ secrets.BUILD_KEY }}
+    with:
+      STACK_ORCHESTRATOR_REF: "f2fd766f5400fcb9eb47b50675d2e3b1f2753702"
+      GO_ETHEREUM_REF: "7b4ef34de2b9469c3f82972b60e38b34c99c5382"
+      IPLD_ETH_DB_REF: "b59505eab252670c622b42ce60621e9747fb64f9"
+  build:
+    name: Run docker build
+    runs-on: ubuntu-latest
+    needs: run-tests
+    if: |
+      always() &&
+      (needs.run-tests.result == 'success' || needs.run-tests.result == 'skipped') &&
+      github.event_name == 'release'
+    steps:
+      - uses: actions/checkout@v2
+      - name: Get the version
+        id: vars
+        run: echo ::set-output name=sha::$(echo ${GITHUB_SHA:0:7})
+      - name: Run docker build
+        run: make docker-build
+      - name: Tag docker image
+        run: docker tag vulcanize/ipld-eth-server docker.pkg.github.com/vulcanize/ipld-eth-server/ipld-eth-server:${{steps.vars.outputs.sha}}
+      - name: Docker Login
+        run: echo ${{ secrets.GITHUB_TOKEN }} | docker login https://docker.pkg.github.com -u vulcanize --password-stdin
+      - name: Docker Push
+        run: docker push docker.pkg.github.com/vulcanize/ipld-eth-server/ipld-eth-server:${{steps.vars.outputs.sha}}
+
+  push_to_registries:
+    name: Push Docker image to Docker Hub
+    runs-on: ubuntu-latest
+    if: |
+      always() &&
+      (needs.build.result == 'success') &&
+      github.event_name == 'release'
+    needs: build
+    steps:
+      - name: Get the version
+        id: vars
+        run: |
+          echo ::set-output name=sha::$(echo ${GITHUB_SHA:0:7})
+          echo ::set-output name=tag::$(echo ${GITHUB_REF#refs/tags/})
+      - name: Docker Login to Github Registry
+        run: echo ${{ secrets.GITHUB_TOKEN }} | docker login https://docker.pkg.github.com -u vulcanize --password-stdin
+      - name: Docker Pull
+        run: docker pull docker.pkg.github.com/vulcanize/ipld-eth-server/ipld-eth-server:${{steps.vars.outputs.sha}}
+      - name: Docker Login to Docker Registry
+        run: echo ${{ secrets.VULCANIZEJENKINS_PAT }} | docker login -u vulcanizejenkins --password-stdin
+      - name: Tag docker image
+        run: docker tag docker.pkg.github.com/vulcanize/ipld-eth-server/ipld-eth-server:${{steps.vars.outputs.sha}} vulcanize/ipld-eth-server:${{steps.vars.outputs.tag}}
+      - name: Docker Push to Docker Hub
+        run: docker push vulcanize/ipld-eth-server:${{steps.vars.outputs.tag}}

.github/workflows/run_unit_test.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+set -e
+
+# Set up repo
+start_dir=$(pwd)
+temp_dir=$(mktemp -d)
+cd $temp_dir
+git clone -b $(cat /tmp/git_head_ref) "https://github.com/$(cat /tmp/git_repository).git"
+cd ipld-eth-server
+
+## Remove the branch and github related info. This way future runs wont be confused.
+rm -f /tmp/git_head_ref /tmp/git_repository
+
+# Spin up DB and run migrations
+docker-compose up -d migrations ipld-eth-db
+trap "docker-compose down -v --remove-orphans; cd $start_dir ; rm -r $temp_dir" SIGINT SIGTERM ERR
+sleep 30
+
+# Remove old logs so there's no confusion, then run test
+rm -f /tmp/test.log /tmp/return_test.txt
+PGPASSWORD=password DATABASE_USER=vdbm DATABASE_PORT=8077 DATABASE_PASSWORD=password DATABASE_HOSTNAME=localhost DATABASE_NAME=vulcanize_testing make test >  /tmp/test.log
+echo $? > /tmp/return_test.txt
+
+# Clean up
+docker-compose down -v --remove-orphans
+cd $start_dir
+rm -fr $temp_dir

.github/workflows/tests.yaml

@@ -0,0 +1,212 @@
+name: Test the stack.
+on:
+  workflow_call:
+    secrets:
+      BUILD_HOSTNAME:
+        required: true
+      BUILD_USERNAME:
+        required: true
+      BUILD_KEY:
+        required: true
+    inputs:
+      STACK_ORCHESTRATOR_REF:
+        required: true
+        type: string
+      GO_ETHEREUM_REF:
+        required: true
+        type: string
+      IPLD_ETH_DB_REF:
+        required: true
+        type: string
+
+jobs:
+  build:
+    name: Run docker build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Run docker build
+        run: make docker-build
+  test:
+    name: Run unit tests
+    env:
+      GOPATH: /tmp/go
+      # To run the unit tests you need to add secrets to your repository.
+      BUILD_HOSTNAME: ${{ secrets.BUILD_HOSTNAME }}
+      BUILD_USERNAME: ${{ secrets.BUILD_USERNAME }}
+      BUILD_KEY: ${{ secrets.BUILD_KEY }}
+    #strategy:
+    #  matrix:
+    #    go-version: [1.16.x, 1.17.x]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      # Passed experience with GHA has taught me to store variables in files instead of passing them as variables.
+      - name: Output variables to files
+        run: |
+          echo $GITHUB_REPOSITORY > /tmp/git_repository
+          [ -z "$GITHUB_HEAD_REF" ] && echo $GITHUB_REF_NAME > /tmp/git_head_ref || echo $GITHUB_HEAD_REF > /tmp/git_head_ref
+          echo "-----BEGIN OPENSSH PRIVATE KEY-----" >> /tmp/key
+          echo ${{ env.BUILD_KEY }} >> /tmp/key
+          echo "-----END OPENSSH PRIVATE KEY-----" >> /tmp/key
+          chmod 400 /tmp/key
+          cat /tmp/git_repository
+          cat /tmp/git_head_ref
+
+      - name: Raw SCP
+        run: |
+          scp -o 'StrictHostKeyChecking no' -o UserKnownHostsFile=/dev/null -q -i /tmp/key /tmp/git_repository ${{ env.BUILD_USERNAME }}@${{ env.BUILD_HOSTNAME }}:/tmp/git_repository
+          scp -o 'StrictHostKeyChecking no' -o UserKnownHostsFile=/dev/null -q -i /tmp/key /tmp/git_head_ref ${{ env.BUILD_USERNAME }}@${{ env.BUILD_HOSTNAME }}:/tmp/git_head_ref
+          scp -o 'StrictHostKeyChecking no' -o UserKnownHostsFile=/dev/null -q -i /tmp/key .github/workflows/run_unit_test.sh ${{ env.BUILD_USERNAME }}@${{ env.BUILD_HOSTNAME }}:/tmp/run_unit_test.sh
+
+      - name: Trigger Unit Test
+        run: |
+          ssh -o 'StrictHostKeyChecking no' -o UserKnownHostsFile=/dev/null -q  -i /tmp/key ${{ env.BUILD_USERNAME }}@${{ env.BUILD_HOSTNAME }} go install github.com/onsi/ginkgo/ginkgo@latest
+          ssh -o 'StrictHostKeyChecking no' -o UserKnownHostsFile=/dev/null -q  -i /tmp/key ${{ env.BUILD_USERNAME }}@${{ env.BUILD_HOSTNAME }} /tmp/run_unit_test.sh
+
+      - name: Get the logs and cat them
+        run: |
+          scp -o 'StrictHostKeyChecking no' -o UserKnownHostsFile=/dev/null -q  -i /tmp/key ${{ env.BUILD_USERNAME }}@${{ env.BUILD_HOSTNAME }}:/tmp/test.log .
+          cat ./test.log
+
+      - name: Check Error Code
+        run: |
+          scp -o 'StrictHostKeyChecking no' -o UserKnownHostsFile=/dev/null -q  -i /tmp/key ${{ env.BUILD_USERNAME }}@${{ env.BUILD_HOSTNAME }}:/tmp/return_test.txt .
+          [ $(cat ./return_test.txt) -eq 0 ]
+
+  integrationtest:
+    name: Run integration tests
+    env:
+      GOPATH: /tmp/go
+      DB_WRITE: true
+      ETH_FORWARD_ETH_CALLS: false
+      ETH_PROXY_ON_ERROR: false
+      ETH_HTTP_PATH: "go-ethereum:8545"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Create GOPATH
+        run: mkdir -p /tmp/go
+      - uses: actions/setup-go@v3
+        with:
+          go-version: ">=1.18.0"
+          check-latest: true
+      - uses: actions/checkout@v2
+        with:
+          path: "./ipld-eth-server"
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{ inputs.STACK_ORCHESTRATOR_REF }}
+          path: "./stack-orchestrator/"
+          repository: vulcanize/stack-orchestrator
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{ inputs.GO_ETHEREUM_REF }}
+          repository: vulcanize/go-ethereum
+          path: "./go-ethereum/"
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{ inputs.IPLD_ETH_DB_REF }}
+          repository: vulcanize/ipld-eth-db
+          path: "./ipld-eth-db/"
+      - name: Create config file
+        run: |
+          echo vulcanize_go_ethereum=$GITHUB_WORKSPACE/go-ethereum/ > ./config.sh
+          echo vulcanize_ipld_eth_db=$GITHUB_WORKSPACE/ipld-eth-db/ >> ./config.sh
+          echo vulcanize_ipld_eth_server=$GITHUB_WORKSPACE/ipld-eth-server/ >> ./config.sh
+          echo vulcanize_test_contract=$GITHUB_WORKSPACE/ipld-eth-server/test/contract >> ./config.sh
+          echo genesis_file_path=start-up-files/go-ethereum/genesis.json >> ./config.sh
+          echo db_write=$DB_WRITE >> ./config.sh
+          echo eth_forward_eth_calls=$ETH_FORWARD_ETH_CALLS >> ./config.sh
+          echo eth_proxy_on_error=$ETH_PROXY_ON_ERROR >> ./config.sh
+          echo eth_http_path=$ETH_HTTP_PATH >> ./config.sh
+          cat ./config.sh
+      - name: Build geth
+        run: |
+          cd $GITHUB_WORKSPACE/stack-orchestrator/helper-scripts
+          ./compile-geth.sh \
+          -p "$GITHUB_WORKSPACE/config.sh" \
+          -e docker
+      - name: Run docker compose
+        run: |
+          docker-compose  \
+          -f "$GITHUB_WORKSPACE/stack-orchestrator/docker/local/docker-compose-db-sharding.yml" \
+          -f "$GITHUB_WORKSPACE/stack-orchestrator/docker/local/docker-compose-go-ethereum.yml" \
+          -f "$GITHUB_WORKSPACE/stack-orchestrator/docker/local/docker-compose-ipld-eth-server.yml" \
+          -f "$GITHUB_WORKSPACE/stack-orchestrator/docker/local/docker-compose-contract.yml" \
+          --env-file "$GITHUB_WORKSPACE/config.sh" \
+          up -d --build
+      - name: Test
+        run: |
+          cd $GITHUB_WORKSPACE/ipld-eth-server
+          while [ "$(curl -s -o /dev/null -w ''%{http_code}'' localhost:8081)" != "200" ]; do echo "waiting for ipld-eth-server..." && sleep 5; done && \
+          while [ "$(curl -s -o /dev/null -w ''%{http_code}'' localhost:8545)" != "200" ]; do echo "waiting for geth-statediff..." && sleep 5; done && \
+          make integrationtest
+
+  integrationtest_forwardethcalls:
+    name: Run integration tests for direct proxy fall-through of eth_calls
+    env:
+      GOPATH: /tmp/go
+      DB_WRITE: false
+      ETH_FORWARD_ETH_CALLS: true
+      ETH_PROXY_ON_ERROR: false
+      ETH_HTTP_PATH: "go-ethereum:8545"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Create GOPATH
+        run: mkdir -p /tmp/go
+      - uses: actions/setup-go@v3
+        with:
+          go-version: ">=1.18.0"
+          check-latest: true
+      - uses: actions/checkout@v2
+        with:
+          path: "./ipld-eth-server"
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{ inputs.STACK_ORCHESTRATOR_REF }}
+          path: "./stack-orchestrator/"
+          repository: vulcanize/stack-orchestrator
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{ inputs.GO_ETHEREUM_REF }}
+          repository: vulcanize/go-ethereum
+          path: "./go-ethereum/"
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{ inputs.IPLD_ETH_DB_REF }}
+          repository: vulcanize/ipld-eth-db
+          path: "./ipld-eth-db/"
+      - name: Create config file
+        run: |
+          echo vulcanize_go_ethereum=$GITHUB_WORKSPACE/go-ethereum/ > ./config.sh
+          echo vulcanize_ipld_eth_db=$GITHUB_WORKSPACE/ipld-eth-db/ >> ./config.sh
+          echo vulcanize_ipld_eth_server=$GITHUB_WORKSPACE/ipld-eth-server/ >> ./config.sh
+          echo vulcanize_test_contract=$GITHUB_WORKSPACE/ipld-eth-server/test/contract >>./config.sh
+          echo genesis_file_path=start-up-files/go-ethereum/genesis.json >> ./config.sh
+          echo db_write=$DB_WRITE >> ./config.sh
+          echo eth_forward_eth_calls=$ETH_FORWARD_ETH_CALLS >> ./config.sh
+          echo eth_proxy_on_error=$ETH_PROXY_ON_ERROR >> ./config.sh
+          echo eth_http_path=$ETH_HTTP_PATH >> ./config.sh
+          cat ./config.sh
+      - name: Build geth
+        run: |
+          cd $GITHUB_WORKSPACE/stack-orchestrator/helper-scripts
+          ./compile-geth.sh \
+          -p "$GITHUB_WORKSPACE/config.sh" \
+          -e docker
+      - name: Run docker compose
+        run: |
+          docker-compose  \
+          -f "$GITHUB_WORKSPACE/stack-orchestrator/docker/local/docker-compose-db-sharding.yml" \
+          -f "$GITHUB_WORKSPACE/stack-orchestrator/docker/local/docker-compose-go-ethereum.yml" \
+          -f "$GITHUB_WORKSPACE/stack-orchestrator/docker/local/docker-compose-ipld-eth-server.yml" \
+          -f "$GITHUB_WORKSPACE/stack-orchestrator/docker/local/docker-compose-contract.yml" \
+          --env-file "$GITHUB_WORKSPACE/config.sh" \
+          up -d --build
+      - name: Test
+        run: |
+          cd $GITHUB_WORKSPACE/ipld-eth-server
+          while [ "$(curl -s -o /dev/null -w ''%{http_code}'' localhost:8081)" != "200" ]; do echo "waiting for ipld-eth-server..." && sleep 5; done && \
+          while [ "$(curl -s -o /dev/null -w ''%{http_code}'' localhost:8545)" != "200" ]; do echo "waiting for geth-statediff..." && sleep 5; done && \
+          make integrationtest

.gitignore

@@ -7,7 +7,7 @@ Vagrantfile
 vagrant*.sh
 .vagrant
 test_scripts/
-vulcanizedb
+ipld-eth-server
 postgraphile/build/
 postgraphile/node_modules/
 postgraphile/package-lock.json
@@ -16,3 +16,4 @@ db/migrations/20*.sql
 plugins/*.so
 postgraphile/*.toml
 postgraphile/schema.graphql
+vulcanizedb.pem

.travis.yml

@@ -1,26 +0,0 @@
-dist: trusty
-language: go
-go:
-  - 1.12
-services:
-  - postgresql
-addons:
-  postgresql: '11.2'
-go_import_path: github.com/vulcanize/vulcanizedb
-before_install:
-  - make installtools
-  - bash ./scripts/install-postgres-11.sh
-  - curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
-  - echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
-  - sudo apt-get update && sudo apt-get install yarn
-before_script:
-  - sudo -u postgres createdb vulcanize_private
-  - make migrate NAME=vulcanize_private
-script:
-  - env GO111MODULE=on make test
-  - env GO111MODULE=on make integrationtest
-notifications:
-  email: false
-env:
-  matrix:
-    secure: GA4GiMHy868UD/C+59jRUOdJxxdLSMauNapPA31AODUMv0lcEOXg6TBJkv6Vn3OOrLHYYSpwCGiGQjF86U2vpKWzD1mSITalPfP/kNpFnrHVNf2oPpfrQs8ccs9gnFpbCNLDy0w2+55pgnrd5hvdnlsTEUS1lHWSKEZmWsSqUeS/dw22IS0+nUja0Pc3pHaWlJz2R502uEKIixjq1fOX65Z/9r1BrMqklOwWrABK0GwgYcDZwc+b3iovyDPkDa3sT/Ddz/srkcYi/Y182zdLdrknj3MVR3GiW5iSqIVm6gr427SFXF4EQVwkEBwAGoo83wRhCgCAslYTRZZ5aleb1HUtAWzuiMAd/JlAYb2jc6VJa19+rQ/5wd7Bann3hB5bY2uV+b02qFK3qWe6uqZLBSESWjFEyWJVoaXgpH0QDc0JG1R9UFxLSVa8NM3P/jgTnUgnAvdW36mTC4dg73Ha9bYdeLpuAZr6k8iTh5qp0CazKAazsdJ+ECNt6q3fkgsI/V5ZwCFfQwlauq+PiBaZsQqr7eeP19klipE3vGf6BCBRvCBdubzSgGZPIRkxOQREc24j/gzBjBNGeqoU2uOp8sXMEG5idfIyHbMU+n2Yi6IRKKPe5lwjgWEsqLkkoM2REMPIEPffRQz0f+mD48HWP0H4KjKHvubKRCE0v2ONlM4=

Dockerfile

@@ -1,24 +1,49 @@
-FROM golang:alpine as builder
-RUN apk --update --no-cache add make git g++
+FROM golang:1.18-alpine as builder
 
-# Build statically linked vDB binary (wonky path because of Dep)
-RUN mkdir -p /go/src/github.com/vulcanize/vulcanizedb
-ADD . /go/src/github.com/vulcanize/vulcanizedb
-WORKDIR /go/src/github.com/vulcanize/vulcanizedb
-RUN GCO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -ldflags '-extldflags "-static"' .
+RUN apk --update --no-cache add make git g++ linux-headers
+# DEBUG
+RUN apk add busybox-extras
 
-# Build migration tool
-RUN go get -u -d github.com/pressly/goose/cmd/goose
-WORKDIR /go/src/github.com/pressly/goose/cmd/goose
-RUN GCO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -ldflags '-extldflags "-static"' -tags='no_mysql no_sqlite' -o goose
+# Build ipld-eth-server
+WORKDIR /go/src/github.com/vulcanize/ipld-eth-server
 
-# Second stage
+# Cache the modules
+ENV GO111MODULE=on
+COPY go.mod .
+COPY go.sum .
+RUN go mod download
+
+COPY . .
+
+# Build the binary
+RUN GCO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -ldflags '-extldflags "-static"' -o ipld-eth-server .
+
+# Copy migration tool
+WORKDIR /
+ARG GOOSE_VER="v2.6.0"
+ADD https://github.com/pressly/goose/releases/download/${GOOSE_VER}/goose-linux64 ./goose
+RUN chmod +x ./goose
+
+# app container
 FROM alpine
-COPY --from=builder /go/src/github.com/vulcanize/vulcanizedb/vulcanizedb /app/vulcanizedb
-COPY --from=builder /go/src/github.com/vulcanize/vulcanizedb/environments/staging.toml /app/environments/
-COPY --from=builder /go/src/github.com/vulcanize/vulcanizedb/dockerfiles/startup_script.sh /app/
-COPY --from=builder /go/src/github.com/vulcanize/vulcanizedb/db/migrations/* /app/
-COPY --from=builder /go/src/github.com/pressly/goose/cmd/goose/goose /app/goose
 
+ARG USER="vdm"
+ARG CONFIG_FILE="./environments/example.toml"
+
+RUN adduser -Du 5000 $USER
 WORKDIR /app
-CMD ["./startup_script.sh"]
+RUN chown $USER /app
+USER $USER
+
+# chown first so dir is writable
+# note: using $USER is merged, but not in the stable release yet
+COPY --chown=5000:5000 --from=builder /go/src/github.com/vulcanize/ipld-eth-server/$CONFIG_FILE config.toml
+COPY --chown=5000:5000 --from=builder /go/src/github.com/vulcanize/ipld-eth-server/entrypoint.sh .
+
+
+# keep binaries immutable
+COPY --from=builder /go/src/github.com/vulcanize/ipld-eth-server/ipld-eth-server ipld-eth-server
+COPY --from=builder /goose goose
+COPY --from=builder /go/src/github.com/vulcanize/ipld-eth-server/environments environments
+
+ENTRYPOINT ["/app/entrypoint.sh"]

Makefile

@@ -3,16 +3,11 @@ BASE = $(GOPATH)/src/$(PACKAGE)
 PKGS = go list ./... | grep -v "^vendor/"
 
 # Tools
-## Testing library
-GINKGO = $(BIN)/ginkgo
-$(BIN)/ginkgo:
-	go get -u github.com/onsi/ginkgo/ginkgo
 
 ## Migration tool
 GOOSE = $(BIN)/goose
 $(BIN)/goose:
-	go get -u -d github.com/pressly/goose/cmd/goose
-	go build -tags='no_mysql no_sqlite' -o $(BIN)/goose github.com/pressly/goose/cmd/goose
+	go get -u github.com/pressly/goose/cmd/goose
 
 ## Source linter
 LINT = $(BIN)/golint
@@ -27,8 +22,9 @@ $(BIN)/gometalinter.v2:
 
 
 .PHONY: installtools
-installtools: | $(LINT) $(GOOSE) $(GINKGO)
+installtools: | $(LINT) $(GOOSE)
 	echo "Installing tools"
+	go mod download
 
 .PHONY: metalint
 metalint: | $(METALINT)
@@ -41,28 +37,40 @@ metalint: | $(METALINT)
 lint:
 	$(LINT) $$($(PKGS)) | grep -v -E "exported (function)|(var)|(method)|(type).*should have comment or be unexported"
 
-.PHONY: test
-test: | $(GINKGO) $(LINT)
-	go vet ./...
-	go fmt ./...
-	$(GINKGO) -r --skipPackage=integration_tests,integration
-
-.PHONY: integrationtest
-integrationtest: | $(GINKGO) $(LINT)
-	go vet ./...
-	go fmt ./...
-	$(GINKGO) -r integration_test/
-
-build:
-	go fmt ./...
-	go build
-
 #Database
 HOST_NAME = localhost
 PORT = 5432
 NAME =
 USER = postgres
-CONNECT_STRING=postgresql://$(USER)@$(HOST_NAME):$(PORT)/$(NAME)?sslmode=disable
+PASSWORD = password
+CONNECT_STRING=postgresql://$(USER):$(PASSWORD)@$(HOST_NAME):$(PORT)/$(NAME)?sslmode=disable
+
+#Test
+TEST_DB = vulcanize_testing
+TEST_CONNECT_STRING = postgresql://$(DATABASE_USER):$(DATABASE_PASSWORD)@$(DATABASE_HOSTNAME):$(DATABASE_PORT)/$(TEST_DB)?sslmode=disable
+TEST_CONNECT_STRING_LOCAL = postgresql://$(USER)@$(HOST_NAME):$(PORT)/$(TEST_DB)?sslmode=disable
+
+.PHONY: test
+test: |  $(GOOSE)
+	go vet ./...
+	go fmt ./...
+	go run github.com/onsi/ginkgo/ginkgo  -r --skipPackage=test
+
+.PHONY: integrationtest
+integrationtest: | $(GOOSE)
+	go vet ./...
+	go fmt ./...
+	go run github.com/onsi/ginkgo/ginkgo -r test/ -v
+
+.PHONY: test_local
+test_local: | $(GOOSE)
+	go vet ./...
+	go fmt ./...
+	./scripts/run_unit_test.sh
+
+build:
+	go fmt ./...
+	GO111MODULE=on go build
 
 # Parameter checks
 ## Check that DB variables are provided
@@ -71,7 +79,6 @@ checkdbvars:
 	test -n "$(HOST_NAME)" # $$HOST_NAME
 	test -n "$(PORT)" # $$PORT
 	test -n "$(NAME)" # $$NAME
-	test -n "$(USER)" # $$USER
 	@echo $(CONNECT_STRING)
 
 ## Check that the migration variable (id/timestamp) is provided
@@ -88,41 +95,36 @@ checkmigname:
 ## Rollback the last migration
 .PHONY: rollback
 rollback: $(GOOSE) checkdbvars
-	cd db/migrations;\
-	  $(GOOSE) postgres "$(CONNECT_STRING)" down
+	$(GOOSE) -dir db/migrations postgres "$(CONNECT_STRING)" down
 	pg_dump -O -s $(CONNECT_STRING) > db/schema.sql
 
 
-## Rollbackt to a select migration (id/timestamp)
+## Rollback to a select migration (id/timestamp)
 .PHONY: rollback_to
 rollback_to: $(GOOSE) checkmigration checkdbvars
-	cd db/migrations;\
-	  $(GOOSE) postgres "$(CONNECT_STRING)" down-to "$(MIGRATION)"
+	$(GOOSE) -dir db/migrations postgres "$(CONNECT_STRING)" down-to "$(MIGRATION)"
 
 ## Apply all migrations not already run
 .PHONY: migrate
 migrate: $(GOOSE) checkdbvars
-	cd db/migrations;\
-	  $(GOOSE) postgres "$(CONNECT_STRING)" up
+	$(GOOSE) -dir db/migrations postgres "$(CONNECT_STRING)" up
 	pg_dump -O -s $(CONNECT_STRING) > db/schema.sql
 
 ## Create a new migration file
 .PHONY: new_migration
 new_migration: $(GOOSE) checkmigname
-	cd db/migrations;\
-	  $(GOOSE) create $(NAME) sql
+	$(GOOSE) -dir db/migrations create $(NAME) sql
 
 ## Check which migrations are applied at the moment
 .PHONY: migration_status
 migration_status: $(GOOSE) checkdbvars
-	cd db/migrations;\
-	  $(GOOSE) postgres "$(CONNECT_STRING)" status
+	$(GOOSE) -dir db/migrations postgres "$(CONNECT_STRING)" status
 
 # Convert timestamped migrations to versioned (to be run in CI);
 # merge timestamped files to prevent conflict
 .PHONY: version_migrations
 version_migrations:
-	cd db/migrations; $(GOOSE) fix
+	$(GOOSE) -dir db/migrations fix
 
 # Import a psql schema to the database
 .PHONY: import
@@ -130,25 +132,7 @@ import:
 	test -n "$(NAME)" # $$NAME
 	psql $(NAME) < db/schema.sql
 
-
-# Docker actions
-## Rinkeby docker environment
-RINKEBY_COMPOSE_FILE=dockerfiles/rinkeby/docker-compose.yml
-
-.PHONY: rinkeby_env_up
-rinkeby_env_up:
-	docker-compose -f $(RINKEBY_COMPOSE_FILE) up -d geth
-	docker-compose -f $(RINKEBY_COMPOSE_FILE) up --build migrations
-	docker-compose -f $(RINKEBY_COMPOSE_FILE) up -d --build vulcanizedb
-
-.PHONY: rinkeby_env_deploy
-rinkeby_env_deploy:
-	docker-compose -f $(RINKEBY_COMPOSE_FILE) up -d --build vulcanizedb
-
-.PHONY: dev_env_migrate
-rinkeby_env_migrate:
-	docker-compose -f $(RINKEBY_COMPOSE_FILE) up --build migrations
-
-.PHONY: rinkeby_env_down
-rinkeby_env_down:
-	docker-compose -f $(RINKEBY_COMPOSE_FILE) down
+## Build docker image
+.PHONY: docker-build
+docker-build:
+	docker build -t vulcanize/ipld-eth-server .

README.md

@@ -1,10 +1,8 @@
-# Vulcanize DB
+# ipld-eth-server
 
-[![Build Status](https://travis-ci.org/vulcanize/vulcanizedb.svg?branch=master)](https://travis-ci.org/vulcanize/vulcanizedb)
-[![Go Report Card](https://goreportcard.com/badge/github.com/vulcanize/vulcanizedb)](https://goreportcard.com/report/github.com/vulcanize/vulcanizedb)
-
-> Vulcanize DB is a set of tools that make it easier for developers to write application-specific indexes and caches for dapps built on Ethereum.
+[![Go Report Card](https://goreportcard.com/badge/github.com/vulcanize/ipld-eth-server)](https://goreportcard.com/report/github.com/vulcanize/ipld-eth-server)
 
+>  ipld-eth-server is the server backend for indexed ETH IPLD objects
 
 ## Table of Contents
 1. [Background](#background)
@@ -13,134 +11,154 @@
 1. [Contributing](#contributing)
 1. [License](#license)
 
-
 ## Background
-The same data structures and encodings that make Ethereum an effective and trust-less distributed virtual machine
-complicate data accessibility and usability for dApp developers. VulcanizeDB improves Ethereum data accessibility by
-providing a suite of tools to ease the extraction and transformation of data into a more useful state, including
-allowing for exposing aggregate data from a suite of smart contracts.
+NOTE: WIP
 
-VulanizeDB includes processes that sync, transform and expose data. Syncing involves
-querying an Ethereum node and then persisting core data into a Postgres database. Transforming focuses on using previously synced data to
-query for and transform log event and storage data for specifically configured smart contract addresses. Exposing data is a matter of getting
-data from VulcanizeDB's underlying Postgres database and making it accessible.
+ipld-eth-server is used to service queries against the Ethereum IPLD objects indexed by [ipld-eth-indexer](https://github.com/vulcanize/ipld-eth-indexer).
 
-![VulcanizeDB Overview Diagram](documentation/diagrams/vdb-overview.png)
+It exposes standard Ethereum JSON RPC endpoints on top of the database, in some cases these endpoints can leverage the unique indexes to improve query performance.
+Additional, unique endpoints are exposed which utilize the new indexes and state diff data objects.
+
+
+## Dependencies
+Minimal build dependencies
+* Go (1.18)
+* Git
+* GCC compiler
+* This repository
+
+External dependency
+* Postgres database populated by [ipld-eth-db](https://github.com/vulcanize/ipld-eth-db)
 
 ## Install
+Start by downloading ipld-eth-server and moving into the repo:
 
-1. [Dependencies](#dependencies)
-1. [Building the project](#building-the-project)
-1. [Setting up the database](#setting-up-the-database)
-1. [Configuring a synced Ethereum node](#configuring-a-synced-ethereum-node)
+`GO111MODULE=off go get -d github.com/vulcanize/ipld-eth-server/v4`
 
-### Dependencies
- - Go 1.12+
- - Postgres 11.2
- - Ethereum Node
-   - [Go Ethereum](https://ethereum.github.io/go-ethereum/downloads/) (1.8.23+)
-   - [Parity 1.8.11+](https://github.com/paritytech/parity/releases)
+`cd $GOPATH/src/github.com/vulcanize/ipld-eth-server/v4@v4.x.x`
 
-### Building the project
-Download the codebase to your local `GOPATH` via:
-
-`go get github.com/vulcanize/vulcanizedb`
-
-Move to the project directory:
-
-`cd $GOPATH/src/github.com/vulcanize/vulcanizedb`
-
-Be sure you have enabled Go Modules (`export GO111MODULE=on`), and build the executable with:
+Then, build the binary:
 
 `make build`
 
-If you need to use a different dependency than what is currently defined in `go.mod`, it may helpful to look into [the replace directive](https://github.com/golang/go/wiki/Modules#when-should-i-use-the-replace-directive).
-This instruction enables you to point at a fork or the local filesystem for dependency resolution.
-
-If you are running into issues at this stage, ensure that `GOPATH` is defined in your shell.
-If necessary, `GOPATH` can be set in `~/.bashrc` or `~/.bash_profile`, depending upon your system.
-It can be additionally helpful to add `$GOPATH/bin` to your shell's `$PATH`.
-
-### Setting up the database
-1. Install Postgres
-1. Create a superuser for yourself and make sure `psql --list` works without prompting for a password.
-1. `createdb vulcanize_public`
-1. `cd $GOPATH/src/github.com/vulcanize/vulcanizedb`
-1.  Run the migrations: `make migrate HOST_NAME=localhost NAME=vulcanize_public PORT=5432`
-    - There is an optional var `USER=username` if the database user is not the default user `postgres`
-    - To rollback a single step: `make rollback NAME=vulcanize_public`
-    - To rollback to a certain migration: `make rollback_to MIGRATION=n NAME=vulcanize_public`
-    - To see status of migrations: `make migration_status NAME=vulcanize_public`
-
-    * See below for configuring additional environments
-    
-In some cases (such as recent Ubuntu systems), it may be necessary to overcome failures of password authentication from
-localhost. To allow access on Ubuntu, set localhost connections via hostname, ipv4, and ipv6 from peer/md5 to trust in: /etc/postgresql/<version>/pg_hba.conf
-
-(It should be noted that trusted auth should only be enabled on systems without sensitive data in them: development and local test databases)
-
-### Configuring a synced Ethereum node
-- To use a local Ethereum node, copy `environments/public.toml.example` to
-  `environments/public.toml` and update the `ipcPath` and `levelDbPath`.
-  - `ipcPath` should match the local node's IPC filepath:
-      - For Geth:
-        - The IPC file is called `geth.ipc`.
-        - The geth IPC file path is printed to the console when you start geth.
-        - The default location is:
-          - Mac: `<full home path>/Library/Ethereum/geth.ipc`
-          - Linux: `<full home path>/ethereum/geth.ipc`
-        - Note: the geth.ipc file may not exist until you've started the geth process
-
-      - For Parity:
-        - The IPC file is called `jsonrpc.ipc`.
-        - The default location is:
-          - Mac: `<full home path>/Library/Application\ Support/io.parity.ethereum/`
-          - Linux: `<full home path>/local/share/io.parity.ethereum/`
-
-  - `levelDbPath` should match Geth's chaindata directory path.
-      - The geth LevelDB chaindata path is printed to the console when you start geth.
-      - The default location is:
-          - Mac: `<full home path>/Library/Ethereum/geth/chaindata`
-          - Linux: `<full home path>/ethereum/geth/chaindata`
-      - `levelDbPath` is irrelevant (and `coldImport` is currently unavailable) if only running parity.
-
-
 ## Usage
-As mentioned above, VulcanizeDB's processes can be split into three categories: syncing, transforming and exposing data.
+After building the binary, run as
 
-### Data syncing
-To provide data for transformations, raw Ethereum data must first be synced into VulcanizeDB.
-This is accomplished through the use of the `headerSync`, `fullSync`, or `coldImport` commands.
-These commands are described in detail [here](documentation/data-syncing.md).
+`./ipld-eth-server serve --config=<the name of your config file.toml>`
 
-### Data transformation
-Data transformation uses the raw data that has been synced into Postgres to filter out and apply transformations to
-specific data of interest. Since there are different types of data that may be useful for observing smart contracts, it
-follows that there are different ways to transform this data. We've started by categorizing this into Generic and
-Custom transformers:
+### Configuration
 
-- Generic Contract Transformer: Generic contract transformation can be done using a built-in command,
-`contractWatcher`, which transforms contract events provided the contract's ABI is available. It also
-provides some state variable coverage by automating polling of public methods, with some restrictions.
-`contractWatcher` is described further [here](documentation/generic-transformer.md).
+Below is the set of parameters for the ipld-eth-server command, in .toml form, with the respective environmental variables commented to the side.
+The corresponding CLI flags can be found with the `./ipld-eth-server serve --help` command.
 
-- Custom Transformers: In many cases custom transformers will need to be written to provide
-more comprehensive coverage of contract data. In this case we have provided the `compose`, `execute`, and
-`composeAndExecute` commands for running custom transformers from external repositories. Documentation on how to write,
-build and run custom transformers as Go plugins can be found
-[here](documentation/custom-transformers.md).
+```toml
+[database]
+    name     = "vulcanize_public" # $DATABASE_NAME
+    hostname = "localhost" # $DATABASE_HOSTNAME
+    port     = 5432 # $DATABASE_PORT
+    user     = "postgres" # $DATABASE_USER
+    password = "" # $DATABASE_PASSWORD
 
-### Exposing the data
-[Postgraphile](https://www.graphile.org/postgraphile/) is used to expose GraphQL endpoints for our database schemas, this is described in detail [here](documentation/postgraphile.md).
+[log]
+    level = "info" # $LOGRUS_LEVEL
+
+[server]
+    ipcPath = "~/.vulcanize/vulcanize.ipc" # $SERVER_IPC_PATH
+    wsPath = "127.0.0.1:8081" # $SERVER_WS_PATH
+    httpPath = "127.0.0.1:8082" # $SERVER_HTTP_PATH
+    graphql = true # $SERVER_GRAPHQL
+    graphqlEndpoint = "" # $SERVER_GRAPHQL_ENDPOINT
+
+[ethereum]
+    chainID = "1" # $ETH_CHAIN_ID
+    defaultSender = "" # $ETH_DEFAULT_SENDER_ADDR
+    rpcGasCap = "1000000000000" # $ETH_RPC_GAS_CAP
+    httpPath = "127.0.0.1:8545" # $ETH_HTTP_PATH
+    nodeID = "arch1" # $ETH_NODE_ID
+    clientName = "Geth" # $ETH_CLIENT_NAME
+    genesisBlock = "0xd4e56740f876aef8c010b86a40d5f56745a118d0906a34e69aec8c0db1cb8fa3" # $ETH_GENESIS_BLOCK
+    networkID = "1" # $ETH_NETWORK_ID
+```
+
+The `database` fields are for connecting to a Postgres database that has been/is being populated by [ipld-eth-indexer](https://github.com/vulcanize/ipld-eth-indexer)  
+The `server` fields set the paths for exposing the ipld-eth-server endpoints  
+The `ethereum` fields set the chainID and default sender address to use for EVM simulation, and can optionally be used to configure a remote eth node to forward cache misses to  
 
 
-### Tests
-- Replace the empty `ipcPath` in the `environments/infura.toml` with a path to a full node's eth_jsonrpc endpoint (e.g. local geth node ipc path or infura url)
-    - Note: integration tests require configuration with an archival node
-- `createdb vulcanize_private` will create the test db
-- `make migrate NAME=vulcanize_private` will run the db migrations
-- `make test` will run the unit tests and skip the integration tests
-- `make integrationtest` will run just the integration tests
+### Endpoints
+#### IPLD subscription
+TODO: Port the IPLD RPC subscription endpoints after the decoupling
+
+#### Ethereum JSON-RPC
+ipld-eth-server currently recapitulates portions of the Ethereum JSON-RPC api standard.
+
+The currently supported standard endpoints are:  
+`eth_call`  
+`eth_getBalance`  
+`eth_getStorageAt`  
+`eth_getCode`  
+`eth_getProof`  
+`eth_blockNumber`  
+`eth_getHeaderByNumber`  
+`eth_getHeaderByHash`  
+`eth_getBlockByNumber`  
+`eth_getBlockByHash`  
+`eth_getTransactionCount`  
+`eth_getBlockTransactionCountByHash`  
+`eth_getBlockTransactionCountByNumber`  
+`eth_getTransactionByHash`  
+`eth_getRawTransactionByHash`  
+`eth_getTransactionByBlockHashAndIndex`  
+`eth_getTransactionByBlockNumberAndIndex`  
+`eth_getRawTransactionByBlockHashAndIndex`  
+`eth_getRawTransactionByBlockNumberAndIndex`  
+`eth_getTransactionReceipt`  
+`eth_getLogs`  
+`eth_getUncleCountByBlockHash`  
+`eth_getUncleCountByBlockNumber`  
+`eth_getUncleByBlockHashAndIndex`  
+`eth_getUncleByBlockNumberAndIndex`  
+
+TODO: Add the rest of the standard endpoints and unique endpoints (e.g. getSlice)
+
+
+### CLI Options and Environment variables
+
+
+| CLI Option                    | Environment Variable          | Default Value    | Comment                             |
+| ----------------------------- | ----------------------------- | ---------------- | ----------------------------------- |
+| `database-hostname`           | `DATABASE_HOSTNAME`           | localhost        | IPLD database host                  |
+| `database-port`               | `DATABASE_PORT`               | 5432             | IPLD database port                  |
+| `database-name`               | `DATABASE_NAME`               | vulcanize_public | IPLD database name                  |
+| `database-user`               | `DATABASE_USER`               |                  | IPLD database user                  |
+| `database-password`           | `DATABASE_PASSWORD`           |                  | IPLD database password              |
+| `eth-server-graphql`          | `ETH_SERVER_GRAPHQL`          | false            | If `true` enable Eth GraphQL Server |
+| `eth-server-graphql-path` | `ETH_SERVER_GRAPHQLPATH` |                  | If `eth-server-graphql` set to true, endpoint url for graphql server (host:port)                               |
+| `eth-server-http`          | `ETH_SERVER_HTTP`          | true            | If `true` enable Eth HTTP JSON-RPC Server |
+| `eth-server-http-path`          | `ETH_SERVER_HTTPPATH`          |             | If `eth-server-http` set to `true`, endpoint url for Eth HTTP JSON-RPC server (host:port)  |
+| `eth-server-ws`          | `ETH_SERVER_WS`          | false            | If `true` enable Eth WS JSON-RPC Server |
+| `eth-server-ws-path`          | `ETH_SERVER_WSPATH`          |             | If `eth-server-ws` set to `true`, endpoint url for Eth WS JSON-RPC server (host:port)  |
+| `eth-server-ipc`          | `ETH_SERVER_IPC`          | false            | If `true` enable Eth IPC JSON-RPC Server |
+| `eth-server-ipc-path`          | `ETH_SERVER_IPC_PATH`          |             | If `eth-server-ws` set to `true`, path for Eth IPC JSON-RPC server |
+| `ipld-server-graphql`          | `IPLD_SERVER_GRAPHQL`          | false            | If `true` enable IPLD GraphQL Server |
+| `ipld-server-graphql-path` | `IPLD_SERVER_GRAPHQLPATH` |                  | If `ipld-server-graphql` set to true, endpoint url for graphql server (host:port)                               |
+| `ipld-postgraphile-path` | `IPLD_POSTGRAPHILEPATH` |                  | If `ipld-server-graphql` set to true, http url for postgraphile server on top of IPLD db                        |
+| `tracing-http-path` | `TRACING_HTTPPATH` |                  | If `ipld-server-graphql` set to true, http url for tracing server                        |
+| `tracing-postgraphile-path` | `TRACING.POSTGRAPHILEPATH` |                  | If `ipld-server-graphql` set to true, http url for postgraphile server on top of tracing db                        |
+
+
+### Testing
+
+Follow steps in [test/README.md](./test/README.md)
+
+## Monitoring
+
+* Enable http server and metrics using parameters `--http --metrics`
+* ipld-eth-server exposes prometheus metrics at `/metric` endpoint
+* start prometheus using `monitoring/prometheus.yml` config (`prometheus --config.file=monitoring/prometheus.yml`)
+* start grafana, connect to prometheus datasource and import dashboard from `monitoring/grafana/dashboard_main.json`
+
+![](monitoring/grafana.png)
 
 
 ## Contributing
@@ -148,7 +166,5 @@ Contributions are welcome!
 
 VulcanizeDB follows the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct).
 
-For more information on contributing, please see [here](documentation/contributing.md).
-
 ## License
-[AGPL-3.0](LICENSE) © Vulcanize Inc
+[AGPL-3.0](LICENSE) © Vulcanize Inc

chain.json

@@ -0,0 +1,16 @@
+{
+  "chainId": 4,
+  "homesteadBlock": 1,
+  "eip150Block": 2,
+  "eip150Hash": "0x9b095b36c15eaf13044373aef8ee0bd3a382a5abb92e402afa44b8249c3a90e9",
+  "eip155Block": 3,
+  "eip158Block": 3,
+  "byzantiumBlock": 3,
+  "constantinopleBlock": 3,
+  "petersburgBlock": 3,
+  "istanbulBlock": 3,
+  "clique": {
+    "period": 15,
+    "epoch": 30000
+  }
+}

cmd/coldImport.go

@@ -1,97 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package cmd
-
-import (
-	log "github.com/sirupsen/logrus"
-	"github.com/spf13/cobra"
-
-	"github.com/vulcanize/vulcanizedb/pkg/crypto"
-	"github.com/vulcanize/vulcanizedb/pkg/datastore/ethereum"
-	"github.com/vulcanize/vulcanizedb/pkg/datastore/postgres/repositories"
-	"github.com/vulcanize/vulcanizedb/pkg/fs"
-	"github.com/vulcanize/vulcanizedb/pkg/geth/cold_import"
-	"github.com/vulcanize/vulcanizedb/pkg/geth/converters/cold_db"
-	vulcCommon "github.com/vulcanize/vulcanizedb/pkg/geth/converters/common"
-	"github.com/vulcanize/vulcanizedb/utils"
-)
-
-var coldImportCmd = &cobra.Command{
-	Use:   "coldImport",
-	Short: "Sync vulcanize from a cold instance of LevelDB.",
-	Long: `Populate core vulcanize db data directly out of LevelDB, rather than over rpc calls. For example:
-
-./vulcanizedb coldImport -s 0 -e 5000000
-
-Geth must be synced over all of the desired blocks and must not be running in order to execute this command.`,
-	Run: func(cmd *cobra.Command, args []string) {
-		SubCommand = cmd.CalledAs()
-		LogWithCommand = *log.WithField("SubCommand", SubCommand)
-		coldImport()
-	},
-}
-
-func init() {
-	rootCmd.AddCommand(coldImportCmd)
-	coldImportCmd.Flags().Int64VarP(&startingBlockNumber, "starting-block-number", "s", 0, "BlockNumber for first block to cold import.")
-	coldImportCmd.Flags().Int64VarP(&endingBlockNumber, "ending-block-number", "e", 5500000, "BlockNumber for last block to cold import.")
-	coldImportCmd.Flags().BoolVarP(&syncAll, "all", "a", false, "Option to sync all missing blocks.")
-}
-
-func coldImport() {
-	// init eth db
-	ethDBConfig := ethereum.CreateDatabaseConfig(ethereum.Level, levelDbPath)
-	ethDB, err := ethereum.CreateDatabase(ethDBConfig)
-	if err != nil {
-		LogWithCommand.Fatal("Error connecting to ethereum db: ", err)
-	}
-	mostRecentBlockNumberInDb := ethDB.GetHeadBlockNumber()
-	if syncAll {
-		startingBlockNumber = 0
-		endingBlockNumber = mostRecentBlockNumberInDb
-	}
-	if endingBlockNumber < startingBlockNumber {
-		LogWithCommand.Fatal("Ending block number must be greater than starting block number for cold import.")
-	}
-	if endingBlockNumber > mostRecentBlockNumberInDb {
-		LogWithCommand.Fatal("Ending block number is greater than most recent block in db: ", mostRecentBlockNumberInDb)
-	}
-
-	// init pg db
-	genesisBlock := ethDB.GetBlockHash(0)
-	reader := fs.FsReader{}
-	parser := crypto.EthPublicKeyParser{}
-	nodeBuilder := cold_import.NewColdImportNodeBuilder(reader, parser)
-	coldNode, err := nodeBuilder.GetNode(genesisBlock, levelDbPath)
-	if err != nil {
-		LogWithCommand.Fatal("Error getting node: ", err)
-	}
-	pgDB := utils.LoadPostgres(databaseConfig, coldNode)
-
-	// init cold importer deps
-	blockRepository := repositories.NewBlockRepository(&pgDB)
-	receiptRepository := repositories.FullSyncReceiptRepository{DB: &pgDB}
-	transactionConverter := cold_db.NewColdDbTransactionConverter()
-	blockConverter := vulcCommon.NewBlockConverter(transactionConverter)
-
-	// init and execute cold importer
-	coldImporter := cold_import.NewColdImporter(ethDB, blockRepository, receiptRepository, blockConverter)
-	err = coldImporter.Execute(startingBlockNumber, endingBlockNumber, coldNode.ID)
-	if err != nil {
-		LogWithCommand.Fatal("Error executing cold import: ", err)
-	}
-}

cmd/common.go

@@ -0,0 +1,37 @@
+// Copyright © 2021 Vulcanize, Inc
+//
+// 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 <http://www.gnu.org/licenses/>.
+
+package cmd
+
+import (
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+)
+
+func addDatabaseFlags(command *cobra.Command) {
+	// database flags
+	command.PersistentFlags().String("database-name", "vulcanize_public", "database name")
+	command.PersistentFlags().Int("database-port", 5432, "database port")
+	command.PersistentFlags().String("database-hostname", "localhost", "database hostname")
+	command.PersistentFlags().String("database-user", "", "database user")
+	command.PersistentFlags().String("database-password", "", "database password")
+
+	// database flag bindings
+	viper.BindPFlag("database.name", command.PersistentFlags().Lookup("database-name"))
+	viper.BindPFlag("database.port", command.PersistentFlags().Lookup("database-port"))
+	viper.BindPFlag("database.hostname", command.PersistentFlags().Lookup("database-hostname"))
+	viper.BindPFlag("database.user", command.PersistentFlags().Lookup("database-user"))
+	viper.BindPFlag("database.password", command.PersistentFlags().Lookup("database-password"))
+}

cmd/compose.go

@@ -1,192 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package cmd
-
-import (
-	"errors"
-	"fmt"
-	"strconv"
-
-	log "github.com/sirupsen/logrus"
-	"github.com/spf13/cobra"
-	"github.com/spf13/viper"
-
-	"github.com/vulcanize/vulcanizedb/pkg/config"
-	p2 "github.com/vulcanize/vulcanizedb/pkg/plugin"
-)
-
-// composeCmd represents the compose command
-var composeCmd = &cobra.Command{
-	Use:   "compose",
-	Short: "Composes transformer initializer plugin",
-	Long: `This command needs a config .toml file of form:
-
-[database]
-    name     = "vulcanize_public"
-    hostname = "localhost"
-    user     = "vulcanize"
-    password = "vulcanize"
-    port     = 5432
-
-[client]
-    ipcPath  = "/Users/user/Library/Ethereum/geth.ipc"
-
-[exporter]
-    home     = "github.com/vulcanize/vulcanizedb"
-    name     = "exampleTransformerExporter"
-    save     = false
-    transformerNames = [
-        "transformer1",
-        "transformer2",
-        "transformer3",
-        "transformer4",
-    ]
-    [exporter.transformer1]
-        path = "path/to/transformer1"
-        type = "eth_event"
-        repository = "github.com/account/repo"
-        migrations = "db/migrations"
-        rank = "0"
-    [exporter.transformer2]
-        path = "path/to/transformer2"
-        type = "eth_contract"
-        repository = "github.com/account/repo"
-        migrations = "db/migrations"
-        rank = "0"
-    [exporter.transformer3]
-        path = "path/to/transformer3"
-        type = "eth_event"
-        repository = "github.com/account/repo"
-        migrations = "db/migrations"
-        rank = "0"
-    [exporter.transformer4]
-        path = "path/to/transformer4"
-        type = "eth_storage"
-        repository = "github.com/account2/repo2"
-        migrations = "to/db/migrations"
-        rank = "1"
-
-
-Note: If any of the plugin transformer need additional
-configuration variables include them in the .toml file as well
-
-This information is used to write and build a go plugin with a transformer 
-set composed from the transformer imports specified in the config file
-This plugin is loaded and the set of transformer initializers is exported
-from it and loaded into and executed over by the appropriate watcher. 
-
-The type of watcher that the transformer works with is specified using the 
-type variable for each transformer in the config. Currently there are watchers 
-of event data from an eth node (eth_event) and storage data from an eth node 
-(eth_storage), and a more generic interface for accepting contract_watcher pkg
-based transformers which can perform both event watching and public method 
-polling (eth_contract).
-
-Transformers of different types can be ran together in the same command using a 
-single config file or in separate command instances using different config files
-
-Specify config location when executing the command:
-./vulcanizedb compose --config=./environments/config_name.toml`,
-	Run: func(cmd *cobra.Command, args []string) {
-		SubCommand = cmd.CalledAs()
-		LogWithCommand = *log.WithField("SubCommand", SubCommand)
-		compose()
-	},
-}
-
-func compose() {
-	// Build plugin generator config
-	prepConfig()
-
-	// Generate code to build the plugin according to the config file
-	LogWithCommand.Info("generating plugin")
-	generator, err := p2.NewGenerator(genConfig, databaseConfig)
-	if err != nil {
-		LogWithCommand.Debug("initializing plugin generator failed")
-		LogWithCommand.Fatal(err)
-	}
-	err = generator.GenerateExporterPlugin()
-	if err != nil {
-		LogWithCommand.Debug("generating plugin failed")
-		LogWithCommand.Fatal(err)
-	}
-	// TODO: Embed versioning info in the .so files so we know which version of vulcanizedb to run them with
-	_, pluginPath, err := genConfig.GetPluginPaths()
-	if err != nil {
-		LogWithCommand.Debug("getting plugin path failed")
-		LogWithCommand.Fatal(err)
-	}
-	fmt.Printf("Composed plugin %s", pluginPath)
-	LogWithCommand.Info("plugin .so file output to ", pluginPath)
-}
-
-func init() {
-	rootCmd.AddCommand(composeCmd)
-}
-
-func prepConfig() {
-	LogWithCommand.Info("configuring plugin")
-	names := viper.GetStringSlice("exporter.transformerNames")
-	transformers := make(map[string]config.Transformer)
-	for _, name := range names {
-		transformer := viper.GetStringMapString("exporter." + name)
-		p, pOK := transformer["path"]
-		if !pOK || p == "" {
-			LogWithCommand.Fatal(name, " transformer config is missing `path` value")
-		}
-		r, rOK := transformer["repository"]
-		if !rOK || r == "" {
-			LogWithCommand.Fatal(name, " transformer config is missing `repository` value")
-		}
-		m, mOK := transformer["migrations"]
-		if !mOK || m == "" {
-			LogWithCommand.Fatal(name, " transformer config is missing `migrations` value")
-		}
-		mr, mrOK := transformer["rank"]
-		if !mrOK || mr == "" {
-			LogWithCommand.Fatal(name, " transformer config is missing `rank` value")
-		}
-		rank, err := strconv.ParseUint(mr, 10, 64)
-		if err != nil {
-			LogWithCommand.Fatal(name, " migration `rank` can't be converted to an unsigned integer")
-		}
-		t, tOK := transformer["type"]
-		if !tOK {
-			LogWithCommand.Fatal(name, " transformer config is missing `type` value")
-		}
-		transformerType := config.GetTransformerType(t)
-		if transformerType == config.UnknownTransformerType {
-			LogWithCommand.Fatal(errors.New(`unknown transformer type in exporter config accepted types are "eth_event", "eth_storage"`))
-		}
-
-		transformers[name] = config.Transformer{
-			Path:           p,
-			Type:           transformerType,
-			RepositoryPath: r,
-			MigrationPath:  m,
-			MigrationRank:  rank,
-		}
-	}
-
-	genConfig = config.Plugin{
-		Transformers: transformers,
-		FilePath:     "$GOPATH/src/github.com/vulcanize/vulcanizedb/plugins",
-		FileName:     viper.GetString("exporter.name"),
-		Save:         viper.GetBool("exporter.save"),
-		Home:         viper.GetString("exporter.home"),
-	}
-}

cmd/composeAndExecute.go

@@ -1,200 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package cmd
-
-import (
-	"os"
-	"plugin"
-	syn "sync"
-	"time"
-
-	log "github.com/sirupsen/logrus"
-	"github.com/spf13/cobra"
-
-	"github.com/vulcanize/vulcanizedb/libraries/shared/fetcher"
-	"github.com/vulcanize/vulcanizedb/libraries/shared/watcher"
-	"github.com/vulcanize/vulcanizedb/pkg/fs"
-	p2 "github.com/vulcanize/vulcanizedb/pkg/plugin"
-	"github.com/vulcanize/vulcanizedb/pkg/plugin/helpers"
-	"github.com/vulcanize/vulcanizedb/utils"
-)
-
-// composeAndExecuteCmd represents the composeAndExecute command
-var composeAndExecuteCmd = &cobra.Command{
-	Use:   "composeAndExecute",
-	Short: "Composes, loads, and executes transformer initializer plugin",
-	Long: `This command needs a config .toml file of form:
-
-[database]
-    name     = "vulcanize_public"
-    hostname = "localhost"
-    user     = "vulcanize"
-    password = "vulcanize"
-    port     = 5432
-
-[client]
-    ipcPath  = "/Users/user/Library/Ethereum/geth.ipc"
-
-[exporter]
-    home     = "github.com/vulcanize/vulcanizedb"
-    name     = "exampleTransformerExporter"
-    save     = false
-    transformerNames = [
-        "transformer1",
-        "transformer2",
-        "transformer3",
-        "transformer4",
-    ]
-    [exporter.transformer1]
-        path = "path/to/transformer1"
-        type = "eth_event"
-        repository = "github.com/account/repo"
-        migrations = "db/migrations"
-        rank = "0"
-    [exporter.transformer2]
-        path = "path/to/transformer2"
-        type = "eth_contract"
-        repository = "github.com/account/repo"
-        migrations = "db/migrations"
-        rank = "2"
-    [exporter.transformer3]
-        path = "path/to/transformer3"
-        type = "eth_event"
-        repository = "github.com/account/repo"
-        migrations = "db/migrations"
-        rank = "0"
-    [exporter.transformer4]
-        path = "path/to/transformer4"
-        type = "eth_storage"
-        repository = "github.com/account2/repo2"
-        migrations = "to/db/migrations"
-        rank = "1"
-
-
-Note: If any of the plugin transformer need additional
-configuration variables include them in the .toml file as well
-
-This information is used to write and build a go plugin with a transformer 
-set composed from the transformer imports specified in the config file
-This plugin is loaded and the set of transformer initializers is exported
-from it and loaded into and executed over by the appropriate watcher. 
-
-The type of watcher that the transformer works with is specified using the 
-type variable for each transformer in the config. Currently there are watchers 
-of event data from an eth node (eth_event) and storage data from an eth node 
-(eth_storage), and a more generic interface for accepting contract_watcher pkg
-based transformers which can perform both event watching and public method 
-polling (eth_contract).
-
-Transformers of different types can be ran together in the same command using a 
-single config file or in separate command instances using different config files
-
-Specify config location when executing the command:
-./vulcanizedb composeAndExecute --config=./environments/config_name.toml`,
-	Run: func(cmd *cobra.Command, args []string) {
-		SubCommand = cmd.CalledAs()
-		LogWithCommand = *log.WithField("SubCommand", SubCommand)
-		composeAndExecute()
-	},
-}
-
-func composeAndExecute() {
-	// Build plugin generator config
-	prepConfig()
-
-	// Generate code to build the plugin according to the config file
-	LogWithCommand.Info("generating plugin")
-	generator, err := p2.NewGenerator(genConfig, databaseConfig)
-	if err != nil {
-		LogWithCommand.Fatal(err)
-	}
-	err = generator.GenerateExporterPlugin()
-	if err != nil {
-		LogWithCommand.Debug("generating plugin failed")
-		LogWithCommand.Fatal(err)
-	}
-
-	// Get the plugin path and load the plugin
-	_, pluginPath, err := genConfig.GetPluginPaths()
-	if err != nil {
-		LogWithCommand.Fatal(err)
-	}
-	if !genConfig.Save {
-		defer helpers.ClearFiles(pluginPath)
-	}
-	LogWithCommand.Info("linking plugin ", pluginPath)
-	plug, err := plugin.Open(pluginPath)
-	if err != nil {
-		LogWithCommand.Debug("linking plugin failed")
-		LogWithCommand.Fatal(err)
-	}
-
-	// Load the `Exporter` symbol from the plugin
-	LogWithCommand.Info("loading transformers from plugin")
-	symExporter, err := plug.Lookup("Exporter")
-	if err != nil {
-		LogWithCommand.Debug("loading Exporter symbol failed")
-		LogWithCommand.Fatal(err)
-	}
-
-	// Assert that the symbol is of type Exporter
-	exporter, ok := symExporter.(Exporter)
-	if !ok {
-		LogWithCommand.Debug("plugged-in symbol not of type Exporter")
-		os.Exit(1)
-	}
-
-	// Use the Exporters export method to load the EventTransformerInitializer, StorageTransformerInitializer, and ContractTransformerInitializer sets
-	ethEventInitializers, ethStorageInitializers, ethContractInitializers := exporter.Export()
-
-	// Setup bc and db objects
-	blockChain := getBlockChain()
-	db := utils.LoadPostgres(databaseConfig, blockChain.Node())
-
-	// Execute over transformer sets returned by the exporter
-	// Use WaitGroup to wait on both goroutines
-	var wg syn.WaitGroup
-	if len(ethEventInitializers) > 0 {
-		ew := watcher.NewEventWatcher(&db, blockChain)
-		ew.AddTransformers(ethEventInitializers)
-		wg.Add(1)
-		go watchEthEvents(&ew, &wg)
-	}
-
-	if len(ethStorageInitializers) > 0 {
-		tailer := fs.FileTailer{Path: storageDiffsPath}
-		storageFetcher := fetcher.NewCsvTailStorageFetcher(tailer)
-		sw := watcher.NewStorageWatcher(storageFetcher, &db)
-		sw.AddTransformers(ethStorageInitializers)
-		wg.Add(1)
-		go watchEthStorage(&sw, &wg)
-	}
-
-	if len(ethContractInitializers) > 0 {
-		gw := watcher.NewContractWatcher(&db, blockChain)
-		gw.AddTransformers(ethContractInitializers)
-		wg.Add(1)
-		go watchEthContract(&gw, &wg)
-	}
-	wg.Wait()
-}
-
-func init() {
-	rootCmd.AddCommand(composeAndExecuteCmd)
-	composeAndExecuteCmd.Flags().BoolVarP(&recheckHeadersArg, "recheck-headers", "r", false, "whether to re-check headers for watched events")
-	composeAndExecuteCmd.Flags().DurationVarP(&queueRecheckInterval, "queue-recheck-interval", "q", 5*time.Minute, "interval duration for rechecking queued storage diffs (ex: 5m30s)")
-}

cmd/contractWatcher.go

@@ -1,127 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package cmd
-
-import (
-	"fmt"
-	"github.com/vulcanize/vulcanizedb/pkg/config"
-	"time"
-
-	log "github.com/sirupsen/logrus"
-	"github.com/spf13/cobra"
-
-	st "github.com/vulcanize/vulcanizedb/libraries/shared/transformer"
-	ft "github.com/vulcanize/vulcanizedb/pkg/contract_watcher/full/transformer"
-	ht "github.com/vulcanize/vulcanizedb/pkg/contract_watcher/header/transformer"
-	"github.com/vulcanize/vulcanizedb/utils"
-)
-
-// contractWatcherCmd represents the contractWatcher command
-var contractWatcherCmd = &cobra.Command{
-	Use:   "contractWatcher",
-	Short: "Watches events at the provided contract address using fully synced vDB",
-	Long: `Uses input contract address and event filters to watch events
-
-Expects an ethereum node to be running
-Expects an archival node synced into vulcanizeDB
-Requires a .toml config file:
-
-  [database]
-    name     = "vulcanize_public"
-    hostname = "localhost"
-    port     = 5432
-
-  [client]
-    ipcPath  = "/Users/user/Library/Ethereum/geth.ipc"
-
-  [contract]
-    network  = ""
-    addresses  = [
-        "contractAddress1",
-        "contractAddress2"
-    ]
-    [contract.contractAddress1]
-        abi    = 'ABI for contract 1'
-        startingBlock = 982463
-    [contract.contractAddress2]
-        abi    = 'ABI for contract 2'
-        events = [
-            "event1",
-            "event2"
-        ]
-		eventArgs = [
-			"arg1",
-			"arg2"
-		]
-        methods = [
-            "method1",
-			"method2"
-        ]
-		methodArgs = [
-			"arg1",
-			"arg2"
-		]
-        startingBlock = 4448566
-        piping = true
-`,
-	Run: func(cmd *cobra.Command, args []string) {
-		SubCommand = cmd.CalledAs()
-		LogWithCommand = *log.WithField("SubCommand", SubCommand)
-		contractWatcher()
-	},
-}
-
-var (
-	mode string
-)
-
-func contractWatcher() {
-	ticker := time.NewTicker(5 * time.Second)
-	defer ticker.Stop()
-
-	blockChain := getBlockChain()
-	db := utils.LoadPostgres(databaseConfig, blockChain.Node())
-
-	var t st.ContractTransformer
-	con := config.ContractConfig{}
-	con.PrepConfig()
-	switch mode {
-	case "header":
-		t = ht.NewTransformer(con, blockChain, &db)
-	case "full":
-		t = ft.NewTransformer(con, blockChain, &db)
-	default:
-		LogWithCommand.Fatal("Invalid mode")
-	}
-
-	err := t.Init()
-	if err != nil {
-		LogWithCommand.Fatal(fmt.Sprintf("Failed to initialize transformer, err: %v ", err))
-	}
-
-	for range ticker.C {
-		err = t.Execute()
-		if err != nil {
-			LogWithCommand.Error("Execution error for transformer: ", t.GetConfig().Name, err)
-		}
-	}
-}
-
-func init() {
-	rootCmd.AddCommand(contractWatcherCmd)
-	contractWatcherCmd.Flags().StringVarP(&mode, "mode", "o", "header", "'header' or 'full' mode to work with either header synced or fully synced vDB (default is header)")
-}

cmd/execute.go

@@ -1,189 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package cmd
-
-import (
-	"fmt"
-	"plugin"
-	syn "sync"
-	"time"
-
-	log "github.com/sirupsen/logrus"
-	"github.com/spf13/cobra"
-
-	"github.com/vulcanize/vulcanizedb/libraries/shared/constants"
-	"github.com/vulcanize/vulcanizedb/libraries/shared/fetcher"
-	storageUtils "github.com/vulcanize/vulcanizedb/libraries/shared/storage/utils"
-	"github.com/vulcanize/vulcanizedb/libraries/shared/transformer"
-	"github.com/vulcanize/vulcanizedb/libraries/shared/watcher"
-	"github.com/vulcanize/vulcanizedb/pkg/fs"
-	"github.com/vulcanize/vulcanizedb/utils"
-)
-
-// executeCmd represents the execute command
-var executeCmd = &cobra.Command{
-	Use:   "execute",
-	Short: "executes a precomposed transformer initializer plugin",
-	Long: `This command needs a config .toml file of form:
-
-[database]
-    name     = "vulcanize_public"
-    hostname = "localhost"
-    user     = "vulcanize"
-    password = "vulcanize"
-    port     = 5432
-
-[client]
-    ipcPath  = "/Users/user/Library/Ethereum/geth.ipc"
-
-[exporter]
-    name     = "exampleTransformerExporter"
-
-Note: If any of the plugin transformer need additional
-configuration variables include them in the .toml file as well
-
-The exporter.name is the name (without extension) of the plugin to be loaded.
-The plugin file needs to be located in the /plugins directory and this command assumes 
-the db migrations remain from when the plugin was composed. Additionally, the plugin 
-must have been composed by the same version of vulcanizedb or else it will not be compatible.
-
-Specify config location when executing the command:
-./vulcanizedb execute --config=./environments/config_name.toml`,
-	Run: func(cmd *cobra.Command, args []string) {
-		SubCommand = cmd.CalledAs()
-		LogWithCommand = *log.WithField("SubCommand", SubCommand)
-		execute()
-	},
-}
-
-func execute() {
-	// Build plugin generator config
-	prepConfig()
-
-	// Get the plugin path and load the plugin
-	_, pluginPath, err := genConfig.GetPluginPaths()
-	if err != nil {
-		LogWithCommand.Fatal(err)
-	}
-
-	fmt.Printf("Executing plugin %s", pluginPath)
-	LogWithCommand.Info("linking plugin ", pluginPath)
-	plug, err := plugin.Open(pluginPath)
-	if err != nil {
-		LogWithCommand.Warn("linking plugin failed")
-		LogWithCommand.Fatal(err)
-	}
-
-	// Load the `Exporter` symbol from the plugin
-	LogWithCommand.Info("loading transformers from plugin")
-	symExporter, err := plug.Lookup("Exporter")
-	if err != nil {
-		LogWithCommand.Warn("loading Exporter symbol failed")
-		LogWithCommand.Fatal(err)
-	}
-
-	// Assert that the symbol is of type Exporter
-	exporter, ok := symExporter.(Exporter)
-	if !ok {
-		LogWithCommand.Fatal("plugged-in symbol not of type Exporter")
-	}
-
-	// Use the Exporters export method to load the EventTransformerInitializer, StorageTransformerInitializer, and ContractTransformerInitializer sets
-	ethEventInitializers, ethStorageInitializers, ethContractInitializers := exporter.Export()
-
-	// Setup bc and db objects
-	blockChain := getBlockChain()
-	db := utils.LoadPostgres(databaseConfig, blockChain.Node())
-
-	// Execute over transformer sets returned by the exporter
-	// Use WaitGroup to wait on both goroutines
-	var wg syn.WaitGroup
-	if len(ethEventInitializers) > 0 {
-		ew := watcher.NewEventWatcher(&db, blockChain)
-		ew.AddTransformers(ethEventInitializers)
-		wg.Add(1)
-		go watchEthEvents(&ew, &wg)
-	}
-
-	if len(ethStorageInitializers) > 0 {
-		tailer := fs.FileTailer{Path: storageDiffsPath}
-		storageFetcher := fetcher.NewCsvTailStorageFetcher(tailer)
-		sw := watcher.NewStorageWatcher(storageFetcher, &db)
-		sw.AddTransformers(ethStorageInitializers)
-		wg.Add(1)
-		go watchEthStorage(&sw, &wg)
-	}
-
-	if len(ethContractInitializers) > 0 {
-		gw := watcher.NewContractWatcher(&db, blockChain)
-		gw.AddTransformers(ethContractInitializers)
-		wg.Add(1)
-		go watchEthContract(&gw, &wg)
-	}
-	wg.Wait()
-}
-
-func init() {
-	rootCmd.AddCommand(executeCmd)
-	executeCmd.Flags().BoolVarP(&recheckHeadersArg, "recheck-headers", "r", false, "whether to re-check headers for watched events")
-	executeCmd.Flags().DurationVarP(&queueRecheckInterval, "queue-recheck-interval", "q", 5*time.Minute, "interval duration for rechecking queued storage diffs (ex: 5m30s)")
-}
-
-type Exporter interface {
-	Export() ([]transformer.EventTransformerInitializer, []transformer.StorageTransformerInitializer, []transformer.ContractTransformerInitializer)
-}
-
-func watchEthEvents(w *watcher.EventWatcher, wg *syn.WaitGroup) {
-	defer wg.Done()
-	// Execute over the EventTransformerInitializer set using the watcher
-	LogWithCommand.Info("executing event transformers")
-	var recheck constants.TransformerExecution
-	if recheckHeadersArg {
-		recheck = constants.HeaderRecheck
-	} else {
-		recheck = constants.HeaderMissing
-	}
-	ticker := time.NewTicker(pollingInterval)
-	defer ticker.Stop()
-	for range ticker.C {
-		w.Execute(recheck)
-	}
-}
-
-func watchEthStorage(w *watcher.StorageWatcher, wg *syn.WaitGroup) {
-	defer wg.Done()
-	// Execute over the StorageTransformerInitializer set using the storage watcher
-	LogWithCommand.Info("executing storage transformers")
-	ticker := time.NewTicker(pollingInterval)
-	defer ticker.Stop()
-	for range ticker.C {
-		errs := make(chan error)
-		rows := make(chan storageUtils.StorageDiffRow)
-		w.Execute(rows, errs, queueRecheckInterval)
-	}
-}
-
-func watchEthContract(w *watcher.ContractWatcher, wg *syn.WaitGroup) {
-	defer wg.Done()
-	// Execute over the ContractTransformerInitializer set using the contract watcher
-	LogWithCommand.Info("executing contract_watcher transformers")
-	ticker := time.NewTicker(pollingInterval)
-	defer ticker.Stop()
-	for range ticker.C {
-		w.Execute()
-	}
-}

cmd/fullSync.go

@@ -1,105 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package cmd
-
-import (
-	"time"
-
-	log "github.com/sirupsen/logrus"
-	"github.com/spf13/cobra"
-
-	"github.com/vulcanize/vulcanizedb/pkg/core"
-	"github.com/vulcanize/vulcanizedb/pkg/datastore"
-	"github.com/vulcanize/vulcanizedb/pkg/datastore/postgres/repositories"
-	"github.com/vulcanize/vulcanizedb/pkg/history"
-	"github.com/vulcanize/vulcanizedb/utils"
-)
-
-// fullSyncCmd represents the fullSync command
-var fullSyncCmd = &cobra.Command{
-	Use:   "fullSync",
-	Short: "Syncs VulcanizeDB with local ethereum node",
-	Long: `Syncs VulcanizeDB with local ethereum node. Populates
-Postgres with blocks, transactions, receipts, and logs.
-
-./vulcanizedb fullSync --starting-block-number 0 --config public.toml
-
-Expects ethereum node to be running and requires a .toml config:
-
-  [database]
-  name = "vulcanize_public"
-  hostname = "localhost"
-  port = 5432
-
-  [client]
-  ipcPath = "/Users/user/Library/Ethereum/geth.ipc"
-`,
-	Run: func(cmd *cobra.Command, args []string) {
-		SubCommand = cmd.CalledAs()
-		LogWithCommand = *log.WithField("SubCommand", SubCommand)
-		fullSync()
-	},
-}
-
-func init() {
-	rootCmd.AddCommand(fullSyncCmd)
-	fullSyncCmd.Flags().Int64VarP(&startingBlockNumber, "starting-block-number", "s", 0, "Block number to start syncing from")
-}
-
-func backFillAllBlocks(blockchain core.BlockChain, blockRepository datastore.BlockRepository, missingBlocksPopulated chan int, startingBlockNumber int64) {
-	populated, err := history.PopulateMissingBlocks(blockchain, blockRepository, startingBlockNumber)
-	if err != nil {
-		LogWithCommand.Error("backfillAllBlocks: error in populateMissingBlocks: ", err)
-	}
-	missingBlocksPopulated <- populated
-}
-
-func fullSync() {
-	ticker := time.NewTicker(pollingInterval)
-	defer ticker.Stop()
-
-	blockChain := getBlockChain()
-	lastBlock, err := blockChain.LastBlock()
-	if err != nil {
-		LogWithCommand.Error("fullSync: Error getting last block: ", err)
-	}
-	if lastBlock.Int64() == 0 {
-		LogWithCommand.Fatal("geth initial: state sync not finished")
-	}
-	if startingBlockNumber > lastBlock.Int64() {
-		LogWithCommand.Fatal("fullSync: starting block number > current block number")
-	}
-
-	db := utils.LoadPostgres(databaseConfig, blockChain.Node())
-	blockRepository := repositories.NewBlockRepository(&db)
-	validator := history.NewBlockValidator(blockChain, blockRepository, validationWindow)
-	missingBlocksPopulated := make(chan int)
-	go backFillAllBlocks(blockChain, blockRepository, missingBlocksPopulated, startingBlockNumber)
-
-	for {
-		select {
-		case <-ticker.C:
-			window, err := validator.ValidateBlocks()
-			if err != nil {
-				LogWithCommand.Error("fullSync: error in validateBlocks: ", err)
-			}
-			LogWithCommand.Debug(window.GetString())
-		case <-missingBlocksPopulated:
-			go backFillAllBlocks(blockChain, blockRepository, missingBlocksPopulated, startingBlockNumber)
-		}
-	}
-}

cmd/headerSync.go

@@ -1,114 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package cmd
-
-import (
-	"time"
-
-	log "github.com/sirupsen/logrus"
-	"github.com/spf13/cobra"
-
-	"github.com/vulcanize/vulcanizedb/pkg/core"
-	"github.com/vulcanize/vulcanizedb/pkg/datastore"
-	"github.com/vulcanize/vulcanizedb/pkg/datastore/postgres/repositories"
-	"github.com/vulcanize/vulcanizedb/pkg/geth"
-	"github.com/vulcanize/vulcanizedb/pkg/history"
-	"github.com/vulcanize/vulcanizedb/utils"
-)
-
-// headerSyncCmd represents the headerSync command
-var headerSyncCmd = &cobra.Command{
-	Use:   "headerSync",
-	Short: "Syncs VulcanizeDB with local ethereum node's block headers",
-	Long: `Syncs VulcanizeDB with local ethereum node. Populates
-Postgres with block headers.
-
-./vulcanizedb headerSync --starting-block-number 0 --config public.toml
-
-Expects ethereum node to be running and requires a .toml config:
-
-  [database]
-  name = "vulcanize_public"
-  hostname = "localhost"
-  port = 5432
-
-  [client]
-  ipcPath = "/Users/user/Library/Ethereum/geth.ipc"
-`,
-	Run: func(cmd *cobra.Command, args []string) {
-		SubCommand = cmd.CalledAs()
-		LogWithCommand = *log.WithField("SubCommand", SubCommand)
-		headerSync()
-	},
-}
-
-func init() {
-	rootCmd.AddCommand(headerSyncCmd)
-	headerSyncCmd.Flags().Int64VarP(&startingBlockNumber, "starting-block-number", "s", 0, "Block number to start syncing from")
-}
-
-func backFillAllHeaders(blockchain core.BlockChain, headerRepository datastore.HeaderRepository, missingBlocksPopulated chan int, startingBlockNumber int64) {
-	populated, err := history.PopulateMissingHeaders(blockchain, headerRepository, startingBlockNumber)
-	if err != nil {
-		// TODO Lots of possible errors in the call stack above. If errors occur, we still put
-		// 0 in the channel, triggering another round
-		LogWithCommand.Error("backfillAllHeaders: Error populating headers: ", err)
-	}
-	missingBlocksPopulated <- populated
-}
-
-func headerSync() {
-	ticker := time.NewTicker(pollingInterval)
-	defer ticker.Stop()
-	blockChain := getBlockChain()
-	validateArgs(blockChain)
-	db := utils.LoadPostgres(databaseConfig, blockChain.Node())
-
-	headerRepository := repositories.NewHeaderRepository(&db)
-	validator := history.NewHeaderValidator(blockChain, headerRepository, validationWindow)
-	missingBlocksPopulated := make(chan int)
-	go backFillAllHeaders(blockChain, headerRepository, missingBlocksPopulated, startingBlockNumber)
-
-	for {
-		select {
-		case <-ticker.C:
-			window, err := validator.ValidateHeaders()
-			if err != nil {
-				LogWithCommand.Error("headerSync: ValidateHeaders failed: ", err)
-			}
-			LogWithCommand.Debug(window.GetString())
-		case n := <-missingBlocksPopulated:
-			if n == 0 {
-				time.Sleep(3 * time.Second)
-			}
-			go backFillAllHeaders(blockChain, headerRepository, missingBlocksPopulated, startingBlockNumber)
-		}
-	}
-}
-
-func validateArgs(blockChain *geth.BlockChain) {
-	lastBlock, err := blockChain.LastBlock()
-	if err != nil {
-		LogWithCommand.Error("validateArgs: Error getting last block: ", err)
-	}
-	if lastBlock.Int64() == 0 {
-		LogWithCommand.Fatal("geth initial: state sync not finished")
-	}
-	if startingBlockNumber > lastBlock.Int64() {
-		LogWithCommand.Fatal("starting block number > current block number")
-	}
-}

cmd/root.go

@@ -18,79 +18,73 @@ package cmd
 
 import (
 	"fmt"
+	"os"
+	"path/filepath"
 	"strings"
-	"time"
 
-	"github.com/ethereum/go-ethereum/ethclient"
-	"github.com/ethereum/go-ethereum/rpc"
+	"github.com/joho/godotenv"
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 
-	"github.com/vulcanize/vulcanizedb/pkg/config"
-	"github.com/vulcanize/vulcanizedb/pkg/geth"
-	"github.com/vulcanize/vulcanizedb/pkg/geth/client"
-	vRpc "github.com/vulcanize/vulcanizedb/pkg/geth/converters/rpc"
-	"github.com/vulcanize/vulcanizedb/pkg/geth/node"
+	"github.com/vulcanize/ipld-eth-server/v4/pkg/prom"
 )
 
 var (
-	cfgFile              string
-	databaseConfig       config.Database
-	genConfig            config.Plugin
-	ipc                  string
-	levelDbPath          string
-	queueRecheckInterval time.Duration
-	startingBlockNumber  int64
-	storageDiffsPath     string
-	syncAll              bool
-	endingBlockNumber    int64
-	recheckHeadersArg    bool
-	SubCommand           string
-	LogWithCommand       log.Entry
-)
-
-const (
-	pollingInterval  = 7 * time.Second
-	validationWindow = 15
+	cfgFile        string
+	envFile        string
+	subCommand     string
+	logWithCommand log.Entry
 )
 
 var rootCmd = &cobra.Command{
-	Use:              "vulcanizedb",
+	Use:              "ipld-eth-server",
 	PersistentPreRun: initFuncs,
 }
 
 func Execute() {
-	log.Info("----- Starting vDB -----")
+	log.Info("----- Starting IPFS blockchain watcher -----")
 	if err := rootCmd.Execute(); err != nil {
 		log.Fatal(err)
 	}
 }
 
 func initFuncs(cmd *cobra.Command, args []string) {
-	setViperConfigs()
-	logLvlErr := logLevel()
-	if logLvlErr != nil {
-		log.Fatal("Could not set log level: ", logLvlErr)
+	viper.BindEnv("log.file", "LOGRUS_FILE")
+	logfile := viper.GetString("log.file")
+	if logfile != "" {
+		file, err := os.OpenFile(logfile,
+			os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
+		if err == nil {
+			log.Infof("Directing output to %s", logfile)
+			log.SetOutput(file)
+		} else {
+			log.SetOutput(os.Stdout)
+			log.Info("Failed to log to file, using default stdout")
+		}
+	} else {
+		log.SetOutput(os.Stdout)
+	}
+	if err := logLevel(); err != nil {
+		log.Fatal("Could not set log level: ", err)
 	}
 
-}
+	if viper.GetBool("metrics") {
+		prom.Init()
+	}
 
-func setViperConfigs() {
-	ipc = viper.GetString("client.ipcpath")
-	levelDbPath = viper.GetString("client.leveldbpath")
-	storageDiffsPath = viper.GetString("filesystem.storageDiffsPath")
-	databaseConfig = config.Database{
-		Name:     viper.GetString("database.name"),
-		Hostname: viper.GetString("database.hostname"),
-		Port:     viper.GetInt("database.port"),
-		User:     viper.GetString("database.user"),
-		Password: viper.GetString("database.password"),
+	if viper.GetBool("prom.http") {
+		addr := fmt.Sprintf(
+			"%s:%s",
+			viper.GetString("prom.http.addr"),
+			viper.GetString("prom.http.port"),
+		)
+		prom.Serve(addr)
 	}
-	viper.Set("database.config", databaseConfig)
 }
 
 func logLevel() error {
+	viper.BindEnv("log.level", "LOGRUS_LEVEL")
 	lvl, err := log.ParseLevel(viper.GetString("log.level"))
 	if err != nil {
 		return err
@@ -105,62 +99,59 @@ func logLevel() error {
 
 func init() {
 	cobra.OnInitialize(initConfig)
-	// When searching for env variables, replace dots in config keys with underscores
 	viper.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))
 	viper.AutomaticEnv()
 
 	rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file location")
-	rootCmd.PersistentFlags().String("database-name", "vulcanize_public", "database name")
-	rootCmd.PersistentFlags().Int("database-port", 5432, "database port")
-	rootCmd.PersistentFlags().String("database-hostname", "localhost", "database hostname")
-	rootCmd.PersistentFlags().String("database-user", "", "database user")
-	rootCmd.PersistentFlags().String("database-password", "", "database password")
+	rootCmd.PersistentFlags().StringVar(&envFile, "env", "", "environment file location")
+
 	rootCmd.PersistentFlags().String("client-ipcPath", "", "location of geth.ipc file")
-	rootCmd.PersistentFlags().String("client-levelDbPath", "", "location of levelDb chaindata")
-	rootCmd.PersistentFlags().String("filesystem-storageDiffsPath", "", "location of storage diffs csv file")
-	rootCmd.PersistentFlags().String("exporter-name", "exporter", "name of exporter plugin")
-	rootCmd.PersistentFlags().String("log-level", log.InfoLevel.String(), "Log level (trace, debug, info, warn, error, fatal, panic")
+	rootCmd.PersistentFlags().String("log-level", log.InfoLevel.String(), "log level (trace, debug, info, warn, error, fatal, panic)")
+	rootCmd.PersistentFlags().String("log-file", "", "file path for logging")
+
+	rootCmd.PersistentFlags().Bool("metrics", false, "enable metrics")
+
+	rootCmd.PersistentFlags().Bool("prom-http", false, "enable http service for prometheus")
+	rootCmd.PersistentFlags().String("prom-http-addr", "127.0.0.1", "http host for prometheus")
+	rootCmd.PersistentFlags().String("prom-http-port", "8090", "http port for prometheus")
 
-	viper.BindPFlag("database.name", rootCmd.PersistentFlags().Lookup("database-name"))
-	viper.BindPFlag("database.port", rootCmd.PersistentFlags().Lookup("database-port"))
-	viper.BindPFlag("database.hostname", rootCmd.PersistentFlags().Lookup("database-hostname"))
-	viper.BindPFlag("database.user", rootCmd.PersistentFlags().Lookup("database-user"))
-	viper.BindPFlag("database.password", rootCmd.PersistentFlags().Lookup("database-password"))
-	viper.BindPFlag("client.ipcPath", rootCmd.PersistentFlags().Lookup("client-ipcPath"))
-	viper.BindPFlag("client.levelDbPath", rootCmd.PersistentFlags().Lookup("client-levelDbPath"))
-	viper.BindPFlag("filesystem.storageDiffsPath", rootCmd.PersistentFlags().Lookup("filesystem-storageDiffsPath"))
-	viper.BindPFlag("exporter.fileName", rootCmd.PersistentFlags().Lookup("exporter-name"))
 	viper.BindPFlag("log.level", rootCmd.PersistentFlags().Lookup("log-level"))
+	viper.BindPFlag("log.file", rootCmd.PersistentFlags().Lookup("log-file"))
+
+	viper.BindPFlag("metrics", rootCmd.PersistentFlags().Lookup("metrics"))
+
+	viper.BindPFlag("prom.http", rootCmd.PersistentFlags().Lookup("prom-http"))
+	viper.BindPFlag("prom.http.addr", rootCmd.PersistentFlags().Lookup("prom-http-addr"))
+	viper.BindPFlag("prom.http.port", rootCmd.PersistentFlags().Lookup("prom-http-port"))
 }
 
 func initConfig() {
+	if cfgFile == "" && envFile == "" {
+		log.Fatal("No configuration file specified, use --config , --env flag to provide configuration")
+	}
+
 	if cfgFile != "" {
+		if filepath.Ext(cfgFile) != ".toml" {
+			log.Fatal("Provide .toml file for --config flag")
+		}
+
 		viper.SetConfigFile(cfgFile)
-	} else {
-		noConfigError := "No config file passed with --config flag"
-		fmt.Println("Error: ", noConfigError)
-		log.Fatal(noConfigError)
+		if err := viper.ReadInConfig(); err != nil {
+			log.Fatalf("Couldn't read config file: %s", err.Error())
+		}
+
+		log.Infof("Using config file: %s", viper.ConfigFileUsed())
 	}
 
-	if err := viper.ReadInConfig(); err == nil {
-		log.Printf("Using config file: %s\n\n", viper.ConfigFileUsed())
-	} else {
-		invalidConfigError := "Couldn't read config file"
-		formattedError := fmt.Sprintf("%s: %s", invalidConfigError, err.Error())
-		log.Fatal(formattedError)
+	if envFile != "" {
+		if filepath.Ext(envFile) != ".env" {
+			log.Fatal("Provide .env file for --env flag")
+		}
+
+		if err := godotenv.Load(envFile); err != nil {
+			log.Fatalf("Failed to set environment variable from env file: %s", err.Error())
+		}
+
+		log.Infof("Using env file: %s", envFile)
 	}
 }
-
-func getBlockChain() *geth.BlockChain {
-	rawRpcClient, err := rpc.Dial(ipc)
-
-	if err != nil {
-		LogWithCommand.Fatal(err)
-	}
-	rpcClient := client.NewRpcClient(rawRpcClient, ipc)
-	ethClient := ethclient.NewClient(rawRpcClient)
-	vdbEthClient := client.NewEthClient(ethClient)
-	vdbNode := node.MakeNode(rpcClient)
-	transactionConverter := vRpc.NewRpcTransactionConverter(ethClient)
-	return geth.NewBlockChain(vdbEthClient, rpcClient, vdbNode, transactionConverter)
-}

cmd/serve.go

@@ -0,0 +1,411 @@
+// Copyright © 2020 Vulcanize, Inc
+//
+// 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 <http://www.gnu.org/licenses/>.
+
+package cmd
+
+import (
+	"errors"
+	"net/http"
+	"net/url"
+	"os"
+	"os/signal"
+	"strings"
+	"sync"
+	"time"
+
+	"github.com/ethereum/go-ethereum/rpc"
+	"github.com/mailgun/groupcache/v2"
+	log "github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+	"github.com/vulcanize/gap-filler/pkg/mux"
+
+	"github.com/vulcanize/ipld-eth-server/v4/pkg/eth"
+	"github.com/vulcanize/ipld-eth-server/v4/pkg/graphql"
+	srpc "github.com/vulcanize/ipld-eth-server/v4/pkg/rpc"
+	s "github.com/vulcanize/ipld-eth-server/v4/pkg/serve"
+	v "github.com/vulcanize/ipld-eth-server/v4/version"
+)
+
+var ErrNoRpcEndpoints = errors.New("no rpc endpoints is available")
+
+// serveCmd represents the serve command
+var serveCmd = &cobra.Command{
+	Use:   "serve",
+	Short: "serve chain data from PG-IPFS",
+	Long: `This command configures a VulcanizeDB ipld-eth-server.
+
+`,
+	Run: func(cmd *cobra.Command, args []string) {
+		subCommand = cmd.CalledAs()
+		logWithCommand = *log.WithField("SubCommand", subCommand)
+		serve()
+	},
+}
+
+func serve() {
+	logWithCommand.Infof("running ipld-eth-server version: %s", v.VersionWithMeta)
+
+	var forwardPayloadChan chan eth.ConvertedPayload
+	wg := new(sync.WaitGroup)
+	logWithCommand.Debug("loading server configuration variables")
+	serverConfig, err := s.NewConfig()
+	if err != nil {
+		logWithCommand.Fatal(err)
+	}
+	logWithCommand.Infof("server config: %+v", serverConfig)
+	logWithCommand.Debug("initializing new server service")
+	server, err := s.NewServer(serverConfig)
+	if err != nil {
+		logWithCommand.Fatal(err)
+	}
+
+	logWithCommand.Info("starting up server servers")
+	forwardPayloadChan = make(chan eth.ConvertedPayload, s.PayloadChanBufferSize)
+	server.Serve(wg, forwardPayloadChan)
+	if err := startServers(server, serverConfig); err != nil {
+		logWithCommand.Fatal(err)
+	}
+	graphQL, err := startEthGraphQL(server, serverConfig)
+	if err != nil {
+		logWithCommand.Fatal(err)
+	}
+
+	err = startIpldGraphQL(serverConfig)
+	if err != nil {
+		logWithCommand.Fatal(err)
+	}
+
+	err = startGroupCacheService(serverConfig)
+	if err != nil {
+		logWithCommand.Fatal(err)
+	}
+
+	if serverConfig.StateValidationEnabled {
+		go startStateTrieValidator(serverConfig, server)
+		logWithCommand.Info("state validator enabled")
+	} else {
+		logWithCommand.Info("state validator disabled")
+	}
+
+	shutdown := make(chan os.Signal, 1)
+	signal.Notify(shutdown, os.Interrupt)
+	<-shutdown
+	if graphQL != nil {
+		graphQL.Stop()
+	}
+	server.Stop()
+	wg.Wait()
+}
+
+func startServers(server s.Server, settings *s.Config) error {
+	if settings.IPCEnabled {
+		logWithCommand.Info("starting up IPC server")
+		_, _, err := srpc.StartIPCEndpoint(settings.IPCEndpoint, server.APIs())
+		if err != nil {
+			return err
+		}
+	} else {
+		logWithCommand.Info("IPC server is disabled")
+	}
+
+	if settings.WSEnabled {
+		logWithCommand.Info("starting up WS server")
+		_, _, err := srpc.StartWSEndpoint(settings.WSEndpoint, server.APIs(), []string{"vdb", "net"}, nil, true)
+		if err != nil {
+			return err
+		}
+	} else {
+		logWithCommand.Info("WS server is disabled")
+	}
+
+	if settings.HTTPEnabled {
+		logWithCommand.Info("starting up HTTP server")
+		_, err := srpc.StartHTTPEndpoint(settings.HTTPEndpoint, server.APIs(), []string{"vdb", "eth", "net"}, nil, []string{"*"}, rpc.HTTPTimeouts{})
+		if err != nil {
+			return err
+		}
+	} else {
+		logWithCommand.Info("HTTP server is disabled")
+	}
+
+	return nil
+}
+
+func startEthGraphQL(server s.Server, settings *s.Config) (graphQLServer *graphql.Service, err error) {
+	if settings.EthGraphqlEnabled {
+		logWithCommand.Info("starting up ETH GraphQL server")
+		endPoint := settings.EthGraphqlEndpoint
+		if endPoint != "" {
+			graphQLServer, err = graphql.New(server.Backend(), endPoint, nil, []string{"*"}, rpc.HTTPTimeouts{})
+			if err != nil {
+				return
+			}
+			err = graphQLServer.Start(nil)
+		}
+	} else {
+		logWithCommand.Info("ETH GraphQL server is disabled")
+	}
+
+	return
+}
+
+func startIpldGraphQL(settings *s.Config) error {
+	if settings.IpldGraphqlEnabled {
+		logWithCommand.Info("starting up IPLD GraphQL server")
+
+		gqlIpldAddr, err := url.Parse(settings.IpldPostgraphileEndpoint)
+		if err != nil {
+			return err
+		}
+
+		gqlTracingAPIAddr, err := url.Parse(settings.TracingPostgraphileEndpoint)
+		if err != nil {
+			return err
+		}
+
+		ethClients, err := parseRpcAddresses(settings.EthHttpEndpoint)
+		if err != nil {
+			return err
+		}
+
+		var tracingClients []*rpc.Client
+		tracingEndpoint := viper.GetString("tracing.httpPath")
+		if tracingEndpoint != "" {
+			tracingClients, err = parseRpcAddresses(tracingEndpoint)
+			if err != nil {
+				return err
+			}
+		}
+
+		router, err := mux.NewServeMux(&mux.Options{
+			BasePath:       "/",
+			EnableGraphiQL: true,
+			Postgraphile: mux.PostgraphileOptions{
+				Default:    gqlIpldAddr,
+				TracingAPI: gqlTracingAPIAddr,
+			},
+			RPC: mux.RPCOptions{
+				DefaultClients: ethClients,
+				TracingClients: tracingClients,
+			},
+		})
+		if err != nil {
+			return err
+		}
+
+		go http.ListenAndServe(settings.IpldGraphqlEndpoint, router)
+	} else {
+		logWithCommand.Info("IPLD GraphQL server is disabled")
+	}
+
+	return nil
+}
+
+func startGroupCacheService(settings *s.Config) error {
+	gcc := settings.GroupCache
+
+	if gcc.Pool.Enabled {
+		logWithCommand.Info("starting up groupcache pool HTTTP server")
+
+		pool := groupcache.NewHTTPPoolOpts(gcc.Pool.HttpEndpoint, &groupcache.HTTPPoolOptions{})
+		pool.Set(gcc.Pool.PeerHttpEndpoints...)
+
+		httpURL, err := url.Parse(gcc.Pool.HttpEndpoint)
+		if err != nil {
+			return err
+		}
+
+		server := http.Server{
+			Addr:    httpURL.Host,
+			Handler: pool,
+		}
+
+		// Start a HTTP server to listen for peer requests from the groupcache
+		go server.ListenAndServe()
+
+		logWithCommand.Infof("groupcache pool endpoint opened for url %s", httpURL)
+	} else {
+		logWithCommand.Info("Groupcache pool is disabled")
+	}
+
+	return nil
+}
+
+func startStateTrieValidator(config *s.Config, server s.Server) {
+	validateEveryNthBlock := config.StateValidationEveryNthBlock
+
+	var lastBlockNumber uint64
+	backend := server.Backend()
+
+	for {
+		time.Sleep(5 * time.Second)
+
+		block, err := backend.CurrentBlock()
+		if err != nil {
+			log.Errorln("Error fetching current block for state trie validator")
+			continue
+		}
+
+		stateRoot := block.Root()
+		blockNumber := block.NumberU64()
+		blockHash := block.Hash()
+
+		if validateEveryNthBlock <= 0 || // Used for static replicas where block number doesn't progress.
+			(blockNumber > lastBlockNumber) && (blockNumber%validateEveryNthBlock == 0) {
+
+			// The validate trie call will take a long time on mainnet, e.g. a few hours.
+			if err = backend.ValidateTrie(stateRoot); err != nil {
+				log.Fatalf("Error validating trie for block number %d hash %s state root %s",
+					blockNumber,
+					blockHash,
+					stateRoot,
+				)
+			}
+
+			log.Infof("Successfully validated trie for block number %d hash %s state root %s",
+				blockNumber,
+				blockHash,
+				stateRoot,
+			)
+
+			if validateEveryNthBlock <= 0 {
+				// Static replica, sleep a long-ish time (1/2 of cache expiry time) since we only need to keep the cache warm.
+				time.Sleep((time.Minute * time.Duration(config.GroupCache.StateDB.CacheExpiryInMins)) / 2)
+			}
+
+			lastBlockNumber = blockNumber
+		}
+	}
+}
+
+func parseRpcAddresses(value string) ([]*rpc.Client, error) {
+	rpcAddresses := strings.Split(value, ",")
+	rpcClients := make([]*rpc.Client, 0, len(rpcAddresses))
+	for _, address := range rpcAddresses {
+		rpcClient, err := rpc.Dial(address)
+		if err != nil {
+			logWithCommand.Errorf("couldn't connect to %s. Error: %s", address, err)
+			continue
+		}
+
+		rpcClients = append(rpcClients, rpcClient)
+	}
+
+	if len(rpcClients) == 0 {
+		logWithCommand.Error(ErrNoRpcEndpoints)
+		return nil, ErrNoRpcEndpoints
+	}
+
+	return rpcClients, nil
+}
+
+func init() {
+	rootCmd.AddCommand(serveCmd)
+
+	addDatabaseFlags(serveCmd)
+
+	// flags for all config variables
+	// eth graphql and json-rpc parameters
+	serveCmd.PersistentFlags().Bool("eth-server-graphql", false, "turn on the eth graphql server")
+	serveCmd.PersistentFlags().String("eth-server-graphql-path", "", "endpoint url for eth graphql server (host:port)")
+	serveCmd.PersistentFlags().Bool("eth-server-http", true, "turn on the eth http json-rpc server")
+	serveCmd.PersistentFlags().String("eth-server-http-path", "", "endpoint url for eth http json-rpc server (host:port)")
+	serveCmd.PersistentFlags().Bool("eth-server-ws", false, "turn on the eth websocket json-rpc server")
+	serveCmd.PersistentFlags().String("eth-server-ws-path", "", "endpoint url for eth websocket json-rpc server (host:port)")
+	serveCmd.PersistentFlags().Bool("eth-server-ipc", false, "turn on the eth ipc json-rpc server")
+	serveCmd.PersistentFlags().String("eth-server-ipc-path", "", "path for eth ipc json-rpc server")
+
+	// ipld and tracing graphql parameters
+	serveCmd.PersistentFlags().Bool("ipld-server-graphql", false, "turn on the ipld graphql server")
+	serveCmd.PersistentFlags().String("ipld-server-graphql-path", "", "endpoint url for ipld graphql server (host:port)")
+	serveCmd.PersistentFlags().String("ipld-postgraphile-path", "", "http url to postgraphile on top of ipld database")
+	serveCmd.PersistentFlags().String("tracing-http-path", "", "http url to tracing service")
+	serveCmd.PersistentFlags().String("tracing-postgraphile-path", "", "http url to postgraphile on top of tracing db")
+
+	serveCmd.PersistentFlags().String("eth-http-path", "", "http url for ethereum node")
+	serveCmd.PersistentFlags().String("eth-node-id", "", "eth node id")
+	serveCmd.PersistentFlags().String("eth-client-name", "Geth", "eth client name")
+	serveCmd.PersistentFlags().String("eth-genesis-block", "0xd4e56740f876aef8c010b86a40d5f56745a118d0906a34e69aec8c0db1cb8fa3", "eth genesis block hash")
+	serveCmd.PersistentFlags().String("eth-network-id", "1", "eth network id")
+	serveCmd.PersistentFlags().String("eth-chain-id", "1", "eth chain id")
+	serveCmd.PersistentFlags().String("eth-default-sender", "", "default sender address")
+	serveCmd.PersistentFlags().String("eth-rpc-gas-cap", "", "rpc gas cap (for eth_Call execution)")
+	serveCmd.PersistentFlags().String("eth-chain-config", "", "json chain config file location")
+	serveCmd.PersistentFlags().Bool("eth-supports-state-diff", false, "whether the proxy ethereum client supports statediffing endpoints")
+	serveCmd.PersistentFlags().Bool("eth-forward-eth-calls", false, "whether to immediately forward eth_calls to proxy client")
+	serveCmd.PersistentFlags().Bool("eth-proxy-on-error", true, "whether to forward all failed calls to proxy client")
+
+	// groupcache flags
+	serveCmd.PersistentFlags().Bool("gcache-pool-enabled", false, "turn on the groupcache pool")
+	serveCmd.PersistentFlags().String("gcache-pool-http-path", "", "http url for groupcache node")
+	serveCmd.PersistentFlags().StringArray("gcache-pool-http-peers", []string{}, "http urls for groupcache peers")
+	serveCmd.PersistentFlags().Int("gcache-statedb-cache-size", 16, "state DB cache size in MB")
+	serveCmd.PersistentFlags().Int("gcache-statedb-cache-expiry", 60, "state DB cache expiry time in mins")
+	serveCmd.PersistentFlags().Int("gcache-statedb-log-stats-interval", 60, "state DB cache stats log interval in secs")
+
+	// state validator flags
+	serveCmd.PersistentFlags().Bool("validator-enabled", false, "turn on the state validator")
+	serveCmd.PersistentFlags().Uint("validator-every-nth-block", 1500, "only validate every Nth block")
+
+	// and their bindings
+	// eth graphql server
+	viper.BindPFlag("eth.server.graphql", serveCmd.PersistentFlags().Lookup("eth-server-graphql"))
+	viper.BindPFlag("eth.server.graphqlPath", serveCmd.PersistentFlags().Lookup("eth-server-graphql-path"))
+
+	// eth http json-rpc server
+	viper.BindPFlag("eth.server.http", serveCmd.PersistentFlags().Lookup("eth-server-http"))
+	viper.BindPFlag("eth.server.httpPath", serveCmd.PersistentFlags().Lookup("eth-server-http-path"))
+
+	// eth websocket json-rpc server
+	viper.BindPFlag("eth.server.ws", serveCmd.PersistentFlags().Lookup("eth-server-ws"))
+	viper.BindPFlag("eth.server.wsPath", serveCmd.PersistentFlags().Lookup("eth-server-ws-path"))
+
+	// eth ipc json-rpc server
+	viper.BindPFlag("eth.server.ipc", serveCmd.PersistentFlags().Lookup("eth-server-ipc"))
+	viper.BindPFlag("eth.server.ipcPath", serveCmd.PersistentFlags().Lookup("eth-server-ipc-path"))
+
+	// ipld and tracing graphql parameters
+	viper.BindPFlag("ipld.server.graphql", serveCmd.PersistentFlags().Lookup("ipld-server-graphql"))
+	viper.BindPFlag("ipld.server.graphqlPath", serveCmd.PersistentFlags().Lookup("ipld-server-graphql-path"))
+	viper.BindPFlag("ipld.postgraphilePath", serveCmd.PersistentFlags().Lookup("ipld-postgraphile-path"))
+	viper.BindPFlag("tracing.httpPath", serveCmd.PersistentFlags().Lookup("tracing-http-path"))
+	viper.BindPFlag("tracing.postgraphilePath", serveCmd.PersistentFlags().Lookup("tracing-postgraphile-path"))
+
+	viper.BindPFlag("ethereum.httpPath", serveCmd.PersistentFlags().Lookup("eth-http-path"))
+	viper.BindPFlag("ethereum.nodeID", serveCmd.PersistentFlags().Lookup("eth-node-id"))
+	viper.BindPFlag("ethereum.clientName", serveCmd.PersistentFlags().Lookup("eth-client-name"))
+	viper.BindPFlag("ethereum.genesisBlock", serveCmd.PersistentFlags().Lookup("eth-genesis-block"))
+	viper.BindPFlag("ethereum.networkID", serveCmd.PersistentFlags().Lookup("eth-network-id"))
+	viper.BindPFlag("ethereum.chainID", serveCmd.PersistentFlags().Lookup("eth-chain-id"))
+	viper.BindPFlag("ethereum.defaultSender", serveCmd.PersistentFlags().Lookup("eth-default-sender"))
+	viper.BindPFlag("ethereum.rpcGasCap", serveCmd.PersistentFlags().Lookup("eth-rpc-gas-cap"))
+	viper.BindPFlag("ethereum.chainConfig", serveCmd.PersistentFlags().Lookup("eth-chain-config"))
+	viper.BindPFlag("ethereum.supportsStateDiff", serveCmd.PersistentFlags().Lookup("eth-supports-state-diff"))
+	viper.BindPFlag("ethereum.forwardEthCalls", serveCmd.PersistentFlags().Lookup("eth-forward-eth-calls"))
+	viper.BindPFlag("ethereum.proxyOnError", serveCmd.PersistentFlags().Lookup("eth-proxy-on-error"))
+
+	// groupcache flags
+	viper.BindPFlag("groupcache.pool.enabled", serveCmd.PersistentFlags().Lookup("gcache-pool-enabled"))
+	viper.BindPFlag("groupcache.pool.httpEndpoint", serveCmd.PersistentFlags().Lookup("gcache-pool-http-path"))
+	viper.BindPFlag("groupcache.pool.peerHttpEndpoints", serveCmd.PersistentFlags().Lookup("gcache-pool-http-peers"))
+	viper.BindPFlag("groupcache.statedb.cacheSizeInMB", serveCmd.PersistentFlags().Lookup("gcache-statedb-cache-size"))
+	viper.BindPFlag("groupcache.statedb.cacheExpiryInMins", serveCmd.PersistentFlags().Lookup("gcache-statedb-cache-expiry"))
+	viper.BindPFlag("groupcache.statedb.logStatsIntervalInSecs", serveCmd.PersistentFlags().Lookup("gcache-statedb-log-stats-interval"))
+
+	// state validator flags
+	viper.BindPFlag("validator.enabled", serveCmd.PersistentFlags().Lookup("validator-enabled"))
+	viper.BindPFlag("validator.everyNthBlock", serveCmd.PersistentFlags().Lookup("validator-every-nth-block"))
+}

cmd/subscribe.go

@@ -0,0 +1,172 @@
+// Copyright © 2019 Vulcanize, Inc
+//
+// 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 <http://www.gnu.org/licenses/>.
+
+package cmd
+
+import (
+	"bytes"
+	"fmt"
+
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/core/types"
+	"github.com/ethereum/go-ethereum/rlp"
+	"github.com/ethereum/go-ethereum/rpc"
+	log "github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+
+	"github.com/vulcanize/ipld-eth-server/v4/pkg/client"
+	"github.com/vulcanize/ipld-eth-server/v4/pkg/eth"
+	w "github.com/vulcanize/ipld-eth-server/v4/pkg/serve"
+)
+
+// subscribeCmd represents the subscribe command
+var subscribeCmd = &cobra.Command{
+	Use:   "subscribe",
+	Short: "This command is used to subscribe to the eth ipfs watcher data stream with the provided filters",
+	Long: `This command is for demo and testing purposes and is used to subscribe to the watcher with the provided subscription configuration parameters.
+It does not do anything with the data streamed from the watcher other than unpack it and print it out for demonstration purposes.`,
+	Run: func(cmd *cobra.Command, args []string) {
+		subCommand = cmd.CalledAs()
+		logWithCommand = *log.WithField("SubCommand", subCommand)
+		subscribe()
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(subscribeCmd)
+}
+
+func subscribe() {
+	// Prep the subscription config/filters to be sent to the server
+	ethSubConfig, err := eth.NewEthSubscriptionConfig()
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	// Create a new rpc client and a subscription streamer with that client
+	rpcClient, err := getRPCClient()
+	if err != nil {
+		logWithCommand.Fatal(err)
+	}
+	subClient := client.NewClient(rpcClient)
+
+	// Buffered channel for reading subscription payloads
+	payloadChan := make(chan w.SubscriptionPayload, 20000)
+
+	// Subscribe to the watcher service with the given config/filter parameters
+	sub, err := subClient.Stream(payloadChan, *ethSubConfig)
+	if err != nil {
+		logWithCommand.Fatal(err)
+	}
+	logWithCommand.Info("awaiting payloads")
+	// Receive response payloads and print out the results
+	for {
+		select {
+		case payload := <-payloadChan:
+			if payload.Err != "" {
+				logWithCommand.Error(payload.Err)
+				continue
+			}
+			var ethData eth.IPLDs
+			if err := rlp.DecodeBytes(payload.Data, &ethData); err != nil {
+				logWithCommand.Error(err)
+				continue
+			}
+			var header types.Header
+			err = rlp.Decode(bytes.NewBuffer(ethData.Header.Data), &header)
+			if err != nil {
+				logWithCommand.Error(err)
+				continue
+			}
+			fmt.Printf("Header number %d, hash %s\n", header.Number.Int64(), header.Hash().Hex())
+			fmt.Printf("header: %v\n", header)
+			for _, trxRlp := range ethData.Transactions {
+				var trx types.Transaction
+				buff := bytes.NewBuffer(trxRlp.Data)
+				stream := rlp.NewStream(buff, 0)
+				err := trx.DecodeRLP(stream)
+				if err != nil {
+					logWithCommand.Error(err)
+					continue
+				}
+				fmt.Printf("Transaction with hash %s\n", trx.Hash().Hex())
+				fmt.Printf("trx: %v\n", trx)
+			}
+			for _, rctRlp := range ethData.Receipts {
+				var rct types.Receipt
+				buff := bytes.NewBuffer(rctRlp.Data)
+				stream := rlp.NewStream(buff, 0)
+				err = rct.DecodeRLP(stream)
+				if err != nil {
+					logWithCommand.Error(err)
+					continue
+				}
+				fmt.Printf("Receipt with block hash %s, trx hash %s\n", rct.BlockHash.Hex(), rct.TxHash.Hex())
+				fmt.Printf("rct: %v\n", rct)
+				for _, l := range rct.Logs {
+					if len(l.Topics) < 1 {
+						logWithCommand.Error(fmt.Sprintf("log only has %d topics", len(l.Topics)))
+						continue
+					}
+					fmt.Printf("Log for block hash %s, trx hash %s, address %s, and with topic0 %s\n",
+						l.BlockHash.Hex(), l.TxHash.Hex(), l.Address.Hex(), l.Topics[0].Hex())
+					fmt.Printf("log: %v\n", l)
+				}
+			}
+			// This assumes leafs only
+			for _, stateNode := range ethData.StateNodes {
+				var acct types.StateAccount
+				err = rlp.DecodeBytes(stateNode.IPLD.Data, &acct)
+				if err != nil {
+					logWithCommand.Error(err)
+					continue
+				}
+				fmt.Printf("Account for key %s, and root %s, with balance %s\n",
+					stateNode.StateLeafKey.Hex(), acct.Root.Hex(), acct.Balance.String())
+				fmt.Printf("state account: %+v\n", acct)
+			}
+			for _, storageNode := range ethData.StorageNodes {
+				fmt.Printf("Storage for state key %s ", storageNode.StateLeafKey.Hex())
+				fmt.Printf("with storage key %s\n", storageNode.StorageLeafKey.Hex())
+				var i []interface{}
+				err := rlp.DecodeBytes(storageNode.IPLD.Data, &i)
+				if err != nil {
+					logWithCommand.Error(err)
+					continue
+				}
+				// if a value node
+				if len(i) == 1 {
+					valueBytes, ok := i[0].([]byte)
+					if !ok {
+						continue
+					}
+					fmt.Printf("Storage leaf key: %s, and value hash: %s\n",
+						storageNode.StorageLeafKey.Hex(), common.BytesToHash(valueBytes).Hex())
+				}
+			}
+		case err = <-sub.Err():
+			logWithCommand.Fatal(err)
+		}
+	}
+}
+
+func getRPCClient() (*rpc.Client, error) {
+	vulcPath := viper.GetString("watcher.ethSubscription.wsPath")
+	if vulcPath == "" {
+		vulcPath = "ws://127.0.0.1:8080" // default to and try the default ws url if no path is provided
+	}
+	return rpc.Dial(vulcPath)
+}

cmd/validate.go

@@ -0,0 +1,87 @@
+// Copyright © 2021 Vulcanize, Inc
+//
+// 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 <http://www.gnu.org/licenses/>.
+
+package cmd
+
+import (
+	"time"
+
+	"github.com/ethereum/go-ethereum/common"
+	log "github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+	validator "github.com/vulcanize/eth-ipfs-state-validator/v4/pkg"
+	ipfsethdb "github.com/vulcanize/ipfs-ethdb/v4/postgres"
+
+	s "github.com/vulcanize/ipld-eth-server/v4/pkg/serve"
+)
+
+const GroupName = "statedb-validate"
+const CacheExpiryInMins = 8 * 60 // 8 hours
+const CacheSizeInMB = 16         // 16 MB
+
+var validateCmd = &cobra.Command{
+	Use:   "validate",
+	Short: "valdiate state",
+	Long:  `This command validates the trie for the given state root`,
+	Run: func(cmd *cobra.Command, args []string) {
+		subCommand = cmd.CalledAs()
+		logWithCommand = *log.WithField("SubCommand", subCommand)
+		validate()
+	},
+}
+
+func validate() {
+	config, err := s.NewConfig()
+	if err != nil {
+		logWithCommand.Fatal(err)
+	}
+
+	stateRootStr := viper.GetString("stateRoot")
+	if stateRootStr == "" {
+		logWithCommand.Fatal("must provide a state root for state validation")
+	}
+
+	stateRoot := common.HexToHash(stateRootStr)
+	cacheSize := viper.GetInt("cacheSize")
+
+	ethDB := ipfsethdb.NewDatabase(config.DB, ipfsethdb.CacheConfig{
+		Name:           GroupName,
+		Size:           cacheSize * 1024 * 1024,
+		ExpiryDuration: time.Minute * time.Duration(CacheExpiryInMins),
+	})
+
+	val := validator.NewValidator(nil, ethDB)
+	if err = val.ValidateTrie(stateRoot); err != nil {
+		log.Fatalln("Error validating state root")
+	}
+
+	stats := ethDB.(*ipfsethdb.Database).GetCacheStats()
+	log.Debugf("groupcache stats %+v", stats)
+
+	log.Infoln("Successfully validated state root")
+}
+
+func init() {
+	rootCmd.AddCommand(validateCmd)
+
+	addDatabaseFlags(validateCmd)
+
+	validateCmd.PersistentFlags().String("state-root", "", "root of the state trie we wish to validate")
+	viper.BindPFlag("stateRoot", validateCmd.PersistentFlags().Lookup("state-root"))
+
+	validateCmd.PersistentFlags().Int("cache-size", CacheSizeInMB, "cache size in MB")
+	viper.BindPFlag("cacheSize", validateCmd.PersistentFlags().Lookup("cache-size"))
+}

cmd/version.go

@@ -0,0 +1,41 @@
+// Copyright © 2020 Vulcanize, Inc
+//
+// 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 <http://www.gnu.org/licenses/>.
+
+package cmd
+
+import (
+	log "github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+
+	v "github.com/vulcanize/ipld-eth-server/v4/version"
+)
+
+// versionCmd represents the version command
+var versionCmd = &cobra.Command{
+	Use:   "version",
+	Short: "Prints the version of ipld-eth-server",
+	Long: `Use this command to fetch the version of ipld-eth-server
+
+Usage: ./ipld-eth-server version`,
+	Run: func(cmd *cobra.Command, args []string) {
+		subCommand = cmd.CalledAs()
+		logWithCommand = *log.WithField("SubCommand", subCommand)
+		logWithCommand.Infof("ipld-eth-server version: %s", v.VersionWithMeta)
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(versionCmd)
+}

db/migrations/00001_create_blocks_table.sql

@@ -1,23 +0,0 @@
--- +goose Up
-CREATE TABLE public.blocks (
-  id            SERIAL PRIMARY KEY,
-  difficulty    BIGINT,
-  extra_data    VARCHAR,
-  gas_limit      BIGINT,
-  gas_used       BIGINT,
-  hash          VARCHAR(66),
-  miner         VARCHAR(42),
-  nonce         VARCHAR(20),
-  "number"      BIGINT,
-  parent_hash    VARCHAR(66),
-  reward        NUMERIC,
-  uncles_reward NUMERIC,
-  "size"        VARCHAR,
-  "time"        BIGINT,
-  is_final      BOOLEAN,
-  uncle_hash    VARCHAR(66)
-);
-
-
--- +goose Down
-DROP TABLE public.blocks;

db/migrations/00002_create_full_sync_transactions_table.sql

@@ -1,18 +0,0 @@
--- +goose Up
-CREATE TABLE full_sync_transactions (
-  id          SERIAL PRIMARY KEY,
-  block_id    INTEGER NOT NULL REFERENCES blocks(id) ON DELETE CASCADE,
-  gas_limit    NUMERIC,
-  gas_price    NUMERIC,
-  hash        VARCHAR(66),
-  input_data  BYTEA,
-  nonce       NUMERIC,
-  raw         BYTEA,
-  tx_from     VARCHAR(66),
-  tx_index    INTEGER,
-  tx_to       VARCHAR(66),
-  "value"     NUMERIC
-);
-
--- +goose Down
-DROP TABLE full_sync_transactions;

db/migrations/00003_add_block_index_to_blocks.sql

@@ -1,6 +0,0 @@
--- +goose Up
-CREATE INDEX number_index ON blocks (number);
-
-
--- +goose Down
-DROP INDEX number_index;

db/migrations/00004_create_contracts_table.sql

@@ -1,10 +0,0 @@
--- +goose Up
-CREATE TABLE watched_contracts
-(
-  contract_id   SERIAL PRIMARY KEY,
-  contract_abi  json,
-  contract_hash VARCHAR(66) UNIQUE
-);
-
--- +goose Down
-DROP TABLE watched_contracts;

db/migrations/00005_create_nodes_table.sql

@@ -1,12 +0,0 @@
--- +goose Up
-CREATE TABLE nodes (
-  id            SERIAL PRIMARY KEY,
-  client_name   VARCHAR,
-  genesis_block VARCHAR(66),
-  network_id    NUMERIC,
-  node_id       VARCHAR(128),
-  CONSTRAINT node_uc UNIQUE (genesis_block, network_id, node_id)
-);
-
--- +goose Down
-DROP TABLE nodes;

db/migrations/00006_add_node_fk_to_blocks.sql

@@ -1,11 +0,0 @@
--- +goose Up
-ALTER TABLE blocks
-  ADD COLUMN node_id INTEGER NOT NULL,
-  ADD CONSTRAINT node_fk
-FOREIGN KEY (node_id)
-REFERENCES nodes (id)
-ON DELETE CASCADE;
-
--- +goose Down
-ALTER TABLE blocks
-  DROP COLUMN node_id;

db/migrations/00007_create_logs_table.sql

@@ -1,19 +0,0 @@
--- +goose Up
-CREATE TABLE logs (
-  id           SERIAL PRIMARY KEY,
-  block_number BIGINT,
-  address      VARCHAR(66),
-  tx_hash      VARCHAR(66),
-  index        BIGINT,
-  topic0       VARCHAR(66),
-  topic1       VARCHAR(66),
-  topic2       VARCHAR(66),
-  topic3       VARCHAR(66),
-  data         TEXT,
-  CONSTRAINT log_uc UNIQUE (block_number, index)
-);
-
-
-
--- +goose Down
-DROP TABLE logs;

db/migrations/00008_add_node_block_number_unique_constraint_to_blocks.sql

@@ -1,7 +0,0 @@
--- +goose Up
-ALTER TABLE blocks
-  ADD CONSTRAINT node_id_block_number_uc UNIQUE (number, node_id);
-
--- +goose Down
-ALTER TABLE blocks
-  DROP CONSTRAINT node_id_block_number_uc;

db/migrations/00009_add_block_id_index_to_full_sync_transactions.sql

@@ -1,5 +0,0 @@
--- +goose Up
-CREATE INDEX block_id_index ON full_sync_transactions (block_id);
-
--- +goose Down
-DROP INDEX block_id_index;

db/migrations/00010_add_node_id_index_to_blocks.sql

@@ -1,5 +0,0 @@
--- +goose Up
-CREATE INDEX node_id_index ON blocks (node_id);
-
--- +goose Down
-DROP INDEX node_id_index;

db/migrations/00011_add_tx_to_index_to_full_sync_transactions.sql

@@ -1,5 +0,0 @@
--- +goose Up
-CREATE INDEX tx_to_index ON full_sync_transactions(tx_to);
-
--- +goose Down
-DROP INDEX tx_to_index;

db/migrations/00012_add_tx_from_index_to_full_sync_transactions.sql

@@ -1,5 +0,0 @@
--- +goose Up
-CREATE INDEX tx_from_index ON full_sync_transactions(tx_from);
-
--- +goose Down
-DROP INDEX tx_from_index;

db/migrations/00013_add_address_table.sql

@@ -1,10 +0,0 @@
--- +goose Up
-CREATE TABLE public.addresses
-(
-    id      SERIAL PRIMARY KEY,
-    address character varying(42),
-    UNIQUE (address)
-);
-
--- +goose Down
-DROP TABLE public.addresses;

db/migrations/00014_create_receipts_table.sql

@@ -1,16 +0,0 @@
--- +goose Up
-CREATE TABLE full_sync_receipts
-(
-    id                  SERIAL PRIMARY KEY,
-    transaction_id      INTEGER NOT NULL REFERENCES full_sync_transactions (id) ON DELETE CASCADE,
-    contract_address_id INTEGER NOT NULL REFERENCES addresses (id) ON DELETE CASCADE,
-    cumulative_gas_used NUMERIC,
-    gas_used            NUMERIC,
-    state_root          VARCHAR(66),
-    status              INTEGER,
-    tx_hash             VARCHAR(66)
-);
-
-
--- +goose Down
-DROP TABLE full_sync_receipts;

db/migrations/00015_add_transaction_id_index_to_receipts.sql

@@ -1,5 +0,0 @@
--- +goose Up
-CREATE INDEX transaction_id_index ON full_sync_receipts (transaction_id);
-
--- +goose Down
-DROP INDEX transaction_id_index;

db/migrations/00016_add_receipts_fk_to_logs.sql

@@ -1,23 +0,0 @@
--- +goose Up
-ALTER TABLE logs
-    DROP CONSTRAINT log_uc;
-
-ALTER TABLE logs
-  ADD COLUMN receipt_id INT;
-
-ALTER TABLE logs
-  ADD CONSTRAINT receipts_fk
-FOREIGN KEY (receipt_id)
-REFERENCES full_sync_receipts (id)
-ON DELETE CASCADE;
-
-
--- +goose Down
-ALTER TABLE logs
-  DROP CONSTRAINT receipts_fk;
-
-ALTER TABLE logs
-  DROP COLUMN receipt_id;
-
-ALTER TABLE logs
-  ADD CONSTRAINT log_uc UNIQUE (block_number, index);

db/migrations/00017_create_log_filters.sql

@@ -1,16 +0,0 @@
--- +goose Up
-CREATE TABLE log_filters (
-  id         SERIAL,
-  name       VARCHAR NOT NULL CHECK (name <> ''),
-  from_block BIGINT CHECK (from_block >= 0),
-  to_block   BIGINT CHECK (from_block >= 0),
-  address    VARCHAR(66),
-  topic0     VARCHAR(66),
-  topic1     VARCHAR(66),
-  topic2     VARCHAR(66),
-  topic3     VARCHAR(66),
-  CONSTRAINT name_uc UNIQUE (name)
-);
-
--- +goose Down
-DROP TABLE log_filters;

db/migrations/00018_create_watched_event_logs.sql

@@ -1,34 +0,0 @@
--- +goose Up
-CREATE VIEW block_stats AS
-  SELECT
-    max(block_number) AS max_block,
-    min(block_number) AS min_block
-  FROM logs;
-
-CREATE VIEW watched_event_logs AS
-  SELECT
-    log_filters.name,
-    logs.id,
-    block_number,
-    logs.address,
-    tx_hash,
-    index,
-    logs.topic0,
-    logs.topic1,
-    logs.topic2,
-    logs.topic3,
-    data,
-    receipt_id
-  FROM log_filters
-    CROSS JOIN block_stats
-    JOIN logs ON logs.address = log_filters.address
-                 AND logs.block_number >= coalesce(log_filters.from_block, block_stats.min_block)
-                 AND logs.block_number <= coalesce(log_filters.to_block, block_stats.max_block)
-  WHERE (log_filters.topic0 = logs.topic0 OR log_filters.topic0 ISNULL)
-        AND (log_filters.topic1 = logs.topic1 OR log_filters.topic1 ISNULL)
-        AND (log_filters.topic2 = logs.topic2 OR log_filters.topic2 ISNULL)
-        AND (log_filters.topic3 = logs.topic3 OR log_filters.topic3 ISNULL);
-
--- +goose Down
-DROP VIEW watched_event_logs;
-DROP VIEW block_stats;

db/migrations/00019_update_log_filters_to_block_constraint.sql

@@ -1,14 +0,0 @@
--- +goose Up
-ALTER TABLE log_filters
-  DROP CONSTRAINT log_filters_from_block_check1;
-
-ALTER TABLE log_filters
-  ADD CONSTRAINT log_filters_to_block_check CHECK (to_block >= 0);
-
-
--- +goose Down
-ALTER TABLE log_filters
-  DROP CONSTRAINT log_filters_to_block_check;
-
-ALTER TABLE log_filters
-  ADD CONSTRAINT log_filters_from_block_check1 CHECK (to_block >= 0);

db/migrations/00020_rename_node_table.sql

@@ -1,43 +0,0 @@
--- +goose Up
-ALTER TABLE public.nodes RENAME TO eth_nodes;
-
-ALTER TABLE public.eth_nodes RENAME COLUMN node_id TO eth_node_id;
-
-ALTER TABLE public.eth_nodes DROP CONSTRAINT node_uc;
-ALTER TABLE public.eth_nodes
-  ADD CONSTRAINT eth_node_uc UNIQUE (genesis_block, network_id, eth_node_id);
-
-ALTER TABLE public.blocks RENAME COLUMN node_id TO eth_node_id;
-
-ALTER TABLE public.blocks DROP CONSTRAINT node_id_block_number_uc;
-ALTER TABLE public.blocks
-  ADD CONSTRAINT eth_node_id_block_number_uc UNIQUE (number, eth_node_id);
-
-ALTER TABLE public.blocks DROP CONSTRAINT node_fk;
-ALTER TABLE public.blocks
-  ADD CONSTRAINT node_fk
-FOREIGN KEY (eth_node_id) REFERENCES eth_nodes (id) ON DELETE CASCADE;
-
-
--- +goose Down
-ALTER TABLE public.eth_nodes
-  RENAME TO nodes;
-
-ALTER TABLE public.nodes
-  RENAME COLUMN eth_node_id TO node_id;
-
-ALTER TABLE public.nodes
-  DROP CONSTRAINT eth_node_uc;
-ALTER TABLE public.nodes
-  ADD CONSTRAINT node_uc UNIQUE (genesis_block, network_id, node_id);
-
-ALTER TABLE public.blocks RENAME COLUMN eth_node_id TO node_id;
-
-ALTER TABLE public.blocks DROP CONSTRAINT eth_node_id_block_number_uc;
-ALTER TABLE public.blocks
-  ADD CONSTRAINT node_id_block_number_uc UNIQUE (number, node_id);
-
-ALTER TABLE public.blocks DROP CONSTRAINT node_fk;
-ALTER TABLE public.blocks
-  ADD CONSTRAINT node_fk
-FOREIGN KEY (node_id) REFERENCES nodes (id) ON DELETE CASCADE;

db/migrations/00021_associate_receipts_with_blocks.sql

@@ -1,44 +0,0 @@
--- +goose Up
-ALTER TABLE full_sync_receipts
-  ADD COLUMN block_id INT;
-
-UPDATE full_sync_receipts
-  SET block_id = (
-    SELECT block_id FROM full_sync_transactions WHERE full_sync_transactions.id = full_sync_receipts.transaction_id
-  );
-
-ALTER TABLE full_sync_receipts
-  ALTER COLUMN block_id SET NOT NULL;
-
-ALTER TABLE full_sync_receipts
-  ADD CONSTRAINT blocks_fk
-FOREIGN KEY (block_id)
-REFERENCES blocks (id)
-ON DELETE CASCADE;
-
-ALTER TABLE full_sync_receipts
-  DROP COLUMN transaction_id;
-
-
--- +goose Down
-ALTER TABLE full_sync_receipts
-  ADD COLUMN transaction_id INT;
-
-CREATE INDEX transaction_id_index ON full_sync_receipts (transaction_id);
-
-UPDATE full_sync_receipts
-  SET transaction_id = (
-    SELECT id FROM full_sync_transactions WHERE full_sync_transactions.hash = full_sync_receipts.tx_hash
-  );
-
-ALTER TABLE full_sync_receipts
-  ALTER COLUMN transaction_id SET NOT NULL;
-
-ALTER TABLE full_sync_receipts
-  ADD CONSTRAINT transaction_fk
-FOREIGN KEY (transaction_id)
-REFERENCES full_sync_transactions (id)
-ON DELETE CASCADE;
-
-ALTER TABLE full_sync_receipts
-  DROP COLUMN block_id;

db/migrations/00022_add_eth_node_fingerprint_to_blocks.sql

@@ -1,16 +0,0 @@
--- +goose Up
-ALTER TABLE blocks
-  ADD COLUMN eth_node_fingerprint VARCHAR(128);
-
-UPDATE blocks
-  SET eth_node_fingerprint = (
-    SELECT eth_node_id FROM eth_nodes WHERE eth_nodes.id = blocks.eth_node_id
-  );
-
-ALTER TABLE blocks
-  ALTER COLUMN eth_node_fingerprint SET NOT NULL;
-
-
--- +goose Down
-ALTER TABLE blocks
-  DROP COLUMN eth_node_fingerprint;

db/migrations/00023_create_headers_table.sql

@@ -1,17 +0,0 @@
--- +goose Up
-CREATE TABLE public.headers (
-  id                    SERIAL PRIMARY KEY,
-  hash                  VARCHAR(66),
-  block_number          BIGINT,
-  raw                   JSONB,
-  block_timestamp       NUMERIC,
-  eth_node_id           INTEGER NOT NULL REFERENCES eth_nodes (id) ON DELETE CASCADE,
-  eth_node_fingerprint  VARCHAR(128)
-);
-
--- Index is removed when table is
-CREATE INDEX headers_block_number ON public.headers (block_number);
-
-
--- +goose Down
-DROP TABLE public.headers;

db/migrations/00024_create_checked_headers_table.sql

@@ -1,8 +0,0 @@
--- +goose Up
-CREATE TABLE public.checked_headers (
-  id                  SERIAL PRIMARY KEY,
-  header_id           INTEGER UNIQUE NOT NULL REFERENCES headers (id) ON DELETE CASCADE
-);
-
--- +goose Down
-DROP TABLE public.checked_headers;

db/migrations/00025_create_queued_storage.sql

@@ -1,13 +0,0 @@
--- +goose Up
-CREATE TABLE public.queued_storage (
-  id            SERIAL PRIMARY KEY,
-  block_height  BIGINT,
-  block_hash    BYTEA,
-  contract      BYTEA,
-  storage_key   BYTEA,
-  storage_value BYTEA,
-  UNIQUE (block_height, block_hash, contract, storage_key, storage_value)
-);
-
--- +goose Down
-DROP TABLE public.queued_storage;

db/migrations/00026_create_header_sync_transactions_table.sql

@@ -1,19 +0,0 @@
--- +goose Up
-CREATE TABLE header_sync_transactions (
-  id          SERIAL PRIMARY KEY,
-  header_id   INTEGER NOT NULL REFERENCES headers(id) ON DELETE CASCADE,
-  hash        VARCHAR(66),
-  gas_limit   NUMERIC,
-  gas_price   NUMERIC,
-  input_data  BYTEA,
-  nonce       NUMERIC,
-  raw         BYTEA,
-  tx_from     VARCHAR(44),
-  tx_index    INTEGER,
-  tx_to       VARCHAR(44),
-  "value"     NUMERIC,
-  UNIQUE (header_id, hash)
-);
-
--- +goose Down
-DROP TABLE header_sync_transactions;

db/migrations/00027_create_header_sync_receipts_table.sql

@@ -1,19 +0,0 @@
--- +goose Up
-CREATE TABLE header_sync_receipts
-(
-    id                  SERIAL PRIMARY KEY,
-    transaction_id      INTEGER NOT NULL REFERENCES header_sync_transactions (id) ON DELETE CASCADE,
-    header_id           INTEGER NOT NULL REFERENCES headers (id) ON DELETE CASCADE,
-    contract_address_id INTEGER NOT NULL REFERENCES addresses (id) ON DELETE CASCADE,
-    cumulative_gas_used NUMERIC,
-    gas_used            NUMERIC,
-    state_root          VARCHAR(66),
-    status              INTEGER,
-    tx_hash             VARCHAR(66),
-    rlp                 BYTEA,
-    UNIQUE (header_id, transaction_id)
-);
-
-
--- +goose Down
-DROP TABLE header_sync_receipts;

db/migrations/00028_create_uncles_table.sql

@@ -1,16 +0,0 @@
--- +goose Up
-CREATE TABLE public.uncles (
-  id                    SERIAL PRIMARY KEY,
-  hash                  VARCHAR(66) NOT NULL,
-  block_id              INTEGER NOT NULL REFERENCES blocks (id) ON DELETE CASCADE,
-  reward                NUMERIC NOT NULL,
-  miner                 VARCHAR(42) NOT NULL,
-  raw                   JSONB,
-  block_timestamp       NUMERIC,
-  eth_node_id           INTEGER NOT NULL REFERENCES eth_nodes (id) ON DELETE CASCADE,
-  eth_node_fingerprint  VARCHAR(128),
-  UNIQUE (block_id, hash)
-);
-
--- +goose Down
-DROP TABLE public.uncles;

docker-compose.test.yml

@@ -0,0 +1,12 @@
+version: '3.2'
+
+services:
+  contract:
+    build:
+      context: ./test/contract
+      args:
+        ETH_ADDR: "http://go-ethereum:8545"
+    environment:
+      ETH_ADDR: "http://go-ethereum:8545"
+    ports:
+      - "127.0.0.1:3000:3000"

docker-compose.yml

@@ -0,0 +1,59 @@
+version: '3.2'
+
+services:
+  migrations:
+    restart: on-failure
+    depends_on:
+      - ipld-eth-db
+    image: vulcanize/ipld-eth-db:v4.2.0-alpha
+    environment:
+      DATABASE_USER: "vdbm"
+      DATABASE_NAME: "vulcanize_testing"
+      DATABASE_PASSWORD: "password"
+      DATABASE_HOSTNAME: "ipld-eth-db"
+      DATABASE_PORT: 5432
+
+  ipld-eth-db:
+    image: timescale/timescaledb:latest-pg14
+    restart: always
+    command: ["postgres", "-c", "log_statement=all"]
+    environment:
+      POSTGRES_USER: "vdbm"
+      POSTGRES_DB: "vulcanize_testing"
+      POSTGRES_PASSWORD: "password"
+    ports:
+      - "127.0.0.1:8077:5432"
+
+  eth-server:
+    restart: unless-stopped
+    depends_on:
+      - ipld-eth-db
+    build:
+      context: ./
+      cache_from:
+       - alpine:latest
+       - golang:1.13-alpine
+    environment:
+      IPLD_SERVER_GRAPHQL: "true"
+      IPLD_POSTGRAPHILEPATH: http://graphql:5000
+      ETH_SERVER_HTTPPATH: 0.0.0.0:8081
+      VDB_COMMAND: "serve"
+      ETH_CHAIN_CONFIG: "/tmp/chain.json"
+      DATABASE_NAME: "vulcanize_testing"
+      DATABASE_HOSTNAME: "ipld-eth-db"
+      DATABASE_PORT: 5432
+      DATABASE_USER: "vdbm"
+      DATABASE_PASSWORD: "password"
+      ETH_CHAIN_ID: 4
+      ETH_FORWARD_ETH_CALLS: $ETH_FORWARD_ETH_CALLS
+      ETH_PROXY_ON_ERROR: $ETH_PROXY_ON_ERROR
+      ETH_HTTP_PATH: $ETH_HTTP_PATH
+    volumes:
+    - type: bind
+      source: ./chain.json
+      target: /tmp/chain.json
+    ports:
+     - "127.0.0.1:8081:8081"
+
+volumes:
+  vdb_db_eth_server:

dockerfiles/README.md

@@ -1,32 +0,0 @@
-S
-`Dockerfile` will build an alpine image containing:
-- vDB as a binary with runtime deps statically linked: `/app/vulcanizedb`
-- The migration tool goose: `/app/goose`
-- Two services for running `headerSync` and `continuousLogSync`, started with the default configuration `environments/staging.toml`.
-
-By default, vDB is configured towards the Kovan deploy. The configuration values can be overridden using environment variables, using the same hierarchical naming pattern but in CAPS and using underscores. For example, the contract address for the `Pit` can be set with the variable `CONTRACT_ADDRESS_PIT="0x123..."`.
-
-## To use the container:
-1. Setup a postgres database with superuser `vulcanize`
-2. Set the env variables `DATABASE_NAME`, `DATABASE_HOSTNAME`,
-  `DATABASE_PORT`, `DATABASE_USER` & `DATABASE_PASSWORD`
-3. Run the DB migrations:
-  * `./goose postgres "postgresql://$(DATABASE_USER):$(DATABASE_PASSWORD)@$(DATABASE_HOSTNAME):$(DATABASE_PORT)/$(DATABASE_NAME)?sslmode=disable"
-e`
-4. Set `CLIENT_IPCPATH` to a node endpoint
-5. Set the contract variables:
-  * `CONTRACT_ADDRESS_[CONTRACT NAME]=0x123...`
-  * `CONTRACT_ABI_[CONTRACT NAME]="ABI STRING"`
-  * `CONTRACT_DEPLOYMENT-BLOCK_[CONTRACT NAME]=0` (doesn't really matter on a short chain, just avoids long unnecessary searching)
-6. Start the `headerSync` and `continuousLogSync` services:
-  * `./vulcanizedb headerSync --config environments/staging.toml`
-  * `./vulcanizedb continuousLogSync --config environments/staging.toml`
-
-### Automated
-The steps above have been rolled into a script: `/app/startup_script.sh`, which just assumes the DB env variables have been set, and defaults the rest to Kovan according to `environments/staging.toml`. This can be called with something like:
-
-`docker run -d -e DATABASE_NAME=vulcanize_public -e DATABASE_HOSTNAME=localhost -e DATABASE_PORT=5432 -e DATABASE_USER=vulcanize -e DATABASE_PASSWORD=vulcanize m0ar/images:vDB`
-
-### Logging
-When running, vDB services log to `/app/vulcanizedb.log`.
-

dockerfiles/rinkeby/Dockerfile

@@ -1,9 +0,0 @@
-FROM golang:1.10.3-alpine3.7
-
-RUN apk add --no-cache make gcc musl-dev
-
-ADD . /go/src/github.com/vulcanize/vulcanizedb
-WORKDIR /go/src/github.com/vulcanize/vulcanizedb
-RUN go build -o /app main.go
-
-ENTRYPOINT ["/app"]

dockerfiles/rinkeby/config.toml

@@ -1,9 +0,0 @@
-[database]
-name = "vulcanizedb"
-hostname = "postgres"
-port = 5432
-user = "postgres"
-password = "postgres"
-
-[client]
-ipcPath = "/geth/geth.ipc"

dockerfiles/rinkeby/docker-compose.yml

@@ -1,63 +0,0 @@
-version: '2.2'
-
-services:
-
-  vulcanizedb:
-    build:
-      context: ./../../
-      dockerfile: dockerfiles/rinkeby/Dockerfile
-    container_name: rinkeby_vulcanizedb
-    command: "sync --starting-block-number 0 --config /config.toml"
-    volumes:
-      - "./config.toml:/config.toml"
-      - "vulcanizedb_geth_data:/geth"
-    networks:
-      vulcanizedb_net:
-
-  migrations:
-    image: migrate/migrate:v3.3.0
-    container_name: rinkeby_vulcanizedb_migrations
-    depends_on:
-      postgres:
-        condition: service_healthy
-    command: -database postgresql://postgres:postgres@postgres:5432/vulcanizedb?sslmode=disable -path /migrations up
-    volumes:
-      - ./../../db/migrations:/migrations
-    networks:
-      vulcanizedb_net:
-
-  postgres:
-    image: postgres:9.6.5-alpine
-    container_name: rinkeby_vulcanizedb_postgres
-    environment:
-      POSTGRES_USER: postgres
-      POSTGRES_DB: vulcanizedb
-      POSTGRES_PASSWORD: postgres
-    volumes:
-      - "vulcanizedb_db_data:/var/lib/postgresql/data"
-    networks:
-      vulcanizedb_net:
-    healthcheck:
-      test: ["CMD", "pg_isready"]
-      interval: 5s
-      timeout: 5s
-      retries: 30
-  
-  geth:
-    image: ethereum/client-go:v1.8.11
-    container_name: rinkeby_vulcanizedb_geth
-    cpus: 0.3
-    hostname: eth
-    command: '--rinkeby --rpc --rpcaddr="0.0.0.0" --rpcvhosts="geth"'
-    volumes:
-      - "vulcanizedb_geth_data:/root/.ethereum/rinkeby"
-    networks:
-      vulcanizedb_net:
-
-volumes:
-  vulcanizedb_geth_data:
-  vulcanizedb_db_data:
-
-networks:
-  vulcanizedb_net:
-    driver: bridge

dockerfiles/startup_script.sh

@@ -1,29 +0,0 @@
-#!/bin/sh
-# Runs the migrations and starts the headerSync and continuousLogSync services
-
-# Exit if the variable tests fail
-set -e
-
-# Check the database variables are set
-test $DATABASE_NAME
-test $DATABASE_HOSTNAME
-test $DATABASE_PORT
-test $DATABASE_USER
-test $DATABASE_PASSWORD
-
-# Construct the connection string for postgres
-CONNECT_STRING=postgresql://$DATABASE_USER:$DATABASE_PASSWORD@$DATABASE_HOSTNAME:$DATABASE_PORT/$DATABASE_NAME?sslmode=disable
-echo "Connecting with: $CONNECT_STRING"
-
-set +e
-
-# Run the DB migrations
-./goose postgres "$CONNECT_STRING" up
-if [ $? -eq 0 ]; then
-  # Fire up the services
-  ./vulcanizedb headerSync --config environments/staging.toml &
-  ./vulcanizedb continuousLogSync --config environments/staging.toml &
-else
-  echo "Could not run migrations. Are the database details correct?"
-fi
-wait

documentation/apis.md

@@ -0,0 +1,258 @@
+## ipld-eth-server APIs
+We can expose a number of different APIs for remote access to ipld-eth-server data
+
+
+### Table of Contents
+1. [Postgraphile](#postgraphile)
+1. [RPC Subscription Interface](#rpc-subscription-interface)
+1. [Native API Recapitulation](#native-api-recapitulation)
+
+
+### Postgraphile
+ipld-eth-server stores all processed data in Postgres using PG-IPFS, this includes all of the IPLD objects.
+[Postgraphile](https://www.graphile.org/postgraphile/) can be used to expose GraphQL endpoints for the Postgres tables.
+
+e.g.
+
+`postgraphile --plugins @graphile/pg-pubsub --subscriptions --simple-subscriptions -c postgres://localhost:5432/vulcanize_public?sslmode=disable -s public,btc,eth -a -j`
+
+
+This will stand up a Postgraphile server on the public, eth, and btc schemas- exposing GraphQL endpoints for all of the tables contained under those schemas.
+All of their data can then be queried with standard [GraphQL](https://graphql.org) queries.
+
+
+### RPC Subscription Interface
+A direct, real-time subscription to the data being processed by ipld-eth-server can be established over WS or IPC through the [Stream](../pkg/serve/api.go#L53) RPC method.
+This method is not chain-specific and each chain-type supports it, it is accessed under the "vdb" namespace rather than a chain-specific namespace. An interface for
+subscribing to this endpoint is provided [here](../pkg/client/client.go).
+
+When subscribing to this endpoint, the subscriber provides a set of RLP-encoded subscription parameters. These parameters will be chain-specific, and are used
+by ipld-eth-server to filter and return a requested subset of chain data to the subscriber. (e.g. [BTC](../pkg/btc/subscription_config.go), [ETH](../../pkg/eth/subscription_config.go)).
+
+#### Ethereum RPC Subscription
+An example of how to subscribe to a real-time Ethereum data feed from ipld-eth-server using the `Stream` RPC method is provided below
+
+```go
+    package main
+
+    import (
+    	"github.com/ethereum/go-ethereum/rlp"
+    	"github.com/ethereum/go-ethereum/rpc"
+    	"github.com/spf13/viper"
+
+        "github.com/vulcanize/ipld-eth-server/v4/pkg/client"
+        "github.com/vulcanize/ipld-eth-server/v4/pkg/eth"
+        "github.com/vulcanize/ipld-eth-server/v4/pkg/watch"
+    )
+
+    config, _ := eth.NewEthSubscriptionConfig()
+    rlpConfig, _ := rlp.EncodeToBytes(config)
+    vulcPath := viper.GetString("watcher.ethSubscription.path")
+    rpcClient, _ := rpc.Dial(vulcPath)
+    subClient := client.NewClient(rpcClient)
+    payloadChan := make(chan watch.SubscriptionPayload, 20000)
+    subscription, _ := subClient.Stream(payloadChan, rlpConfig)
+    for {
+        select {
+        case payload := <- payloadChan:
+            // do something with the subscription payload
+        case err := <- subscription.Err():
+            // do something with the subscription error
+        }
+    }
+```
+
+The .toml file being used to fill the Ethereum subscription config would look something like this:
+
+```toml
+[watcher]
+    [watcher.ethSubscription]
+        historicalData = false
+        historicalDataOnly = false
+        startingBlock = 0
+        endingBlock = 0
+        wsPath = "ws://127.0.0.1:8080"
+        [watcher.ethSubscription.headerFilter]
+            off = false
+            uncles = false
+        [watcher.ethSubscription.txFilter]
+            off = false
+            src = []
+            dst = []
+        [watcher.ethSubscription.receiptFilter]
+            off = false
+            contracts = []
+            topic0s = []
+            topic1s = []
+            topic2s = []
+            topic3s = []
+        [watcher.ethSubscription.stateFilter]
+            off = false
+            addresses = []
+           intermediateNodes = false
+        [watcher.ethSubscription.storageFilter]
+            off = true
+            addresses = []
+            storageKeys = []
+            intermediateNodes = false
+```
+
+These configuration parameters are broken down as follows:
+
+`ethSubscription.wsPath` is used to define the watcher ws url OR ipc endpoint to subscribe to
+
+`ethSubscription.historicalData` specifies whether or not ipld-eth-server should look up historical data in its cache and
+send that to the subscriber, if this is set to `false` then only newly synced/incoming data is streamed
+
+`ethSubscription.historicalDataOnly` will tell ipld-eth-server to only send historical data with the specified range and
+not stream forward syncing data
+
+`ethSubscription.startingBlock` is the starting block number for the range to receive data in
+
+`ethSubscription.endingBlock` is the ending block number for the range to receive data in;
+setting to 0 means the process will continue streaming indefinitely.
+
+`ethSubscription.headerFilter` has two sub-options: `off` and `uncles`. 
+
+- Setting `off` to true tells ipld-eth-server to not send any headers to the subscriber
+- setting `uncles` to true tells ipld-eth-server to send uncles in addition to normal headers.
+
+`ethSubscription.txFilter` has three sub-options: `off`, `src`, and `dst`. 
+
+- Setting `off` to true tells ipld-eth-server to not send any transactions to the subscriber
+- `src` and `dst` are string arrays which can be filled with ETH addresses to filter transactions for,
+if they have any addresses then ipld-eth-server will only send transactions that were sent or received by the addresses contained
+in `src` and `dst`, respectively.
+
+`ethSubscription.receiptFilter` has four sub-options: `off`, `topics`, `contracts` and `matchTxs`. 
+
+- Setting `off` to true tells ipld-eth-server to not send any receipts to the subscriber
+- `topic0s` is a string array which can be filled with event topics to filter for,
+if it has any topics then ipld-eth-server will only send receipts that contain logs which have that topic0.
+- `contracts` is a string array which can be filled with contract addresses to filter for, if it contains any contract addresses the watcher will
+only send receipts that correspond to one of those contracts. 
+- `matchTrxs` is a bool which when set to true any receipts that correspond to filtered for transactions will be sent by the watcher, regardless of whether or not the receipt satisfies the `topics` or `contracts` filters.
+
+`ethSubscription.stateFilter` has three sub-options: `off`, `addresses`, and `intermediateNodes`. 
+
+- Setting `off` to true tells ipld-eth-server to not send any state data to the subscriber
+- `addresses` is a string array which can be filled with ETH addresses to filter state for,
+if it has any addresses then ipld-eth-server will only send state leafs (accounts) corresponding to those account addresses. 
+- By default ipld-eth-server only sends along state leafs, to receive branch and extension nodes as well `intermediateNodes` can be set to `true`.
+
+`ethSubscription.storageFilter` has four sub-options: `off`, `addresses`, `storageKeys`, and `intermediateNodes`. 
+
+- Setting `off` to true tells ipld-eth-server to not send any storage data to the subscriber
+- `addresses` is a string array which can be filled with ETH addresses to filter storage for,
+if it has any addresses then ipld-eth-server will only send storage nodes from the storage tries at those state addresses.
+- `storageKeys` is another string array that can be filled with storage keys to filter storage data for. It is important to note that the storage keys need to be the actual keccak256 hashes, whereas
+the addresses in the `addresses` fields are pre-hashed ETH addresses.
+- By default ipld-eth-server only sends along storage leafs, to receive branch and extension nodes as well `intermediateNodes` can be set to `true`.
+
+### Bitcoin RPC Subscription:
+An example of how to subscribe to a real-time Bitcoin data feed from ipld-eth-server using the `Stream` RPC method is provided below
+
+```go
+    package main
+
+    import (
+    	"github.com/ethereum/go-ethereum/rlp"
+    	"github.com/ethereum/go-ethereum/rpc"
+    	"github.com/spf13/viper"
+
+    	"github.com/vulcanize/ipld-eth-server/v4/pkg/btc"
+    	"github.com/vulcanize/ipld-eth-server/v4/pkg/client"
+    	"github.com/vulcanize/ipld-eth-server/v4/pkg/watch"
+    )
+
+    config, _ := btc.NewBtcSubscriptionConfig()
+    rlpConfig, _ := rlp.EncodeToBytes(config)
+    vulcPath := viper.GetString("watcher.btcSubscription.path")
+    rpcClient, _ := rpc.Dial(vulcPath)
+    subClient := client.NewClient(rpcClient)
+    payloadChan := make(chan watch.SubscriptionPayload, 20000)
+    subscription, _ := subClient.Stream(payloadChan, rlpConfig)
+    for {
+        select {
+        case payload := <- payloadChan:
+            // do something with the subscription payload
+        case err := <- subscription.Err():
+            // do something with the subscription error
+        }
+    }
+```
+
+The .toml file being used to fill the Bitcoin subscription config would look something like this:
+
+```toml
+[watcher]
+    [watcher.btcSubscription]
+        historicalData = false
+        historicalDataOnly = false
+        startingBlock = 0
+        endingBlock = 0
+        wsPath = "ws://127.0.0.1:8080"
+        [watcher.btcSubscription.headerFilter]
+            off = false
+        [watcher.btcSubscription.txFilter]
+            off = false
+            segwit = false
+            witnessHashes = []
+            indexes = []
+            pkScriptClass = []
+            multiSig = false
+            addresses = []
+```
+
+These configuration parameters are broken down as follows:
+
+`btcSubscription.wsPath` is used to define the ipld-eth-server ws url OR ipc endpoint to subscribe to
+
+`btcSubscription.historicalData` specifies whether or not ipld-eth-server should look up historical data in its cache and
+send that to the subscriber, if this is set to `false` then ipld-eth-server only streams newly synced/incoming data
+
+`btcSubscription.historicalDataOnly` will tell ipld-eth-server to only send historical data with the specified range and
+not stream forward syncing data
+
+`btcSubscription.startingBlock` is the starting block number for the range to receive data in
+
+`btcSubscription.endingBlock` is the ending block number for the range to receive data in;
+setting to 0 means the process will continue streaming indefinitely.
+
+`btcSubscription.headerFilter` has one sub-option: `off`. 
+
+- Setting `off` to true tells ipld-eth-server to
+not send any headers to the subscriber.
+- Additional header-filtering options will be added in the future.
+
+`btcSubscription.txFilter` has seven sub-options: `off`, `segwit`, `witnessHashes`, `indexes`, `pkScriptClass`, `multiSig`, and `addresses`.
+
+- Setting `off` to true tells ipld-eth-server to not send any transactions to the subscriber.
+- Setting `segwit` to true tells ipld-eth-server to only send segwit transactions.
+- `witnessHashes` is a string array that can be filled with witness hash string; if it contains any hashes ipld-eth-server will only send transactions that contain one of those hashes.
+- `indexes` is an int64 array that can be filled with tx index numbers; if it contains any integers ipld-eth-server will only send transactions at those indexes (e.g. `[0]` will send only coinbase transactions)
+- `pkScriptClass` is an uint8 array that can be filled with pk script class numbers; if it contains any integers ipld-eth-server will only send transactions that have at least one tx output with one of the specified pkscript classes;
+possible class types are 0 through 8 as defined [here](https://github.com/btcsuite/btcd/blob/master/txscript/standard.go#L52).
+- Setting `multisig` to true tells ipld-eth-server to send only multi-sig transactions- to send only transaction that have at least one tx output that requires more than one signature to spend.
+- `addresses` is a string array that can be filled with btc address strings; if it contains any addresses ipld-eth-server will only send transactions that have at least one tx output with at least one of the provided addresses.
+
+
+### Native API Recapitulation:
+In addition to providing novel Postgraphile and RPC-Subscription endpoints, we are working towards complete recapitulation of the
+standard chain APIs. This will allow direct compatibility with software that already makes use of the standard interfaces.
+
+#### Ethereum JSON-RPC API
+ipld-eth-server currently faithfully recapitulates portions of the Ethereum JSON-RPC api standard.
+
+The currently supported endpoints include:  
+`eth_blockNumber`  
+`eth_getLogs`  
+`eth_getHeaderByNumber`  
+`eth_getBlockByNumber`  
+`eth_getBlockByHash`  
+`eth_getTransactionByHash`  
+
+Additional endpoints will be added in the near future, with the immediate goal of recapitulating the largest set of "eth_" endpoints which can be provided as a service.
+
+#### Bitcoin JSON-RPC API:
+In the near future, the standard Bitcoin JSON-RPC interfaces will be implemented.

documentation/contributing.md

@@ -1,50 +0,0 @@
-# Contribution guidelines
-
-Contributions are welcome! Please open an Issues or Pull Request for any changes.
-
-In addition to core contributions, developers are encouraged to build their own custom transformers which
-can be run together with other custom transformers using the [composeAndExecute](../../staging/documentation/custom-transformers.md) command.
-
-## Pull Requests
-- `go fmt` is run as part of `make test` and `make integrationtest`, please make sure to check in the format changes.
-- Ensure that new code is well tested, including integration testing if applicable.
-- Make sure the build is passing.
-- Update the README or any [documentation files](./) as necessary. If editing the Readme, please
-conform to the
-[standard-readme specification](https://github.com/RichardLitt/standard-readme).
-- Once a Pull Request has received two approvals it can be merged in by a core developer.
-
-## Creating a new migration file
-1. `make new_migration NAME=add_columnA_to_table1`
-    - This will create a new timestamped migration file in `db/migrations`
-1. Write the migration code in the created file, under the respective `goose` pragma
-    - Goose automatically runs each migration in a transaction; don't add `BEGIN` and `COMMIT` statements.
-1. Core migrations should be committed in their `goose fix`ed form. To do this, run `make version_migrations` which
-converts timestamped migrations to migrations versioned by an incremented integer.
-
-## Diagrams
-- Diagrams were created with [draw.io](https://www.draw.io).
-- To update a diagram:
-  1. Go to [draw.io](https://www.draw.io).
-  1. Click on *File > Open from* and choose the location of the diagram you want to update.
-  1. Once open in draw.io, you may update it.
-  1. Export the diagram to this repository's directory and commit it.
-
-
-## Generating the Changelog
-We use [github-changelog-generator](https://github.com/github-changelog-generator/github-changelog-generator) to generate release Changelogs. To be consistent with previous Changelogs, the following flags should be passed to the command:
-
-```
---user vulcanize
---project vulcanizedb
---token {YOUR_GITHUB_TOKEN}
---no-issues
---usernames-as-github-logins
---since-tag {PREVIOUS_RELEASE_TAG}
-```
-
-For more information on why your github token is needed, and how to generate it see [https://github
-.com/github-changelog-generator/github-changelog-generator#github-token](https://github.com/github-changelog-generator/github-changelog-generator#github-token).
-
-## Code of Conduct
-VulcanizeDB follows the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct).

documentation/custom-transformers.md

@@ -1,196 +0,0 @@
-# Custom Transformers
-When the capabilities of the generic `contractWatcher` are not sufficient, custom transformers tailored to a specific
-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).
-
-## 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)
-
-Event Transformers: transform data derived from Ethereum log events
-   * [Guide](../../staging/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)
-
-Contract Transformers: transform data derived from Ethereum log events and use it to poll public contract methods
-   * [Example 1](https://github.com/vulcanize/account_transformers)
-   * [Example 2](https://github.com/vulcanize/ens_transformers/tree/master/transformers/domain_records)
-
-## 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
-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
-    * If the base vDB migrations occupy this path as well, they need to be in their `goose fix`ed form
-    as they are [here](../../staging/db/migrations)
-
-To update a plugin repository with changes to the core vulcanizedb repository, use your dependency manager to install the desired version of vDB.
-
-## Building and Running Custom Transformers
-### Commands
-* The `compose`, `execute`, `composeAndExecute` commands require Go 1.11+ and use [Go plugins](https://golang
-.org/pkg/plugin/) which only work on Unix-based systems.
-
-* There is an ongoing [conflict](https://github.com/golang/go/issues/20481) between Go plugins and the use of vendored
-dependencies which imposes certain limitations on how the plugins are built.
-
-* Separate `compose` and `execute` commands allow pre-building and linking to the pre-built .so file. So, if
-these are run independently, instead of using `composeAndExecute`, a couple of things need to be considered:
-    * It is necessary that the .so file was built with the same exact dependencies that are present in the execution
-    environment, i.e. we need to `compose` and `execute` the plugin .so file with the same exact version of vulcanizeDB.
-    * The plugin migrations are run during the plugin's composition. As such, if `execute` is used to run a prebuilt .so
-    in a different environment than the one it was composed in, then the database structure will need to be loaded 
-    into the environment's Postgres database. This can either be done by manually loading the plugin's schema into 
-    Postgres, or by manually running the plugin's migrations.
-     
-* The `compose` and `composeAndExecute` commands assume you are in the vulcanizdb directory located at your system's 
-`$GOPATH`, and that the plugin dependencies are present at their `$GOPATH` directories.
-
-* The `execute` command does not require the plugin transformer dependencies be located in their `$GOPATH` directories,
-instead it expects a .so file (of the name specified in the config file) to be in
-`$GOPATH/src/github.com/vulcanize/vulcanizedb/plugins/` and, as noted above, also expects the plugin db migrations to
- have already been ran against the database.
-
- * Usage:
-     * compose: `./vulcanizedb compose --config=environments/config_name.toml`
-
-     * execute: `./vulcanizedb execute --config=environments/config_name.toml`
-
-     * composeAndExecute: `./vulcanizedb composeAndExecute --config=environments/config_name.toml`
-
-### Flags
-The `execute` and `composeAndExecute` commands can be passed optional flags to specify the operation of the watchers:
-
-- `--recheck-headers`/`-r` - specifies whether to re-check headers for events after the header has already been queried for watched logs.
-Can be useful for redundancy if you suspect that your node is not always returning all desired logs on every query.
-Argument is expected to be a boolean: e.g. `-r=true`.
-Defaults to `false`.
-
-- `query-recheck-interval`/`-q` - specifies interval for re-checking storage diffs that haven been queued for later processing
-(by default, the storage watched queues storage diffs if transformer execution fails, on the assumption that subsequent data derived from the event transformers may enable us to decode storage keys that we don't recognize right now).
-Argument is expected to be a duration (integer measured in nanoseconds): e.g. `-q=10m30s` (for 10 minute, 30 second intervals).
-Defaults to `5m` (5 minutes).
-
-### Configuration
-A .toml config file is specified when executing the commands.
-The config provides information for composing a set of transformers from external repositories:
-
-```toml
-[database]
-    name     = "vulcanize_public"
-    hostname = "localhost"
-    user     = "vulcanize"
-    password = "vulcanize"
-    port     = 5432
-
-[client]
-    ipcPath  = "/Users/user/Library/Ethereum/geth.ipc"
-
-[exporter]
-    home     = "github.com/vulcanize/vulcanizedb"
-    name     = "exampleTransformerExporter"
-    save     = false
-    transformerNames = [
-        "transformer1",
-        "transformer2",
-        "transformer3",
-        "transformer4",
-    ]
-    [exporter.transformer1]
-        path = "path/to/transformer1"
-        type = "eth_event"
-        repository = "github.com/account/repo"
-        migrations = "db/migrations"
-        rank = "0"
-    [exporter.transformer2]
-        path = "path/to/transformer2"
-        type = "eth_contract"
-        repository = "github.com/account/repo"
-        migrations = "db/migrations"
-        rank = "0"
-    [exporter.transformer3]
-        path = "path/to/transformer3"
-        type = "eth_event"
-        repository = "github.com/account/repo"
-        migrations = "db/migrations"
-        rank = "0"
-    [exporter.transformer4]
-        path = "path/to/transformer4"
-        type = "eth_storage"
-        repository = "github.com/account2/repo2"
-        migrations = "to/db/migrations"
-        rank = "1"
-```
-- `home` is the name of the package you are building the plugin for, in most cases this is github.com/vulcanize/vulcanizedb
-- `name` is the name used for the plugin files (.so and .go)   
-- `save` indicates whether or not the user wants to save the .go file instead of removing it after .so compilation. Sometimes useful for debugging/trouble-shooting purposes.
-- `transformerNames` is the list of the names of the transformers we are composing together, so we know how to access their submaps in the exporter map
-- `exporter.<transformerName>`s are the sub-mappings containing config info for the transformers
-    - `repository` is the path for the repository which contains the transformer and its `TransformerInitializer`
-    - `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)
-         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)
-         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)
-        based transformers which work with either a header or full sync 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
-        - this is to help isolate any potential conflicts between transformer migrations
-        - start at "0" 
-        - use strings
-        - don't leave gaps
-        - transformers with identical migrations/migration paths should share the same rank
-- Note: If any of the imported transformers need additional config variables those need to be included as well   
-
-This information is used to write and build a Go plugin which exports the configured transformers.
-These transformers are loaded onto their specified watchers and executed.
-
-Transformers of different types can be run together in the same command using a single config file or in separate instances using different config files   
-
-The general structure of a plugin .go file, and what we would see built with the above config is shown below
-
-```go
-package main
-
-import (
-	interface1 "github.com/vulcanize/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"
-	transformer4 "github.com/account2/repo2/path/to/transformer4"
-)
-
-type exporter string
-
-var Exporter exporter
-
-func (e exporter) Export() []interface1.EventTransformerInitializer, []interface1.StorageTransformerInitializer, []interface1.ContractTransformerInitializer {
-	return []interface1.TransformerInitializer{
-            transformer1.TransformerInitializer,
-            transformer3.TransformerInitializer,
-        },     []interface1.StorageTransformerInitializer{
-            transformer4.StorageTransformerInitializer,
-        },     []interface1.ContractTransformerInitializer{
-            transformer2.TransformerInitializer,
-        }
-}
-```

documentation/data-syncing.md

@@ -1,81 +0,0 @@
-# Syncing commands
-These commands are used to sync raw Ethereum data into Postgres, with varying levels of data granularity.
-
-## headerSync
-Syncs block headers from a running Ethereum node into the VulcanizeDB table `headers`.
-- Queries the Ethereum node using RPC calls.
-- Validates headers from the last 15 blocks to ensure that data is up to date.
-- Useful when you want a minimal baseline from which to track targeted data on the blockchain (e.g. individual smart
-contract storage values or event logs).
-- Handles chain reorgs by [validating the most recent blocks' hashes](../pkg/history/header_validator.go). If the hash is
-different from what we have already stored in the database, the header record will be updated.
-
-#### Usage
-- Run: `./vulcanizedb headerSync --config <config.toml> --starting-block-number <block-number>`
-- The config file must be formatted as follows, and should contain an ipc path to a running Ethereum node:
-```toml
-[database]
-    name     = "vulcanize_public"
-    hostname = "localhost"
-    user     = "vulcanize"
-    password = "vulcanize"
-    port     = 5432
-
-[client]
-    ipcPath  = <path to a running Ethereum node>
-```
-- Alternatively, the ipc path can be passed as a flag instead `--client-ipcPath`.
-
-## fullSync
-Syncs blocks, transactions, receipts and logs from a running Ethereum node into VulcanizeDB tables named
-`blocks`, `uncles`, `full_sync_transactions`, `full_sync_receipts` and `logs`. 
-- Queries the Ethereum node using RPC calls.
-- Validates headers from the last 15 blocks to ensure that data is up to date.
-- Useful when you want to maintain a broad cache of what's happening on the blockchain.
-- Handles chain reorgs by [validating the most recent blocks' hashes](../pkg/history/header_validator.go). If the hash is
-different from what we have already stored in the database, the header record will be updated.
-
-#### Usage
-- Run `./vulcanizedb fullSync --config <config.toml> --starting-block-number <block-number>`
-- The config file must be formatted as follows, and should contain an ipc path to a running Ethereum node:
-```toml
-[database]
-    name     = "vulcanize_public"
-    hostname = "localhost"
-    user     = "vulcanize"
-    password = "vulcanize"
-    port     = 5432
-
-[client]
-    ipcPath  = <path to a running Ethereum node>
-```
-- Alternatively, the ipc path can be passed as a flag instead `--client-ipcPath`.
-
-*Please note, that if you are fast syncing your Ethereum node, wait for the initial sync to finish.*
-
-## coldImport
-Syncs VulcanizeDB from Geth's underlying LevelDB datastore and persists Ethereum blocks, 
-transactions, receipts and logs into VulcanizeDB tables named `blocks`, `uncles`, 
-`full_sync_transactions`, `full_sync_receipts` and `logs` respectively.
-
-#### Usage
-1. Ensure the Ethereum node you're point at is not running, and that it has synced to the desired block height.
-1. Run `./vulcanizedb coldImport --config <config.toml>`
-1. Optional flags:
-    - `--starting-block-number <block number>`/`-s <block number>`: block number to start syncing from
-    - `--ending-block-number <block number>`/`-e <block number>`: block number to sync to
-    - `--all`/`-a`: sync all missing blocks
-
-The config file can be formatted as follows, and must contain the LevelDB path.
-
-```toml
-[database]
-    name     = "vulcanize_public"
-    hostname = "localhost"
-    user     = "vulcanize"
-    password = "vulcanize"
-    port     = 5432
-
-[client]
-    leveldbpath = "/Users/user/Library/Ethereum/geth/chaindata"
-```

documentation/generic-transformer.md

@@ -1,160 +0,0 @@
-# Generic Transformer
-The `contractWatcher` command is a built-in generic contract watcher. It can watch any and all events for a given contract provided the contract's ABI is available.
-It also provides some state variable coverage by automating polling of public methods, with some restrictions:
-1. The method must have 2 or less arguments
-1. The method's arguments must all be of type address or bytes32 (hash)
-1. The method must return a single value
-
-This command operates in two modes- `header` and `full`- which require a header or full-synced vulcanizeDB, respectively.
-
-This command requires the contract ABI be available on Etherscan if it is not provided in the config file by the user.
-
-If method polling is turned on we require an archival node at the ETH ipc endpoint in our config, whether or not we are operating in `header` or `full` mode.
-Otherwise we only need to connect to a full node.
-
-## Configuration
-This command takes a config of the form:
-
-```toml
-  [database]
-    name     = "vulcanize_public"
-    hostname = "localhost"
-    port     = 5432
-
-  [client]
-    ipcPath  = "/Users/user/Library/Ethereum/geth.ipc"
-
-  [contract]
-    network  = ""
-    addresses  = [
-        "contractAddress1",
-        "contractAddress2"
-    ]
-    [contract.contractAddress1]
-        abi    = 'ABI for contract 1'
-        startingBlock = 982463
-    [contract.contractAddress2]
-        abi    = 'ABI for contract 2'
-        events = [
-            "event1",
-            "event2"
-        ]
-		eventArgs = [
-			"arg1",
-			"arg2"
-		]
-        methods = [
-            "method1",
-			"method2"
-        ]
-		methodArgs = [
-			"arg1",
-			"arg2"
-		]
-        startingBlock = 4448566
-        piping = true
-````
-
-- The `contract` section defines which contracts we want to watch and with which conditions.
-- `network` is only necessary if the ABIs are not provided and wish to be fetched from Etherscan.
-    - Empty or nil string indicates mainnet
-    - "ropsten", "kovan", and "rinkeby" indicate their respective networks
-- `addresses` lists the contract addresses we are watching and is used to load their individual configuration parameters
-- `contract.<contractAddress>` are the sub-mappings which contain the parameters specific to each contract address
-    - `abi` is the ABI for the contract; if none is provided the application will attempt to fetch one from Etherscan using the provided address and network
-    - `events` is the list of events to watch
-        - If this field is omitted or no events are provided then by defualt ALL events extracted from the ABI will be watched
-        - If event names are provided then only those events will be watched
-    - `eventArgs` is the list of arguments to filter events with
-        - If this field is omitted or no eventArgs are provided then by default watched events are not filtered by their argument values
-        - If eventArgs are provided then only those events which emit at least one of these values as an argument are watched
-    - `methods` is the list of methods to poll
-        - If this is omitted or no methods are provided then by default NO methods are polled
-        - If method names are provided then those methods will be polled, provided
-            1) Method has two or less arguments
-            1) Arguments are all of address or hash types
-            1) Method returns a single value
-    - `methodArgs` is the list of arguments to limit polling methods to
-        - If this field is omitted or no methodArgs are provided then by default methods will be polled with every combination of the appropriately typed values that have been collected from watched events
-        - If methodArgs are provided then only those values will be used to poll methods
-    - `startingBlock` is the block we want to begin watching the contract, usually the deployment block of that contract
-    - `piping` is a boolean flag which indicates whether or not we want to pipe return method values forward as arguments to subsequent method calls
-
-At the very minimum, for each contract address an ABI and a starting block number need to be provided (or just the starting block if the ABI can be reliably fetched from Etherscan).
-With just this information we will be able to watch all events at the contract, but with no additional filters and no method polling.
-
-## Output
-
-Transformed events and polled method results are committed to Postgres in schemas and tables generated according to the contract abi.      
-
-Schemas are created for each contract using the naming convention `<sync-type>_<lowercase contract-address>`
-Under this schema, tables are generated for watched events as `<lowercase event name>_event` and for polled methods as `<lowercase method name>_method`  
-The 'method' and 'event' identifiers are tacked onto the end of the table names to prevent collisions between methods and events of the same lowercase name    
-
-## Example:
-
-Modify `./environments/example.toml` to replace the empty `ipcPath` with a path that points to an ethjson_rpc endpoint (e.g. a local geth node ipc path or an Infura url).
-This endpoint should be for an archival eth node if we want to perform method polling as this configuration is currently set up to do. To work with a non-archival full node,
-remove the `balanceOf` method from the `0x8dd5fbce2f6a956c3022ba3663759011dd51e73e` (TrueUSD) contract.
-
-If you are operating a header sync vDB, run:
-
- `./vulcanizedb contractWatcher --config=./environments/example.toml --mode=header`
-
-If instead you are operating a full sync vDB and provided an archival node IPC path, run in full mode:
-
- `./vulcanizedb contractWatcher --config=./environments/example.toml --mode=full`
-
-This will run the contractWatcher and configures it to watch the contracts specified in the config file. Note that
-by default we operate in `header` mode but the flag is included here to demonstrate its use.
-
-The example config we link to in this example watches two contracts, the ENS Registry (0x314159265dD8dbb310642f98f50C066173C1259b) and TrueUSD (0x8dd5fbCe2F6a956C3022bA3663759011Dd51e73E).
-
-Because the ENS Registry is configured with only an ABI and a starting block, we will watch all events for this contract and poll none of its methods. Note that the ENS Registry is an example
-of a contract which does not have its ABI available over Etherscan and must have it included in the config file.
-
-The TrueUSD contract is configured with two events (`Transfer` and `Mint`) and a single method (`balanceOf`), as such it will watch these two events and use any addresses it collects emitted from them
-to poll the `balanceOf` method with those addresses at every block. Note that we do not provide an ABI for TrueUSD as its ABI can be fetched from Etherscan.
-
-For the ENS contract, it produces and populates a schema with four tables"
-`header_0x314159265dd8dbb310642f98f50c066173c1259b.newowner_event`
-`header_0x314159265dd8dbb310642f98f50c066173c1259b.newresolver_event`
-`header_0x314159265dd8dbb310642f98f50c066173c1259b.newttl_event`
-`header_0x314159265dd8dbb310642f98f50c066173c1259b.transfer_event`
-
-For the TrusUSD contract, it produces and populates a schema with three tables:
-
-`header_0x8dd5fbce2f6a956c3022ba3663759011dd51e73e.transfer_event`
-`header_0x8dd5fbce2f6a956c3022ba3663759011dd51e73e.mint_event`
-`header_0x8dd5fbce2f6a956c3022ba3663759011dd51e73e.balanceof_method`
-
-Column ids and types for these tables are generated based on the event and method argument names and types and method return types, resulting in tables such as:
-
-Table "header_0x8dd5fbce2f6a956c3022ba3663759011dd51e73e.transfer_event"
-
-|  Column    |         Type          | Collation | Nullable |                                           Default                                            | Storage  | Stats target | Description  
-|:----------:|:---------------------:|:---------:|:--------:|:--------------------------------------------------------------------------------------------:|:--------:|:------------:|:-----------:|
-| id         | integer               |           | not null | nextval('header_0x8dd5fbce2f6a956c3022ba3663759011dd51e73e.transfer_event_id_seq'::regclass) | plain    |              |             |
-| header_id  | integer               |           | not null |                                                                                              | plain    |              |             |
-| token_name | character varying(66) |           | not null |                                                                                              | extended |              |             |
-| raw_log    | jsonb                 |           |          |                                                                                              | extended |              |             |
-| log_idx    | integer               |           | not null |                                                                                              | plain    |              |             |
-| tx_idx     | integer               |           | not null |                                                                                              | plain    |              |             |
-| from_      | character varying(66) |           | not null |                                                                                              | extended |              |             |
-| to_        | character varying(66) |           | not null |                                                                                              | extended |              |             |
-| value_     | numeric               |           | not null |                                                                                              | main     |              |             |
-
-
-Table "header_0x8dd5fbce2f6a956c3022ba3663759011dd51e73e.balanceof_method"
-
-|   Column   |         Type          | Collation | Nullable |                                            Default                                             | Storage  | Stats target | Description |
-|:----------:|:---------------------:|:---------:|:--------:|:----------------------------------------------------------------------------------------------:|:--------:|:------------:|:-----------:|
-| id         | integer               |           | not null | nextval('header_0x8dd5fbce2f6a956c3022ba3663759011dd51e73e.balanceof_method_id_seq'::regclass) | plain    |              |             |
-| token_name | character varying(66) |           | not null |                                                                                                | extended |              |             |
-| block      | integer               |           | not null |                                                                                                | plain    |              |             |
-| who_       | character varying(66) |           | not null |                                                                                                | extended |              |             |
-| returned   | numeric               |           | not null |                                                                                                | main     |              |             |
-  
-The addition of '_' after table names is to prevent collisions with reserved Postgres words.
-
-Also notice that the contract address used for the schema name has been down-cased.

documentation/postgraphile.md

@@ -1,34 +0,0 @@
-# Postgraphile
-
-You can expose VulcanizeDB data via [Postgraphile](https://github.com/graphile/postgraphile).
-Check out [their documentation](https://www.graphile.org/postgraphile/) for the most up-to-date instructions on installing, running, and customizing Postgraphile.
-
-## Simple Setup
-
-As of April 30, 2019, you can run Postgraphile pointed at the default `vulcanize_public` database with the following commands:
-
-```
-npm install -g postgraphile
-postgraphile --connection postgres://localhost/vulcanize_public --schema=public,custom --disable-default-mutations --no-ignore-rbac
-```
-
-Arguments:
-- `--connection` specifies the database. The above command connects to the default `vulcanize_public` database 
-defined in [the example config](../environments/public.toml.example).
-- `--schema` defines what schema(s) to expose. The above exposes the `public` schema (for core VulcanizeDB data) as well as a `custom` schema (where `custom` is the name of a schema defined in executed transformers).
-- `--disable-default-mutations` prevents Postgraphile from exposing create, update, and delete operations on your data, which are otherwise enabled by default.
-- `--no-ignore-rbac` ensures that Postgraphile will only expose the tables, columns, fields, and query functions that the user has explicit access to.
-
-## Customizing Postgraphile
-
-By default, Postgraphile will expose queries for all tables defined in your chosen database/schema(s), including [filtering](https://www.graphile.org/postgraphile/filtering/) and [auto-discovered relations](https://www.graphile.org/postgraphile/relations/).
-
-If you'd like to expose more customized windows into your data, there are some techniques you can apply when writing migrations:
-
-- [Computed columns](https://www.graphile.org/postgraphile/computed-columns/) enable you to derive additional fields from types defined in your database.
-For example, you could write a function to expose a block header's state root over Postgraphile with a computed column - without modifying the `public.headers` table.
-- [Custom queries](https://www.graphile.org/postgraphile/custom-queries/) enable you to provide on-demand access to more complex data (e.g. the product of joining and filtering several tables' data based on a passed argument).
-For example, you could write a custom query to get the block timestamp for every transaction originating from a given address.
-- [Subscriptions](https://www.graphile.org/postgraphile/subscriptions/) enable you to publish data as it is coming into your database.
-
-The above list is not exhaustive - please see the Postgraphile documentation for a more comprehensive and up-to-date description of available features.

entrypoint.sh

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+echo "Beginning the ipld-eth-server process"
+
+echo running: ./ipld-eth-server ${VDB_COMMAND} --config=config.toml
+./ipld-eth-server ${VDB_COMMAND} --config=config.toml
+rv=$?
+
+if [ $rv != 0 ]; then
+  echo "ipld-eth-server startup failed"
+  exit 1
+fi

environments/composeAndExecuteAccountTransformer.toml

@@ -1,38 +0,0 @@
-[database]
-    name     = "vulcanize_public"
-    hostname = "localhost"
-    port     = 5432
-
-[client]
-    ipcPath = ""
-
-[exporter]
-    home     = "github.com/vulcanize/vulcanizedb"
-    name     = "accountTransformerExporter"
-    save     = false
-    transformerNames = [
-        "account"
-    ]
-    [exporter.account]
-        path = "transformers/account/light/initializer"
-        type = "eth_contract"
-        repository = "github.com/vulcanize/account_transformers"
-        migrations = "db/migrations"
-        rank = "0"
-
-[token]
-    addresses = [
-        "0x58b6A8A3302369DAEc383334672404Ee733aB239",
-        "0x862Da0A691bb0b74038377295f8fF523D0493eB4",
-    ]
-    [token.equivalents]
-        0x0000000000085d4780B73119b644AE5ecd22b376 = [
-           "0x8dd5fbCe2F6a956C3022bA3663759011Dd51e73E"
-        ]
-        0x58b6A8A3302369DAEc383334672404Ee733aB239 = [
-           "0x8e306b005773bee6bA6A6e8972Bc79D766cC15c8"
-        ]
-
-[account]
-    start = 0
-    addresses = []

environments/example.toml

@@ -1,26 +1,30 @@
 [database]
-    name     = "vulcanize_public"
-    hostname = "localhost"
-    port     = 5432
+    name     = "vulcanize_public" # $DATABASE_NAME
+    hostname = "localhost" # $DATABASE_HOSTNAME
+    port     = 5432 # $DATABASE_PORT
+    user     = "postgres" # $DATABASE_USER
+    password = "" # $DATABASE_PASSWORD
 
-[client]
-    ipcPath  = ""
+[log]
+    level = "info" # $LOGRUS_LEVEL
 
-[contract]
-    network  = ""
-    addresses  = [
-        "0x314159265dD8dbb310642f98f50C066173C1259b",
-        "0x8dd5fbCe2F6a956C3022bA3663759011Dd51e73E"
-    ]
-    [contract.0x314159265dD8dbb310642f98f50C066173C1259b]
-        abi    = '[{"constant":true,"inputs":[{"name":"node","type":"bytes32"}],"name":"resolver","outputs":[{"name":"","type":"address"}],"payable":false,"type":"function"},{"constant":true,"inputs":[{"name":"node","type":"bytes32"}],"name":"owner","outputs":[{"name":"","type":"address"}],"payable":false,"type":"function"},{"constant":false,"inputs":[{"name":"node","type":"bytes32"},{"name":"label","type":"bytes32"},{"name":"owner","type":"address"}],"name":"setSubnodeOwner","outputs":[],"payable":false,"type":"function"},{"constant":false,"inputs":[{"name":"node","type":"bytes32"},{"name":"ttl","type":"uint64"}],"name":"setTTL","outputs":[],"payable":false,"type":"function"},{"constant":true,"inputs":[{"name":"node","type":"bytes32"}],"name":"ttl","outputs":[{"name":"","type":"uint64"}],"payable":false,"type":"function"},{"constant":false,"inputs":[{"name":"node","type":"bytes32"},{"name":"resolver","type":"address"}],"name":"setResolver","outputs":[],"payable":false,"type":"function"},{"constant":false,"inputs":[{"name":"node","type":"bytes32"},{"name":"owner","type":"address"}],"name":"setOwner","outputs":[],"payable":false,"type":"function"},{"anonymous":false,"inputs":[{"indexed":true,"name":"node","type":"bytes32"},{"indexed":false,"name":"owner","type":"address"}],"name":"Transfer","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"name":"node","type":"bytes32"},{"indexed":true,"name":"label","type":"bytes32"},{"indexed":false,"name":"owner","type":"address"}],"name":"NewOwner","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"name":"node","type":"bytes32"},{"indexed":false,"name":"resolver","type":"address"}],"name":"NewResolver","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"name":"node","type":"bytes32"},{"indexed":false,"name":"ttl","type":"uint64"}],"name":"NewTTL","type":"event"}]'
-        startingBlock = 3327417
-    [contract.0x8dd5fbCe2F6a956C3022bA3663759011Dd51e73E]
-        events = [
-            "Transfer",
-            "Issue"
-        ]
-        methods = [
-            "balanceOf"
-        ]
-        startingBlock = 5197514
+[server]
+    ipcPath = "~/.vulcanize/vulcanize.ipc" # $SERVER_IPC_PATH
+    wsPath = "127.0.0.1:8081" # $SERVER_WS_PATH
+    httpPath = "127.0.0.1:8082" # $SERVER_HTTP_PATH
+    graphql = true # $SERVER_GRAPHQL
+    graphqlEndpoint = "127.0.0.1:8083" # $SERVER_GRAPHQL_ENDPOINT
+
+[ethereum]
+    chainConfig = "./chain.json" # ETH_CHAIN_CONFIG
+    chainID = "1" # $ETH_CHAIN_ID
+    defaultSender = "" # $ETH_DEFAULT_SENDER_ADDR
+    rpcGasCap = "1000000000000" # $ETH_RPC_GAS_CAP
+    httpPath = "127.0.0.1:8545" # $ETH_HTTP_PATH
+    supportsStateDiff = true # $ETH_SUPPORTS_STATEDIFF
+    forwardEthCalls = false # $ETH_FORWARD_ETH_CALLS
+    proxyOnError = true # $ETH_PROXY_ON_ERROR
+    nodeID = "arch1" # $ETH_NODE_ID
+    clientName = "Geth" # $ETH_CLIENT_NAME
+    genesisBlock = "0xd4e56740f876aef8c010b86a40d5f56745a118d0906a34e69aec8c0db1cb8fa3" # $ETH_GENESIS_BLOCK
+    networkID = "1" # $ETH_NETWORK_ID

environments/infura.toml

@@ -1,7 +0,0 @@
-[database]
-    name     = "vulcanize_public"
-    hostname = "localhost"
-    port     = 5432
-
-[client]
-    ipcPath  = ""

environments/private.toml

@@ -1,7 +0,0 @@
-[database]
-    name     = "vulcanize_private"
-    hostname = "localhost"
-    port     = 5432
-
-[client]
-    ipcPath  = "http://127.0.0.1:7545"

environments/public.toml.example

@@ -1,8 +0,0 @@
-[database]
-    name = "vulcanize_public"
-    hostname = "localhost"
-    port = 5432
-
-[client]
-    ipcPath = <local node's IPC filepath>
-    levelDbPath = <local node's LevelDB chaindata filepath>

environments/subscribeExample.toml

@@ -0,0 +1,30 @@
+[watcher]
+    [watcher.ethSubscription]
+        historicalData = false
+        historicalDataOnly = false
+        startingBlock = 0
+        endingBlock = 0
+        wsPath = "ws://127.0.0.1:8080"
+        [watcher.ethSubscription.headerFilter]
+            off = false
+            uncles = false
+        [watcher.ethSubscription.txFilter]
+            off = false
+            src = []
+            dst = []
+        [watcher.ethSubscription.receiptFilter]
+            off = false
+            contracts = []
+            topic0s = []
+            topic1s = []
+            topic2s = []
+            topic3s = []
+        [watcher.ethSubscription.stateFilter]
+            off = false
+            addresses = []
+           intermediateNodes = false
+        [watcher.ethSubscription.storageFilter]
+            off = true
+            addresses = []
+            storageKeys = []
+            intermediateNodes = false

environments/testing.toml

@@ -0,0 +1,7 @@
+[database]
+  name     = "vulcanize_testing"
+  hostname = "localhost"
+  port     = 5432
+
+[client]
+  ipcPath  = "http://127.0.0.1:8545"

go.mod

@@ -1,33 +1,295 @@
-module github.com/vulcanize/vulcanizedb
+module github.com/vulcanize/ipld-eth-server/v4
 
-go 1.12
+go 1.18
 
 require (
-	github.com/allegro/bigcache v1.2.1 // indirect
-	github.com/aristanetworks/goarista v0.0.0-20190712234253-ed1100a1c015 // indirect
-	github.com/dave/jennifer v1.3.0
-	github.com/ethereum/go-ethereum v1.9.1
-	github.com/graph-gophers/graphql-go v0.0.0-20190724201507-010347b5f9e6 // indirect
-	github.com/hashicorp/golang-lru v0.5.1
-	github.com/hpcloud/tail v1.0.0
-	github.com/jmoiron/sqlx v0.0.0-20181024163419-82935fac6c1a
-	github.com/karalabe/usb v0.0.0-20190819132248-550797b1cad8 // indirect
-	github.com/lib/pq v1.0.0
-	github.com/mattn/go-isatty v0.0.9 // indirect
-	github.com/mitchellh/go-homedir v1.1.0
-	github.com/onsi/ginkgo v1.7.0
-	github.com/onsi/gomega v1.4.3
-	github.com/pborman/uuid v1.2.0 // indirect
-	github.com/pressly/goose v2.6.0+incompatible
-	github.com/prometheus/tsdb v0.10.0 // indirect
-	github.com/rs/cors v1.7.0 // indirect
-	github.com/sirupsen/logrus v1.2.0
-	github.com/spf13/cobra v0.0.3
-	github.com/spf13/viper v1.3.2
-	github.com/steakknife/bloomfilter v0.0.0-20180922174646-6819c0d2a570 // indirect
-	github.com/steakknife/hamming v0.0.0-20180906055917-c99c65617cd3 // indirect
-	github.com/tyler-smith/go-bip39 v1.0.2 // indirect
-	golang.org/x/net v0.0.0-20190603091049-60506f45cf65
-	golang.org/x/sync v0.0.0-20190423024810-112230192c58
-	gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7
+	github.com/ethereum/go-ethereum v1.10.20
+	github.com/graph-gophers/graphql-go v1.3.0
+	github.com/ipfs/go-block-format v0.0.3
+	github.com/ipfs/go-cid v0.0.7
+	github.com/ipfs/go-ipfs-blockstore v1.0.1
+	github.com/ipfs/go-ipfs-ds-help v1.0.0
+	github.com/jmoiron/sqlx v1.3.5
+	github.com/joho/godotenv v1.4.0
+	github.com/lib/pq v1.10.6
+	github.com/machinebox/graphql v0.2.2
+	github.com/mailgun/groupcache/v2 v2.3.0
+	github.com/multiformats/go-multihash v0.1.0
+	github.com/onsi/ginkgo v1.16.5
+	github.com/onsi/gomega v1.19.0
+	github.com/prometheus/client_golang v1.11.0
+	github.com/sirupsen/logrus v1.8.1
+	github.com/spf13/cobra v1.4.0
+	github.com/spf13/viper v1.11.0
+	github.com/vulcanize/eth-ipfs-state-validator/v4 v4.0.3-alpha
+	github.com/vulcanize/gap-filler v0.4.0
+	github.com/vulcanize/ipfs-ethdb/v4 v4.0.2-alpha
+	gorm.io/driver/postgres v1.3.7
+	gorm.io/gorm v1.23.5
 )
+
+require (
+	bazil.org/fuse v0.0.0-20200117225306-7b5117fecadc // indirect
+	github.com/StackExchange/wmi v0.0.0-20180116203802-5d049714c4a6 // indirect
+	github.com/Stebalien/go-bitfield v0.0.1 // indirect
+	github.com/VictoriaMetrics/fastcache v1.6.0 // indirect
+	github.com/benbjohnson/clock v1.1.0 // indirect
+	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/blang/semver/v4 v4.0.0 // indirect
+	github.com/btcsuite/btcd v0.22.1 // indirect
+	github.com/btcsuite/btcd/btcec/v2 v2.2.0 // indirect
+	github.com/cenkalti/backoff v2.2.1+incompatible // indirect
+	github.com/cenkalti/backoff/v4 v4.1.1 // indirect
+	github.com/cespare/xxhash/v2 v2.1.1 // indirect
+	github.com/cheekybits/genny v1.0.0 // indirect
+	github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
+	github.com/crackcomm/go-gitignore v0.0.0-20170627025303-887ab5e44cc3 // indirect
+	github.com/cskr/pubsub v1.0.2 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/davidlazar/go-crypto v0.0.0-20200604182044-b73af7476f6c // indirect
+	github.com/deckarep/golang-set v1.8.0 // indirect
+	github.com/decred/dcrd/dcrec/secp256k1/v4 v4.0.1 // indirect
+	github.com/deepmap/oapi-codegen v1.8.2 // indirect
+	github.com/edsrzf/mmap-go v1.0.0 // indirect
+	github.com/facebookgo/atomicfile v0.0.0-20151019160806-2de1f203e7d5 // indirect
+	github.com/fjl/memsize v0.0.0-20190710130421-bcb5799ab5e5 // indirect
+	github.com/flynn/noise v1.0.0 // indirect
+	github.com/francoispqt/gojay v1.2.13 // indirect
+	github.com/friendsofgo/graphiql v0.2.2 // indirect
+	github.com/fsnotify/fsnotify v1.5.1 // indirect
+	github.com/gballet/go-libpcsclite v0.0.0-20190607065134-2772fd86a8ff // indirect
+	github.com/georgysavva/scany v0.2.9 // indirect
+	github.com/go-ole/go-ole v1.2.1 // indirect
+	github.com/go-stack/stack v1.8.0 // indirect
+	github.com/go-task/slim-sprig v0.0.0-20210107165309-348f09dbbbc0 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/golang-jwt/jwt/v4 v4.3.0 // indirect
+	github.com/golang/protobuf v1.5.2 // indirect
+	github.com/golang/snappy v0.0.4 // indirect
+	github.com/google/gopacket v1.1.19 // indirect
+	github.com/google/uuid v1.3.0 // indirect
+	github.com/gorilla/websocket v1.4.2 // indirect
+	github.com/graphql-go/graphql v0.7.9 // indirect
+	github.com/hannahhoward/go-pubsub v0.0.0-20200423002714-8d62886cc36e // indirect
+	github.com/hashicorp/errwrap v1.0.0 // indirect
+	github.com/hashicorp/go-bexpr v0.1.10 // indirect
+	github.com/hashicorp/go-multierror v1.1.1 // indirect
+	github.com/hashicorp/golang-lru v0.5.5-0.20210104140557-80c98217689d // indirect
+	github.com/hashicorp/hcl v1.0.0 // indirect
+	github.com/holiman/bloomfilter/v2 v2.0.3 // indirect
+	github.com/holiman/uint256 v1.2.0 // indirect
+	github.com/huin/goupnp v1.0.3 // indirect
+	github.com/inconshreveable/mousetrap v1.0.0 // indirect
+	github.com/influxdata/influxdb v1.8.3 // indirect
+	github.com/influxdata/influxdb-client-go/v2 v2.4.0 // indirect
+	github.com/influxdata/line-protocol v0.0.0-20210311194329-9aa0e372d097 // indirect
+	github.com/ipfs/bbloom v0.0.4 // indirect
+	github.com/ipfs/go-bitswap v0.4.0 // indirect
+	github.com/ipfs/go-blockservice v0.1.7 // indirect
+	github.com/ipfs/go-cidutil v0.0.2 // indirect
+	github.com/ipfs/go-datastore v0.4.6 // indirect
+	github.com/ipfs/go-ds-measure v0.1.0 // indirect
+	github.com/ipfs/go-fetcher v1.5.0 // indirect
+	github.com/ipfs/go-filestore v1.0.0 // indirect
+	github.com/ipfs/go-fs-lock v0.0.7 // indirect
+	github.com/ipfs/go-graphsync v0.8.0 // indirect
+	github.com/ipfs/go-ipfs v0.10.0 // indirect
+	github.com/ipfs/go-ipfs-chunker v0.0.5 // indirect
+	github.com/ipfs/go-ipfs-config v0.16.0 // indirect
+	github.com/ipfs/go-ipfs-delay v0.0.1 // indirect
+	github.com/ipfs/go-ipfs-exchange-interface v0.0.1 // indirect
+	github.com/ipfs/go-ipfs-exchange-offline v0.0.1 // indirect
+	github.com/ipfs/go-ipfs-files v0.0.8 // indirect
+	github.com/ipfs/go-ipfs-keystore v0.0.2 // indirect
+	github.com/ipfs/go-ipfs-pinner v0.1.2 // indirect
+	github.com/ipfs/go-ipfs-posinfo v0.0.1 // indirect
+	github.com/ipfs/go-ipfs-pq v0.0.2 // indirect
+	github.com/ipfs/go-ipfs-provider v0.6.1 // indirect
+	github.com/ipfs/go-ipfs-routing v0.1.0 // indirect
+	github.com/ipfs/go-ipfs-util v0.0.2 // indirect
+	github.com/ipfs/go-ipld-cbor v0.0.5 // indirect
+	github.com/ipfs/go-ipld-format v0.2.0 // indirect
+	github.com/ipfs/go-ipld-legacy v0.1.0 // indirect
+	github.com/ipfs/go-ipns v0.1.2 // indirect
+	github.com/ipfs/go-log v1.0.5 // indirect
+	github.com/ipfs/go-log/v2 v2.3.0 // indirect
+	github.com/ipfs/go-merkledag v0.4.0 // indirect
+	github.com/ipfs/go-metrics-interface v0.0.1 // indirect
+	github.com/ipfs/go-mfs v0.1.2 // indirect
+	github.com/ipfs/go-namesys v0.3.1 // indirect
+	github.com/ipfs/go-path v0.1.2 // indirect
+	github.com/ipfs/go-peertaskqueue v0.4.0 // indirect
+	github.com/ipfs/go-unixfs v0.2.5 // indirect
+	github.com/ipfs/go-unixfsnode v1.1.3 // indirect
+	github.com/ipfs/go-verifcid v0.0.1 // indirect
+	github.com/ipfs/interface-go-ipfs-core v0.5.1 // indirect
+	github.com/ipld/go-codec-dagpb v1.3.0 // indirect
+	github.com/ipld/go-ipld-prime v0.12.2 // indirect
+	github.com/jackc/chunkreader/v2 v2.0.1 // indirect
+	github.com/jackc/pgconn v1.12.1 // indirect
+	github.com/jackc/pgio v1.0.0 // indirect
+	github.com/jackc/pgpassfile v1.0.0 // indirect
+	github.com/jackc/pgproto3/v2 v2.3.0 // indirect
+	github.com/jackc/pgservicefile v0.0.0-20200714003250-2b9c44734f2b // indirect
+	github.com/jackc/pgtype v1.11.0 // indirect
+	github.com/jackc/pgx/v4 v4.16.1 // indirect
+	github.com/jackc/puddle v1.2.1 // indirect
+	github.com/jackpal/go-nat-pmp v1.0.2 // indirect
+	github.com/jbenet/go-temp-err-catcher v0.1.0 // indirect
+	github.com/jbenet/goprocess v0.1.4 // indirect
+	github.com/jinzhu/copier v0.2.4 // indirect
+	github.com/jinzhu/inflection v1.0.0 // indirect
+	github.com/jinzhu/now v1.1.4 // indirect
+	github.com/klauspost/compress v1.11.7 // indirect
+	github.com/klauspost/cpuid/v2 v2.0.9 // indirect
+	github.com/koron/go-ssdp v0.0.2 // indirect
+	github.com/libp2p/go-addr-util v0.1.0 // indirect
+	github.com/libp2p/go-buffer-pool v0.0.2 // indirect
+	github.com/libp2p/go-cidranger v1.1.0 // indirect
+	github.com/libp2p/go-conn-security-multistream v0.2.1 // indirect
+	github.com/libp2p/go-doh-resolver v0.3.1 // indirect
+	github.com/libp2p/go-eventbus v0.2.1 // indirect
+	github.com/libp2p/go-flow-metrics v0.0.3 // indirect
+	github.com/libp2p/go-libp2p v0.15.0 // indirect
+	github.com/libp2p/go-libp2p-asn-util v0.0.0-20200825225859-85005c6cf052 // indirect
+	github.com/libp2p/go-libp2p-autonat v0.4.2 // indirect
+	github.com/libp2p/go-libp2p-blankhost v0.2.0 // indirect
+	github.com/libp2p/go-libp2p-circuit v0.4.0 // indirect
+	github.com/libp2p/go-libp2p-connmgr v0.2.4 // indirect
+	github.com/libp2p/go-libp2p-core v0.9.0 // indirect
+	github.com/libp2p/go-libp2p-discovery v0.5.1 // indirect
+	github.com/libp2p/go-libp2p-kad-dht v0.13.1 // indirect
+	github.com/libp2p/go-libp2p-kbucket v0.4.7 // indirect
+	github.com/libp2p/go-libp2p-loggables v0.1.0 // indirect
+	github.com/libp2p/go-libp2p-mplex v0.4.1 // indirect
+	github.com/libp2p/go-libp2p-nat v0.0.6 // indirect
+	github.com/libp2p/go-libp2p-noise v0.2.2 // indirect
+	github.com/libp2p/go-libp2p-peerstore v0.2.8 // indirect
+	github.com/libp2p/go-libp2p-pnet v0.2.0 // indirect
+	github.com/libp2p/go-libp2p-pubsub v0.5.4 // indirect
+	github.com/libp2p/go-libp2p-pubsub-router v0.4.0 // indirect
+	github.com/libp2p/go-libp2p-quic-transport v0.12.0 // indirect
+	github.com/libp2p/go-libp2p-record v0.1.3 // indirect
+	github.com/libp2p/go-libp2p-routing-helpers v0.2.3 // indirect
+	github.com/libp2p/go-libp2p-swarm v0.5.3 // indirect
+	github.com/libp2p/go-libp2p-tls v0.2.0 // indirect
+	github.com/libp2p/go-libp2p-transport-upgrader v0.4.6 // indirect
+	github.com/libp2p/go-libp2p-xor v0.0.0-20210714161855-5c005aca55db // indirect
+	github.com/libp2p/go-libp2p-yamux v0.5.4 // indirect
+	github.com/libp2p/go-maddr-filter v0.1.0 // indirect
+	github.com/libp2p/go-mplex v0.3.0 // indirect
+	github.com/libp2p/go-msgio v0.0.6 // indirect
+	github.com/libp2p/go-nat v0.0.5 // indirect
+	github.com/libp2p/go-netroute v0.1.6 // indirect
+	github.com/libp2p/go-openssl v0.0.7 // indirect
+	github.com/libp2p/go-reuseport v0.0.2 // indirect
+	github.com/libp2p/go-reuseport-transport v0.0.5 // indirect
+	github.com/libp2p/go-sockaddr v0.1.1 // indirect
+	github.com/libp2p/go-stream-muxer-multistream v0.3.0 // indirect
+	github.com/libp2p/go-tcp-transport v0.2.8 // indirect
+	github.com/libp2p/go-ws-transport v0.5.0 // indirect
+	github.com/libp2p/go-yamux/v2 v2.2.0 // indirect
+	github.com/libp2p/zeroconf/v2 v2.0.0 // indirect
+	github.com/lucas-clemente/quic-go v0.26.0 // indirect
+	github.com/magiconair/properties v1.8.6 // indirect
+	github.com/marten-seemann/qtls-go1-16 v0.1.5 // indirect
+	github.com/marten-seemann/qtls-go1-17 v0.1.1 // indirect
+	github.com/marten-seemann/qtls-go1-18 v0.1.1 // indirect
+	github.com/marten-seemann/tcp v0.0.0-20210406111302-dfbc87cc63fd // indirect
+	github.com/matryer/is v1.4.0 // indirect
+	github.com/mattn/go-colorable v0.1.12 // indirect
+	github.com/mattn/go-isatty v0.0.14 // indirect
+	github.com/mattn/go-runewidth v0.0.9 // indirect
+	github.com/mattn/go-sqlite3 v2.0.3+incompatible // indirect
+	github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect
+	github.com/miekg/dns v1.1.43 // indirect
+	github.com/mikioh/tcpinfo v0.0.0-20190314235526-30a79bb1804b // indirect
+	github.com/mikioh/tcpopt v0.0.0-20190314235656-172688c1accc // indirect
+	github.com/minio/blake2b-simd v0.0.0-20160723061019-3f5f724cb5b1 // indirect
+	github.com/minio/sha256-simd v1.0.0 // indirect
+	github.com/mitchellh/go-homedir v1.1.0 // indirect
+	github.com/mitchellh/mapstructure v1.4.3 // indirect
+	github.com/mitchellh/pointerstructure v1.2.0 // indirect
+	github.com/mr-tron/base58 v1.2.0 // indirect
+	github.com/multiformats/go-base32 v0.0.3 // indirect
+	github.com/multiformats/go-base36 v0.1.0 // indirect
+	github.com/multiformats/go-multiaddr v0.4.0 // indirect
+	github.com/multiformats/go-multiaddr-dns v0.3.1 // indirect
+	github.com/multiformats/go-multiaddr-fmt v0.1.0 // indirect
+	github.com/multiformats/go-multibase v0.0.3 // indirect
+	github.com/multiformats/go-multicodec v0.3.0 // indirect
+	github.com/multiformats/go-multistream v0.2.2 // indirect
+	github.com/multiformats/go-varint v0.0.6 // indirect
+	github.com/nxadm/tail v1.4.8 // indirect
+	github.com/olekukonko/tablewriter v0.0.5 // indirect
+	github.com/opentracing/opentracing-go v1.2.0 // indirect
+	github.com/pelletier/go-toml v1.9.4 // indirect
+	github.com/pelletier/go-toml/v2 v2.0.0-beta.8 // indirect
+	github.com/peterh/liner v1.1.1-0.20190123174540-a2c9a5303de7 // indirect
+	github.com/pganalyze/pg_query_go/v2 v2.1.0 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/polydawn/refmt v0.0.0-20201211092308-30ac6d18308e // indirect
+	github.com/prometheus/client_model v0.2.0 // indirect
+	github.com/prometheus/common v0.30.0 // indirect
+	github.com/prometheus/procfs v0.7.3 // indirect
+	github.com/prometheus/tsdb v0.7.1 // indirect
+	github.com/rjeczalik/notify v0.9.1 // indirect
+	github.com/rs/cors v1.7.0 // indirect
+	github.com/russross/blackfriday/v2 v2.1.0 // indirect
+	github.com/segmentio/fasthash v1.0.3 // indirect
+	github.com/shirou/gopsutil v3.21.4-0.20210419000835-c7a38de76ee5+incompatible // indirect
+	github.com/spacemonkeygo/spacelog v0.0.0-20180420211403-2296661a0572 // indirect
+	github.com/spaolacci/murmur3 v1.1.0 // indirect
+	github.com/spf13/afero v1.8.2 // indirect
+	github.com/spf13/cast v1.4.1 // indirect
+	github.com/spf13/jwalterweatherman v1.1.0 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/status-im/keycard-go v0.0.0-20190316090335-8537d3370df4 // indirect
+	github.com/stretchr/objx v0.2.0 // indirect
+	github.com/stretchr/testify v1.7.2 // indirect
+	github.com/subosito/gotenv v1.2.0 // indirect
+	github.com/syndtr/goleveldb v1.0.1-0.20210819022825-2ae1ddf74ef7 // indirect
+	github.com/thoas/go-funk v0.9.2 // indirect
+	github.com/tklauser/go-sysconf v0.3.5 // indirect
+	github.com/tklauser/numcpus v0.2.2 // indirect
+	github.com/tyler-smith/go-bip39 v1.0.1-0.20181017060643-dbb3b84ba2ef // indirect
+	github.com/urfave/cli/v2 v2.10.2 // indirect
+	github.com/valyala/fastjson v1.6.3 // indirect
+	github.com/whyrusleeping/base32 v0.0.0-20170828182744-c30ac30633cc // indirect
+	github.com/whyrusleeping/cbor-gen v0.0.0-20210219115102-f37d292932f2 // indirect
+	github.com/whyrusleeping/chunker v0.0.0-20181014151217-fe64bd25879f // indirect
+	github.com/whyrusleeping/go-keyspace v0.0.0-20160322163242-5b898ac5add1 // indirect
+	github.com/whyrusleeping/mdns v0.0.0-20190826153040-b9b60ed33aa9 // indirect
+	github.com/whyrusleeping/multiaddr-filter v0.0.0-20160516205228-e903e4adabd7 // indirect
+	github.com/whyrusleeping/timecache v0.0.0-20160911033111-cfcb2f1abfee // indirect
+	github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect
+	go.opencensus.io v0.23.0 // indirect
+	go.opentelemetry.io/otel v0.20.0 // indirect
+	go.opentelemetry.io/otel/metric v0.20.0 // indirect
+	go.opentelemetry.io/otel/trace v0.20.0 // indirect
+	go.uber.org/atomic v1.9.0 // indirect
+	go.uber.org/dig v1.10.0 // indirect
+	go.uber.org/fx v1.13.1 // indirect
+	go.uber.org/multierr v1.7.0 // indirect
+	go.uber.org/zap v1.19.0 // indirect
+	go4.org v0.0.0-20200411211856-f5505b9728dd // indirect
+	golang.org/x/crypto v0.0.0-20220525230936-793ad666bf5e // indirect
+	golang.org/x/mod v0.6.0-dev.0.20211013180041-c96bc1413d57 // indirect
+	golang.org/x/net v0.0.0-20220607020251-c690dde0001d // indirect
+	golang.org/x/sync v0.0.0-20210220032951-036812b2e83c // indirect
+	golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a // indirect
+	golang.org/x/text v0.3.7 // indirect
+	golang.org/x/time v0.0.0-20210220033141-f8bda1e9f3ba // indirect
+	golang.org/x/tools v0.1.8-0.20211029000441-d6a9af8af023 // indirect
+	golang.org/x/xerrors v0.0.0-20220517211312-f3a8303e98df // indirect
+	google.golang.org/protobuf v1.28.0 // indirect
+	gopkg.in/ini.v1 v1.66.4 // indirect
+	gopkg.in/natefinch/npipe.v2 v2.0.0-20160621034901-c1b8fa8bdcce // indirect
+	gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+	lukechampine.com/blake3 v1.1.6 // indirect
+)
+
+replace github.com/ethereum/go-ethereum v1.10.20 => github.com/vulcanize/go-ethereum v1.10.20-statediff-4.1.0-alpha

integration_test/block_rewards_test.go

@@ -1,62 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package integration
-
-import (
-	"github.com/ethereum/go-ethereum/ethclient"
-	"github.com/ethereum/go-ethereum/rpc"
-	. "github.com/onsi/ginkgo"
-	. "github.com/onsi/gomega"
-
-	"github.com/vulcanize/vulcanizedb/pkg/geth"
-	"github.com/vulcanize/vulcanizedb/pkg/geth/client"
-	vRpc "github.com/vulcanize/vulcanizedb/pkg/geth/converters/rpc"
-	"github.com/vulcanize/vulcanizedb/pkg/geth/node"
-	"github.com/vulcanize/vulcanizedb/test_config"
-)
-
-var _ = Describe("Rewards calculations", func() {
-
-	It("calculates a block reward for a real block", func() {
-		rawRpcClient, err := rpc.Dial(test_config.InfuraClient.IPCPath)
-		Expect(err).NotTo(HaveOccurred())
-		rpcClient := client.NewRpcClient(rawRpcClient, test_config.InfuraClient.IPCPath)
-		ethClient := ethclient.NewClient(rawRpcClient)
-		blockChainClient := client.NewEthClient(ethClient)
-		node := node.MakeNode(rpcClient)
-		transactionConverter := vRpc.NewRpcTransactionConverter(ethClient)
-		blockChain := geth.NewBlockChain(blockChainClient, rpcClient, node, transactionConverter)
-		block, err := blockChain.GetBlockByNumber(1071819)
-		Expect(err).ToNot(HaveOccurred())
-		Expect(block.Reward).To(Equal("5313550000000000000"))
-	})
-
-	It("calculates an uncle reward for a real block", func() {
-		rawRpcClient, err := rpc.Dial(test_config.InfuraClient.IPCPath)
-		Expect(err).NotTo(HaveOccurred())
-		rpcClient := client.NewRpcClient(rawRpcClient, test_config.InfuraClient.IPCPath)
-		ethClient := ethclient.NewClient(rawRpcClient)
-		blockChainClient := client.NewEthClient(ethClient)
-		node := node.MakeNode(rpcClient)
-		transactionConverter := vRpc.NewRpcTransactionConverter(ethClient)
-		blockChain := geth.NewBlockChain(blockChainClient, rpcClient, node, transactionConverter)
-		block, err := blockChain.GetBlockByNumber(1071819)
-		Expect(err).ToNot(HaveOccurred())
-		Expect(block.UnclesReward).To(Equal("6875000000000000000"))
-	})
-
-})

integration_test/contract_test.go

@@ -1,110 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package integration
-
-import (
-	"math/big"
-
-	"github.com/ethereum/go-ethereum/common"
-	"github.com/ethereum/go-ethereum/ethclient"
-	"github.com/ethereum/go-ethereum/rpc"
-	. "github.com/onsi/ginkgo"
-	. "github.com/onsi/gomega"
-
-	"github.com/vulcanize/vulcanizedb/pkg/core"
-	"github.com/vulcanize/vulcanizedb/pkg/geth"
-	"github.com/vulcanize/vulcanizedb/pkg/geth/client"
-	rpc2 "github.com/vulcanize/vulcanizedb/pkg/geth/converters/rpc"
-	"github.com/vulcanize/vulcanizedb/pkg/geth/node"
-	"github.com/vulcanize/vulcanizedb/pkg/geth/testing"
-	"github.com/vulcanize/vulcanizedb/test_config"
-)
-
-var _ = Describe("Reading contracts", func() {
-
-	Describe("Getting a contract attribute", func() {
-		It("retrieves the event log for a specific block and contract", func() {
-			expectedLogZero := core.Log{
-				BlockNumber: 4703824,
-				TxHash:      "0xf896bfd1eb539d881a1a31102b78de9f25cd591bf1fe1924b86148c0b205fd5d",
-				Address:     "0xd26114cd6ee289accf82350c8d8487fedb8a0c07",
-				Topics: core.Topics{
-					0: "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
-					1: "0x000000000000000000000000fbb1b73c4f0bda4f67dca266ce6ef42f520fbb98",
-					2: "0x000000000000000000000000d26114cd6ee289accf82350c8d8487fedb8a0c07",
-				},
-				Index: 19,
-				Data:  "0x0000000000000000000000000000000000000000000000000c7d713b49da0000"}
-			rawRpcClient, err := rpc.Dial(test_config.InfuraClient.IPCPath)
-			Expect(err).NotTo(HaveOccurred())
-			rpcClient := client.NewRpcClient(rawRpcClient, test_config.InfuraClient.IPCPath)
-			ethClient := ethclient.NewClient(rawRpcClient)
-			blockChainClient := client.NewEthClient(ethClient)
-			node := node.MakeNode(rpcClient)
-			transactionConverter := rpc2.NewRpcTransactionConverter(ethClient)
-			blockChain := geth.NewBlockChain(blockChainClient, rpcClient, node, transactionConverter)
-			contract := testing.SampleContract()
-
-			logs, err := blockChain.GetLogs(contract, big.NewInt(4703824), nil)
-
-			Expect(err).To(BeNil())
-			Expect(len(logs)).To(Equal(3))
-			Expect(logs[0]).To(Equal(expectedLogZero))
-		})
-
-		It("returns and empty log array when no events for a given block / contract combo", func() {
-			rawRpcClient, err := rpc.Dial(test_config.InfuraClient.IPCPath)
-			Expect(err).NotTo(HaveOccurred())
-			rpcClient := client.NewRpcClient(rawRpcClient, test_config.InfuraClient.IPCPath)
-			ethClient := ethclient.NewClient(rawRpcClient)
-			blockChainClient := client.NewEthClient(ethClient)
-			node := node.MakeNode(rpcClient)
-			transactionConverter := rpc2.NewRpcTransactionConverter(ethClient)
-			blockChain := geth.NewBlockChain(blockChainClient, rpcClient, node, transactionConverter)
-
-			logs, err := blockChain.GetLogs(core.Contract{Hash: "0x123"}, big.NewInt(4703824), nil)
-
-			Expect(err).To(BeNil())
-			Expect(len(logs)).To(Equal(0))
-		})
-	})
-
-	Describe("Fetching Contract data", func() {
-		It("returns the correct attribute for a real contract", func() {
-			rawRpcClient, err := rpc.Dial(test_config.InfuraClient.IPCPath)
-			Expect(err).NotTo(HaveOccurred())
-			rpcClient := client.NewRpcClient(rawRpcClient, test_config.InfuraClient.IPCPath)
-			ethClient := ethclient.NewClient(rawRpcClient)
-			blockChainClient := client.NewEthClient(ethClient)
-			node := node.MakeNode(rpcClient)
-			transactionConverter := rpc2.NewRpcTransactionConverter(ethClient)
-			blockChain := geth.NewBlockChain(blockChainClient, rpcClient, node, transactionConverter)
-
-			contract := testing.SampleContract()
-			var balance = new(big.Int)
-
-			args := make([]interface{}, 1)
-			args[0] = common.HexToHash("0xd26114cd6ee289accf82350c8d8487fedb8a0c07")
-
-			err = blockChain.FetchContractData(contract.Abi, "0xd26114cd6ee289accf82350c8d8487fedb8a0c07", "balanceOf", args, &balance, 5167471)
-			Expect(err).NotTo(HaveOccurred())
-			expected := new(big.Int)
-			expected.SetString("10897295492887612977137", 10)
-			Expect(balance).To(Equal(expected))
-		})
-	})
-})

integration_test/contract_watcher_full_transformer_test.go

@@ -1,338 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package integration
-
-import (
-	"fmt"
-	"github.com/vulcanize/vulcanizedb/pkg/config"
-	"math/rand"
-	"strings"
-	"time"
-
-	"github.com/ethereum/go-ethereum/common"
-	. "github.com/onsi/ginkgo"
-	. "github.com/onsi/gomega"
-
-	"github.com/vulcanize/vulcanizedb/pkg/contract_watcher/full/transformer"
-	"github.com/vulcanize/vulcanizedb/pkg/contract_watcher/shared/constants"
-	"github.com/vulcanize/vulcanizedb/pkg/contract_watcher/shared/helpers/test_helpers"
-	"github.com/vulcanize/vulcanizedb/pkg/contract_watcher/shared/helpers/test_helpers/mocks"
-	"github.com/vulcanize/vulcanizedb/pkg/core"
-	"github.com/vulcanize/vulcanizedb/pkg/datastore/postgres"
-	"github.com/vulcanize/vulcanizedb/pkg/datastore/postgres/repositories"
-)
-
-var _ = Describe("contractWatcher full transformer", func() {
-	var db *postgres.DB
-	var err error
-	var blockChain core.BlockChain
-	var blockRepository repositories.BlockRepository
-	var ensAddr = strings.ToLower(constants.EnsContractAddress)
-	var tusdAddr = strings.ToLower(constants.TusdContractAddress)
-	rand.Seed(time.Now().UnixNano())
-
-	BeforeEach(func() {
-		db, blockChain = test_helpers.SetupDBandBC()
-		blockRepository = *repositories.NewBlockRepository(db)
-	})
-
-	AfterEach(func() {
-		test_helpers.TearDown(db)
-	})
-
-	Describe("Init", func() {
-		It("Initializes transformer's contract objects", func() {
-			_, insertErr := blockRepository.CreateOrUpdateBlock(mocks.TransferBlock1)
-			Expect(insertErr).NotTo(HaveOccurred())
-			_, insertErrTwo := blockRepository.CreateOrUpdateBlock(mocks.TransferBlock2)
-			Expect(insertErrTwo).NotTo(HaveOccurred())
-			t := transformer.NewTransformer(test_helpers.TusdConfig, blockChain, db)
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-
-			c, ok := t.Contracts[tusdAddr]
-			Expect(ok).To(Equal(true))
-
-			Expect(c.StartingBlock).To(Equal(int64(6194633)))
-			Expect(c.Abi).To(Equal(constants.TusdAbiString))
-			Expect(c.Name).To(Equal("TrueUSD"))
-			Expect(c.Address).To(Equal(tusdAddr))
-		})
-
-		It("Fails to initialize if first and most recent blocks cannot be fetched from vDB", func() {
-			t := transformer.NewTransformer(test_helpers.TusdConfig, blockChain, db)
-			err = t.Init()
-			Expect(err).To(HaveOccurred())
-			Expect(err.Error()).To(ContainSubstring("no rows in result set"))
-		})
-
-		It("Does nothing if watched events are unset", func() {
-			_, insertErr := blockRepository.CreateOrUpdateBlock(mocks.TransferBlock1)
-			Expect(insertErr).NotTo(HaveOccurred())
-			_, insertErrTwo := blockRepository.CreateOrUpdateBlock(mocks.TransferBlock2)
-			Expect(insertErrTwo).NotTo(HaveOccurred())
-			var testConf config.ContractConfig
-			testConf = test_helpers.TusdConfig
-			testConf.Events = nil
-			t := transformer.NewTransformer(testConf, blockChain, db)
-			err = t.Init()
-			Expect(err).To(HaveOccurred())
-			Expect(err.Error()).To(ContainSubstring("no filters created"))
-
-			_, ok := t.Contracts[tusdAddr]
-			Expect(ok).To(Equal(false))
-		})
-	})
-
-	Describe("Execute", func() {
-		BeforeEach(func() {
-			_, insertErr := blockRepository.CreateOrUpdateBlock(mocks.TransferBlock1)
-			Expect(insertErr).NotTo(HaveOccurred())
-			_, insertErrTwo := blockRepository.CreateOrUpdateBlock(mocks.TransferBlock2)
-			Expect(insertErrTwo).NotTo(HaveOccurred())
-		})
-
-		It("Transforms watched contract data into custom repositories", func() {
-			t := transformer.NewTransformer(test_helpers.TusdConfig, blockChain, db)
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-
-			err = t.Execute()
-			Expect(err).ToNot(HaveOccurred())
-
-			log := test_helpers.TransferLog{}
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM full_%s.transfer_event WHERE block = 6194634", tusdAddr)).StructScan(&log)
-
-			// We don't know vulcID, so compare individual fields instead of complete structures
-			Expect(log.Tx).To(Equal("0x135391a0962a63944e5908e6fedfff90fb4be3e3290a21017861099bad654eee"))
-			Expect(log.Block).To(Equal(int64(6194634)))
-			Expect(log.From).To(Equal("0x000000000000000000000000000000000000Af21"))
-			Expect(log.To).To(Equal("0x09BbBBE21a5975cAc061D82f7b843bCE061BA391"))
-			Expect(log.Value).To(Equal("1097077688018008265106216665536940668749033598146"))
-		})
-
-		It("Keeps track of contract-related addresses while transforming event data if they need to be used for later method polling", func() {
-			var testConf config.ContractConfig
-			testConf = test_helpers.TusdConfig
-			testConf.Methods = map[string][]string{
-				tusdAddr: {"balanceOf"},
-			}
-			t := transformer.NewTransformer(testConf, blockChain, db)
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-
-			c, ok := t.Contracts[tusdAddr]
-			Expect(ok).To(Equal(true))
-
-			err = t.Execute()
-			Expect(err).ToNot(HaveOccurred())
-
-			b, ok := c.EmittedAddrs[common.HexToAddress("0x000000000000000000000000000000000000Af21")]
-			Expect(ok).To(Equal(true))
-			Expect(b).To(Equal(true))
-
-			b, ok = c.EmittedAddrs[common.HexToAddress("0x09BbBBE21a5975cAc061D82f7b843bCE061BA391")]
-			Expect(ok).To(Equal(true))
-			Expect(b).To(Equal(true))
-
-			_, ok = c.EmittedAddrs[common.HexToAddress("0x09BbBBE21a5975cAc061D82f7b843b1234567890")]
-			Expect(ok).To(Equal(false))
-
-			_, ok = c.EmittedAddrs[common.HexToAddress("0x")]
-			Expect(ok).To(Equal(false))
-
-			_, ok = c.EmittedAddrs[""]
-			Expect(ok).To(Equal(false))
-
-			_, ok = c.EmittedAddrs[common.HexToAddress("0x09THISE21a5IS5cFAKE1D82fAND43bCE06MADEUP")]
-			Expect(ok).To(Equal(false))
-		})
-
-		It("Polls given methods using generated token holder address", func() {
-			var testConf config.ContractConfig
-			testConf = test_helpers.TusdConfig
-			testConf.Methods = map[string][]string{
-				tusdAddr: {"balanceOf"},
-			}
-			t := transformer.NewTransformer(testConf, blockChain, db)
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-
-			err = t.Execute()
-			Expect(err).ToNot(HaveOccurred())
-
-			res := test_helpers.BalanceOf{}
-
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM full_%s.balanceof_method WHERE who_ = '0x000000000000000000000000000000000000Af21' AND block = '6194634'", tusdAddr)).StructScan(&res)
-			Expect(err).ToNot(HaveOccurred())
-			Expect(res.Balance).To(Equal("0"))
-			Expect(res.TokenName).To(Equal("TrueUSD"))
-
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM full_%s.balanceof_method WHERE who_ = '0x09BbBBE21a5975cAc061D82f7b843bCE061BA391' AND block = '6194634'", tusdAddr)).StructScan(&res)
-			Expect(err).ToNot(HaveOccurred())
-			Expect(res.Balance).To(Equal("0"))
-			Expect(res.TokenName).To(Equal("TrueUSD"))
-
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM full_%s.balanceof_method WHERE who_ = '0xfE9e8709d3215310075d67E3ed32A380CCf451C8' AND block = '6194634'", tusdAddr)).StructScan(&res)
-			Expect(err).To(HaveOccurred())
-			Expect(err.Error()).To(ContainSubstring("no rows in result set"))
-		})
-
-		It("Fails if initialization has not been done", func() {
-			t := transformer.NewTransformer(test_helpers.TusdConfig, blockChain, db)
-
-			err = t.Execute()
-			Expect(err).To(HaveOccurred())
-			Expect(err.Error()).To(ContainSubstring("transformer has no initialized contracts to work with"))
-		})
-	})
-
-	Describe("Execute- against ENS registry contract", func() {
-		BeforeEach(func() {
-			_, insertErr := blockRepository.CreateOrUpdateBlock(mocks.NewOwnerBlock1)
-			Expect(insertErr).NotTo(HaveOccurred())
-			_, insertErrTwo := blockRepository.CreateOrUpdateBlock(mocks.NewOwnerBlock2)
-			Expect(insertErrTwo).NotTo(HaveOccurred())
-		})
-
-		It("Transforms watched contract data into custom repositories", func() {
-			t := transformer.NewTransformer(test_helpers.ENSConfig, blockChain, db)
-
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-
-			err = t.Execute()
-			Expect(err).ToNot(HaveOccurred())
-
-			log := test_helpers.NewOwnerLog{}
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM full_%s.newowner_event", ensAddr)).StructScan(&log)
-
-			// We don't know vulcID, so compare individual fields instead of complete structures
-			Expect(log.Tx).To(Equal("0x135391a0962a63944e5908e6fedfff90fb4be3e3290a21017861099bad654bbb"))
-			Expect(log.Block).To(Equal(int64(6194635)))
-			Expect(log.Node).To(Equal("0x0000000000000000000000000000000000000000000000000000c02aaa39b223"))
-			Expect(log.Label).To(Equal("0x9dd48110dcc444fdc242510c09bbbbe21a5975cac061d82f7b843bce061ba391"))
-			Expect(log.Owner).To(Equal("0x000000000000000000000000000000000000Af21"))
-		})
-
-		It("Keeps track of contract-related hashes while transforming event data if they need to be used for later method polling", func() {
-			var testConf config.ContractConfig
-			testConf = test_helpers.ENSConfig
-			testConf.Methods = map[string][]string{
-				ensAddr: {"owner"},
-			}
-			t := transformer.NewTransformer(testConf, blockChain, db)
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-
-			c, ok := t.Contracts[ensAddr]
-			Expect(ok).To(Equal(true))
-
-			err = t.Execute()
-			Expect(err).ToNot(HaveOccurred())
-			Expect(len(c.EmittedHashes)).To(Equal(3))
-
-			b, ok := c.EmittedHashes[common.HexToHash("0x0000000000000000000000000000000000000000000000000000c02aaa39b223")]
-			Expect(ok).To(Equal(true))
-			Expect(b).To(Equal(true))
-
-			b, ok = c.EmittedHashes[common.HexToHash("0x9dd48110dcc444fdc242510c09bbbbe21a5975cac061d82f7b843bce061ba391")]
-			Expect(ok).To(Equal(true))
-			Expect(b).To(Equal(true))
-
-			// Doesn't keep track of address since it wouldn't be used in calling the 'owner' method
-			_, ok = c.EmittedAddrs[common.HexToAddress("0x000000000000000000000000000000000000Af21")]
-			Expect(ok).To(Equal(false))
-		})
-
-		It("Polls given methods using generated token holder address", func() {
-			var testConf config.ContractConfig
-			testConf = test_helpers.ENSConfig
-			testConf.Methods = map[string][]string{
-				ensAddr: {"owner"},
-			}
-			t := transformer.NewTransformer(testConf, blockChain, db)
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-
-			err = t.Execute()
-			Expect(err).ToNot(HaveOccurred())
-
-			res := test_helpers.Owner{}
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM full_%s.owner_method WHERE node_ = '0x0000000000000000000000000000000000000000000000000000c02aaa39b223' AND block = '6194636'", ensAddr)).StructScan(&res)
-			Expect(err).ToNot(HaveOccurred())
-			Expect(res.Address).To(Equal("0x0000000000000000000000000000000000000000"))
-			Expect(res.TokenName).To(Equal(""))
-
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM full_%s.owner_method WHERE node_ = '0x9dd48110dcc444fdc242510c09bbbbe21a5975cac061d82f7b843bce061ba391' AND block = '6194636'", ensAddr)).StructScan(&res)
-			Expect(err).ToNot(HaveOccurred())
-			Expect(res.Address).To(Equal("0x0000000000000000000000000000000000000000"))
-			Expect(res.TokenName).To(Equal(""))
-
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM full_%s.owner_method WHERE node_ = '0x9THIS110dcc444fIS242510c09bbAbe21aFAKEcacNODE82f7b843HASH61ba391' AND block = '6194636'", ensAddr)).StructScan(&res)
-			Expect(err).To(HaveOccurred())
-			Expect(err.Error()).To(ContainSubstring("no rows in result set"))
-		})
-
-		It("It does not perist events if they do not pass the emitted arg filter", func() {
-			var testConf config.ContractConfig
-			testConf = test_helpers.ENSConfig
-			testConf.EventArgs = map[string][]string{
-				ensAddr: {"fake_filter_value"},
-			}
-			t := transformer.NewTransformer(testConf, blockChain, db)
-
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-
-			err = t.Execute()
-			Expect(err).ToNot(HaveOccurred())
-
-			log := test_helpers.HeaderSyncNewOwnerLog{}
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM full_%s.newowner_event", ensAddr)).StructScan(&log)
-			Expect(err).To(HaveOccurred())
-			Expect(err.Error()).To(ContainSubstring("does not exist"))
-		})
-
-		It("If a method arg filter is applied, only those arguments are used in polling", func() {
-			var testConf config.ContractConfig
-			testConf = test_helpers.ENSConfig
-			testConf.MethodArgs = map[string][]string{
-				ensAddr: {"0x0000000000000000000000000000000000000000000000000000c02aaa39b223"},
-			}
-			testConf.Methods = map[string][]string{
-				ensAddr: {"owner"},
-			}
-			t := transformer.NewTransformer(testConf, blockChain, db)
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-
-			err = t.Execute()
-			Expect(err).ToNot(HaveOccurred())
-
-			res := test_helpers.Owner{}
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM full_%s.owner_method WHERE node_ = '0x0000000000000000000000000000000000000000000000000000c02aaa39b223' AND block = '6194636'", ensAddr)).StructScan(&res)
-			Expect(err).ToNot(HaveOccurred())
-			Expect(res.Address).To(Equal("0x0000000000000000000000000000000000000000"))
-			Expect(res.TokenName).To(Equal(""))
-
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM full_%s.owner_method WHERE node_ = '0x9dd48110dcc444fdc242510c09bbbbe21a5975cac061d82f7b843bce061ba391' AND block = '6194636'", ensAddr)).StructScan(&res)
-			Expect(err).To(HaveOccurred())
-			Expect(err.Error()).To(ContainSubstring("no rows in result set"))
-		})
-	})
-})

integration_test/contract_watcher_header_sync_transformer_test.go

@@ -1,461 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package integration
-
-import (
-	"fmt"
-	"strings"
-
-	"github.com/ethereum/go-ethereum/common"
-	. "github.com/onsi/ginkgo"
-	. "github.com/onsi/gomega"
-
-	"github.com/vulcanize/vulcanizedb/pkg/config"
-	"github.com/vulcanize/vulcanizedb/pkg/contract_watcher/header/transformer"
-	"github.com/vulcanize/vulcanizedb/pkg/contract_watcher/shared/constants"
-	"github.com/vulcanize/vulcanizedb/pkg/contract_watcher/shared/helpers/test_helpers"
-	"github.com/vulcanize/vulcanizedb/pkg/contract_watcher/shared/helpers/test_helpers/mocks"
-	"github.com/vulcanize/vulcanizedb/pkg/core"
-	"github.com/vulcanize/vulcanizedb/pkg/datastore/postgres"
-	"github.com/vulcanize/vulcanizedb/pkg/datastore/postgres/repositories"
-)
-
-var _ = Describe("contractWatcher headerSync transformer", func() {
-	var db *postgres.DB
-	var err error
-	var blockChain core.BlockChain
-	var headerRepository repositories.HeaderRepository
-	var headerID int64
-	var ensAddr = strings.ToLower(constants.EnsContractAddress)
-	var tusdAddr = strings.ToLower(constants.TusdContractAddress)
-
-	BeforeEach(func() {
-		db, blockChain = test_helpers.SetupDBandBC()
-		headerRepository = repositories.NewHeaderRepository(db)
-	})
-
-	AfterEach(func() {
-		test_helpers.TearDown(db)
-	})
-
-	Describe("Init", func() {
-		It("Initializes transformer's contract objects", func() {
-			_, insertErr := headerRepository.CreateOrUpdateHeader(mocks.MockHeader1)
-			Expect(insertErr).NotTo(HaveOccurred())
-			_, insertErrTwo := headerRepository.CreateOrUpdateHeader(mocks.MockHeader3)
-			Expect(insertErrTwo).NotTo(HaveOccurred())
-			t := transformer.NewTransformer(test_helpers.TusdConfig, blockChain, db)
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-
-			c, ok := t.Contracts[tusdAddr]
-			Expect(ok).To(Equal(true))
-
-			// TODO: Fix this
-			// This test sometimes randomly fails because
-			// for some reason the starting block number is not updated from
-			// its original value (5197514) to the block number (6194632)
-			// of the earliest header (mocks.MockHeader1) in the repository
-			// It is not clear how this happens without one of the above insertErrs
-			// having been thrown and without any errors thrown during the Init() call
-			Expect(c.StartingBlock).To(Equal(int64(6194632)))
-			Expect(c.Abi).To(Equal(constants.TusdAbiString))
-			Expect(c.Name).To(Equal("TrueUSD"))
-			Expect(c.Address).To(Equal(tusdAddr))
-		})
-
-		It("Fails to initialize if first and block cannot be fetched from vDB headers table", func() {
-			t := transformer.NewTransformer(test_helpers.TusdConfig, blockChain, db)
-			err = t.Init()
-			Expect(err).To(HaveOccurred())
-			Expect(err.Error()).To(ContainSubstring("no rows in result set"))
-		})
-
-		It("Does nothing if nothing if no addresses are configured", func() {
-			_, insertErr := headerRepository.CreateOrUpdateHeader(mocks.MockHeader1)
-			Expect(insertErr).NotTo(HaveOccurred())
-			_, insertErrTwo := headerRepository.CreateOrUpdateHeader(mocks.MockHeader3)
-			Expect(insertErrTwo).NotTo(HaveOccurred())
-			var testConf config.ContractConfig
-			testConf = test_helpers.TusdConfig
-			testConf.Addresses = nil
-			t := transformer.NewTransformer(testConf, blockChain, db)
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-
-			_, ok := t.Contracts[tusdAddr]
-			Expect(ok).To(Equal(false))
-		})
-	})
-
-	Describe("Execute- against TrueUSD contract", func() {
-		BeforeEach(func() {
-			header1, err := blockChain.GetHeaderByNumber(6791668)
-			Expect(err).ToNot(HaveOccurred())
-			header2, err := blockChain.GetHeaderByNumber(6791669)
-			Expect(err).ToNot(HaveOccurred())
-			header3, err := blockChain.GetHeaderByNumber(6791670)
-			Expect(err).ToNot(HaveOccurred())
-			headerRepository.CreateOrUpdateHeader(header1)
-			headerID, err = headerRepository.CreateOrUpdateHeader(header2)
-			Expect(err).ToNot(HaveOccurred())
-			headerRepository.CreateOrUpdateHeader(header3)
-		})
-
-		It("Transforms watched contract data into custom repositories", func() {
-			t := transformer.NewTransformer(test_helpers.TusdConfig, blockChain, db)
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-			err = t.Execute()
-			Expect(err).ToNot(HaveOccurred())
-
-			log := test_helpers.HeaderSyncTransferLog{}
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.transfer_event", tusdAddr)).StructScan(&log)
-			Expect(err).ToNot(HaveOccurred())
-			// We don't know vulcID, so compare individual fields instead of complete structures
-			Expect(log.HeaderID).To(Equal(headerID))
-			Expect(log.From).To(Equal("0x1062a747393198f70F71ec65A582423Dba7E5Ab3"))
-			Expect(log.To).To(Equal("0x2930096dB16b4A44Ecd4084EA4bd26F7EeF1AEf0"))
-			Expect(log.Value).To(Equal("9998940000000000000000"))
-		})
-
-		It("Keeps track of contract-related addresses while transforming event data if they need to be used for later method polling", func() {
-			var testConf config.ContractConfig
-			testConf = test_helpers.TusdConfig
-			testConf.Methods = map[string][]string{
-				tusdAddr: {"balanceOf"},
-			}
-			t := transformer.NewTransformer(testConf, blockChain, db)
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-			c, ok := t.Contracts[tusdAddr]
-			Expect(ok).To(Equal(true))
-			err = t.Execute()
-			Expect(err).ToNot(HaveOccurred())
-			Expect(len(c.EmittedAddrs)).To(Equal(4))
-			Expect(len(c.EmittedHashes)).To(Equal(0))
-
-			b, ok := c.EmittedAddrs[common.HexToAddress("0x1062a747393198f70F71ec65A582423Dba7E5Ab3")]
-			Expect(ok).To(Equal(true))
-			Expect(b).To(Equal(true))
-
-			b, ok = c.EmittedAddrs[common.HexToAddress("0x2930096dB16b4A44Ecd4084EA4bd26F7EeF1AEf0")]
-			Expect(ok).To(Equal(true))
-			Expect(b).To(Equal(true))
-
-			b, ok = c.EmittedAddrs[common.HexToAddress("0x571A326f5B15E16917dC17761c340c1ec5d06f6d")]
-			Expect(ok).To(Equal(true))
-			Expect(b).To(Equal(true))
-
-			b, ok = c.EmittedAddrs[common.HexToAddress("0xFBb1b73C4f0BDa4f67dcA266ce6Ef42f520fBB98")]
-			Expect(ok).To(Equal(true))
-			Expect(b).To(Equal(true))
-
-			_, ok = c.EmittedAddrs[common.HexToAddress("0x09BbBBE21a5975cAc061D82f7b843b1234567890")]
-			Expect(ok).To(Equal(false))
-
-			_, ok = c.EmittedAddrs[common.HexToAddress("0x")]
-			Expect(ok).To(Equal(false))
-
-			_, ok = c.EmittedAddrs[""]
-			Expect(ok).To(Equal(false))
-
-			_, ok = c.EmittedAddrs[common.HexToAddress("0x09THISE21a5IS5cFAKE1D82fAND43bCE06MADEUP")]
-			Expect(ok).To(Equal(false))
-		})
-
-		It("Polls given methods using generated token holder address", func() {
-			var testConf config.ContractConfig
-			testConf = test_helpers.TusdConfig
-			testConf.Methods = map[string][]string{
-				tusdAddr: {"balanceOf"},
-			}
-			t := transformer.NewTransformer(testConf, blockChain, db)
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-			err = t.Execute()
-			Expect(err).ToNot(HaveOccurred())
-
-			res := test_helpers.BalanceOf{}
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.balanceof_method WHERE who_ = '0x1062a747393198f70F71ec65A582423Dba7E5Ab3' AND block = '6791669'", tusdAddr)).StructScan(&res)
-			Expect(err).ToNot(HaveOccurred())
-			Expect(res.Balance).To(Equal("55849938025000000000000"))
-			Expect(res.TokenName).To(Equal("TrueUSD"))
-
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.balanceof_method WHERE who_ = '0x09BbBBE21a5975cAc061D82f7b843b1234567890' AND block = '6791669'", tusdAddr)).StructScan(&res)
-			Expect(err).To(HaveOccurred())
-			Expect(err.Error()).To(ContainSubstring("no rows in result set"))
-		})
-
-		It("Fails if initialization has not been done", func() {
-			t := transformer.NewTransformer(test_helpers.TusdConfig, blockChain, db)
-			err = t.Execute()
-			Expect(err).To(HaveOccurred())
-			Expect(err.Error()).To(ContainSubstring("transformer has no initialized contracts"))
-		})
-	})
-
-	Describe("Execute- against ENS registry contract", func() {
-		BeforeEach(func() {
-			header1, err := blockChain.GetHeaderByNumber(6885695)
-			Expect(err).ToNot(HaveOccurred())
-			header2, err := blockChain.GetHeaderByNumber(6885696)
-			Expect(err).ToNot(HaveOccurred())
-			header3, err := blockChain.GetHeaderByNumber(6885697)
-			Expect(err).ToNot(HaveOccurred())
-			headerRepository.CreateOrUpdateHeader(header1)
-			headerID, err = headerRepository.CreateOrUpdateHeader(header2)
-			Expect(err).ToNot(HaveOccurred())
-			headerRepository.CreateOrUpdateHeader(header3)
-		})
-
-		It("Transforms watched contract data into custom repositories", func() {
-			t := transformer.NewTransformer(test_helpers.ENSConfig, blockChain, db)
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-			err = t.Execute()
-			Expect(err).ToNot(HaveOccurred())
-			Expect(t.Start).To(Equal(int64(6885698)))
-
-			log := test_helpers.HeaderSyncNewOwnerLog{}
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.newowner_event", ensAddr)).StructScan(&log)
-			Expect(err).ToNot(HaveOccurred())
-			// We don't know vulcID, so compare individual fields instead of complete structures
-			Expect(log.HeaderID).To(Equal(headerID))
-			Expect(log.Node).To(Equal("0x93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae"))
-			Expect(log.Label).To(Equal("0x95832c7a47ff8a7840e28b78ce695797aaf402b1c186bad9eca28842625b5047"))
-			Expect(log.Owner).To(Equal("0x6090A6e47849629b7245Dfa1Ca21D94cd15878Ef"))
-		})
-
-		It("Keeps track of contract-related hashes while transforming event data if they need to be used for later method polling", func() {
-			var testConf config.ContractConfig
-			testConf = test_helpers.ENSConfig
-			testConf.Methods = map[string][]string{
-				ensAddr: {"owner"},
-			}
-			t := transformer.NewTransformer(testConf, blockChain, db)
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-			c, ok := t.Contracts[ensAddr]
-			Expect(ok).To(Equal(true))
-			err = t.Execute()
-			Expect(err).ToNot(HaveOccurred())
-			Expect(len(c.EmittedHashes)).To(Equal(2))
-			Expect(len(c.EmittedAddrs)).To(Equal(0))
-
-			b, ok := c.EmittedHashes[common.HexToHash("0x93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae")]
-			Expect(ok).To(Equal(true))
-			Expect(b).To(Equal(true))
-
-			b, ok = c.EmittedHashes[common.HexToHash("0x95832c7a47ff8a7840e28b78ce695797aaf402b1c186bad9eca28842625b5047")]
-			Expect(ok).To(Equal(true))
-			Expect(b).To(Equal(true))
-
-			// Doesn't keep track of address since it wouldn't be used in calling the 'owner' method
-			_, ok = c.EmittedAddrs[common.HexToAddress("0x6090A6e47849629b7245Dfa1Ca21D94cd15878Ef")]
-			Expect(ok).To(Equal(false))
-		})
-
-		It("Polls given method using list of collected hashes", func() {
-			var testConf config.ContractConfig
-			testConf = test_helpers.ENSConfig
-			testConf.Methods = map[string][]string{
-				ensAddr: {"owner"},
-			}
-			t := transformer.NewTransformer(testConf, blockChain, db)
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-			err = t.Execute()
-			Expect(err).ToNot(HaveOccurred())
-
-			res := test_helpers.Owner{}
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.owner_method WHERE node_ = '0x93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae' AND block = '6885696'", ensAddr)).StructScan(&res)
-			Expect(err).ToNot(HaveOccurred())
-			Expect(res.Address).To(Equal("0x6090A6e47849629b7245Dfa1Ca21D94cd15878Ef"))
-			Expect(res.TokenName).To(Equal(""))
-
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.owner_method WHERE node_ = '0x95832c7a47ff8a7840e28b78ce695797aaf402b1c186bad9eca28842625b5047' AND block = '6885696'", ensAddr)).StructScan(&res)
-			Expect(err).ToNot(HaveOccurred())
-			Expect(res.Address).To(Equal("0x0000000000000000000000000000000000000000"))
-			Expect(res.TokenName).To(Equal(""))
-
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.owner_method WHERE node_ = '0x9THIS110dcc444fIS242510c09bbAbe21aFAKEcacNODE82f7b843HASH61ba391' AND block = '6885696'", ensAddr)).StructScan(&res)
-			Expect(err).To(HaveOccurred())
-			Expect(err.Error()).To(ContainSubstring("no rows in result set"))
-		})
-
-		It("It does not persist events if they do not pass the emitted arg filter", func() {
-			var testConf config.ContractConfig
-			testConf = test_helpers.ENSConfig
-			testConf.EventArgs = map[string][]string{
-				ensAddr: {"fake_filter_value"},
-			}
-			t := transformer.NewTransformer(testConf, blockChain, db)
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-			err = t.Execute()
-			Expect(err).ToNot(HaveOccurred())
-
-			log := test_helpers.HeaderSyncNewOwnerLog{}
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.newowner_event", ensAddr)).StructScan(&log)
-			Expect(err).To(HaveOccurred())
-			Expect(err.Error()).To(ContainSubstring("does not exist"))
-		})
-
-		It("If a method arg filter is applied, only those arguments are used in polling", func() {
-			var testConf config.ContractConfig
-			testConf = test_helpers.ENSConfig
-			testConf.MethodArgs = map[string][]string{
-				ensAddr: {"0x93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae"},
-			}
-			testConf.Methods = map[string][]string{
-				ensAddr: {"owner"},
-			}
-			t := transformer.NewTransformer(testConf, blockChain, db)
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-			err = t.Execute()
-			Expect(err).ToNot(HaveOccurred())
-
-			res := test_helpers.Owner{}
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.owner_method WHERE node_ = '0x93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae' AND block = '6885696'", ensAddr)).StructScan(&res)
-			Expect(err).ToNot(HaveOccurred())
-			Expect(res.Address).To(Equal("0x6090A6e47849629b7245Dfa1Ca21D94cd15878Ef"))
-			Expect(res.TokenName).To(Equal(""))
-
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.owner_method WHERE node_ = '0x95832c7a47ff8a7840e28b78ce695797aaf402b1c186bad9eca28842625b5047' AND block = '6885696'", ensAddr)).StructScan(&res)
-			Expect(err).To(HaveOccurred())
-			Expect(err.Error()).To(ContainSubstring("no rows in result set"))
-		})
-	})
-
-	Describe("Execute- against both ENS and TrueUSD", func() {
-		BeforeEach(func() {
-			for i := 6885692; i <= 6885701; i++ {
-				header, err := blockChain.GetHeaderByNumber(int64(i))
-				Expect(err).ToNot(HaveOccurred())
-				_, err = headerRepository.CreateOrUpdateHeader(header)
-				Expect(err).ToNot(HaveOccurred())
-			}
-		})
-
-		It("Transforms watched contract data into custom repositories", func() {
-			t := transformer.NewTransformer(test_helpers.ENSandTusdConfig, blockChain, db)
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-			err = t.Execute()
-			Expect(err).ToNot(HaveOccurred())
-			Expect(t.Start).To(Equal(int64(6885702)))
-
-			newOwnerLog := test_helpers.HeaderSyncNewOwnerLog{}
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.newowner_event", ensAddr)).StructScan(&newOwnerLog)
-			Expect(err).ToNot(HaveOccurred())
-			// We don't know vulcID, so compare individual fields instead of complete structures
-			Expect(newOwnerLog.Node).To(Equal("0x93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae"))
-			Expect(newOwnerLog.Label).To(Equal("0x95832c7a47ff8a7840e28b78ce695797aaf402b1c186bad9eca28842625b5047"))
-			Expect(newOwnerLog.Owner).To(Equal("0x6090A6e47849629b7245Dfa1Ca21D94cd15878Ef"))
-
-			transferLog := test_helpers.HeaderSyncTransferLog{}
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.transfer_event", tusdAddr)).StructScan(&transferLog)
-			Expect(err).ToNot(HaveOccurred())
-			// We don't know vulcID, so compare individual fields instead of complete structures
-			Expect(transferLog.From).To(Equal("0x8cA465764873E71CEa525F5EB6AE973d650c22C2"))
-			Expect(transferLog.To).To(Equal("0xc338482360651E5D30BEd77b7c85358cbBFB2E0e"))
-			Expect(transferLog.Value).To(Equal("2800000000000000000000"))
-		})
-
-		It("Keeps track of contract-related hashes and addresses while transforming event data if they need to be used for later method polling", func() {
-			var testConf config.ContractConfig
-			testConf = test_helpers.ENSandTusdConfig
-			testConf.Methods = map[string][]string{
-				ensAddr:  {"owner"},
-				tusdAddr: {"balanceOf"},
-			}
-			t := transformer.NewTransformer(testConf, blockChain, db)
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-			ens, ok := t.Contracts[ensAddr]
-			Expect(ok).To(Equal(true))
-			tusd, ok := t.Contracts[tusdAddr]
-			Expect(ok).To(Equal(true))
-			err = t.Execute()
-			Expect(err).ToNot(HaveOccurred())
-			Expect(len(ens.EmittedHashes)).To(Equal(2))
-			Expect(len(ens.EmittedAddrs)).To(Equal(0))
-			Expect(len(tusd.EmittedAddrs)).To(Equal(2))
-			Expect(len(tusd.EmittedHashes)).To(Equal(0))
-
-			b, ok := ens.EmittedHashes[common.HexToHash("0x93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae")]
-			Expect(ok).To(Equal(true))
-			Expect(b).To(Equal(true))
-
-			b, ok = ens.EmittedHashes[common.HexToHash("0x95832c7a47ff8a7840e28b78ce695797aaf402b1c186bad9eca28842625b5047")]
-			Expect(ok).To(Equal(true))
-			Expect(b).To(Equal(true))
-
-			b, ok = tusd.EmittedAddrs[common.HexToAddress("0x8cA465764873E71CEa525F5EB6AE973d650c22C2")]
-			Expect(ok).To(Equal(true))
-			Expect(b).To(Equal(true))
-
-			b, ok = tusd.EmittedAddrs[common.HexToAddress("0xc338482360651E5D30BEd77b7c85358cbBFB2E0e")]
-			Expect(ok).To(Equal(true))
-			Expect(b).To(Equal(true))
-
-			_, ok = tusd.EmittedAddrs[common.HexToAddress("0x6090A6e47849629b7245Dfa1Ca21D94cd15878Ef")]
-			Expect(ok).To(Equal(false))
-		})
-
-		It("Polls given methods for each contract, using list of collected values", func() {
-			var testConf config.ContractConfig
-			testConf = test_helpers.ENSandTusdConfig
-			testConf.Methods = map[string][]string{
-				ensAddr:  {"owner"},
-				tusdAddr: {"balanceOf"},
-			}
-			t := transformer.NewTransformer(testConf, blockChain, db)
-			err = t.Init()
-			Expect(err).ToNot(HaveOccurred())
-			err = t.Execute()
-			Expect(err).ToNot(HaveOccurred())
-
-			owner := test_helpers.Owner{}
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.owner_method WHERE node_ = '0x93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae' AND block = '6885696'", ensAddr)).StructScan(&owner)
-			Expect(err).ToNot(HaveOccurred())
-			Expect(owner.Address).To(Equal("0x6090A6e47849629b7245Dfa1Ca21D94cd15878Ef"))
-			Expect(owner.TokenName).To(Equal(""))
-
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.owner_method WHERE node_ = '0x95832c7a47ff8a7840e28b78ce695797aaf402b1c186bad9eca28842625b5047' AND block = '6885696'", ensAddr)).StructScan(&owner)
-			Expect(err).ToNot(HaveOccurred())
-			Expect(owner.Address).To(Equal("0x0000000000000000000000000000000000000000"))
-			Expect(owner.TokenName).To(Equal(""))
-
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.owner_method WHERE node_ = '0x95832c7a47ff8a7840e28b78ceMADEUPaaf4HASHc186badTHItransformers.8IS625bFAKE' AND block = '6885696'", ensAddr)).StructScan(&owner)
-			Expect(err).To(HaveOccurred())
-			Expect(err.Error()).To(ContainSubstring("no rows in result set"))
-
-			bal := test_helpers.BalanceOf{}
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.balanceof_method WHERE who_ = '0x8cA465764873E71CEa525F5EB6AE973d650c22C2' AND block = '6885701'", tusdAddr)).StructScan(&bal)
-			Expect(err).ToNot(HaveOccurred())
-			Expect(bal.Balance).To(Equal("1954436000000000000000"))
-			Expect(bal.TokenName).To(Equal("TrueUSD"))
-
-			err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.balanceof_method WHERE who_ = '0x09BbBBE21a5975cAc061D82f7b843b1234567890' AND block = '6885701'", tusdAddr)).StructScan(&bal)
-			Expect(err).To(HaveOccurred())
-			Expect(err.Error()).To(ContainSubstring("no rows in result set"))
-		})
-	})
-})

integration_test/geth_blockchain_test.go

@@ -1,137 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package integration_test
-
-import (
-	"github.com/ethereum/go-ethereum/common"
-	"github.com/ethereum/go-ethereum/ethclient"
-	"github.com/ethereum/go-ethereum/rpc"
-	. "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/geth"
-	"github.com/vulcanize/vulcanizedb/pkg/geth/client"
-	rpc2 "github.com/vulcanize/vulcanizedb/pkg/geth/converters/rpc"
-	"github.com/vulcanize/vulcanizedb/pkg/geth/node"
-	"github.com/vulcanize/vulcanizedb/pkg/history"
-	"github.com/vulcanize/vulcanizedb/test_config"
-)
-
-var _ = Describe("Reading from the Geth blockchain", func() {
-	var blockChain *geth.BlockChain
-
-	BeforeEach(func() {
-		rawRpcClient, err := rpc.Dial(test_config.InfuraClient.IPCPath)
-		Expect(err).NotTo(HaveOccurred())
-		rpcClient := client.NewRpcClient(rawRpcClient, test_config.InfuraClient.IPCPath)
-		ethClient := ethclient.NewClient(rawRpcClient)
-		blockChainClient := client.NewEthClient(ethClient)
-		node := node.MakeNode(rpcClient)
-		transactionConverter := rpc2.NewRpcTransactionConverter(ethClient)
-		blockChain = geth.NewBlockChain(blockChainClient, rpcClient, node, transactionConverter)
-	})
-
-	It("reads two blocks", func(done Done) {
-		blocks := fakes.NewMockBlockRepository()
-		lastBlock, err := blockChain.LastBlock()
-		Expect(err).NotTo(HaveOccurred())
-
-		queriedBlocks := []int64{lastBlock.Int64() - 5, lastBlock.Int64() - 6}
-		_, err = history.RetrieveAndUpdateBlocks(blockChain, blocks, queriedBlocks)
-		Expect(err).NotTo(HaveOccurred())
-
-		blocks.AssertCreateOrUpdateBlocksCallCountAndBlockNumbersEquals(2, []int64{lastBlock.Int64() - 5, lastBlock.Int64() - 6})
-		close(done)
-	}, 30)
-
-	It("retrieves the genesis block and first block", func(done Done) {
-		genesisBlock, err := blockChain.GetBlockByNumber(int64(0))
-		Expect(err).ToNot(HaveOccurred())
-		firstBlock, err := blockChain.GetBlockByNumber(int64(1))
-		Expect(err).ToNot(HaveOccurred())
-		lastBlockNumber, err := blockChain.LastBlock()
-
-		Expect(err).NotTo(HaveOccurred())
-		Expect(genesisBlock.Number).To(Equal(int64(0)))
-		Expect(firstBlock.Number).To(Equal(int64(1)))
-		Expect(lastBlockNumber.Int64()).To(BeNumerically(">", 0))
-		close(done)
-	}, 15)
-
-	It("retrieves the node info", func(done Done) {
-		node := blockChain.Node()
-		mainnetID := float64(1)
-
-		Expect(node.GenesisBlock).ToNot(BeNil())
-		Expect(node.NetworkID).To(Equal(mainnetID))
-		Expect(len(node.ID)).ToNot(BeZero())
-		Expect(node.ClientName).ToNot(BeZero())
-
-		close(done)
-	}, 15)
-
-	It("retrieves transaction", func() {
-		// actual transaction: https://etherscan.io/tx/0x44d462f2a19ad267e276b234a62c542fc91c974d2e4754a325ca405f95440255
-		txHash := common.HexToHash("0x44d462f2a19ad267e276b234a62c542fc91c974d2e4754a325ca405f95440255")
-		transactions, err := blockChain.GetTransactions([]common.Hash{txHash})
-
-		Expect(err).NotTo(HaveOccurred())
-		Expect(len(transactions)).To(Equal(1))
-		expectedData := []byte{149, 227, 197, 11, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
-			1, 160, 85, 105, 13, 157, 184, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 7,
-			241, 202, 218, 90, 30, 178, 234, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
-			0, 0, 0, 92, 155, 193, 43}
-		expectedRaw := []byte{248, 201, 9, 132, 59, 154, 202, 0, 131, 1, 102, 93, 148, 44, 75, 208, 100, 185, 152, 131,
-			128, 118, 250, 52, 26, 131, 208, 7, 252, 47, 165, 9, 87, 128, 184, 100, 149, 227, 197, 11, 0, 0, 0, 0, 0, 0, 0,
-			0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 160, 85, 105, 13, 157, 184, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
-			0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 7, 241, 202, 218, 90, 30, 178, 234, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
-			0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 92, 155, 193, 43, 37, 160, 237, 184, 236, 248, 23, 152,
-			53, 238, 44, 215, 181, 234, 229, 157, 246, 212, 178, 88, 25, 116, 134, 163, 124, 64, 2, 66, 25, 118, 1, 253, 27,
-			101, 160, 36, 226, 116, 43, 147, 236, 124, 76, 227, 250, 228, 168, 22, 19, 248, 155, 248, 151, 219, 14, 1, 186,
-			159, 35, 154, 22, 222, 123, 254, 147, 63, 221}
-		expectedModel := core.TransactionModel{
-			Data:     expectedData,
-			From:     "0x3b08b99441086edd66f36f9f9aee733280698378",
-			GasLimit: 91741,
-			GasPrice: 1000000000,
-			Hash:     "0x44d462f2a19ad267e276b234a62c542fc91c974d2e4754a325ca405f95440255",
-			Nonce:    9,
-			Raw:      expectedRaw,
-			Receipt:  core.Receipt{},
-			To:       "0x2c4bd064b998838076fa341a83d007fc2fa50957",
-			TxIndex:  30,
-			Value:    "0",
-		}
-		Expect(transactions[0]).To(Equal(expectedModel))
-	})
-
-	//Benchmarking test: remove skip to test performance of block retrieval
-	XMeasure("retrieving n blocks", func(b Benchmarker) {
-		b.Time("runtime", func() {
-			var blocks []core.Block
-			n := 10
-			for i := 5327459; i > 5327459-n; i-- {
-				block, err := blockChain.GetBlockByNumber(int64(i))
-				Expect(err).ToNot(HaveOccurred())
-				blocks = append(blocks, block)
-			}
-			Expect(len(blocks)).To(Equal(n))
-		})
-	}, 10)
-})

integration_test/poller_test.go

@@ -1,252 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package integration_test
-
-import (
-	"fmt"
-
-	"github.com/ethereum/go-ethereum/common"
-	. "github.com/onsi/ginkgo"
-	. "github.com/onsi/gomega"
-
-	"github.com/vulcanize/vulcanizedb/pkg/contract_watcher/shared/constants"
-	"github.com/vulcanize/vulcanizedb/pkg/contract_watcher/shared/contract"
-	"github.com/vulcanize/vulcanizedb/pkg/contract_watcher/shared/helpers/test_helpers"
-	"github.com/vulcanize/vulcanizedb/pkg/contract_watcher/shared/poller"
-	"github.com/vulcanize/vulcanizedb/pkg/contract_watcher/shared/types"
-	"github.com/vulcanize/vulcanizedb/pkg/core"
-	"github.com/vulcanize/vulcanizedb/pkg/datastore/postgres"
-)
-
-var _ = Describe("Poller", func() {
-
-	var contractPoller poller.Poller
-	var con *contract.Contract
-	var db *postgres.DB
-	var bc core.BlockChain
-
-	AfterEach(func() {
-		test_helpers.TearDown(db)
-	})
-
-	Describe("Full sync mode", func() {
-		BeforeEach(func() {
-			db, bc = test_helpers.SetupDBandBC()
-			contractPoller = poller.NewPoller(bc, db, types.FullSync)
-		})
-
-		Describe("PollContract", func() {
-			It("Polls specified contract methods using contract's argument list", func() {
-				con = test_helpers.SetupTusdContract(nil, []string{"balanceOf"})
-				Expect(con.Abi).To(Equal(constants.TusdAbiString))
-				con.StartingBlock = 6707322
-				con.AddEmittedAddr(common.HexToAddress("0xfE9e8709d3215310075d67E3ed32A380CCf451C8"), common.HexToAddress("0x3f5CE5FBFe3E9af3971dD833D26bA9b5C936f0bE"))
-
-				err := contractPoller.PollContract(*con, 6707323)
-				Expect(err).ToNot(HaveOccurred())
-
-				scanStruct := test_helpers.BalanceOf{}
-
-				err = db.QueryRowx(fmt.Sprintf("SELECT * FROM full_%s.balanceof_method WHERE who_ = '0xfE9e8709d3215310075d67E3ed32A380CCf451C8' AND block = '6707322'", constants.TusdContractAddress)).StructScan(&scanStruct)
-				Expect(err).ToNot(HaveOccurred())
-				Expect(scanStruct.Balance).To(Equal("66386309548896882859581786"))
-				Expect(scanStruct.TokenName).To(Equal("TrueUSD"))
-
-				err = db.QueryRowx(fmt.Sprintf("SELECT * FROM full_%s.balanceof_method WHERE who_ = '0xfE9e8709d3215310075d67E3ed32A380CCf451C8' AND block = '6707323'", constants.TusdContractAddress)).StructScan(&scanStruct)
-				Expect(err).ToNot(HaveOccurred())
-				Expect(scanStruct.Balance).To(Equal("66386309548896882859581786"))
-				Expect(scanStruct.TokenName).To(Equal("TrueUSD"))
-
-				err = db.QueryRowx(fmt.Sprintf("SELECT * FROM full_%s.balanceof_method WHERE who_ = '0x3f5CE5FBFe3E9af3971dD833D26bA9b5C936f0bE' AND block = '6707322'", constants.TusdContractAddress)).StructScan(&scanStruct)
-				Expect(err).ToNot(HaveOccurred())
-				Expect(scanStruct.Balance).To(Equal("17982350181394112023885864"))
-				Expect(scanStruct.TokenName).To(Equal("TrueUSD"))
-
-				err = db.QueryRowx(fmt.Sprintf("SELECT * FROM full_%s.balanceof_method WHERE who_ = '0x3f5CE5FBFe3E9af3971dD833D26bA9b5C936f0bE' AND block = '6707323'", constants.TusdContractAddress)).StructScan(&scanStruct)
-				Expect(err).ToNot(HaveOccurred())
-				Expect(scanStruct.Balance).To(Equal("17982350181394112023885864"))
-				Expect(scanStruct.TokenName).To(Equal("TrueUSD"))
-			})
-
-			It("Polls specified contract methods using contract's hash list", func() {
-				con = test_helpers.SetupENSContract(nil, []string{"owner"})
-				Expect(con.Abi).To(Equal(constants.ENSAbiString))
-				Expect(len(con.Methods)).To(Equal(1))
-				con.AddEmittedHash(common.HexToHash("0x93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae"), common.HexToHash("0x7e74a86b6e146964fb965db04dc2590516da77f720bb6759337bf5632415fd86"))
-
-				err := contractPoller.PollContractAt(*con, 6885877)
-				Expect(err).ToNot(HaveOccurred())
-
-				scanStruct := test_helpers.Owner{}
-
-				err = db.QueryRowx(fmt.Sprintf("SELECT * FROM full_%s.owner_method WHERE node_ = '0x7e74a86b6e146964fb965db04dc2590516da77f720bb6759337bf5632415fd86' AND block = '6885877'", constants.EnsContractAddress)).StructScan(&scanStruct)
-				Expect(err).ToNot(HaveOccurred())
-				Expect(scanStruct.Address).To(Equal("0x546aA2EaE2514494EeaDb7bbb35243348983C59d"))
-				Expect(scanStruct.TokenName).To(Equal("ENS-Registry"))
-
-				err = db.QueryRowx(fmt.Sprintf("SELECT * FROM full_%s.owner_method WHERE node_ = '0x93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae' AND block = '6885877'", constants.EnsContractAddress)).StructScan(&scanStruct)
-				Expect(err).ToNot(HaveOccurred())
-				Expect(scanStruct.Address).To(Equal("0x6090A6e47849629b7245Dfa1Ca21D94cd15878Ef"))
-				Expect(scanStruct.TokenName).To(Equal("ENS-Registry"))
-			})
-
-			It("Does not poll and persist any methods if none are specified", func() {
-				con = test_helpers.SetupTusdContract(nil, nil)
-				Expect(con.Abi).To(Equal(constants.TusdAbiString))
-				con.StartingBlock = 6707322
-				con.AddEmittedAddr(common.HexToAddress("0xfE9e8709d3215310075d67E3ed32A380CCf451C8"), common.HexToAddress("0x3f5CE5FBFe3E9af3971dD833D26bA9b5C936f0bE"))
-
-				err := contractPoller.PollContract(*con, 6707323)
-				Expect(err).ToNot(HaveOccurred())
-
-				scanStruct := test_helpers.BalanceOf{}
-
-				err = db.QueryRowx(fmt.Sprintf("SELECT * FROM full_%s.balanceof_method WHERE who_ = '0xfE9e8709d3215310075d67E3ed32A380CCf451C8' AND block = '6707322'", constants.TusdContractAddress)).StructScan(&scanStruct)
-				Expect(err).To(HaveOccurred())
-			})
-		})
-
-		Describe("FetchContractData", func() {
-			It("Calls a single contract method", func() {
-				var name = new(string)
-				err := contractPoller.FetchContractData(constants.TusdAbiString, constants.TusdContractAddress, "name", nil, &name, 6197514)
-				Expect(err).ToNot(HaveOccurred())
-				Expect(*name).To(Equal("TrueUSD"))
-			})
-		})
-	})
-
-	Describe("Header sync mode", func() {
-		BeforeEach(func() {
-			db, bc = test_helpers.SetupDBandBC()
-			contractPoller = poller.NewPoller(bc, db, types.HeaderSync)
-		})
-
-		Describe("PollContract", func() {
-			It("Polls specified contract methods using contract's token holder address list", func() {
-				con = test_helpers.SetupTusdContract(nil, []string{"balanceOf"})
-				Expect(con.Abi).To(Equal(constants.TusdAbiString))
-				con.StartingBlock = 6707322
-				con.AddEmittedAddr(common.HexToAddress("0xfE9e8709d3215310075d67E3ed32A380CCf451C8"), common.HexToAddress("0x3f5CE5FBFe3E9af3971dD833D26bA9b5C936f0bE"))
-
-				err := contractPoller.PollContract(*con, 6707323)
-				Expect(err).ToNot(HaveOccurred())
-
-				scanStruct := test_helpers.BalanceOf{}
-
-				err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.balanceof_method WHERE who_ = '0xfE9e8709d3215310075d67E3ed32A380CCf451C8' AND block = '6707322'", constants.TusdContractAddress)).StructScan(&scanStruct)
-				Expect(err).ToNot(HaveOccurred())
-				Expect(scanStruct.Balance).To(Equal("66386309548896882859581786"))
-				Expect(scanStruct.TokenName).To(Equal("TrueUSD"))
-
-				err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.balanceof_method WHERE who_ = '0xfE9e8709d3215310075d67E3ed32A380CCf451C8' AND block = '6707323'", constants.TusdContractAddress)).StructScan(&scanStruct)
-				Expect(err).ToNot(HaveOccurred())
-				Expect(scanStruct.Balance).To(Equal("66386309548896882859581786"))
-				Expect(scanStruct.TokenName).To(Equal("TrueUSD"))
-
-				err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.balanceof_method WHERE who_ = '0x3f5CE5FBFe3E9af3971dD833D26bA9b5C936f0bE' AND block = '6707322'", constants.TusdContractAddress)).StructScan(&scanStruct)
-				Expect(err).ToNot(HaveOccurred())
-				Expect(scanStruct.Balance).To(Equal("17982350181394112023885864"))
-				Expect(scanStruct.TokenName).To(Equal("TrueUSD"))
-
-				err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.balanceof_method WHERE who_ = '0x3f5CE5FBFe3E9af3971dD833D26bA9b5C936f0bE' AND block = '6707323'", constants.TusdContractAddress)).StructScan(&scanStruct)
-				Expect(err).ToNot(HaveOccurred())
-				Expect(scanStruct.Balance).To(Equal("17982350181394112023885864"))
-				Expect(scanStruct.TokenName).To(Equal("TrueUSD"))
-			})
-
-			It("Polls specified contract methods using contract's hash list", func() {
-				con = test_helpers.SetupENSContract(nil, []string{"owner"})
-				Expect(con.Abi).To(Equal(constants.ENSAbiString))
-				Expect(len(con.Methods)).To(Equal(1))
-				con.AddEmittedHash(common.HexToHash("0x93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae"), common.HexToHash("0x7e74a86b6e146964fb965db04dc2590516da77f720bb6759337bf5632415fd86"))
-
-				err := contractPoller.PollContractAt(*con, 6885877)
-				Expect(err).ToNot(HaveOccurred())
-
-				scanStruct := test_helpers.Owner{}
-
-				err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.owner_method WHERE node_ = '0x7e74a86b6e146964fb965db04dc2590516da77f720bb6759337bf5632415fd86' AND block = '6885877'", constants.EnsContractAddress)).StructScan(&scanStruct)
-				Expect(err).ToNot(HaveOccurred())
-				Expect(scanStruct.Address).To(Equal("0x546aA2EaE2514494EeaDb7bbb35243348983C59d"))
-				Expect(scanStruct.TokenName).To(Equal("ENS-Registry"))
-
-				err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.owner_method WHERE node_ = '0x93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae' AND block = '6885877'", constants.EnsContractAddress)).StructScan(&scanStruct)
-				Expect(err).ToNot(HaveOccurred())
-				Expect(scanStruct.Address).To(Equal("0x6090A6e47849629b7245Dfa1Ca21D94cd15878Ef"))
-				Expect(scanStruct.TokenName).To(Equal("ENS-Registry"))
-			})
-
-			It("Does not poll and persist any methods if none are specified", func() {
-				con = test_helpers.SetupTusdContract(nil, nil)
-				Expect(con.Abi).To(Equal(constants.TusdAbiString))
-				con.StartingBlock = 6707322
-				con.AddEmittedAddr(common.HexToAddress("0xfE9e8709d3215310075d67E3ed32A380CCf451C8"), common.HexToAddress("0x3f5CE5FBFe3E9af3971dD833D26bA9b5C936f0bE"))
-
-				err := contractPoller.PollContract(*con, 6707323)
-				Expect(err).ToNot(HaveOccurred())
-
-				scanStruct := test_helpers.BalanceOf{}
-
-				err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.balanceof_method WHERE who_ = '0xfE9e8709d3215310075d67E3ed32A380CCf451C8' AND block = '6707322'", constants.TusdContractAddress)).StructScan(&scanStruct)
-				Expect(err).To(HaveOccurred())
-			})
-
-			It("Caches returned values of the appropriate types for downstream method polling if method piping is turned on", func() {
-				con = test_helpers.SetupENSContract(nil, []string{"resolver"})
-				Expect(con.Abi).To(Equal(constants.ENSAbiString))
-				con.StartingBlock = 6921967
-				con.EmittedAddrs = map[interface{}]bool{}
-				con.Piping = false
-				con.AddEmittedHash(common.HexToHash("0x495b6e6efdedb750aa519919b5cf282bdaa86067b82a2293a3ff5723527141e8"))
-				err := contractPoller.PollContract(*con, 6921968)
-				Expect(err).ToNot(HaveOccurred())
-
-				scanStruct := test_helpers.Resolver{}
-				err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.resolver_method WHERE node_ = '0x495b6e6efdedb750aa519919b5cf282bdaa86067b82a2293a3ff5723527141e8' AND block = '6921967'", constants.EnsContractAddress)).StructScan(&scanStruct)
-				Expect(err).ToNot(HaveOccurred())
-				Expect(scanStruct.Address).To(Equal("0x5FfC014343cd971B7eb70732021E26C35B744cc4"))
-				Expect(scanStruct.TokenName).To(Equal("ENS-Registry"))
-				Expect(len(con.EmittedAddrs)).To(Equal(0)) // With piping off the address is not saved
-
-				test_helpers.TearDown(db)
-				db, bc = test_helpers.SetupDBandBC()
-				contractPoller = poller.NewPoller(bc, db, types.HeaderSync)
-
-				con.Piping = true
-				err = contractPoller.PollContract(*con, 6921968)
-				Expect(err).ToNot(HaveOccurred())
-
-				err = db.QueryRowx(fmt.Sprintf("SELECT * FROM header_%s.resolver_method WHERE node_ = '0x495b6e6efdedb750aa519919b5cf282bdaa86067b82a2293a3ff5723527141e8' AND block = '6921967'", constants.EnsContractAddress)).StructScan(&scanStruct)
-				Expect(err).ToNot(HaveOccurred())
-				Expect(scanStruct.Address).To(Equal("0x5FfC014343cd971B7eb70732021E26C35B744cc4"))
-				Expect(scanStruct.TokenName).To(Equal("ENS-Registry"))
-				Expect(len(con.EmittedAddrs)).To(Equal(1)) // With piping on it is saved
-				Expect(con.EmittedAddrs[common.HexToAddress("0x5FfC014343cd971B7eb70732021E26C35B744cc4")]).To(Equal(true))
-			})
-		})
-
-		Describe("FetchContractData", func() {
-			It("Calls a single contract method", func() {
-				var name = new(string)
-				err := contractPoller.FetchContractData(constants.TusdAbiString, constants.TusdContractAddress, "name", nil, &name, 6197514)
-				Expect(err).ToNot(HaveOccurred())
-				Expect(*name).To(Equal("TrueUSD"))
-			})
-		})
-	})
-})

libraries/shared/README.md

@@ -1,8 +0,0 @@
-# Shared Tools
-
-## Description
-Code that is useful for or used by plugins written 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/chunker_suite_test.go

@@ -1,35 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package chunker_test
-
-import (
-	"testing"
-
-	. "github.com/onsi/ginkgo"
-	. "github.com/onsi/gomega"
-	log "github.com/sirupsen/logrus"
-	"io/ioutil"
-)
-
-func TestFactories(t *testing.T) {
-	RegisterFailHandler(Fail)
-	RunSpecs(t, "Shared Chunker Suite")
-}
-
-var _ = BeforeSuite(func() {
-	log.SetOutput(ioutil.Discard)
-})

libraries/shared/chunker/log_chunker.go

@@ -1,72 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package chunker
-
-import (
-	"strings"
-
-	"github.com/ethereum/go-ethereum/common"
-	"github.com/ethereum/go-ethereum/core/types"
-
-	shared_t "github.com/vulcanize/vulcanizedb/libraries/shared/transformer"
-)
-
-type Chunker interface {
-	AddConfigs(transformerConfigs []shared_t.EventTransformerConfig)
-	ChunkLogs(logs []types.Log) map[string][]types.Log
-}
-
-type LogChunker struct {
-	AddressToNames map[string][]string
-	NameToTopic0   map[string]common.Hash
-}
-
-// Returns a new log chunker with initialised maps.
-// Needs to have configs added with `AddConfigs` to consider logs for the respective transformer.
-func NewLogChunker() *LogChunker {
-	return &LogChunker{
-		AddressToNames: map[string][]string{},
-		NameToTopic0:   map[string]common.Hash{},
-	}
-}
-
-// Configures the chunker by adding more addreses and topics to consider.
-func (chunker *LogChunker) AddConfigs(transformerConfigs []shared_t.EventTransformerConfig) {
-	for _, config := range transformerConfigs {
-		for _, address := range config.ContractAddresses {
-			var lowerCaseAddress = strings.ToLower(address)
-			chunker.AddressToNames[lowerCaseAddress] = append(chunker.AddressToNames[lowerCaseAddress], config.TransformerName)
-			chunker.NameToTopic0[config.TransformerName] = common.HexToHash(config.Topic)
-		}
-	}
-}
-
-// Goes through an array of logs, associating relevant logs (matching addresses and topic) with transformers
-func (chunker *LogChunker) ChunkLogs(logs []types.Log) map[string][]types.Log {
-	chunks := map[string][]types.Log{}
-	for _, log := range logs {
-		// Topic0 is not unique to each transformer, also need to consider the contract address
-		relevantTransformers := chunker.AddressToNames[strings.ToLower(log.Address.String())]
-
-		for _, transformer := range relevantTransformers {
-			if chunker.NameToTopic0[transformer] == log.Topics[0] {
-				chunks[transformer] = append(chunks[transformer], log)
-			}
-		}
-	}
-	return chunks
-}

libraries/shared/chunker/log_chunker_test.go

@@ -1,152 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package chunker_test
-
-import (
-	"github.com/ethereum/go-ethereum/common"
-	"github.com/ethereum/go-ethereum/core/types"
-	. "github.com/onsi/ginkgo"
-	. "github.com/onsi/gomega"
-
-	chunk "github.com/vulcanize/vulcanizedb/libraries/shared/chunker"
-	shared_t "github.com/vulcanize/vulcanizedb/libraries/shared/transformer"
-)
-
-var _ = Describe("Log chunker", func() {
-	var (
-		configs []shared_t.EventTransformerConfig
-		chunker *chunk.LogChunker
-	)
-
-	BeforeEach(func() {
-		configA := shared_t.EventTransformerConfig{
-			TransformerName:   "TransformerA",
-			ContractAddresses: []string{"0x00000000000000000000000000000000000000A1", "0x00000000000000000000000000000000000000A2"},
-			Topic:             "0xA",
-		}
-		configB := shared_t.EventTransformerConfig{
-			TransformerName:   "TransformerB",
-			ContractAddresses: []string{"0x00000000000000000000000000000000000000B1"},
-			Topic:             "0xB",
-		}
-
-		configC := shared_t.EventTransformerConfig{
-			TransformerName:   "TransformerC",
-			ContractAddresses: []string{"0x00000000000000000000000000000000000000A2"},
-			Topic:             "0xC",
-		}
-
-		configs = []shared_t.EventTransformerConfig{configA, configB, configC}
-		chunker = chunk.NewLogChunker()
-		chunker.AddConfigs(configs)
-	})
-
-	Describe("initialisation", func() {
-		It("creates lookup maps correctly", func() {
-			Expect(chunker.AddressToNames).To(Equal(map[string][]string{
-				"0x00000000000000000000000000000000000000a1": {"TransformerA"},
-				"0x00000000000000000000000000000000000000a2": {"TransformerA", "TransformerC"},
-				"0x00000000000000000000000000000000000000b1": {"TransformerB"},
-			}))
-
-			Expect(chunker.NameToTopic0).To(Equal(map[string]common.Hash{
-				"TransformerA": common.HexToHash("0xA"),
-				"TransformerB": common.HexToHash("0xB"),
-				"TransformerC": common.HexToHash("0xC"),
-			}))
-		})
-	})
-
-	Describe("AddConfigs", func() {
-		It("can add more configs later", func() {
-			configD := shared_t.EventTransformerConfig{
-				TransformerName:   "TransformerD",
-				ContractAddresses: []string{"0x000000000000000000000000000000000000000D"},
-				Topic:             "0xD",
-			}
-			chunker.AddConfigs([]shared_t.EventTransformerConfig{configD})
-
-			Expect(chunker.AddressToNames).To(ContainElement([]string{"TransformerD"}))
-			Expect(chunker.NameToTopic0).To(ContainElement(common.HexToHash("0xD")))
-		})
-
-		It("lower cases address", func() {
-			configD := shared_t.EventTransformerConfig{
-				TransformerName:   "TransformerD",
-				ContractAddresses: []string{"0x000000000000000000000000000000000000000D"},
-				Topic:             "0xD",
-			}
-			chunker.AddConfigs([]shared_t.EventTransformerConfig{configD})
-
-			Expect(chunker.AddressToNames["0x000000000000000000000000000000000000000d"]).To(Equal([]string{"TransformerD"}))
-		})
-	})
-
-	Describe("ChunkLogs", func() {
-		It("only associates logs with relevant topic0 and address to transformers", func() {
-			logs := []types.Log{log1, log2, log3, log4, log5}
-			chunks := chunker.ChunkLogs(logs)
-
-			Expect(chunks["TransformerA"]).To(And(ContainElement(log1), ContainElement(log4)))
-			Expect(chunks["TransformerB"]).To(BeEmpty())
-			Expect(chunks["TransformerC"]).To(ContainElement(log5))
-		})
-	})
-})
-
-var (
-	// Match TransformerA
-	log1 = types.Log{
-		Address: common.HexToAddress("0xA1"),
-		Topics: []common.Hash{
-			common.HexToHash("0xA"),
-			common.HexToHash("0xLogTopic1"),
-		},
-	}
-	// Match TransformerA address, but not topic0
-	log2 = types.Log{
-		Address: common.HexToAddress("0xA1"),
-		Topics: []common.Hash{
-			common.HexToHash("0xB"),
-			common.HexToHash("0xLogTopic2"),
-		},
-	}
-	// Match TransformerA topic, but TransformerB address
-	log3 = types.Log{
-		Address: common.HexToAddress("0xB1"),
-		Topics: []common.Hash{
-			common.HexToHash("0xA"),
-			common.HexToHash("0xLogTopic3"),
-		},
-	}
-	// Match TransformerA, with the other address
-	log4 = types.Log{
-		Address: common.HexToAddress("0xA2"),
-		Topics: []common.Hash{
-			common.HexToHash("0xA"),
-			common.HexToHash("0xLogTopic4"),
-		},
-	}
-	// Match TransformerC, which shares address with TransformerA
-	log5 = types.Log{
-		Address: common.HexToAddress("0xA2"),
-		Topics: []common.Hash{
-			common.HexToHash("0xC"),
-			common.HexToHash("0xLogTopic5"),
-		},
-	}
-)

libraries/shared/constants/checked_headers.go

@@ -1,25 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package constants
-
-type TransformerExecution bool
-
-const (
-	HeaderRecheck    TransformerExecution = true
-	HeaderMissing    TransformerExecution = false
-	RecheckHeaderCap                      = "4"
-)

libraries/shared/constants/data.go

@@ -1,19 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package constants
-
-var DataItemLength = 32

libraries/shared/factories/event/README.md

@@ -1,388 +0,0 @@
-# Watching Contract Events
-	
-One approach VulcanizeDB takes to caching and indexing smart contracts is to watch contract events emitted in receipt logs.
-
-With a header synced vDB we can watch events by iterating over headers retrieved from the synced `headers` table and using these headers to
-fetch and verify relevant event logs from a full Ethereum node, keeping track of which headers we have checked for which events 
-with our `checked_headers` table.
-
-## Assumptions
-
-This approach assumes you are running a vDB header sync which is run against a light Ethereum node;
-this approach also assumes there is a full node available. 
-
-Looking forward, we will be building fetchers that enable sourcing data from IPFS instead of an ETH node.
-
-## Shared Code
-
-VulcanizeDB has shared code built out for building and plugging in event transformers
-
-### [Event Watcher (header sync)](../staging/libraries/shared/watcher/event_watcher.go)
-
-The event watcher is responsible for continuously fetching and delegating chunks of logs and their associated header to the appropriate transformers.
-
-Using the `compose` or `composeAndExecute` command, event watchers can be loaded with plugin event transformers and execute over them.
-
-### [Event Transformer](../staging/libraries/shared/transformer/event_transformer.go)
-
-The event transformer is responsible for converting event logs into more useful data objects and storing them in Postgres.
-The event transformer is composed of converter and repository interfaces and a config struct:
-```go
-type EventTransformer struct {
-	Config     transformer.EventTransformerConfig
-	Converter  Converter
-	Repository Repository
-}
-```
-
-The event transformer executes over provided event logs at a given header.
-
-In this process, the converter unpacks these logs into entities and then converts these entities 
-to their final db models. These models are then written to the Postgres db by the repository.
-
-```go
-func (transformer Transformer) Execute(logs []types.Log, header core.Header, recheckHeaders constants.TransformerExecution) error {
-	transformerName := transformer.Config.TransformerName
-	config := transformer.Config
-
-	if len(logs) < 1 {
-		err := transformer.Repository.MarkHeaderChecked(header.Id)
-		if err != nil {
-			log.Printf("Error marking header as checked in %v: %v", transformerName, err)
-			return err
-		}
-		return nil
-	}
-
-	entities, err := transformer.Converter.ToEntities(config.ContractAbi, logs)
-	if err != nil {
-		log.Printf("Error converting logs to entities in %v: %v", transformerName, err)
-		return err
-	}
-
-	models, err := transformer.Converter.ToModels(entities)
-	if err != nil {
-		log.Printf("Error converting entities to models in %v: %v", transformerName, err)
-		return err
-	}
-
-	err = transformer.Repository.Create(header.Id, models)
-	if err != nil {
-		log.Printf("Error persisting %v record: %v", transformerName, err)
-		return err
-	}
-
-	return nil
-}
-```
-
-
-## Custom Code
-
-In order to watch events at a smart contract, for those events the developer must create:
-
-1. Config - struct to hold configuration information (contract address, starting block, event name and signature).
-1. Entity - struct to unpack the event log into.
-1. Model - struct representing the final data model we want to write to Postgres.
-1. Converter - an interface which can unpack event logs into our entities and convert those entities to our models. 
-1. Repository - an interface to write our models to Postgres.
-1. EventTransformerInitializer - a public variable which exports our configured transformer to be loaded as part of a plugin.
-1. DB migrations - migrations to generate the Postgres schema, tables, views, function, etc that are needed to store and interface with the transformed data models.
-
-The example event we will use looks like: 
-```
-event ExampleEvent(bytes32 indexed arg1, address indexed arg2, bytes32 arg3, uint256 arg4, uint256 arg5);
-```
-
-### Config
-
-The config holds configuration variables for the event transformer, including a name for the transformer, the contract address
-it is working at, the contract's ABI, the topic (e.g. event signature; topic0) that it is filtering for, and starting
-and ending block numbers.
-
-```go
-type EventTransformerConfig struct {
-	TransformerName     string
-	ContractAddresses   []string
-	ContractAbi         string
-	Topic               string
-	StartingBlockNumber int64
-	EndingBlockNumber   int64 // Set -1 for indefinite transformer
-}
-```
-
-### Entity
-
-Entity field names for event arguments need to be exported and match the argument's name and type. LogIndex, 
-TransactionIndex, and the Raw log are retained in order to link the data to it's source for downstream validation.
-
-```go
-type ExampleEntity struct {
-	Arg1             common.Hash
-	Arg2             common.Address
-	Arg3             common.Hash
-	Arg4             *big.Int
-	Arg5             *big.Int
-	LogIndex         uint
-	TransactionIndex uint
-	Raw              types.Log
-}
-```
-
-### Model
-
-Model fields are not constrained by the event log structure.
-This allows us to rename our fields, decode or convert our log values into more useful types, and perform operations 
-with or on the values before persisting the data to Postgres.
-
-```go
-type ExampleModel struct {
-	EventHash         string
-	UserAddress       string
-	FractionSkimmed   string 
-	Surplus           string 
-	Deficit           string
-	FinalPosition     string
-	LogIndex          uint
-	TransactionIndex  uint
-	Raw               types.Log
-}
-```
-
-### Converter
-
-The converter needs to satisfy the interface. One for unpacking logs into the custom defined entities, and
-another for converting those entities to their final db models.
-
-```go
-type Converter interface {
-	ToEntities(contractAbi string, ethLog []types.Log) ([]interface{}, error)
-	ToModels([]interface{}) ([]interface{}, error)
-}
-```
-
-For the example event, this might look like:
-```go
-type ExampleConverter struct{}
-
-func (ExampleConverter) ToEntities(contractAbi string, ethLogs []types.Log) ([]interface{}, error) {
-	var entities []interface{}
-	for _, ethLog := range ethLogs {
-		entity := &ExampleEntity{}
-		address := ethLog.Address
-		abi, err := geth.ParseAbi(contractAbi)
-		if err != nil {
-			return nil, err
-		}
-
-		contract := bind.NewBoundContract(address, abi, nil, nil, nil)
-
-		err = contract.UnpackLog(entity, "ExampleEvent", ethLog)
-		if err != nil {
-			return nil, err
-		}
-
-		entity.Raw = ethLog
-		entity.LogIndex = ethLog.Index
-		entity.TransactionIndex = ethLog.TxIndex
-
-		entities = append(entities, *entity)
-	}
-
-	return entities, nil
-}
-
-func (converter ExampleConverter) ToModels(entities []interface{}) ([]interface{}, error) {
-	var models []interface{}
-	for _, entity := range entities {
-        entity, ok := entity.(ExampleModel)
-        if !ok {
-            return nil, fmt.Errorf("entity of type %T, not %T", entity, ExampleModel{})
-        }
-        
-        fractionSkimmed, err := hexutil.DecodeBig(entity.Arg3.Hex())
-        if err != nil {
-        	reuturn nil, err
-        }
-        position := new(big.Int)
-        position.Sub(entity.Arg4, entity.Arg5)
-        finalPosition := new(big.Int)
-        if preTaxPosition.Sign() < 0 {
-            finalPosition = position
-        } else {
-            skim := new(big.Int)
-            skim.Div(position, fractionSkimmed)
-            finalPosition = position.Sub(position, skim)
-        }
-        
-        rawLog, err := json.Marshal(entity.Raw)
-        if err != nil {
-            return nil, err
-        }
-        
-        model := ExampleModel{
-            EventHash:        entity.Arg1.Hex(),
-            UserAddress:      entity.Arg2.Hex(),
-            FractionSkimmed:  fractionSkimmed.String(), 
-            Surplus:          entity.Arg4.String(),
-            Deficit:          entity.Arg5.String(),
-            FinalPosition:    finalPosition,
-            LogIndex:         entity.LogIndex,
-            TransactionIndex: entity.TransactionIndex,
-            Raw:              rawLog,
-        }
-        models = append(models, model)
-	}
-	return models, nil
-}
-```
-Notice that in this example we have a bytes32 argument in the event that needs to be decoded to an integer before it can be worked with
-to produce our hypothetical `FinalPosition` field. This is to highlight the fact that contracts can and sometimes do encode the
-data types we want to work with into raw bytes. Writing custom transformers with these converters allows us to account for this.
-
-### Repository
-
-The repository needs to satisfy the interface and use the `Create` method to write the model to Postgres.
-```go
-type Repository interface {
-	Create(headerID int64, models []interface{}) error
-	MarkHeaderChecked(headerID int64) error
-	MissingHeaders(startingBlockNumber, endingBlockNumber int64) ([]core.Header, error)
-	RecheckHeaders(startingBlockNumber, endingBlockNUmber int64) ([]core.Header, error)
-	SetDB(db *postgres.DB)
-}
-```
-
-For the example event, this might look like:
-```go
-type ExampleRepository struct {
-	db *postgres.DB
-}
-
-func (repository *ExampleRepository) SetDB(db *postgres.DB) {
-	repository.db = db
-}
-
-func (repository ExampleRepository) Create(headerID int64, models []interface{}) error {
-	tx, dBaseErr := repository.db.Beginx()
-	if dBaseErr != nil {
-		return dBaseErr
-	}
-	for _, model := range models {
-		model, ok := model.(ExampleModel)
-		if !ok {
-			rollbackErr := tx.Rollback()
-			if rollbackErr != nil {
-				log.Error("failed to rollback ", rollbackErr)
-			}
-			return fmt.Errorf("model of type %T, not %T", model, ExampleModel{})
-		}
-		
-		_, execErr := tx.Exec(
-			`INSERT into example_schema.example_event (header_id, event_hash, user_address, fraction_skimmed, surplus, deficit, final_position, log_idx, tx_idx, raw_log)
-        			VALUES($1, $2, $3, $4, $5, $6, $7, $8, $9, $10)
-					ON CONFLICT (header_id, tx_idx, log_idx) DO UPDATE SET event_hash = $2, user_address = $3, fraction_skimmed = $4, surplus = $5, deficit = $6, final_position = $7, raw_log = $10;`,
-			headerID, model.EventHash, model.UserAddress, model.FractonSkimmed, model.Surplus, model.Deficit, model.FinalPosition, model.LogIndex, model.TransactionIndex, model.Raw,
-		)
-		if execErr != nil {
-			rollbackErr := tx.Rollback()
-			if rollbackErr != nil {
-				log.Error("failed to rollback ", rollbackErr)
-			}
-			return execErr
-		}
-	}
-
-	checkHeaderErr := repo.MarkHeaderCheckedInTransaction(headerID, tx, "example_event_checked")
-	if checkHeaderErr != nil {
-		rollbackErr := tx.Rollback()
-		if rollbackErr != nil {
-			log.Error("failed to rollback ", rollbackErr)
-		}
-		return checkHeaderErr
-	}
-
-	return tx.Commit()
-}
-
-func (repository ExampleRepository) MarkHeaderChecked(headerID int64) error {
-	return repo.MarkHeaderChecked(headerID, repository.db, "example_event_checked")
-}
-
-func (repository ExampleRepository) MissingHeaders(startingBlockNumber int64, endingBlockNumber int64) ([]core.Header, error) {
-	return repo.MissingHeaders(startingBlockNumber, endingBlockNumber, repository.db,"example_event_checked")
-}
-
-func (repository ExampleRepository) RecheckHeaders(startingBlockNumber int64, endingBlockNumber int64) ([]core.Header, error) {
-	return repo.RecheckHeaders(startingBlockNumber, endingBlockNumber, repository.db, "example_event_checked")
-}
-```
-
-### EventTransformerInitializer
-
-A transformer initializer variable needs to be exported from somewhere within the transformer repository so that the transformer can be
-loaded as part of a plugin in the `compose` or `composeAndExecute` commands. It is important that this variable is named `EventTransformerInitializer` and
-it must be of `type EventTransformerInitializer func(db *postgres.DB) EventTransformer`.
-
-```go
-var EventTransformerInitializer transformer.EventTransformerInitializer = factories.Transformer{
-	Config:     exampleEventConfig,
-	Converter:  ExampleConverter{},
-	Repository: &ExampleRepository{},
-}.NewTransformer
-```
-
-### DB migrations
-
-We use `goose` as our migration management tool. Any Go data model that needs to be written to Postgres by the
-repository needs a db migration for the corresponding Postgres data model.
-
-Each contract or set of transformers being watched should define its own namespace with a db schema:
-```postgresql
--- +goose Up
-CREATE SCHEMA example_schema;
-
-
--- +goose Down
-DROP SCHEMA example_schema;
-
-```
-
-For the example event and its resulting model, the table we write to would look like:
-```postgresql
--- +goose Up
-CREATE TABLE example_schema.example_event (
-  id               SERIAL PRIMARY KEY,
-  header_id        INTEGER NOT NULL REFERENCES headers (id) ON DELETE CASCADE,
-  event_hash       CHARACTER VARYING(66) NOT NULL,
-  user_address     CHARACTER VARYING(66) NOT NULL,
-  fraction_skimmed NUMERIC NOT NULL,
-  surplus          NUMERIC NOT NULL,
-  deficit          NUMERIC NOT NULL,
-  final_position   NUMERIC NOT NULL,
-  tx_idx           INTEGER NOT NUll,
-  log_idx          INTEGER NOT NUll,
-  raw_log          JSONB,
-  UNIQUE (header_id, tx_idx, log_idx)
-);
-
-ALTER TABLE public.checked_headers
-  ADD COLUMN example_event_checked INTEGER NOT NULL DEFAULT 0;
-
-
--- +goose Down
-DROP TABLE example_schema.example_event;
-
-ALTER TABLE public.checked_headers
-  DROP COLUMN example_event_checked;
-``` 
-
-Notice that we have also added a column to the `checked_headers` table for this event so that we can keep track
-of which headers we have already filtered through for this event.
-
-## Summary
-
-To create a transformer for a contract event we need to create entities for unpacking the raw log, models to represent
-the final data structure, a converter to mediate this unpacking and conversion between entities to models, a repository to write
-these models to Postgres, db migrations to accommodate these models in Postgres, and a EventTransformerInitializer to export the
-configured transformer and load it as a plugin to the `compose` or `composeAndExecute` commands as described in the main readme.

libraries/shared/factories/event/converter.go

@@ -1,24 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package event
-
-import "github.com/ethereum/go-ethereum/core/types"
-
-type Converter interface {
-	ToEntities(contractAbi string, ethLog []types.Log) ([]interface{}, error)
-	ToModels([]interface{}) ([]interface{}, error)
-}

libraries/shared/factories/event/factories_suite_test.go

@@ -1,35 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package event_test
-
-import (
-	"testing"
-
-	. "github.com/onsi/ginkgo"
-	. "github.com/onsi/gomega"
-	log "github.com/sirupsen/logrus"
-	"io/ioutil"
-)
-
-func TestFactories(t *testing.T) {
-	RegisterFailHandler(Fail)
-	RunSpecs(t, "Factories Suite")
-}
-
-var _ = BeforeSuite(func() {
-	log.SetOutput(ioutil.Discard)
-})

libraries/shared/factories/event/repository.go

@@ -1,27 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package event
-
-import (
-	"github.com/vulcanize/vulcanizedb/pkg/datastore/postgres"
-)
-
-type Repository interface {
-	Create(headerID int64, models []interface{}) error
-	MarkHeaderChecked(headerID int64) error
-	SetDB(db *postgres.DB)
-}

libraries/shared/factories/event/transformer.go

@@ -1,79 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package event
-
-import (
-	"github.com/ethereum/go-ethereum/core/types"
-	log "github.com/sirupsen/logrus"
-
-	"github.com/vulcanize/vulcanizedb/libraries/shared/transformer"
-	"github.com/vulcanize/vulcanizedb/pkg/core"
-	"github.com/vulcanize/vulcanizedb/pkg/datastore/postgres"
-)
-
-type Transformer struct {
-	Config     transformer.EventTransformerConfig
-	Converter  Converter
-	Repository Repository
-}
-
-func (transformer Transformer) NewTransformer(db *postgres.DB) transformer.EventTransformer {
-	transformer.Repository.SetDB(db)
-	return transformer
-}
-
-func (transformer Transformer) Execute(logs []types.Log, header core.Header) error {
-	transformerName := transformer.Config.TransformerName
-	config := transformer.Config
-
-	if len(logs) < 1 {
-		err := transformer.Repository.MarkHeaderChecked(header.Id)
-		if err != nil {
-			log.Printf("Error marking header as checked in %v: %v", transformerName, err)
-			return err
-		}
-		return nil
-	}
-
-	entities, err := transformer.Converter.ToEntities(config.ContractAbi, logs)
-	if err != nil {
-		log.Printf("Error converting logs to entities in %v: %v", transformerName, err)
-		return err
-	}
-
-	models, err := transformer.Converter.ToModels(entities)
-	if err != nil {
-		log.Printf("Error converting entities to models in %v: %v", transformerName, err)
-		return err
-	}
-
-	err = transformer.Repository.Create(header.Id, models)
-	if err != nil {
-		log.Printf("Error persisting %v record: %v", transformerName, err)
-		return err
-	}
-
-	return nil
-}
-
-func (transformer Transformer) GetName() string {
-	return transformer.Config.TransformerName
-}
-
-func (transformer Transformer) GetConfig() transformer.EventTransformerConfig {
-	return transformer.Config
-}

libraries/shared/factories/event/transformer_test.go

@@ -1,146 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package event_test
-
-import (
-	"math/rand"
-
-	"github.com/ethereum/go-ethereum/core/types"
-	. "github.com/onsi/ginkgo"
-	. "github.com/onsi/gomega"
-
-	"github.com/vulcanize/vulcanizedb/libraries/shared/factories/event"
-	"github.com/vulcanize/vulcanizedb/libraries/shared/mocks"
-	"github.com/vulcanize/vulcanizedb/libraries/shared/test_data"
-	"github.com/vulcanize/vulcanizedb/libraries/shared/transformer"
-	"github.com/vulcanize/vulcanizedb/pkg/core"
-	"github.com/vulcanize/vulcanizedb/pkg/fakes"
-)
-
-var _ = Describe("Transformer", func() {
-	var (
-		repository mocks.MockRepository
-		converter  mocks.MockConverter
-		t          transformer.EventTransformer
-		headerOne  core.Header
-		config     = test_data.GenericTestConfig
-		logs       = test_data.GenericTestLogs
-	)
-
-	BeforeEach(func() {
-		repository = mocks.MockRepository{}
-		converter = mocks.MockConverter{}
-
-		t = event.Transformer{
-			Repository: &repository,
-			Converter:  &converter,
-			Config:     config,
-		}.NewTransformer(nil)
-
-		headerOne = core.Header{Id: rand.Int63(), BlockNumber: rand.Int63()}
-	})
-
-	It("sets the db", func() {
-		Expect(repository.SetDbCalled).To(BeTrue())
-	})
-
-	It("marks header checked if no logs returned", func() {
-		err := t.Execute([]types.Log{}, headerOne)
-
-		Expect(err).NotTo(HaveOccurred())
-		repository.AssertMarkHeaderCheckedCalledWith(headerOne.Id)
-	})
-
-	It("doesn't attempt to convert or persist an empty collection when there are no logs", func() {
-		err := t.Execute([]types.Log{}, headerOne)
-
-		Expect(err).NotTo(HaveOccurred())
-		Expect(converter.ToEntitiesCalledCounter).To(Equal(0))
-		Expect(converter.ToModelsCalledCounter).To(Equal(0))
-		Expect(repository.CreateCalledCounter).To(Equal(0))
-	})
-
-	It("does not call repository.MarkCheckedHeader when there are logs", func() {
-		err := t.Execute(logs, headerOne)
-
-		Expect(err).NotTo(HaveOccurred())
-		repository.AssertMarkHeaderCheckedNotCalled()
-	})
-
-	It("returns error if marking header checked returns err", func() {
-		repository.SetMarkHeaderCheckedError(fakes.FakeError)
-
-		err := t.Execute([]types.Log{}, headerOne)
-
-		Expect(err).To(HaveOccurred())
-		Expect(err).To(MatchError(fakes.FakeError))
-	})
-
-	It("converts an eth log to an entity", func() {
-		err := t.Execute(logs, headerOne)
-
-		Expect(err).NotTo(HaveOccurred())
-		Expect(converter.ContractAbi).To(Equal(config.ContractAbi))
-		Expect(converter.LogsToConvert).To(Equal(logs))
-	})
-
-	It("returns an error if converter fails", func() {
-		converter.ToEntitiesError = fakes.FakeError
-
-		err := t.Execute(logs, headerOne)
-
-		Expect(err).To(HaveOccurred())
-		Expect(err).To(MatchError(fakes.FakeError))
-	})
-
-	It("converts an entity to a model", func() {
-		converter.EntitiesToReturn = []interface{}{test_data.GenericEntity{}}
-
-		err := t.Execute(logs, headerOne)
-
-		Expect(err).NotTo(HaveOccurred())
-		Expect(converter.EntitiesToConvert[0]).To(Equal(test_data.GenericEntity{}))
-	})
-
-	It("returns an error if converting to models fails", func() {
-		converter.EntitiesToReturn = []interface{}{test_data.GenericEntity{}}
-		converter.ToModelsError = fakes.FakeError
-
-		err := t.Execute(logs, headerOne)
-
-		Expect(err).To(HaveOccurred())
-		Expect(err).To(MatchError(fakes.FakeError))
-	})
-
-	It("persists the record", func() {
-		converter.ModelsToReturn = []interface{}{test_data.GenericModel{}}
-
-		err := t.Execute(logs, headerOne)
-
-		Expect(err).NotTo(HaveOccurred())
-		Expect(repository.PassedHeaderID).To(Equal(headerOne.Id))
-		Expect(repository.PassedModels[0]).To(Equal(test_data.GenericModel{}))
-	})
-
-	It("returns error if persisting the record fails", func() {
-		repository.SetCreateError(fakes.FakeError)
-		err := t.Execute(logs, headerOne)
-
-		Expect(err).To(HaveOccurred())
-		Expect(err).To(MatchError(fakes.FakeError))
-	})
-})

libraries/shared/factories/storage/EXAMPLE.md

@@ -1,167 +0,0 @@
-# Storage Transformer Example
-
-In the Storage Transformer README, we went over code that needs to be written to add a new storage transformer to VulcanizeDB.
-In this document, we'll go over an example contract and discuss how one would go about watching its storage.
-
-## Example Contract
-
-For the purposes of this document, we'll be assuming that we're interested in watching the following contract:
-
-```solidity
-pragma solidity ^0.5.1;
-
-contract Contract {
-  uint256 public num_addresses;
-  mapping(address => uint) public addresses;
-  
-  event AddressAdded(
-    address addr,
-    uint256 num_addrs
-  );
-  
-  constructor() public {
-    addresses[msg.sender] = 1;
-    num_addresses = 1;
-  }
-  
-  function add_address(address addr) public {
-    bool exists = addresses[addr] > 0;
-    addresses[addr]++;
-    if (!exists) {
-      emit AddressAdded(addr, ++num_addresses);
-    }
-  }
-}
-```
-
-Disclaimer: this contract has not been audited and is not intended to be modeled or used in production. :)
-
-This contract persists two values in its storage:
-
-1. `num_addresses`: the total number of unique addresses known to the contract.
-2. `addresses`: a mapping that records the number of times an address has been added to the contract.
-
-It also emits an event each time a new address is added into the contract's storage.
-
-## Custom Code
-
-In order to monitor the state of this smart contract, we'd need to implement: an event transformer, a mappings namespace, and a repository.
-We will go through each of these in turn.
-
-### Event Transformer
-
-Given that the contract's storage includes a mapping, `addresses`, we will need to be able to identify the keys to that mapping that exist in the system so that we can recognize contract storage keys that correspond to non-zero values in that mapping.
-
-The simplest way to be aware of keys used in a contract's mapping is to listen for contract events that emit the keys that are used in its mapping(s).
-Since this contract includes an event, `AddressAdded`, that is emitted each time a new address is added to the `addresses` mapping, we will want to listen for those events and cache the adddresses that map to non-zero values.
-
-Please see the event transformer README for detailed instructions about developing this code.
-In short, it should be feasible to recognize `AddressAdded` events on the blockchain and parse them to keep a record of addresses that have been added to the system.
-
-### Mappings
-
-If we point an ethereum node at a blockchain hosting this contract and our node is equipped to write out storage changes happening on this contract, we will expect such changes to appear each time `add_address` (which modifies the `addresses` mapping) is called.
-
-In order for those changes - which include raw hex versions of storage keys and storage values, to be useful for us - we need to know how to recognize and parse them.
-Our mappings file should assist us with both of these tasks: the `Lookup` function should recognize raw storage keys and return known metadata about the storage value.
-
-In order to perform this lookup, the mappings file should maintain its own mapping of known storage keys to the corresponding storage value metadata.
-This internal mapping should contain the storage key for `num_addresses` as well as a storage key for each `addresses` key known to be associated with a non-zero value.
-
-#### num_addresses
-
-`num_addresses` is the first variable declared on the contract, and it is a simple (non-array, non-mapping) type.
-Therefore, we know that its storage key is `0000000000000000000000000000000000000000000000000000000000000000`.
-The storage key for non-array and non-mapping variables is (usually*) the index of the variable on the contract's storage.
-If we see a storage diff being emitted from this contract with this storage key, we know that the `num_addresses` variable has been modified.
-
-In this case, we would expect that the call `mappings.Lookup("0000000000000000000000000000000000000000000000000000000000000000")` would return metadata corresponding to the `num_addresses` variable.
-This metadata would probably look something like:
-
-```golang
-shared.StorageValueMetadata{
-    Name: "num_addresses",
-    Keys: nil,
-    Type: shared.Uint256,
-}
-```
-
-<sup>*</sup> Occasionally, multiple variables may be packed into one storage slot, which complicates a direct translation of the index of the variable on the contract to its storage key.
-
-#### addresses
-
-`addresses` is the second variable declared on the contract, but it is a mapping.
-Since it is a mapping, the storage key is more complex than `0000000000000000000000000000000000000000000000000000000000000001` (which would be the key for the variable if it were not an array or mapping).
-Having a single storage slot for an entire mapping would not work, since there can be an arbitrary number of entries in a mapping, and a single storage value slot is constrained to 32 bytes.
-
-The way that smart contract mappings are maintained in storage (in Solidity) is by creating a new storage key/value pair for each entry in the mapping, where the storage key is a hash of the occupied slot's key concatenated with the mapping's index on the contract.
-Given an occupied slot's key, `k`, and a mapping's index on the contract, `i`, we can generate the storage key with the following code:
-
-```golang
-func GetMappingStorageKey(k, i string) string {
-    return common.BytesToHash(crypto.Keccak256(common.FromHex(k + i))).Hex()
-}
-```
-
-If we were to call the contract's `add_address` function with `0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe`, we would expect to see an `AddressAdded` event emitted, with `0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe` in its payload.
-From that event, we would know that there exists in the contract's storage a storage key of:
-
-```golang
-GetMappingStorageKey("0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe", "0000000000000000000000000000000000000000000000000000000000000001")
-```
-
-Executing the above code results in: `0x0f96a1133cfd5b94c329aa0526b5962bd791dbbfc481ca82f7d4a439e1e9bc40`.
-
-Therefore, the first time `add_address` was called for this address, we would also expect to see a storage diff with a key of `0x0f96a1133cfd5b94c329aa0526b5962bd791dbbfc481ca82f7d4a439e1e9bc40` and a value of `0000000000000000000000000000000000000000000000000000000000000001`.
-This would be the indication that in contract storage, the address `0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe` maps to the value 1.
-
-Given that we knew this address was a key in the mapping from our event transformer, we would expect a call to `mappings.Lookup("0x0f96a1133cfd5b94c329aa0526b5962bd791dbbfc481ca82f7d4a439e1e9bc40")` to return metadata corresponding to _this slot_ in the addresses mapping:
-
-```golang
-shared.StorageValueMetadata{
-    Name: "addresses,
-    Keys: map[Key]string{Address: "0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe"},
-    Type: shared.Uint256,
-}
-```
-
-### Repository
-
-Once we have recognized a storage diff, we can decode the storage value to the data's known type.
-Since the metadata tells us that the above values are `uint256`, we can decode a value like `0000000000000000000000000000000000000000000000000000000000000001` to `1`.
-
-The purpose of the contract-specific repository is to write that value to the database in a way that makes it useful for future queries.
-Typically, this involves writing the block hash, block number, decoded value, and any keys in the metadata to a table.
-
-The current repository interface has a generalized `Create` function that can accept any arbitrary storage row along with its metadata.
-This is deliberate, to facilitate shared use of the common storage transformer.
-An implication of this decision is that the `Create` function typically includes a `switch` statement that selects which table to write to, as well as what data to include, based on the name of the variable as defined in the metadata.
-
-An example implementation of `Create` for our example contract above might look like:
-
-```golang
-func (repository AddressStorageRepository) Create(blockNumber int, blockHash string, metadata shared.StorageValueMetadata, value interface{}) error {
-    switch metadata.Name {
-    case "num_addresses":
-        _, err := repository.db.Exec(`INSERT INTO storage.num_addresses (block_hash, block_number, n) VALUES ($1, $2, $3)`,
-            blockHash, blockNumber, value)
-        return err
-    case "addresses":
-        _, err := repository.db.Exec(`INSERT INTO storage.addresses (block_hash, block_number, address, n) VALUES ($1, $2, $3, $4)`,
-            blockHash, blockNumber, metadata.Keys[Address], value)
-        return err
-    default:
-        panic(fmt.Sprintf("unrecognized contract storage name: %s", metadata.Name))
-    }
-}
-```
-
-## Summary
-
-With our very simple address storing contract, we would be able to read its storage diffs by implementing an event transformer, a mappings, and a repository.
-
-The mappings would be able to lookup storage keys reflecting `num_addresses` or any slot in `addresses`, using addresses derived from watching the `AddressAdded` event for the latter.
-
-The repository would be able to persist the value or `num_addresses` or any slot in `addresses`, using metadata returned from the mappings.
-
-The mappings and repository could be plugged into the common storage transformer, enabling us to know the contract's state as it is changing.

libraries/shared/factories/storage/README.md

@@ -1,124 +0,0 @@
-# Watching Contract Storage
-
-One approach VulcanizeDB takes to caching and indexing smart contracts is to ingest raw contract storage values.
-Assuming that you are running an ethereum node that is writing contract storage changes to a CSV file, VulcanizeDB can parse them and persist the results to postgres.
-
-## Assumptions
-
-The current approach for caching smart contract storage diffs assumes that you are running a node that is writing contract storage diffs to a CSV file.
-The CSV file is expected to have 5 columns: contract address, block hash, block number, storage key, storage value.
-
-We have [a branch on vulcanize/parity-ethereum](https://github.com/vulcanize/parity-ethereum/tree/watch-storage-diffs) that enables running a node that writes storage diffs this way.
-
-Looking forward, we would like to isolate this assumption as much as possible.
-We may end up needing to read CSV data that is formatted differently, or reading data from a non-CSV source, and we do not want resulting changes to cascade throughout the codebase.
-
-## Shared Code
-
-VulcanizeDB has shared code for continuously reading from the CSV file written by the ethereum node and writing a parsed version of each row to postgres.
-
-### Storage Watcher
-
-The storage watcher is responsible for continuously delegating CSV rows to the appropriate transformer as they are being written by the ethereum node.
-It maintains a mapping of contract addresses to transformers, and will ignore storage diff rows for contract addresses that do not have a corresponding transformer.
-
-Storage watchers can be loaded with plugin storage transformers and executed using the `composeAndExecute` command.
-
-### Storage Transformer
-
-The storage transformer is responsible for converting raw contract storage hex values into useful data and writing them to postgres.
-The storage transformer depends on contract-specific implementations of code capable of recognizing storage keys and writing the matching (decoded) storage value to disk.
-
-```golang
-func (transformer Transformer) Execute(row shared.StorageDiffRow) error {
-	metadata, lookupErr := transformer.Mappings.Lookup(row.StorageKey)
-	if lookupErr != nil {
-		return lookupErr
-	}
-	value, decodeErr := shared.Decode(row, metadata)
-	if decodeErr != nil {
-		return decodeErr
-	}
-	return transformer.Repository.Create(row.BlockHeight, row.BlockHash.Hex(), metadata, value)
-}
-```
-
-## Custom Code
-
-In order to watch an additional smart contract, a developer must create three things:
-
-1. Mappings - specify how to identify keys in the contract's storage trie.
-1. Repository - specify how to persist a parsed version of the storage value matching the recognized storage key.
-1. Instance - create an instance of the storage transformer that uses your mappings and repository.
-
-### Mappings
-
-```golang
-type Mappings interface {
-	Lookup(key common.Hash) (shared.StorageValueMetadata, error)
-	SetDB(db *postgres.DB)
-}
-```
-
-A contract-specific implementation of the mappings interface enables the storage transformer to fetch metadata associated with a storage key.
-
-Storage metadata contains: the name of the variable matching the storage key, a raw version of any keys associated with the variable (if the variable is a mapping), and the variable's type.
-
-```golang
-type StorageValueMetadata struct {
-	Name string
-	Keys map[Key]string
-	Type ValueType
-}
-```
-
-Keys are only relevant if the variable is a mapping. For example, in the following Solidity code:
-
-```solidity
-pragma solidity ^0.4.0;
-
-contract Contract {
-  uint x;
-  mapping(address => uint) y;
-}
-```
-
-The metadata for variable `x` would not have any associated keys, but the metadata for a storage key associated with `y` would include the address used to specify that key's index in the mapping.
-
-The `SetDB` function is required for the mappings to connect to the database.
-A database connection may be desired when keys in a mapping variable need to be read from log events (e.g. to lookup what addresses may exist in `y`, above).
-
-### Repository
-
-```golang
-type Repository interface {
-	Create(blockNumber int, blockHash string, metadata shared.StorageValueMetadata, value interface{}) error
-	SetDB(db *postgres.DB)
-}
-```
-
-A contract-specific implementation of the repository interface enables the transformer to write the decoded storage value to the appropriate table in postgres.
-
-The `Create` function is expected to recognize and persist a given storage value by the variable's name, as indicated on the row's metadata.
-Note: we advise silently discarding duplicates in `Create` - as it's possible that you may read the same diff several times, and an error will trigger the storage watcher to queue that diff for later processing.
-
-The `SetDB` function is required for the repository to connect to the database.
-
-### Instance
-
-```golang
-type Transformer struct {
-	Address    common.Address
-	Mappings   storage_diffs.Mappings
-	Repository storage_diffs.Repository
-}
-```
-
-A new instance of the storage transformer is initialized with the contract-specific mappings and repository, as well as the contract's address.
-The contract's address is included so that the watcher can query that value from the transformer in order to build up its mapping of addresses to transformers.
-
-## Summary
-
-To begin watching an additional smart contract, create a new mappings file for looking up storage keys on that contract, a repository for writing storage values from the contract, and initialize a new storage transformer instance with the mappings, repository, and contract address.
-
-The new instance, wrapped in an initializer that calls `SetDB` on the mappings and repository, should be passed to the `AddTransformers` function on the storage watcher.

libraries/shared/factories/storage/storage_suite_test.go

@@ -1,29 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package storage_test
-
-import (
-	"testing"
-
-	. "github.com/onsi/ginkgo"
-	. "github.com/onsi/gomega"
-)
-
-func TestStorage(t *testing.T) {
-	RegisterFailHandler(Fail)
-	RunSpecs(t, "Storage Factories Suite")
-}

libraries/shared/factories/storage/transformer.go

@@ -1,55 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package storage
-
-import (
-	"github.com/ethereum/go-ethereum/common"
-
-	"github.com/vulcanize/vulcanizedb/libraries/shared/repository"
-	"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 Transformer struct {
-	Address    common.Address
-	Mappings   storage.Mappings
-	Repository repository.StorageRepository
-}
-
-func (transformer Transformer) NewTransformer(db *postgres.DB) transformer.StorageTransformer {
-	transformer.Mappings.SetDB(db)
-	transformer.Repository.SetDB(db)
-	return transformer
-}
-
-func (transformer Transformer) ContractAddress() common.Address {
-	return transformer.Address
-}
-
-func (transformer Transformer) Execute(row utils.StorageDiffRow) error {
-	metadata, lookupErr := transformer.Mappings.Lookup(row.StorageKey)
-	if lookupErr != nil {
-		return lookupErr
-	}
-	value, decodeErr := utils.Decode(row, metadata)
-	if decodeErr != nil {
-		return decodeErr
-	}
-	return transformer.Repository.Create(row.BlockHeight, row.BlockHash.Hex(), metadata, value)
-}

libraries/shared/factories/storage/transformer_test.go

@@ -1,153 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package storage_test
-
-import (
-	"github.com/ethereum/go-ethereum/common"
-	. "github.com/onsi/ginkgo"
-	. "github.com/onsi/gomega"
-
-	"github.com/vulcanize/vulcanizedb/libraries/shared/factories/storage"
-	"github.com/vulcanize/vulcanizedb/libraries/shared/mocks"
-	"github.com/vulcanize/vulcanizedb/libraries/shared/storage/utils"
-	"github.com/vulcanize/vulcanizedb/pkg/fakes"
-)
-
-var _ = Describe("Storage transformer", func() {
-	var (
-		mappings   *mocks.MockMappings
-		repository *mocks.MockStorageRepository
-		t          storage.Transformer
-	)
-
-	BeforeEach(func() {
-		mappings = &mocks.MockMappings{}
-		repository = &mocks.MockStorageRepository{}
-		t = storage.Transformer{
-			Address:    common.Address{},
-			Mappings:   mappings,
-			Repository: repository,
-		}
-	})
-
-	It("returns the contract address being watched", func() {
-		fakeAddress := common.HexToAddress("0x12345")
-		t.Address = fakeAddress
-
-		Expect(t.ContractAddress()).To(Equal(fakeAddress))
-	})
-
-	It("looks up metadata for storage key", func() {
-		t.Execute(utils.StorageDiffRow{})
-
-		Expect(mappings.LookupCalled).To(BeTrue())
-	})
-
-	It("returns error if lookup fails", func() {
-		mappings.LookupErr = fakes.FakeError
-
-		err := t.Execute(utils.StorageDiffRow{})
-
-		Expect(err).To(HaveOccurred())
-		Expect(err).To(MatchError(fakes.FakeError))
-	})
-
-	It("creates storage row with decoded data", func() {
-		fakeMetadata := utils.StorageValueMetadata{Type: utils.Address}
-		mappings.Metadata = fakeMetadata
-		rawValue := common.HexToAddress("0x12345")
-		fakeBlockNumber := 123
-		fakeBlockHash := "0x67890"
-		fakeRow := utils.StorageDiffRow{
-			Contract:     common.Address{},
-			BlockHash:    common.HexToHash(fakeBlockHash),
-			BlockHeight:  fakeBlockNumber,
-			StorageKey:   common.Hash{},
-			StorageValue: rawValue.Hash(),
-		}
-
-		err := t.Execute(fakeRow)
-
-		Expect(err).NotTo(HaveOccurred())
-		Expect(repository.PassedBlockNumber).To(Equal(fakeBlockNumber))
-		Expect(repository.PassedBlockHash).To(Equal(common.HexToHash(fakeBlockHash).Hex()))
-		Expect(repository.PassedMetadata).To(Equal(fakeMetadata))
-		Expect(repository.PassedValue.(string)).To(Equal(rawValue.Hex()))
-	})
-
-	It("returns error if creating row fails", func() {
-		rawValue := common.HexToAddress("0x12345")
-		fakeMetadata := utils.StorageValueMetadata{Type: utils.Address}
-		mappings.Metadata = fakeMetadata
-		repository.CreateErr = fakes.FakeError
-
-		err := t.Execute(utils.StorageDiffRow{StorageValue: rawValue.Hash()})
-
-		Expect(err).To(HaveOccurred())
-		Expect(err).To(MatchError(fakes.FakeError))
-	})
-
-	Describe("when a storage row contains more than one item packed in storage", func() {
-		var (
-			rawValue        = common.HexToAddress("000000000000000000000000000000000000000000000002a300000000002a30")
-			fakeBlockNumber = 123
-			fakeBlockHash   = "0x67890"
-			packedTypes     = make(map[int]utils.ValueType)
-		)
-		packedTypes[0] = utils.Uint48
-		packedTypes[1] = utils.Uint48
-
-		var fakeMetadata = utils.StorageValueMetadata{
-			Name:        "",
-			Keys:        nil,
-			Type:        utils.PackedSlot,
-			PackedTypes: packedTypes,
-		}
-
-		It("passes the decoded data items to the repository", func() {
-			mappings.Metadata = fakeMetadata
-			fakeRow := utils.StorageDiffRow{
-				Contract:     common.Address{},
-				BlockHash:    common.HexToHash(fakeBlockHash),
-				BlockHeight:  fakeBlockNumber,
-				StorageKey:   common.Hash{},
-				StorageValue: rawValue.Hash(),
-			}
-
-			err := t.Execute(fakeRow)
-
-			Expect(err).NotTo(HaveOccurred())
-			Expect(repository.PassedBlockNumber).To(Equal(fakeBlockNumber))
-			Expect(repository.PassedBlockHash).To(Equal(common.HexToHash(fakeBlockHash).Hex()))
-			Expect(repository.PassedMetadata).To(Equal(fakeMetadata))
-			expectedPassedValue := make(map[int]string)
-			expectedPassedValue[0] = "10800"
-			expectedPassedValue[1] = "172800"
-			Expect(repository.PassedValue.(map[int]string)).To(Equal(expectedPassedValue))
-		})
-
-		It("returns error if creating a row fails", func() {
-			mappings.Metadata = fakeMetadata
-			repository.CreateErr = fakes.FakeError
-
-			err := t.Execute(utils.StorageDiffRow{StorageValue: rawValue.Hash()})
-
-			Expect(err).To(HaveOccurred())
-			Expect(err).To(MatchError(fakes.FakeError))
-		})
-	})
-})

libraries/shared/fetcher/fetcher_suite_test.go

@@ -1,35 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package fetcher_test
-
-import (
-	"testing"
-
-	. "github.com/onsi/ginkgo"
-	. "github.com/onsi/gomega"
-	log "github.com/sirupsen/logrus"
-	"io/ioutil"
-)
-
-func TestFactories(t *testing.T) {
-	RegisterFailHandler(Fail)
-	RunSpecs(t, "Shared Fetcher Suite")
-}
-
-var _ = BeforeSuite(func() {
-	log.SetOutput(ioutil.Discard)
-})

libraries/shared/fetcher/log_fetcher.go

@@ -1,58 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-package fetcher
-
-import (
-	"github.com/ethereum/go-ethereum"
-	"github.com/ethereum/go-ethereum/common"
-	"github.com/ethereum/go-ethereum/core/types"
-
-	"github.com/vulcanize/vulcanizedb/pkg/core"
-)
-
-type ILogFetcher interface {
-	FetchLogs(contractAddresses []common.Address, topics []common.Hash, missingHeader core.Header) ([]types.Log, error)
-}
-
-type LogFetcher struct {
-	blockChain core.BlockChain
-}
-
-func NewLogFetcher(blockchain core.BlockChain) *LogFetcher {
-	return &LogFetcher{
-		blockChain: blockchain,
-	}
-}
-
-// Checks all topic0s, on all addresses, fetching matching logs for the given header
-func (logFetcher LogFetcher) FetchLogs(addresses []common.Address, topic0s []common.Hash, header core.Header) ([]types.Log, error) {
-	blockHash := common.HexToHash(header.Hash)
-	query := ethereum.FilterQuery{
-		BlockHash: &blockHash,
-		Addresses: addresses,
-		// Search for _any_ of the topics in topic0 position; see docs on `FilterQuery`
-		Topics: [][]common.Hash{topic0s},
-	}
-
-	logs, err := logFetcher.blockChain.GetEthLogsWithCustomQuery(query)
-	if err != nil {
-		// TODO review aggregate fetching error handling
-		return []types.Log{}, err
-	}
-
-	return logs, nil
-}