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

Updating all paths to user-guides.

This commit is contained in:
idiom-bytes 2023-10-06 09:51:24 -07:00
parent 780d05ec60
commit 16261337a5
10 changed files with 53 additions and 52 deletions

View File

@ -61,6 +61,7 @@ redirects:
veocean-data-farming/df-background: rewards/df-volumedf.md
veocean-data-farming/emissions-apys: rewards/df-emissions-apys.md
veocean-data-farming/delegation: rewards/README.md
veocean-data-farming/veocean-data-farming-tutorial: rewards/user-guides/how-to-veocean.md
rewards/veOcean-Data-Farming-Tutorial: rewards/user-guides/how-to-veocean.md
api-references: developers/README.md
api-references/aquarius-rest-api: developers/aquarius/asset-requests.md

View File

@ -28,13 +28,13 @@
- [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](user-guides/data-farming/README.md)
- [Earn Passive Rewards](user-guides/data-farming/how-to-veocean.md)
- [Estimate APYs](user-guides/data-farming/how-to-estimate-apy.md)
- [Claim Rewards](user-guides/data-farming/how-to-claim-rewards.md)
- [Curate with Volume DF](user-guides/data-farming/how-to-volumedf.md)
- [Delegate Curation](user-guides/data-farming/how-to-delegate.md)
- [Predict with Challenge DF](user-guides/data-farming/how-to-challengedf.md)
- [Data Farming](rewards/user-guides/README.md)
- [Earn Passive Rewards](rewards/user-guides/how-to-veocean.md)
- [Estimate APYs](rewards/user-guides/how-to-estimate-apy.md)
- [Claim Rewards](rewards/user-guides/how-to-claim-rewards.md)
- [Curate with Volume DF](rewards/user-guides/how-to-volumedf.md)
- [Delegate Curation](rewards/user-guides/how-to-delegate.md)
- [Predict with Challenge DF](rewards/user-guides/how-to-challengedf.md)
- [Liquidity Pools \[deprecated\]](user-guides/remove-liquidity-pools.md)
- [💻 Developers](developers/README.md)
- [Architecture Overview](developers/architecture.md)

View File

@ -27,7 +27,7 @@ If you are looking for step-by-step tutorials on how to access the Data Farming
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.
It may help for you to review the user guide on [how to estimate APY](../user-guides/data-farming/how-to-estimate-apy.md) to get a better idea for how long you'll want to lock your funds.
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.
### Passive Rewards
@ -41,7 +41,7 @@ It is by-design, without the need for anyone to put in any significant effort. Y
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/data-farming/how-to-claim-rewards.md).
Once your tokens are locked up, you can then learn [how to claim rewards](user-guides/how-to-claim-rewards.md).
### Active Rewards
@ -61,13 +61,13 @@ If you have locked your OCEAN tokens in exchange for veOCEAN, this is the ideal
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/data-farming/how-to-volumedf.md).
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/data-farming/how-to-delegate.md) user guide to follow the steps needed to successfully delegate.
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.
@ -77,7 +77,7 @@ In this substream, Data Scientists can win competitions by participating in [Cha
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/data-farming/how-to-challengedf.md) will take you step-by-step through the process of submitting your algorithm into the competition.
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

View File

@ -43,7 +43,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/data-farming/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](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.
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.

View File

@ -11,9 +11,9 @@ description: >-
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](../rewards/df-intro.md#estimating-apy) first.
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/data-farming/how-to-estimate-apy.md).
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

View File

