| cmd | ||
| db | ||
| environments | ||
| integration_test | ||
| libraries/shared | ||
| pkg | ||
| scripts | ||
| test_config | ||
| utils | ||
| vendor | ||
| .gitignore | ||
| .private_blockchain_password | ||
| .travis.yml | ||
| Gopkg.lock | ||
| Gopkg.toml | ||
| LICENSE | ||
| main.go | ||
| Makefile | ||
| README.md | ||
Vulcanize DB
Dependencies
- Go 1.9+
- Postgres 10
- Ethereum Node
- Go Ethereum (1.8+)
- Parity 1.8.11+
Installation
go get github.com/vulcanize/vulcanizedb
Setting up the Databases
-
Install Postgres
-
Create a superuser for yourself and make sure
psql --listworks without prompting for a password. -
createdb vulcanize_private -
cd $GOPATH/src/github.com/vulcanize/vulcanizedb -
Import the schema:
psql vulcanize_private < db/schema.sqlor run the migrations:
make migrate HOST_NAME=localhost NAME=vulcanize_public PORT=5432- See below for configuring additional environments
IPC File Paths
The default location for Ethereum is:
$HOME/Library/Ethereumfor Mac$HOME/.ethereumfor Ubuntu$GOPATH/src/gihub.com/vulcanize/vulcanizedb/test_data_dir/geth.ipcfor private node.
Note the location of the ipc file is printed to the console when you start geth. It is needed to for configuration
Start syncing with postgres
-
Start geth node (if fast syncing wait for geth to finsh initial sync)
-
In a separate terminal start vulcanize_db
vulcanizedb sync --config <config.toml> --starting-block-number <block-number>
- see
./environmentsfor example config
Running the Tests
Unit Tests
go test ./pkg/...
Integration Test
-
Run
make startprivatein a separate terminal -
Setup a test database and import the schema:
createdb vulcanize_privatepsql vulcanize_private < db/schema.sql -
go test ./...to run all tests.