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

GITBOOK-76: change request with no subject merged in GitBook

This commit is contained in:
Nicholas Scavuzzo 2023-05-11 21:45:12 +00:00 committed by gitbook-bot
parent e4c1cd1ffc
commit 220750c89e
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
6 changed files with 57 additions and 53 deletions

View File

@ -34,9 +34,9 @@
* [Update Metadata](tutorials/using-ocean-libraries/update-metadata.md)
* [🤑 DeFi](defi.md)
* [💰 Rewards](rewards/README.md)
* [How to get veOCEAN](rewards/how-to-get-veocean.md)
* [veOCEAN](rewards/veocean.md)
* [Data Farming 101](rewards/df-intro.md)
* [veOCEAN](rewards/veocean.md)
* [How to get veOCEAN](rewards/how-to-get-veocean.md)
* [Data Farming Background](rewards/df-background.md)
* [Emissions & APYs](rewards/emissions-apys.md)
* [Rewards Tutorial](rewards/veOcean-Data-Farming-Tutorial.md)

View File

@ -4,21 +4,21 @@ description: An overview of Ocean Protocol's governance and incentives mechanism
# 💰 Rewards
veOCEAN is a fork of veCRV, and enables you to become a governance participant, eligible to receive rewards and engage with different protocol mechanisms.
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.
The following docs should provide you with sufficient intuition to access, utilize, and build upon the protocol's core incentive and reward system: Data Farming.
The following docs provide you with sufficient intuition to access, utilize, and build upon the protocol's core incentive and reward system: Data Farming.
![DF Rewards Page](../.gitbook/assets/rewards/df\_rewards\_page.png)
## veOCEAN
Learning about [veOCEAN](veocean.md) will help you answer the question "What can I do with my veOCEAN?" and give you insights on how veOCEAN works. It will teach you everything you need to know about why it exists and how it works.
Learning about [veOCEAN](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 earn rewards.
You will learn that by just holding veOCEAN passively, you are able to rewards.
## Data Farming
[Data Farming 101](df-intro.md) will teach you about the different reward systems, how they work, and how to access them. By the end of it, you should be more familiar with how Data Farming works and able to take next steps to curate assets.
[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.
[Data Farming Background](df-background.md) will provide you with more intuitions about Data Farming, briefly explain the Reward Function, and how the program evolved over time.

View File

@ -1,5 +1,5 @@
---
description: An introduction to Data Farming and Ocean Protocol's key incentives.
description: An introduction to Data Farming and Ocean Protocol's incentive mechanism
---
# Data Farming 101
@ -22,19 +22,19 @@ Active Rewards are governed and defined by the [Reward Function](df-background.m
## How to access DF and claim rewards
Please [follow this tutorial](../rewards/veOcean-Data-Farming-Tutorial.md) to learn how the Ocean Protocol reward programs work, and how to access them.
Please [follow this tutorial](veOcean-Data-Farming-Tutorial.md) to learn how the Ocean Protocol reward programs work, and how to access them.
Otherwise, go to the DF webapp at [df.oceandao.org](df.oceandao.org/) and explore Data Farming for yourself.
Otherwise, go to the DF webapp at [df.oceandao.org](df.oceandao.org) and explore Data Farming for yourself.
### Where to claim?
All earnings for veOCEAN holders are claimable on the ”Rewards” page inside the Data Farming webapp on Ethereum mainnet.
All earnings for veOCEAN token holders are claimable on the ”Rewards” page inside the Data Farming webapp on Ethereum mainnet.
Data assets for DF may published in any [network where Oceans deployed in production](../core-concepts/networks.md): Eth mainnet, Polygon, etc.
Data assets for DF may be published in any [network where Oceans deployed in production](../core-concepts/networks.md): Ethereum Mainnet, Polygon, etc.
### When to claim?
There are fresh rewards available every Thursday. If you wish, you can wait for many weeks to accumulate before claiming. (Its all on-chain.)
Yield rewards are distributed weekly, every Thursday. Users can choose to claim every week, or wait many weeks to accumulate before claiming. (Its all on-chain.)
### When to do a first claim?
@ -60,8 +60,7 @@ DF Main lasts for decades.
The table below cross-references DF Round Number, Start Date, Phase & Week, Sub-Phase & Week, and OCEAN Rewards/Week.
![Rewards Schedule](../.gitbook/assets/rewards/reward_schedule.png)
_Ocean Reward Schedule for the next 20+ years_
![Rewards Schedule](../.gitbook/assets/rewards/reward\_schedule.png) _Ocean Reward Schedule for the next 20+ years_
## Ranked Rewards
@ -73,7 +72,7 @@ At the top-end, this helps increase quality and diversification of inventory.
At the bottom-end, this eliminates some potential free-rider issues and smooths out the reward distribution.
![Ranked Rewards](images/ranked_rewards_study.png)
![Ranked Rewards](images/ranked\_rewards\_study.png)
You can read more about the implementation [in this blog post](https://blog.oceanprotocol.com/data-farming-df22-completed-df23-started-reward-function-tuned-ffd4359657ee) and find the full study [in these slides](https://docs.google.com/presentation/d/1HIA2zV8NUPpCELmi2WFwnAbHmFFrcXjNQiCpEqJ2Jdg/).
@ -84,7 +83,7 @@ DF gives stronger incentives to publish data services, as follows.
_All the veOCEAN a publisher has allocated to an asset theyve published (“staked”) is treated as 2x the stake for rewards calculation._
1. As a staker, due to their staked veOCEAN on their own assets (1x).
1. As a publisher, for having veOCEAN staked on their own asset(1x).
2. As a publisher, for having veOCEAN staked on their own asset(1x).
The final reward is then calculated and bundled together to be distributed.

View File

@ -4,17 +4,17 @@ description: Details on the emission curves and a study on estimated APYs
# Emissions & APYs
With veOCEAN, OceanDAO evolves to be more like CurveDAO:
With veOCEAN, OceanDAO evolves to be more user focused, community driven, and futuristic revenue sharing like CurveDAO:
- ve is at the heart with v = voting (in data asset curation) and e = escrowed (locked) OCEAN. The longer the lockup, the more voting and rewards, which reconciles near and long-term DAO incentives.
- The DAO has increased bias to automation, and to minimizing the governance attack surface.
* ve (vote-escrowed) is at the heart with v = voting (in data asset curation) and e = escrowed (locked) OCEAN. The longer the lockup, the more voting and rewards, which reconciles near and long-term DAO incentives.
* The DAO has increased bias to automation, and to minimizing the governance attack surface.
The baseline emissions schedule determines the weekly OCEAN budget for this phase. The schedule is like Bitcoin, including a half-life of 4 years. Unlike Bitcoin, there is a burn-in period to ratchet up value-at-risk versus time:
The baseline emissions schedule determines the weekly OCEAN budget for this phase. The schedule mimics Bitcoin when including a half-life of 4 years. Unlike Bitcoin, there is a burn-in period to ratchet up value-at-risk versus time:
- The curve initially gets a multiplier of 10% for 12 months (DF Main 1)
- Then, it transitions to multiplier of 25% for 6 months (DF Main 2)
- Then, a multiplier of 50% for 6 months (DF Main 3)
- Finally, a multiplier of 100%. (DF Main 4)
* The curve initially gets a multiplier of 10% for 12 months (DF Main 1)
* Then, it transitions to multiplier of 25% for 6 months (DF Main 2)
* Further, a multiplier of 50% for 6 months (DF Main 3)
* Finally, a multiplier of 100%. (DF Main 4)
We implement the first three phases as constants, because they are relatively short in duration. We implement the fourth phase as a Bitcoin-style exponential: constant, with the constant dividing by two (“halvening”) every four years.
@ -24,21 +24,21 @@ Lets visualize!
The image below shows the first 5 years. The y-axis is OCEAN released each week. Its log-scaled to easily see the differences. The x-axis is time, measured in weeks. In weeks 029, we can see the distinct phases for DF Alpha (DF1 // week 0), DF/VE Alpha (DF5 // week 4), DF Beta (DF9 // week 8), DF Main 1 (DF29 // week 28), DF Main 2 (DF80 // week 79), DF Main 3 (DF106 // week 105), and DF Main 4 (DF132 // week 131).
![emissions-5 years](../.gitbook/assets/rewards/emissions_first_5years.png)
![emissions-5 years](../.gitbook/assets/rewards/emissions\_first\_5years.png)\
_OCEAN released to DF per week — first 5 years_
## Emissions — First 20 years.
The image below is like the previous one: OCEAN released per week, but now for the first 20 years. Week 131 onwards is DF Main 4. We can see that the y-value divides by two (“halvens”) every four years.
![emissions-20 years](../.gitbook/assets/rewards/emissions_first_20years.png)
![emissions-20 years](../.gitbook/assets/rewards/emissions\_first\_20years.png)\
_OCEAN released to DF per week — first 20 years_
## Total OCEAN released.
The image below shows the total OCEAN released by DF for the first 20 years. The y-axis is log-scaled to capture both the small initial rewards and exponentially larger values later on. The x-axis is also log-scaled so that we can more readily see how the curve converges over time.
![emissions-lifetime](../.gitbook/assets/rewards/emissions_lifetime.png)
![emissions-lifetime](../.gitbook/assets/rewards/emissions\_lifetime.png)\
_Total OCEAN released to DF — first 20 years_
## Example APYs
@ -47,12 +47,9 @@ 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.
![Example APYS](../.gitbook/assets/rewards/example_apys.png)
_Green: estimated APYs (passive + active). Black: estimated APYs (just passive). Yellow: estimated staking_
The plots are calculated from [this Google Sheet](https://docs.google.com/spreadsheets/d/1F4o7PbV45yW1aPWOJ2rwZEKkgJXbIk5Yq7tj8749drc/edit#gid=1051477754).
![Example APYS](../.gitbook/assets/rewards/example\_apys.png)\
_Green: estimated APYs (passive + active). Black: estimated APYs (just passive). Yellow: estimated staking_ The plots are calculated from [this Google Sheet](https://docs.google.com/spreadsheets/d/1F4o7PbV45yW1aPWOJ2rwZEKkgJXbIk5Yq7tj8749drc/edit#gid=1051477754).
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 youre 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 youre actively allocating veOCEAN allocation towards high-DCV data assets. For passive locking or low-DCV data assets, divide APY by 2 (approximate).

View File

@ -1,3 +1,7 @@
---
description: '****DRAFT include images in each of these steps'
---
# How to get veOCEAN
Step 1 

View File

@ -19,11 +19,29 @@ There are 4 things you can do with veOCEAN.
1. **Hold it** veOCEAN pays **Passive Rewards** every week.
2. **Allocate it** veOCEAN pays **Active Rewards** every week to the top performing Datasets, Algorithms, dApps, and more.
3. **Delegate 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 access Active Rewards.
4. **2x Stake** If you are a publisher, allocating veOCEAN to your own Dataset gives your veOCEAN a 2x Bonus. This is an incentive for publishers to engage with their assets and benefit from from the protocol further.
4. **2x Publisher Stake** If you are a publisher to the Ocean marketplace, allocating veOCEAN to your own Dataset gives your veOCEAN a 2x Bonus. This is an incentive for publishers to engage with their assets and benefit from from the protocol further.
## What is time locking?
## veOCEAN holders retain earnings from two sources: **Active & Passive Rewards**
Users can lock their OCEAN for different lengths of time to gain voting power. df.oceandao.org is designed to lock OCEAN for a minimum of 2 weeks and a maximum of four years for max benefit.
### Active Rewards from Community Fees
Every transaction in Ocean Market and Ocean backend generates transaction fees, some of which go to the community. 50% of the community fees will go to veOCEAN holders; the rest will go to Ocean community-oriented traction programs.
All earnings here are passive.
### Passive Rewards from Data Farming
veOCEAN holders will each get weekly DF rewards allocation, except a small carveout for any Data Challenge initiatives that may run through DF ops.
**veOCEAN holders can be passive, though they are incentivized with larger real yield if active participant.**
“Being active” means allocating veOCEAN to promising data assets (data NFTs). Then, rewards follow the usual DF formula: DCV \* stake. Stake is the amount of veOCEAN allocated to the data asset. There is no liquidity locked inside a datatoken pool. (And this stake is safe: you cant lose your OCEAN as it is merely locked.)
## Time Locking: What is it
Users can lock their OCEAN for different lengths of time to gain voting power. df.oceandao.org is designed to lock OCEAN for a minimum of 2 weeks and a maximum of four years for max benefit. VeToken-economics is simple: The longer user stakes, the more rewards users are eligible to earn.  
When users commit to locking their OCEAN tokens for an extended time duration, they are rewarded with an increased amount of veOCEAN tokens. This incentivizes users to have act with strong network support and confidence in the ecosystem.
@ -69,25 +87,11 @@ To maximize rewards, participants would need to update their 4-year lock every w
## veOCEAN Earnings
All earnings for veOCEAN holders are claimable in Ethereum mainnet. (Data assets for DF may published in any network where Oceans deployed in production: Eth mainnet, Polygon, etc.)
All earnings for veOCEAN holders are claimable in Ethereum mainnet. (Data assets for DFing may published in any network where Oceans deployed in production: ETH Mainnet, Polygon, etc.)
Theres a new DF round every week; in line with this, theres a new ve distribution “epoch” every week. This affects when you can first claim rewards. Specifically, if you lock OCEAN on day x, youll 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. Heres the code. )
Data Farming rounds occur weekly; in line with this, theres a new ve distribution “epoch” every week. This affects when you can first claim rewards. Specifically, if you lock OCEAN on day x, youll 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. Heres the code. )
veOCEAN holders have earnings from two sources:
### Active Earnings from Community Fees
Every transaction in Ocean Market and Ocean backend generates transaction fees, some of which go to the community. 50% of the community fees will go to veOCEAN holders; the rest will go to Ocean community-oriented traction programs.
All earnings here are passive.
### Passive Earnings from Data Farming
veOCEAN holders will each get weekly DF rewards allocation, except a small carveout for any Data Challenge initiatives that may run through DF ops.
**veOCEAN holders can be passive, though they are incentivized with larger real yield if active participant.**
“Being active” means allocating veOCEAN to promising data assets (data NFTs). Then, rewards follow the usual DF formula: DCV \* stake. Stake is the amount of veOCEAN allocated to the data asset. There is no liquidity locked inside a datatoken pool. (And this stake is safe: you cant lose your OCEAN as it is merely locked.)
## Flow of Value