1
0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-02 00:05:35 +01:00
docs/content/concepts/components.md

71 lines
2.5 KiB
Markdown
Raw Normal View History

---
title: Software Components
description: The Ocean Protocol network is brought to life by many interacting symbiotic software components.
---
Before reading this page, you should understand some [Ocean-specific terminology](/concepts/terminology/).
## Aquarius
2018-11-15 15:45:07 +01:00
Aquarius provides an API to an off-chain database ("OceanDB") to store and manage metadata about data assets: the assets listed in that marketplace. Every marketplace must run an instance of Aquarius.
The off-chain database might be MongoDB, Elasticsearch or BigchainDB.
2018-11-16 13:17:47 +01:00
<repo name="aquarius"></repo>
## Brizo
Publishers run Brizo to manage access control to assets on behalf of asset owners or data service providers.
<repo name="brizo"></repo>
## Keeper
A computer running a 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: [Set Up a Keeper](/setup/keeper/)
## Pleuston
An example marketplace front-end for consumers to explore, download, and publish data assets within the Ocean Protocol network. Implemented using [React](https://reactjs.org/) and [🦑 squid-js](https://github.com/oceanprotocol/squid-js).
<repo name="pleuston"></repo>
2018-11-12 14:07:04 +01:00
## Squid Libraries
Client libraries used by applications (such as Pleuston or Jupyter notebooks) to interact with Ocean components, including Keepers, Aquarius nodes, Brizo nodes, etc.
![How Squid is Used](images/Squid_role_diagram_small.jpg)
2018-11-14 15:07:19 +01:00
2018-11-12 14:07:04 +01:00
<repo name="squid-js"></repo>
<repo name="squid-py"></repo>
<repo name="squid-java"></repo>
2018-11-16 15:38:51 +01:00
## OceanDB Drivers
2018-11-16 16:06:15 +01:00
OceanDB is an off-chain database for storing metadata about data assets.
2018-11-16 15:38:51 +01:00
<repo name="oceandb-mongodb-driver"></repo>
<repo name="oceandb-bigchaindb-driver"></repo>
<repo name="oceandb-elasticsearch-driver"></repo>
2018-11-19 16:00:05 +01:00
These drivers are extended from a high-level module implementing OceanDB functions. You can create your own plugins based on its abstracted interface:
2018-11-16 15:38:51 +01:00
<repo name="oceandb-driver-interface"></repo>
## 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 access-control keys.
2018-11-12 14:07:04 +01:00
We have created multiple clients for integrating the Parity Secret Store into Ocean:
2018-11-12 14:07:04 +01:00
<repo name="secret-store-client-js"></repo>
<repo name="secret-store-client-py"></repo>
<repo name="secret-store-client-java"></repo>