Skip to content
main
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.

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 and exposed ports

The default versions are always a combination of component versions which are considered stable.

Component name Required by Version IP Address Ports exposed
ganache ocean-contracts latest 172.15.0.3 8545 -> 8545
ocean-contracts v0.6.5 172.15.0.14
Aquarius v3.0.1 172.15.0.5 5000 -> 5000
Elasticsearch Aquarius 6.8.3 172.15.0.6
Provider v0.4.14 172.15.0.4 8030 -> 8030
Provider2 v0.4.14 172.15.0.7 8030 -> 8030
RBAC Server main 172.15.0.8 3000 -> 3000
GraphNode oceanprotocol/graph-node:latest 172.15.0.15 9000 -> 8000 ,9001 -> 8001 , 9020 -> 8020, 9030 -> 8030, 9040 -> 8040
Graphipfs ipfs/go-ipfs:v0.4.23 172.15.0.16 5001 -> 5001
Graphpgsql postgres 172.15.0.7 5432 -> 5432
Dashboard portainer/portainer 172.15.0.25 9100 -> 9000

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
  • RBAC_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-elasticseach Start up Ocean without the elasticsearch 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.
--with-rbac Start up Ocean with RBAC Server
--with-thegraph Start up Ocean with graphnode, ipfs & postgresql
--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

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:8030 http://localhost:8030

Ganache

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

TheGraph

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

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 9100 http://dashboard:9100 http://localhost:9100 Portainer

RBAC Server

Hostname External Port Internal URL Local URL Description
rbac 3000 http://rbac:3000 http://localhost:3000

The following addresses are preconfigured for testing: (first 10 addresses from the default mnemonic)

Address Roles
0xe2DD09d719Da89e5a3D0F2549c7E24566e947260 ["user","publisher","consumer"]
0xBE5449a6A97aD46c8558A3356267Ee5D2731ab5e ["user","publisher","consumer"]
0xA78deb2Fa79463945C247991075E2a0e98Ba7A09 ["user","publisher","consumer"]
0x02354A1F160A3fd7ac8b02ee91F04104440B28E7 ["user","publisher","consumer"]
0xe17D2A07EFD5b112F4d675ea2d122ddb145d117B ["user","publisher","consumer"]
0xA32C84D2B44C041F3a56afC07a33f8AC5BF1A071 ["user","publisher","consumer"]
0xFF3fE9eb218EAe9ae1eF9cC6C4db238B770B65CC ["user"]
0x529043886F21D9bc1AE0feDb751e34265a246e47 ["consumer"]
0xe08A1dAe983BC701D05E492DB80e0144f8f4b909 ["publisher"]
0xbcE5A3468386C64507D30136685A99cFD5603135 ["consumer","publisher"]

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.