1.7 KiB
1.7 KiB
Vulcanize DB
Development Setup
Dependencies
- Go 1.9+
Cloning the Repository
-
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.
- By default,
-
go get github.com/8thlight/vulcanizedb
-
go get github.com/ethereum/go-ethereum
- This will take a while and gives poor indication of progress.
-
go install github.com/ethereum/go-ethereum/cmd/geth
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.
- Run
./scripts/setup
to create a private blockchain with a new account.- This will result in a warning.
- Run
./scripts/start_private_blockchain
.
Connecting to the Public Blockchain
./scripts/start_blockchain
Running Listener
- Start a blockchain.
- In a separate terminal start listener (ipcDir location)
go run main.go --ipcPath /path/to/file.ipc
IPC File Paths
The default location for the Ethereum blockchain to be stored is:
$HOME/Library/Ethereum
for Mac$HOME/.ethereum
for Ubuntu$GOPATH/src/gihub.com/8thlight/vulcanizedb/test_data_dir/geth.ipc
for private blockchain.
Running the Tests
Integration Test
In order to run the integration tests, you will need to run them against a real blockchain.
- Run
./scripts/start_private_blockchain
as a separate process. go test ./...
Unit Tests
go test ./core