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

Revise the def'n of Assets & link to it more

Browse Source
This commit is contained in:
Troy McConaghy 2019-02-22 13:24:46 +01:00
parent 97af514a1c
commit fc5709c431
4 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
content/concepts/components.md
View File

@ -7,7 +7,7 @@ Before reading this page, you should understand some [Ocean-specific terminology
## Aquarius ## Aquarius
Marketplaces run Aquarius to store and manage metadata about the data assets available in their marketplace. It provides an HTTP API for interacting with an off-chain database ([OceanDB](/concepts/components/#oceandb-drivers)). 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 ([OceanDB](/concepts/components/#oceandb-drivers)).
<repo name="aquarius"></repo> <repo name="aquarius"></repo>
@ -15,7 +15,7 @@ Marketplaces run Aquarius to store and manage metadata about the data assets ava
Publishers run Brizo to manage interactions with marketplaces and consumers. Publishers run Brizo to manage interactions with marketplaces and consumers.
It interacts with the publisher's cloud and/or on-premise infrastructure. It interacts with the publisher's cloud and/or on-premise infrastructure.
The most basic scenario for a publisher is to provide access to the assets the publisher owns or manages, but [Brizo can do much more](/concepts/architecture/#brizo). The most basic scenario for a publisher is to provide access to the [assets](/concepts/terminology/#asset-or-data-asset) the publisher owns or manages, but [Brizo can do much more](/concepts/architecture/#brizo).
<repo name="brizo"></repo> <repo name="brizo"></repo>
@ -33,7 +33,7 @@ See also: [Run a Keeper](/setup/keeper/)
## Pleuston ## 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). An example marketplace front-end for consumers to explore, download, and publish [assets](/concepts/terminology/#asset-or-data-asset) within the Ocean Protocol network. Implemented using [React](https://reactjs.org/) and [🦑 squid-js](https://github.com/oceanprotocol/squid-js).
<repo name="pleuston"></repo> <repo name="pleuston"></repo>
@ -49,7 +49,7 @@ Client libraries used by applications (such as Pleuston or Jupyter notebooks) to
## OceanDB Drivers ## OceanDB Drivers
OceanDB is an off-chain database for storing metadata about data assets. OceanDB is an off-chain database for storing metadata about [assets](/concepts/terminology/#asset-or-data-asset).
<repo name="oceandb-mongodb-driver"></repo> <repo name="oceandb-mongodb-driver"></repo>
<repo name="oceandb-bigchaindb-driver"></repo> <repo name="oceandb-bigchaindb-driver"></repo>
@ -61,7 +61,7 @@ These drivers are extended from a high-level module implementing OceanDB functio
## Secret Store ## 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. 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.
There are several clients for integrating the Parity Secret Store into Ocean: There are several clients for integrating the Parity Secret Store into Ocean:

6
content/concepts/terminology.md
View File

@ -5,7 +5,7 @@ description: Terminology specific to Ocean Protocol.
## Asset or Data Asset ## Asset or Data Asset
A data set or data service. Anything that can be registered with and made available via the Ocean Network. Examples include data sets, trained model parameters, pipelines, and data-cleaning services.
## Data Owner or Data Service Provider ## Data Owner or Data Service Provider
@ -17,7 +17,7 @@ Note: Initially, most data owners or data service providers will also be the pub
A service which mediates access to assets on behalf of data owners or data service providers. A service which mediates access to assets on behalf of data owners or data service providers.
Note: Initially, most publishers will also be the owners of the data assets they publish. Note: Initially, most publishers will also be the owners of the assets they publish.
## Consumer ## Consumer
@ -33,7 +33,7 @@ A person or a software service that checks some steps in transactions. For examp
## Service Execution Agreement (SEA) ## Service Execution Agreement (SEA)
A contract-like agreement between a provider, a consumer, and a verifier, specifying what data assets are to be delivered (from provider to consumer), the conditions that must be met, and the rewards for fulfilling the conditions. A contract-like agreement between a provider, a consumer, and a verifier, specifying what assets are to be delivered (from provider to consumer), the conditions that must be met, and the rewards for fulfilling the conditions.
We published an [Ocean Protocol blog post that explains SEAs in more detail](https://blog.oceanprotocol.com/exploring-the-sea-service-execution-agreements-65f7523d85e2). We published an [Ocean Protocol blog post that explains SEAs in more detail](https://blog.oceanprotocol.com/exploring-the-sea-service-execution-agreements-65f7523d85e2).

12
content/setup/marketplace.md
View File

@ -5,20 +5,20 @@ description: Set up and run a data marketplace in the Ocean network.
## What Does it Mean to Set Up a Marketplace? ## What Does it Mean to Set Up a Marketplace?
An Ocean marketplace app is one of the primary ways that end users use the Ocean network. For example, a data scientist could use a marketplace app to see what data sets and data services (data assets) a marketplace has available. They can use the marketplace app to buy access to assets. Publishers make those data assets available. An Ocean marketplace app is one of the primary ways that end users use the Ocean network. For example, a data scientist could use a marketplace app to see what [assets](/concepts/terminology/#asset-or-data-asset) a marketplace has available. They can use the marketplace app to buy access to assets. Publishers make those assets available.
**Note: In the early days of the Ocean network, there won't be many marketplaces or publishers, so marketplaces will often also act as publishers.** **Note: In the early days of the Ocean network, there won't be many marketplaces or publishers, so marketplaces will often also act as publishers.**
If you want to set up and run a marketplace in the Ocean network, then at a technical level, you must: If you want to set up and run a marketplace in the Ocean network, then at a technical level, you must:
1. Have [Data Assets](/concepts/terminology/#asset-or-data-asset) to offer in your marketplace. 1. Have [assets](/concepts/terminology/#asset-or-data-asset) to offer in your marketplace.
1. Get those data assets set up to work with Ocean Protocol. 1. Get those assets set up to work with Ocean Protocol.
1. Develop a marketplace application (app). 1. Develop a marketplace application (app).
1. Run your marketplace app in production. 1. Run your marketplace app in production.
## Prepare Data Assets ## Prepare Assets
At the time of writing, the following kinds of [data assets](/concepts/terminology/#asset-or-data-asset) were supported: At the time of writing, the following kinds of [assets](/concepts/terminology/#asset-or-data-asset) were supported:
- data sets stored in Azure Storage (i.e. with "core.windows.net" in their URL). See [the tutorial about setting up Azure Storage to work with Ocean Protocol](/tutorials/azure-for-brizo/). - data sets stored in Azure Storage (i.e. with "core.windows.net" in their URL). See [the tutorial about setting up Azure Storage to work with Ocean Protocol](/tutorials/azure-for-brizo/).
- data sets stored in Amazon S3 storage (i.e. with "s3://" in their URL). See [the tutorial about setting up Amazon S3 storage to work with Ocean Protocol](/tutorials/amazon-s3-for-brizo/). - data sets stored in Amazon S3 storage (i.e. with "s3://" in their URL). See [the tutorial about setting up Amazon S3 storage to work with Ocean Protocol](/tutorials/amazon-s3-for-brizo/).
@ -26,7 +26,7 @@ At the time of writing, the following kinds of [data assets](/concepts/terminolo
Note: You can use _all_ of the above. You aren't restricted to using only one storage provider. Note: You can use _all_ of the above. You aren't restricted to using only one storage provider.
Support for other kinds of data assets (e.g. computing in Azure) is coming. Support for other kinds of assets (e.g. computing in Azure) is coming.
## Develop a Marketplace App ## Develop a Marketplace App

2
content/tutorials/react-publish-data-set.md
View File

@ -11,7 +11,7 @@ Open `src/App.js` in your marketplace app from the [React App Setup](/tutorials/
## Define Asset ## Define Asset
First, let's add the asset that we want to publish. First, let's add the [asset](/concepts/terminology/#asset-or-data-asset) that we want to publish.
To do that, we need to add the following code after `window.ethereum.enable()` line, defining our asset based on the [OEP-08](https://github.com/oceanprotocol/OEPs/tree/master/8) metadata structure: To do that, we need to add the following code after `window.ethereum.enable()` line, defining our asset based on the [OEP-08](https://github.com/oceanprotocol/OEPs/tree/master/8) metadata structure: