🐳 Docker Compose files for the full Ocean Protocol stack
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
md00ux ab52738923 blockscout 1 year ago
.github Update CODEOWNERS 1 year ago
compose-files blockscout 1 year ago
.banner add discord link 2 years ago
.gitignore cleanup 2 years ago
LICENSE Initial commit 4 years ago
README.md blockscout 1 year ago
Welcome_to_Ocean_Protocol.png update version options docs 3 years ago
start_ocean.sh blockscout 1 year ago

README.md

banner

barge

🐳 Docker Compose files for the full Ocean Protocol stack running locally for development.



Prerequisites

You need to have the newest versions of:

Get Started

If you're new to Barge, it's best to start with the defaults:

git clone git@github.com:oceanprotocol/barge.git
cd barge

./start_ocean.sh

This will run the current default versions of Aquarius, Provider, and Ganache with our contracts deployed to it.

Welcome to Ocean Protocol

It's overkill, but to be sure that you use exactly the Docker images and volumes you want, you can prune all the Docker things in your system first:

docker system prune --all --volumes

Options

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 Provider Ganache ocean-contracts
v2.2.6 v0.4.9 latest V0.5.9

You can override the Docker image tag used for a particular component by setting its associated environment variable before calling start_ocean.sh:

  • AQUARIUS_VERSION
  • PROVIDER_VERSION
  • CONTRACTS_VERSION

For example:

export AQUARIUS_VERSION=v2.0.0
./start_ocean.sh

All Options

Option Description
--no-aquarius Start up Ocean without the aquarius Building Block.
--no-provider Start up Ocean without the provider Building Block.
--with-provider2 Runs a 2nd provider, on port 8031. This is required for ocean.js/ocean.py integration tests. 2nd Provider will use the same image and parameters (log_level, ipfs gateway, compute gateway, etc) as provider1, but has a different private key
--no-ganache Start up Ocean without the ganache Building Block.
--no-dashboard Start up Ocean without the dashboard Building Block.
--skip-deploy Start up Ocean without deploying the contracts. Useful when ethereum node already has contracts.
--force-pull Force pulling the latest revision of the used Docker images.
--purge Removes the Docker containers, volumes, artifact folder and networks used by the script.
--exposeip Binds the components to that specific ip. Example: ./start_ocean.sh --exposeip 192.168.0.1
--no-explorer Start up Ocean without blockscout Building Block.

Docker Building Blocks

Barge consists of a set of building blocks that can be combined to form a local test environment. By default all building blocks will be started by the start_ocean.sh script.

Aquarius

By default it will start two containers (one for Aquarius and one for its database engine). By default, Barge will use Elasticsearch for its database engine.

This Building Block can be disabled by setting the --no-aquarius flag.

Hostname External Port Internal URL Local URL Description
aquarius 5000 http://aquarius:5000 http://localhost:5000 Aquarius
elasticsearch The Elasticsearch used by Aquarius

Provider

Hostname External Port Internal URL Local URL Description
provider 8030 http://provider:9000 http://localhost:8030

Ganache

Hostname External Port Internal URL Local URL Description
ganache 8545 http://ganache:9000 http://localhost:8545

ocean-contracts

  • Deploy all smart contracts from the ocean-contracts repo
  • Export artifacts files (.json) to default shared folder between all containers
  • Create address file (address.json) that has the address of each deployed smart contract that is required by the ocean library. This file is saved to the same folder with the artifacts files

The accounts can be accessed with this seed phrase:

taxi music thumb unique chat sand crew more leg another off lamp

Alternatively, you can pass your own mnemonic with GANACHE_MNEMONIC.

Dashboard

This will start a portainer dashboard with the following admin credentials and connects to the local docker host. This Building Block can be disabled by setting the --no-dashboard flag.

  • User: admin
  • Password: oceanprotocol
Hostname External Port Internal URL Local URL Description
dashboard 9000 http://dashboard:9000 http://localhost:9000 Portainer

Blockscout

This will start an explorer docker container. This Building Block can be disabled by setting the --no-explorer flag.

Hostname External Port Internal URL Local URL Description
explorer 4000 http://explorer:4000 http://localhost:4000 Blockscout

Contributing

See the page titled "Ways to Contribute" in the Ocean Protocol documentation.

License

Copyright 2021 Ocean Protocol Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.