oceanprotocol/docs
1
0
Fork 0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-26 19:49:26 +01:00
Code Releases Activity

wip update components for v3.

Browse Source
This commit is contained in:
trentmc 2020-10-16 12:46:59 +02:00
parent 430d6b2d60
commit d69c2cdfd7
1 changed files with 5 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
content/concepts/components.md
View File

@ -1,53 +1,16 @@
---
title: Software Components
description: Every Ocean network is brought to life by many interacting symbiotic software components.
description: Ocean components are tools meant to stay as simple as possible.
---
Before reading this page, you should understand some [Ocean-specific terminology](/concepts/terminology/).
## Aquarius - Metadata Cache
## Keeper
Metadata is stored on-chain.
A computer running an EVM-compatible blockchain client
(such as [Parity Ethereum](https://www.parity.io/ethereum/))
where the associated blockchain network is running the Ocean Protocol
[keeper-contracts](https://github.com/oceanprotocol/keeper-contracts)
(smart contracts).
<repo name="keeper-contracts"></repo>
See also: [Run a Keeper](/setup/keeper/)
## Secret Store
A [Parity Secret Store](https://wiki.parity.io/Secret-Store): software for distributed key pair generation, distributed key storage, and threshold retrieval. It's used to store [asset](/concepts/terminology/#asset-or-data-asset) access-control keys.
<repo name="parity-ethereum"></repo>
There are several clients for integrating the Parity Secret Store into Ocean:
<repo name="secret-store-client-js"></repo>
<repo name="secret-store-client-py"></repo>
<repo name="secret-store-client-java"></repo>
## Aquarius
Marketplaces run Aquarius to store and manage metadata about the [assets](/concepts/terminology/#asset-or-data-asset) available in their marketplace. It provides an HTTP API for interacting with an off-chain database (sometimes called "OceanDB").
To improve GUI responsiveness, Ocean Market runs Aquarius to retrieve the metadata from the chain and cache it locally (using MongoDB).
<repo name="aquarius"></repo>
### OceanDB Drivers
Aquarius supports several options for the off-chain database (OceanDB), including Elasticsearch and MongoDB. One can add support for another off-chain database by creating a new driver similar to the existing OceanDB drivers.
<repo name="oceandb-elasticsearch-driver"></repo>
<repo name="oceandb-mongodb-driver"></repo>
> There is also a [BigchainDB driver](https://github.com/oceanprotocol/oceandb-bigchaindb-driver) but it hasn't been maintained.
You can create your own OceanDB drivers by extending on the `oceandb-driver-interface`.
<repo name="oceandb-driver-interface"></repo>
## Brizo
Publishers run Brizo to manage interactions with marketplaces and consumers.
@ -80,7 +43,7 @@ You can create your own Osmosis drivers by extending on the `osmosis-driver-inte
<repo name="osmosis-driver-interface"></repo>
## Squid Libraries
## JavaScript & Python Drivers
Client libraries used by applications (such as Pleuston or Jupyter notebooks) to interact with Ocean components, including Keepers, Aquarius nodes, Brizo nodes, etc.
@ -99,9 +62,3 @@ For more information, see [the blog post about Commons Marketplace](https://blog
<repo name="commons"></repo>
The Commons Marketplace is also the default frontend when running a full Ocean network locally with [Barge](/setup/quickstart/).
## Pleuston (deprecated)
An example marketplace/publisher front-end for developers to explore, download, and publish [assets](/concepts/terminology/#asset-or-data-asset) in an Ocean Protocol network. Implemented using [React](https://reactjs.org/) and [squid-js](https://github.com/oceanprotocol/squid-js).
<repo name="pleuston"></repo>