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

GITBOOK-170: change request with no subject merged in GitBook

Browse Source
This commit is contained in:
Ana Loznianu 2023-05-18 12:34:59 +00:00 committed by gitbook-bot
parent 7f6714f976
commit 06b318a54b
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
18 changed files with 208 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
.gitbook/assets/balance-of (1) (1) (1).png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 77 KiB

BIN
.gitbook/assets/landing/contribute_card.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 27 KiB

BIN
.gitbook/assets/landing/data_science_card.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 13 KiB

BIN
.gitbook/assets/landing/developers_card.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 18 KiB

BIN
.gitbook/assets/landing/discover_card.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 18 KiB

BIN
.gitbook/assets/landing/infrastructure_card.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 13 KiB

BIN
.gitbook/assets/landing/rewards_card.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 19 KiB

106
README.md
View File

@ -6,107 +6,5 @@ layout: landing
---
# 👋 Welcome
<table data-view="cards">
<thead>
<tr>
<th data-type="content-ref"></th>
<th></th>
<th data-hidden data-type="files"></th>
<th data-hidden data-type="files"></th>
<th data-hidden data-card-target data-type="content-ref"></th>
<th data-hidden data-card-cover data-type="files"></th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="discover/discover.md">discover.md</a>
</td>
<td>Learn about Ocean Protocol's powerful data-sharing capabilities and its potential to transform the way data is shared and monetized.</td>
<td>
<a href="discover/discover.md">discover.md</a>
</td>
<td>
<a href=".gitbook/assets/cover/discover_card.png">discover_card.png</a>
</td>
</tr>
<tr>
<td>
<a href="user-guides/">user-guides</a>
</td>
<td>Whether you're new to Ocean or just need a refresher on a particular task, the "How to's" section is a great resource for quickly finding the information step-by-step instructions for what you need.</td>
<td>
<a href="user-guides/">user-guides</a>
</td>
<td>
<a href=".gitbook/assets/cover/user_guides.png">user_guides.png</a>
</td>
</tr>
<tr>
<td>
<a href="developers/">developers</a>
</td>
<td>Whether you're building a dApp or integrating with the ecosystem, you'll find plenty of APIs, libraries, and other tools to help you get the job done.</td>
<td>
<a href="developers/">developers</a>
</td>
<td>
<a href=".gitbook/assets/cover/developer_tutorials.png">developer_tutorials.png</a>
</td>
</tr>
<tr>
<td>
<a href="data-science.md">data-science.md</a>
</td>
<td>Data science is the key to unlocking the true potential of decentralized data sharing. In this category, you'll find an abundance of tutorials and guides on various data science topics.</td>
<td>
<a href=".gitbook/assets/cover/data_science_card.png">data_science_card.png</a>
</td>
</tr>
<tr>
<td>
<a href="infrastructure/">infrastructure</a>
</td>
<td>Learn how to deploy your own components on the Ocean Protocol network. Discover how the platform leverages blockchain technology, decentralized storage, and other cutting-edge tools to enable secure and scalable data sharing.</td>
<td>
<a href="infrastructure/">infrastructure</a>
</td>
<td>
<a href=".gitbook/assets/cover/infrastructure_card.png">infrastructure_card.png</a>
</td>
</tr>
<tr>
<td>
<a href="defi.md">defi.md</a>
</td>
<td>DeFi (Decentralized Finance) has taken the financial world by storm, and Ocean Protocol has been at the forefront of this movement. In this category, you'll find a wealth of tutorials and guides on various DeFi topics.</td>
<td>
<a href=".gitbook/assets/cover/rewards_card.png">rewards_card.png</a>
</td>
</tr>
<tr>
<td>
<a href="rewards/">rewards</a>
</td>
<td>Discover ways to earn rewards for contributing to the Ocean Protocol ecosystem. Explore bounty programs, grants, and other initiatives that can help you make an impact and earn recognition for your contributions.</td>
<td>
<a href="rewards/">rewards</a>
</td>
<td>
<a href=".gitbook/assets/cover/rewards_card.png">rewards_card.png</a>
</td>
</tr>
<tr>
<td>
<a href="contribute/contributing.md">contributing.md</a>
</td>
<td>Learn how you can contribute to the growth and development of Ocean Protocol. Whether you're interested in community initiatives, open-source projects, or other opportunities, there are many ways to get involved and make a difference.</td>
<td>
<a href="contribute/contributing.md">contributing.md</a>
</td>
<td>
<a href=".gitbook/assets/cover/contribute_card.png">contribute_card.png</a>
</td>
</tr>
</tbody>
</table>
<table data-view="cards"><thead><tr><th data-type="content-ref"></th><th></th><th data-hidden data-type="files"></th><th data-hidden data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><a href="discover/discover.md">discover.md</a></td><td>Learn about Ocean Protocol's powerful data-sharing capabilities and its potential to transform the way data is shared and monetized.</td><td></td><td></td><td><a href="discover/discover.md">discover.md</a></td><td><a href=".gitbook/assets/landing/discover_card.png">discover_card.png</a></td></tr><tr><td><a href="user-guides/">user-guides</a></td><td>Whether you're new to Ocean or just need a refresher on a particular task, the "How to's" section is a great resource for quickly finding the information step-by-step instructions for what you need.</td><td></td><td></td><td><a href="user-guides/">user-guides</a></td><td></td></tr><tr><td><a href="developers/">developers</a></td><td>Whether you're building a dApp or integrating with the ecosystem, you'll find plenty of APIs, libraries, and other tools to help you get the job done.</td><td></td><td></td><td><a href="developers/">developers</a></td><td><a href=".gitbook/assets/landing/developers_card.png">developers_card.png</a></td></tr><tr><td><a href="data-science.md">data-science.md</a></td><td>Data science is the key to unlocking the true potential of decentralized data sharing. In this category, you'll find an abundance of tutorials and guides on various data science topics.</td><td></td><td></td><td></td><td><a href=".gitbook/assets/landing/data_science_card.png">data_science_card.png</a></td></tr><tr><td><a href="infrastructure/">infrastructure</a></td><td>Learn how to deploy your own components on the Ocean Protocol network. Discover how the platform leverages blockchain technology, decentralized storage, and other cutting-edge tools to enable secure and scalable data sharing.</td><td></td><td></td><td><a href="infrastructure/">infrastructure</a></td><td><a href=".gitbook/assets/landing/infrastructure_card.png">infrastructure_card.png</a></td></tr><tr><td><a href="defi.md">defi.md</a></td><td>DeFi (Decentralized Finance) has taken the financial world by storm, and Ocean Protocol has been at the forefront of this movement. In this category, you'll find a wealth of tutorials and guides on various DeFi topics.</td><td></td><td></td><td></td><td><a href=".gitbook/assets/landing/rewards_card.png">rewards_card.png</a></td></tr><tr><td><a href="rewards/">rewards</a></td><td>Discover ways to earn rewards for contributing to the Ocean Protocol ecosystem. Explore bounty programs, grants, and other initiatives that can help you make an impact and earn recognition for your contributions.</td><td></td><td></td><td><a href="rewards/">rewards</a></td><td><a href=".gitbook/assets/landing/rewards_card.png">rewards_card.png</a></td></tr><tr><td><a href="contribute/contributing.md">contributing.md</a></td><td>Learn how you can contribute to the growth and development of Ocean Protocol. Whether you're interested in community initiatives, open-source projects, or other opportunities, there are many ways to get involved and make a difference.</td><td></td><td></td><td><a href="contribute/contributing.md">contributing.md</a></td><td><a href=".gitbook/assets/landing/contribute_card.png">contribute_card.png</a></td></tr></tbody></table>

