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

Rewriting titles and re-organizing data based on IA. ^Carted consolidating data, removing redundancy, increasing focus. Docs == Concepts || Guides == How Tos. Renamed from Volume DF => VolumeDF, from Challenge DF => ChallengeDF...

Browse Source
This commit is contained in:
idiom-bytes 2023-07-24 10:54:36 -07:00
parent 288e12af31
commit 1186731ebd
14 changed files with 75 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
SUMMARY.md
View File

@ -29,12 +29,12 @@
* [Join a Data Challenge](user-guides/join-a-data-challenge.md)
* [Sponsor a Data Challenge](user-guides/sponsor-a-data-challenge.md)
* [Data Farming](user-guides/data-farming/README.md)
* [Get Started with Passive Rewards](user-guides/data-farming/how-to-veocean.md)
* [Estimate your APYs](user-guides/data-farming/how-to-estimate-apy.md)
* [Claim your Rewards](user-guides/data-farming/how-to-claim-rewards.md)
* [Curate with Volume DF](user-guides/data-farming/how-to-volumedf.md)
* [Delegate Data Curation](user-guides/data-farming/how-to-challengedf.md)
* [Predict with Challenge DF](user-guides/data-farming/how-to-challengedf.md)
* [Earn Passive Rewards](user-guides/data-farming/how-to-veocean.md)
* [Estimate APYs](user-guides/data-farming/how-to-estimate-apy.md)
* [Claim Rewards](user-guides/data-farming/how-to-claim-rewards.md)
* [Curate Data](user-guides/data-farming/how-to-volumedf.md)
* [Delegate Curation](user-guides/data-farming/how-to-challengedf.md)
* [Predict ETH](user-guides/data-farming/how-to-challengedf.md)
* [Liquidity Pools \[deprecated\]](user-guides/remove-liquidity-pools.md)
* [💻 Developers](developers/README.md)
* [Architecture Overview](developers/architecture.md)
@ -116,13 +116,13 @@
* [Deploying C2D](infrastructure/compute-to-data-minikube.md)
* [C2D - Private Docker Registry](infrastructure/compute-to-data-docker-registry.md)
* [🤑 DeFi](defi/README.md)
* [💰 Data Farming Rewards](rewards/README.md)
* [Data Farming 101 (White Belt)](rewards/df-intro.md)
* [DF Max Out Yield (Purple Belt)](rewards/df-max-out-yield.md)
* [DF Challenge (Red Belt)](rewards/df-challenges.md)
* [DF "ve" in veOCEAN (Brown Belt)](rewards/df-veocean.md)
* [DF Deep Dives (Brown Belt)](rewards/df-basic.md)
* [DF Emissions & APYs (Black Belt)](rewards/df-emissions-apys.md)
* [💰 Data Farming](rewards/README.md)
* [Farming 101](rewards/df-intro.md)
* [veOCEAN](rewards/df-veocean.md)
* [Curate Data](rewards/df-max-out-yield.md)
* [Prediction Challenges](rewards/df-challenges.md)
* [Complete User Guides](rewards/df-guides.md)
* [Emissions & APYs](rewards/df-emissions-apys.md)
* [🤝 Contribute](contribute/README.md)
* [Partners & Collaborators](contribute/projects-using-ocean.md)
* [Contributor Code of Conduct](contribute/code-of-conduct.md)

16
discover/glossary.md
View File

