diff --git a/README.md b/README.md index 3a8070d..a979120 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ cd barge ./start_ocean.sh ``` -That will run the current default versions of Aquarius, Brizo, Pleuston, Keeper Contracts, and Faucet. It will also run a local Spree network (i.e. `--local-spree-node`). +That will run the current default versions of Aquarius, Brizo, Events handler, Pleuston, Keeper Contracts, and Faucet. It will also run a local Spree network (i.e. `--local-spree-node`). Welcome to Ocean Protocol @@ -57,15 +57,15 @@ docker system prune --all --volumes ## Options -The startup script comes with a set of options for customizing variou things. +The startup script comes with a set of options for customizing various things. ### Component Versions The default versions are always a combination of component versions which are considered stable. -| Aquarius | Brizo | Keeper | Pleuston | Faucet | -| -------- | --------- | --------- | -------- | -------- | -| `v0.3.8` | `v0.3.14` | `v0.10.3` | `v0.5.0` | `v0.2.6` | +| Aquarius | Brizo | Events handler | Keeper | Pleuston | Faucet | +| -------- | --------- | -------------- | --------- | -------- | -------- | +| `v0.3.8` | `v0.3.14` | `v0.1.1` | `v0.10.3` | `v0.5.0` | `v0.2.6` | You can use the `--latest` option to pull the most recent Docker images for all components, which are always tagged as `latest` in Docker. The `latest` Docker image tag derives from the default main branch of the component's Git repo. @@ -73,6 +73,7 @@ You can override the Docker image tag used for a particular component by setting - `AQUARIUS_VERSION` - `BRIZO_VERSION` +- `EVENTS_HANDLER_VERSION` - `KEEPER_VERSION` - `PLEUSTON_VERSION` - `FAUCET_VERSION` @@ -96,6 +97,7 @@ will use the default Docker image tags for Aquarius, Keeper Contracts and Pleust | `--no-pleuston` | Start up Ocean without the `pleuston` Building Block. Helpful for development on `pleuston`. | | `--no-aquarius` | Start up Ocean without the `aquarius` Building Block. | | `--no-brizo` | Start up Ocean without the `brizo` Building Block. | +| `--no-events-handler` | Start up Ocean without the `events handler` Building Block. | | `--no-secret-store` | Start up Ocean without the `secret-store` Building Block. | | `--no-faucet` | Start up Ocean without the `faucet` Building Block. | | `--mongodb` | Start up Ocean with MongoDB as DB engine for Aquarius instead of Elasticsearch. | @@ -146,6 +148,14 @@ By default it will start one container. This Building Block can be disabled by s | -------- | ------------- | ----------------- | --------------------- | ----------------------------------------------- | | `brizo` | `8030` | http://brizo:8030 | http://localhost:8030 | [Brizo](https://github.com/oceanprotocol/brizo) | +### Events handler + +By default it will start one container. This Building Block can be disabled by setting the `--no-events-handler` flag. + +| Hostname | External Port | Internal URL | Local URL | Description | +| ----------------- | ------------- | ----------------- | --------------------- | -------------------------------------------------------------------- | +| `events-handler` | | | | [Events-handler](https://github.com/oceanprotocol/events-handler-py) | + ### Keeper Node Controlled by the `--local-*-node` config switches will start a container `keeper-node` that uses port `8545` to expose an rpc endpoint to the Ethereum Protocol. @@ -207,7 +217,11 @@ you will have available a keeper node in the local and private Spree Network wit | `0xe08A1dAe983BC701D05E492DB80e0144f8f4b909` | mnemonic | [info here](#spree-mnemonic) | 1000000000 Ether | | `0xbcE5A3468386C64507D30136685A99cFD5603135` | mnemonic | [info here](#spree-mnemonic) | 1000000000 Ether | -Use one of the above accounts to populate `PARITY_ADDRESS` and `PARITY_PASSWORD` in `brizo.env` file to avoid account `locked` issues from the keeper contracts. +Use one of the above accounts to populate `PROVIDER_ADDRESS`, `PROVIDER_PASSWORD` and `PROVIDER_KEYFILE` in `start_ocean.sh`. +This account will is used in `brizo` and `events-handler` as the `provider` account which is important for processing the +service agreements flow. The `PROVIDER_KEYFILE` must be placed in the `accounts` folder and must match the ethereum +address from `PROVIDER_ADDRESS`. The `PROVIDER_ADDRESS` is also set in `pleuston` instance so that published assets get +assigned the correct provider address. ### Spree Mnemonic diff --git a/compose-files/brizo.yml b/compose-files/brizo.yml index 265d442..aecac7f 100644 --- a/compose-files/brizo.yml +++ b/compose-files/brizo.yml @@ -17,9 +17,9 @@ services: PARITY_URL: ${SIGNING_NODE_URL} LOCAL_CONTRACTS: ${KEEPER_DEPLOY_CONTRACTS} SECRET_STORE_URL: ${SECRET_STORE_URL} - PARITY_ADDRESS: ${PROVIDER_ADDRESS} - PARITY_PASSWORD: ${PROVIDER_PASSWORD} - PARITY_KEYFILE: ${PROVIDER_KEYFILE} + PROVIDER_ADDRESS: ${PROVIDER_ADDRESS} + PROVIDER_PASSWORD: ${PROVIDER_PASSWORD} + PROVIDER_KEYFILE: ${PROVIDER_KEYFILE} LOG_LEVEL: ${BRIZO_LOG_LEVEL} volumes: - ${KEEPER_ARTIFACTS_FOLDER}:/usr/local/keeper-contracts:ro diff --git a/compose-files/events_handler.yml b/compose-files/events_handler.yml index cc71414..352765c 100644 --- a/compose-files/events_handler.yml +++ b/compose-files/events_handler.yml @@ -1,7 +1,7 @@ version: '3' services: events-handler: - image: oceanprotocol/ocean-events-handler:$EVENTS_HANDLER_VERSION + image: oceanprotocol/events-handler-py:$EVENTS_HANDLER_VERSION networks: backend: ipv4_address: 172.15.0.22 @@ -11,9 +11,9 @@ services: KEEPER_URL: ${KEEPER_RPC_URL} PARITY_URL: ${SIGNING_NODE_URL} SECRET_STORE_URL: ${SECRET_STORE_URL} - PARITY_ADDRESS: ${PROVIDER_ADDRESS} - PARITY_PASSWORD: ${PROVIDER_PASSWORD} - PARITY_KEYFILE: ${PROVIDER_KEYFILE} + PROVIDER_ADDRESS: ${PROVIDER_ADDRESS} + PROVIDER_PASSWORD: ${PROVIDER_PASSWORD} + PROVIDER_KEYFILE: ${PROVIDER_KEYFILE} LOCAL_CONTRACTS: ${KEEPER_DEPLOY_CONTRACTS} LOG_LEVEL: ${EVENTS_HANDLER_LOG_LEVEL} volumes: diff --git a/start_ocean.sh b/start_ocean.sh index d5c3099..4881c68 100755 --- a/start_ocean.sh +++ b/start_ocean.sh @@ -15,7 +15,7 @@ COMPOSE_DIR="${DIR}/compose-files" # Default versions of Aquarius, Brizo, Keeper Contracts and Pleuston export AQUARIUS_VERSION=${AQUARIUS_VERSION:-v0.3.8} export BRIZO_VERSION=${BRIZO_VERSION:-v0.3.14} -export EVENTS_HANDLER_VERSION=${EVENTS_HANDLER_VERSION:v0.1.0} +export EVENTS_HANDLER_VERSION=${EVENTS_HANDLER_VERSION:-latest} export KEEPER_VERSION=${KEEPER_VERSION:-v0.10.3} export PLEUSTON_VERSION=${PLEUSTON_VERSION:-v0.5.1} export FAUCET_VERSION=${FAUCET_VERSION:-v0.2.6}