barge

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

• Prerequisites
• Get Started
• Options
  • Component Versions
  • All Options
• Docker Building Blocks
  • Aquarius
  • Provider
  • Ganache
  • ocean-contracts
  • Dashboard
• Contributing
• License

Prerequisites

You need to have the newest versions of:

• Linux or macOS. Windows is not currently supported. If you are on Windows, we recommend running Barge inside a Linux VM. Another option might be to use the Windows Subsystem for Linux (WSL).
• Docker
• Docker Compose

Get Started

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

git clone [email protected]: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.

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.

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

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.

Provider

Ganache

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

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.