mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
content updates
This commit is contained in:
parent
a256d07f1c
commit
456acc645a
@ -3,4 +3,14 @@ title: Architecture
|
|||||||
description: The architecture of Ocean Protocol with all its components and how they work together.
|
description: The architecture of Ocean Protocol with all its components and how they work together.
|
||||||
---
|
---
|
||||||
|
|
||||||
|
In the [Ecosystem overview](/concepts/ecosystem/) you got an overview about the components making up the Ocean Protocol network:
|
||||||
|
|
||||||
|
- [💧 keeper-contracts](https://github.com/oceanprotocol/keeper-contracts)
|
||||||
|
- [🐋 aquarius](https://github.com/oceanprotocol/aquarius)
|
||||||
|
- [brizo](https://github.com/oceanprotocol/brizo)
|
||||||
|
- [🦄 pleuston](https://github.com/oceanprotocol/pleuston)
|
||||||
|
- [🦑 squid-js](https://github.com/oceanprotocol/squid-js)
|
||||||
|
|
||||||
|
They work together in various ways:
|
||||||
|
|
||||||
![Ocean Protocol Components](images/components.png 'Ocean Protocol Components')
|
![Ocean Protocol Components](images/components.png 'Ocean Protocol Components')
|
||||||
|
@ -1,12 +1,36 @@
|
|||||||
---
|
---
|
||||||
title: Ecosystem
|
title: Ecosystem
|
||||||
description: The Ocean Protocol network consists of various components.
|
description: The Ocean Protocol network consists of various components. Learn about all of them here.
|
||||||
---
|
---
|
||||||
|
|
||||||
Learn about all of them here.
|
## Keeper-contracts
|
||||||
|
|
||||||
- 💧 keeper. See also [Set Up a Keeper](/setup/keeper/)
|
See also [Set Up a Keeper](/setup/keeper/)
|
||||||
- 🐋 aquarius
|
|
||||||
- brizo
|
- [💧 keeper-contracts](https://github.com/oceanprotocol/keeper-contracts)
|
||||||
- 🦄 pleuston
|
|
||||||
- 🦑 squid
|
## Aquarius
|
||||||
|
|
||||||
|
Aquarius provides an off-chain database store for metadata about data assets. Every marketplace must run an instance of Aquarius.
|
||||||
|
|
||||||
|
- [🐋 aquarius](https://github.com/oceanprotocol/aquarius)
|
||||||
|
|
||||||
|
## Brizo
|
||||||
|
|
||||||
|
Brizo is the technical component executed by Publishers allowing them to provide extended data services. Brizo, as part of the Publisher ecosystem, includes the credentials to interact with the infrastructure (initially cloud, but could be on-premise).
|
||||||
|
|
||||||
|
- [brizo](https://github.com/oceanprotocol/brizo)
|
||||||
|
|
||||||
|
## Pleuston
|
||||||
|
|
||||||
|
An example marketplace front-end for consumers to explore, download, and publish data assets within the Ocean Protocol network. Implemented using React and squid-js.
|
||||||
|
|
||||||
|
- [🦄 pleuston](https://github.com/oceanprotocol/pleuston)
|
||||||
|
|
||||||
|
## Squid
|
||||||
|
|
||||||
|
Client libraries used by applications to interact with Ocean nodes, including Keepers, Aquarius nodes, Brizo nodes, etc.
|
||||||
|
|
||||||
|
- [🦑 squid-js](https://github.com/oceanprotocol/squid-js)
|
||||||
|
- [🦑 squid-py](https://github.com/oceanprotocol/squid-py)
|
||||||
|
- [🦑 squid-java](https://github.com/oceanprotocol/squid-java)
|
||||||
|
@ -5,7 +5,9 @@ description: Get up to speed with Ocean Protocol
|
|||||||
|
|
||||||
## What is Ocean Protocol?
|
## What is Ocean Protocol?
|
||||||
|
|
||||||
It's a decentralized data exchange protocol to unlock data for artificial intelligence (AI).
|
Ocean Protocol is an ecosystem for the data economy and associated services. It provides a tokenized service layer that exposes data, storage, compute and algorithms for consumption with a set of deterministic proofs on availability and integrity that serve as verifiable service agreements. There is staking on services to signal quality, reputation and ward against Sybil Attacks.
|
||||||
|
|
||||||
|
Ocean helps to unlock data, particularly for AI. It is designed for scale and uses blockchain technology that allows data to be shared and sold in a safe, secure and transparent manner.
|
||||||
|
|
||||||
While vast amounts of data are generated each year, data exchange and analysis have been hampered due largely to concerns over trust and security. Currently, many organizations have data but do not have the trusted and secure means to share it. Without data, AI cannot advance and be applied to solve problems and ultimately improve lives. More pressing is the fact that today, only a handful of companies have both AI and data capacities, and if data remains locked up, these companies could very well govern the development of AI and thereby our future.
|
While vast amounts of data are generated each year, data exchange and analysis have been hampered due largely to concerns over trust and security. Currently, many organizations have data but do not have the trusted and secure means to share it. Without data, AI cannot advance and be applied to solve problems and ultimately improve lives. More pressing is the fact that today, only a handful of companies have both AI and data capacities, and if data remains locked up, these companies could very well govern the development of AI and thereby our future.
|
||||||
|
|
||||||
@ -17,6 +19,6 @@ There are more details on the
|
|||||||
[Ocean Protocol home page](https://oceanprotocol.com/),
|
[Ocean Protocol home page](https://oceanprotocol.com/),
|
||||||
and in the whitepapers:
|
and in the whitepapers:
|
||||||
|
|
||||||
* [Technical Whitepaper](https://oceanprotocol.com/tech-whitepaper.pdf)
|
- [Technical Whitepaper](https://oceanprotocol.com/tech-whitepaper.pdf)
|
||||||
* [Business Whitepaper](https://oceanprotocol.com/business-whitepaper.pdf)
|
- [Business Whitepaper](https://oceanprotocol.com/business-whitepaper.pdf)
|
||||||
* [Reference Marketplace Framework](https://oceanprotocol.com/marketplace-framework.pdf)
|
- [Reference Marketplace Framework](https://oceanprotocol.com/marketplace-framework.pdf)
|
||||||
|
@ -22,26 +22,10 @@ A service where publishers can list what assets they have, and consumers can see
|
|||||||
## Keeper
|
## Keeper
|
||||||
|
|
||||||
A computer running a blockchain client (i.e. a blockchain node)
|
A computer running a blockchain client (i.e. a blockchain node)
|
||||||
where the associated blockchain network is running the
|
where the associated blockchain network is running the Ocean Protocol
|
||||||
[Ocean Protocol keeper contracts](https://github.com/oceanprotocol/keeper-contracts)
|
[💧 keeper-contracts](https://github.com/oceanprotocol/keeper-contracts)
|
||||||
(smart contracts).
|
(smart contracts).
|
||||||
|
|
||||||
## Aquarius
|
|
||||||
|
|
||||||
Ocean-specific software to help store and manage metadata about assets (but not assets themselves). Every marketplace must run an instance of Aquarius.
|
|
||||||
|
|
||||||
## Brizo
|
|
||||||
|
|
||||||
Ocean-specific software to help publishers manage consumer access to their assets.
|
|
||||||
|
|
||||||
## Secret Store
|
## Secret Store
|
||||||
|
|
||||||
[Parity Secret Store](https://wiki.parity.io/Secret-Store): software for distributed key pair generation, distributed key storage, and threshold retrieval.
|
[Parity Secret Store](https://wiki.parity.io/Secret-Store): software for distributed key pair generation, distributed key storage, and threshold retrieval.
|
||||||
|
|
||||||
## squid-py, squid-js, squid-java, etc.
|
|
||||||
|
|
||||||
Software libraries used by applications to interact with Ocean nodes, including Keepers, Aquarius nodes, Brizo nodes, etc.
|
|
||||||
|
|
||||||
## Pleuston
|
|
||||||
|
|
||||||
An example marketplace website frontend implemented using React and squid-js.
|
|
||||||
|
@ -3,3 +3,5 @@ title: Set Up a Keeper
|
|||||||
---
|
---
|
||||||
|
|
||||||
This page is a placeholder for now.
|
This page is a placeholder for now.
|
||||||
|
|
||||||
|
- [💧 keeper-contracts](https://github.com/oceanprotocol/keeper-contracts)
|
||||||
|
@ -5,8 +5,8 @@ description: Fill me
|
|||||||
|
|
||||||
If you want to set up a marketplace for the Ocean network, then you could start by running the following tech stack:
|
If you want to set up a marketplace for the Ocean network, then you could start by running the following tech stack:
|
||||||
|
|
||||||
1. Pleuston
|
1. [🦄 pleuston](https://github.com/oceanprotocol/pleuston)
|
||||||
1. Aquarius
|
1. [🐋 aquarius](https://github.com/oceanprotocol/aquarius)
|
||||||
1. A database for Aquarius
|
1. A database for Aquarius
|
||||||
|
|
||||||
Then you could modify that stack to better suit your needs.
|
Then you could modify that stack to better suit your needs.
|
||||||
@ -16,10 +16,12 @@ Let's take a closer look inside each of those components.
|
|||||||
|
|
||||||
Pleuston is an example Ocean marketplace written in JavaScript using React and Redux.
|
Pleuston is an example Ocean marketplace written in JavaScript using React and Redux.
|
||||||
It uses the squid-js library to interact with Ocean network services, such as Keepers, Brizo nodes, Secret Stores, and your own Aquarius node.
|
It uses the squid-js library to interact with Ocean network services, such as Keepers, Brizo nodes, Secret Stores, and your own Aquarius node.
|
||||||
|
|
||||||
Pleuston runs entirely in the browser, i.e. Pleuston has no server-side part. It communicates directly with Keepers etc.
|
Pleuston runs entirely in the browser, i.e. Pleuston has no server-side part. It communicates directly with Keepers etc.
|
||||||
|
|
||||||
You _could_ build an Ocean marketplace with a browser-side frontend and a server-side part.
|
You _could_ build an Ocean marketplace with a browser-side frontend and a server-side part.
|
||||||
For example, the server-side part could be written in Python and it could use the squid-py library.
|
For example, the server-side part could be written in Python and it could use the squid-py library.
|
||||||
|
|
||||||
Currently, there is no explicit example of how to do that, but there are examples of how to use squid-py, e.g. from IPython running in a Jupyter notebook.
|
Currently, there is no explicit example of how to do that, but there are examples of how to use squid-py, e.g. from IPython running in a Jupyter notebook.
|
||||||
See the Tutorials section.
|
See the Tutorials section.
|
||||||
|
|
||||||
@ -31,7 +33,7 @@ Note: There's also a squid-java library but it's currently not as full-featured
|
|||||||
|
|
||||||
Aquarius is an application used by Marketplaces to store, update, read and delete metadata about assets. The Squid libraries all know how to talk to Aquarius, so you don't need to think about it or its API too much. You just need to make sure you have Aquarius running on a server somewhere.
|
Aquarius is an application used by Marketplaces to store, update, read and delete metadata about assets. The Squid libraries all know how to talk to Aquarius, so you don't need to think about it or its API too much. You just need to make sure you have Aquarius running on a server somewhere.
|
||||||
|
|
||||||
TODO: Link to instructions.
|
TODO: Add instructions here.
|
||||||
|
|
||||||
## Database for Aquarius
|
## Database for Aquarius
|
||||||
|
|
||||||
|
@ -41,7 +41,7 @@ $font-size-h5: 1.125rem;
|
|||||||
$font-weight-base: 500;
|
$font-weight-base: 500;
|
||||||
$font-weight-bold: 600;
|
$font-weight-bold: 600;
|
||||||
|
|
||||||
$line-height: 1.5;
|
$line-height: 1.6;
|
||||||
|
|
||||||
// Sizes
|
// Sizes
|
||||||
$spacer: 2rem;
|
$spacer: 2rem;
|
||||||
|
Loading…
Reference in New Issue
Block a user