@ -12,8 +12,8 @@ description: Frequently Asked Questions about Data Farming
Absolutely, we've adopted the voting escrowed system from Curve Finance (veCRV) and created veOCEAN.
veOCEAN lets you lock $OCEAN to receive veOCEAN. You then automatically access Passive Rewards via Data Farming while learning more about Active Rewards. Here are some handy resources to help you get started:
1. [Tutorial](https://docs.oceanprotocol.com/veocean-data-farming/veocean-data-farming-tutorial)
2. [Estimate your APY](https://docs.oceanprotocol.com/user-guides/data-farming/how-to-estimate-apy)
1. [Tutorial](user-guides/how-to-volumedf.md)
2. [Estimate your APY](user-guides/how-to-estimate-apy.md)
By exploring these links, you'll get step-by-step guidance and insights into maximizing your rewards with veOCEAN.
@ -28,7 +28,7 @@ We cannot offer guidance as how to allocate your voting power, that's your decis
No. They cannot be traded, transferred, or sold.
You can delegate veOCEAN to others in order to facilitate farming, however, you need to understand how this works. To learn more [please read the docs](https://docs.oceanprotocol.com/user-guides/data-farming).
You can delegate veOCEAN to others in order to facilitate farming, however, you need to understand how this works. To learn more [please read the docs](user-guides/how-to-delegate.md).
</details>
<details>
@ -57,7 +57,7 @@ You can find a list of [all supported chains here](networks/README.md).
<summary>What is veOcean and staking in context of Ocean Protocol? </summary>
[veOCEAN](https://docs.oceanprotocol.com/rewards/df-veocean) (vote-escrowed OCEAN) is a special token in the Ocean Protocol ecosystem. Users can obtain veOCEAN by Locking their OCEAN tokens for a specific period of time. Their OCEAN cannot be accessed during this time as a sign of conviction that lets them engage with the network. Longer lock periods for veOCEAN typically yield higher rewards.
[veOCEAN](df-veocean.md) (vote-escrowed OCEAN) is a special token in the Ocean Protocol ecosystem. Users can obtain veOCEAN by Locking their OCEAN tokens for a specific period of time. Their OCEAN cannot be accessed during this time as a sign of conviction that lets them engage with the network. Longer lock periods for veOCEAN typically yield higher rewards.
You can lock your Ocean Token at - [df.oceandao.org](https://df.oceandao.org)
</details>
@ -67,7 +67,7 @@ You can lock your Ocean Token at - [df.oceandao.org](https://df.oceandao.org)
<summary>How much Ocean do I need to stake to earn interest?</summary>
There is no minimum amount. The rewards will depend on the amount you lock.
You will get passive rewards by default when you lock tokens. On top of that, you can get active rewards if you actively participate in the program. Here are some [resources](https://docs.oceanprotocol.com/veocean-data-farming/veocean-data-farming-tutorial).
You will get passive rewards by default when you lock tokens. On top of that, you can get active rewards if you actively participate in the program. Here are some [resources](user-guides/how-to-veocean.md).
</details>
@ -97,7 +97,7 @@ But to maximize your rewards, you will also need to engage in Active Rewards.
It's worth noting that active staking does come with associated costs, such as gas fees which you will need to cover.
More information about [APYs](https://docs.oceanprotocol.com/user-guides/data-farming/how-to-estimate-apy).
More information about [APYs](user-guides/how-to-estimate-apy).
</details>
@ -134,7 +134,7 @@ You can convert psdnOCEAN back to $OCEAN using the Balancer AMM liquidity [pool]
<summary>What's the amount of veOcean one can get for locking 1 Ocean token?</summary>
1 veOCEAN if you lock for 4 years. Learn more about VeOCEAN [here](https://docs.oceanprotocol.com/rewards/df-veocean).
1 veOCEAN if you lock for 4 years. Learn more about VeOCEAN [here](df-veocean.md).
</details>
@ -142,7 +142,7 @@ You can convert psdnOCEAN back to $OCEAN using the Balancer AMM liquidity [pool]
<summary>If I withdraw before the unlock date, what happens to my veOCEAN and rewards?</summary>
You can't withdraw before the [unlock date](https://docs.oceanprotocol.com/rewards/df-veocean).
You can't withdraw before the [unlock date](df-veocean.md).
</details>
@ -152,7 +152,7 @@ You can't withdraw before the [unlock date](https://docs.oceanprotocol.com/rewar
No, you can't convert your VeOcean to Ocean during the lock period. When the lock period concludes, you gain access to all your locked Ocean tokens.
To learn more about VeOcean, check out this [resource](https://docs.oceanprotocol.com/rewards/df-veocean).
To learn more about VeOcean, check out this [resource](df-veocean).
</details>
@ -192,7 +192,7 @@ All rewards in Data Farming are paid out in $OCEAN and can be claimed at the eve
If you've locked 10,000 OCEAN for a short period, it's possible to see a near-0% APY.
To boost your APY, consider locking your OCEAN for a more extended period. It's not only about the amount you lock but also **the duration of the lock that matters most**. Longer lock periods yield more significant results. You can find further insights in this [document](https://docs.oceanprotocol.com/user-guides/data-farming/how-to-estimate-apy).
To boost your APY, consider locking your OCEAN for a more extended period. It's not only about the amount you lock but also **the duration of the lock that matters most**. Longer lock periods yield more significant results. You can find further insights in this [document](user-guides/how-to-estimate-apy).
</details>
@ -201,9 +201,9 @@ To boost your APY, consider locking your OCEAN for a more extended period. It's
<summary>Could you explain the benefits of staking $OCEAN tokens and how the APY is calculated?</summary>
Yes, You can find the details in these resources.
1. [Benefits](https://docs.oceanprotocol.com/rewards/veocean).
2. [Passive Rewards](https://docs.oceanprotocol.com/rewards/df-intro).
3. [Emissions & APYs](https://docs.oceanprotocol.com/rewards/df-emissions-apys).
1. [Benefits](df-veocean).
2. [Passive Rewards](df-intro).
3. [Emissions & APYs](df-emissions-apys).
</details>
@ -211,7 +211,7 @@ Yes, You can find the details in these resources.
<summary>What is the current APY (Annual Percentage Yield) for staking?</summary>
The APY is highly dependent on the locked amount and more importantly on the locking period. Please see the [Estimate your APY](https://docs.oceanprotocol.com/user-guides/data-farming/how-to-estimate-apy) guide.
The APY is highly dependent on the locked amount and more importantly on the locking period. Please see the [Estimate your APY](user-guides/how-to-estimate-apy) guide.
</details>
@ -229,7 +229,7 @@ Just, visit the Data Farming website and scroll down to the [Data Farming Histor
<summary>What assets are eligible for Data Farming?</summary>
The data asset may be of any type — dataset (for static URIs), algorithm for Compute-to-Data, or any other Datatoken token-gated system. The data asset may be fixed price or free price. You can find more details in the [DF Background page](../rewards/df-volumedf.md#assets-that-qualify-for-data-farming)
The data asset may be of any type — dataset (for static URIs), algorithm for Compute-to-Data, or any other Datatoken token-gated system. The data asset may be fixed price or free price. You can find more details in the [DF Background page](df-volumedf.md#assets-that-qualify-for-data-farming)
</details>
@ -237,7 +237,7 @@ The data asset may be of any type — dataset (for static URIs), algorithm for C
<summary>Do I only receive Active Rewards from Volume DF if the datasets I staked on receive DCV?</summary>
Yes, you will receive [Active Rewards from Volume DF](https://docs.oceanprotocol.com/rewards/df-intro#what-are-active-rewards) if the assets you've curated have Data consume Volume(DCV).
Yes, you will receive [Active Rewards from Volume DF](df-intro#what-are-active-rewards) if the assets you've curated have Data consume Volume(DCV).
</details>
@ -288,7 +288,7 @@ When it comes to active staking, you aren't exposed to additional risks. Your ve
As with any system, inherent risks exist. In terms of the liquidity you provide, rest assured that we have implemented battle-tested contracts, protecting assets worth billions, including veCRV. With this model, there is no liquidity risk, and you are shielded from losing your OCEAN due to Impermanent Loss (IL); your OCEAN tokens are held securely in lock.
More info [here](https://docs.oceanprotocol.com/user-guides/data-farming).
More info [here](user-guides/how-to-volumedf.md).
</details>

View File

@ -8,30 +8,30 @@ description: Show you can complete all User-Guides as the last steps to master D
### Get Started
Our [User Guides](../user-guides/data-farming/README.md) get you started on Data Farming quickly so you can complete all operations. Follow these guides to get a complete handle on all Data Farming activities.
Our [User Guides](user-guides/README.md) get you started on Data Farming quickly so you can complete all operations. Follow these guides to get a complete handle on all Data Farming activities.
{% content-ref url="../user-guides/data-farming/how-to-veocean.md" %}
[data-farming/how-to-veocean.md](../user-guides/data-farming/how-to-veocean.md)
{% content-ref url="user-guides/how-to-veocean.md" %}
[data-farming/how-to-veocean.md](user-guides/how-to-veocean.md)
{% endcontent-ref %}
{% content-ref url="../user-guides/data-farming/how-to-estimate-apy.md" %}
[../user-guides/data-farming/how-to-data-farm-volumedf.md](../user-guides/data-farming/how-to-estimate-apy.md)
{% content-ref url="user-guides/how-to-estimate-apy.md" %}
[user-guides/how-to-data-farm-volumedf.md](user-guides/how-to-estimate-apy.md)
{% endcontent-ref %}
{% content-ref url="../user-guides/data-farming/how-to-claim-rewards.md" %}
[../user-guides/data-farming/how-to-claim-rewards.md](../user-guides/data-farming/how-to-claim-rewards.md)
{% content-ref url="user-guides/how-to-claim-rewards.md" %}
[user-guides/how-to-claim-rewards.md](user-guides/how-to-claim-rewards.md)
{% endcontent-ref %}
{% content-ref url="../user-guides/data-farming/how-to-volumedf.md" %}
[../user-guides/data-farming/how-to-volumedf.md](../user-guides/data-farming/how-to-volumedf.md)
{% content-ref url="user-guides/how-to-volumedf.md" %}
[user-guides/how-to-volumedf.md](user-guides/how-to-volumedf.md)
{% endcontent-ref %}
{% content-ref url="../user-guides/data-farming/how-to-delegate.md" %}
[../user-guides/data-farming/how-to-delegate.md](../user-guides/data-farming/how-to-delegate.md)
{% content-ref url="user-guides/how-to-delegate.md" %}
[user-guides/how-to-delegate.md](user-guides/how-to-delegate.md)
{% endcontent-ref %}
{% content-ref url="../user-guides/data-farming/how-to-challengedf.md" %}
[../user-guides/data-farming/how-to-challengedf.md](../user-guides/data-farming/how-to-challengedf.md)
{% content-ref url="user-guides/how-to-challengedf.md" %}
[user-guides/how-to-challengedf.md](user-guides/how-to-challengedf.md)
{% endcontent-ref %}
### Not much of a reader? Watch and learn, friend

View File

@ -36,7 +36,7 @@ veOCEAN holders can generate yield completely passively if they wish, though the
<figure><img src="../.gitbook/assets/gif/passive-income.gif" alt=""><figcaption></figcaption></figure>
[To start getting passive rewards, go here.](../user-guides/data-farming/how-to-veocean.md)
[To start getting passive rewards, go here.](user-guides/how-to-veocean.md)
### What are Active Rewards?
@ -65,7 +65,7 @@ Rewards are paid in OCEAN to contributors actively working to improve Ocean Prot
[Volume DF](df-volumedf.md#allocating-veocean) rewards Data Farmers that allocate their veOCEAN tokens 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/data-farming/how-to-volumedf.md).
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).
@ -73,7 +73,7 @@ Volume DF rewards are governed and defined by the [Reward Function](df-intro.md#
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/data-farming/how-to-estimate-apy.md) user guide, calculate a reward schedule, and compare your lock up period with others.
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
@ -81,13 +81,13 @@ You can find the [how to estimate APY](../user-guides/data-farming/how-to-estima
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/data-farming/how-to-volumedf.md#) here.
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/data-farming/how-to-challengedf.md).
You can visit the follow tutorial learn how to [access Challenge DF](user-guides/how-to-challengedf.md).
### What is Predictoor DF

View File

@ -76,7 +76,7 @@ Here are some good mental models to improve the outcome of your APY.
1. APYs are always calculated by dividing the amount of OCEAN received from rewards, by the relative amount of OCEAN locked up.
1. As a rule: _wherever APYs are provided to the user in the app (df.oceandao.org), they are caclulated assuming an initial 4-year lock up period with a weekly schedule of compounding rewards into an updated 4-year lock. This estimate works provided current: number of users, reward emissions, and other reward parameters stay constant while excluding all tx fees._
To help you more easily understand APYs, we have provided a couple of examples in the [how to estimate APY](../user-guides/data-farming/how-to-estimate-apy.md) user guide so you can visualize different setups and their relative yields.
To help you more easily understand APYs, we have provided a couple of examples in the [how to estimate APY](user-guides/how-to-estimate-apy.md) user guide so you can visualize different setups and their relative yields.
### Replenishing your veOCEAN

View File

@ -46,7 +46,7 @@ The Data Farming dApp [Delegate Page](https://df.oceandao.org/delegate) lets you
Whatever your scenario, there may be some risk to delegating because the rewards generated will be sent to the person you delegated to. **It's their responsibility to return those rewards back to you if that's the agreement you both made.**
The guide on [how to Delegate](../user-guides/data-farming/how-to-delegate.md) shows how to provide another wallet with 100% of your allocation power.
The guide on [how to Delegate](user-guides/how-to-delegate.md) shows how to provide another wallet with 100% of your allocation power.
### What are Publisher Rewards?