ipld-eth-server/README.md
Matt K c00b8a5a98 Add Filters (#133)
* Add LogFilter struct

* Add log_filters table

* Add view for events watching

* Add cmd line "add_filter" to mimic eventual endpoint

* Allow multiple filters in config
2018-01-23 12:43:35 -06:00

4.2 KiB

Vulcanize DB

Build Status

Development Setup

Dependencies

Cloning the Repository

  1. git config --global url."git@github.com:".insteadOf "https://github.com/"
    • By default, go get does not work for private GitHub repos. This will fix that.
  2. go get github.com/8thlight/vulcanizedb
  3. cd $GOPATH/src/github.com/8thlight/vulcanizedb
  4. dep ensure

Setting up the Databases

  1. Install Postgres
  2. Create a superuser for yourself and make sure psql --list works without prompting for a password.
  3. go get -u -d github.com/mattes/migrate/cli github.com/lib/pq
  4. go build -tags 'postgres' -o /usr/local/bin/migrate github.com/mattes/migrate/cli
  5. createdb vulcanize_private
  6. cd $GOPATH/src/github.com/8thlight/vulcanizedb
  7. godo migrate -- --environment=<some-environment>
    • See below for configuring additional environments

Adding a new migration: ./scripts/create_migration <migration-name>

Creating/Using a Private Blockchain

Syncing the public blockchain takes many hours for the initial sync and will download 20+ GB of data. Here are some instructions for creating a private blockchain that does not depend on having a network connection.

  1. Run ./scripts/setup to create a private blockchain with a new account.
    • This will result in a warning.
  2. Run ./scripts/start_private_blockchain.
  3. Run godo run -- --environment=private to start listener.

Connecting to the Public Blockchain

./scripts/start_blockchain

IPC File Paths

The default location for Ethereum is:

  • $HOME/Library/Ethereum for Mac
  • $HOME/.ethereum for Ubuntu
  • $GOPATH/src/gihub.com/8thlight/vulcanizedb/test_data_dir/geth.ipc for private blockchain.

Note the location of the ipc file is outputted when you connect to a blockchain. It is needed to for configuration

Start Vulcanize DB

  1. Start geth
  2. In a separate terminal start vulcanize_db
    • godo vulcanizeDb -- --environment=<some-environment>

Watch contract events

  1. Start geth
  2. In a separate terminal start vulcanize_db
    • godo vulcanizeDb -- --environment=<some-environment>
  3. Create event filter
    • godo watchEvent -- --environment=<some-environment> --filter-filepath=<filters/example-filer.json>

Running Listener

  1. Start geth
  2. In a separate terminal start listener (ipcDir location)
    • godo run -- --environment=<some-environment>

Retrieving Historical Data

  1. Start geth
  2. In a separate terminal start listener (ipcDir location)
    • godo populateBlocks -- --environment=<some-environment> --starting-number=<starting-block-number>

Retrieve Contract Attributes

  1. Add contract ABI to contracts / environment directory:
vulcanizedb/
    contracts/
        public/
            <contract-address>.json
        private/

The name of the JSON file should correspond the contract's address.

  1. Start watching the contract godo watchContract -- --environment=<some-environment> --contract-hash=<contract-address>
  2. Request summary data godo showContractSummary -- --environment=<some-environment> --contract-hash=<contract-address>

Configuring Additional Environments

You can create configuration files for additional environments.

  • Among other things, it will require the IPC file path
  • See environments/private.toml for an example
  • You will need to do this if you want to run a node connecting to the public blockchain

Running the Tests

Unit Tests

  1. go test ./pkg/...

Integration Test

In order to run the integration tests, you will need to run them against a real blockchain. At the moment the integration tests require Geth v1.7.2 as they depend on the --dev mode, which changed in v1.7.3

  1. Run ./scripts/start_private_blockchain as a separate process.
  2. go test ./... to run all tests.