Server backend for indexed ETH IPLD objects
Go to file
2017-12-04 17:04:06 -06:00
cmd Rename watched_contracts package to contract_summary 2017-12-04 17:04:06 -06:00
db Store contract ABI on watched_contracts 2017-12-04 14:13:15 -06:00
environments Move environment configuration to root 2017-11-14 09:10:48 -06:00
Gododir Require ABI filepath for watching a contract 2017-12-04 15:12:27 -06:00
integration_test Contract hist (#84) 2017-12-04 12:54:33 -06:00
pkg Rename watched_contracts package to contract_summary 2017-12-04 17:04:06 -06:00
scripts Add contracts table / start building out watch contracts 2017-11-09 15:06:01 -06:00
.gitignore Add function to get string state attributes for a given contract 2017-11-27 15:18:04 -06:00
.private_blockchain_password Add integration test 2017-10-24 15:36:50 -05:00
.travis.yml Update .travis.yml so that integration tests run 2017-11-29 14:39:59 -06:00
Gopkg.lock Updated to use contracts derived Attributes 2017-11-28 13:43:08 -06:00
Gopkg.toml Add BlockchainDBObserver 2017-10-25 15:57:05 -05:00
LICENSE Add LICENSE 2017-11-09 12:58:17 -06:00
README.md Update README to include contract summary usage 2017-11-28 15:14:05 -06:00

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. go get github.com/ethereum/go-ethereum
    • This will take a while and gives poor indication of progress.
  4. go install github.com/ethereum/go-ethereum/cmd/geth
  5. cd $GOPATH/src/github.com/8thlight/vulcanizedb
  6. 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

Running Listener

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

Retrieving Historical Data

  1. Start a blockchain.
  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. 2. Start watching the contract godo watchContract -- --environment=<some-environment> --contract-hash=<contract-address> 3. 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

Integration Test

In order to run the integration tests, you will need to run them against a real blockchain.

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

Unit Tests

  1. go test ./pkg/...