cerc-io/ipld-eth-server
18
0
Fork 1
Code Issues 10 Pull Requests 1 Actions Packages Projects Releases 37 Wiki Activity
Server backend for indexed ETH IPLD objects
48 Commits 12 Branches 52 Tags 80 MiB
Go 97.9%
JavaScript 1.4%
Shell 0.4%
Dockerfile 0.3%
d2920e7acf
Go to file
Matt K d2920e7acf Add index on block_number column (#43)
2017-11-01 08:52:04 -05:00
core Refactor block conversion (#38) 2017-10-31 12:51:05 -05:00
fakes Add integration test 2017-10-24 15:36:50 -05:00
integration_test Refactor block conversion (#38) 2017-10-31 12:51:05 -05:00
migrations Add index on block_number column (#43) 2017-11-01 08:52:04 -05:00
scripts Add scripts to help with migrations 2017-10-27 14:20:22 -05:00
.gitignore Update locked dependencies 2017-10-25 13:29:12 -05:00
.private_blockchain_password Add integration test 2017-10-24 15:36:50 -05:00
.travis.yml Revert "Remove Travis" 2017-10-31 09:03:13 -05:00
Gopkg.lock Add BlockchainDBObserver 2017-10-25 15:57:05 -05:00
Gopkg.toml Add BlockchainDBObserver 2017-10-25 15:57:05 -05:00
main.go Add BlockchainDBObserver 2017-10-25 15:57:05 -05:00
README.md Revert "Remove Travis indicator from README" 2017-10-31 09:13:47 -05:00

README.md

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 Development Database

  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
  6. cd $GOPATH/src/github.com/8thlight/vulcanizedb
  7. ./scripts/migrate

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.

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 start the listener below

Running Listener

  1. Start a blockchain.
  2. In a separate terminal start listener (ipcDir location)
    • go run main.go --ipcPath /path/to/file.ipc

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 ./...

Unit Tests

  1. go test ./core