Skip to content

Commit

Permalink
Merge pull request #104 from andogro/ag-update-test-parameters
Browse files Browse the repository at this point in the history
test parameter clarification
  • Loading branch information
akolotov committed Oct 18, 2018
2 parents 84432b8 + c2a290f commit 8583bf2
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,16 @@ For more information on the Redis/RabbitMQ requirements, see [#90](/../../issues

There are two options to run the nodejs oracle:
1. Docker containers. This requires [Docker](https://docs.docker.com/install/) and [Docker Compose](https://docs.docker.com/compose/install/) installed. If you are on Linux, it's also recommended that you [create a docker group and add your user to it](https://docs.docker.com/install/linux/linux-postinstall/), so that you can use the CLI without sudo.
2. NodeJs Package Manager.
2. NodeJs Package Manager (NPM).

### Docker

- Start RabbitMQ and Redis: if you are running the bridge containers for the first time use `docker-compose up -d --build` otherwise use `docker-compose up -d`
- `docker-compose run bridge npm run watcher:signature-request`
- `docker-compose run bridge npm run watcher:collected-signatures`
- `docker-compose run bridge npm run watcher:affirmation-request`
- `docker-compose run bridge npm run sender:home`
- `docker-compose run bridge npm run sender:foreign`

### NPM

Expand All @@ -152,15 +161,6 @@ There are two options to run the nodejs oracle:
- `npm run sender:home`
- `npm run sender:foreign`

### Docker

- Start RabbitMQ and Redis: if you are running the bridge containers for the first time use `docker-compose up -d --build` otherwise use `docker-compose up -d`
- `docker-compose run bridge npm run watcher:signature-request`
- `docker-compose run bridge npm run watcher:collected-signatures`
- `docker-compose run bridge npm run watcher:affirmation-request`
- `docker-compose run bridge npm run sender:home`
- `docker-compose run bridge npm run sender:foreign`

### Bridge UI

See the [Bridge UI installation instructions](https://github.com/poanetwork/bridge-ui/) to configure and use the optional Bridge UI.
Expand Down Expand Up @@ -269,11 +269,12 @@ When running the processes, the following commands can be used to test functiona
| `USER_ADDRESS` | An account - the current owner of coins/tokens. |
| `USER_ADDRESS_PRIVATE_KEY` | A private key belonging to the account. |
| `HOME_BRIDGE_ADDRESS` | Address of the bridge in the Home network to send transactions. |
| `HOME_MIN_AMOUNT_PER_TX` | Value (in _eth_ or tokens) to be sent in one transaction for the Home network. |
| `HOME_MIN_AMOUNT_PER_TX` | Value (in _eth_ or tokens) to be sent in one transaction for the Home network. This should be greater than or equal to the value specified in the `poa-bridge-contracts/deploy/.env` file. The default value in that file is 500000000000000000, which is equivalent to 0.5. |
| `FOREIGN_BRIDGE_ADDRESS` | Address of the bridge in the Foreign network to send transactions. |
| `FOREIGN_MIN_AMOUNT_PER_TX` | Value (in _eth_ or tokens) to be sent in one transaction for the Foreign network. |
| `ERC20_TOKEN_ADDRESS` | An address of the token deployed on the Home side for `ERC20-to-ERC20` mode. |
| `BRIDGEABLE_TOKEN_ADDRESS` | An address of the token deployed on the Home side for `Native-to-ERC20` mode or on the Foreign side for `ERC20-to-ERC20`. |
| `FOREIGN_MIN_AMOUNT_PER_TX` | Value (in _eth_ or tokens) to be sent in one transaction for the Foreign network. This should be greater than or equal to the value specified in the `poa-bridge-contracts/deploy/.env` file. The default value in that file is 500000000000000000, which is equivalent to 0.5. |
| `ERC20_TOKEN_ADDRESS` | An address of the token deployed on the Foreign side for `ERC20-to-ERC20` mode. Omit this parameter with other bridge modes. |
| `BRIDGEABLE_TOKEN_ADDRESS` | An address of the token deployed on the Foreign side for `Native-to-ERC20` mode or on the Home side for `ERC20-to-ERC20` (specified as erc677 in the `poa-bridge-contracts/deploy/bridgeDeploymentResults.json` file). |


## Contributing

Expand Down

0 comments on commit 8583bf2

Please sign in to comment.