2019-04-05 15:10:34 +00:00
# Syncing commands
2019-05-07 21:21:08 +00:00
These commands are used to sync raw Ethereum data into Postgres, with varying levels of data granularity.
2019-04-05 15:10:34 +00:00
2019-05-01 06:02:30 +00:00
## headerSync
2019-05-07 21:21:08 +00:00
Syncs block headers from a running Ethereum node into the VulcanizeDB table `headers` .
- Queries the Ethereum node using RPC calls.
- Validates headers from the last 15 blocks to ensure that data is up to date.
- Useful when you want a minimal baseline from which to track targeted data on the blockchain (e.g. individual smart contract storage values or event logs).
2019-05-13 20:52:17 +00:00
#### Usage
- Run: `./vulcanizedb headerSync --config <config.toml> --starting-block-number <block-number>`
- The config file must be formatted as follows, and should contain an ipc path to a running Ethereum node:
```toml
[database]
name = "vulcanize_public"
hostname = "localhost"
user = "vulcanize"
password = "vulcanize"
port = 5432
[client]
ipcPath = < path to a running Ethereum node >
```
- Alternatively, the ipc path can be passed as a flag instead `--client-ipcPath` .
2019-05-07 21:21:08 +00:00
2019-04-05 15:10:34 +00:00
## sync
2019-05-07 21:21:08 +00:00
Syncs blocks, transactions, receipts and logs from a running Ethereum node into VulcanizeDB tables named
`blocks` , `uncles` , `full_sync_transactions` , `full_sync_receipts` and `logs` .
- Queries the Ethereum node using RPC calls.
- Validates headers from the last 15 blocks to ensure that data is up to date.
- Useful when you want to maintain a broad cache of what's happening on the blockchain.
2019-05-13 20:52:17 +00:00
#### Usage
- Run `./vulcanizedb sync --config <config.toml> --starting-block-number <block-number>`
- The config file must be formatted as follows, and should contain an ipc path to a running Ethereum node:
```toml
[database]
name = "vulcanize_public"
hostname = "localhost"
user = "vulcanize"
password = "vulcanize"
port = 5432
[client]
ipcPath = < path to a running Ethereum node >
```
- Alternatively, the ipc path can be passed as a flag instead `--client-ipcPath` .
*Please note, that if you are fast syncing your Ethereum node, wait for the initial sync to finish.*
2019-04-05 15:10:34 +00:00
## coldImport
2019-05-07 21:21:08 +00:00
Syncs VulcanizeDB from Geth's underlying LevelDB datastore and persists Ethereum blocks,
transactions, receipts and logs into VulcanizeDB tables named `blocks` , `uncles` ,
`full_sync_transactions` , `full_sync_receipts` and `logs` respectively.
2019-05-13 20:52:17 +00:00
#### Usage
1. Ensure the Ethereum node you're point at is not running, and that it has synced to the desired block height.
1. Run `./vulcanizedb coldImport --config <config.toml>`
2019-04-05 15:10:34 +00:00
1. Optional flags:
- `--starting-block-number <block number>` /`-s < block number > `: block number to start syncing from
- `--ending-block-number <block number>` /`-e < block number > `: block number to sync to
- `--all` /`-a`: sync all missing blocks
2019-05-13 20:52:17 +00:00
The config file can be formatted as follows, and must contain the LevelDB path.
```toml
[database]
name = "vulcanize_public"
hostname = "localhost"
user = "vulcanize"
password = "vulcanize"
port = 5432
[client]
leveldbpath = "/Users/user/Library/Ethereum/geth/chaindata"
```