Skip to content

Commit

Permalink
Update README and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@sinahab
sinahab committed Feb 5, 2018
1 parent 542dba3 commit b0f6f49
Show file tree
Hide file tree
Showing 4 changed files with 122 additions and 159 deletions.
197 changes: 39 additions & 158 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[![Build Status](https://travis-ci.org/TrueBitFoundation/scrypt-interactive.svg?branch=master)](https://travis-ci.org/TrueBitFoundation/scrypt-interactive)

# Truebit Verification for Scrypt.

Expand All @@ -19,189 +18,71 @@ The client relies on a local Parity instance to execute the ScryptRunner contrac

The rest of the contracts can be deployed on any chain (currently ganache for local development, Rinkeby for staging, and mainnet for production).

There are 3 actors in the system:
There are 2 actors in the system:

1. The claimant submitting doge block headers to the DogeRelay contract.
- The claimant must also defend their block headers in the event of a challenge.
2. The challenger that has the option of challenging a claimant's block headers.
3. The user who wishes to use the bridge to move dogecoins to Ethereum
- This user can be the same as the claimant, but it's not necessary.
- This user provides a merkle proof of a tx on dogecoin that is validated against the blockheader stored in DogeRelay.
- DogeRelay can trust the blockheader submissions due to the protocol described in this repo.
1. The Claimant:
- submits doge block headers to the DogeRelay contract.
- must also defend their block headers in the event of a challenge.
2. The Verifier:
- monitors the Truebit contract and challenges incorrect claims.

The address for the contracts as deployed on Rinkeby are in the [`.env`](https://github.com/TrueBitFoundation/scrypt-interactive/blob/master/.env) file.

The addresses of the doge relay on mainnet are
```
# @TODO - update this once we deploy
DOGE_RELAY_ADDRESS=0xd5cd4e3bede456d9e1da2582d7771fdbf6e28846
SCRYPT_VERIFIER_ADDRESS=0xc4291fc3a35a66c993a47b96079e5439c5febe16
SCRYPT_RUNNER_ADDRESS=0x75d860a49037082f1c96fe0c527f7cb9be3a3be6
CLAIM_MANAGER_ADDRESS=0xff35220a6e4771b94bf1a92cf27f060d6598b1c7
```

For your convenience, they've been coded into `.env`, but if you're interested in running against a different chain, make sure to deploy and then update those values.

## Running the Tests

First, install the needed dependencies.

Running the tests involves
1. Running ganache `npm run ganache`
2. Running parity `npm run parity`
3. Running the tests `npm run test`

We also have a convenient `test.sh` script that does all that for you.
```bash
./bin/test.sh
```
## Running the client

## Installing Dependencies
The client software is open-source and available in this repo.

Install the latest stable release of the Parity Ethereum client. You can look for the binary [here](https://github.com/paritytech/parity/releases).
```bash
# make sure it's executable
chmod 755 ./parity
# add it to your PATH if you want to use our scripts for launching it
```

Initialize the parity development chain database with
```bash
parity --chain dev
```

Let that run for 5 seconds or whatever and then kill it. In the future, run parity with
```bash
npm run parity
# or
parity --config config.toml --geth
```
Follow [these directions](https://github.com/TrueBitFoundation/scrypt-interactive/blob/master/docs/setup.md) to setup the client.

Ensure you have the latest version of node installed (currently v9.4.0).
Use the CLI tool to interact with the client:

Then install packages deps:
```bash
npm install
npm install -g sequelize-cli
npm install -g truffle
```

Install postgres and run it on the default port `5432`:

```
# Ubuntu instructions for installing psql
sudo apt-get update
sudo apt-get install postgresql postgresql-contrib
# Switch over to postgres account
sudo -i -u postgres
# create a new role
createuser --interactive
# enter user name
# then select yes for superuser
# check the status
npm start status

# give you user the ability to execute commands as postgres user
# by giving it the right permissions in pg_hba.conf
# manage your deposits
npm start deposit <amout_in_ether>
npm start withdraw <amout_in_ether>

```
# monitor the system as a Verifier.
# note: you must have the required amount of eth deposited to stake per claim you want to challenge;
# otherwise, it won't be able to do anything but watch.
npm start monitor --auto-challenge

Bootstrap your database with:
# submit a claim as a Claimant.
# note: you must defend your claim (scrypt hash and plaintext payload) against challenges.
# note: you must have the required amount of eth deposited to stake.
npm start claim <input> <hash> <proposalID>

```bash
sequelize db:create
sequelize db:migrate
NODE_ENV=test sequelize db:create
NODE_ENV=test sequelize db:migrate
```

Configure your client by updating the `.env` file:
## Running the Tests

```bash
export WEB3_HTTP_PROVIDER=http://localhost:8545
export WEB3_PARITY_PROVIDER=http://localhost:4242
export DOGE_RELAY_ADDRESS=0x0
export SCRYPT_VERIFIER_ADDRESS=0x0
export SCRYPT_RUNNER_ADDRESS=0x0
export CLAIM_MANAGER_ADDRESS=0x0
```
First, install the needed dependencies as described in the [setup docs](https://github.com/TrueBitFoundation/scrypt-interactive/blob/master/docs/setup.md).

## The CLI
Running the tests involves
1. Running ganache `npm run ganache`
2. Running parity `npm run parity`
3. Running the tests `npm run test`

We also have a convenient `test.sh` script that does all that for you.
```bash
bridge --help

# run the cli as a challenger
# The `challenge` and `deposit` flags configure how the bridge behaves.
# note: as a challenger, your account must have the required amount of Ether to stake per claim you want to challenge;
# otherwise, it won't be able to do anything but watch.
bridge monitor [-c, --auto-challenge]

# run the cli as a claimant
# note: your job is to submit doge block headers and defend them against challenges.
# if you never submit an invalid doge header (who would do that??), you'll never have to play the verification game.
# note: you must have enough Ether deposited within the ClaimManager in order to submit blocks.
# @TODO
bridge claim <block_header> <block_header_hash>

# manage your deposits
# @TODO
bridge deposit <amout_in_ether>
bridge withdraw <amout_in_ether>

# show the status of the bridge
# @TODO
bridge status
./bin/test.sh
```

## Deploying the Contracts

To deploy the contracts to your favorite dev chain,
```bash
npm run migrate:dev
# or
truffle migrate --network :your-chain-here

# use `npm run migrate:dev -- --reset` for force-migrate
```
To deploy the contracts to your favorite chain:

To deploy the contracts to your favorite infura chain, do something like
```bash
MNEMONIC="your mnemonic here do not put this in a file keep it in the interpreter" \
npm run migrate:rinkeby
# or
MNEMONIC="your mnemonic here do not put this in a file keep it in the interpreter" \
INFURA_CHAIN=ropsten \
truffle migrate --network infura
```

And note the addresses for configuring your env when actually running the code.
# first:
# update the .env file.

## Geth Docker Image Testing
# then
npm run migrate:rinkeby # or target another chain.

Want to test against a more reasonable test chain?
# then
# update the resulting contract addresses in .env

```
git clone [email protected]:livepeer/docker-livepeer.git
cd docker-livepeer/geth-dev
# replace the latest tag with v1.7.3
s/latest/v1.7.3/g Dockerfile
docker build . -t geth-dev
docker run \
--name geth-dev --rm -d \
-p 8545:8545 \
geth-dev
docker logs -f :container-id
```

## Doge-Ethereum Bounty Split Contract

We're splitting the bounty with additional developers via smart contract.

The bounty contract is deployed at: `0x1ed3e252dcb6d540947d2d63a911f56733d55681`

3 changes: 2 additions & 1 deletion bin/server_setup.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,8 @@ wget https://parity-downloads-mirror.parity.io/v1.8.8/x86_64-unknown-linux-gnu/p
sudo apt install ./parity_1.8.8_amd64.deb

# follow the README:
parity --chain dev # kill this after ~ 5 seconds, when the dev db is setup.
# kill this after ~ 5 seconds, when the dev db is setup.
parity --chain dev

#----------------------------------

Expand Down
30 changes: 30 additions & 0 deletions docs/misc.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@

Here are some odds and ends:

## Geth Docker Image Testing

Want to test against a more reasonable test chain?

```
git clone [email protected]:livepeer/docker-livepeer.git
cd docker-livepeer/geth-dev
# replace the latest tag with v1.7.3
s/latest/v1.7.3/g Dockerfile
docker build . -t geth-dev
docker run \
--name geth-dev --rm -d \
-p 8545:8545 \
geth-dev
docker logs -f :container-id
```

## Doge-Ethereum Bounty Split Contract

We're splitting the bounty with additional developers via smart contract.

The bounty contract is deployed at: `0x1ed3e252dcb6d540947d2d63a911f56733d55681`

51 changes: 51 additions & 0 deletions docs/setup.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@

## Setting up the client

The specific commands used to setup our Ubuntu 16.04 server can be found [here](https://github.com/TrueBitFoundation/scrypt-interactive/blob/master/bin/server_setup.sh).

More general directions follow:

```bash
# Install the latest stable release of the Parity Ethereum client.
# You can look for the binary [here](https://github.com/paritytech/parity/releases).

# make sure it's executable
chmod 755 ./parity

# Initialize the parity development chain database with
# kill this after the dev db is setup (a few seconds).
parity --chain dev

# run parity
npm run parity

# Ensure you have the latest version of node installed (currently v9.4.0).

# Then install npm packages deps:
npm install
npm install -g sequelize-cli
npm install -g truffle

# Install postgres and run it on the default port `5432`:
sudo apt-get update
sudo apt-get install postgresql postgresql-contrib

# give you user the ability to execute commands as postgres user
# by giving it the right permissions in pg_hba.conf

# Bootstrap your database with:
sequelize db:create
sequelize db:migrate
NODE_ENV=test sequelize db:create
NODE_ENV=test sequelize db:migrate

# Configure your client by updating the `.env` file, as follows:
#
# export WEB3_HTTP_PROVIDER=http://localhost:8545
# export WEB3_PARITY_PROVIDER=http://localhost:4242
# export DOGE_RELAY_ADDRESS=0x0
# export SCRYPT_VERIFIER_ADDRESS=0x0
# export SCRYPT_RUNNER_ADDRESS=0x0
# export CLAIM_MANAGER_ADDRESS=0x0
```

0 comments on commit b0f6f49

Please sign in to comment.