Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instruction for runnng from Docker Compose #61

Open
wants to merge 1 commit into
base: deploydocker
Choose a base branch
from
Open

Add instruction for runnng from Docker Compose #61

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,38 @@

Proof-of-concept Implementation of [Plasma EVM](https://hackmd.io/s/HyZ2ms8EX), forked from [Onther-Tech/plasma-evm](https://github.com/Onther-Tech/plasma-evm). You can check the RootChain smart contract [here](https://github.com/Onther-Tech/plasma-evm-contracts).


## Development Status

- [x] Make enter / exit requests
- [x] Submit NRBs / ORBs
- [x] Finalize block and requests
- [ ] Challenge on Null Address Transaction in NRBs

Implementing TrueBit's verification game is under research as well as challenges that requires verification game.

## Quick Start

Make sure that you have installed **Docker Compose** for quick start.

* For Mac or Windows:
* Download [Docker Desktop](https://www.docker.com/products/docker-desktop) for Mac or Windows. [Docker Compose](https://docs.docker.com/compose) will be automatically installed.
* For Linux:
* On Linux, make sure you have the latest version of [Compose](https://docs.docker.com/compose/install/).


Download Plasma EVM code and go into its directory:
```
git clone --single-branch --branch deploydocker https://github.com/Onther-Tech/plasma-evm
cd plasma-evm
```

Then just run:
```
docker-compose up
```

## Ethereum client

Building geth requires both a Go (version 1.9 or later) and a C compiler.
You can install them using your favourite package manager.
Once the dependencies are installed, run
Expand All @@ -21,7 +42,6 @@ We're using [Onther-Tech/go-ethereum](https://github.com/Onther-Tech/go-ethereum

For the simple start of both clients(ethereum, plasma-evm), you can run `run.rootchain.sh` in [Onther-Tech/go-ethereum](https://github.com/Onther-Tech/go-ethereum) and `run.pls.sh` in [Onther-Tech/plasma-evm](https://github.com/Onther-Tech/plasma-evm) (this is recommended way to setup devlop and test plasma-evm).


## Build

Just run `make geth` in terminal.
Expand All @@ -46,12 +66,14 @@ DEVELOPER CHAIN OPTIONS:
You can import your private key and HDwallet into new account with keystore

#### Using Private Key

Inside `build/bin` directory, run the following command
```bash
geth account importKey <privateKey>
```

#### Using HDwallet

Inside `build/bin` directory, run the following command
```bash
geth account importHDwallet <mnemonic> <path>
Expand Down