1
0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-26 19:49:26 +01:00

Restructured a lot of the docs, renamed them to be easier to follow, and tried to simplify in many places due to a lot of repeated-concepts... There is still a lot of duplication and redundancy between the DF docs (technical) and the How-Tos (tutorials). More to come.

This commit is contained in:
idiom-bytes 2023-07-10 13:54:39 -07:00
parent 3f11469be0
commit deb17b30f2
15 changed files with 119 additions and 89 deletions

View File

@ -28,12 +28,12 @@
* [Github](user-guides/asset-hosting/github.md)
* [Join a Data Challenge](user-guides/join-a-data-challenge.md)
* [Sponsor a Data Challenge](user-guides/sponsor-a-data-challenge.md)
* [Data Farming - Overview ](user-guides/data-farming-101.md)
* [Data Farming - Passive Rewards](user-guides/how-to-farm-veOCEAN.md)
* [Data Farming - Claim Rewards](user-guides/how-to-farm-claim-rewards.md)
* [Data Farming - Active Rewards - Challenge DF](user-guides/how-to-farm-challengedf.md)
* [Data Farming - Active Rewards - Volume DF](user-guides/how-to-farm-volumedf.md)
* [Data Farming - Delegate](user-guides/how-to-delegate.md)
* [Data Farming](user-guides/data-farming/README.md)
* [Farm Passive Rewards](user-guides/data-farming/how-to-farm-veOCEAN.md)
* [Claim Rewards](user-guides/data-farming/how-to-farm-claim-rewards.md)
* [Predict Challenge DF](user-guides/data-farming/how-to-farm-challengedf.md)
* [Curate Volume DF](user-guides/data-farming/how-to-farm-volumedf.md)
* [Delegate](user-guides/data-farming/how-to-farm-delegate.md)
* [Liquidity Pools \[deprecated\]](user-guides/remove-liquidity-pools.md)
* [👨💻 Developers](developers/README.md)
* [Architecture Overview](developers/architecture.md)
@ -115,11 +115,11 @@
* [C2D - Minikube Environment](infrastructure/compute-to-data-minikube.md)
* [C2D - Private Docker Registry](infrastructure/compute-to-data-docker-registry.md)
* [🤑 DeFi](defi/README.md)
* [💰 Rewards](rewards/README.md)
* [💰 Data Farming Rewards](rewards/README.md)
* [Data Farming 101 (White Belt)](rewards/df-intro.md)
* [DF Basic Actions (Blue Belt)](rewards/df-basic.md)
* [DF "ve" in veOCEAN (Blue Belt)](rewards/veocean.md)
* [DF Max Out Yield (Purple Belt)](rewards/df-max-out-yield.md)
* [DF "ve" in veOCEAN (Brown Belt)](rewards/veocean.md)
* [DF Deep Dives (Brown Belt)](rewards/df-basic.md)
* [DF Emissions & APYs (Black Belt)](rewards/df-emissions-apys.md)
* [🤝 Contribute](contribute/README.md)
* [Partners & Collaborators](contribute/projects-using-ocean.md)

View File

@ -4,11 +4,13 @@ cover: ../.gitbook/assets/cover/rewards_banner.png
coverY: 0
---
# 💰 Rewards
# Data Farming Rewards 💰
### Why did we create the Data Farming dApp?
The purpose of Ocean Protocol's Data Farming dApp reward system is to incentivize the curation and publishing of high-quality data NFTs in the Ocean Ecosystem. Data Farming participants earn OCEAN rewards for these activities.
The purpose of Ocean Protocol's Data Farming dApp reward system is to incentivize the growth, curation, and publishing of high-quality data NFTs in the Ocean Ecosystem.
Data Farming participants earn OCEAN rewards for these activities.
Data Farming rewards are structured in 2 main streams **Passive Rewards** and **Active Rewards**. At a minimum, Data Farmers earn "passive rewards" for locking their OCEAN tokens to get veOCEAN tokens in return. Then, Data Farmers can maximize their yield by earning "active rewards". Active Rewards stream it's broken down into multiple substreams, to offer you a variaty of ways to contribute to Ocean Protocol values and increase your Data Farming rewards: Volume DF, Challenge DF.
### The belt system
@ -33,7 +35,7 @@ veOCEAN is a fork of veCRV. This enables participants to become a governance del
## Delegation
[Delegation](../user-guides/how-to-delegate.md) will teach you how to share your veOCEAN allocation power to other users that can help manage Volume DF substream for you.
[Delegation](..user-guides/data-farming/how-to-farm-delegate.md) will teach you how to share your veOCEAN allocation power to other users that can help manage Volume DF substream for you.
Once delegated, rewards will be sent to the wallet address you delegated to. The delegation receiver is in charge of managing your Allocation Power and cut from the rewards.

