From 3f11469be0f90315217449e51d790d259f996b56 Mon Sep 17 00:00:00 2001 From: idiom-bytes Date: Fri, 7 Jul 2023 17:49:20 -0700 Subject: [PATCH 1/3] Restructured DF how-tos so they follow a logical onboarding->flow. --- SUMMARY.md | 9 ++++--- rewards/df-basic.md | 12 +++++----- rewards/df-intro.md | 4 ++-- rewards/df-max-out-yield.md | 2 +- user-guides/README.md | 24 +++++++++---------- ...ow-to-data-farm.md => data-farming-101.md} | 13 +++++++--- user-guides/how-to-farm-challengedf.md | 2 +- ...ewards.md => how-to-farm-claim-rewards.md} | 2 +- ...t-started-df.md => how-to-farm-veOCEAN.md} | 4 ++-- user-guides/how-to-farm-volumedf.md | 4 ++-- 10 files changed, 43 insertions(+), 33 deletions(-) rename user-guides/{how-to-data-farm.md => data-farming-101.md} (79%) rename user-guides/{claim-ocean-rewards.md => how-to-farm-claim-rewards.md} (98%) rename user-guides/{get-started-df.md => how-to-farm-veOCEAN.md} (91%) diff --git a/SUMMARY.md b/SUMMARY.md index cec1bc1b..ae5bcaf6 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -28,9 +28,12 @@ * [Github](user-guides/asset-hosting/github.md) * [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) - * [Harvest More Yield Data Farming](user-guides/how-to-data-farm.md) - * [Claim Rewards Data Farming](user-guides/claim-ocean-rewards.md) + * [Data Farming - Overview ](user-guides/data-farming-101.md) + * [Data Farming - Passive Rewards](user-guides/how-to-farm-veOCEAN.md) + * [Data Farming - Claim Rewards](user-guides/how-to-farm-claim-rewards.md) + * [Data Farming - Active Rewards - Challenge DF](user-guides/how-to-farm-challengedf.md) + * [Data Farming - Active Rewards - Volume DF](user-guides/how-to-farm-volumedf.md) + * [Data Farming - Delegate](user-guides/how-to-delegate.md) * [Liquidity Pools \[deprecated\]](user-guides/remove-liquidity-pools.md) * [πŸ‘¨πŸ’» Developers](developers/README.md) * [Architecture Overview](developers/architecture.md) diff --git a/rewards/df-basic.md b/rewards/df-basic.md index 8882562c..a6ce6571 100644 --- a/rewards/df-basic.md +++ b/rewards/df-basic.md @@ -10,16 +10,16 @@ description: Learn the basic moves to start kicking a** Data Farming Our [User Guides](../user-guides/README.md) get you started Data Farming quickly to do the basic operations. Follow these guides to earn your blue belt in Data Farming understanding. -{% content-ref url="../user-guides/get-started-df.md" %} -[get-started-df.md](../user-guides/get-started-df.md) +{% content-ref url="../user-guides/how-to-farm-veOCEAN.md" %} +[how-to-farm-veOCEAN.md](../user-guides/how-to-farm-veOCEAN.md) {% endcontent-ref %} -{% content-ref url="../user-guides/how-to-data-farm.md" %} -[how-to-data-farm.md](../user-guides/how-to-data-farm.md) +{% content-ref url="../user-guides/data-farming-101.md" %} +[data-farming-101.md](../user-guides/data-farming-101.md) {% endcontent-ref %} -{% content-ref url="../user-guides/claim-ocean-rewards.md" %} -[claim-ocean-rewards.md](../user-guides/claim-ocean-rewards.md) +{% content-ref url="../user-guides/how-to-farm-claim-rewards.md" %} +[how-to-farm-claim-rewards.md](../user-guides/how-to-farm-claim-rewards.md) {% endcontent-ref %} ### Not much of a reader? Watch and learn, friend diff --git a/rewards/df-intro.md b/rewards/df-intro.md index 924a0c3f..7b35976c 100644 --- a/rewards/df-intro.md +++ b/rewards/df-intro.md @@ -24,7 +24,7 @@ Passive rewards are the OCEAN rewards paid to Data Farmers just for locking thei
-[To start getting passive rewards, go here.](../user-guides/get-started-df.md) +[To start getting passive rewards, go here.](../user-guides/how-to-farm-veOCEAN.md) #### What are Active Rewards and Substreams? @@ -40,7 +40,7 @@ Challenge DF rewards Data Scientists that produce prediction models that consist Active Rewards are governed and defined by the [Reward Function](df-max-out-yield.md#reward-schedule). -[To start getting Active Rewards, go here.](../user-guides/how-to-data-farm.md) +[To start getting Active Rewards, go here.](../user-guides/data-farming-101.md) #### Splitting the Pie diff --git a/rewards/df-max-out-yield.md b/rewards/df-max-out-yield.md index 0c42eb76..c2c735da 100644 --- a/rewards/df-max-out-yield.md +++ b/rewards/df-max-out-yield.md @@ -24,7 +24,7 @@ Thus, if you really want to max out Volume DF APY: #### Don't have time to publish your own datasets? -Another way to improve your yield is by [delegating](../user-guides/how-to-data-farm.md#how-to-delegate-your-active-rewards) your veOCEAN to someone to generate Active Rewards for you! In this case, the idea is that they may do a better job at publishing assets or picking winners better than you can. However, there is some risk to this because the rewards generated will be sent to the person you delegated to, and it's their responsibility to return those rewards back to you if that's the agreement you both made. To read more, see our [info on Delegation](../user-guides/how-to-data-farm.md#how-to-delegate-your-active-rewards). +Another way to improve your yield is by [delegating](../user-guides/data-farming-101.md#how-to-delegate-your-active-rewards) your veOCEAN to someone to generate Active Rewards for you! In this case, the idea is that they may do a better job at publishing assets or picking winners better than you can. However, there is some risk to this because the rewards generated will be sent to the person you delegated to, and it's their responsibility to return those rewards back to you if that's the agreement you both made. To read more, see our [info on Delegation](../user-guides/data-farming-101.md#how-to-delegate-your-active-rewards). ### Those assets don't sell themselves! diff --git a/user-guides/README.md b/user-guides/README.md index ba16c189..e93508bd 100644 --- a/user-guides/README.md +++ b/user-guides/README.md @@ -38,30 +38,30 @@ Buy, mint, and sell NFTs using the Ocean Market following the guides below. Farm data like a pro. 😎πŸ₯• -{% content-ref url="get-started-df.md" %} -[get-started-df.md](get-started-df.md) +{% content-ref url="data-farming-101.md" %} +[data-farming-101.md](data-farming-101.md) {% endcontent-ref %} -{% content-ref url="how-to-data-farm.md" %} -[how-to-data-farm.md](how-to-data-farm.md) +{% content-ref url="how-to-farm-veOCEAN.md" %} +[how-to-farm-veOCEAN.md](how-to-farm-veOCEAN.md) {% endcontent-ref %} -{% content-ref url="how-to-data-farm-challengedf.md" %} -[how-to-data-farm-challengedf.md](how-to-data-farm-challengedf.md) +{% content-ref url="how-to-farm-claim-rewards.md" %} +[how-to-farm-claim-rewards.md](how-to-farm-claim-rewards.md) {% endcontent-ref %} -{% content-ref url="how-to-data-farm-volumedf.md" %} -[how-to-data-farm-volumedf.md](how-to-data-farm-volumedf.md) +{% content-ref url="how-to-farm-challengedf.md" %} +[how-to-farm-challengedf.md](how-to-farm-challengedf.md) +{% endcontent-ref %} + +{% content-ref url="how-to-farm-volumedf.md" %} +[how-to-farm-volumedf.md](how-to-farm-volumedf.md) {% endcontent-ref %} {% content-ref url="how-to-delegate.md" %} [how-to-delegate.md](how-to-delegate.md) {% endcontent-ref %} -{% content-ref url="claim-ocean-rewards.md" %} -[claim-ocean-rewards.md](claim-ocean-rewards.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/data-farming-101.md similarity index 79% rename from user-guides/how-to-data-farm.md rename to user-guides/data-farming-101.md index 41df7a08..0df59fe8 100644 --- a/user-guides/how-to-data-farm.md +++ b/user-guides/data-farming-101.md @@ -2,13 +2,16 @@ description: Make extra dosh with active rewards yield in Data Farming --- -# Harvest More Yield Data Farming +# Data Farm 101
-## Get More Yield from Data Farming Active Rewards +## The basics of Passive and Active Rewards + + +## Passive Rewards substreams + -The bread and butter of the Data Farming dApp is incentivizing OCEAN rewards for curating and publishing valuable assets in the Ocean ecosystem. The way that users curate assets is by **allocating veOCEAN** to them using the Data Farming dApp. We'll show you how! ## Active Rewards substreams @@ -18,10 +21,14 @@ The primary objective of these substreams is to provide users with various oppor ### Volume DF Substream +Volume DF is the bread and butter of the Data Farming incentive program and rewards OCEAN to publishers and curators that help maintain quality assets in the Ocean ecosystem. + If you have locked your OCEAN tokens in exchange for veOCEAN, this is the ideal opportunity for you to utilize those veOCEAN tokens and earn a portion of active rewards in addition to passive rewards. By allocating your veOCEAN power to high-quality datasets, you can assist Ocean in curating datasets. Moreover, through allocation, you will also receive a portion of the revenue generated by the dataset consumption. +Allocation Powe can also be earned via delegation. The Data Farming dApp [Delegate Page](https://df.oceandao.org/delegate) lets you easily manage simple delegations that use the 100% of the current veOCEAN and the LockEnd time to set the delegation. + For more information on how to get started and detailed instructions, please refer to the [Volume DF](/user-guides/how-to-farm-volumedf.md) section. ### Challenge DF Substream diff --git a/user-guides/how-to-farm-challengedf.md b/user-guides/how-to-farm-challengedf.md index 4669aae4..098fd9de 100644 --- a/user-guides/how-to-farm-challengedf.md +++ b/user-guides/how-to-farm-challengedf.md @@ -2,7 +2,7 @@ description: Make extra dosh with active rewards yield in Data Farming --- -# Harvest More Yield - Challenge DF +# Harvest More Yield in Challenge DF
diff --git a/user-guides/claim-ocean-rewards.md b/user-guides/how-to-farm-claim-rewards.md similarity index 98% rename from user-guides/claim-ocean-rewards.md rename to user-guides/how-to-farm-claim-rewards.md index 4ee40b47..5a36b25d 100644 --- a/user-guides/claim-ocean-rewards.md +++ b/user-guides/how-to-farm-claim-rewards.md @@ -8,7 +8,7 @@ description: How to claim OCEAN token rewards from data farming πŸ§‘β€πŸŒΎπŸ₯• Ocean Protocol's Data Farming dapp dispenses rewards **every Thursday** to its participants. πŸ’° To claim your OCEAN token rewards for data farming, simply navigate to the Data Farming [Rewards page](https://df.oceandao.org/activerewards) and click the Claim OCEAN rewards buttons that will appear pink and clickable each Thursday. Yeehaw! -Want to begin [data farming](https://df.oceandao.org)? Start [here](get-started-df.md). 🀠 +Want to begin [data farming](https://df.oceandao.org)? Start [here](how-to-farm-veOCEAN.md). 🀠 ### Step 1 - Navigate to the Data Farming Rewards page diff --git a/user-guides/get-started-df.md b/user-guides/how-to-farm-veOCEAN.md similarity index 91% rename from user-guides/get-started-df.md rename to user-guides/how-to-farm-veOCEAN.md index a02ad9c8..940fd449 100644 --- a/user-guides/get-started-df.md +++ b/user-guides/how-to-farm-veOCEAN.md @@ -2,7 +2,7 @@ description: Get veOCEAN tokens to use the Data Farming dApp and make yield! πŸ§‘β€πŸŒΎπŸ₯• --- -# Get Started Data Farming +# Earn Passive Rewards with veOCEAN ### What is Data Farming? @@ -52,4 +52,4 @@ In this step you will: - Click the β€œCreate Lock” button. - Accept the transaction in your wallet. -Congratulations! You have now locked your OCEAN tokens for veOCEAN tokens and are generating passive yield automatically. You can [claim your passive OCEAN rewards](claim-ocean-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! +Congratulations! You have now locked your OCEAN tokens for veOCEAN tokens and are generating passive yield automatically. You can [claim your passive OCEAN rewards](how-to-farm-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! diff --git a/user-guides/how-to-farm-volumedf.md b/user-guides/how-to-farm-volumedf.md index a9bb3882..45abaf0f 100644 --- a/user-guides/how-to-farm-volumedf.md +++ b/user-guides/how-to-farm-volumedf.md @@ -2,7 +2,7 @@ description: Make extra dosh with active rewards yield in Data Farming --- -# Harvest More Yield - Volume DF +# Harvest More Yield in Volume DF
@@ -38,4 +38,4 @@ The way that users curate assets is by **pointing their Allocation Power** to th

Click the Update Allocations button

-That's it! You've successfully allocated (aka "voted on") your favorite assets in the Ocean ecosystem using your veOCEAN tokens and are generating active rewards yield. Now, just wait until next Thursday to see if you can [claim any OCEAN rewards](claim-ocean-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! \ No newline at end of file +That's it! You've successfully allocated (aka "voted on") your favorite assets in the Ocean ecosystem using your veOCEAN tokens and are generating active rewards yield. Now, just wait until next Thursday to see if you can [claim any OCEAN rewards](how-to-farm-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! \ No newline at end of file From deb17b30f2385095571d577dc45b8d2852b00c3e Mon Sep 17 00:00:00 2001 From: idiom-bytes Date: Mon, 10 Jul 2023 13:54:39 -0700 Subject: [PATCH 2/3] Restructured a lot of the docs, renamed them to be easier to follow, and tried to simplify in many places due to a lot of repeated-concepts... There is still a lot of duplication and redundancy between the DF docs (technical) and the How-Tos (tutorials). More to come. --- SUMMARY.md | 18 +++--- rewards/README.md | 8 ++- rewards/df-basic.md | 28 ++++++--- rewards/df-emissions-apys.md | 3 - rewards/df-intro.md | 4 +- rewards/df-max-out-yield.md | 30 ++++----- rewards/veocean.md | 8 +-- user-guides/README.md | 8 +-- user-guides/data-farming-101.md | 40 ------------ user-guides/data-farming/data-farming-101.md | 61 +++++++++++++++++++ .../how-to-farm-challengedf.md | 0 .../how-to-farm-claim-rewards.md | 0 .../how-to-farm-delegate.md} | 0 .../{ => data-farming}/how-to-farm-veOCEAN.md | 0 .../how-to-farm-volumedf.md | 0 15 files changed, 119 insertions(+), 89 deletions(-) delete mode 100644 user-guides/data-farming-101.md create mode 100644 user-guides/data-farming/data-farming-101.md rename user-guides/{ => data-farming}/how-to-farm-challengedf.md (100%) rename user-guides/{ => data-farming}/how-to-farm-claim-rewards.md (100%) rename user-guides/{how-to-delegate.md => data-farming/how-to-farm-delegate.md} (100%) rename user-guides/{ => data-farming}/how-to-farm-veOCEAN.md (100%) rename user-guides/{ => data-farming}/how-to-farm-volumedf.md (100%) diff --git a/SUMMARY.md b/SUMMARY.md index ae5bcaf6..1df31a87 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -28,12 +28,12 @@ * [Github](user-guides/asset-hosting/github.md) * [Join a Data Challenge](user-guides/join-a-data-challenge.md) * [Sponsor a Data Challenge](user-guides/sponsor-a-data-challenge.md) - * [Data Farming - Overview ](user-guides/data-farming-101.md) - * [Data Farming - Passive Rewards](user-guides/how-to-farm-veOCEAN.md) - * [Data Farming - Claim Rewards](user-guides/how-to-farm-claim-rewards.md) - * [Data Farming - Active Rewards - Challenge DF](user-guides/how-to-farm-challengedf.md) - * [Data Farming - Active Rewards - Volume DF](user-guides/how-to-farm-volumedf.md) - * [Data Farming - Delegate](user-guides/how-to-delegate.md) + * [Data Farming](user-guides/data-farming/README.md) + * [Farm Passive Rewards](user-guides/data-farming/how-to-farm-veOCEAN.md) + * [Claim Rewards](user-guides/data-farming/how-to-farm-claim-rewards.md) + * [Predict Challenge DF](user-guides/data-farming/how-to-farm-challengedf.md) + * [Curate Volume DF](user-guides/data-farming/how-to-farm-volumedf.md) + * [Delegate](user-guides/data-farming/how-to-farm-delegate.md) * [Liquidity Pools \[deprecated\]](user-guides/remove-liquidity-pools.md) * [πŸ‘¨πŸ’» Developers](developers/README.md) * [Architecture Overview](developers/architecture.md) @@ -115,11 +115,11 @@ * [C2D - Minikube Environment](infrastructure/compute-to-data-minikube.md) * [C2D - Private Docker Registry](infrastructure/compute-to-data-docker-registry.md) * [πŸ€‘ DeFi](defi/README.md) -* [πŸ’° Rewards](rewards/README.md) +* [πŸ’° Data Farming Rewards](rewards/README.md) * [Data Farming 101 (White Belt)](rewards/df-intro.md) - * [DF Basic Actions (Blue Belt)](rewards/df-basic.md) + * [DF "ve" in veOCEAN (Blue Belt)](rewards/veocean.md) * [DF Max Out Yield (Purple Belt)](rewards/df-max-out-yield.md) - * [DF "ve" in veOCEAN (Brown Belt)](rewards/veocean.md) + * [DF Deep Dives (Brown Belt)](rewards/df-basic.md) * [DF Emissions & APYs (Black Belt)](rewards/df-emissions-apys.md) * [🀝 Contribute](contribute/README.md) * [Partners & Collaborators](contribute/projects-using-ocean.md) diff --git a/rewards/README.md b/rewards/README.md index b2fad061..a25b21a3 100644 --- a/rewards/README.md +++ b/rewards/README.md @@ -4,11 +4,13 @@ cover: ../.gitbook/assets/cover/rewards_banner.png coverY: 0 --- -# πŸ’° Rewards +# Data Farming Rewards πŸ’° ### Why did we create the Data Farming dApp? -The purpose of Ocean Protocol's Data Farming dApp reward system is to incentivize the curation and publishing of high-quality data NFTs in the Ocean Ecosystem. Data Farming participants earn OCEAN rewards for these activities. +The purpose of Ocean Protocol's Data Farming dApp reward system is to incentivize the growth, curation, and publishing of high-quality data NFTs in the Ocean Ecosystem. + +Data Farming participants earn OCEAN rewards for these activities. Data Farming rewards are structured in 2 main streams **Passive Rewards** and **Active Rewards**. At a minimum, Data Farmers earn "passive rewards" for locking their OCEAN tokens to get veOCEAN tokens in return. Then, Data Farmers can maximize their yield by earning "active rewards". Active Rewards stream it's broken down into multiple substreams, to offer you a variaty of ways to contribute to Ocean Protocol values and increase your Data Farming rewards: Volume DF, Challenge DF. ### The belt system @@ -33,7 +35,7 @@ veOCEAN is a fork of veCRV. This enables participants to become a governance del ## Delegation -[Delegation](../user-guides/how-to-delegate.md) will teach you how to share your veOCEAN allocation power to other users that can help manage Volume DF substream for you. +[Delegation](..user-guides/data-farming/how-to-farm-delegate.md) will teach you how to share your veOCEAN allocation power to other users that can help manage Volume DF substream for you. 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. diff --git a/rewards/df-basic.md b/rewards/df-basic.md index a6ce6571..bcf309a2 100644 --- a/rewards/df-basic.md +++ b/rewards/df-basic.md @@ -2,24 +2,36 @@ description: Learn the basic moves to start kicking a** Data Farming --- -# DF Basic Actions (Blue Belt) +# DF Deep Dives (Brown Belt)

Like Neo, you have great potential.

### Get Started -Our [User Guides](../user-guides/README.md) get you started Data Farming quickly to do the basic operations. Follow these guides to earn your blue belt in Data Farming understanding. +Our [User Guides](../user-guides/README.md) get you started Data Farming quickly to do the basic operations. Follow these guides to earn your brown belt in Data Farming understanding. -{% content-ref url="../user-guides/how-to-farm-veOCEAN.md" %} -[how-to-farm-veOCEAN.md](../user-guides/how-to-farm-veOCEAN.md) +{% content-ref url="../user-guides/data-farming/README.md" %} +[README.md](../user-guides/data-farming/README.md) {% endcontent-ref %} -{% content-ref url="../user-guides/data-farming-101.md" %} -[data-farming-101.md](../user-guides/data-farming-101.md) +{% content-ref url="../user-guides/data-farming/how-to-farm-veOCEAN.md" %} +[how-to-farm-veOCEAN.md](../user-guides/data-farming/how-to-farm-veOCEAN.md) {% endcontent-ref %} -{% content-ref url="../user-guides/how-to-farm-claim-rewards.md" %} -[how-to-farm-claim-rewards.md](../user-guides/how-to-farm-claim-rewards.md) +{% content-ref url="..user-guides/data-farming/how-to-farm-claim-rewards.md" %} +[how-to-farm-claim-rewards.md](..user-guides/data-farming/how-to-farm-claim-rewards.md) +{% endcontent-ref %} + +{% content-ref url="..user-guides/data-farming/how-to-farm-challengedf.md" %} +[how-to-farm-challengedf.md](..user-guides/data-farming/how-to-farm-challengedf.md) +{% endcontent-ref %} + +{% content-ref url="..user-guides/data-farming/how-to-farm-volumedf.md" %} +[how-to-farm-volumedf.md](..user-guides/data-farming/how-to-farm-volumedf.md) +{% endcontent-ref %} + +{% content-ref url="..user-guides/data-farming/how-to-farm-delegate.md" %} +[how-to-farm-delegate.md](..user-guides/data-farming/how-to-farm-delegate.md) {% endcontent-ref %} ### Not much of a reader? Watch and learn, friend diff --git a/rewards/df-emissions-apys.md b/rewards/df-emissions-apys.md index b9502851..08e7deae 100644 --- a/rewards/df-emissions-apys.md +++ b/rewards/df-emissions-apys.md @@ -51,9 +51,6 @@ 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. -\ - -

Green: estimated APYs (passive + active). Black: estimated APYs (just passive). Yellow: estimated staking

All the plots are calculated from [this Google Sheet](https://docs.google.com/spreadsheets/d/1F4o7PbV45yW1aPWOJ2rwZEKkgJXbIk5Yq7tj8749drc/edit#gid=1051477754). diff --git a/rewards/df-intro.md b/rewards/df-intro.md index 7b35976c..10510ca7 100644 --- a/rewards/df-intro.md +++ b/rewards/df-intro.md @@ -24,7 +24,7 @@ Passive rewards are the OCEAN rewards paid to Data Farmers just for locking thei
-[To start getting passive rewards, go here.](../user-guides/how-to-farm-veOCEAN.md) +[To start getting passive rewards, go here.](../user-guides/data-farming/how-to-farm-veOCEAN.md) #### What are Active Rewards and Substreams? @@ -40,7 +40,7 @@ Challenge DF rewards Data Scientists that produce prediction models that consist Active Rewards are governed and defined by the [Reward Function](df-max-out-yield.md#reward-schedule). -[To start getting Active Rewards, go here.](../user-guides/data-farming-101.md) +[To start getting Active Rewards, go here.](../user-guides/README.md) #### Splitting the Pie diff --git a/rewards/df-max-out-yield.md b/rewards/df-max-out-yield.md index c2c735da..b864ce53 100644 --- a/rewards/df-max-out-yield.md +++ b/rewards/df-max-out-yield.md @@ -4,11 +4,11 @@ description: >- Ocean Protocol's Data Farming dApp! πŸ₯‹ --- -# Max Out Volume DF (Purple Belt) +# Mastering Volume DF (Purple Belt)

You know enough to be dangerous.

-### Maximize your Yield +## Yield Kung Fu If you only lock your OCEAN tokens to get passive yield, then you're leaving money on the table. @@ -22,19 +22,19 @@ Thus, if you really want to max out Volume DF APY: 4. Point your Allocation Power towards your published assets to receive a 2x bonus. 5. Claim weekly Passive Rewards, Active Rewards, and update your lock. -#### Don't have time to publish your own datasets? +### Data Farming success metrics -Another way to improve your yield is by [delegating](../user-guides/data-farming-101.md#how-to-delegate-your-active-rewards) your veOCEAN to someone to generate Active Rewards for you! In this case, the idea is that they may do a better job at publishing assets or picking winners better than you can. However, there is some risk to this because the rewards generated will be sent to the person you delegated to, and it's their responsibility to return those rewards back to you if that's the agreement you both made. To read more, see our [info on Delegation](../user-guides/data-farming-101.md#how-to-delegate-your-active-rewards). +**Data Consume Volume (DCV)** is our term for **the total $ amount spent on purchases of Ocean ecosystem assets**, transaction fees, and more. The higher DCV of Ocean ecosystem assets, then the more OCEAN rewards are distributed to Data Farmers. It's that simple! ### Those assets don't sell themselves! -Marketing your assets to buyers is your challenge. Just because you publish them in the Ocean ecosystem doesn't mean that they will sell. It will take real work. Your reward is great APY. Its incentives all the way down πŸ™‚ +Marketing your assets to buyers can be a big challenge. Just because you publish them in the Ocean ecosystem doesn't mean that they will sell. It will take real work. Your reward is great APY. Its incentives all the way down πŸ™‚
-### Measuring Data Farming's Success +### Don't have time to publish your own datasets? -**Data Consume Volume (DCV)** is our term for **the total $ amount spent on purchases of Ocean ecosystem assets**, transaction fees, and more. The higher DCV of Ocean ecosystem assets, then the more OCEAN rewards are distributed to Data Farmers. It's that simple! +Another way to improve your yield is by [delegating](../user-guides/README.md#how-to-delegate-your-active-rewards) your veOCEAN to someone to generate Active Rewards for you! In this case, the idea is that they may do a better job at publishing assets or picking winners better than you can. However, there is some risk to this because the rewards generated will be sent to the person you delegated to, and it's their responsibility to return those rewards back to you if that's the agreement you both made. To read more, see our [info on Delegation](../user-guides/README.md#how-to-delegate-your-active-rewards). ### How Rewards are Calculated @@ -72,6 +72,14 @@ To qualify for DF, an asset must also: * Have been created by Ocean Smart contracts [deployed](https://github.com/oceanprotocol/contracts/blob/v4main/addresses/address.json) by OPF to [production networks](../discover/networks/README.md) * Can’t be in [purgatory](https://github.com/oceanprotocol/list-purgatory/blob/main/policies/README.md) +### 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. + +

Ocean Reward Schedule for the next 20+ years

+ +
+ ### 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. @@ -89,11 +97,3 @@ Up to 100K OCEAN rewards were budgeted per week. Counting started Thu Oct 27, 20 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 go 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 below. - -### 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. - -

Ocean Reward Schedule for the next 20+ years

- -
diff --git a/rewards/veocean.md b/rewards/veocean.md index 3a6b7ab1..3f5648d5 100644 --- a/rewards/veocean.md +++ b/rewards/veocean.md @@ -1,10 +1,10 @@ --- description: >- - Let's discuss the "ve" in veOCEAN for our last jutsu before earning a black + Let's discuss the "ve" in veOCEAN for our second jutsu, earning a blue belt in Data Farming knowledge! --- -# DF "ve" in veOCEAN (Brown Belt) +# DF "ve" in veOCEAN (Blue Belt)

Data Farming is getting effortless.

@@ -81,9 +81,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. -#### 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. +The veOCEAN code is a fork of Curve's battle tested [veCRV](https://curve.readthedocs.io/dao-vecrv.html) token code. ### Replenishing your veOCEAN diff --git a/user-guides/README.md b/user-guides/README.md index e93508bd..1e097555 100644 --- a/user-guides/README.md +++ b/user-guides/README.md @@ -38,8 +38,8 @@ Buy, mint, and sell NFTs using the Ocean Market following the guides below. Farm data like a pro. 😎πŸ₯• -{% content-ref url="data-farming-101.md" %} -[data-farming-101.md](data-farming-101.md) +{% content-ref url="README.md" %} +[README.md](README.md) {% endcontent-ref %} {% content-ref url="how-to-farm-veOCEAN.md" %} @@ -58,8 +58,8 @@ Farm data like a pro. 😎πŸ₯• [how-to-farm-volumedf.md](how-to-farm-volumedf.md) {% endcontent-ref %} -{% content-ref url="how-to-delegate.md" %} -[how-to-delegate.md](how-to-delegate.md) +{% content-ref url="how-to-farm-delegate.md" %} +[how-to-farm-delegate.md](how-to-farm-delegate.md) {% endcontent-ref %} ### Antique Stuff 🏺 diff --git a/user-guides/data-farming-101.md b/user-guides/data-farming-101.md deleted file mode 100644 index 0df59fe8..00000000 --- a/user-guides/data-farming-101.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -description: Make extra dosh with active rewards yield in Data Farming ---- - -# Data Farm 101 - -
- -## The basics of Passive and Active Rewards - - -## Passive Rewards substreams - - - -## Active Rewards substreams - -Active Rewards is one of the two main streams within Data Farming, along with Passive Rewards. The Active Rewards stream offers a defined amount of rewards for each round and is further divided into multiple substreams. - -The primary objective of these substreams is to provide users with various opportunities to actively engage in Data Farming. This approach allows users with different skills and interests to collaborate and contribute their unique abilities towards achieving the core values of Ocean Protocol. - -### Volume DF Substream - -Volume DF is the bread and butter of the Data Farming incentive program and rewards OCEAN to publishers and curators that help maintain quality assets in the Ocean ecosystem. - -If you have locked your OCEAN tokens in exchange for veOCEAN, this is the ideal opportunity for you to utilize those veOCEAN tokens and earn a portion of active rewards in addition to passive rewards. - -By allocating your veOCEAN power to high-quality datasets, you can assist Ocean in curating datasets. Moreover, through allocation, you will also receive a portion of the revenue generated by the dataset consumption. - -Allocation Powe can also be earned via delegation. The Data Farming dApp [Delegate Page](https://df.oceandao.org/delegate) lets you easily manage simple delegations that use the 100% of the current veOCEAN and the LockEnd time to set the delegation. - -For more information on how to get started and detailed instructions, please refer to the [Volume DF](/user-guides/how-to-farm-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 provides a weekly competition where you can test your skills in predicting the price of Ethereum. Rise against other participants to earn a place on the podium and receive a share of the available rewards. - -This opportunity allows you to explore the capabilities offered by Ocean Protocol and gain valuable exposure. As your models and skills improve, you can publish your models on the main network and begin monetizing your work. - -For detailed instructions and information on how to get started, please refer to the [Challenge DF](/user-guides/how-to-farm-challengedf.md) section. diff --git a/user-guides/data-farming/data-farming-101.md b/user-guides/data-farming/data-farming-101.md new file mode 100644 index 00000000..1ec30f2d --- /dev/null +++ b/user-guides/data-farming/data-farming-101.md @@ -0,0 +1,61 @@ +--- +description: Make extra dosh with active rewards yield in Data Farming +--- + +# Data Farm 101 + +
+ +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 curate markets, create algorithms, and active do work to imporve the protocol. + +All streams operate permissionlessly and anyone is welcomed to participate. + +## Passive Rewards stream + +Passive Rewards is the first of the main streams within Data Farming. + +Passive Rewards offers a defined amount of rewards for each round that is divided amongst veOCEAN holders based on how much they hold. + +The primary objective of the Passive Rewards stream is to provide a low-friction, high-accessibility way for anyone that is holding OCEAN to participate and help the protocol grow. + +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. + +To learn more about veOCEAN and the Passive Rewards stream [you can click here](user-guides/data-farming/how-to-farm-veOCEAN.md) + +## Active Rewards stream & substreams + +Active Rewards is the second of the main streams within Data Farming. + +Active Rewards offers a defined amount of rewards for each round and is further divided into multiple substreams. + +The primary objective of these substreams is to provide users with various opportunities to actively engage in Data Farming. 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 now to learn more about them, and help you get started with contributing to Ocean Protocol and earning rewards. + +### Volume DF Substream + +Volume DF is the bread and butter of the Data Farming incentive program and rewards OCEAN to publishers and curators that help maintain quality assets in the Ocean ecosystem. + +If you have locked your OCEAN tokens in exchange for veOCEAN, this is the ideal opportunity for you to utilize those veOCEAN tokens and earn a portion of active rewards in addition to passive rewards. + +By allocating your veOCEAN power to high-quality datasets, you can assist Ocean in curating datasets. Moreover, through allocation, you will also receive a portion of the revenue generated by the dataset consumption. + +Allocation Power can also be earned via delegation. The Data Farming dApp [Delegate Page](https://df.oceandao.org/delegate) lets you easily manage simple delegations that use the 100% of the current veOCEAN and the LockEnd time to set the delegation. + +For more information on how to get started and detailed instructions, please refer to the [Volume DF](user-guides/data-farming/how-to-farm-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 provides a weekly competition where you can test your skills in predicting the price of Ethereum. Rise against other participants to earn a place on the podium and receive a share of the available rewards. + +This opportunity allows you to explore the capabilities offered by Ocean Protocol and gain valuable exposure. As your models and skills improve, you can publish your models on the main network and begin monetizing your work. + +For detailed instructions and information on how to get started, please refer to the [Challenge DF](user-guides/data-farming/how-to-farm-challengedf.md) section. diff --git a/user-guides/how-to-farm-challengedf.md b/user-guides/data-farming/how-to-farm-challengedf.md similarity index 100% rename from user-guides/how-to-farm-challengedf.md rename to user-guides/data-farming/how-to-farm-challengedf.md diff --git a/user-guides/how-to-farm-claim-rewards.md b/user-guides/data-farming/how-to-farm-claim-rewards.md similarity index 100% rename from user-guides/how-to-farm-claim-rewards.md rename to user-guides/data-farming/how-to-farm-claim-rewards.md diff --git a/user-guides/how-to-delegate.md b/user-guides/data-farming/how-to-farm-delegate.md similarity index 100% rename from user-guides/how-to-delegate.md rename to user-guides/data-farming/how-to-farm-delegate.md diff --git a/user-guides/how-to-farm-veOCEAN.md b/user-guides/data-farming/how-to-farm-veOCEAN.md similarity index 100% rename from user-guides/how-to-farm-veOCEAN.md rename to user-guides/data-farming/how-to-farm-veOCEAN.md diff --git a/user-guides/how-to-farm-volumedf.md b/user-guides/data-farming/how-to-farm-volumedf.md similarity index 100% rename from user-guides/how-to-farm-volumedf.md rename to user-guides/data-farming/how-to-farm-volumedf.md From a740fb43d9ebefdd3e0c72f044123d09ccc9f468 Mon Sep 17 00:00:00 2001 From: idiom-bytes Date: Mon, 10 Jul 2023 14:05:36 -0700 Subject: [PATCH 3/3] Fixing relative urls. --- user-guides/data-farming/data-farming-101.md | 6 +++--- user-guides/data-farming/how-to-farm-challengedf.md | 12 ++++++------ .../data-farming/how-to-farm-claim-rewards.md | 6 +++--- user-guides/data-farming/how-to-farm-delegate.md | 2 +- user-guides/data-farming/how-to-farm-veOCEAN.md | 2 +- user-guides/data-farming/how-to-farm-volumedf.md | 8 ++++---- 6 files changed, 18 insertions(+), 18 deletions(-) diff --git a/user-guides/data-farming/data-farming-101.md b/user-guides/data-farming/data-farming-101.md index 1ec30f2d..5f62b3a5 100644 --- a/user-guides/data-farming/data-farming-101.md +++ b/user-guides/data-farming/data-farming-101.md @@ -4,7 +4,7 @@ description: Make extra dosh with active rewards yield in Data Farming # Data Farm 101 -
+
Data Farming is the core incentive system inside of Ocean Protocol. It offers different ways for participants to help the protocol grow and succeed. @@ -50,7 +50,7 @@ By allocating your veOCEAN power to high-quality datasets, you can assist Ocean Allocation Power can also be earned via delegation. The Data Farming dApp [Delegate Page](https://df.oceandao.org/delegate) lets you easily manage simple delegations that use the 100% of the current veOCEAN and the LockEnd time to set the delegation. -For more information on how to get started and detailed instructions, please refer to the [Volume DF](user-guides/data-farming/how-to-farm-volumedf.md) section. +For more information on how to get started and detailed instructions, please refer to the [Volume DF](how-to-farm-volumedf.md) section. ### Challenge DF Substream @@ -58,4 +58,4 @@ If you are a data scientist and enjoy tackling challenging problems, this is the This opportunity allows you to explore the capabilities offered by Ocean Protocol and gain valuable exposure. As your models and skills improve, you can publish your models on the main network and begin monetizing your work. -For detailed instructions and information on how to get started, please refer to the [Challenge DF](user-guides/data-farming/how-to-farm-challengedf.md) section. +For detailed instructions and information on how to get started, please refer to the [Challenge DF](how-to-farm-challengedf.md) section. diff --git a/user-guides/data-farming/how-to-farm-challengedf.md b/user-guides/data-farming/how-to-farm-challengedf.md index 098fd9de..f9bee1df 100644 --- a/user-guides/data-farming/how-to-farm-challengedf.md +++ b/user-guides/data-farming/how-to-farm-challengedf.md @@ -4,7 +4,7 @@ description: Make extra dosh with active rewards yield in Data Farming # Harvest More Yield in Challenge DF -
+
## Get More Rewards from Challenge DF @@ -24,13 +24,13 @@ Go to https://df.oceandao.org After the dApp loads, look for the menu and click on "Challenges" -

Find "Challenges" in the menu and click on it

+

Find "Challenges" in the menu and click on it

#### Step 3 - Click on "Participate" After clicking on "Participate" you will be linked to a README that outlines all details about the challenge. -

Click the Participate button

+

Click the Participate button

#### Step 4 - Use README to publish your predictions @@ -38,7 +38,7 @@ You can see the ongoing challenge right away together with some key informations Follow the README steps to publish your model and compete in the challenge. -

How to submit ChallengeDF

+

How to submit ChallengeDF

#### Step 5 - Check weekly results @@ -46,7 +46,7 @@ Challenge DF weekly results become available at the end of every Data Farming ro The top 3 competitors win prizes and are visible in the leaderboard. -

Past Challenges leaderboard

+

Past Challenges leaderboard

#### Step 6 - View and claim Active Rewards. @@ -55,4 +55,4 @@ To view and claim your rewards: 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. -

Click the Claim Rewards button

\ No newline at end of file +

Click the Claim Rewards button

\ No newline at end of file diff --git a/user-guides/data-farming/how-to-farm-claim-rewards.md b/user-guides/data-farming/how-to-farm-claim-rewards.md index 5a36b25d..4f2c508c 100644 --- a/user-guides/data-farming/how-to-farm-claim-rewards.md +++ b/user-guides/data-farming/how-to-farm-claim-rewards.md @@ -4,7 +4,7 @@ description: How to claim OCEAN token rewards from data farming πŸ§‘β€πŸŒΎπŸ₯• # Claim Rewards Data Farming -
+
Ocean Protocol's Data Farming dapp dispenses rewards **every Thursday** to its participants. πŸ’° To claim your OCEAN token rewards for data farming, simply navigate to the Data Farming [Rewards page](https://df.oceandao.org/activerewards) and click the Claim OCEAN rewards buttons that will appear pink and clickable each Thursday. Yeehaw! @@ -14,7 +14,7 @@ Want to begin [data farming](https://df.oceandao.org)? Start [here](how-to-farm- Go to [https://df.oceandao.org/](https://df.oceandao.org), and click the Rewards [link](https://df.oceandao.org/activerewards) at the top of the page. -

Click the Rewards link at the top of the page

+

Click the Rewards link at the top of the page

### Step 2 - Click the pink 'Claim # OCEAN' buttons πŸ›ŽοΈ @@ -22,7 +22,7 @@ At the bottom of the 'Passive Rewards' and 'Active Rewards' panels are the 'Clai This is where you click to claim your rewards! Easy peasy. You will need to approve the transactions with your wallet. -

Click the pink Claim # Ocean buttons

+

Click the pink Claim # Ocean buttons

### FIRST TIME CLAIMING? diff --git a/user-guides/data-farming/how-to-farm-delegate.md b/user-guides/data-farming/how-to-farm-delegate.md index 65defb77..5483e040 100644 --- a/user-guides/data-farming/how-to-farm-delegate.md +++ b/user-guides/data-farming/how-to-farm-delegate.md @@ -4,7 +4,7 @@ description: Simplify and Improve your Data Farming # Delegate Allocation Power and Active Rewards -
+
## Why Delegate? diff --git a/user-guides/data-farming/how-to-farm-veOCEAN.md b/user-guides/data-farming/how-to-farm-veOCEAN.md index 940fd449..a8253d1c 100644 --- a/user-guides/data-farming/how-to-farm-veOCEAN.md +++ b/user-guides/data-farming/how-to-farm-veOCEAN.md @@ -8,7 +8,7 @@ description: Get veOCEAN tokens to use the Data Farming dApp and make yield! [Data Farming](https://df.oceandao.org) is our dApp that generates yield for participants that curate and publish valuable assets in the Ocean ecosystem. -

Get veOCEAN tokens

+

Get veOCEAN tokens

### What is veOCEAN and why do you want it? 🌊 diff --git a/user-guides/data-farming/how-to-farm-volumedf.md b/user-guides/data-farming/how-to-farm-volumedf.md index 45abaf0f..eb51daa3 100644 --- a/user-guides/data-farming/how-to-farm-volumedf.md +++ b/user-guides/data-farming/how-to-farm-volumedf.md @@ -4,7 +4,7 @@ description: Make extra dosh with active rewards yield in Data Farming # Harvest More Yield in Volume DF -
+
## Get More Rewards from Volume DF @@ -22,20 +22,20 @@ The way that users curate assets is by **pointing their Allocation Power** to th #### Step 3 - Click on the VolumeDF tab in the top menu -

Click the VolumeDF page link in the menu

+

Click the VolumeDF page link in the menu

#### 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**. The rows for assets that you publish will appear cream-colored. -

Toggle the percentage of your veOCEAN that you would like to allocate to each asset

+

Toggle the percentage of your veOCEAN that you would like to allocate to each asset

#### Step 5 - Click the Update Allocations button - Click the pink Update Allocations button - Sign the transactions with your wallet & pay the gas fees -

Click the Update Allocations button

+

Click the Update Allocations button

That's it! You've successfully allocated (aka "voted on") your favorite assets in the Ocean ecosystem using your veOCEAN tokens and are generating active rewards yield. Now, just wait until next Thursday to see if you can [claim any OCEAN rewards](how-to-farm-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! \ No newline at end of file