From d846c7a6fa0f7b82a6d8a6b6d9559e6f7f97b08f Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Thu, 15 Nov 2018 11:34:21 +0100 Subject: [PATCH 1/4] Copyedited README.md, fixed minor errors, added more examples --- README.md | 71 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 46 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 8e26832..c0a3ac8 100644 --- a/README.md +++ b/README.md @@ -53,35 +53,63 @@ To get the `latest` versions of all components, referring to their `develop` bra After getting everything running, you can open the **Pleuston Frontend** application in your browser: -``` -http://localhost:3000 -``` +[http://localhost:3000](http://localhost:3000) ### Script Options -The script provides the following options: +The `start_ocean.sh` script provides the following options: -Option | Description ---- | --- +Option | Description +--- | --- `--latest` | Get the `latest` versions of all components, referring to their `develop` branches. `--no-pleuston` | Start up Ocean without an instance of `pleuston`. Helpful for development on `pleuston`. `--local-parity-node` | Runs a local parity POA node and Secret Store instead of ganache-cli. `--reuse-database` | Start up Ocean and reuse the Database from ganache. Helpful for development. -For example, the following command would run the latest version of the stack, without Pleuston and with the Parity + Secret Store nodes: +For example, if you do: -`./start_ocean.sh --latest --no-pleuston --local-parity-node` +```bash +./start_ocean.sh --latest +``` -## Ocean Protocol components +then the main/default [docker-compose.yml](docker-compose.yml) will be used, so the following Docker images will all be started: -The Ocean Docker compose starts the following components: +- mongo:3.6 +- oceanprotocol/keeper-contracts:latest +- oceanprotocol/aquarius:latest +- oceanprotocol/brizo:latest +- oceanprotocol/pleuston:latest -* [🦄 pleuston](https://github.com/oceanprotocol/pleuston). Frontend listening on port `3000`. -* [🐋 aquarius](https://github.com/oceanprotocol/aquarius). Backend listening on port `5000`. -* [💧 keeper-contracts](https://github.com/oceanprotocol/keeper-contracts). RPC client listening on port `8545`. -* [💧 secret-store](https://github.com/oceanprotocol/parity-ethereum). HTTP client listening on port `12001`. +To see what ports each of those listens on, read [docker-compose.yml](docker-compose.yml). Note that `keeper-contracts` runs a local Ganache node (not a local Parity Ethereum POA node). -![Ocean Protocol Components](doc/img/ocean-components@2x.png) +If you do: + +```bash +./start_ocean.sh --no-pleuston +``` + +then [docker-compose-no-pleuston.yml](docker-compose-no-pleuston.yml) will be used, so these images will be started: + +- mongo:3.6 +- oceanprotocol/keeper-contracts:stable +- oceanprotocol/aquarius:stable +- oceanprotocol/brizo:stable + +If you do: + +```bash +./start_ocean.sh --latest --local-parity-node +``` + +then [docker-compose-local-parity-node.yml](docker-compose-local-parity-node.yml) will be used. Read it to see what images it starts. Note that it _doesn't_ start Pleuston, and it _does_ start a Parity Secret Store. + +If you do: + +```bash +./start_ocean.sh --latest --no-pleuston --local-parity-node +``` + +then the last-selected Docker Compose file will be used, i.e. the one selected by `--local-parity-node`: [docker-compose-local-parity-node.yml](docker-compose-local-parity-node.yml). ### Parity Client Accounts @@ -102,20 +130,13 @@ export REUSE_DATABASE="true" docker-compose --project-name=ocean -f docker-compose-no-pleuston.yml up ``` -Variable | Description ---- | --- +Variable | Description +--- | --- `REUSE_DATABASE` | The keeper-contracts component runs with ganache by default and every run will produce and deploy new instances of the keeper contracts. Ganache can be run with a specific database path by setting the env var `REUSE_DATABASE` to `"true"`. By default, the ganache database will be setup in the cwd. `DEPLOY_CONTRACTS` | skip deploying smart contracts by setting this to `"false"`, in this case `REUSE_DATABASE` should be set to `"true"` in the previous run when using ganache `KEEPER_NETWORK_NAME` | set to one of `"ganache"` (default), `"kovan"`, or `"ocean_poa_net_local"` `ARTIFACTS_FOLDER` | this is where the deployed smart contracts abi files will be available. This can be pointed at any path you like. -A subset of the components can be run by modifying the docker-compose file directly or by using one of the other pre-built compose files: - -Compose file | Description ---- | --- -`docker-compose-no-pleuston.yml` | runs all components without the pleuston. This is useful for developing/debugging the front-end app. So first the docker compose container can be started then pleuston can be started separately from source. You can also use `./start_ocean.sh --no-pleuston` to do this -`docker-compose-local-parity-node.yml` | similar to the above with no pleuston, but runs a local parity POA node instead of ganache-cli. You can also use `./start_ocean.sh --local-parity-node` instead - ## Contributing We use GitHub as a means for maintaining and tracking issues and source code development. @@ -126,7 +147,7 @@ Ocean Protocol uses [C4 Standard process](https://github.com/unprotocols/rfc/blo ## License -``` +```text Copyright 2018 Ocean Protocol Foundation Licensed under the Apache License, Version 2.0 (the "License"); From 11c4c6bb59b2e8e0ea024cd90390cc7115f8c6b8 Mon Sep 17 00:00:00 2001 From: Javier Cortejoso Date: Mon, 19 Nov 2018 08:43:45 +0100 Subject: [PATCH 2/4] Increased balance of test accounts --- parity/parity/config/chain.json | 10 +++++----- parity/secret_store/config/chain.json | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/parity/parity/config/chain.json b/parity/parity/config/chain.json index 93accc3..c4176c8 100644 --- a/parity/parity/config/chain.json +++ b/parity/parity/config/chain.json @@ -88,19 +88,19 @@ } }, "0x6B0c56d1Ad5144b4d37fa6e27DC9afd5C2435c3B": { - "balance": "1000" + "balance": "0x200000000000000000000000000000000000000000000000" }, "0x0011598De1016A350ad719D23586273804076774": { - "balance": "100500" + "balance": "0x200000000000000000000000000000000000000000000000" }, "0x068ed00cf0441e4829d9784fcbe7b9e26d4bd8d0": { - "balance": "100000000" + "balance": "0x200000000000000000000000000000000000000000000000" }, "0xa99d43d86a0758d5632313b8fa3972b6088a21bb": { - "balance": "100000000" + "balance": "0x200000000000000000000000000000000000000000000000" }, "0x00Bd138aBD70e2F00903268F3Db08f2D25677C9e": { - "balance": "10000000111000111000111000" + "balance": "0x200000000000000000000000000000000000000000000000" } } } \ No newline at end of file diff --git a/parity/secret_store/config/chain.json b/parity/secret_store/config/chain.json index e991c3d..7c63abb 100644 --- a/parity/secret_store/config/chain.json +++ b/parity/secret_store/config/chain.json @@ -88,19 +88,19 @@ } }, "0x6B0c56d1Ad5144b4d37fa6e27DC9afd5C2435c3B": { - "balance": "1000" + "balance": "0x200000000000000000000000000000000000000000000000" }, "0x0011598De1016A350ad719D23586273804076774": { - "balance": "100500" + "balance": "0x200000000000000000000000000000000000000000000000" }, "0x068ed00cf0441e4829d9784fcbe7b9e26d4bd8d0": { - "balance": "100000000" + "balance": "0x200000000000000000000000000000000000000000000000" }, "0xa99d43d86a0758d5632313b8fa3972b6088a21bb": { - "balance": "100000000" + "balance": "0x200000000000000000000000000000000000000000000000" }, "0x00Bd138aBD70e2F00903268F3Db08f2D25677C9e": { - "balance": "10000000111000111000111000" + "balance": "0x200000000000000000000000000000000000000000000000" } } } From e6d5fd9e8057276f2001f84ab16588ef99ef9c73 Mon Sep 17 00:00:00 2001 From: Javier Cortejoso Date: Mon, 19 Nov 2018 11:20:44 +0100 Subject: [PATCH 3/4] Fix typo in volume --- docker-compose-no-pleuston.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker-compose-no-pleuston.yml b/docker-compose-no-pleuston.yml index 12c8db1..8a19ca2 100644 --- a/docker-compose-no-pleuston.yml +++ b/docker-compose-no-pleuston.yml @@ -54,7 +54,7 @@ services: KEEPER_URL: http://keeper-contracts:8545 LOCAL_CONTRACTS: "true" volumes: - - ${ARTIFACTS_FOLDER}:/usr/local/keeper-contracs/:ro + - ${ARTIFACTS_FOLDER}:/usr/local/keeper-contracts/:ro networks: backend: From 614a7da2f5e24a50215e8363e2e66c3687e5aed6 Mon Sep 17 00:00:00 2001 From: Javier Cortejoso Date: Tue, 20 Nov 2018 14:43:48 +0100 Subject: [PATCH 4/4] Changed networkId to avoid collision --- parity/parity/config/chain.json | 2 +- parity/secret_store/config/chain.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/parity/parity/config/chain.json b/parity/parity/config/chain.json index 93accc3..49657e1 100644 --- a/parity/parity/config/chain.json +++ b/parity/parity/config/chain.json @@ -20,7 +20,7 @@ "params": { "maximumExtraDataSize": "0x20", "minGasLimit": "0x1388", - "networkID": "0x2323", + "networkID": "0x2324", "gasLimitBoundDivisor": "0x400", "eip140Transition": 0, "eip211Transition": 0, diff --git a/parity/secret_store/config/chain.json b/parity/secret_store/config/chain.json index e991c3d..753f9d1 100644 --- a/parity/secret_store/config/chain.json +++ b/parity/secret_store/config/chain.json @@ -20,7 +20,7 @@ "params": { "maximumExtraDataSize": "0x20", "minGasLimit": "0x1388", - "networkID": "0x2323", + "networkID": "0x2324", "gasLimitBoundDivisor": "0x400", "eip140Transition": 0, "eip211Transition": 0,