View File

@ -2,24 +2,36 @@
description: Learn the basic moves to start kicking a** Data Farming
---
# DF Basic Actions (Blue Belt)
# DF Deep Dives (Brown Belt)
<figure><img src="../.gitbook/assets/gif/neo-kinda-martial-arts.gif" alt=""><figcaption><p>Like Neo, you have great potential.</p></figcaption></figure>
### Get Started
Our [User Guides](../user-guides/README.md) get you started Data Farming quickly to do the basic operations. Follow these guides to earn your blue belt in Data Farming understanding.
Our [User Guides](../user-guides/README.md) get you started Data Farming quickly to do the basic operations. Follow these guides to earn your brown belt in Data Farming understanding.
{% content-ref url="../user-guides/how-to-farm-veOCEAN.md" %}
[how-to-farm-veOCEAN.md](../user-guides/how-to-farm-veOCEAN.md)
{% content-ref url="../user-guides/data-farming/README.md" %}
[README.md](../user-guides/data-farming/README.md)
{% endcontent-ref %}
{% content-ref url="../user-guides/data-farming-101.md" %}
[data-farming-101.md](../user-guides/data-farming-101.md)
{% content-ref url="../user-guides/data-farming/how-to-farm-veOCEAN.md" %}
[how-to-farm-veOCEAN.md](../user-guides/data-farming/how-to-farm-veOCEAN.md)
{% endcontent-ref %}
{% content-ref url="../user-guides/how-to-farm-claim-rewards.md" %}
[how-to-farm-claim-rewards.md](../user-guides/how-to-farm-claim-rewards.md)
{% content-ref url="..user-guides/data-farming/how-to-farm-claim-rewards.md" %}
[how-to-farm-claim-rewards.md](..user-guides/data-farming/how-to-farm-claim-rewards.md)
{% endcontent-ref %}
{% content-ref url="..user-guides/data-farming/how-to-farm-challengedf.md" %}
[how-to-farm-challengedf.md](..user-guides/data-farming/how-to-farm-challengedf.md)
{% endcontent-ref %}
{% content-ref url="..user-guides/data-farming/how-to-farm-volumedf.md" %}
[how-to-farm-volumedf.md](..user-guides/data-farming/how-to-farm-volumedf.md)
{% endcontent-ref %}
{% content-ref url="..user-guides/data-farming/how-to-farm-delegate.md" %}
[how-to-farm-delegate.md](..user-guides/data-farming/how-to-farm-delegate.md)
{% endcontent-ref %}
### Not much of a reader? Watch and learn, friend

View File

