diff --git a/.gitbook/assets/gif/mafs.gif b/.gitbook/assets/gif/mafs.gif new file mode 100644 index 00000000..3d19c0e1 Binary files /dev/null and b/.gitbook/assets/gif/mafs.gif differ diff --git a/.gitbook/assets/rewards/curate-datasets.png b/.gitbook/assets/rewards/curate-datasets.png new file mode 100644 index 00000000..8798483b Binary files /dev/null and b/.gitbook/assets/rewards/curate-datasets.png differ diff --git a/SUMMARY.md b/SUMMARY.md index 7a3c04be..aec186c3 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -29,6 +29,7 @@ * [Join a Data Challenge](user-guides/join-a-data-challenge.md) * [Sponsor a Data Challenge](user-guides/sponsor-a-data-challenge.md) * [Get Started Data Farming](user-guides/get-started-df.md) + * [Estimate your APYs](user-guides/how-to-df-estimate-apy.md) * [Harvest More Yield Data Farming](user-guides/how-to-data-farm.md) * [Claim Rewards Data Farming](user-guides/claim-ocean-rewards.md) * [Liquidity Pools \[deprecated\]](user-guides/remove-liquidity-pools.md) diff --git a/rewards/df-intro.md b/rewards/df-intro.md index 2c8a0135..5a72079e 100644 --- a/rewards/df-intro.md +++ b/rewards/df-intro.md @@ -20,6 +20,14 @@ Unlike yield farming in DeFi, data farming has real intrinsic utility for Ocean Every week OCEAN rewards are paid out to Data Farmers in two different ways: **passive** rewards and **active** rewards. The two reward functions produce different variable APYs. +#### Splitting the Pie + +Each Data Farming weekly round has a pool of OCEAN rewards, and 50% of the pool is paid out in the form of passive rewards & 50% in the form of active rewards. + +| Passive Rewards | Active Rewards | +| --------------- | -------------- | +| 50% | 50% | + #### What are Passive Rewards? Passive rewards are the OCEAN rewards paid to Data Farmers just for locking their OCEAN tokens. @@ -36,13 +44,11 @@ Active rewards are governed and defined by the [Reward Function](df-max-out-yiel [To start getting active rewards, go here.](../user-guides/how-to-data-farm.md) -#### Splitting the Pie +#### Estimating APY -Each Data Farming weekly round has a pool of OCEAN rewards, and 50% of the pool is paid out in the form of passive rewards & 50% in the form of active rewards. +To estimate your APY effectively, you will need a good understanding of how Passive and Active Rewards work. Therefore you should make sure to complete reading the documentation on Data Farming. -| Passive Rewards | Active Rewards | -| --------------- | -------------- | -| 50% | 50% | +To help you understand Data Farming and APYs and a bit better, [we have provided a couple of scenarios](../user-guides/how-to-df-estimate-apy.md) so you to can easily get an overview of how your yield might behave depending on your decisions. ## [GET STARTED DATA FARMING HERE.](https://df.oceandao.org) diff --git a/rewards/veocean.md b/rewards/veocean.md index 71b483e6..05f973f9 100644 --- a/rewards/veocean.md +++ b/rewards/veocean.md @@ -61,6 +61,8 @@ After choosing your lock period and locking up your OCEAN into the vault, you wi veOCEAN is non-transferable. You canโ€™t sell it or send it to other addresses. +_To help you more easily understand this, [we have created a couple of examples for you](../user-guides/how-to-df-estimate-apy.md) so you can more easily visualize the impact for your decisions on your overall yields._ + ### Linear Decay Your veOCEAN balance will slowly start declining as soon as you receive it. @@ -80,10 +82,6 @@ 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. - ### Replenishing your veOCEAN You can choose to update your lock and replenish your veOCEAN balance at any time. diff --git a/user-guides/README.md b/user-guides/README.md index c4412e68..03c0fd84 100644 --- a/user-guides/README.md +++ b/user-guides/README.md @@ -42,14 +42,22 @@ Earn rewards by obtaining veOCEAN, farm yield by curating datasets, and optimize [get-started-df.md](get-started-df.md) {% endcontent-ref %} -{% content-ref url="how-to-data-farm.md" %} -[how-to-data-farm.md](how-to-data-farm.md) +{% content-ref url="get-started-df.md" %} +[get-started-df.md](get-started-df.md) {% endcontent-ref %} {% content-ref url="claim-ocean-rewards.md" %} [claim-ocean-rewards.md](claim-ocean-rewards.md) {% endcontent-ref %} +{% content-ref url="how-to-data-farm.md" %} +[how-to-data-farm.md](how-to-data-farm.md) +{% endcontent-ref %} + +{% content-ref url="how-to-df-estimate-apy.md" %} +[how-to-df-estimate-apy.md](how-to-df-estimate-apy.md) +{% endcontent-ref %} + ### Antique Stuff ๐Ÿบ Out with the old, in with the new! diff --git a/user-guides/how-to-data-farm.md b/user-guides/how-to-data-farm.md index d6f32b44..abd8c5db 100644 --- a/user-guides/how-to-data-farm.md +++ b/user-guides/how-to-data-farm.md @@ -42,8 +42,6 @@ That's it! You've successfully allocated (aka "voted on") your favorite assets i Do you have multiple wallets? Say you want to send rewards to someone you ๐Ÿ’– We have a solution for that! Data Farming's [Delegate](https://df.oceandao.org/delegate) feature allows you to transfer your veOCEAN allocation power to another wallet address. Another reason for delegating - you might be able to earn a higher annual percentage yield (APY) by delegating your active rewards to an address that more efficiently manages your allocation. For all these reasons and more, then you might want to delegate - go to [https://df.oceandao.org/delegate](https://df.oceandao.org/delegate) to make the magic happen โœจ - - When you delegate, you transfer 100% of your veOCEAN allocation power for a limited period. You can delegate your active rewards \*without\* the need for reallocation and transaction fees! Note that after you delegate, then you cannot manage your allocations until the delegation expires. The delegation expiration date is the same as your veOCEAN Lock End Date at the time of delegation. If necessary, you can extend your Lock End Date before delegating. You can also cancel your delegation at any time ๐Ÿ’ช Once delegated, rewards will be sent to the wallet address you delegated to. Then, the delegation receiver is in charge of your active rewards and is responsible for returning those back to you should you choose to do so. Follow these steps to delegate your veOCEAN: diff --git a/user-guides/how-to-df-estimate-apy.md b/user-guides/how-to-df-estimate-apy.md new file mode 100644 index 00000000..82cca9ca --- /dev/null +++ b/user-guides/how-to-df-estimate-apy.md @@ -0,0 +1,38 @@ +--- +description: >- + Learn how to use basic math and a simple spreadsheet to estimate your + Passive Rewards APY and get deeper into Active Rewards APY. +--- + +# veOCEAN and your APY + +Rewards are earned by users that hold and use their veOCEAN to help the protocol improve and grow. Here are some good lessons to improve the outcome of your APY. +1. To improve your yield, you will need to make good decisions for how long you'll choose to lock. The best way to do this is to learn how [Time Locking](/rewards/veocean.md#veocean-time-locking) and [Linear Decay](/rewards/veocean.md#linear-decaywork) function. +2. APYs are always initially calculated by dividing the amount of OCEAN you have received from rewards, by the relative amount of OCEAN you have locked up. +3. As a rule: _Wherever APYs are provided to the user in the app (df.oceandao.org), they are caclulated assuming an initial 4-year lock up period with a weekly schedule of compounding rewards into an updated 4-year lock. This estimate works provided current: number of users, reward emissions, and other reward parameters stay constant while excluding all tx fees_ + +### Estimating Passive APY + +To make it easier to estimate your APY, [we have created a simple spreadsheet](https://docs.google.com/spreadsheets/d/1zzuW5pBbX6j6hZL_XtJDtSR2-rDHa_LGOEwgoQ4D8lk/edit?usp=sharing) that let's you easily estimate your Passive APY. + +We have provided 2 sheets as an example of locking-up 10,000 OCEAN for: +1. A 4-year investment period +2. A 6-mo investment period + +These examples are meant to be as simple as possible so anyone can understand them. They are naive investment strategies and are meant to provide the reader some examples to build upon. Please copy this spreadsheet and modify as you wish. + +

It doesn't have to be scary.

+ +### Estimating Active APY + +Active Rewards are a bit more complicated and we currently do not provide a model/sim for estimating Active APY. This is also dependent on a lot of different variables and is unlikely for the user to get a practical result. + +You can easily expand the spreadsheet above to support basic, naive calculations for Active Rewards such as defining a constant percent yield per week. + +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. + +

Curate like a Pro.

+ +You can also [learn how rewards are calculated here](rewards/df-max-out-yield.md#how-rewards-are-calculated) to understand more about what's happening behind the scenes each rounn of Data Farming. + +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. \ No newline at end of file