12
SUMMARY.md
View File

@ -11,7 +11,7 @@
* [Manage Your OCEAN Tokens](discover/wallets-and-ocean-tokens.md)
* [Glossary](discover/glossary.md)
* [FAQ](discover/faq.md)
* [📚 User Guides](user-guides/user_guides.md)
* [📚 User Guides](user-guides/README.md)
* [Publish an NFT](user-guides/marketplace-publish-data-asset.md)
* [Download NFT Assets](user-guides/marketplace-download-data-asset.md)
* [Sell NFT Outputs](user-guides/compute-to-data/README.md)
@ -27,7 +27,7 @@
* [Claim OCEAN Rewards](user-guides/claim-ocean-rewards.md)
* [Guide to Ocean Market](user-guides/using-ocean-market.md)
* [Liquidity Pools \[deprecated\]](user-guides/remove-liquidity-using-etherscan.md)
* [Developers](developers/developers.md)
* [👨💻 👨💻 Developers](developers/README.md)
* [Architecture Overview](developers/architecture.md)
* [Data NFTs and Datatokens](developers/datanft-and-datatoken.md)
* [Roles](developers/roles.md)
@ -62,8 +62,8 @@
* [Aquarius](developers/apis/aquarius.md)
* [Provider](developers/apis/provider.md)
* [Subgraph](developers/apis/subgraph.md)
* [📊 Data Science](data_science/data-science.md)
* [🔨 Infrastructure](infrastructure/infrastructure.md)
* [📊 Data Science](data-science.md)
* [🔨 Infrastructure](infrastructure/README.md)
* [Setup a Server](infrastructure/setup-server.md)
* [Deploying Marketplace](infrastructure/deploying-marketplace.md)
* [Deploying Aquarius](infrastructure/deploying-aquarius.md)
@ -71,8 +71,8 @@
* [Deploying Ocean Subgraph](infrastructure/deploying-ocean-subgraph.md)
* [C2D - Minikube Environment](infrastructure/compute-to-data-minikube.md)
* [C2D - Private Docker Registry](infrastructure/compute-to-data-docker-registry.md)
* [🤑 DeFi](defi/defi.md)
* [💰 Rewards](rewards/rewards.md)
* [🤑 DeFi](defi.md)
* [💰 Rewards](rewards/README.md)
* [Data Farming 101](rewards/df-intro.md)
* [veOCEAN](rewards/veocean.md)
* [Data Farming Background](rewards/df-background.md)