@ -51,9 +51,6 @@ The plot below shows estimated APY over time. Green includes both passive and ac
APYs are an estimate because APY depends on OCEAN locked. OCEAN locked for future weeks is not known precisely; it must be estimated. The yellow line is the model for OCEAN locked. We modeled OCEAN locked by observing linear growth from week 5 (when OCEAN locking was introduced) to week 28 (now): OCEAN locked grew from 7.89M OCEAN to 34.98M OCEAN respectively, or 1.177M more OCEAN locked per week.
\
<figure><img src="../.gitbook/assets/rewards/example_apys.png" alt="" width="563"><figcaption><p><em>Green: estimated APYs (passive + active). Black: estimated APYs (just passive). Yellow: estimated staking</em> </p></figcaption></figure>
All the plots are calculated from [this Google Sheet](https://docs.google.com/spreadsheets/d/1F4o7PbV45yW1aPWOJ2rwZEKkgJXbIk5Yq7tj8749drc/edit#gid=1051477754).

View File

@ -24,7 +24,7 @@ Passive rewards are the OCEAN rewards paid to Data Farmers just for locking thei
<figure><img src="../.gitbook/assets/gif/passive-income.gif" alt=""><figcaption></figcaption></figure>
[To start getting passive rewards, go here.](../user-guides/how-to-farm-veOCEAN.md)
[To start getting passive rewards, go here.](../user-guides/data-farming/how-to-farm-veOCEAN.md)
#### What are Active Rewards and Substreams?
@ -40,7 +40,7 @@ Challenge DF rewards Data Scientists that produce prediction models that consist
Active Rewards are governed and defined by the [Reward Function](df-max-out-yield.md#reward-schedule).
[To start getting Active Rewards, go here.](../user-guides/data-farming-101.md)
[To start getting Active Rewards, go here.](../user-guides/README.md)
#### Splitting the Pie

View File

@ -4,11 +4,11 @@ description: >-
Ocean Protocol's Data Farming dApp! 🥋
---
# Max Out Volume DF (Purple Belt)
# Mastering Volume DF (Purple Belt)
<figure><img src="../.gitbook/assets/gif/i-know-kung-fu.gif" alt=""><figcaption><p>You know enough to be dangerous.</p></figcaption></figure>
### Maximize your Yield
## Yield Kung Fu
If you only lock your OCEAN tokens to get passive yield, then you're leaving money on the table.
@ -22,19 +22,19 @@ Thus, if you really want to max out Volume DF APY:
4. Point your Allocation Power towards your published assets to receive a 2x bonus.
5. Claim weekly Passive Rewards, Active Rewards, and update your lock.
#### Don't have time to publish your own datasets?
### Data Farming success metrics
Another way to improve your yield is by [delegating](../user-guides/data-farming-101.md#how-to-delegate-your-active-rewards) your veOCEAN to someone to generate Active Rewards for you! In this case, the idea is that they may do a better job at publishing assets or picking winners better than you can. However, there is some risk to this because the rewards generated will be sent to the person you delegated to, and it's their responsibility to return those rewards back to you if that's the agreement you both made. To read more, see our [info on Delegation](../user-guides/data-farming-101.md#how-to-delegate-your-active-rewards).
**Data Consume Volume (DCV)** is our term for **the total $ amount spent on purchases of Ocean ecosystem assets**, transaction fees, and more. The higher DCV of Ocean ecosystem assets, then the more OCEAN rewards are distributed to Data Farmers. It's that simple!
### Those assets don't sell themselves!
Marketing your assets to buyers is your challenge. Just because you publish them in the Ocean ecosystem doesn't mean that they will sell. It will take real work. Your reward is great APY. Its incentives all the way down 🙂
Marketing your assets to buyers can be a big challenge. Just because you publish them in the Ocean ecosystem doesn't mean that they will sell. It will take real work. Your reward is great APY. Its incentives all the way down 🙂
<figure><img src="../.gitbook/assets/gif/hustlin.gif" alt=""><figcaption></figcaption></figure>
### Measuring Data Farming's Success
### Don't have time to publish your own datasets?
**Data Consume Volume (DCV)** is our term for **the total $ amount spent on purchases of Ocean ecosystem assets**, transaction fees, and more. The higher DCV of Ocean ecosystem assets, then the more OCEAN rewards are distributed to Data Farmers. It's that simple!
Another way to improve your yield is by [delegating](../user-guides/README.md#how-to-delegate-your-active-rewards) your veOCEAN to someone to generate Active Rewards for you! In this case, the idea is that they may do a better job at publishing assets or picking winners better than you can. However, there is some risk to this because the rewards generated will be sent to the person you delegated to, and it's their responsibility to return those rewards back to you if that's the agreement you both made. To read more, see our [info on Delegation](../user-guides/README.md#how-to-delegate-your-active-rewards).
### How Rewards are Calculated
@ -72,6 +72,14 @@ To qualify for DF, an 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](../discover/networks/README.md)
* Cant be in [purgatory](https://github.com/oceanprotocol/list-purgatory/blob/main/policies/README.md)
### Reward Schedule
The table below shows the total amount of OCEAN rewards that will be distributed among Passive and Active rewards each week. The table cross-references DF Round Number, Start Date, Phase & Week, Sub-Phase & Week, and OCEAN Rewards/Week.
<figure><img src="../.gitbook/assets/rewards/reward_schedule.png" alt=""><figcaption><p><em>Ocean Reward Schedule for the next 20+ years</em></p></figcaption></figure>
<figure><img src="../.gitbook/assets/gif/cash-flow.gif" alt=""><figcaption></figcaption></figure>
### A Brief History of Data Farming
Data Farming has evolved over time and will continue to do so as the Emission Curve progresses. Below are the phases and parameters incurred during the evolution of the Data Farming program. We are now in the DF Main phase.
@ -89,11 +97,3 @@ Up to 100K OCEAN rewards were budgeted per week. Counting started Thu Oct 27, 20
We are now in DF Main which immediately followed the release of DF Beta on Thu Mar 16, 2023. Rewards begin at 150k per week and go to 1.1M OCEAN per week. DF Main emits 503.4M OCEAN worth of rewards and lasts for decades.&#x20;
The amount of OCEAN released is determined by the emission schedule as defined by the [Emission Curve](df-emissions-apys.md#emissions--first-5-years), and perhaps more easily understood in the Reward Schedule below.
### Reward Schedule
The table below shows the total amount of OCEAN rewards that will be distributed among Passive and Active rewards each week. The table cross-references DF Round Number, Start Date, Phase & Week, Sub-Phase & Week, and OCEAN Rewards/Week.
<figure><img src="../.gitbook/assets/rewards/reward_schedule.png" alt=""><figcaption><p><em>Ocean Reward Schedule for the next 20+ years</em></p></figcaption></figure>
<figure><img src="../.gitbook/assets/gif/cash-flow.gif" alt=""><figcaption></figcaption></figure>

View File

@ -1,10 +1,10 @@
---
description: >-
Let's discuss the "ve" in veOCEAN for our last jutsu before earning a black
Let's discuss the "ve" in veOCEAN for our second jutsu, earning a blue
belt in Data Farming knowledge!
---
# DF "ve" in veOCEAN (Brown Belt)
# DF "ve" in veOCEAN (Blue Belt)
<figure><img src="../.gitbook/assets/gif/neo-blocking.gif" alt=""><figcaption><p>Data Farming is getting effortless.</p></figcaption></figure>
@ -81,9 +81,7 @@ If you lock 1.0 OCEAN for 4 years, you get 1.0 veOCEAN at the start.
At the end of your 4 years, your OCEAN is unlocked.
#### Linear Decay
**Your balance of veOCEAN may be less than the amount when you first locked your tokens because your veOCEAN balance decreases linearly over time until the Lock End Date when you can withdraw your OCEAN tokens.** This is because rewards are designed to be paid out weekly in a decreasing amount until you unlock your OCEAN tokens entirely. The veOCEAN code is a fork of Curve's battle tested [veCRV](https://curve.readthedocs.io/dao-vecrv.html) token code.
The veOCEAN code is a fork of Curve's battle tested [veCRV](https://curve.readthedocs.io/dao-vecrv.html) token code.
### Replenishing your veOCEAN

View File

@ -38,8 +38,8 @@ Buy, mint, and sell NFTs using the Ocean Market following the guides below.
Farm data like a pro. 😎🥕
{% content-ref url="data-farming-101.md" %}
[data-farming-101.md](data-farming-101.md)
{% content-ref url="README.md" %}
[README.md](README.md)
{% endcontent-ref %}
{% content-ref url="how-to-farm-veOCEAN.md" %}
@ -58,8 +58,8 @@ Farm data like a pro. 😎🥕
[how-to-farm-volumedf.md](how-to-farm-volumedf.md)
{% endcontent-ref %}
{% content-ref url="how-to-delegate.md" %}
[how-to-delegate.md](how-to-delegate.md)
{% content-ref url="how-to-farm-delegate.md" %}
[how-to-farm-delegate.md](how-to-farm-delegate.md)
{% endcontent-ref %}
### Antique Stuff 🏺

View File

@ -1,40 +0,0 @@
---
description: Make extra dosh with active rewards yield in Data Farming
---
# Data Farm 101
<figure><img src="../.gitbook/assets/gif/farming.gif" alt=""><figcaption></figcaption></figure>
## The basics of Passive and Active Rewards
## Passive Rewards substreams
## Active Rewards substreams
Active Rewards is one of the two main streams within Data Farming, along with Passive Rewards. The Active Rewards stream offers a defined amount of rewards for each round and is further divided into multiple substreams.
The primary objective of these substreams is to provide users with various opportunities to actively engage in Data Farming. This approach allows users with different skills and interests to collaborate and contribute their unique abilities towards achieving the core values of Ocean Protocol.
### Volume DF Substream
Volume DF is the bread and butter of the Data Farming incentive program and rewards OCEAN to publishers and curators that help maintain quality assets in the Ocean ecosystem.
If you have locked your OCEAN tokens in exchange for veOCEAN, this is the ideal opportunity for you to utilize those veOCEAN tokens and earn a portion of active rewards in addition to passive rewards.
By allocating your veOCEAN power to high-quality datasets, you can assist Ocean in curating datasets. Moreover, through allocation, you will also receive a portion of the revenue generated by the dataset consumption.
Allocation Powe can also be earned via delegation. The Data Farming dApp [Delegate Page](https://df.oceandao.org/delegate) lets you easily manage simple delegations that use the 100% of the current veOCEAN and the LockEnd time to set the delegation.
For more information on how to get started and detailed instructions, please refer to the [Volume DF](/user-guides/how-to-farm-volumedf.md) section.
### Challenge DF Substream
If you are a data scientist and enjoy tackling challenging problems, this is the perfect place for you. Challenge DF provides a weekly competition where you can test your skills in predicting the price of Ethereum. Rise against other participants to earn a place on the podium and receive a share of the available rewards.
This opportunity allows you to explore the capabilities offered by Ocean Protocol and gain valuable exposure. As your models and skills improve, you can publish your models on the main network and begin monetizing your work.
For detailed instructions and information on how to get started, please refer to the [Challenge DF](/user-guides/how-to-farm-challengedf.md) section.

View File

@ -0,0 +1,61 @@
---
description: Make extra dosh with active rewards yield in Data Farming
---
# Data Farm 101
<figure><img src="../.gitbook/assets/gif/farming.gif" alt=""><figcaption></figcaption></figure>
Data Farming is the core incentive system inside of Ocean Protocol. It offers different ways for participants to help the protocol grow and succeed.
It's broken down into 2 reward streams:
1. Passive Rewards
2. Active Rewards
As the name suggests, users need to do very little to earn Passive Rewards and the program is aimed to onboard as many people as possible to help drive liquidity and conviction into the protocol.
Active Rewards is an evolving incentive program that offers different venues for contributors to curate markets, create algorithms, and active do work to imporve the protocol.
All streams operate permissionlessly and anyone is welcomed to participate.
## Passive Rewards stream
Passive Rewards is the first of the main streams within Data Farming.
Passive Rewards offers a defined amount of rewards for each round that is divided amongst veOCEAN holders based on how much they hold.
The primary objective of the Passive Rewards stream is to provide a low-friction, high-accessibility way for anyone that is holding OCEAN to participate and help the protocol grow.
It is by-design, without the need for anyone to put in any significant effort. You simply need to lock your tokens for a period of time.
To learn more about veOCEAN and the Passive Rewards stream [you can click here](user-guides/data-farming/how-to-farm-veOCEAN.md)
## Active Rewards stream & substreams
Active Rewards is the second of the main streams within Data Farming.
Active Rewards offers a defined amount of rewards for each round and is further divided into multiple substreams.
The primary objective of these substreams is to provide users with various opportunities to actively engage in Data Farming. This approach allows users with different skills and interests to collaborate and contribute their unique abilities towards achieving the core values of Ocean Protocol.
Let's review the Active Reward substreams now to learn more about them, and help you get started with contributing to Ocean Protocol and earning rewards.
### Volume DF Substream
Volume DF is the bread and butter of the Data Farming incentive program and rewards OCEAN to publishers and curators that help maintain quality assets in the Ocean ecosystem.
If you have locked your OCEAN tokens in exchange for veOCEAN, this is the ideal opportunity for you to utilize those veOCEAN tokens and earn a portion of active rewards in addition to passive rewards.
By allocating your veOCEAN power to high-quality datasets, you can assist Ocean in curating datasets. Moreover, through allocation, you will also receive a portion of the revenue generated by the dataset consumption.
Allocation Power can also be earned via delegation. The Data Farming dApp [Delegate Page](https://df.oceandao.org/delegate) lets you easily manage simple delegations that use the 100% of the current veOCEAN and the LockEnd time to set the delegation.
For more information on how to get started and detailed instructions, please refer to the [Volume DF](user-guides/data-farming/how-to-farm-volumedf.md) section.
### Challenge DF Substream
If you are a data scientist and enjoy tackling challenging problems, this is the perfect place for you. Challenge DF provides a weekly competition where you can test your skills in predicting the price of Ethereum. Rise against other participants to earn a place on the podium and receive a share of the available rewards.
This opportunity allows you to explore the capabilities offered by Ocean Protocol and gain valuable exposure. As your models and skills improve, you can publish your models on the main network and begin monetizing your work.
For detailed instructions and information on how to get started, please refer to the [Challenge DF](user-guides/data-farming/how-to-farm-challengedf.md) section.