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

re-add remaining guides as separate pages

Browse Source
This commit is contained in:
trentmc 2023-11-06 12:49:32 +01:00
parent 99424fe2ef
commit 57eb8768d8
13 changed files with 181 additions and 154 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
.gitbook/assets/gif/swimming-pool.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.0 MiB

6
SUMMARY.md
View File

@ -115,11 +115,15 @@
* [Predictoor FAQ](predictoor/pdr-faq.md)
* [💰 Data Farming](data-farming/README.md)
* [Passive DF (and veOCEAN)](data-farming/passivedf.md)
* [User Guide](data-farming/passivedf-guide.md)
* [Guide to Passive DF](data-farming/passivedf-guide.md)
* [Liquid Staking](data-farming/liquid-staking.md)
* [Volume DF](data-farming/volumedf.md)
* [Guide to Volume DF](data-farming/volumedf-guide.md)
* [Delegation in Volume DF](data-farming/delegate.md)
* [Challenge DF](data-farming/challengedf.md)
* [Guide to Challenge DF](data-farming/challengedf-guide.md)
* [Predictoor DF](data-farming/predictoordf.md)
* [Guide to Predictoor DF](data-farming/predictoordf-guide.md)
* [Claim Rewards](data-farming/claim-rewards.md)
* [Reward Schedule](data-farming/reward-schedule.md)
* [APYs](data-farming/apys.md)

2
data-farming/README.md
View File

@ -18,7 +18,7 @@ DF is organized into two streams: Passive DF and Active DF. Each has 50% of the
Here are all streams & substreams. The links lead to dedicated pages.
1. **[Passive DF](veocean-passivedf.md).** 75,000 OCEAN per week. Lock OCEAN for **veOCEAN**; rewards are pro-rata to veOCEAN holdings.
1. **[Passive DF](passivedf.md).** 75,000 OCEAN per week. Lock OCEAN for **veOCEAN**; rewards are pro-rata to veOCEAN holdings.
1. **Active DF.** 75,000 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.

56
data-farming/challengedf-guide.md Normal file
View File

@ -0,0 +1,56 @@
---
description: >-
Be competive, make great predictions, earn $
---
# User Guide to Challenge DF
<figure><img src="../.gitbook/assets/gif/swimming-pool.gif" alt=""><figcaption><p></p></figcaption></figure>
## Predict to earn
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>

63
data-farming/challengedf.md
View File

@ -5,12 +5,10 @@ description: >-
# 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>
<figure><img src="../../.gitbook/assets/gif/underwater-you-want-some-of-this.gif" alt=""></figure>
**Contents:**
- [About Challenge DF](#about-challenge-df)
- [User Guide to Challenge DF](#user-guide-to-challenge-df)
**This page** is about Challenge DF, and [this page](challengedf-guide.md) is a guide.
## About Challenge DF
@ -50,7 +48,7 @@ For the full details on how to submit, please read the [Where to start](#where-t
Head over to the [Challenges Page](https://df.oceandao.org/challenge-df) to learn more about Challenge DF, see historical results, and find out where you go to submit.
If you're looking for a step-by-step guide on what a challenge entails and how to claiming your well-deserved rewards, check out the [Challenge DF user guide](user-guides/how-to-challengedf.md). It will provide you with all the necessary information you need to make the most out of the challenges.
If you're looking for a step-by-step guide on what a challenge entails and how to claiming your well-deserved rewards, check out the [Challenge DF user guide](challengedf-guide.md). It will provide you with all the necessary information you need to make the most out of the challenges.
You can find a direct link to the [Challenge DF README](https://github.com/oceanprotocol/predict-eth/blob/main/challenges/challenge-df.md) which you'll be using to submit your predictions.
@ -58,58 +56,3 @@ You can find a direct link to the [Challenge DF README](https://github.com/ocean
<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
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>

46
data-farming/delegate.md
View File

@ -0,0 +1,46 @@
---
description: >-
Give another wallet power to allocate veOCEAN
---
# Delegation in Volume DF
<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>

4
data-farming/faq.md
View File

@ -115,7 +115,7 @@ In its [docs page](ocean-reward-schedule.md).
</details>
### veOCEAN & Passive DF
### Passive DF (and veOCEAN)
<details>
@ -176,7 +176,7 @@ But to maximize your rewards, you will also need to engage in the other streams.
<summary>Where do I learn more about veOCEAN & Passive DF?</summary>
In its [docs page](veocean-passivedf.md).
In its [docs page](passivedf.md).
</details>

7
data-farming/passivedf-guide.md
View File

@ -1,4 +1,9 @@
# User Guide to veOCEAN and Passive DF
---
description: >-
Get veOCEAN to use the Data Farming dApp and make yield!
---
# Guide to 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>

2
data-farming/passivedf.md
View File

@ -10,7 +10,7 @@ description: >-
**This page** is about Passive DF, and veOCEAN.
Follow-up pages on Passive DF:
- [Passive DF User Guide](passivedf-guide.md)
- [Guide to Passive DF](passivedf-guide.md)
- [Liquid Staking](liquid-staking.md)
# About veOCEAN and Passive DF

10
data-farming/predictoordf-guide.md Normal file
View File

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

5
data-farming/predictoordf.md
View File

@ -5,6 +5,11 @@ description: >-
# Predictoor Data Farming
**This page** is about Predictoor DF, and [this page](predictoordf-guide.md) is a guide.
# About Predictoor DF
In Predictoor DF, you run prediction bots to earn continuously. Starts on DF62.

42
data-farming/volumedf-guide.md Normal file
View File

@ -0,0 +1,42 @@
---
description: >-
Curate datasets in Data Farming and earn
---
# 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!

92
data-farming/volumedf.md
View File

@ -7,11 +7,11 @@ description: >-
<figure><img src="../.gitbook/assets/gif/avatar-plugin.gif" alt=""><figcaption><p>Make your selection and commit. Good things will come.</p></figcaption></figure>
**Contents:**
**This page** is about Volume DF.
- [About Volume DF](#about-volume-df)
- [User Guide to Volume DF](#user-guide-to-volume-df)
- [User Guide to Delegation](#user-guide-to-delegation)
Follow-up pages on Volume DF:
- [Guide to Volume DF](volumedf-guide.md)
- [Guide to Delegation](delegate.md)
# About Volume DF
@ -75,87 +75,3 @@ The actual code is in [calcrewards.py](https://github.com/oceanprotocol/df-py/bl
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>