Skip to content

Commit

Permalink
Merge branch 'master' into deploy-fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
hkalodner committed Feb 12, 2020
2 parents 8fb72fc + 075bf4c commit b322e9d
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Here are the important dependencies in case you are not running on a supported O
Download the Arbitrum Monorepo from source:

```bash
git clone -b v0.3.0 --depth=1 -c advice.detachedHead=false https://github.com/offchainlabs/arbitrum.git
git clone -b v0.4.0 --depth=1 -c advice.detachedHead=false https://github.com/offchainlabs/arbitrum.git
cd arbitrum
yarn
yarn build
Expand Down
17 changes: 9 additions & 8 deletions docs/Rinkeby.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,25 @@ The deployment tool will assist you in configuring and launching your Rollup Cha

## Initializing the validators

Run the following command to initialize a set of validators for a given Rollup contract. The `contract_path` should be to the same file you submitted to the deployment tool, the `rollup_address` should be the address output by the tool after a successful deployment, and the `eth_url` should be a RPC or WebSocket connection to an Ethereum node.

You can select to have one or more validators run on your machine for testing purposes.

```bash
./scripts/initialize_validators.py [contract_path] [validator_count]
./scripts/initialize_validators.py [contract_path] [validator_count] [rollup_address] [eth_url]
```

This command will initialize your rollup chain and create a `validator-states` folder with configuration
information for `validator_count` validators prepared to validator it.

Note that this command executes the `setup_rollup.py` script and if you are not in the root of the `arbitrum`
Note that this command executes the `initialize_validators.py` script and if you are not in the root of the `arbitrum`
directory, you may need to use a different path.

Running the `setup_rollup` command will perform two main tasks 1) Launch an Arbitrum Rollup chain on the local testnet 2) Create a `validator-states` folder. This folder contains pre-seeded wallets for the created validators. It serves as a lightweight simulation of an enviroment where the validators are running on multiple machines.
Running the `initialize_validators` command will create a `validator-states` folder with `validator_count` subfolders, each configured with a validator for the given Rollup contract. It serves as a lightweight simulation of an enviroment where the validators are running on multiple machines.

## Deploying your validators

To launch a set of docker images containing your validators, run:

```bash
./scripts/arb_deploy.py validator-states --password=P8ssW0Rd
./scripts/arb_deploy.py validator-states --password=[password]
```

`arb_deploy.py` takes a path to the validator-states created in the previous step. Unlike the blockchain docker image, the validators can be stopped and restarted without losing any state. The password argument is used to security the validator keystore.
`arb_deploy.py` takes a path to the validator-states created in the previous step. Unlike the blockchain docker image, the validators can be stopped and restarted without losing any state. The password argument is used to secure the validator keystore. On the first deployment you set the password to any value, and on later deployments you must resubmit the same password.
2 changes: 1 addition & 1 deletion packages/arb-provider-ethers/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "arb-provider-ethers",
"version": "0.3.6",
"version": "0.3.7",
"description": "Arbitrum provider for ethers",
"author": "Offchain Labs, Inc.",
"license": "Apache-2.0",
Expand Down

0 comments on commit b322e9d

Please sign in to comment.