first cut

This commit is contained in:
trentmc 2023-11-05 11:07:32 +01:00
parent 9c26ac7851
commit cc1e3f974b
25 changed files with 414 additions and 605 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 100 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.6 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.9 MiB

View File

@ -114,11 +114,13 @@
* [How to Earn](predictoor/pdr-earn.md)
* [Predictoor FAQ](predictoor/pdr-faq.md)
* [💰 Data Farming](data-farming/README.md)
* [OCEAN Rewards Schedule](data-farming/ocean-rewards-schedule.md)
* [veOCEAN & Passive DF](data-farming/veocean-passivedf.md)
* [Volume DF](data-farming/volumedf.md)
* [Challenge DF](data-farming/challengedf.md)
* [Predictoor DF](data-farming/predictoordf.md)
* [Claim Rewards](data-farming/user-guides/claim-rewards.md)
* [Emissions & APYs](data-farming/emissions-apys.md)
* [APYs](data-farming/apys.md)
* [FAQ](data-farming/faq.md)
* [🔨 Infrastructure](infrastructure/README.md)
* [Set Up a Server](infrastructure/setup-server.md)

View File

@ -6,90 +6,41 @@ coverY: 0
## What is Data Farming?
Data Farming is Ocean Protocol's core incentive program that rewards participants to onboard the protocol and create value by using tools that help grow it further.
Data Farming (DF) is Ocean's incentive program. It rewards OCEAN to participants who lock OCEAN and who help to drive data consume volume (DCV).
Data Farming participants earn OCEAN rewards across 2 main streams **Passive Rewards** and **Active Rewards**. Participants are able to **receive rewards passively, actively, or both** by engaging in a variety of activities.
DF is like DeFi liquidity mining, but tuned for DCV.
Passive Rewards provides a way for all contributors to participate.
## [START DATA FARMING HERE.](https://df.oceandao.org)
Active Rewards focuses on incentivizing the curation and publishing of high-quality data assets and DataNFTs within the Ocean Ecosystem.
### Reward Schedule
We have used battle-tested contracts that safeguard billions (veCRV). With this model there is no liquidity risk. You cant lose your OCEAN through Impermanent-Loss (IL). It is merely locked.
DF currently rewards 150K OCEAN per week. That will increase to over 1.1M OCEAN per week. Details are [here](ocean-reward-schedule.md)
## Introduction
### DF Streams
[Farming 101](df-intro.md) introduces Data Farming, the various 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 having a better idea of what subject you might want to learn about next.
DF's main streams are Passive DF and Active DF. The former allows for passive earning potential, and the latter requires more engagement. Each has 50% of the DF budget. Active DF has several sub-streams.
## User Guides
Here are the streams and substreams. The links lead to dedicated pages.
If you are looking for step-by-step tutorials on how to access the Data Farming program and complete different actions, head over to the [Data Farming User Guides page](user-guides/README.md).
1. **[Passive DF](veocean-passivedf.md).** 75K OCEAN per week. Lock OCEAN for veOCEAN; rewards are pro-rata to veOCEAN holdings.
1. **Active DF.** 75K OCEAN per week. It has these substreams:
1. **[Volume DF](volumedf.md).** Allocate veOCEAN towards data assets with high DCV, ie "curate data". Rewards are a function of DCV and veOCEAN stake.
1. **[Challenge DF](challengedf.md).** Predict future ETH price, one-time weekly. Rewards are a function of accuracy. Runs from DF48 — DF65.
1. **[Predictoor DF](predictoordf.md).** Run prediction bots to earn continuously. Starts on DF62.
## veOCEAN
Active DF's substreams can -- and do -- evolve 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) is used inside of Ocean Protocol to help advance the protocol.
All streams and substreams repeat on a **weekly** basis that start on Thursdays 00:00 at UTC and end on Wed at 23:59 UTC.
It may help for you to review the user guide on [how to estimate APY](user-guides/how-to-estimate-apy.md) to get a better idea for how long you'll want to lock your funds.
### Getting your $
### Passive Rewards
**Claiming.**. Learn how claim rewards [here](claim-rewards.md)
Passive Rewards is the first reward stream within Data Farming.
**[Emissions & APYs](emissions-apys.md)**. OCEAN emissions lead to rewards and therefore participant yields. Typical APYs are 520%, but may be as high as 45% and as low as 1%. APYs will vary week to week. APY depends on total OCEAN staked, duration of OCEAN lock, DCV, what DF streams you participate in, and other factors.
It's a fixed stream that focuses on incentivizing participants to easily onboard and help the protocol grow.
### Further resources
At a minimum, Data Farmers earn [Passive Rewards](df-intro.md#what-are-passive-rewards) for locking their OCEAN.
- The [DF FAQ](faq.md) answers more questions.
- The [Ocean Data Farming Series](https://blog.oceanprotocol.com/ocean-data-farming-series-c7922f1d0e45) blog has a chronological account of all Data Farming activities since its inception. It links to related blog posts.
- Main DF github repos: [df-py (backend)](https://github.com/oceanprotocol/df-py), [df-web (frontend)[https://github.com/oceanprotocol/df-web)
It is by-design, without the need for anyone to put in any significant effort. You simply need to lock your tokens for a period of time.
Passive Rewards offers a defined amount of rewards for each round that is divided amongst veOCEAN holders based on how much they hold.
Once your tokens are locked up, you can then learn [how to claim rewards](user-guides/how-to-claim-rewards.md).
### Active Rewards
Active Rewards is the second reward stream within Data Farming.
It's an evolving stream that focuses on driving fundamental traction and growth of the protocol.
For participants that are more engaged and want to increase their yield, the [Active Rewards](df-intro.md#what-are-active-rewards) stream is broken down into multiple substreams.
This offers contributors a variety of ways to help Ocean Protocol grow and increase your Data Farming rewards:
1. Volume DF
1. Challenge DF
#### Curate Data with Volume DF
If you have locked your OCEAN in exchange for veOCEAN, this is the ideal opportunity for you to utilize those veOCEAN to earn higher yield.
You can learn about [the design of Volume DF](df-volumedf.md) to learn about it's substreams. Here, curators earn rewards for curating datasets that are driving sales and helping Ocean Protocol achieve traction.
Once you're familiar with the concepts there, you can then read the following user guide on [how to participate in Volume DF](user-guides/how-to-volumedf.md).
## Delegate Curation
The [Delegation](df-volumedf.md#delegating-voting-power) docs will teach you about the concepts of delegating your veOCEAN allocation power to another wallet that will manage Volume DF for you.
You can then use the [how to delegate](user-guides/how-to-delegate.md) user guide to follow the steps needed to successfully delegate.
Please note, 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 Challenge DF
In this substream, Data Scientists can win competitions by participating in [Challenge DF](df-challengedf.md). You will obtain overview of what it is, how it works, the rules, and other details.
Challenge DF requires participants to submit predictions as close to the price of ETH as possible in order to be in the top 3 participants to win rewards.
The user guide on [how to Challenge DF](user-guides/how-to-challengedf.md) will take you step-by-step through the process of submitting your algorithm into the competition.
## Further Reading
Finally, if you want to continue expanding your knowledge on OCEAN 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.
[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.
The [FAQ](df-faq.md) answers many different questions about staking, chains, deployments, and other details that may be valuable to you.
## Reference
All content within has been assembled via reference of the [Ocean Data Farming Series](https://blog.oceanprotocol.com/ocean-data-farming-series-c7922f1d0e45), official [Ocean Protocol github repositories](https://github.com/oceanprotocol/), and [Whitepapers](https://oceanprotocol.com/tech-whitepaper.pdf).

66
data-farming/apys.md Normal file
View File

@ -0,0 +1,66 @@
---
description: >-
From emissions, estimate APYs
---
# APYs
**Contents:**
- [About APYs](#about-apys)
- [User Guide to Estimating APYs](#user-guide-to-estimating-apys)
# About APYs
Rewards are earned by users that hold and use their veOCEAN to help the protocol improve and grow.
To receive competitive short-term APYs, veOCEAN requires users to make long-term commitments.
Pre-requisite: to really know APYs, you should first understand OCEAN reward schedule. Learn more [here](ocean-reward-schedule.md).
## Estimated APY vs Time
Let's work through the examples and keep it as simple as possible.
The plot below shows estimated APY over time. Green includes both passive and active rewards; black is just passive rewards. As of DF29, wash consume is no longer profitable, so we should expect a large drop in DCV and therefore in active rewards. So passive rewards (black) provides a great baseline with upside in active rewards (green).
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.
<figure><img src="../.gitbook/assets/data-farming/example_apys.png" alt="" width="563"><figcaption><p><em>Green: estimated APYs (passive + active). Black: estimated APYs (just passive). Yellow: estimated staking</em> </p></figcaption></figure>
All 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).
----
<figure><img src="../../.gitbook/assets/gif/mafs.gif" alt=""><figcaption><p>K.I.S.S.</p></figcaption></figure>
# User Guide to Estimating APYs
### 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
The above are simplified examples meant for everyone to understand. They are naive investment strategies and are meant to provide you, the reader, with some examples to build upon. You can use these as a reference to create your own plan, so feel free to make a copy of this spreadsheet and customize it to your needs and wants.
### Estimating Active APY (from Volume DF)
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 a basic, naive calculations for Active Rewards such as adding a fixed-rate.
To help solve this challenge, [we built a dashboard](https://df.oceandao.org/volume-df) that shows historical and ongoing summaries of APY, Data Consume Volume, and veOCEAN allocations per-round.
<figure><img src="../../.gitbook/assets/data-farming/curate-datasets.png" alt=""><figcaption><p>Curate like a Pro.</p></figcaption></figure>
You can also [learn how rewards are calculated](../df-volumedf.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 the APYs on the UI are calculated.

View File

@ -3,22 +3,29 @@ description: >-
Be the champ 🏆
---
# Win Competitions in Challenge DF
# Challenge Data Farming
<figure><img src="../.gitbook/assets/gif/underwater-you-want-some-of-this.gif" alt=""><figcaption><p>It's a competition. Let's gooo!</p></figcaption></figure>
**Contents:**
- [About Challenge DF](#about-challenge-df)
- [User Guide to Chellenge DF](#user-guide-to-challenge-df)
## About Challenge DF
Challenge DF rewards data scientists for making predictions for future ETH price. It's a weekly challenge.
## Publish prediction models and earn rewards
If you're eager to consume data and create valuable assets for publishing but unsure of where to begin, fear not! We've got you covered.
Data Farming offers rewards to data scientists who participate in weekly challenges. We provide the rules and rewards, allowing you to focus on delivering high-quality results.
**Prizes:**
- 1st Place - 2500 OCEAN
- 2nd Place - 1500 OCEAN
- 3rd Place - 1000 OCEAN
_Total - 5000 OCEAN_
Prize Pool: 1,000 OCEAN (as of Nov 2, 2022)
- 1st Place - 500 OCEAN
- 2nd Place - 300 OCEAN
- 3rd Place - 200 OCEAN
### What are the base rules?
@ -50,3 +57,61 @@ You can find a direct link to the [Challenge DF README](https://github.com/ocean
### Good lock and happy coding!
<figure><img src="../.gitbook/assets/data-farming/gif/winner.gif" alt=""><figcaption></figcaption></figure>
----
# User Guide to Challenge DF
<figure><img src="../../.gitbook/assets/gif/underwater-you-want-some-of-this.gif" alt=""></figure>
## Predict to earn
If you're eager to begin extracting value from data but aren't sure how to get started, then [Challenge DF is here to help](../df-challengedf.md)!
By participating in the weekly data challenges of predicting the price of Ethereum, you will become familiar with the Ocean Protocol stack and with building predictions that can be sold for money.
These are the steps to get involved:
#### Step 1 - Navigate to the Data Farming dApp
Go to [Data Farming dApp](https://df.oceandao.org)
#### Step 2 - Go to the "Challenges" page
After the dApp loads, look for the menu and click on "Challenges"
<figure><img src="../../.gitbook/assets/data-farming/challenge-page.png" alt=""><figcaption><p>Find "Challenges" in the menu and click on it</p></figcaption></figure>
#### Step 3 - Click on "Participate"
After clicking on "Participate" you will be [linked to the Challenge DF README](https://github.com/oceanprotocol/predict-eth/blob/main/challenges/challenge-df.md) that outlines all details about the challenge.
<figure><img src="../../.gitbook/assets/data-farming/challenge-active.png" alt=""><figcaption><p>Click the Participate button</p></figcaption></figure>
#### Step 4 - Use README to publish your predictions
You can see the ongoing challenge right away together with some key informations such as submission deadline and available rewards.
Follow the README steps to publish your model and compete in the challenge.
<figure><img src="../../.gitbook/assets/data-farming/challenge-df-readme.png" alt=""><figcaption><p>How to submit Challenge DF</p></figcaption></figure>
#### Step 5 - Check weekly results
Challenge DF weekly results become available at the end of every Data Farming round and can be viewed in the Challenges page.
The top 3 competitors win prizes and are visible in the leaderboard.
<figure><img src="../../.gitbook/assets/data-farming/challenge-history.png" alt=""><figcaption><p>Past Challenges leaderboard</p></figcaption></figure>
#### Step 6 - View and claim Active Rewards.
To view and claim your rewards:
1. Make sure your wallet is connected.
2. Your Challenge DF substream rewards will be displayed to the left besides "rewards". As you can see, it will be added to other active rewards that can be claimed besides "total rewards".
3. To claim all Active Rewards including your Challenge DF rewards, simply click on the "Claim Rewards" button.
<figure><img src="../../.gitbook/assets/data-farming/challenge-substream.png" alt=""><figcaption><p>Click the Claim Rewards button</p></figcaption></figure>

View File

@ -2,13 +2,13 @@
description: Unbox your OCEAN rewards
---
# Claim Rewards Data Farming
# Claim Rewards in DF
<figure><img src="../../.gitbook/assets/gif/underwater-treasure.gif" alt=""><figcaption></figcaption></figure>
Ocean Protocol's Data Farming dapp dispenses rewards **every Thursday** to its participants. 💰 To claim your OCEAN rewards for data farming, simply navigate to the Data Farming [Rewards page](https://df.oceandao.org/rewards) and click the Claim OCEAN rewards buttons that will appear pink and clickable each Thursday. Yeehaw!
To claim OCEAN rewards, go to [DF Rewards page](https://df.oceandao.org/rewards) and click the "Claim OCEAN rewards" buttons.
You can visit this dApp to [begin Data Farming](https://df.oceandao.org)? Or [follow this user guide](how-to-veocean.md) to get started. 🤠
A detailed guide is below.
### Step 1 - Navigate to the Data Farming Rewards page
@ -24,10 +24,10 @@ This is where you click to claim your rewards! Easy peasy. You will need to appr
<figure><img src="../../.gitbook/assets/data-farming/claim-rewards.png" alt=""><figcaption><p>Click the pink Claim # Ocean buttons</p></figcaption></figure>
### FIRST TIME CLAIMING?
### First time claiming?
You will need to wait at least one week, but not more than two weeks to claim your rewards for the first time. Check back on Thursday!
### FORGOT TO CLAIM?
### Forgot to claim?
If you forget to claim your OCEAN rewards, then do not worry because they continue to accumulate! You can claim them anytime after Thursday. 😃
If you forget to claim your OCEAN rewards, then do not worry because they continue to accumulate! It's all fine. You can claim them anytime after Thursday. 😃

View File

@ -1,114 +0,0 @@
---
description: Learn how to earn passively, and with active work 🧑‍🏫
---
# Data Farming 101
<figure><img src="../.gitbook/assets/gif/school-of-fish.gif" alt=""><figcaption><p>School (of fish) time.</p></figcaption></figure>
## Weekly Rounds
All streams and substreams repeat on a weekly basis that start on Thursdays 00:00 at UTC and end on Wed at 23:59 UTC.
### Passive and Active Reward streams
OCEAN rewards are paid out at the end of each week to Data Farmers through two different reward streams. **Passive Rewards** and **Active Rewards**.
These two reward streams produce different variable APYs.
Rewards are paid out at the end of each round.
#### Splitting the Pie
Each Data Farming 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 |
| --------------- | -------------- |
| 50% | 50% |
<figure><img src="../.gitbook/assets/data-farming/df-reward-streams.png" alt=""><figcaption><p>Rewards Page overview for each stream.</p></figcaption></figure>
### What are Passive Rewards?
Passive rewards are the OCEAN rewards paid to Data Farmers just for locking their OCEAN.
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 prediction challenges.
<figure><img src="../.gitbook/assets/gif/passive-income.gif" alt=""><figcaption></figcaption></figure>
[To start getting passive rewards, go here.](user-guides/how-to-veocean.md)
### What are Active Rewards?
Active Rewards is an evolving program that focuses on providing incentives to key areas of the protocol that support traction and growth.
Rewards are paid in OCEAN to contributors actively working to improve Ocean Protocol.
**Active Rewards** is then composed of two sub-streams:
1. 5,000 OCEAN is paid out to Challenge DF.
2. 70,000 OCEAN is paid out to Volume DF.
| Challenge DF | Volume DF |
| --------------- | -------------- |
| 5,000 OCEAN | 70,000 OCEAN |
**November 9** will then change when Predictoor DF is launched:
1. 1,000 OCEAN is paid out to Challenge DF.
2. 37,000 OCEAN is paid out to Volume DF.
3. 37,000 OCEAN is paid out to PredictoorDF.
| Challenge DF | Volume DF | Predictoor DF |
| --------------- | -------------- | -------------- |
| 1,000 OCEAN | 37,000 OCEAN | 37,000 OCEAN
### What is Volume DF
[Volume DF](df-volumedf.md#curate-data-in-volume-df) rewards Data Farmers that allocate their veOCEAN to Ocean datasets. It's called Volume DF 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 Volume DF](user-guides/how-to-volumedf.md).
Volume DF rewards are governed and defined by the [Reward Function](df-intro.md#reward-schedule).
#### Estimating APY
To 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/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/how-to-volumedf.md#) here.
### What is Challenge DF
Challenge DF rewards Data Scientists that produce prediction models that consistently improve the prediction of the price of Ethereum. It's called Challenge DF 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, **Challenge DF 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 Challenge DF](user-guides/how-to-challengedf.md).
### What is Predictoor DF
Predictoor DF rewards Data Scientists (as a predictoor) that submit continuous predictions for future price movements of different assets. It's called Predictoor DF because weekly rewards are dispensed towards predictoors that are competing to accurately predict asset prices. Therefore **Predictoor DF yields depend on participants being accurate and outcompeting each other**.
### What's the difference between Data Farming and Yield Farming?
If you are familiar with 'liquidity mining' then you will find Data Farming similar, but instead, tuned for the curation of high quality assets in the Ocean ecosystem.
Unlike yield farming in DeFi, data farming has real intrinsic utility for Ocean Protocol stakeholders as Data Farmers determine which are the highest quality assets in the Ocean ecosystem to purchase, and as these assets sell, they are rewarded in OCEAN . It's this **curation of the "best" assets in the Ocean ecosystem** that shortens the search times for those looking to shop for assets in the Ocean ecosystem.
To deepen this incentive, Publishers are boosted further and **gain 2x the allocation power** when pointing to their own assets.
## 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/data-farming/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>
## [GET STARTED DATA FARMING HERE.](https://df.oceandao.org)
### Unsure how? These [guides](../user-guides/README.md) will show you how to do the basics.

View File

@ -1,84 +0,0 @@
---
description: >-
Know reward emissions, to know daily yields, multiply for annual yields
---
# Emissions & APYs
<figure><img src="../.gitbook/assets/gif/many-penguins.gif" alt=""><figcaption><p>Multiply, and multiply again. And again.</p></figcaption></figure>
## Understand emissions to know APYs
To really know APYs, you should understand emissions and how they play a role in the funds disributed inside Ocean Protocol.
If you are looking to get an overview of APYs, please read the [basics of estimating APY](df-intro.md#estimating-apy) first.
If you want to see some examples of how to calculate it, you can find out more in the [Estimate APY user guides](user-guides/how-to-estimate-apy.md).
### Why veOCEAN is important to OceanDAO
veOCEAN enables OceanDAO to be more user-focused, community-driven, and futuristic revenue-sharing like CurveDAO:
* ve (vote escrowed) is at the heart with v = voting (in asset curation) and e = escrowed (locked) OCEAN. The longer that Data Farmers lockup their OCEAN, the more voting and rewards, which reconciles near and long-term DAO incentives.
* OceanDAO has an increased bias to automation and to minimizing the governance attack (hack) surface via veOCEAN.
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)
* 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.
Lets visualize!
## Emissions — first 5 years.
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).
<figure><img src="../.gitbook/assets/data-farming/emissions_first_5years.png" alt="" width="540"><figcaption><p><em>OCEAN released to DF per week — first 5 years</em></p></figcaption></figure>
## 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.
<figure><img src="../.gitbook/assets/data-farming/emissions_first_20years.png" alt="" width="563"><figcaption><p><em>OCEAN released to DF per week — first 20 years</em></p></figcaption></figure>
## 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.
<figure><img src="../.gitbook/assets/data-farming/emissions_lifetime.png" alt="" width="563"><figcaption><p><em>Total OCEAN released to DF — first 20 years</em></p></figcaption></figure>
## Example APYs
The plot below shows estimated APY over time. Green includes both passive and active rewards; black is just passive rewards. As of DF29, wash consume is no longer profitable, so we should expect a large drop in DCV and therefore in active rewards. So passive rewards (black) provides a great baseline with upside in active rewards (green).
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.
<figure><img src="../.gitbook/assets/data-farming/example_apys.png" alt="" width="563"><figcaption><p><em>Green: estimated APYs (passive + active). Black: estimated APYs (just passive). Yellow: estimated staking</em> </p></figcaption></figure>
All 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).
## 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).

View File

@ -0,0 +1,73 @@
---
description: >-
Know the OCEAN reward schedule, towards understanding yields
---
# OCEAN Reward Schedule
<figure><img src="../.gitbook/assets/gif/many-penguins.gif" alt=""><figcaption><p>Multiply, and multiply again. And again.</p></figcaption></figure>
## OCEAN Reward Schedule
## 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/data-farming/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>
### DF Phases
DF proceeds one round at a time. Each round is weekly. Rounds are grouped into four phases: DF Alpha, DF/VE Alpha, DF Beta, and DF Main. We are now in the "DF Main" phase. Here are details including OCEAN emissions per 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.
## Emissions schedule
The emissions schedule determines the weekly OCEAN budget for Data Farming.
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)
* 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.
Lets visualize!
## Emissions — first 5 years
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).
<figure><img src="../.gitbook/assets/data-farming/emissions_first_5years.png" alt="" width="540"><figcaption><p><em>OCEAN released to DF per week — first 5 years</em></p></figcaption></figure>
## 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.
<figure><img src="../.gitbook/assets/data-farming/emissions_first_20years.png" alt="" width="563"><figcaption><p><em>OCEAN released to DF per week — first 20 years</em></p></figcaption></figure>
## 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.
<figure><img src="../.gitbook/assets/data-farming/emissions_lifetime.png" alt="" width="563"><figcaption><p><em>Total OCEAN released to DF — first 20 years</em></p></figcaption></figure>

View File

@ -0,0 +1,11 @@
---
description: >-
Run prediction bots to earn continuously.
---
# Predictoor Data Farming
In Predictoor DF, you run prediction bots to earn continuously. Starts on DF62.
(Note: this doc will get fleshed out soon.)

View File

@ -1,53 +0,0 @@
---
description: Learn the ins-and-outs Data Farming
---
# Data Farming Guides
<figure><img src="../../.gitbook/assets/gif/school-of-fish2.gif" alt=""><figcaption>Back to school (of fish)</figcaption></figure>
Data Farming is the core incentive system inside of Ocean Protocol. It offers different ways for participants to help the protocol grow and succeed.
It's broken down into 2 reward streams:
1. Passive Rewards
2. Active Rewards
As the name suggests, users need to do very little to earn Passive Rewards and the program is aimed to onboard as many people as possible to help drive liquidity and conviction into the protocol.
Active Rewards is an evolving incentive program that offers different venues for contributors to complete active work that drives the protocol forward.
Anyone is welcomed to participate.
## Passive Rewards stream
The primary objective of the [Passive Rewards](../df-intro.md#what-are-passive-rewards) stream is to provide an accessible way for anyone to use OCEAN and help the protocol grow.
In [the veOCEAN user guide](how-to-veocean.md), you'll learn more about the Passive Rewards stream and how to get veOCEAN.
## Active Rewards stream & Substreams
The primary objective of [Active Rewards](../df-intro.md#what-are-active-rewards) and substreams is to provide participants that engage with Data Farming different opportunities to create value. This approach allows users with different skills and interests to collaborate and contribute their unique abilities towards achieving the core values of Ocean Protocol.
Let's review the Active Reward substreams and get you started.
### Volume DF Substream
The bread and butter of the Data Farming incentive program is [Volume DF](../df-volumedf.md). Here publishers and curators that help maintain quality assets in the Ocean ecosystem are rewarded.
You can receive OCEAN rewards by allocating veOCEAN voting power to high-quality datasets and assisting Ocean with the curation of Data assets. Through this allocation, you will also receive a portion of the revenue generated by the dataset consumption.
Allocation power can also be increased via delegation. The Data Farming dApp [Delegate Page](https://df.oceandao.org/delegate) lets you easily manage delegations.
For more information on how to get started and detailed instructions, please refer to the [Volume DF user guide](how-to-volumedf.md) section.
### Challenge DF Substream
If you are a data scientist and enjoy tackling challenging problems, this is the perfect place for you. [Challenge DF](../df-challengedf.md) provides a competition where you can test your skills in predicting the price of Ethereum. Earn a place on the podium to receive a reward.
This opportunity allows you to explore the capabilities offered by Ocean Protocol to build algorithms, publish data assets, and to gain valuable exposure. As your models and skills improve, you can begin monetizing your work.
For detailed instructions and information on how to get started, please refer to the [Challenge DF user guide](how-to-challengedf.md).
### Not much of a reader? Watch and learn, friend
{% embed url="https://youtu.be/zAQlPHkK3og" %}

View File

@ -1,60 +0,0 @@
---
description: Be competive, make great predictions, earn $
---
# Guide: Challenge DF
<figure><img src="../../.gitbook/assets/gif/underwater-you-want-some-of-this.gif" alt=""></figure>
## Predict to earn
If you're eager to begin extracting value from data but aren't sure how to get started, then [Challenge DF is here to help](../df-challengedf.md)!
By participating in the weekly data challenges of predicting the price of Ethereum, you will become familiar with the Ocean Protocol stack and with building predictions that can be sold for money.
These are the steps to get involved:
#### Step 1 - Navigate to the Data Farming dApp
Go to [Data Farming dApp](https://df.oceandao.org)
#### Step 2 - Go to the "Challenges" page
After the dApp loads, look for the menu and click on "Challenges"
<figure><img src="../../.gitbook/assets/data-farming/challenge-page.png" alt=""><figcaption><p>Find "Challenges" in the menu and click on it</p></figcaption></figure>
#### Step 3 - Click on "Participate"
After clicking on "Participate" you will be [linked to the Challenge DF README](https://github.com/oceanprotocol/predict-eth/blob/main/challenges/challenge-df.md) that outlines all details about the challenge.
<figure><img src="../../.gitbook/assets/data-farming/challenge-active.png" alt=""><figcaption><p>Click the Participate button</p></figcaption></figure>
#### Step 4 - Use README to publish your predictions
You can see the ongoing challenge right away together with some key informations such as submission deadline and available rewards.
Follow the README steps to publish your model and compete in the challenge.
<figure><img src="../../.gitbook/assets/data-farming/challenge-df-readme.png" alt=""><figcaption><p>How to submit Challenge DF</p></figcaption></figure>
#### Step 5 - Check weekly results
Challenge DF weekly results become available at the end of every Data Farming round and can be viewed in the Challenges page.
The top 3 competitors win prizes and are visible in the leaderboard.
<figure><img src="../../.gitbook/assets/data-farming/challenge-history.png" alt=""><figcaption><p>Past Challenges leaderboard</p></figcaption></figure>
#### Step 6 - View and claim Active Rewards.
To view and claim your rewards:
1. Make sure your wallet is connected.
2. Your Challenge DF substream rewards will be displayed to the left besides "rewards". As you can see, it will be added to other active rewards that can be claimed besides "total rewards".
3. To claim all Active Rewards including your Challenge DF rewards, simply click on the "Claim Rewards" button.
<figure><img src="../../.gitbook/assets/data-farming/challenge-substream.png" alt=""><figcaption><p>Click the Claim Rewards button</p></figcaption></figure>

View File

@ -1,45 +0,0 @@
---
description: Give another wallet power to allocate veOCEAN
---
# Guide: Volume DF Delegation
<figure><img src="../../.gitbook/assets/gif/underwater-buddy-peewee.gif" alt=""><figcaption></figcaption></figure>
## Why Delegate?
Delegation is a tool for Volume DF.
Consider these challenges:
- Your veOCEAN is on a hardware wallet and you want a "hot" software wallet to auto-delegate based on data consume volume, to increase APY
- You have >1 wallets and it's a pain to switch among them for delegating
[Delegation](https://df.oceandao.org/delegate) solves that. "To delegate" means "to transfer veOCEAN Allocation Power to another wallet address" for a limited period.
When you delegate, you delegate 100% of your veOCEAN Allocation power.
{% hint style="info" %}
If you delegate 100% of your Allocation Power, your allocations will not count 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.
{% endhint %}
### Steps to Delegate
Follow these steps to delegate your veOCEAN:
1. Go to the [Data Farming dApp](https://df.oceandao.org).
2. Navigate to the [Delegate page](https://df.oceandao.org/delegate).
3. In the 'Receiver wallet address' field, enter the wallet address you wish to delegate to
4. Click the 'Delegate' button, and sign the transaction with your wallet.
5. (Optional) Cancel the delegation to regain your allocation power before the delegation expires.
### What if someone delegates to you?
If you receive veOCEAN allocation power from other wallets, then you will receive their active rewards.
You _cannot_ re-delegate this veOCEAN further downstream.&#x20;
<figure><img src="../../.gitbook/assets/data-farming/veOCEAN-Delegation.png" alt=""><figcaption></figcaption></figure>

View File

@ -1,41 +0,0 @@
---
description: >-
Learn how to use basic math and a simple spreadsheet to estimate your
Passive Rewards APY and get deeper into Active Rewards APY.
---
<figure><img src="../../.gitbook/assets/gif/mafs.gif" alt=""><figcaption><p>K.I.S.S.</p></figcaption></figure>
# veOCEAN and your APY
Rewards are earned by users that hold and use their veOCEAN to help the protocol improve and grow.
To receive competitve short-term APYs, veOCEAN requires users to make long-term commitments.
First, make sure that you [understand the basics of APY](../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.
### 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
The above are simplified examples meant for everyone to understand. They are naive investment strategies and are meant to provide you, the reader, with some examples to build upon. You can use these as a reference to create your own plan, so feel free to make a copy of this spreadsheet and customize it to your needs and wants.
### Estimating Active APY
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 a basic, naive calculations for Active Rewards such as adding a fixed-rate.
To help solve this challenge, [we built a dashboard](https://df.oceandao.org/volume-df) that shows historical and ongoing summaries of APY, Data Consume Volume, and veOCEAN allocations per-round.
<figure><img src="../../.gitbook/assets/data-farming/curate-datasets.png" alt=""><figcaption><p>Curate like a Pro.</p></figcaption></figure>
You can also [learn how rewards are calculated](../df-volumedf.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 the APYs on the UI are calculated.

View File

@ -1,50 +0,0 @@
---
description: Get veOCEAN to use the Data Farming dApp and make yield! 🧑‍🌾🥕
---
<figure><img src="../../.gitbook/assets/gif/aquaman-gold.gif" alt="" width="250"><figcaption><p>Get your gold. Get your veOCEAN.</p></figcaption></figure>
# What is veOCEAN and Passive Rewards
In order to **gain yield Data Farming**, you will need to lock your OCEAN first! When you lock your OCEAN, you get **veOCEAN** 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 to your favorite assets and get a portion of their sales!
### Don't have OCEAN yet? Get those first!
#### Step 1 - Get OCEAN
- Acquire OCEAN via a decentralized exchange (DEX) such as Uniswap or a centralized exchange (CEX) such as Binance, Coinbase, etc.
#### Step 2 - Send to your self-custody wallet
- Send your OCEAN to a self-custody wallet of yours that supports ERC-20 tokens, like Metamask for example.
### Where the rubber meets the road 🚗💨
Not much of a reader? Watch and learn, friend
{% embed url="https://www.youtube.com/watch?v=zAQlPHkK3og" fullWidth="false" %}
Watch and learn, friend
{% endembed %}
#### Step 3 - Go to Ocean Protocol's Data Farming dApp
- Go to [https://df.oceandao.org/](https://df.oceandao.org/)
#### Step 4 - Connect Your Wallet + Lock your OCEAN for veOCEAN
- Click on the purple circles in the interactive demo to walk through the steps for locking your OCEAN for veOCEAN.
{% embed url="https://app.arcade.software/share/FUSkygksSRsJHwle1zFs" fullWidth="false" %}
{% endembed %}
In this step you will:
- Enter the amount of OCEAN that you are going to lock up
- Select a Lock End Date indicating how many weeks youre going to lock up your OCEAN. (As the Lock End Date goes farther into the future, your Lock Multiplier increases).
- Click on the checkbox to agree to the disclaimer.
- Click the pink “Approve # OCEAN” button
- Accept the transaction in your wallet.
- Click the “Create Lock” button.
- Accept the transaction in your wallet.
Congratulations! You have now locked your OCEAN for veOCEAN and are generating passive yield automatically. You can [claim your passive OCEAN rewards](how-to-claim-rewards.md) every Thursday - note that your first time claiming rewards will require at least one week, but not more than 2 weeks of wait!

View File

@ -1,42 +0,0 @@
---
description: Curate datasets in Data Farming and earn
---
# Guide: Volume Data Farming
<figure><img src="../../.gitbook/assets/gif/avatar-pick-whale.gif" alt=""><figcaption>Pick your whale</figcaption></figure>
## Curate to earn
In Volume DF, you allocate veOCEAN to data assets with high data consume volume (DCV). You do this via the DF dApp.
We'll show you how!
#### Step 1 - Navigate to the DF dApp
- Go to [https://df.oceandao.org](https://df.oceandao.org)
#### Step 2 - Connect your wallet
- Connect your wallet to the dApp, on Ethereum mainnet
#### Step 3 - Click the Volume DF tab in the top menu
<figure><img src="../../.gitbook/assets/data-farming/volumeDF-page.png" alt=""><figcaption><p>Click the Volume DF page link in the menu</p></figcaption></figure>
#### Step 4 - Select the assets which you would like to allocate to by toggling the percentage allocation at the end of the row
- On the rightmost column, toggle the percentage of your total Allocation Power that you wish to allocate to each asset of your choice. You will **get a portion of the sales** of each asset that you allocate to!
- Note that if you allocate to an asset that YOU published, then you will get an **effective 2x allocation boost**.
- If you are a publisher and curating your own asset, your asset may be styled differently in the UI.
<figure><img src="../../.gitbook/assets/data-farming/allocations.png" alt=""><figcaption><p>Toggle the percentage of your veOCEAN that you would like to allocate to each asset</p></figcaption></figure>
#### Step 5 - Click the Update Allocations button
- Click the pink Update Allocations button
- Sign the transactions with your wallet & pay the gas fees
<figure><img src="../../.gitbook/assets/data-farming/update-allocations.png" alt=""><figcaption><p>Click the Update Allocations button</p></figcaption></figure>
That's it! You've successfully allocated (aka "voted on") your favorite assets in the Ocean ecosystem using your veOCEAN and are generating active rewards yield. Now, just wait until next Thursday to see if you can [claim any OCEAN rewards](how-to-claim-rewards.md) on the Active Rewards section of the [Rewards page](https://df.oceandao.org/rewards) for your portion of the assets' sales. Remember that your first time claiming rewards will require at least one week, but not more than 2 weeks of wait!

View File

@ -3,30 +3,20 @@ description: >-
Earn passively by locking veOCEAN for OCEAN
---
# Passive Farming with veOCEAN
# veOCEAN and Passive Data Farming
<figure><img src="../.gitbook/assets/gif/aquaman-fade.gif" alt=""><figcaption><p>I've got veOCEAN, my work is done.</p></figcaption></figure>
### What does the "ve" in veOCEAN stand for?
**Contents:**
"ve" stands for <mark style="color:orange;">**vote escrowed**</mark>. And the "vote" part of "ve" and veOCEAN is what you really need to pay attention to in order to truly understand the function of this token.
- [About veOCEAN and Passive DF](#about-veocean-and-passive-df)
- [User Guide to veOCEAN and Passive DF](#user-guide-to-veocean-and-passive-df)
You see, when you acquire veOCEAN via locking your OCEAN in the Data Farming dApp, the intended use is to **vote on your favorite assets** in the Ocean ecosystem!
# About veOCEAN and Passive DF
When you allocate to assets that sell, then **you get a portion of the sales**!
Here, Data Farmers earn OCEAN rewards by locking their OCEAN for veOCEAN for a period of time. That's it! It's low effort, ie passive.
You can do this all from the Data Farming dApp [Farms page](https://df.oceandao.org/volume-df).
### The Superpowers of veOCEAN
veOCEAN allows you to engage with different Ocean Protocol mechanisms and benefit from the reward programs available.
4 key utility functionalities of veOCEAN:
1. **Holding it** veOCEAN pays **Passive OCEAN Rewards** every week.
2. **Allocating it** veOCEAN pays **Active OCEAN Rewards** every week to the top selling assets in the Ocean ecosystem.
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 amount of rewards you get is pro-rata to the amount of veOCEAN you hold, cmopared to other veOCEAN holders.
### veOCEAN Time Locking
@ -66,7 +56,7 @@ 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.
The veOCEAN code is a fork of Curve's battle tested [veCRV](https://curve.readthedocs.io/dao-vecrv.html) token code.
veOCEAN code is a fork of Curve's battle-tested [veCRV](https://curve.readthedocs.io/dao-vecrv.html) contracts that safeguard billions (veCRV). With this model there is no liquidity risk. You cant lose your OCEAN through Impermanent Loss (IL). It is merely locked.
# veOCEAN and your APY
@ -120,10 +110,59 @@ The "veTokenomics" model of veOCEAN (vote-escrowed token economics) is inspired
[Here is Ocean Protocol's open-source code](https://github.com/oceanprotocol/contracts/blob/main/contracts/ve/veFeeDistributor.vy#L240-L256) for veOCEAN, and if you're a developer, then you'll notice the strong similarities to [veCRV's](https://curve.readthedocs.io/dao-fees.html) code.
### veOCEAN's Smart Contracts Security
### veOCEAN Smart Contracts Security
[veOCEAN core contracts](https://github.com/oceanprotocol/contracts/tree/main/contracts/ve) use [veCRV contracts](https://curve.readthedocs.io/dao-vecrv.html) with zero changes, on purpose: the veCRV contracts have been battle-tested since inception and have not had security issues. Nearly 500 million USD is locked across all forks of veCRV, with the leading DeFi protocols adopting this standard. veCRV contracts [have been audited by Trail of Bits and Quantstamp](https://github.com/curvefi/curve-dao-contracts#audits-and-security).
We have built [a new contract](https://github.com/oceanprotocol/contracts/blob/main/contracts/ve/veAllocate.sol) for users to point their veOCEAN towards given data assets (“allocate veOCEAN”). These new contracts do not control the veOCEAN core contracts at all. In the event of a breach, the only funds at risk would be the rewards distributed for a single week; and we would be able to redirect future funds to a different contract.
We have an [ongoing bug bounty via Immunefi](https://immunefi.com/bounty/oceanprotocol/) for Ocean software, including veOCEAN and DF components. If you identify an issue, please report it there and get rewarded.
----
# User Guide to veOCEAN and Passive DF
<figure><img src="../../.gitbook/assets/gif/aquaman-gold.gif" alt="" width="250"><figcaption><p>Get your gold. Get your veOCEAN.</p></figcaption></figure>
In order to **get yield in DF**, you will need to lock your OCEAN first! When you lock your OCEAN, you get **veOCEAN** 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 to your favorite assets and get a portion of their sales!
### Don't have OCEAN yet? Get those first!
#### Step 1 - Get OCEAN
- Acquire OCEAN via a decentralized exchange (DEX) such as Uniswap or a centralized exchange (CEX) such as Binance, Coinbase, etc.
#### Step 2 - Send to your self-custody wallet
- Send your OCEAN to a self-custody wallet of yours that supports ERC-20 tokens, like Metamask for example.
### Where the rubber meets the road 🚗💨
Not much of a reader? Watch and learn, friend
{% embed url="https://www.youtube.com/watch?v=zAQlPHkK3og" fullWidth="false" %}
Watch and learn, friend
{% endembed %}
#### Step 3 - Go to Ocean Protocol's Data Farming dApp
- Go to [https://df.oceandao.org/](https://df.oceandao.org/)
#### Step 4 - Connect Your Wallet + Lock your OCEAN for veOCEAN
- Click on the purple circles in the interactive demo to walk through the steps for locking your OCEAN for veOCEAN.
{% embed url="https://app.arcade.software/share/FUSkygksSRsJHwle1zFs" fullWidth="false" %}
{% endembed %}
In this step you will:
- Enter the amount of OCEAN that you are going to lock up
- Select a Lock End Date indicating how many weeks youre going to lock up your OCEAN. (As the Lock End Date goes farther into the future, your Lock Multiplier increases).
- Click on the checkbox to agree to the disclaimer.
- Click the pink “Approve # OCEAN” button
- Accept the transaction in your wallet.
- Click the “Create Lock” button.
- Accept the transaction in your wallet.
Congratulations! You have now locked your OCEAN for veOCEAN and are generating passive yield automatically. You can [claim your passive OCEAN rewards](how-to-claim-rewards.md) every Thursday - note that your first time claiming rewards will require at least one week, but not more than 2 weeks of wait!

View File

@ -3,19 +3,25 @@ description: >-
Choose your fav data assets, earn more
---
# Curate with Volume DF
# Volume Data Farming
<figure><img src="../.gitbook/assets/gif/avatar-plugin.gif" alt=""><figcaption><p>Make your selection and commit. Good things will come.</p></figcaption></figure>
## What is Volume DF
**Contents:**
Passive Data Farming is a great start to earn from your locked OCEAN (veOCEAN).
- [About Volume DF](#about-volume-df)
- [User Guide to Volume DF](#user-guide-to-volume-df)
- [User Guide to Delegation](#user-guide-to-delegation)
Volume DF lets you can earn more yet, with that same veOCEAN. In Volume DF, you allocate veOCEAN to data assets with high data consume volume (DCV).
# About Volume DF
### User Guide
We've already covered [Passive DF](passivedf.md), which is a great start to earn from your locked OCEAN (veOCEAN).
The [Volume DF User Guide](./user-guides/how-to-volumedf.md) tells how to use the Data Farming dApp to allocate veOCEAN.
_Volume_ DF lets you can earn more yet, with that same veOCEAN.
In Volume DF, you allocate veOCEAN to data assets with high data consume volume (DCV). This acts as _data curation_.
You can delegate your veOCEAN to other wallets. This is helpful when you want a bot to automatically update your veOCEAN allocations (from a "hot" wallet) while keeping your locked OCEAN secure in a hardware wallet. There are other use cases too. There's more info [below](#user-guide-to-delegation).
### How to Maximize Volume DF rewards
@ -68,3 +74,88 @@ The Reward Function (RF) governs how active rewards are allocated to Data Farmer
The actual code is in [calcrewards.py](https://github.com/oceanprotocol/df-py/blob/main/df_py/volume/calc_rewards.py) in df-py repo.
When DF restarts each Thursday, the global allocation towards each asset resets back to zero and then starts counting up again until the end of the round. After allocating your veOCEAN to different datasets, it will take time for your voting power to be accounted for.
----
# User Guide to Volume DF
<figure><img src="../../.gitbook/assets/gif/avatar-pick-whale.gif" alt=""><figcaption>Pick your whale</figcaption></figure>
In Volume DF, you allocate veOCEAN to data assets with high data consume volume (DCV). You do this via the DF dApp.
We'll show you how!
#### Step 1 - Navigate to the DF dApp
- Go to [https://df.oceandao.org](https://df.oceandao.org)
#### Step 2 - Connect your wallet
- Connect your wallet to the dApp, on Ethereum mainnet
#### Step 3 - Click the Volume DF tab in the top menu
<figure><img src="../../.gitbook/assets/data-farming/volumeDF-page.png" alt=""><figcaption><p>Click the Volume DF page link in the menu</p></figcaption></figure>
#### Step 4 - Select the assets which you would like to allocate to by toggling the percentage allocation at the end of the row
- On the rightmost column, toggle the percentage of your total Allocation Power that you wish to allocate to each asset of your choice. You will **get a portion of the sales** of each asset that you allocate to!
- Note that if you allocate to an asset that YOU published, then you will get an **effective 2x allocation boost**.
- If you are a publisher and curating your own asset, your asset may be styled differently in the UI.
<figure><img src="../../.gitbook/assets/data-farming/allocations.png" alt=""><figcaption><p>Toggle the percentage of your veOCEAN that you would like to allocate to each asset</p></figcaption></figure>
#### Step 5 - Click the Update Allocations button
- Click the pink Update Allocations button
- Sign the transactions with your wallet & pay the gas fees
<figure><img src="../../.gitbook/assets/data-farming/update-allocations.png" alt=""><figcaption><p>Click the Update Allocations button</p></figcaption></figure>
That's it! You've successfully allocated (aka "voted on") your favorite assets in the Ocean ecosystem using your veOCEAN and are generating active rewards yield. Now, just wait until next Thursday to see if you can [claim any OCEAN rewards](how-to-claim-rewards.md) on the Active Rewards section of the [Rewards page](https://df.oceandao.org/rewards) for your portion of the assets' sales. Remember that your first time claiming rewards will require at least one week, but not more than 2 weeks of wait!
----
# User Guide to Delegation
<figure><img src="../../.gitbook/assets/gif/underwater-buddy-peewee.gif" alt=""><figcaption></figcaption></figure>
## Why Delegate?
Delegation is a tool for Volume DF.
Consider these challenges:
- Your veOCEAN is on a hardware wallet and you want a "hot" software wallet to auto-delegate based on data consume volume, to increase APY
- You have >1 wallets and it's a pain to switch among them for delegating
[Delegation](https://df.oceandao.org/delegate) solves that. "To delegate" means "to transfer veOCEAN Allocation Power to another wallet address" for a limited period.
When you delegate, you delegate 100% of your veOCEAN Allocation power.
{% hint style="info" %}
If you delegate 100% of your Allocation Power, your allocations will not count 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.
{% endhint %}
### Steps to Delegate
Follow these steps to delegate your veOCEAN:
1. Go to the [Data Farming dApp](https://df.oceandao.org).
2. Navigate to the [Delegate page](https://df.oceandao.org/delegate).
3. In the 'Receiver wallet address' field, enter the wallet address you wish to delegate to
4. Click the 'Delegate' button, and sign the transaction with your wallet.
5. (Optional) Cancel the delegation to regain your allocation power before the delegation expires.
### What if someone delegates to you?
If you receive veOCEAN allocation power from other wallets, then you will receive their active rewards.
You _cannot_ re-delegate this veOCEAN further downstream.&#x20;
<figure><img src="../../.gitbook/assets/data-farming/veOCEAN-Delegation.png" alt=""><figcaption></figcaption></figure>

View File

@ -42,6 +42,6 @@ Additionally, provider fees are not limited to data consumption — they can als
**Benefits to the Ocean Community**
Were always looking to give back to the Ocean community and collecting fees is an important part of that. As mentioned above, the Ocean Protocol Foundation retains the ability to implement community fees on data consumption. The tokens that we receive will either be burned or invested in the community via projects that they are building. These investments will take place either through [Data Farming](../data-farming/df-intro.md), [Ocean Shipyard](https://oceanprotocol.com/shipyard), or Ocean Ventures.
Were always looking to give back to the Ocean community and collecting fees is an important part of that. As mentioned above, the Ocean Protocol Foundation retains the ability to implement community fees on data consumption. The tokens that we receive will either be burned or invested in the community via projects that they are building. These investments will take place either through [Data Farming](../data-farming/README.md), [Ocean Shipyard](https://oceanprotocol.com/shipyard), or Ocean Ventures.
Projects that utilize OCEAN or H2O are subject to a 0.1% fee. In the case of projects that opt to use different tokens, an additional 0.1% fee will be applied. We want to support marketplaces that use other tokens but we also recognize that they dont bring the same wider benefit to the Ocean community, so we feel this small additional fee is proportionate.

View File

@ -4,7 +4,7 @@ description: 'Discover the World of veOCEAN: Retrieving a Stats'
# Get veOCEAN stats
If you are already familiarized with veOCEAN, you're off to a great start. However, if you need a refresher, we recommend visiting the [veOCEAN](../../data-farming/df-veocean.md) page for a quick overview :mag:
If you are already familiarized with veOCEAN, you're off to a great start. However, if you need a refresher, we recommend visiting the [veOCEAN](../../data-farming/veocean-passive.md) page for a quick overview :mag:
On this page, you'll find a few examples to fetch the stats of veOCEANS from the Ocean Subgraph. These examples serve as a valuable starting point to help you retrieve essential information about veOCEAN. However, if you're eager to delve deeper into the topic, we invite you to visit the [GitHub](https://github.com/oceanprotocol/ocean-subgraph/blob/main/test/integration/VeOcean.test.ts) repository. There, you'll discover a wealth of additional examples, which provide comprehensive insights. Feel free to explore and expand your knowledge! :books:

View File

@ -38,8 +38,8 @@ Buy, mint, and sell NFTs using the Ocean Market following the guides below.
Earn rewards by locking OCEAN, curating data assets, and more.
{% content-ref url="../data-farming/user-guides/README.md" %}
[../data-farming/user-guides/README.md](../data-farming/user-guides/README.md)
{% content-ref url="../data-farming/README.md" %}
[../data-farming/README.md](../data-farming/README.md)
{% endcontent-ref %}
### Antique Stuff 🏺