79 lines
3.3 KiB
Markdown
79 lines
3.3 KiB
Markdown
# Vulcanize DB
|
|
|
|
[](https://gitter.im/vulcanizeio/VulcanizeDB?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
[](https://travis-ci.org/vulcanize/vulcanizedb)
|
|
|
|
## About
|
|
|
|
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.
|
|
|
|
## Dependencies
|
|
- Go 1.9+
|
|
- Postgres 10
|
|
- Ethereum Node
|
|
- [Go Ethereum](https://ethereum.github.io/go-ethereum/downloads/) (1.8+)
|
|
- [Parity 1.8.11+](https://github.com/paritytech/parity/releases)
|
|
|
|
## Installation
|
|
`go get github.com/vulcanize/vulcanizedb`
|
|
|
|
## 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`
|
|
|
|
* See below for configuring additional environments
|
|
|
|
## Configuration
|
|
- 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:
|
|
- when using 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: `$HOME/Library/Ethereum`
|
|
- Linux: `$HOME/.ethereum`
|
|
|
|
- when using parity:
|
|
- The IPC file is called `jsonrpc.ipc`.
|
|
- The default location is:
|
|
- Mac: `$HOME/Library/Application\ Support/io.parity.ethereum/`
|
|
- Linux: `$HOME/.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: `$HOME/Library/Ethereum/geth/chaindata`
|
|
- Linux: `$HOME/.ethereum/geth/chaindata`
|
|
- `levelDbPath` is irrelevant (and `coldImport` is currently unavailable) if only running parity.
|
|
|
|
- See `environments/infura.toml` to configure commands to run against infura, if a local node is unavailable
|
|
|
|
## Start syncing with postgres
|
|
Syncs VulcanizeDB with the configured Ethereum node.
|
|
1. Start node (**if fast syncing wait for initial sync to finish**)
|
|
1. In a separate terminal start vulcanize_db
|
|
- `./vulcanizedb sync --config <config.toml> --starting-block-number <block-number>`
|
|
|
|
## Alternatively, sync from Geth's underlying LevelDB
|
|
Sync VulcanizeDB from the LevelDB underlying a Geth node.
|
|
1. Assure node is not running, and that it has synced to the desired block height.
|
|
1. Start vulcanize_db
|
|
- `./vulcanizedb coldImport --config <config.toml> --starting-block-number <block-number> --ending-block-number <block-number>`
|
|
1. Optional flags:
|
|
- `--starting-block-number`/`-s`: block number to start syncing from
|
|
- `--ending-block-number`/`-e`: block number to sync to
|
|
- `--all`/`-a`: sync all missing blocks
|
|
|
|
## Running the Tests
|
|
|
|
### Unit Tests
|
|
- `go test ./pkg/...`
|
|
|
|
### Integration Tests
|
|
- `go test ./...` to run all tests.
|