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

Removed old core-concepts page and cleaned up a few references

Browse Source
This commit is contained in:
Anamaria Loznianu 2023-05-24 19:02:40 +03:00
parent 74a1a9f32f
commit 0216255afd
10 changed files with 12 additions and 164 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
developers/compute-to-data/compute-to-data-architecture.md
View File

@ -30,7 +30,7 @@ Before the flow can begin, these pre-conditions must be met:
### Access Control using Ocean Provider ### Access Control using Ocean Provider
As with [the `access` service](../../core-concepts/architecture.md#data-nfts-datatokens-and-access-control-tools), the `compute` service requires the **Ocean Provider** as a component handled by Publishers. Ocean Provider is in charge of interacting with users and managing the basics of a Publisher's infrastructure to integrate this infrastructure into Ocean Protocol. The direct interaction with the infrastructure where the data resides happens through this component only. As with [the `access` service](../architecture.md#data-nfts-datatokens-and-access-control-tools), the `compute` service requires the **Ocean Provider** as a component handled by Publishers. Ocean Provider is in charge of interacting with users and managing the basics of a Publisher's infrastructure to integrate this infrastructure into Ocean Protocol. The direct interaction with the infrastructure where the data resides happens through this component only.
Ocean Provider includes the credentials to interact with the infrastructure (initially in cloud providers, but it could be on-premise). Ocean Provider includes the credentials to interact with the infrastructure (initially in cloud providers, but it could be on-premise).

152
developers/core-concepts/README.md
View File

@ -1,152 +0,0 @@
# Core concepts
## Ana - Work on this
##
## Local / Ganache
The most straightforward way for local-only development is to use [Barge](https://www.github.com/oceanprotocol/barge), which runs [Ganache](https://www.trufflesuite.com/ganache), Aquarius, and Provider. It is used extensively by the Ocean core devs and for automated integration testing.
To connect to it from MetaMask, select the network called _Localhost 8545_.
Alternatively, you can run Ganache independently. Install it according to [the Ganache docs](https://www.trufflesuite.com/ganache). Then deploy Ocean contracts onto Ganache following [docs in Ocean contracts repo](https://www.github.com/oceanprotocol/contracts). Ganache is at the RPC URL [http://localhost:8545](http://localhost:8545).
**Tokens**
* Ganache ETH:
* Native token to pay transaction fees
* By default, Ganache creates several Ethereum accounts at launch, gives each some ETH, and makes their private keys available in the logs. You can also instruct Ganache to give ETH to specific Ethereum addresses.
* Ganache OCEAN:
* You can deploy an ERC20 token with the label OCEAN. At a minimum, the token needs to be ERC20Detailed and ERC20Capped. You’ll see examples in the quickstarts for the Ocean JavaScript and Python drivers.
### Other
Some apps may need `network_id` and `chain_id`. Here's a [list of values for major Ethereum networks](https://medium.com/@piyopiyo/list-of-ethereums-major-network-and-chain-ids-2bc58e928508).
What is Ocean?
Ocean provides the next generation of tools to unlock data at a large scale. Ocean makes it easy to publish and consume data services.
Ocean uses Data NFTs (ERC721) and datatokens (ERC20) as the interface to connect data assets with blockchain and DeFi tools. Crypto wallets become data wallets, crypto exchanges become data marketplaces, DAOs for data co-ops, and more via DeFi composability.
![Creating a New Data Economy](../../.gitbook/assets/architecture/feature-datascience@2x.webp)
The following guides are a greate place to start if you are new to Ocean:
* [Architecture Overview](architecture.md)
* [Data NFTs and Datatokens](datanft-and-datatoken.md)
* [Publish a data asset](../../how-tos/marketplace-publish-data-asset.md)
* [Download a data asset](../../how-tos/marketplace-download-data-asset.md)
## What is our Mission?
**To unlock data, for more equitable outcomes for users of data, using a thoughtful application of both technology and governance.**
Society is becoming increasingly reliant on data, especially with the advent of AI. However, a small handful of organizations with both massive data assets and AI capabilities attained worrying levels of control which is a danger to a free and open society.
Our team and community is committed to kick-starting a New Data Economy that reaches every single person, company and device, giving power back to data owners and enabling people to capture value from data to better our world.
Find out more about the people building Ocean on our [site](https://oceanprotocol.com/about).
## What can you do with Ocean?
### Buy or Sell Data
Use Ocean Market to publish and sell data, or browse and buy data. Data is published as interoperable ERC721 data NFTs & ERC20 datatokens. It's a decentralized exchange (DEX), tuned for data. The acts of publishing data, purchasing data, and consuming data are all recorded on the blockchain to make a tamper-proof audit trail.
As a data scientist or AI practitioner, you can benefit from access to more data (including private data), crypto-secured provenance in data & AI training, and income opportunities for selling data and curating data.
![Decentralized Exchange Marketplaces](../../.gitbook/assets/architecture/feature-marketplaces@2x.webp)
The following guides will help you get started with buying and selling data:
* [Publish a data asset](../../how-tos/marketplace-publish-data-asset.md)
* [Download a data asset](../../how-tos/marketplace-download-data-asset.md)
* [Publishing with hosting services](../../how-tos/asset-hosting/)
### Build Your Own Data Market
Use Ocean Protocol software tools to build your own data marketplace, by either forking [Ocean Market](https://v4.market.oceanprotocol.com/) code or building up with Ocean components.
![Ocean Market Homepage](../../.gitbook/assets/market/ocean-market-homepage.png)
If you're interested in starting your own marketplace checkout the following guides:
* [Forking Ocean Market](../../tutorials/build-a-marketplace/forking-ocean-market.md)
* [Customising your market](../../tutorials/build-a-marketplace/customising-your-market.md)
* [Deploying your market](../../tutorials/build-a-marketplace/deploying-market.md)
### Manage datatokens and data NFTs for use in DeFi
Ocean makes it easy to publish data services (deploy ERC721 data NFTs and ERC20 datatokens), and to consume data services (spend datatokens). Crypto wallets, exchanges, and DAOs become data wallets, exchanges, and DAOs.
Use Ocean [JavaScript](https://github.com/oceanprotocol/ocean.js) or [Python](https://github.com/oceanprotocol/ocean.py) drivers to manage data NFTs and datatokens:
Ocean-based apps make data asset on-ramps and off-ramps easy for end users. Ocean smart contracts and libraries make this easy for developers. The data itself does not need to be on-chain, just the access control.
![New Data on-ramp and off-ramp](../../.gitbook/assets/architecture/new-ramp-on-crypto-ramp-off.webp)
Data NFTs are ERC721 tokens representing the unique asset and datatokens are ERC20 tokens to access data services. Each data service gets its own data NFT and one or more type of datatokens.
To access the dataset, you send 1.0 datatokens to the data provider (running Ocean Provider). To give access to someone else, send them 1.0 datatokens. That's it.
Since datatokens are ERC20, and live on Ethereum mainnet, there's a whole ecosystem to leverage.
* _Publish and access data services:_ downloadable files or compute-to-data. Use Ocean to deploy a new [ERC721](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md) and [ERC20](https://github.com/ethereum/EIPs/blob/7f4f0377730f5fc266824084188cc17cf246932e/EIPS/eip-20.md) datatoken contract for each data service, then mint datatokens.
* _Transfer datatokens_ to another owner (or approve & transferFrom).
* _And more._ Use ERC20 support in [web3.js](https://web3js.readthedocs.io/), [web3.py](https://web3py.readthedocs.io/en/stable/examples.html#working-with-an-erc20-token-contract) and Solidity to connect datatokens with crypto wallets and other DeFi services.
### Compute-to-Data
Ocean's "Compute-to-Data" feature enables private data to be bought & sold. You can sell compute access to privately-held data, which never leaves the data owner’s premises. Ocean-based marketplaces enable the monetization of private data while preserving privacy.
Compute-to-data resolves the tradeoff between the benefits of using private data, and the risks of exposing it. It lets the data stay on-premise, yet allows 3rd parties to run specific compute jobs on it to get useful compute results like averaging or building an AI model.
The most valuable data is private data — using it can improve research and business outcomes. But concerns over privacy and control make it hard to access. With Compute-to-Data, private data isn’t directly shared but rather specific access to it is granted.
![Compute-to-data](../../.gitbook/assets/architecture/feature-compute@2x.webp)
It can be used for data sharing in science or technology contexts, or in marketplaces for selling private data while preserving privacy, as an opportunity for companies to monetize their data assets.
Private data can help research, leading to life-altering innovations in science and technology. For example, more data improves the predictive accuracy of modern Artificial Intelligence (AI) models. Private data is often considered the most valuable data because it’s so hard to get at, and using it can lead to potentially big payoffs.
Checkout these guides if you are aiming to get a deeper understanding on how compute-to-data works:
* [Architecture](compute-to-data-architecture.md)
* [Datasets & Algorithms](compute-to-data-datasets-algorithms.md)
* [Minikube Environment](../../infrastructure/compute-to-data-minikube.md)
* [Writing Algorithms](compute-to-data-algorithms.md)
* [Private docker registry](../../infrastructure/compute-to-data-docker-registry.md)
## How does it work?
In Ocean Protocol, each asset gets its own ERC721 **data NFT** and one(or more) ERC20 **datatokens**. This enables data wallets, data exchanges, and data co-ops by directly leveraging crypto wallets, exchanges, and more.
Ocean Protocol provides tools for developers to _build data markets_, and to _manage data NFTs and datatokens_ for use in DeFi.
If you are new to web3 and blockchain technologies then we suggest you first read these introductory guides:
* [Wallet Basics](../../discover/wallets.md)
* [Set Up MetaMask Wallet](../../discover/metamask-setup.md)
* [Manage Your OCEAN Tokens](../../discover/wallets-and-ocean-tokens.md)
If ou are looking to get to grips with the inner workings of Ocean, then you'll be interested in the following guides:
* [Architecture Overview](architecture.md)
* [Data NFTs and Datatokens](datanft-and-datatoken.md)
* [Networks](../../discover/networks/)
* [Fees](fees.md)
* [Asset pricing](asset-pricing.md)
* [DID & DDO](did-ddo.md)
* [Roles](roles.md)
* [Set Up a Marketplace](../../tutorials/build-a-marketplace/marketplace.md)
* [Compute-to-Data](compute-to-data/)
* [Deploying components](../../infrastructure/)
* [Contributing](../../contribute/contributing.md)
## Supporters
[GitBook](https://www.gitbook.com/) is a supporter of this open source project by providing hosting for this documentation.

2
developers/using-ocean-libraries/configuration.md
View File

@ -10,7 +10,7 @@ Choose any API provider of your choice. Some of the commonly used are:
* [Alchemy](https://www.alchemy.com/) * [Alchemy](https://www.alchemy.com/)
* [Moralis](https://moralis.io/) * [Moralis](https://moralis.io/)
The supported networks are listed [here](../../core-concepts/networks.md). The supported networks are listed [here](../../discover/networks/).
### Create a directory ### Create a directory

4
developers/using-ocean-libraries/create-datatoken-with-fixed-pricing.md
View File

@ -1,6 +1,6 @@
# Publish with Fixed Pricing # Publish with Fixed Pricing
This tutorial guides you through the process of creating your own data NFT and a datatoken with fixed pricing, using Ocean libraries. To know more about data NFTs and datatokens please refer [this page](../../core-concepts/datanft-and-datatoken.md). Ocean Protocol supports different pricing schemes which can be set while publishing an asset. Please refer [this page](../../core-concepts/asset-pricing.md) for more details on pricing schemes. This tutorial guides you through the process of creating your own data NFT and a datatoken with fixed pricing, using Ocean libraries. To know more about data NFTs and datatokens please refer [this page](../datanft-and-datatoken.md). Ocean Protocol supports different pricing schemes which can be set while publishing an asset. Please refer [this page](../asset-pricing.md) for more details on pricing schemes.
#### Prerequisites #### Prerequisites
@ -14,7 +14,7 @@ This tutorial guides you through the process of creating your own data NFT and a
Create a new file in the same working directory where configuration file (`config.py`/`config.js`) and `.env` files are present, and copy the code as listed below. Create a new file in the same working directory where configuration file (`config.py`/`config.js`) and `.env` files are present, and copy the code as listed below.
{% hint style="info" %} {% hint style="info" %}
**Fees**: The code snippets below define fees related parameters. Please refer [fees page ](../../core-concepts/fees.md)for more details **Fees**: The code snippets below define fees related parameters. Please refer [fees page ](../fees.md)for more details
{% endhint %} {% endhint %}
{% tabs %} {% tabs %}

2
developers/using-ocean-libraries/creating-datanft.md
View File

@ -1,6 +1,6 @@
# Creating a data NFT # Creating a data NFT
This tutorial guides you through the process of creating your own data NFT using Ocean libraries. To know more about data NFT please refer [this page](../../core-concepts/datanft-and-datatoken.md). This tutorial guides you through the process of creating your own data NFT using Ocean libraries. To know more about data NFT please refer [this page](../datanft-and-datatoken.md).
#### Prerequisites #### Prerequisites

2
developers/using-ocean-libraries/update-metadata.md
View File

@ -1,6 +1,6 @@
# Update Metadata # Update Metadata
This tutorial will guide you to update an existing asset published on-chain using Ocean libraries. The tutorial assumes that you already have the `did` of the asset which needs to be updated. In this tutorial, we will update the name, description, tags of the data NFT. Please refer [the page on DDO](../../core-concepts/did-ddo.md) to know more about additional the fields which can be updated. This tutorial will guide you to update an existing asset published on-chain using Ocean libraries. The tutorial assumes that you already have the `did` of the asset which needs to be updated. In this tutorial, we will update the name, description, tags of the data NFT. Please refer [the page on DDO](../ddo-specification.md) to know more about additional the fields which can be updated.
#### Prerequisites #### Prerequisites

2
discover/faq.md
View File

@ -336,7 +336,7 @@ Yes, from the get-go! It doesn’t matter how data is priced, this works for all
<summary>Which networks are eligible for Data Farming?</summary> <summary>Which networks are eligible for Data Farming?</summary>
Data assets for DF may published in any network where Ocean’s deployed in production: Eth Mainnet, Polygon, BSC, and more. Data assets for DF may published in any network where Ocean’s deployed in production: Eth Mainnet, Polygon, BSC, and more.
You can find a list of [all supported chains here](https://docs.oceanprotocol.com/core-concepts/networks). You can find a list of [all supported chains here](https://docs.oceanprotocol.com/discover/networks).
</details> </details>

2
rewards/df-background.md
View File

@ -38,7 +38,7 @@ Data assets that have veOCEAN allocated towards them get DF rewards.
The data asset may be of any type — dataset (for static URIs), algorithm for Compute-to-Data, or any other Datatoken token-gated system. The data asset may be fixed price or free price. If fixed price, any token of exchange is alright (OCEAN, H2O, USDC, ..). The data asset may be of any type — dataset (for static URIs), algorithm for Compute-to-Data, or any other Datatoken token-gated system. The data asset may be fixed price or free price. If fixed price, any token of exchange is alright (OCEAN, H2O, USDC, ..).
To qualify for DF, a data asset must also: To qualify for DF, a data asset must also:
- Have been created by Ocean Smart contracts [deployed](https://github.com/oceanprotocol/contracts/blob/v4main/addresses/address.json) by OPF to [production networks](https://docs.oceanprotocol.com/core-concepts/networks) - Have been created by Ocean Smart contracts [deployed](https://github.com/oceanprotocol/contracts/blob/v4main/addresses/address.json) by OPF to [production networks](https://docs.oceanprotocol.com/discover/networks)
- Be visible on [Ocean Market](https://market.oceanprotocol.com/) - Be visible on [Ocean Market](https://market.oceanprotocol.com/)
- Can’t be in [purgatory](https://github.com/oceanprotocol/list-purgatory/blob/main/policies/README.md) - Can’t be in [purgatory](https://github.com/oceanprotocol/list-purgatory/blob/main/policies/README.md)

2
rewards/df-intro.md
View File

@ -44,7 +44,7 @@ Otherwise, go to the DF webapp at [df.oceandao.org](df.oceandao.org) and explore
All earnings for veOCEAN token holders are claimable on the ”Rewards” page inside the Data Farming webapp on Ethereum mainnet. All earnings for veOCEAN token holders are claimable on the ”Rewards” page inside the Data Farming webapp on Ethereum mainnet.
Data assets for DF may be published in any [network where Ocean’s deployed in production](../core-concepts/networks.md): Ethereum Mainnet, Polygon, etc. Data assets for DF may be published in any [network where Ocean’s deployed in production](../discover/networks/README.md): Ethereum Mainnet, Polygon, etc.
### When to claim? ### When to claim?

6
user-guides/using-ocean-market.md
View File

@ -25,6 +25,6 @@ The Ocean Market is a place for buyers + sellers of top-notch data and algorithm
**If you are new to web3** and blockchain technologies then we suggest you first get familiar with some Web3 basics: **If you are new to web3** and blockchain technologies then we suggest you first get familiar with some Web3 basics:
* [Wallet Basics](../tutorials/building-with-ocean/wallets.md) 👛 * [Wallet Basics](../discover/wallets.md) 👛
* [Set Up MetaMask](../tutorials/orientation/metamask-setup.md) [Wallet ](../tutorials/orientation/metamask-setup.md)🦊 * [Set Up MetaMask](../discover/metamask-setup.md) [Wallet ](../discover/metamask-setup.md)🦊
* [Manage Your OCEAN Tokens](../tutorials/building-with-ocean/wallets-and-ocean-tokens.md) 🪙 * [Manage Your OCEAN Tokens](../discover/wallets-and-ocean-tokens.md) 🪙