From d43401fc13ba10d6dc8f4e245a434168f11e2861 Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Fri, 30 Nov 2018 15:46:13 +0100 Subject: [PATCH 1/3] Standardize contrib guidelines across public repos --- .github/CONTRIBUTING.md | 3 +++ README.md | 6 +----- 2 files changed, 4 insertions(+), 5 deletions(-) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..eaf0ba7 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,3 @@ +# Contributing + +See the page titled "[Ways to Contribute](https://docs.oceanprotocol.com/concepts/contributing/)" in the Ocean Protocol documentation. diff --git a/README.md b/README.md index e83e43a..210477e 100644 --- a/README.md +++ b/README.md @@ -143,11 +143,7 @@ In addition to these variables, when running Brizo you need to provide the Azure ## Contributing -We use GitHub as a means for maintaining and tracking issues and source code development. - -If you would like to contribute, please fork this repository, do work in a feature branch, and finally open a pull request for maintainers to review your changes. - -Ocean Protocol uses [C4 Standard process](https://github.com/unprotocols/rfc/blob/master/1/README.md) to manage changes in the source code. Find here more details about [Ocean C4 OEP](https://github.com/oceanprotocol/OEPs/tree/master/1). +See the page titled "[Ways to Contribute](https://docs.oceanprotocol.com/concepts/contributing/)" in the Ocean Protocol documentation. ## License From ef618810435846a50413c227509480907d42a379 Mon Sep 17 00:00:00 2001 From: ssallam Date: Mon, 3 Dec 2018 16:53:30 +0100 Subject: [PATCH 2/3] Update the readme file to make it clear what is required to setup before running start_ocean. --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 210477e..24a33a5 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,10 @@ You need to have the newest versions available of both: * [Docker](https://www.docker.com/get-started) * [Docker Compose](https://docs.docker.com/compose/) +Populate the following in `brizo.env` file: +* `PARITY_ADDRESS` and `PARITY_PASSWORD`: necessary for interacting with the keeper-contracts. Use one of the accounts in [Parity Client Accounts](#parity-client-accounts) +* All of the `AZURE_`... related variables: necessary for `Brizo` to serve consume requests + ## Get Started Then bring up an instance of the whole Ocean Protocol network stack with the `start_ocean.sh` script: @@ -48,6 +52,8 @@ This will bring up the `stable` versions of all components, referring to their r To get the `latest` versions of all components, referring to their `develop` branches, pass the argument `--latest`: +To run as a publisher, `Brizo` configuration must be set with valid Azure account credentials. This is done in + ```bash ./start_ocean.sh --latest ``` @@ -117,12 +123,15 @@ then the last-selected Docker Compose file will be used, i.e. the one selected b If you run the `start_ocean.sh` script with the `--local-parity-node` option, you will have available a Parity Client instance with the following accounts enabled: -Account | Password | Balance +Account | Password | Balance --------|----------|-------- 0x00bd138abd70e2f00903268f3db08f2d25677c9e | node0 | 10000000111000111000111000 0x068ed00cf0441e4829d9784fcbe7b9e26d4bd8d0 | secret | 100000000 0xa99d43d86a0758d5632313b8fa3972b6088a21bb | secret | 100000000 + +Use one of the above accounts to populate `PARITY_ADDRESS` and `PARITY_PASSWORD` in `brizo.env` file to avoid asccount `locked` issues from the keeper contracts. + ### Environment Variables The `start_ocean.sh` script and `.env` file sets defaults for the following environment variables but you can use these in combination with the Docker Compose files for further customization, e.g.: @@ -139,7 +148,7 @@ Variable | Description `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. -In addition to these variables, when running Brizo you need to provide the Azure credentials to allow Brizo connect to Azure. These variables can be configured in the file `brizo.env`. +In addition to these variables, when running Brizo you need to provide the Azure credentials to allow Brizo to connect to Azure. These variables can be configured in the file `brizo.env`. ## Contributing From 797b0534a2b9b7822be9b653729890b2f2dabf06 Mon Sep 17 00:00:00 2001 From: ssallam Date: Mon, 3 Dec 2018 17:31:41 +0100 Subject: [PATCH 3/3] Fill in default parity address/password. --- README.md | 1 - brizo.env | 4 ++-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 24a33a5..477cb8f 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,6 @@ You need to have the newest versions available of both: * [Docker Compose](https://docs.docker.com/compose/) Populate the following in `brizo.env` file: -* `PARITY_ADDRESS` and `PARITY_PASSWORD`: necessary for interacting with the keeper-contracts. Use one of the accounts in [Parity Client Accounts](#parity-client-accounts) * All of the `AZURE_`... related variables: necessary for `Brizo` to serve consume requests ## Get Started diff --git a/brizo.env b/brizo.env index 735b028..2f64e90 100755 --- a/brizo.env +++ b/brizo.env @@ -7,8 +7,8 @@ KEEPER_NETWORK_NAME=ocean_poa_net_local SECRET_STORE_URL=http://secret-store:12001 PARITY_URL=http://parity-node:8545 # Set a valid parity address and password to have seamless interaction with the `keeper` -PARITY_ADDRESS= -PARITY_PASSWORD= +PARITY_ADDRESS=0x00bd138abd70e2f00903268f3db08f2d25677c9e +PARITY_PASSWORD=node0 AQUARIUS_URL=http://aquarius:5000 BRIZO_URL=http://brizo:8030