overview.md

At the high level, the main ocean-lib features are accessible via the Ocean instance. Here is a quick overview of the main functions and submodules:

from ocean_lib.ocean.ocean import Ocean
from ocean_lib.config import Config

config = Config('config_local.ini')

# Ocean instance: create/get datatoken, get dtfactory, user orders (history)
ocean = Ocean(config)

# Then use the following submodules...

# Assets: publish, get, list, search, order, consume/download
ocean.assets

# Datatoken Pool: create, add/remove liquidity, check liquidity, price, buy datatokens
ocean.pool

# Fixed rate exchange: create, price, buy datatokens  
ocean.exchange

# Compute-to-data: consume/start, stop, results, status, define-service
ocean.compute

To access functions that are not supported in the above classes, you can directly use the lower level objects:

# DataToken -- ERC20 datatoken
from ocean_lib.models.data_token import DataToken
DataToken(token_address)

# DTFactory -- datatoken factory
from ocean_lib.models.dtfactory import DTFactory
DTFactory(dtfactory_address)

# BPool -- Balancer pool
from ocean_lib.models.bpool import BPool
BPool(pool_address)

# BFactory -- Balancer pool factory
from ocean_lib.models.bfactory import BFactory
BFactory(bfactory_address)