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

Setup redirects, standardized user-guide headers, cleaned up titles and content.

Browse Source
This commit is contained in:
idiom-bytes 2023-07-25 16:12:22 -07:00
parent 34802bda18
commit 581e40f793
3 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
.gitbook.yaml
View File

@ -63,3 +63,10 @@ redirects:
api-references: developers/README.md
api-references/aquarius-rest-api: developers/aquarius/asset-requests.md
api-references/provider-rest-api: developers/provider/general-endpoints.md
user-guides/claim-ocean-rewards: user-guides/data-farming/how-to-claim-ocean-rewards.md
user-guides/get-started-df: user-guides/data-farming/how-to-veocean.md
user-guides/how-to-data-farm: user-guides/data-farming/how-to-volume-df.md
user-guides/how-to-df-estimate-apy: user-guides/data-farming/how-to-estimate-apy.md
rewards/df-basic: rewards/df-guides.md
rewards/veocean: rewards/df-veocean.md
rewards/df-max-out-yield: rewards/df-volumedf.md

8
user-guides/data-farming/how-to-estimate-apy.md
View File

@ -10,7 +10,7 @@ description: >-
Rewards are earned by users that hold and use their veOCEAN to help the protocol improve and grow.
We would
First, make sure that you [understand the basics of APY](../../rewards/df-veocean.md#veocean-and-your-apy) and how veOCEAN works.
Now that we got that out of the way, let's work through the examples and keep it as simple as possible.
@ -28,12 +28,12 @@ The above are simplified examples meant for everyone to understand. They are nai
Active Rewards are a bit more complicated and depend on many factors that are currently hard to predict accurately. It is unlikely for the user to get a practical result, which is why we don't offer a tool to estimate Active APY right now.
You can easily expand the spreadsheet above to support basic, naive calculations for Active Rewards such as defining a constant percent yield per week.
You can easily expand the spreadsheet above to support a basic, naive calculations for Active Rewards such as adding a fixed-rate.
Having said this, we do provide a thorough dashboard that provides historical and ongoing summaries of APY, Data Consume Volume, and veOCEAN allocations per-round.
To help solve this challenge, [we built a dashboard](https://df.oceandao.org/datafarming) that shows historical and ongoing summaries of APY, Data Consume Volume, and veOCEAN allocations per-round.
<figure><img src="../../.gitbook/assets/rewards/curate-datasets.png" alt=""><figcaption><p>Curate like a Pro.</p></figcaption></figure>
You can also [learn how rewards are calculated here](../rewards/df-volumedf.md.md#how-rewards-are-calculated) to understand more about what's happening behind the scenes of each Data Farming round.
Finally, you can [review the implementation inside df-web](https://github.com/oceanprotocol/df-web/blob/main/src/utils/rewards.js) to understand how APYs are calculated at the frontend/UI level.
Finally, you can [review the implementation inside df-web](https://github.com/oceanprotocol/df-web/blob/main/src/utils/rewards.js) to understand how the APYs on the UI are calculated.

8
user-guides/data-farming/how-to-veocean.md
View File

@ -2,15 +2,9 @@
description: Get veOCEAN tokens to use the Data Farming dApp and make yield! 🧑‍🌾🥕
---
# Earn Passive Rewards with veOCEAN
### What is Data Farming?
[Data Farming](https://df.oceandao.org) is our dApp that generates yield for participants that curate and publish valuable assets in the Ocean ecosystem.
<figure><img src="../../.gitbook/assets/gif/super-mario-coins.gif" alt="" width="250"><figcaption><p>Get veOCEAN tokens</p></figcaption></figure>
### What is veOCEAN and why do you want it? 🌊
# What is veOCEAN and Passive Rewards
In order to **gain yield Data Farming**, you will need to lock your OCEAN tokens first! When you lock your OCEAN tokens, you get **veOCEAN tokens** and **weekly passive OCEAN rewards** in return. veOCEAN is a token used in Ocean Protocol's Data Farming dApp to **generate even more yield,** called **Volume DF rewards**, for allocating your veOCEAN tokens to your favorite assets and get a portion of their sales!