oceanprotocol/docs
1
0
Fork 0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-01 15:55:34 +01:00
Code Releases Activity

Reordering pages to make them more compact, objective, and to reduce burden on the user.

Browse Source
This commit is contained in:
idiom-bytes 2023-07-24 15:28:50 -07:00
parent 2dc4de605f
commit 0443929a8e
5 changed files with 105 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
rewards/README.md
View File

@ -4,43 +4,56 @@ cover: ../.gitbook/assets/cover/rewards_banner.png
coverY: 0 coverY: 0
--- ---
# Data Farming Rewards 💰 # Data Farming Overview
### Why did we create the Data Farming dApp? ### Why did we create Data Farming?
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. The purpose of Ocean Protocol's Data Farming incentive programs is to onboard participants onto the protocol, and provide them with the tools needed for 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 participants earn OCEAN rewards across 2 main streams **Passive Rewards** and **Active Rewards**.
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: VolumeDF, ChallengeDF.
## veOCEAN
Learning about [veOCEAN](df-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.
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.
## Data Farming ## Data Farming
![DF Rewards Page](../.gitbook/assets/rewards/df_rewards_page.png) [Farming 101](df-intro.md) introduces Data Farming, the different reward systems, how they work, and how to access them. By the end of the document, you should feel more familiar with Data Farming concepts and confident to take next steps towards estimating APYs, locking your OCEAN, and accessing other reward streams.
[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. ## veOCEAN
[Data Farming Background](df-volumedf.md.md) will provide you with more intuitions about Data Farming, briefly explain the Reward Function, and how the program evolved over time. Learning about [veOCEAN](df-veocean.md) will help you answer the question "What is the purpose of veOCEAN?" and give insights on how veOCEAN (vote-escrowed OCEAN) works.
## Delegation ### Passive Rewards
At a minimum, Data Farmers earn [Passive Rewards](df-intro.md#what-are-passive-rewards) for locking their $OCEAN and receiving $veOCEAN in return.
### Active Rewards
[Active Rewards](df-intro.md#what-are-active-rewards) stream is broken down into multiple substreams, to offer you a variaty of ways to contribute to Ocean Protocol values and increase your Data Farming rewards: VolumeDF, ChallengeDF.
#### Curate Data with VolumeDF
In the VolumeDF substream, curators can maximize their yield by participating in [VolumeDF](df-volumedf.md).
VolumeDF requires participants to curate quality datasets that are driving sales and are helping Ocean Protocol achieve traction.
## Delegate Curation
[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 VolumeDF 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 VolumeDF 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. 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.
#### Predict with ChallengeDF
In this substream, Data Scientists can maximize their yield by participating in [ChallengeDF](df-challengedf.md).
ChallengeDF requires participants to submit algorithms that predict the price of ETH correctly in order to win rewards.
## Further Reading ## 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: 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](df-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. [Emissions & APYs](df-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.
[Data Farming Background](df-emissions-apys.md#a-brief-history-of-data-farming) will provide you with a lot more information about Data Farming, how the program evolved, and explain detailed mechanisms of the program such as the Reward Function.
Our [FAQ](../discover/faq.md) answers many different questions about staking, chains, deployments, and other details that may be valuable to you. Our [FAQ](../discover/faq.md) answers many different questions about staking, chains, deployments, and other details that may be valuable to you.
## Reference ## Reference

2
rewards/df-challengedf.md
View File

@ -3,7 +3,7 @@ description: >-
Weekly prediction challenges for data scientists to compete, launch algorithms, and start earning. 🏆 Weekly prediction challenges for data scientists to compete, launch algorithms, and start earning. 🏆
--- ---
# Participage in ChallengeDF # Participate in ChallengeDF
<figure><img src="../.gitbook/assets/rewards/gif/eat-data.gif" alt=""><figcaption><p>Let's consume some data.</p></figcaption></figure> <figure><img src="../.gitbook/assets/rewards/gif/eat-data.gif" alt=""><figcaption><p>Let's consume some data.</p></figcaption></figure>

18
rewards/df-emissions-apys.md
View File

@ -56,3 +56,21 @@ All the plots are calculated from [this Google Sheet](https://docs.google.com/sp
OCEAN lock time affects APY. The numbers above assume that all locked OCEAN is locked for 4 years, so that 1 OCEAN → 1 veOCEAN. But APY could be much worse or more if you lock for shorter durations. Here are approximate bounds. OCEAN lock time affects APY. The numbers above assume that all locked OCEAN is locked for 4 years, so that 1 OCEAN → 1 veOCEAN. But APY could be much worse or more if you lock for shorter durations. Here are approximate bounds.
If you lock for 4 years, and everyone else locks for 2, then multiply expected APY by 2. If you lock for 4 years and others for 1, then multiply by 4. Conversely, if you lock for 2 years and everyone else for 4, then divide your expected APY by 2. If you lock for 1 year and others for 4, then divide by 4. The numbers assume that you’re actively allocating veOCEAN allocation towards high-DCV data assets. For passive locking or low-DCV data assets, divide APY by 2 (approximate). If you lock for 4 years, and everyone else locks for 2, then multiply expected APY by 2. If you lock for 4 years and others for 1, then multiply by 4. Conversely, if you lock for 2 years and everyone else for 4, then divide your expected APY by 2. If you lock for 1 year and others for 4, then divide by 4. The numbers assume that you’re actively allocating veOCEAN allocation towards high-DCV data assets. For passive locking or low-DCV data assets, divide APY by 2 (approximate).
## 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.
**DF Alpha - Rounds 1-4 (4 wks)**\
10K OCEAN rewards were budgeted per week. Counting started Thu June 16, 2022 and ended July 13, 2022. Rewards were distributed at the end of every week, for the activity of the previous week. It ran for 4 weeks. The aim was to test technology, learn, and onboard data publishers.
**DF/VE Alpha - Rounds 5-8 (4 wks)**\
10K OCEAN rewards were budgeted per week. Counting started Thu Sep 29, 2022 and ended Oct 27, 2022. Rewards were distributed at the end of every week, for the activity of the previous week. It ran for 4 weeks. The aim was to resume Data Farming along with veOCEAN, test the technology, onboard data publishers, and keep learning.
**DF Beta - Rounds 9-28 (20 wks)**\
Up to 100K OCEAN rewards were budgeted per week. Counting started Thu Oct 27, 2022, and ended on March 15, 2023. It ran for 20 weeks. The aim was to test the effect of larger incentives, and support ecosystem participation, while continually refining the underlying technology.
**DF Main - Rounds 29-1000+**\
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 goes up to 1.1M OCEAN per week. DF Main emits 503.4M OCEAN worth of rewards and lasts for decades.
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](df-intro.md#reward-schedule).

94
rewards/df-intro.md
View File

@ -24,68 +24,64 @@ These two reward streams produce different variable APYs.
#### Splitting the Pie #### Splitting the Pie
Each Data Farming weekly round has a pool of OCEAN rewards, where 50% of the pool is paid out in the form of passive rewards & 50% in the form of active rewards. Each Data Farming weekly round has a pool of OCEAN rewards, where 50% of the pool is paid out in the form of passive rewards & 50% in the form of active rewards that [can be viewed here](https://df.oceandao.org/rewards).
| Passive Rewards | Active Rewards | | Passive Rewards | Active Rewards |
| --------------- | -------------- | | --------------- | -------------- |
| 50% | 50% | | 50% | 50% |
#### What are Passive Rewards?
Passive rewards are the OCEAN rewards paid to Data Farmers just for locking their OCEAN tokens. <figure><img src="../.gitbook/assets/rewards/df-reward-streams.png" alt=""><figcaption><p>Rewards Page overview for each stream.</p></figcaption></figure>
veOCEAN holders can generate yield completely passively if they wish, though they are incentivized with larger real yield if they **actively participate** in farming yield from assets, or completing predictionc hallenges. ### What are Passive Rewards?
Passive rewards are the OCEAN rewards paid to Data Farmers just for locking their OCEAN tokens.
veOCEAN holders can generate yield completely passively if they wish, though they are incentivized with larger real yield if they **actively participate** in farming yield from assets, or completing predictionc hallenges.
<figure><img src="../.gitbook/assets/gif/passive-income.gif" alt=""><figcaption></figcaption></figure> <figure><img src="../.gitbook/assets/gif/passive-income.gif" alt=""><figcaption></figcaption></figure>
[To start getting passive rewards, go here.](../user-guides/data-farming/how-to-veocean.md) [To start getting passive rewards, go here.](../user-guides/data-farming/how-to-veocean.md)
#### What are Active Rewards and Substreams? ### What are Active Rewards?
Active Rewards are OCEAN rewards paid to contributors actively working to improve Ocean Protocol. Active Rewards are OCEAN rewards paid to contributors actively working to improve Ocean Protocol.
There are are two substreams available in Active Rewards: **Active Rewards** is then composed of two sub-streams:
1. VolumeDF 1. 5,000 $OCEAN is paid out to ChallengeDF.
2. ChallengeDF 2. 70,000 $OCEAN remainder is paid out to VolumeDF.
#### What is VolumeDF
VolumeDF rewards Data Farmers that allocate their veOCEAN tokens to Ocean ecosystem assets. It's called VolumeDF because the amount of rewards relies on assets that are actively generating Data Consume Volume. Therefore, **VolumeDF yields depend on the sales produced by these assets and allocations made.** No sales = no rewards, so choose your favorite datasets wisely & then allocate. Always DYOR.
You can visit the follow tutorial learn how to [access VolumeDF](../user-guides/data-farming/how-to-volumedf.md)
VolumeDF rewards are governed and defined by the [Reward Function](df-volumedf.md.md#reward-schedule).
#### What is ChallengeDF
ChallengeDF rewards Data Scientists that produce prediction models that consistently improve the prediction of the price of Ethereum. It's called ChallengeDF because weekly rewards are dispensed towards participants that are competing to improve the accuracy of how well we can predict price movements of Ethereum. Therefore, **ChallengeDF yields depend on participants accurately outcompeting each other.** Only the top 3 predictions on the leaderboard win.
You can visit the follow tutorial learn how to [access ChallengeDF](../user-guides/data-farming/how-to-challengedf.md)
#### Estimating APY
Each Data Farming weekly round has a pool of OCEAN rewards and [can be viewed here](https://df.oceandao.org/rewards)
<figure><img src="../.gitbook/assets/rewards/df-reward-streams.png" alt=""><figcaption><p>Rewards Page overview for each stream.</p></figcaption></figure>
##### Reward Streams
50% of the pool is paid out in the form of **Passive Rewards**.
50% of the pool is paid out in the form of **Active Rewards**.
| Passive Rewards | Active Rewards |
| --------------- | -------------- |
| 50% | 50% |
##### Reward Sub-Streams
**Active Rewards** is then composed of two sub-streams.
1. 5,000 OCEAN is paid out to ChallengeDF.
2. The remainder is paid out to VolumeDF.
| ChallengeDF | VolumeDF | | ChallengeDF | VolumeDF |
| --------------- | -------------- | | --------------- | -------------- |
| 5,000 OCEAN | Remaining OCEAN | | 5,000 $OCEAN | 70,000 $OCEAN |
### What is VolumeDF
[VolumeDF](df-volumedf.md#allocating-veocean) rewards Data Farmers that allocate their veOCEAN tokens to Ocean datasets. It's called VolumeDF because the amount of rewards relies on assets that are actively generating Data Consume Volume.
You can visit the follow tutorial learn how to [access VolumeDF](../user-guides/data-farming/how-to-volumedf.md).
VolumeDF rewards are governed and defined by the [Reward Function](df-intro.md#reward-schedule).
#### Estimating APY
To a get a good sense for how much APY you'll make, we recommend you understand the details of [how veOCEAN works](df-veocean.md). This will give you a basis for the calculations and provide you with an outline for what to expect in terms of rewards over time.
You can find the [how to estimate APY](../user-guides/data-farming/how-to-estimate-apy.md) user guide, calculate a reward schedule, and compare your lock up period with others.
#### Publisher Rewards
<figure><img src="../.gitbook/assets/gif/just-publish.gif" alt=""><figcaption><p>Publishing lets you earn *more* OCEAN rewards</p></figcaption></figure>
Publishers are strongly incentivized to launch assets in the Ocean Ecosystem. When publishers curate and support their own assets, they [receive double the allocation power](df-volumedf.md#what-are-publisher-rewards).
You can learn how to curate datasets and access [Publisher Rewards](../user-guides/data-farming/how-to-volumedf.md#) here.
### What is ChallengeDF
ChallengeDF rewards Data Scientists that produce prediction models that consistently improve the prediction of the price of Ethereum. It's called ChallengeDF because weekly rewards are dispensed towards participants that are competing to improve the accuracy of how well we can predict price movements of Ethereum. Therefore, **ChallengeDF yields depend on participants accurately outcompeting each other.** Only the top 3 predictions on the leaderboard win.
You can visit the follow tutorial learn how to [access ChallengeDF](../user-guides/data-farming/how-to-challengedf.md).
### What's the difference between Data Farming and Yield Farming? ### What's the difference between Data Farming and Yield Farming?
@ -95,15 +91,13 @@ Unlike yield farming in DeFi, data farming has real intrinsic utility for Ocean
To deepen this incentive, Publishers are boosted further and **gain 2x the allocation power** when pointing to their own assets. To deepen this incentive, Publishers are boosted further and **gain 2x the allocation power** when pointing to their own assets.
### What are Publisher Rewards? ## Reward Schedule
<figure><img src="../.gitbook/assets/gif/just-publish.gif" alt=""><figcaption><p>Publishing lets you earn *more* OCEAN rewards</p></figcaption></figure> 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.
Data Farming strongly incentivizes publishing assets in the Ocean ecosystem by doubling the allocation power of Data Farmers that support their own published assets. <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>
How is it calculated? _All the veOCEAN a Data Farmer has allocated to an asset they’ve published **is effectively doubled for the rewards calculation.**_ <figure><img src="../.gitbook/assets/gif/cash-flow.gif" alt=""><figcaption></figcaption></figure>
You can read more about the implementation [in this blog post](https://blog.oceanprotocol.com/data-farming-publisher-rewards-f2639525e508).
## [GET STARTED DATA FARMING HERE.](https://df.oceandao.org) ## [GET STARTED DATA FARMING HERE.](https://df.oceandao.org)

42
rewards/df-volumedf.md
View File

@ -3,11 +3,19 @@ description: >-
If you've gotten this far, then you're half way to becoming a pro in Ocean Protocol's Data Farming dApp! If you've gotten this far, then you're half way to becoming a pro in Ocean Protocol's Data Farming dApp!
--- ---
# Mastering VolumeDF # Curate Data in VolumeDF
<figure><img src="../.gitbook/assets/gif/i-know-kung-fu.gif" alt=""><figcaption><p>You know enough to be dangerous.</p></figcaption></figure> <figure><img src="../.gitbook/assets/gif/i-know-kung-fu.gif" alt=""><figcaption><p>You know enough to be dangerous.</p></figcaption></figure>
## Yield Kung Fu ## Allocating veOCEAN
VolumeDF rewards Data Farmers that allocate their veOCEAN tokens to Ocean ecosystem assets.
It's called VolumeDF because the amount of rewards relies on assets that are actively generating Data Consume Volume. Therefore, **VolumeDF yields depend on the sales produced by these assets and allocations made.**
No sales = no rewards, so choose your favorite datasets wisely & then allocate.
## Data Curation Kung Fu
If you only lock your OCEAN tokens to get passive yield, then you're leaving money on the table. If you only lock your OCEAN tokens to get passive yield, then you're leaving money on the table.
@ -23,7 +31,7 @@ Thus, if you really want to max out VolumeDF APY:
Another way to improve your yield is by [delegating](../user-guides/data-farming/how-to-delegate.md) 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. Another way to improve your yield is by [delegating](../user-guides/data-farming/how-to-delegate.md) 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.
### Data Farming success metrics ### Success Metrics
**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! **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!
@ -52,7 +60,7 @@ For mathematicians and coders, you can find this code inside [calcrewards.py](ht
<figure><img src="../.gitbook/assets/gif/just-publish.gif" alt=""><figcaption><p>Publishing makes you *more* OCEAN rewards</p></figcaption></figure> <figure><img src="../.gitbook/assets/gif/just-publish.gif" alt=""><figcaption><p>Publishing makes you *more* OCEAN rewards</p></figcaption></figure>
Data Farming strongly incentivizes publishing assets in the Ocean ecosystem by giving double the active rewards to Data Farmers that allocate to their own published assets. VolumeDF strongly incentivizes publishing assets in the Ocean ecosystem by giving double the active rewards to Data Farmers that allocate to their own published assets.
How is it calculated? _All the veOCEAN a Data Farmer has allocated to an asset they’ve published is **doubled for the rewards calculation.**_ How is it calculated? _All the veOCEAN a Data Farmer has allocated to an asset they’ve published is **doubled for the rewards calculation.**_
@ -83,29 +91,3 @@ 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) * 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)
* The asset must be listed on Ocean Market * The asset must be listed on Ocean Market
* 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)
### 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.
**DF Alpha - Rounds 1-4 (4 wks)**\
10K OCEAN rewards were budgeted per week. Counting started Thu June 16, 2022 and ended July 13, 2022. Rewards were distributed at the end of every week, for the activity of the previous week. It ran for 4 weeks. The aim was to test technology, learn, and onboard data publishers.
**DF/VE Alpha - Rounds 5-8 (4 wks)**\
10K OCEAN rewards were budgeted per week. Counting started Thu Sep 29, 2022 and ended Oct 27, 2022. Rewards were distributed at the end of every week, for the activity of the previous week. It ran for 4 weeks. The aim was to resume Data Farming along with veOCEAN, test the technology, onboard data publishers, and keep learning.
**DF Beta - Rounds 9-28 (20 wks)**\
Up to 100K OCEAN rewards were budgeted per week. Counting started Thu Oct 27, 2022, and ended on March 15, 2023. It ran for 20 weeks. The aim was to test the effect of larger incentives, and support ecosystem participation, while continually refining the underlying technology.
**DF Main - Rounds 29-1000+**\
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 goes up to 1.1M OCEAN per week. DF Main emits 503.4M OCEAN worth of rewards and lasts for decades.
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.