mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
Merge branch 'main' into Wanderclyffex-patch-2
# Conflicts: # discover/faq.md
This commit is contained in:
Ana Loznianu
commit
8c1df8a188
@ -61,14 +61,23 @@ 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
|
||||
rewards/veOcean-Data-Farming-Tutorial: user-guides/data-farming/how-to-veocean.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
|
||||
api-references/provider-rest-api: developers/provider/general-endpoints.md
|
||||
user-guides/claim-ocean-rewards: user-guides/data-farming/how-to-claim-ocean-rewards.md
|
||||
user-guides/get-started-df: user-guides/data-farming/how-to-veocean.md
|
||||
user-guides/how-to-data-farm: user-guides/data-farming/how-to-volume-df.md
|
||||
user-guides/how-to-df-estimate-apy: user-guides/data-farming/how-to-estimate-apy.md
|
||||
user-guides/claim-ocean-rewards: rewards/user-guides/how-to-claim-rewards.md
|
||||
user-guides/get-started-df: rewards/user-guides/how-to-veocean.md
|
||||
user-guides/how-to-veocean: rewards/user-guides/how-to-veocean.md
|
||||
user-guides/how-to-claim-rewards: rewards/user-guides/how-to-claim-rewards.md
|
||||
user-guides/how-to-data-farm: rewards/user-guides/how-to-volumedf.md
|
||||
user-guides/data-farming/how-to-volume-df: rewards/user-guides/how-to-volumedf.md
|
||||
user-guides/data-farming/how-to-df-estimate-apy: rewards/user-guides/how-to-estimate-apy.md
|
||||
user-guides/data-farming/how-to-estimate-apy: rewards/user-guides/how-to-estimate-apy.md
|
||||
user-guides/data-farming/how-to-challengedf: rewards/user-guides/how-to-challengedf.md
|
||||
user-guides/data-farming/how-to-delegate: rewards/user-guides/how-to-delegate.md
|
||||
user-guides/data-farming/README: rewards/user-guides/README.md
|
||||
rewards/df-basic: rewards/df-guides.md
|
||||
rewards/veocean: rewards/df-veocean.md
|
||||
rewards/df-max-out-yield: rewards/df-volumedf.md
|
||||
rewards/df-guides.md: rewards/user-guides/README.md
|
||||
BIN
.gitbook/assets/cover/predictoor_banner.jpg
Normal file
BIN
.gitbook/assets/cover/predictoor_banner.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 129 KiB |
BIN
.gitbook/assets/cover/predictoor_card.jpg
Normal file
BIN
.gitbook/assets/cover/predictoor_card.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 13 KiB |
BIN
.gitbook/assets/predictoor/ai-dao.png
Normal file
BIN
.gitbook/assets/predictoor/ai-dao.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 802 KiB |
BIN
.gitbook/assets/predictoor/details_on_predictoor.png
Normal file
BIN
.gitbook/assets/predictoor/details_on_predictoor.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 260 KiB |
BIN
.gitbook/assets/predictoor/predictoor_behavior.png
Normal file
BIN
.gitbook/assets/predictoor/predictoor_behavior.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 356 KiB |
BIN
.gitbook/assets/predictoor/predictoor_overview.png
Normal file
BIN
.gitbook/assets/predictoor/predictoor_overview.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 210 KiB |
BIN
.gitbook/assets/predictoor/predictoor_splash.png
Normal file
BIN
.gitbook/assets/predictoor/predictoor_splash.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 308 KiB |
BIN
.gitbook/assets/predictoor/predictoor_structure.png
Normal file
BIN
.gitbook/assets/predictoor/predictoor_structure.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 206 KiB |
BIN
.gitbook/assets/predictoor/predictoor_ui.png
Normal file
BIN
.gitbook/assets/predictoor/predictoor_ui.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 145 KiB |
BIN
.gitbook/assets/predictoor/progression_of_a_predictoor.png
Normal file
BIN
.gitbook/assets/predictoor/progression_of_a_predictoor.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 583 KiB |
BIN
.gitbook/assets/predictoor/progression_of_a_trader.png
Normal file
BIN
.gitbook/assets/predictoor/progression_of_a_trader.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 376 KiB |
BIN
.gitbook/assets/predictoor/simulated_returns_btc_tusd.png
Normal file
BIN
.gitbook/assets/predictoor/simulated_returns_btc_tusd.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 108 KiB |
BIN
.gitbook/assets/predictoor/simulated_returns_btc_usdt.png
Normal file
BIN
.gitbook/assets/predictoor/simulated_returns_btc_usdt.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 71 KiB |
BIN
.gitbook/assets/predictoor/value_creation_loop.png
Normal file
BIN
.gitbook/assets/predictoor/value_creation_loop.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 108 KiB |
87
README.md
87
README.md
@ -7,4 +7,89 @@ layout: landing
|
||||
|
||||
# 👋 Welcome
|
||||
|
||||
<table data-view="cards"><thead><tr><th data-type="content-ref"></th><th></th><th data-hidden data-type="files"></th><th data-hidden data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><a href="discover/">discover</a></td><td>Learn how Ocean Protocol transforms data sharing and monetization with its powerful Web3 open source tools.</td><td></td><td></td><td><a href="discover/">discover</a></td><td><a href=".gitbook/assets/cover/discover_card.png">discover_card.png</a></td></tr><tr><td><a href="user-guides/">user-guides</a></td><td>Follow our step-by-step instructions for a no-code solution to unleash the power of Ocean Protocol technologies!</td><td></td><td></td><td><a href="user-guides/">user-guides</a></td><td><a href=".gitbook/assets/cover/user_guides_card.png">user_guides_card.png</a></td></tr><tr><td><a href="developers/">developers</a></td><td>Find APIs, libraries, and other tools to build awesome dApps or integrate with the Ocean Protocol ecosystem.</td><td></td><td></td><td><a href="developers/">developers</a></td><td><a href=".gitbook/assets/cover/developer_card.png">developer_card.png</a></td></tr><tr><td><a href="data-science/">data-science</a></td><td>We invite and engage all data scientists and machine learning specialists to discover Ocean Protocol.</td><td></td><td></td><td><a href="data-science/">data-science</a></td><td><a href=".gitbook/assets/cover/data_science_card.png">data_science_card.png</a></td></tr><tr><td><a href="infrastructure/">infrastructure</a></td><td>For software architects and developers - deploy your own components on the Ocean Protocol network.</td><td></td><td></td><td><a href="infrastructure/">infrastructure</a></td><td><a href=".gitbook/assets/cover/infrastructure_card.png">infrastructure_card.png</a></td></tr><tr><td><a href="defi/">defi</a></td><td>Get creative capitalizing with Ocean Protocol tools in a variety of DeFi (Decentralized Finance) applications.</td><td></td><td></td><td><a href="defi/">defi</a></td><td><a href=".gitbook/assets/cover/defi_card.png">defi_card.png</a></td></tr><tr><td><a href="rewards/">rewards</a></td><td>Explore how you can earn OCEAN rewards by Data Farming and publishing your assets on the Ocean Market.</td><td></td><td></td><td><a href="rewards/">rewards</a></td><td><a href=".gitbook/assets/cover/rewards_card.png">rewards_card.png</a></td></tr><tr><td><a href="contribute/">contribute</a></td><td>Get involved and make a difference! Learn how you can contribute to the growth and development of Ocean Protocol.</td><td></td><td></td><td><a href="contribute/">contribute</a></td><td><a href=".gitbook/assets/cover/contribute_card.png">contribute_card.png</a></td></tr></tbody></table>
|
||||
<table data-view="cards">
|
||||
<thead>
|
||||
<tr>
|
||||
<th data-type="content-ref"></th>
|
||||
<th></th>
|
||||
<th data-hidden data-type="files"></th>
|
||||
<th data-hidden data-type="files"></th>
|
||||
<th data-hidden data-card-target data-type="content-ref"></th>
|
||||
<th data-hidden data-card-cover data-type="files"></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a href="discover/">discover</a></td>
|
||||
<td>Learn how Ocean Protocol transforms data sharing and monetization with its powerful Web3 open source tools.</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td><a href="discover/">discover</a></td>
|
||||
<td><a href=".gitbook/assets/cover/discover_card.png">discover_card.png</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="user-guides/">user-guides</a></td>
|
||||
<td>Follow our step-by-step instructions for a no-code solution to unleash the power of Ocean Protocol technologies!</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td><a href="user-guides/">user-guides</a></td>
|
||||
<td><a href=".gitbook/assets/cover/user_guides_card.png">user_guides_card.png</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="developers/">developers</a></td>
|
||||
<td>Find APIs, libraries, and other tools to build awesome dApps or integrate with the Ocean Protocol ecosystem.</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td><a href="developers/">developers</a></td>
|
||||
<td><a href=".gitbook/assets/cover/developer_card.png">developer_card.png</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="data-science/">data-science</a></td>
|
||||
<td>We invite and engage all data scientists and machine learning specialists to discover Ocean Protocol.</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td><a href="data-science/">data-science</a></td>
|
||||
<td><a href=".gitbook/assets/cover/data_science_card.png">data_science_card.png</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="infrastructure/">infrastructure</a></td>
|
||||
<td>For software architects and developers - deploy your own components on the Ocean Protocol network.</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td><a href="infrastructure/">infrastructure</a></td>
|
||||
<td><a href=".gitbook/assets/cover/infrastructure_card.png">infrastructure_card.png</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="defi/">defi</a></td>
|
||||
<td>Get creative capitalizing with Ocean Protocol tools in a variety of DeFi (Decentralized Finance) applications.</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td><a href="defi/">defi</a></td>
|
||||
<td><a href=".gitbook/assets/cover/defi_card.png">defi_card.png</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="predictoor/">predictoor</a></td>
|
||||
<td>Learn about Predictoor and how to make money with data science or by improve your trading edge with accurate signals.</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td><a href="predictoor/">predictoor</a></td>
|
||||
<td><a href=".gitbook/assets/cover/predictoor_card.jpg">predictoor_card.jpg</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="rewards/">rewards</a></td>
|
||||
<td>Explore how you can earn OCEAN rewards by Data Farming and publishing your assets on the Ocean Market.</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td><a href="rewards/">rewards</a></td>
|
||||
<td><a href=".gitbook/assets/cover/rewards_card.png">rewards_card.png</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="contribute/">contribute</a></td>
|
||||
<td>Get involved and make a difference! Learn how you can contribute to the growth and development of Ocean Protocol.</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td><a href="contribute/">contribute</a></td>
|
||||
<td><a href=".gitbook/assets/cover/contribute_card.png">contribute_card.png</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
42
SUMMARY.md
42
SUMMARY.md
@ -28,13 +28,6 @@
|
||||
- [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)
|
||||
- [Liquidity Pools \[deprecated\]](user-guides/remove-liquidity-pools.md)
|
||||
- [💻 Developers](developers/README.md)
|
||||
- [Architecture Overview](developers/architecture.md)
|
||||
@ -123,14 +116,27 @@
|
||||
- [Deploying C2D](infrastructure/compute-to-data-minikube.md)
|
||||
- [C2D - Private Docker Registry](infrastructure/compute-to-data-docker-registry.md)
|
||||
- [🤑 DeFi](defi/README.md)
|
||||
- [💰 Data Farming Rewards](rewards/README.md)
|
||||
- [Farming 101](rewards/df-intro.md)
|
||||
- [veOCEAN](rewards/df-veocean.md)
|
||||
- [Curate with Volume DF](rewards/df-volumedf.md)
|
||||
- [Predict with Challenge DF](rewards/df-challengedf.md)
|
||||
- [Complete User Guides](rewards/df-guides.md)
|
||||
- [Emissions & APYs](rewards/df-emissions-apys.md)
|
||||
- [🤝 Contribute](contribute/README.md)
|
||||
- [Partners & Collaborators](contribute/projects-using-ocean.md)
|
||||
- [Contributor Code of Conduct](contribute/code-of-conduct.md)
|
||||
- [Legal Requirements](contribute/legal-reqs.md)
|
||||
* [👀 Predictoor](predictoor/README.md)
|
||||
* [Introduction](predictoor/pdr-intro.md)
|
||||
* [Architecture](predictoor/pdr-architecture.md)
|
||||
* [Parameters](predictoor/pdr-parameters.md)
|
||||
* [How to Earn](predictoor/pdr-earn.md)
|
||||
* [Predictoor FAQ](predictoor/pdr-faq.md)
|
||||
* [💰 Data Farming Rewards](rewards/README.md)
|
||||
* [Data Farming 101](rewards/df-intro.md)
|
||||
* [veOCEAN](rewards/df-veocean.md)
|
||||
* [Curate with Volume DF](rewards/df-volumedf.md)
|
||||
* [Predict with Challenge DF](rewards/df-challengedf.md)
|
||||
* [Emissions & APYs](rewards/df-emissions-apys.md)
|
||||
* [veOCEAN & DF FAQ](rewards/df-faq.md)
|
||||
- [📖 DF User Guides](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)
|
||||
* [🤝 Contribute](contribute/README.md)
|
||||
* [Partners & Collaborators](contribute/projects-using-ocean.md)
|
||||
* [Contributor Code of Conduct](contribute/code-of-conduct.md)
|
||||
* [Legal Requirements](contribute/legal-reqs.md)
|
||||
|
||||
@ -10,6 +10,14 @@ coverY: 0
|
||||
|
||||
Ocean Protocol's open-source tools are useful in a variety of DeFi applications. Here we show you how to capitalize with Ocean Protocol tech in several ways using crypto trading!
|
||||
|
||||
## Predictoor
|
||||
|
||||
Whether creating data feeds for the daily price of BTC-USD on Binance, or the ice level in Antartica, Predictoor offers a tech stack for data scientists to earn rewards from future predictions.
|
||||
|
||||
A tech stack that empowers traders and analysts to improve the performance of their algorithmic models when making valuable decisions.
|
||||
|
||||
Read more about [Predictoor here](../predictoor/README.md) and start earning today.
|
||||
|
||||
## Data Farming - Challenge DF 📈
|
||||
|
||||
Data Farming offers a weekly rewards via [Challenge DF](../rewards/df-challengedf.md), a challenge where users predict the price of Ethereum and win prizes 💰 based on accuracy.
|
||||
|
||||
@ -6,7 +6,7 @@ The process of consuming an asset is straightforward. To achieve this, you only
|
||||
npm run cli download 'assetDID' 'download-location-path'
|
||||
```
|
||||
|
||||
In this command, replace `assetDID`` with the specific DID of the asset you want to consume, and `download-location-path`` with the desired path where you wish to store the downloaded asset content
|
||||
In this command, replace `assetDID` with the specific DID of the asset you want to consume, and `download-location-path` with the desired path where you wish to store the downloaded asset content
|
||||
|
||||
Once executed, this command orchestrates both the **ordering** of a [datatoken](../contracts/datatokens.md) and the subsequent download operation. The asset's content will be automatically retrieved and saved at the specified location, simplifying the consumption process for users.
|
||||
|
||||
|
||||
@ -7,7 +7,7 @@ To get started with the Ocean CLI, follow these steps for a seamless setup:
|
||||
Begin by cloning the repository. You can achieve this by executing the following command in your terminal:
|
||||
|
||||
```bash
|
||||
$ git clone https://github.com/oceanprotocol/ocean.js-cli.git
|
||||
$ git clone https://github.com/oceanprotocol/ocean-cli.git
|
||||
```
|
||||
|
||||
Cloning the repository will create a local copy on your machine, allowing you to access and work with its contents.
|
||||
@ -37,7 +37,7 @@ To successfully configure the CLI tool, two essential steps must be undertaken:
|
||||
|
||||
### Private Key Configuration
|
||||
|
||||
The CLI tool necessitates the configuration of the account's private key. This private key serves as the means by which the CLI tool establishes a connection to the associated wallet. It plays a crucial role in authenticating and authorizing operations performed by the tool.
|
||||
The CLI tool requires the configuration of the account's private key. This private key serves as the means by which the CLI tool establishes a connection to the associated wallet. It plays a crucial role in authenticating and authorizing operations performed by the tool.
|
||||
|
||||
```bash
|
||||
export MNEMONIC="XXXX"
|
||||
@ -50,7 +50,7 @@ Additionally, it is imperative to specify the RPC endpoint that corresponds to t
|
||||
export RPC='XXXX'
|
||||
```
|
||||
|
||||
Furthermore, there are additional environment variables that can be configured to enhance the flexibility and customization of the environment. These variables include options such as the metadataCache URL and Provider URL, which can be specified if you prefer to utilize a custom deployment of Aquarius or Provider in contrast of the default settings. Moreover, you have the option to provide a custom address file path if you wish to use customized smart contracts or deployments for your specific use case. Remeber setting the next envariament variables is optional.
|
||||
Furthermore, there are additional environment variables that can be configured to enhance the flexibility and customization of the environment. These variables include options such as the metadataCache URL and Provider URL, which can be specified if you prefer to utilize a custom deployment of Aquarius or Provider in contrast to the default settings. Moreover, you have the option to provide a custom address file path if you wish to use customized smart contracts or deployments for your specific use case. Remember setting the next environment variables is optional.
|
||||
|
||||
```bash
|
||||
export AQUARIUS_URL='XXXX'
|
||||
|
||||
@ -4,7 +4,7 @@ In the Ocean Protocol ecosystem, each asset is associated with a state that is m
|
||||
|
||||
By assigning specific states to assets, Ocean Protocol enables a structured approach to asset management and visibility. These states help regulate asset discoverability, ordering permissions, and the representation of assets in user profiles, ensuring a controlled and reliable asset ecosystem.
|
||||
|
||||
It is possible to remove assets from Ocean Protocol by modifying the state of the asset. Each asset has a state, which is stored in the NFT contract. Additional details regarding asset states can be found at this [link](../ddo-specification.md#state). There is also an assets purgatory that contains information about the purgatory status of an asset, as defined in the list-purgatory. For more information about the purgatory, please refer to: [https://docs.oceanprotocol.com/core-concepts/did-ddo#purgatory](https://docs.oceanprotocol.com/core-concepts/did-ddo#purgatory).
|
||||
It is possible to remove assets from Ocean Protocol by modifying the state of the asset. Each asset has a state, which is stored in the NFT contract. Additional details regarding asset states can be found at this [link](../ddo-specification.md#state). There is also an assets purgatory that contains information about the purgatory status of an asset, as defined in the list-purgatory. For more information about the purgatory, please refer to the [DID and DDO Identifier docs](/developers/identifiers.md).
|
||||
|
||||
We can utilize a portion of the previous tutorial on updating metadata and incorporate the steps to update the asset's state in the asset DDO.
|
||||
|
||||
|
||||
@ -75,4 +75,4 @@ node create_dataNFT.js
|
||||
* Checkout our [code examples](https://github.com/oceanprotocol/ocean.js/blob/main/CodeExamples.md#L0-L1) or [compute to data examples](https://github.com/oceanprotocol/ocean.js/blob/main/ComputeExamples.md#L417) to see how you can use ocean.js.
|
||||
* If you have any difficulties or if you have further questions about how to use ocean.js please reach out to us on [Discord](https://discord.gg/TnXjkR5).
|
||||
* If you notice any bugs or issues with ocean.js please [open an issue on github](https://github.com/oceanprotocol/ocean.js/issues/new?assignees=\&labels=bug\&template=bug\_report.md\&title=).
|
||||
* Visit the [Ocean Protocol website](https://docs.oceanprotocol.com/) for general information about Ocean Protocol.
|
||||
* Visit the [Ocean Protocol website](https://oceanprotocol.com/) for general information about Ocean Protocol.
|
||||
|
||||
@ -42,7 +42,7 @@ print(f"DATA_ddo did = '{DATA_ddo.did}'")
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
To customise the privacy and accessibility of your compute service, add the `compute_values` argument to `create_url_asset` to set values according to the [DDO specs](https://docs.oceanprotocol.com/core-concepts/did-ddo). The function assumes the documented defaults.
|
||||
To customise the privacy and accessibility of your compute service, add the `compute_values` argument to `create_url_asset` to set values according to the [DDO specs](/developers/identifiers.md). The function assumes the documented defaults.
|
||||
|
||||
### 2. Alice publishes an algorithm
|
||||
|
||||
|
||||
@ -66,7 +66,7 @@ Ocean.py follows the exact `id` name for the network's name from the default Bro
|
||||
|
||||
#### 1.4 Networks Supported
|
||||
|
||||
All [Ocean-deployed](https://docs.oceanprotocol.com/core-concepts/networks) chains (Eth mainnet, Polygon, etc) should be in Brownie's default `network-config.yaml` except Energy Web Chain (EWC).
|
||||
All [Ocean-deployed](../../discover/networks/README.md) chains (Eth mainnet, Polygon, etc) should be in Brownie's default `network-config.yaml` except Energy Web Chain (EWC).
|
||||
|
||||
For Windows users: it's possible that your `network-config.yaml` doesn't have all the network entries. In this case, just replace your local file's content with the `network-config.yaml` in Brownie's GitHub repo, [here](https://github.com/eth-brownie/brownie/blob/master/brownie/data/network-config.yaml).
|
||||
|
||||
|
||||
59
predictoor/README.md
Normal file
59
predictoor/README.md
Normal file
@ -0,0 +1,59 @@
|
||||
---
|
||||
description: Tomorrow belongs to those who can hear it coming. — David Bowie
|
||||
cover: ../.gitbook/assets/cover/predictoor_banner.jpg
|
||||
coverY: 0
|
||||
---
|
||||
|
||||
# Summary
|
||||
We dream of a world of 10,000 truly accurate prediction feeds, for everything from rain forecasts to sea level rise, or traffic congestion to ETH price. [Ocean Predictoor](https://predictoor.ai/) is an on-chain, privacy-enabled, AI-powered application and stack that is bringing this dream to reality.
|
||||
|
||||
**Accurate predictions are valuable.** With them, one can take action and create value. Conversely, inaccurate predictions lead to disaster. Predictions have value because they're the [final step in a data supply chain](https://blog.oceanprotocol.com/the-data-value-creation-loop-68e23575be02), right before action is taken by the user.
|
||||
|
||||
**Prediction feeds** are a stream of predictions for a given time series. This could be predicting the price of ETH every 5 minutes, or the sea temperature daily. A feed may be binary, i.e. whether a time series changes up or down: ↑↓↓↓↑↓↑↑. Accurate prediction feeds are valuable.
|
||||
|
||||
Alas, accurate predictions are *hard*. Worse, typical prediction feeds have no accountability on accuracy. If the weatherman says "no rain for today" and then it rains, a farmer could get stuck in the mud, wrecking a portion of his crops. The weatherman doesn't feel the impact of wrong predictions, but the farmers sure care!
|
||||
|
||||
**Accountable Predictions** - Imagine if there was accountability. Accuracy would go up; the farmer would be stuck less. Imagine accountable prediction feeds for not only for rain, but also wind, sea temperature, road congestion, train delays, ETH prices, NVID prices, housing prices, and more. **Imagine tens of thousands of prediction feeds with accountable accuracy.** Imagine them **globally distributed**, and censorship resistant. Imagine **accuracy improving with time**.
|
||||
|
||||
## Introduction
|
||||
Ocean Predictoor is a stack and a dapp for prediction feeds. It has accountability for accuracy, via staking. It’s globally distributed and censorship-resistant, by being on-chain. We expect its accuracy to improve over time, due to its incentive structure. Its first use case is DeFi token prediction because users can close the data value-creation loop quickly to make tangible \$.
|
||||
|
||||
Predictoor is composed of different actors, often referred to as: predictoors and traders. You will learn in the [Predictoor Introduction](pdr-intro.md) page, you will out more about these actors, how they are structured in the system, and their behaviors. By the time you've completed reading this, you'll know what Epochs are, and have a better understand of what "t+1" means.
|
||||
|
||||
## Architecture
|
||||
After obtaining a broad overview of the system and its actors, you should be ready to dive into [The Architecture of Predictoor](pdr-architecture.md) and the [pdr-backend repo](https://github.com/oceanprotocol/pdr-backend). You'll become more exposed to the key building blocks and pdr-backend, the integration component for Predictoors and Traders.
|
||||
|
||||
We anticipate Predictoor to extend beyond DeFi to other verticals like climate and agriculture. Predictoor agents may evolve into AI DAOs with emergent swarm-like behavior. This is the future.
|
||||
|
||||
## Earning with Predictoor
|
||||
Predictoor serves two groups of actors: Predictoors, and Traders. In this section, we'll explore [How to Earn with Predictoor](pdr-earn.md) and describe how both of these groups can benefit from it. After you are done with this, you should know what steps you need to take next in order to start leveraging the system for your own benefit.
|
||||
|
||||
We'll also provide some links and exercise to make this easier for you.
|
||||
|
||||
## Predictoor Parameters
|
||||
The [Predictoor Parameters page](pdr-parameters.md) will provide you with details on many topics such as incentives, feed costs, and deployed feeds.
|
||||
|
||||
You can find details about Oasis, Testnet, Mainnet, and how to bridge your OCEAN here.
|
||||
|
||||
## FAQ
|
||||
|
||||
The [FAQ page](pdr-faq.md) has frequently asked questions about Predictoor.
|
||||
|
||||
## Connect with Us
|
||||
If you want to talk to other Predictoors, Traders, and contributors to this ecosystem, [join us on Discord](https://discord.gg/TnXjkR5).
|
||||
|
||||
## Predictoor Resources
|
||||
|
||||
Main:
|
||||
- Mainnet webapp: [predictoor.ai](https://predictoor.ai). Testnet: [test.predictoor.ai](https://test.predictoor.ai)
|
||||
- Run bots via [pdr-backend](https://github.com/oceanprotocol/pdr-backend) repo
|
||||
|
||||
Intro:
|
||||
- _These_ docs are the best starting point to learn about Predictoor:)
|
||||
- Original blogpost "Meet Predictoor", Sep 12, 2023 [[Link](https://blog.oceanprotocol.com/meet-predictoor-accountable-accurate-prediction-feeds-8b104d26a5d9)]
|
||||
- Original talk "Introducing Prediction Feeds", Dappcon, Sep 12, 2023 [[Video](https://www.youtube.com/live/ev76qrunCn4?si=a6dw_qCgw3F3070y&t=24393)][[GSlides](https://docs.google.com/presentation/d/118tBnWNbzuq6vL1TITGq69RKPvHWbxVUZULp8KnfPyQ/edit#slide=id.g243aace1a9a_0_681)][[PDF](https://drive.google.com/drive/folders/1ekNmB1LcS81xfJ6ntZpzibi3PF6QFwFR)]
|
||||
|
||||
For thoroughness:
|
||||
- All blog posts & media: ["Ocean Predictoor Series"](https://blog.oceanprotocol.com/ocean-predictoor-series-6a9122754a4d)
|
||||
- Webapp code is at [pdr-web](https://github.com/oceanprotocol/pdr-web/) repo
|
||||
|
||||
40
predictoor/pdr-architecture.md
Normal file
40
predictoor/pdr-architecture.md
Normal file
@ -0,0 +1,40 @@
|
||||
---
|
||||
description: >-
|
||||
"It was never easy to look into the future, but it is possible and we should not miss our chance." — Andrei Linde
|
||||
---
|
||||
|
||||
# Predictoor Architecture
|
||||
|
||||
## Privacy and Oasis Sapphire
|
||||
Predictoor needs privacy for:
|
||||
- Submitted predictions
|
||||
- Compute aggregate predictions; and
|
||||
- Aggregated predictions — only subscribers can see
|
||||
|
||||
This could all be done on fully-centralized infrastructure. But doing so would fail on our other goals: **being globally distributed, censorship resistant, and non-custodial**.
|
||||
|
||||
Targeting these needs, we researched & prototyped many privacy technologies. [Oasis Sapphire](https://oasisprotocol.org/sapphire) emerged as the best choice because, as the only privacy-preserving EVM chain in production, it could handle these needs cleanly end-to-end.
|
||||
|
||||
## Software Implementation
|
||||
Most of [predictoor.ai](https://predictoor.ai) dapp is implemented in the [pdr-web repo](https://github.com/oceanprotocol/pdr-web), with help from [pdr-websocket](https://github.com/oceanprotocol/pdr-websocket/) to fetch feed data and [Ocean Aquarius](https://github.com/oceanprotocol/aquarius) for metadata caching.
|
||||
|
||||
The template Predictoor bots, trader bots, trueval bot, and prediction feed publishing are all in the [pdr-backend repo](https://github.com/oceanprotocol/pdr-backend). Contracts are in the Ocean [contracts](https://github.com/oceanprotocol/contracts) repo.
|
||||
|
||||
Events emitted by contracts are indexed as Ocean subgraphs, to be consumed by predictoor.ai and the bots. The backend [subgraph README](https://github.com/oceanprotocol/pdr-backend/blob/main/READMEs/subgraph.md) has more info.
|
||||
|
||||
## Backend & Contract Details
|
||||
The section [Predictoor Structure](pdr-intro.md) presented much of the Predictoor architecture.
|
||||
|
||||
The image below adds detail around the backend (bottom 1/3 of diagram). Let’s discuss.
|
||||
|
||||
<figure><img src="../.gitbook/assets/predictoor/details_on_predictoor.png" alt=""><figcaption>Details of Predictoor Structure (Architecture)</figcaption></figure>
|
||||
|
||||
**Smart Contracts.** There’s one Predictoor contract for each prediction feed, at each exchange/timescale: BTC/USDT at Binance/5m, ETH/USDT at Binance/5m, and so on. Each contract is an Ocean datatoken contract, with a new template for prediction feeds.
|
||||
|
||||
The implementation is in templates/ERC20Template3.sol at at [Ocean’s contracts repo](https://github.com/oceanprotocol/contracts). It implements ERC20, Ocean, and Predictoor-specific behavior as follows.
|
||||
|
||||
**- ERC20 behavior.** It implements the ERC20 interface and therefore plays well with ERC20-friendly crypto wallets, DEXes, etc.
|
||||
|
||||
**- Ocean behavior.** Being part of Ocean, having 1.0 datatokens means you can access the underlying data asset for the duration of the subscription (once you’ve initiated the order). For Predictoor contracts this is 24h. Each datatoken contract has a parent Ocean data NFT with metadata, means to specify & collect fees, and more.
|
||||
|
||||
**- Predictoor behavior.** Each datatoken contract has additional methods specific to Predictoor: submitting predictions, submitting truevals, computing aggregated predictions, etc.
|
||||
68
predictoor/pdr-earn.md
Normal file
68
predictoor/pdr-earn.md
Normal file
@ -0,0 +1,68 @@
|
||||
# How to Earn
|
||||
|
||||
## How to Earn as a Predictoor
|
||||
If you have background in AI, ML, data science or statistics (and these overlap!) then you’re well suited to become a predictoor to make \$.
|
||||
|
||||
<figure><img src="../.gitbook/assets/predictoor/progression_of_a_predictoor.png" alt=""></figure>
|
||||
|
||||
Typical steps as a Predictoor:
|
||||
1. **Play with predictoor.ai.** Go to [predictoor.ai](https://predictoor.ai) to build intuition: observe the free feed, perhaps buy a few feeds, and watch them change over time.
|
||||
1. **Do Challenge DF: one-off predictions.** Then, practice making accurate AI/ML based predictions via [Challenge Data Farming](https://df.oceandao.org/challenge-df). Submissions are due Wednesdays at midnight, for ETH price predictions 5 min, 10 min, …, 60 min ahead. Every week, 5000 OCEAN prize money is distributed to the three lowest-error submissions.
|
||||
1. **Run a predictoor bot: continuous predictions.** Follow the steps in the [Run a Predictoor Bot README](https://github.com/oceanprotocol/pdr-backend/blob/main/READMEs/predictoor.md). You’ll start by deploying a bot locally that submits a random prediction every 5 minutes. Then you’ll add AI/ML model predictions. Then you’ll do it on a remote testnet staking fake OCEAN. Finally, you’ll do it on mainnet staking real OCEAN.
|
||||
1. **Optimize the bot.** Improve model prediction accuracy via more data and better algorithms. Extend to predict >1 prediction feeds (Predictoor has many). Wash, rinse, repeat.
|
||||
|
||||
The actions as a predictoor give the following ways to earn:
|
||||
* **Feed sales.** At an epoch, sales revenue (minus fees) for that epoch goes to predictoors. It’s distributed pro-rata by stake among the predictoors who predicted the true value correctly. The revenue for an epoch is the fraction of sales, spread uniformly across subscription length. A price of 3 OCEAN, 5m epochs, and 24h (1440m) subscriptions gives a revenue of (# subscribers) * (3 OCEAN) * / (1440m / 5m).
|
||||
* **Stake reshuffling.** At an epoch, incorrect predictoors have their stake slashed. This slashed stake is distributed to the correct predictoors pro-rata on their stake.
|
||||
* **Predictoor DF.** The third phase of Predictoor rollout will have an incentives program that amounts to additional earning for predictoors. 37,000 OCEAN/week rewards.
|
||||
Don’t expect to be 100% accurate in your up/down predictions. Marginally better than 50% might be enough, and be skeptical if you’re greatly above 50%, you probably have a bug in your testing.
|
||||
|
||||
Predictoors can earn even more, via complementary actions:
|
||||
* **[Challenge DF](../rewards/df-intro.md#what-is-challenge-df).** Predict accurately for weekly prizes.
|
||||
|
||||
Every week there’s [150,000 total OCEAN rewards](../rewards/df-intro.md#reward-schedule) for Ocean Data Farming. This will increase in early 2024, and more yet later.
|
||||
|
||||
{% hint style="warning" %}
|
||||
You will lose money as a predictoor if your \$ out exceeds your \$ in. If you have low accuracy you’ll have your stake slashed a lot. Do account for gas fees, compute costs, and more. Everything you do is your responsibility, at your discretion. None of this blog is financial advice.
|
||||
{% endhint %}
|
||||
|
||||
## How to Earn as a Trader
|
||||
|
||||
You can make \$ by buying prediction feeds, and using it as an input — as “alpha” — to your trading approach.
|
||||
|
||||
<figure><img src="../.gitbook/assets/predictoor/progression_of_a_trader.png" alt=""></figure>
|
||||
|
||||
Typical steps as a Trader:
|
||||
1. **Play with dapp, and trade.** First, go to [predictoor.ai](https://test.predictoor.ai/) to build intuition: observe the free feed, perhaps buy a few feeds, and watch them change over time. In a second window, have Binance open. Employ a baseline trading strategy: when a new Predictoor prediction pops in, buy if “↑”, and sell or short if “↓”; exit the position 5 min later.
|
||||
1. **Run a trader bot.** Follow the steps in the [Trader README](https://github.com/oceanprotocol/pdr-backend/blob/main/READMEs/trader.md). You’ll start by deploying a bot locally that follows the baseline trading strategy: when a new Predictoor prediction pops in, it buys if “↑”, and sells if “↓”. Then you’ll do it on a remote testnet with fake tokens. Finally, you’ll do it on mainnet with real tokens on a real exchange.
|
||||
1. **Improve & extend.** Improve trading performance via more sophisticated trading strategies. This is a universe all of its own! Extend to >1 prediction feeds (Predictoor has many). Wash, rinse, repeat.
|
||||
|
||||
The actions as a trader offer a single yet powerful way to earn: **trading revenue.** Buy low and sell high! (And the opposite with shorting)
|
||||
|
||||
Traders can earn even more via a complementary action: **[Volume DF](../rewards/df-intro.md#what-are-active-rewards).**. Lock veOCEAN for OCEAN, then point the veOCEAN to data assets with high DCV. Predictoor feeds are great candidates for high-DCV assets.
|
||||
|
||||
⚠️ You will lose money trading if your \$ out exceeds your \$ in. Do account for trading fees, order book slippage, cost of prediction feeds, and more. Everything you do is your responsibility, at your discretion. None of this blog is financial advice.
|
||||
|
||||
## How to Earn as a Data Farmer
|
||||
|
||||
Even if you’re not active as a predictoor or a trader, you can earn nonetheless.
|
||||
|
||||
* **[Passive DF](../rewards/df-intro.md#what-are-passive-rewards).** By simply locking your OCEAN for veOCEAN, you can earn passive rewards.
|
||||
* **[Volume DF](../rewards/df-intro.md#what-are-active-rewards).** Point the veOCEAN to data assets with high data consume volume (DCV). Predictoor feeds are great candidates for high-DCV assets (Predictoor assets are a good choice).
|
||||
|
||||
## Early Earnings Benchmarks
|
||||
|
||||
Predictoor aims to make it easy for people to make \$ doing predictions (as predictoors), and taking actions against those predictions (as traders).
|
||||
|
||||
Before we started building Predictoor, we first asked: _can we predict ETH (etc) up/down with accuracy?_ Then we conducted intensive AI/ML research towards this question. The results of this investigation were positive 😎. TBH, we were surprised at the degree of market inefficiency.
|
||||
|
||||
Our next question was: _with these predictions, can we make \$ trading?_ Again, we conducted intensive AI/ML research, and again found positive results 😎😎.
|
||||
|
||||
Here we share some results of that research — a glimpse of how deep the rabbit hole goes — to inspire would-be predictoors and traders in their own work. The model was trained on data from January 1, 2021 to June 30, 2023, with simulated results the first 24 days of July 2023. A “baseline” trading strategy was used:
|
||||
|
||||
The image below shows simulated returns as a function of order size, for BTC/USDT on Binance. Duration = 7000 ticks x 5m/tick = 24.3 days of trading. It simulates spread effects. It assumes 0% fees. Note how the size of the order affects the return. This is because BTC/USDT is not very liquid; therefore larger amounts cause slippage.
|
||||
|
||||
Simulated returns vs time of BTC/USDT trading on Binance. Trade size has an impact.
|
||||
The image below has the same experimental setup, but for BTC/USDT pair. The size of the order does not affect the return, because BTC/USDT is more liquid than BTC/USDT.
|
||||
|
||||
<figure><img src="../.gitbook/assets/predictoor/simulated_returns_btc_usdt.png" alt=""><figcaption>Simulated returns vs time of BTC/USDT trading on Binance. Trade size has little impact.</figcaption></figure>
|
||||
143
predictoor/pdr-faq.md
Normal file
143
predictoor/pdr-faq.md
Normal file
@ -0,0 +1,143 @@
|
||||
---
|
||||
title: Predictoor FAQ
|
||||
description: Frequently Asked Questions about Predictoor
|
||||
---
|
||||
|
||||
## Predictoor FAQ
|
||||
|
||||
### Getting Started
|
||||
|
||||
<details>
|
||||
|
||||
<summary>How can users begin experimenting with Predictoor?</summary>
|
||||
|
||||
You can start by playing with [predictoor.ai](https://predictoor.ai), then click "run bots" and go through [Predictoor](https://github.com/oceanprotocol/pdr-backend/blob/main/READMEs/predictoor.md) or [Trader](https://github.com/oceanprotocol/pdr-backend/blob/main/READMEs/trader.md) README. This [blog](https://blog.oceanprotocol.com/meet-predictoor-accountable-accurate-prediction-feeds-8b104d26a5d9#048b) "How to Earn" section has details.
|
||||
|
||||
</details>
|
||||
|
||||
### For Predictoors
|
||||
|
||||
<details>
|
||||
|
||||
<summary>What happens if your prediction is good or bad?</summary>
|
||||
|
||||
If the prediction is wrong, your staked amount on that prediction is going to be slashed and distributed among people who submitted the right predictions.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Is it possible to predict without using bots?</summary>
|
||||
|
||||
Before we answer, please understand that to make decent money, it will take hundreds or thousands of submissions, guided by AI/ML models. So doing this manually would be tedious and error-prone. Therefore a bot is the most practical way. This is why the Predictoor core team has made it easy to run a bot. Here are the getting-started READMEs [Predictoor](https://github.com/oceanprotocol/pdr-backend/blob/main/READMEs/predictoor.md) and [Trader](https://github.com/oceanprotocol/pdr-backend/blob/main/READMEs/trader.md), respectively.
|
||||
|
||||
To the question "Is it possible to predict without a bot", the specific answer is "Yes". Here are the details
|
||||
- Somehow you need to submit an up/down prediction, with OCEAN stake, as a transaction to Sapphire chain. Here are the Possible ways to do such a transaction:
|
||||
- (a) Core team-supplied Python bot
|
||||
- (b) simple Python script
|
||||
- (c) Use "Write Contract" in [Sapphire blockchain explorer](https://explorer.sapphire.oasis.io)
|
||||
- (d) 3rd-party bot that decides to support this
|
||||
- (e) dapp that decides to support this
|
||||
|
||||
</details>
|
||||
|
||||
### For Traders
|
||||
|
||||
<details>
|
||||
|
||||
<summary>How can I trust individual predictions?</summary>
|
||||
|
||||
The most important metric to assess confidence in a prediction is "how much OCEAN have people *staked* on this prediction", both up and down. It's how much they're willing to lose if they're wrong. This metric is not gameable because OCEAN has scarcity. It's "put your money where your mouth is".
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>What factors influence the accuracy of Predictoor? How accurate do you think the predictions will be over time?</summary>
|
||||
|
||||
That's up to Predictoors to figure out! Certainly, historical price information has a huge influence. After that, there are many possibilities: other CEX and DEX data, on-chain data, social media data, GitHub data, news, weather, and more. The [Predictoor README](https://github.com/oceanprotocol/pdr-backend/blob/main/READMEs/predictoor.md) gets you started, using historical price information.
|
||||
|
||||
</details>
|
||||
|
||||
### Price and Rewards
|
||||
|
||||
<details>
|
||||
|
||||
<summary>How is the pricing determined and will it continue to be 3 OCEAN?</summary>
|
||||
|
||||
Pricing is 3 OCEAN for one feed for 24 hours. It will be like that for the near-term future. We can expect price changes and price structure over time, as the Predictoor core team learns what pricing makes sense.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>How do Predictoors benefit from sales? Is there a burn mechanism?</summary>
|
||||
|
||||
20% of prediction feed sales go to OPF. A portion of that is passed on to the Ocean community, including burning.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>How Is Predictoor related to Data Farming?</summary>
|
||||
|
||||
Predictoor is its own dapp, stack, and set of feeds. In addition, the Ocean Data Farming infrastructure is extended to incentivize for activities within Predictoor.
|
||||
|
||||
Starting Nov 9, 2023 via "Predictoor Data Farming", there is 37000 OCEAN (about $10K) and several $K worth of ROSE allocated weekly to Predictoor DF. This will be used to purchase prediction feeds, alongside purchases by traders, etc. 80% of prediction feed sales goes to predictoors themselves.
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
### How is Predictoor different
|
||||
<details>
|
||||
|
||||
<summary>How does Predictoor compare to prediction markets? Like Predictoor, they use $ for accountability.</summary>
|
||||
|
||||
Prediction markets are for one-off predictions like “will Biden win in 2024?” whereas Predictoor-style prediction feeds are for a continuous stream of predictions.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>How does Predictoor compare to Chainlink? Like Predictoor, it has price feeds on-chain.</summary>
|
||||
|
||||
Chainlink provides current prices on-chain, and Predictoor makes predictions for prices in the future.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>How does Predictoor compare to Numerai? Like Predictoor, it crowd-sources predictions, related to trading.</summary>
|
||||
|
||||
They are different:
|
||||
- Numerai takes predictions, then aggregates them and uses them to trade directly. It operates as a hedge fund.
|
||||
- Whereas Predictoor takes predictions, then aggregates them and sells the aggregate. It operates as data feeds.
|
||||
|
||||
Secondary differences:
|
||||
- Numerai focus is tradfi trading, as a hedge fund.
|
||||
- Whereas Predictoor is pure datafeeds, and applies to any vertical. Its first use case is defi trading.
|
||||
- Currently Numerai is mostly centralized.
|
||||
- Whereas Predictoor is decentralized. Predictoor tech may be useful to Numerai to help decentralize
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>How does Predictoor compare to Numerai Signals? People supplying to Numerai Signals don’t get paid out from trading (like the main Numerai product).</summary>
|
||||
|
||||
In Numerai Signals, payout is a function of the submitter’s “originality” compared to other signals. These signals are used as inputs for prediction models in Numerai main product.
|
||||
|
||||
Whereas in Predictoor, payout is a function of the the accuracy of the submitter’s prediction, compared to the true value. These signals are predictions, directly.
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
### Networks
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Will Predictoor become available on other blockchain networks in the future?</summary>
|
||||
|
||||
Predictoor needs to leverage a privacy-preserving EVM chain which is in production. Oasis Sapphire is currently the only such chain.
|
||||
|
||||
</details>
|
||||
56
predictoor/pdr-intro.md
Normal file
56
predictoor/pdr-intro.md
Normal file
@ -0,0 +1,56 @@
|
||||
---
|
||||
description: >-
|
||||
"Yesterday is gone. Tomorrow has not yet come. We have only today. Let us begin." - A mother
|
||||
---
|
||||
|
||||
# Introduction
|
||||
|
||||
**Ocean Predictoor is a stack and a dapp for prediction feeds.** It has accountability for accuracy, via staking. It’s globally distributed and censorship-resistant, by being on-chain. We expect its accuracy to improve over time, due to its incentive structure. Its first use case is DeFi token prediction because users can [close the data value-creation loop](https://blog.oceanprotocol.com/the-data-value-creation-loop-68e23575be02) quickly to make tangible \$.
|
||||
|
||||
<figure><img src="../.gitbook/assets/predictoor/predictoor_overview.png" alt=""><figcaption>Conceptual overview of Predictoor</figcaption></figure>
|
||||
|
||||
**Prediction feeds are crowd-sourced. "Predictoor" agents submit individual predictions and stake on them.** They make money when they're correct and lose money when not. This drives accurate prediction feeds, because only accurate predictoors will be making \$ and sticking around.
|
||||
|
||||
**“Trader” agents buy aggregate predictions,** then use them to take action like buying or selling. The more accurate the predictions, the more easily they make \$, the longer they stick around to keep buying prediction feeds from trading profits.
|
||||
|
||||
**Predictoor is built on the Ocean Protocol stack**, including contracts for tokenized data and middleware to cache metadata. To keep predictions private unless paid for, Predictoor uses Oasis Sapphire privacy-preserving EVM chain.
|
||||
|
||||
**The initial dapp is live at [predictoor.ai](https://predictoor.ai).** It’s for up/down predictions of BTC, ETH, and other tokens’ prices. The dapp helps users build a mental model of Predictoor behavior. Predictoors and traders’ main workflow is to do run predicting / trading bots with the help of the Py SDK. We have seeded Predictoor with bots that have AI/ML models of accuracy comfortably above 50% — a precondition to make \$ trading.
|
||||
|
||||
<figure><img src="../.gitbook/assets/predictoor/predictoor_ui.png" alt=""><figcaption>Screenshot from predictoor.ai</figcaption></figure>
|
||||
|
||||
## Predictoor Structure
|
||||
|
||||
The image below gives an overview of Predictoor structure.
|
||||
|
||||
In the image top left, predictoors, traders, or anyone play with predictoor.ai to build an understanding how predictoor works. One feed is free; the rest are available for purchase. At first, only the free feed is visible. Users can connect their web3 wallet and buy another feed.
|
||||
|
||||
In the image top middle, predictoors graduate to building & deploying Python "Template Predictoor bots" (agents), which submit predictions every 5 minutes. Now, predictoors can see how to make revenue from making predictions, with plenty of room to improve AI/ML modeling accuracy and make more \$.
|
||||
|
||||
<figure><img src="../.gitbook/assets/predictoor/predictoor_structure.png" alt=""><figcaption>Predictoor Structure</figcaption></figure>
|
||||
|
||||
In the image top right, traders graduate from predictoor.ai to building & deploying Python "Template Trader bots" (agents), which grab the latest prediction every 5 minutes, as soon as it's available, then trade using that prediction (and other info). Now, Traders can see how to make \$ from buying predictions, with plenty of room to improve trading strategy and make more \$.
|
||||
|
||||
In the image bottom is the Oasis Sapphire chain, with Predictoor feed contracts deployed to it. There's one contract deployed for each {pair, exchange, timescale} such as {ETH/USDT, Binance, 5m}.
|
||||
|
||||
## Predictoor Behavior
|
||||
|
||||
We just covered Predictoor structure. Let's now layer on some Predictoor behavior, with the help of the image below. We'll walk through actions by Predictoors and Traders related to predictions for time slot "epoch t+1", and show how they make \$.
|
||||
|
||||
We assume predictions on BTC, and where epoch t ends at 5:00pm, t+1 ends 5:05pm, and t+2 ends 5:10pm. We assume that Traders already purchased a subscription via predictoor.ai, Python, or otherwise. When we discuss an action by a Predictoor or Trader, we recognize that it's typically executed by their agent (bot).
|
||||
|
||||
**Epoch t.** This is left 1/3 of the image. It starts at 4:55pm and ends at 5:00pm. Predictoor 1 (pink) predicts that BTC close price for epoch t+1 will be higher ("↑") than close price for epoch t. He submits a tx to that chain with that prediction, and some OCEAN stake of his choice (higher stake = more confident). Predictoor 2 (dark green) does the same. Predictoor 3 (light green) predicts "↓" and stakes. The chain stores these prediction values, privately.
|
||||
|
||||
<figure><img src="../.gitbook/assets/predictoor/predictoor_behavior.png" alt=""><figcaption>Predictoor Behavior</figcaption></figure>
|
||||
|
||||
**Epoch t+1.** The middle 1/3 of the image covers epoch t+1. It starts at 5:00pm and ends at 5:05pm. The BTC Predictoor contract computes the aggregated predicted value (agg_predval) as stake-weighted sum across individual predictions.
|
||||
|
||||
> agg_predval = (stake1 x predval1 + stake2 x predval2 + …) / (stake1 + stake2 + …)
|
||||
|
||||
The contract then makes agg_predval visible to its subscribers. The predicted value is the stake-weighted sum across predictions. Smart traders may take the information and act immediately. A baseline strategy is "if it predicts ↑ then buy; if it predicts ↓ then sell or short".
|
||||
|
||||
**Epoch t+2.** This is the right 1/3 of the image. It starts at 5:05pm and ends at 5:10pm. Both traders and trueval agent take action (and, predictoors get paid).
|
||||
|
||||
- **Actions by Traders.** Typically, traders exit their position immediately, exactly 5 minutes since they got the 5-minute-ahead prediction and acted*. If the prediction feed was accurate enough and trading fees & slippage weren't too high, then the trader makes money on average.
|
||||
|
||||
- **Actions by Trueval agent; predictoors get paid.** The trueval agent is a process that grabs price feeds from e.g. Binance and submits it to chain, inside the smart contract*. The "submit" transaction also takes the opportunity to calculate each Predictoor's reward or slashing, and update their OCEAN holdings in the contract accordingly. (Funds aren't sent per se, they're made available via ERC20 "approve", for the predictoor to transfer at some later point). Predictoor 3 got his OCEAN slashed because he was wrong; predictoors 1 and 2 receive that as income, in addition to receiving income from prediction feed sales to traders. Predictoors can claim their balance anytime.
|
||||
37
predictoor/pdr-parameters.md
Normal file
37
predictoor/pdr-parameters.md
Normal file
@ -0,0 +1,37 @@
|
||||
# Predictoor Parameters
|
||||
|
||||
## Testnet Details
|
||||
As of Sep 12, 2023, Predictoor / Ocean contracts are deployed to [Oasis Sapphire testnet](https://docs.oasis.io/dapp/sapphire/#testnet).
|
||||
|
||||
Users need fake OCEAN & ROSE tokens:
|
||||
**- Fake OCEAN.** Staking & payment is in fake OCEAN. Users acquire it via a faucet. [Here's how](https://github.com/oceanprotocol/pdr-backend/blob/main/READMEs/testnet-faucet.md).
|
||||
**- Fake ROSE.** Gas fees are in fake ROSE. Users acquire it via a faucet. [Here's how](https://github.com/oceanprotocol/pdr-backend/blob/main/READMEs/testnet-faucet.md).
|
||||
|
||||
## Mainnet Details
|
||||
As of Oct 10, 2023, Predictoor / Ocean contracts are deployed to [Oasis Sapphire mainnet](https://docs.oasis.io/dapp/sapphire/#mainnet).
|
||||
|
||||
Users need (real) OCEAN & ROSE tokens:
|
||||
**- OCEAN.** Staking & payment is in OCEAN. [How to get OCEAN on Sapphire](https://github.com/oceanprotocol/pdr-backend/blob/main/READMEs/get-ocean-on-sapphire.md).
|
||||
**- ROSE.** Gas fees are in ROSE. [How to get ROSE on Sapphire](https://github.com/oceanprotocol/pdr-backend/blob/main/READMEs/get-ocean-on-sapphire.md).
|
||||
|
||||
## Feeds Published
|
||||
For testnet, there are 10 feeds: X/USDT pair for each of the top-10 coins by market cap (ignoring stablecoins), 5m timescales, on Binance, >0% fees on Binance. Paid feeds. The coins are: X = BTC, ETH, BNB, XRP, ADA, DOGE, SOL, LTC, TRX, DOT
|
||||
|
||||
For both testnet and mainnet, there are 20 feeds:
|
||||
- X/USDT pair for each of the top-10 coins by market cap (ignoring stablecoins), on Binance, 5m timescales, on Binance. The coins are: X = BTC, ETH, BNB, XRP, ADA, DOGE, SOL, LTC, TRX, DOT
|
||||
- Like above, but for 60m timescales
|
||||
|
||||
## Pricing
|
||||
For each timescale, one feed is free: BTC/UTD on Binance. Below is pricing for the remaining feeds.
|
||||
|
||||
The price to subscribe to one feed for 24 hours is 3.00 OCEAN. This includes all fees. Fee details:
|
||||
- 0.1% community swap fee
|
||||
- 20% fee to Ocean Protocol Foundation. (Will be used to further drive Predictoor, and to burn OCEAN.)
|
||||
- For reference, price without fees is 2.49791840133 OCEAN. To calculate this: Let x = price without fees. Then x * (1 + 0.20 + 0.001) = 3.0 → x = 3.0 / (1 + 0.20 + 0.001) = 2.49791840133
|
||||
|
||||
Pricing is subject to change based on learnings, and feedback from community.
|
||||
|
||||
## Predictoor Data Farming
|
||||
[Ocean Data Farming](https://df.oceandao.org/rewards) (DF) is an incentives program currently with [150K OCEAN rewards](../rewards/df-intro.md#reward-schedule) per week.
|
||||
|
||||
On Nov 9, a reward stream will be introduced to incentivize predictoors. This reward stream will provide 37,000 OCEAN in weekly rewards. You can find more about it in [Data Farming Intro - What are Active Rewards?](../rewards/df-intro.md#what-are-active-rewards)
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
description: Learn how to generate OCEAN rewards by using our Data Farming dApp
|
||||
description: Learn how to earn OCEAN rewards via Data Farming
|
||||
cover: ../.gitbook/assets/cover/rewards_banner.png
|
||||
coverY: 0
|
||||
---
|
||||
@ -20,11 +20,15 @@ We have used battle-tested contracts that safeguard billions (veCRV). With this
|
||||
|
||||
[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.
|
||||
|
||||
## User Guides
|
||||
|
||||
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).
|
||||
|
||||
## veOCEAN
|
||||
|
||||
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
|
||||
|
||||
@ -38,7 +42,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
|
||||
|
||||
@ -58,13 +62,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.
|
||||
|
||||
@ -74,7 +78,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
|
||||
|
||||
@ -84,7 +88,7 @@ Finally, if you want to continue expanding your knowledge on OCEAN token emissio
|
||||
|
||||
[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.
|
||||
|
||||
Our [FAQ](../discover/faq.md) answers many different questions about staking, chains, deployments, and other details that may be valuable to you.
|
||||
Our [FAQ](df-faq.md) answers many different questions about staking, chains, deployments, and other details that may be valuable to you.
|
||||
|
||||
## Reference
|
||||
|
||||
|
||||
@ -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.
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
336
rewards/df-faq.md
Normal file
336
rewards/df-faq.md
Normal file
@ -0,0 +1,336 @@
|
||||
---
|
||||
title: veOCEAN & Data Farming FAQ
|
||||
description: Frequently Asked Questions about Data Farming
|
||||
---
|
||||
## veOCEAN FAQ
|
||||
|
||||
### Guides
|
||||
<details>
|
||||
|
||||
<summary>I'm new to Ocean and I want to stake my $OCEAN tokens. Can you show me how? Where can I learn about APY and locks?</summary>
|
||||
|
||||
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](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.
|
||||
|
||||
We cannot offer guidance as how to allocate your voting power, that's your decision.
|
||||
|
||||
</details>
|
||||
|
||||
### Basics
|
||||
<details>
|
||||
|
||||
<summary>Are veOCEAN tokens tradeable or have a market price?</summary>
|
||||
|
||||
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](user-guides/how-to-delegate.md).
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Which chain is veOCEAN be deployed on?</summary>
|
||||
|
||||
[veOCEAN & DF](https://github.com/oceanprotocol/contracts/tree/main/contracts/ve) core contracts are deployed on Ethereum mainnet.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Which networks are eligible for Data Farming?</summary>
|
||||
|
||||
You participate by default in Passive Rewards when you lock $OCEAN on Ethereum Mainnet.
|
||||
|
||||
Data assets for Volume DF may be published in any network where Ocean’s deployed in production: Eth Mainnet, Polygon, BSC, and more.
|
||||
|
||||
You can find a list of [all supported chains here](../discover/networks/README.md).
|
||||
|
||||
</details>
|
||||
|
||||
### Staking
|
||||
|
||||
<details>
|
||||
|
||||
<summary>What is veOcean and staking in context of Ocean Protocol? </summary>
|
||||
|
||||
[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>
|
||||
|
||||
<details>
|
||||
|
||||
<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](user-guides/how-to-veocean.md).
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<Summary>I locked my OCEAN for veOcean but can't see the rewards. What am I missing?</Summary>
|
||||
|
||||
Please hang in there and stay patient, as it can take almost two weeks to receive your first reward. 😊
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>If I stake my Ocean for 6 months and the price of Ocean goes up during that time, will my staked tokens increase in value as well?</summary>
|
||||
|
||||
Yes. When you lock Ocean tokens, you'll receive them back at the end of the lock-up period. If the value increases during this time, your Ocean tokens will appreciate in worth. The same principle applies in reverse if the value decreases
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Is it possible to only participate in Passive Rewards? Or should I participate in Active Rewards?</summary>
|
||||
|
||||
You participate by default in Passive Rewards when you lock $OCEAN.
|
||||
|
||||
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](user-guides/how-to-estimate-apy).
|
||||
|
||||
</details>
|
||||
|
||||
### Liquid Staking
|
||||
<details>
|
||||
|
||||
<summary>Are there any liquid staking wrappers for veOCEAN?</summary>
|
||||
|
||||
You can also earn active staking rewards by assigning your veOCEAN directly on datasets or through a proxy ([psdnOCEAN](https://docs.h2odata.xyz/protocol-overview/psdnocean-veocean-liquid-staking)), which deploys your veOCEAN at no risk, in order to gain a share of active rewards.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Why the ratio between psdnOCEAN and OCEAN tokens is not close to 1:1?</summary>
|
||||
|
||||
The ratio stands at 80% to 20%, creating an imbalanced pool that minimizes price fluctuations. You might find this [resource](https://blog.oceanprotocol.com/psdnocean-the-first-liquid-staking-wrapper-by-the-h2o-team-is-now-live-a3330e15fa5c) valuable.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<Summary> How to convert PsdnOcean back to $OCEAN ?</Summary>
|
||||
|
||||
You can convert psdnOCEAN back to $OCEAN using the Balancer AMM liquidity [pool](https://app.balancer.fi/#/ethereum/pool/0xf8c4cd95c7496cb7c8d97202cf7e5b8da2204c2b00020000000000000000039e).
|
||||
|
||||
[Price information](https://www.geckoterminal.com/eth/pools/0xf8c4cd95c7496cb7c8d97202cf7e5b8da2204c2b) for psdnOCEAN.
|
||||
|
||||
</details>
|
||||
|
||||
### Locking & Withdrawing
|
||||
|
||||
<details>
|
||||
|
||||
<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](df-veocean.md).
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>If I withdraw before the unlock date, what happens to my veOCEAN and rewards?</summary>
|
||||
|
||||
You can't withdraw before the [unlock date](df-veocean.md).
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Is there a way to transform VeOcean to Ocean gradually over the lock period?</summary>
|
||||
|
||||
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](df-veocean).
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>What is the best time to lock OCEAN to avoid high gas fees?</summary>
|
||||
|
||||
When [gas](https://www.useweb3.xyz/gas) is cheap.
|
||||
|
||||
</details>
|
||||
|
||||
### Claiming Rewards
|
||||
|
||||
<details>
|
||||
|
||||
<summary>When I claim my Ocean tokens, do I need to restake them manually, or are they auto-compounded?</summary>
|
||||
|
||||
They are not auto-compounded.
|
||||
|
||||
They can be claimed/redeposited whenever you want. If you don't claim, they just stack up. There is no loss.
|
||||
|
||||
</details>
|
||||
|
||||
### APY
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Are rewards paid out in veOCEAN or $OCEAN?</summary>
|
||||
|
||||
All rewards in Data Farming are paid out in $OCEAN and can be claimed at the every epoch.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>I locked 10k OCEAN but only received 0.1 OCEAN as a reward. What gives? </summary>
|
||||
|
||||
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](user-guides/how-to-estimate-apy).
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<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](df-veocean).
|
||||
2. [Passive Rewards](df-intro).
|
||||
3. [Emissions & APYs](df-emissions-apys).
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<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](user-guides/how-to-estimate-apy) guide.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Where can I see the history for Data Farming APY to get an idea of what to expect?</summary>
|
||||
|
||||
Just, visit the Data Farming website and scroll down to the [Data Farming History](https://df.oceandao.org/activerewards) section.
|
||||
|
||||
</details>
|
||||
|
||||
### Volume DF
|
||||
|
||||
<details>
|
||||
|
||||
<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](df-volumedf.md#assets-that-qualify-for-data-farming)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<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](df-intro#what-are-active-rewards) if the assets you've curated have Data consume Volume(DCV).
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Is there a dashboard to view the volume of DF-main?</summary>
|
||||
|
||||
Yes
|
||||
|
||||
[DF Dashboard](https://df.oceandao.org/datafarming) (per round).
|
||||
[Autobot](https://autobotocean.com/volumes) (historical).
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>How do I analyze projects and decide where to allocate? Do I look at current and past APYs, or is there more to consider? </summary>
|
||||
|
||||
Curators can select datasets to stake on based on several factors such as publisher reputation, number of previous consumes of the dataset, ratings, and comments of others.
|
||||
|
||||
We provide an overview into many of these stats inside the [Volume DF page](https://df.oceandao.org/volume-df) in the Data Farming dApp.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>The datatoken price may change throughout the week. What price is taken in the DCV calculation?</summary>
|
||||
|
||||
The price is taken at the same time as each consume. E.g. if a data asset has three consumes, where the price was 1 OCEAN when the first consume happened, and the price was 10 OCEAN when the other consumes happened, then the total DCV for the asset is 1 + 10 + 10 = 21.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>How long does it take for the system to update round allocations for veOCEAN?</summary>
|
||||
|
||||
Allocations happen instantly.
|
||||
|
||||
However, your voting power is counted progressively throughout the week and requires you to keep your veOCEAn allocated on datasets for it to work.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Are there any risks associated with Active Rewards?</summary>
|
||||
|
||||
When it comes to active staking, you aren't exposed to additional risks. Your veOCEAN tokens remain securely locked, and your role is to curate datasets by allocating them.
|
||||
|
||||
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](user-guides/how-to-volumedf.md).
|
||||
|
||||
</details>
|
||||
|
||||
### Parameters & Stats
|
||||
<details>
|
||||
|
||||
<summary>What is the official veOCEAN epoch start_time?</summary>
|
||||
|
||||
veFeeDistributor has a start\_time of 1663804800 (Thu Sep 22 2022 00:00:00).
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Where can I find the veOCEAN and DF contracts?</summary>
|
||||
|
||||
They are deployed on the Ethereum mainnet, alongside other Ocean contract deployments. You can find the [full list of contracts here](https://github.com/oceanprotocol/contracts/blob/main/addresses/address.json).
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Can the reward function change during a given week?</summary>
|
||||
|
||||
No. At the beginning of a new DF round (DF1, DF2, etc.), rules are laid out, either implicitly if no change from the previous round, or explicitly in a blog post if there are new rules. This is: reward function, bounds, etc. Then teams stake, buy data, consume, etc. LPs are given DF rewards based on staking, DCV, etc. at the end of the week. Overall cycle time is one week.
|
||||
|
||||
Caveat: it’s no at least in theory! Sometimes there may be tweaks if there is community consensus or a bug.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>What is the percentage of tokens currently staked?</summary>
|
||||
|
||||
You can find the statistics for the number of locked tokens [here](https://autobotocean.com/veOcean). As of September 2023, there are approximately 700 million Ocean tokens in circulation, out of which approximately 30 million have been locked.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Is there a way to check the duration and amounts of veOCEAN locked on-chain for all wallets?</summary>
|
||||
|
||||
Yes, this information is available. Indeed, there is a technical aspect involved. You'll need to have some technical knowledge because you'll be required to query our subgraph. You can find a working example of how to get the list of holders [in our subgraph documentation](../developers/subgraph/get-veocean-stats#get-the-veocean-holders-list). Feel free to run the script by clicking on the "run" button.
|
||||
|
||||
</details>
|
||||
@ -1,39 +0,0 @@
|
||||
---
|
||||
description: Show you can complete all User-Guides as the last steps to master Data Farming!
|
||||
---
|
||||
|
||||
# Complete User Guides
|
||||
|
||||
<figure><img src="../.gitbook/assets/gif/neo-kinda-martial-arts.gif" alt=""><figcaption><p>Like Neo, you have great potential.</p></figcaption></figure>
|
||||
|
||||
### 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.
|
||||
|
||||
{% 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)
|
||||
{% 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)
|
||||
{% 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)
|
||||
{% 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)
|
||||
{% 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)
|
||||
{% 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)
|
||||
{% endcontent-ref %}
|
||||
|
||||
### Not much of a reader? Watch and learn, friend
|
||||
|
||||
{% embed url="https://youtu.be/zAQlPHkK3og" %}
|
||||
@ -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?
|
||||
|
||||
@ -52,11 +52,20 @@ Rewards are paid in OCEAN to contributors actively working to improve Ocean Prot
|
||||
| --------------- | -------------- |
|
||||
| 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#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).
|
||||
|
||||
@ -64,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
|
||||
|
||||
@ -72,13 +81,17 @@ 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
|
||||
|
||||
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?
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -22,13 +22,13 @@ Data Farming rewards farmers that allocate their veOCEAN tokens to assets that *
|
||||
Thus, if you really want to max out Volume DF APY:
|
||||
1. Lock your OCEAN for 4 years to receive 100% voting power.
|
||||
1. Have other participants delegate their Allocation Power to you.
|
||||
1. Create & publish assets (and make $ in selling them) — or work with people who can.
|
||||
1. Create & publish assets (and make \$ in selling them) — or work with people who can.
|
||||
1. Point your Allocation Power towards your published assets to receive a 2x bonus.
|
||||
1. Claim weekly Passive Rewards, Active Rewards, and update your lock.
|
||||
|
||||
### Success Metrics
|
||||
|
||||
**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!
|
||||
**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!
|
||||
|
||||
@ -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?
|
||||
|
||||
|
||||
@ -20,19 +20,19 @@ Anyone is welcomed to participate.
|
||||
|
||||
## Passive Rewards stream
|
||||
|
||||
The primary objective of the [Passive Rewards](../../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.
|
||||
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](../../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.
|
||||
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](../../rewards/df-volumedf.md). Here publishers and curators that help maintain quality assets in the Ocean ecosystem are rewarded.
|
||||
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.
|
||||
|
||||
@ -42,8 +42,12 @@ For more information on how to get started and detailed instructions, please ref
|
||||
|
||||
### Challenge DF Substream
|
||||
|
||||
If you are a data scientist and enjoy tackling challenging problems, this is the perfect place for you. [Challenge DF](../../rewards/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.
|
||||
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" %}
|
||||
@ -8,7 +8,7 @@ description: Make extra dosh with building prediction models
|
||||
|
||||
## 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](../../rewards/df-challengedf.md)!
|
||||
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.
|
||||
|
||||
@ -12,7 +12,7 @@ Rewards are earned by users that hold and use their veOCEAN to help the protocol
|
||||
|
||||
To receive competitve short-term APYs, veOCEAN requires users to make long-term commitments.
|
||||
|
||||
First, make sure that you [understand the basics of APY](../../rewards/df-veocean.md#veocean-and-your-apy) and how veOCEAN works.
|
||||
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.
|
||||
|
||||
@ -36,6 +36,6 @@ To help solve this challenge, [we built a dashboard](https://df.oceandao.org/vol
|
||||
|
||||
<figure><img src="../../.gitbook/assets/rewards/curate-datasets.png" alt=""><figcaption><p>Curate like a Pro.</p></figcaption></figure>
|
||||
|
||||
You can also [learn how rewards are calculated](../../rewards/df-volumedf.md#how-rewards-are-calculated) to understand more about what's happening behind the scenes of each Data Farming round.
|
||||
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.
|
||||
Loading…
Reference in New Issue
Block a user