ipld-eth-server/README.md

# Vulcanize DB

[![Join the chat at https://gitter.im/vulcanizeio/VulcanizeDB](https://badges.gitter.im/vulcanizeio/VulcanizeDB.svg)](https://gitter.im/vulcanizeio/VulcanizeDB?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Build Status](https://travis-ci.org/vulcanize/VulcanizeDB.svg?branch=master)](https://travis-ci.org/vulcanize/VulcanizeDB)

## 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` to 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/`

- 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>`

## Running the Tests

### Unit Tests
- `go test ./pkg/...`

### Integration Tests
 - `go test ./...` to run all tests.
Add Travis indicator to readme 2017-10-19 14:45:37 +00:00			`# Vulcanize DB`
WIP 2018-01-25 23:19:15 +00:00
Add Gitter badge 2018-04-19 14:49:56 +00:00			`[![Join the chat at https://gitter.im/vulcanizeio/VulcanizeDB](https://badges.gitter.im/vulcanizeio/VulcanizeDB.svg)](https://gitter.im/vulcanizeio/VulcanizeDB?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)`

Add vendor dir (#16) (#4) * Add vendor dir so builds dont require dep * Pin specific version go-eth version 2018-01-29 19:44:18 +00:00			`[![Build Status](https://travis-ci.org/vulcanize/VulcanizeDB.svg?branch=master)](https://travis-ci.org/vulcanize/VulcanizeDB)`
Add README 2017-10-19 14:38:47 +00:00
Updates to README - update configuration section - remove creating and migrating the db as a prerequisite for running test - it doesn't seem to be necessary - add a public.toml.example config file to be copied and updated locally 2018-04-09 16:51:21 +00:00			`## Dependencies`
Updates to readme 2017-10-25 14:01:13 +00:00			`- Go 1.9+`
Updates to README - update configuration section - remove creating and migrating the db as a prerequisite for running test - it doesn't seem to be necessary - add a public.toml.example config file to be copied and updated locally 2018-04-09 16:51:21 +00:00			`- Postgres 10`
Update README.md 2018-03-07 21:34:55 +00:00			`- Ethereum Node`
			`- [Go Ethereum](https://ethereum.github.io/go-ethereum/downloads/) (1.8+)`
			`- [Parity 1.8.11+](https://github.com/paritytech/parity/releases)`
Add vendor dir (#16) (#4) * Add vendor dir so builds dont require dep * Pin specific version go-eth version 2018-01-29 19:44:18 +00:00
Updates to README - update configuration section - remove creating and migrating the db as a prerequisite for running test - it doesn't seem to be necessary - add a public.toml.example config file to be copied and updated locally 2018-04-09 16:51:21 +00:00			`## Installation`
			`go get github.com/vulcanize/vulcanizedb`
Add instructions for creating the database and the initial table 2017-10-25 15:05:29 +00:00
Updates to README - update configuration section - remove creating and migrating the db as a prerequisite for running test - it doesn't seem to be necessary - add a public.toml.example config file to be copied and updated locally 2018-04-09 16:51:21 +00:00			`## Setting up the Database`
Add instructions for creating the database and the initial table 2017-10-25 15:05:29 +00:00			`1. Install Postgres`
Remove geth --dev dep 2018-03-21 18:44:01 +00:00			1. Create a superuser for yourself and make sure `psql --list` works without prompting for a password.
Updates to README - update configuration section - remove creating and migrating the db as a prerequisite for running test - it doesn't seem to be necessary - add a public.toml.example config file to be copied and updated locally 2018-04-09 16:51:21 +00:00			1. `createdb vulcanize_public`
Remove geth --dev dep 2018-03-21 18:44:01 +00:00			1. `cd $GOPATH/src/github.com/vulcanize/vulcanizedb`
Update README to only recommend 1 way to setup database schema 2018-04-11 16:00:25 +00:00			1. Run the migrations: `make migrate HOST_NAME=localhost NAME=vulcanize_public PORT=5432`
Update README, add State sync test (#1) 2018-01-26 19:38:14 +00:00
Update README to account for environment based changes 2017-11-03 21:52:19 +00:00			`* See below for configuring additional environments`
Update README 2018-01-26 19:51:13 +00:00
Updates to README - update configuration section - remove creating and migrating the db as a prerequisite for running test - it doesn't seem to be necessary - add a public.toml.example config file to be copied and updated locally 2018-04-09 16:51:21 +00:00			`## Configuration`
			- To use a local Ethereum node, copy `environments/public.toml.example` to
			`environments/public.toml` and update the `ipcPath` to 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/`

Address PR comments 2018-04-10 14:07:55 +00:00			- See `environments/infura.toml` to configure commands to run against infura, if a local node is unavailable
Add instructions for creating the database and the initial table 2017-10-25 15:05:29 +00:00
Remove godo (#136) 2018-01-25 21:46:55 +00:00			`## Start syncing with postgres`
Updates to README - update configuration section - remove creating and migrating the db as a prerequisite for running test - it doesn't seem to be necessary - add a public.toml.example config file to be copied and updated locally 2018-04-09 16:51:21 +00:00			`Syncs VulcanizeDB with the configured Ethereum node.`
			`1. Start node (if fast syncing wait for initial sync to finish)`
Remove geth --dev dep 2018-03-21 18:44:01 +00:00			`1. In a separate terminal start vulcanize_db`
Update README 2018-01-26 19:51:13 +00:00			- `vulcanizedb sync --config <config.toml> --starting-block-number <block-number>`
Block categorization (#110) * Add block categorization (is_final=) * Add godo task for vulcanizeDB (Example of how everything could work together) * Add unique constraint on block_number and node * Add index on block_id for transactions_table * Add node_id index on blocks table * Sort transactions returned from FindBlock by tx_hash * lowercase tx_to, tx_from like etherscan 2017-12-20 20:06:22 +00:00
Add Travis indicator to readme 2017-10-19 14:45:37 +00:00			`## Running the Tests`
Add README 2017-10-19 14:38:47 +00:00
Block categorization (#110) * Add block categorization (is_final=) * Add godo task for vulcanizeDB (Example of how everything could work together) * Add unique constraint on block_number and node * Add index on block_id for transactions_table * Add node_id index on blocks table * Sort transactions returned from FindBlock by tx_hash * lowercase tx_to, tx_from like etherscan 2017-12-20 20:06:22 +00:00			`### Unit Tests`
Updates to README - update configuration section - remove creating and migrating the db as a prerequisite for running test - it doesn't seem to be necessary - add a public.toml.example config file to be copied and updated locally 2018-04-09 16:51:21 +00:00			- `go test ./pkg/...`
Add integration test * Update Travis to run integration tests 2017-10-24 14:24:07 +00:00
Updates to README - update configuration section - remove creating and migrating the db as a prerequisite for running test - it doesn't seem to be necessary - add a public.toml.example config file to be copied and updated locally 2018-04-09 16:51:21 +00:00			`### Integration Tests`
			- `go test ./...` to run all tests.