Merge old private repo into vulcanize

2018-01-25 18:08:26 -06:00
parent ed5a8f5bc4 d09c2ae9bb
commit aac2239097
55 changed files with 1718 additions and 579 deletions
@@ -1,23 +1,50 @@
-# Vulcanize DB 
+# Vulcanize DB

-test change
-
-[![Build Status](https://travis-ci.com/vulcanize/vulcanizedb.svg?token=GKv2Y33qsFnfYgejjvYx&branch=master)](https://travis-ci.com/vulcanize/vulcanizedb)
-
-## Development Setup
+[![Build Status](https://travis-ci.com/8thlight/vulcanizedb.svg?token=GKv2Y33qsFnfYgejjvYx&branch=master)](https://travis-ci.com/8thlight/vulcanizedb)

 ### Dependencies

 - Go 1.9+
- - https://github.com/golang/dep
-    - `go get -u github.com/golang/dep/cmd/dep`
- - https://github.com/go-godo/godo
-    - `go get -u gopkg.in/godo.v2/cmd/godo`
 - Postgres 10 
 - Go Ethereum 
    - https://ethereum.github.io/go-ethereum/downloads/ 
+ 
+### Installation 
+    go get github.com/vulcanize/vulcanizedb
    
-### Cloning the Repository
+### Setting up the Databases
+
+1. Install Postgres
+2. Create a superuser for yourself and make sure `psql --list` works without prompting for a password.
+3. `createdb vulcanize_private`
+4. `cd $GOPATH/src/github.com/vulcanize/vulcanizedb`
+5. Import the schema: 
+    `psql vulcanize_private < db/schema.sql`
+   or run the migrations: 
+    `make migrate HOST_NAME=localhost NAME=vulcanize_public PORT=5432`
+    * See below for configuring additional environments
+    
+Adding a new migration: `./scripts/create_migration <migration-name>`
+
+## Start syncing with postgres
+1. Start geth
+2. In a separate terminal start vulcanize_db
+    - `vulcanizedb sync --config <config.toml> --starting-block-number <block-numbe>`
+    
+   * see `environments` for example config 
+
+## Watch specific contract events
+1. Start geth
+2. In a separate terminal start vulcanize_db
+    - `vulcanizedb sync --config <config.toml> --starting-block-number <block-numbe>`
+3. Create event filter 
+    - `vulcanizedb addFilter --config <config.toml> --filter-filepath <filter.json>`
+    
+   * see `filters` for example filter 
+     
+## Development Setup
+
+### Cloning the Repository (Private repo only)

 1. `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.
@@ -25,32 +52,14 @@ test change
 3. `cd $GOPATH/src/github.com/vulcanize/vulcanizedb`
 4. `dep ensure`

-### Setting up the Databases
+### Creating/Using a test node

-1. Install Postgres
-2. Create a superuser for yourself and make sure `psql --list` works without prompting for a password.
-3. `go get -u -d github.com/mattes/migrate/cli github.com/lib/pq`
-4. `go build -tags 'postgres' -o /usr/local/bin/migrate github.com/mattes/migrate/cli`
-5. `createdb vulcanize_private`
-6. `cd $GOPATH/src/github.com/vulcanize/vulcanizedb`
-7. `godo migrate -- --environment=<some-environment>`
-    * See below for configuring additional environments
-
-Adding a new migration: `./scripts/create_migration <migration-name>`
-
-### 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.
+Syncing the against the public network takes many hours for the initial sync and will download 20+ GB of data.
+Here are some instructions for creating a private test node that does not depend on having a network connection.

 1. Run `./scripts/setup` to create a private blockchain with a new account.
    * This will result in a warning.
 2. Run `./scripts/start_private_blockchain`.
-3. Run `godo run -- --environment=private` to start listener.
-
-### Connecting to the Public Blockchain
-
-`./scripts/start_blockchain`

 ### IPC File Paths

@@ -59,52 +68,7 @@ The default location for Ethereum is:
 - `$HOME/.ethereum` for Ubuntu
 - `$GOPATH/src/gihub.com/vulcanize/vulcanizedb/test_data_dir/geth.ipc` for private blockchain.

-**Note the location of the ipc file is outputted when you connect to a blockchain. It is needed to for configuration**
-
-## Start Vulcanize DB
-1. Start a blockchain.
-2. In a separate terminal start vulcanize_db
-    - `godo vulcanizeDb -- --environment=<some-environment>`
-
-## Running Listener
-
-1. Start a blockchain.
-2. In a separate terminal start listener (ipcDir location)
-    - `godo run -- --environment=<some-environment>`
-    
-## Retrieving Historical Data
-
-1. Start a blockchain.
-2. In a separate terminal start listener (ipcDir location)
-    - `godo populateBlocks -- --environment=<some-environment> --starting-number=<starting-block-number>`
-    
-## Retrieve Contract Attributes
-
-1. Add contract ABI to contracts / environment directory:
-```
-vulcanizedb/
-    contracts/
-        public/
-            <contract-address>.json
-        private/
-```
-The name of the JSON file should correspond the contract's address.
-2. Start watching the contract `godo watchContract -- --environment=<some-environment> --contract-hash=<contract-address>`
-3. Request summary data `godo showContractSummary -- --environment=<some-environment> --contract-hash=<contract-address>`
-
-
-## Retrieving Contract Logs
-
-1. Get the logs for a specific contract
-    - `godo getLogs -- --environment=<some-environment> --contract-hash=<contract-address>`
-    
-### Configuring Additional Environments
-
-You can create configuration files for additional environments.
-
- * Among other things, it will require the IPC file path
- * See `environments/private.toml` for an example
- * You will need to do this if you want to run a node connecting to the public blockchain
+**Note the location of the ipc file is printed to the console when you start geth. It is needed to for configuration**

 ## Running the Tests