@ -137,17 +137,25 @@ In exchange for locking tokens, users can earn rewards. The amount of reward dep
<details>
<summary>DF Passive Rewards</summary>
<summary>Passive Rewards</summary>
When a user locks their OCEAN tokens for a finite period of time, they get veOCEAN tokens in return. Based on the quantity of veOCEAN, the user accumulates weekly OCEAN [rewards](../rewards/df-intro.md#what-are-active-rewards). Because rewards are generated without human intervention, these are called "passive" OCEAN rewards. OCEAN rewards are claimable every Thursday on the [Rewards page](https://df.oceandao.org/rewards).
When a user locks their OCEAN tokens for a finite period of time, they get veOCEAN tokens in return. Based on the quantity of veOCEAN, the user accumulates weekly OCEAN rewards. Because rewards are generated without human intervention, these are called [Passive Rewards](../rewards/df-intro.md#what-are-passive-rewards). OCEAN Data Farming Passive Rewards are claimable every Thursday on the [Rewards page](https://df.oceandao.org/rewards).
</details>
<details>
<summary>DF Active Rewards</summary>
<summary>VolumeDF</summary>
When a user allocates veOCEAN tokens to Ocean Market projects, then weekly OCEAN rewards are given to a user based on the sales of those projects. Since these rewards depend on human intervention to decide the allocations, they are categorized as "active" [rewards](../rewards/df-intro.md#what-are-passive-rewards) instead of passive rewards. OCEAN rewards are claimable every Thursday on the [Rewards page](https://df.oceandao.org/rewards).
When a user allocates veOCEAN tokens to Ocean Market projects, then weekly OCEAN rewards are given to a user based on the sales of those projects. Since these rewards depend on human intervention to decide the allocations, these are categorized as [VolumeDF](../rewards/df-intro.md#what-is-volume-df) rewards. OCEAN Data Farming VolumeDF rewards are claimable every Thursday on the [Rewards page](https://df.oceandao.org/rewards).
</details>
<details>
<summary>ChallengeDF</summary>
When a user submits prediction algorithms to the [ChallengeDF program](https://df.oceandao.org/challenges) that accurately estimate the price of Ethereum, then OCEAN rewards are airdropped to that user if win one of the top 3 prizes. Since these rewards depend on human intervention to compete in this challenge, these are categorized as [ChallengeDF](../rewards/df-intro.md#what-is-challenge-df) rewards. OCEAN Data Farming ChallengeDF rewards are claimable every Thursday on the [Rewards page](https://df.oceandao.org/rewards).
</details>

2
rewards/README.md
View File

@ -25,7 +25,7 @@ veOCEAN is a fork of veCRV. This enables participants to become a governance del
![DF Rewards Page](../.gitbook/assets/rewards/df_rewards_page.png)
[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.
[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-max-out-yield.md) will provide you with more intuitions about Data Farming, briefly explain the Reward Function, and how the program evolved over time.

2
rewards/df-challenges.md
View File

@ -33,7 +33,7 @@ We provide the rules and rewards, allowing you to focus on delivering high-quali
Head over to the [Data Farming dapp](https://df.oceandao.org/rewards) and explore the new **ChallengeDF substream** section, which is now part of the Active Rewards. The dapp itself will serve as your guide moving forward!
If you're looking for a step-by-step guide on everything from understanding what a challenge entails to claiming your well-deserved rewards, be sure to check out [how to farm challenge df rewards](../user-guides/data-farming/how-to-challengedf.md) section. It will provide you with all the necessary information you need to make the most out of the challenges.
If you're looking for a step-by-step guide on everything from understanding what a challenge entails to claiming your well-deserved rewards, be sure to check out [how to farm ChallengeDF rewards](../user-guides/data-farming/how-to-challengedf.md) section. It will provide you with all the necessary information you need to make the most out of the challenges.
### Good lock and happy coding!

0
rewards/df-basic.md → rewards/df-guides.md
View File

26
rewards/df-intro.md
View File

@ -12,6 +12,10 @@ Data Farming (DF) is Ocean Protocol's **incentive system that rewards participan
Participants are able to **receive rewards passively, actively, or both** weekly by engaging in a variety of streams that helps the protocol grow. These activities include holding veOCEAN, curating datasets and building prediction models.
With this model, there is no liquidity risk through AMMs. We have also used battle-tested, hardened contracts that safeguard billions (veCRV).
You can’t lose your OCEAN. It is merely locked.
### Passive and Active Reward streams
Every week OCEAN rewards are paid out to Data Farmers through two different reward streams. **Passive Rewards** and **Active Rewards**.
@ -30,13 +34,11 @@ Each Data Farming weekly round has a pool of OCEAN rewards, where 50% of the poo
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>
<<<<<<< HEAD
[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-farm-veOCEAN.md)
>>>>>>> issue-1218-add-challenge-df-info
#### What are Active Rewards and Substreams?
@ -46,17 +48,19 @@ There are are two substreams available in Active Rewards:
1. VolumeDF
2. ChallengeDF
#### 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-max-out-yield.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.
Active Rewards are governed and defined by the [Reward Function](df-max-out-yield.md#reward-schedule).
<<<<<<< HEAD
[To start getting Active Rewards, go here.](../user-guides/data-farming/README.md)
=======
[To start getting Active Rewards, go here.](../user-guides/README.md)
>>>>>>> issue-1218-add-challenge-df-info
You can visit the follow tutorial learn how to [access ChallengeDF](../user-guides/data-farming/how-to-challengedf.md)
#### Estimating APY

2
rewards/df-max-out-yield.md
View File

@ -4,7 +4,7 @@ description: >-
Ocean Protocol's Data Farming dApp!
---
# Mastering Volume DF (Purple Belt)
# Mastering VolumeDF
<figure><img src="../.gitbook/assets/gif/i-know-kung-fu.gif" alt=""><figcaption><p>You know enough to be dangerous.</p></figcaption></figure>

20
rewards/df-veocean.md
View File

@ -28,20 +28,6 @@ veOCEAN allows you to engage with different Ocean Protocol mechanisms and benefi
3. **Delegating it** You can delegate veOCEAN to other Data Farmers who can curate Datasets for you. In return for their services, these farmers may charge you a fee for helping you receive APY on **Active Rewards**. The Delegate feature has just been recently released and enables veOCEAN holders to more easily manage Active Rewards.
4. **2x Publisher Stake** If you are a publisher in the Ocean ecosystem, then allocating your veOCEAN to your own asset gives your veOCEAN **a 2x Bonus**. This is an incentive for publishers to engage with their assets and benefit the assets in the Ocean ecosystem further.
### The Nitty Gritty of **Passive & Active Rewards**
#### Passive Rewards from Data Farming
veOCEAN holders get weekly Data Farming rewards with a small carveout for any Ocean Protocol Data Challenges that run through Data Farming operations.
#### Active Rewards from Community Fees
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.
Active rewards follow the usual Data Farming formula: $ of sales of the asset \* allocation to that asset.
There is no liquidity locked inside a datatoken pool, and this allocation is safe: you can’t lose your OCEAN as it is merely locked.
### veOCEAN Time Locking
Users can lock their OCEAN for different lengths of time to gain more veOCEAN **voting power**. The Data Farming dApp is designed to lock OCEAN for **a minimum of 2 weeks and a maximum of four years** (for max rewards). The longer you lock your OCEAN, the more veOCEAN + OCEAN rewards you get!
@ -96,13 +82,11 @@ All earnings for veOCEAN holders are claimable in the Ethereum mainnet. (Data as
Data Farming rounds occur weekly; in line with this, there’s a new [`ve`](https://github.com/oceanprotocol/df-py/tree/main/contracts/ve) distribution “epoch” every week. This affects when you can first claim rewards. Specifically, if you lock OCEAN on day x, you’ll be able to claim rewards on the first ve epoch that begins after day x+7. Put another way, from the time you lock OCEAN, you must wait at least a week, and up to two weeks, to be able to claim rewards. (This behavior is inherited from veCRV. Here’s the [code](https://github.com/oceanprotocol/df-py/tree/main/contracts/ve) )
### DYOR!
### Locks & Withdrawal
veOCEAN is architected to be locked (i.e. 'staked') for a certain period of time and cannot be transferred or sold during the lock time that is determined by each user.
So it's important to **NOTE:** that you will not be able to retrieve your locked OCEAN tokens until the Lock End Date you selected on the dApp!
### Withdrawal
So it's important to note that: **"you will not be able to retrieve your locked OCEAN tokens until the Lock End Date you selected on the dApp!**
After the Lock End Date, then you can withdraw your principal OCEAN tokens on the [veOCEAN page](https://df.oceandao.org/veocean) on the left side panel.

2
user-guides/data-farming/how-to-challengedf.md
View File

@ -2,7 +2,7 @@
description: Make extra dosh with building prediction models
---
# Harvest More Yield in Challenge DF
# How to ChallengeDF
<figure><img src="../../.gitbook/assets/rewards/gif/challenge-df.gif" alt=""></figure>

4
user-guides/data-farming/how-to-volumedf.md
View File

@ -2,11 +2,11 @@
description: Make extra dosh by curating datasets in Data Farming
---
# Harvest More Yield in Volume DF
# How to VolumeDF
<figure><img src="../../.gitbook/assets/rewards/gif/volume-df.gif" alt=""><figcaption></figcaption></figure>
## Get More Rewards from Volume DF
## Maximize APY with VolumeDF
The bread and butter of the Data Farming dApp is incentivizing OCEAN rewards for curating and publishing valuable assets in the Ocean ecosystem.