2
contribute/contributing.md
View File

@ -1,8 +1,6 @@
---
title: Ways to Contribute
description: Help to improve and develop Ocean core software.
cover: ../.gitbook/assets/cover/contribute.png
coverY: 0
---
# 🤝 Contribute

2
data-science.md Normal file
View File

@ -0,0 +1,2 @@
# 📊 Data Science

31
defi.md Normal file
View File

@ -0,0 +1,31 @@
# 🤑 DeFi
## Capitalize with Ocean Protocol 💸
Ocean Protocol's open-source tools are useful in a variety of DeFi applications. Here we show you how to capitalize with Ocean Protocol tech in several ways using crypto trading!
## Predicting the Price of ETH 📈
We offer a Predict ETH data challenge where participants can win prizes 💰 for making accurate ETH price predictions. Participants use machine learning to extrapolate ETH prices for the next 12 hours as accurately as possible and upload these predictions to the Ocean Market as data NFTs. It's a win-win for both Ocean Protocol and challenge participants! This challenge promotes more valuable data feeds on the Ocean Market and participants gain cash prizes!
Check our [challenges page](https://oceanprotocol.com/challenges) to see if there is an active Predict ETH challenge!
Wondering how to start predicting the price of ETH? We have a [blogpost](https://blog.oceanprotocol.com/capitalize-with-ocean-protocol-a-predict-eth-tutorial-b2da136633f0?source=search\_post---------0----------------------------) 📖 for that!&#x20;
## Algorithmic Crypto Trading 🤖📊
There are a variety of NFTs on the Ocean Market that offer profitable algorithms for crypto trading using [Trading View](https://www.tradingview.com) and [freqtrade](http://freqtrade.io) open-source Github library. Not sure how to algorithmically trade crypto? We have a few tutorials for that:
Check out our video [tutorial](https://www.youtube.com/watch?v=c7A4vA8YUyI) on how to begin algorithmically trading crypto with no experience using an EMA crossover strategy on the Ocean Market!
{% embed url="https://www.youtube.com/watch?v=c7A4vA8YUyI" %}
Are you more of a reader? Check out our [blogpost](https://blog.oceanprotocol.com/capitalize-with-ocean-protocol-a-sma-algorithmic-trading-tutorial-a2490661ab85) 📖 how to use a Python SMA crossover strategy with grid search optimization to begin accurately predicting ETH.&#x20;
## Create Trading Strategy NFTs 📲
Do you have a valuable trading strategy that you want to share or sell? You can anonymously upload your trading strategies as NFTs on-chain using the Ocean Market!
Check out our video tutorial 🧑‍🏫 how to [publish trading strategy NFTs](https://youtu.be/Q4jj5ukiTZA) on-chain 🔗 with the Ocean Market!
{% embed url="https://youtu.be/Q4jj5ukiTZA" %}

126
developers/README.md Normal file
View File

@ -0,0 +1,126 @@
# 👨💻 👨💻 Developers
## 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](../user-guides/marketplace-publish-data-asset.md)
* [Download a data asset](../user-guides/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](../user-guides/marketplace-publish-data-asset.md)
* [Download a data asset](../user-guides/marketplace-download-data-asset.md)
* [Publishing with hosting services](../user-guides/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](build-a-marketplace/forking-ocean-market.md)
* [Customising your market](build-a-marketplace/customising-your-market.md)
* [Deploying your market](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
discover/discover.md
View File

@ -1,6 +1,6 @@
---
description: Why Ocean?
cover: ../.gitbook/assets/cover/rewards.png
cover: broken-reference
coverY: 0
---

2
discover/explore.md
View File

@ -1,5 +1,5 @@
---
description: What Can You Do with Ocean?
description: What is Ocean?
---
# Explore

2
infrastructure/README.md Normal file
View File

@ -0,0 +1,2 @@
# 🔨 Infrastructure

35
rewards/README.md Normal file
View File

@ -0,0 +1,35 @@
---
description: An overview of Ocean Protocol's governance and incentives mechanisms
---
# 💰 Rewards
veOCEAN is a fork of veCRV. This enables participants to become a governance delegate, and eligible to receive rewards and engage with different protocol mechanisms.
The following docs provide you with sufficient intuition to access, utilize, and build upon the protocol's core incentive and reward system: Data Farming.
![DF Rewards Page](../.gitbook/assets/rewards/df\_rewards\_page.png)
## veOCEAN
Learning about [veOCEAN](veocean.md) will help you answer the question "What is the purpose of holding veOCEAN?" & give insights on how veOCEAN (vote-escrowed OCEAN) works. It will teach you everything you need to know about why it exists and how it works.
You will learn that by just holding veOCEAN passively, you are able to rewards.
## Data Farming
[Data Farming 101](df-intro.md) introduces the different reward systems, how they work, and how to access them. By the end of the page, you should be more familiar with how Data Farming works and able to take next steps to curate assets.
[Data Farming Background](df-background.md) will provide you with more intuitions about Data Farming, briefly explain the Reward Function, and how the program evolved over time.
## Further Reading
Finally, if you want to continue expanding your knowledge on OCEAN token emissions, APY estimates, and get useful answers to some of the most common questions, you can read the following:
[Emissions & APYs](emissions-apys.md) will provide you will information about how OCEAN will be released over time through the Data Farming program and provide you with APY studies.
Our [FAQ](faq.md) answers many different questions about staking, chains, deployments, and other details that may be valuable to you.
## Reference
All content within has been assembled via reference of the [Ocean Data Farming Series](https://blog.oceanprotocol.com/ocean-data-farming-series-c7922f1d0e45), official [Ocean Protocol github repositories](https://github.com/oceanprotocol/), and [v4 Whitepapers](https://oceanprotocol.com/tech-whitepaper.pdf).

2
user-guides/README.md Normal file
View File

@ -0,0 +1,2 @@
# 📚 User Guides