mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
Merge branch 'main' into feature/sepolia
This commit is contained in:
Ana Loznianu
commit
a9e35eeaa5
@ -3,7 +3,7 @@ description: >-
|
||||
From emissions, estimate APYs
|
||||
---
|
||||
|
||||
<figure><img src="../../.gitbook/assets/gif/mafs.gif" alt=""><figcaption><p>K.I.S.S.</p></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/gif/mafs.gif" alt=""><figcaption><p>K.I.S.S.</p></figcaption></figure>
|
||||
|
||||
# Guide to Estimating APYs
|
||||
|
||||
@ -46,7 +46,7 @@ You can easily expand the spreadsheet above to support a basic, naive calculatio
|
||||
|
||||
To help solve this challenge, [we built a dashboard](https://df.oceandao.org/volume-df) that shows historical and ongoing summaries of APY, Data Consume Volume, and veOCEAN allocations per-round.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/data-farming/curate-datasets.png" alt=""><figcaption><p>Curate like a Pro.</p></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/data-farming/curate-datasets.png" alt=""><figcaption><p>Curate like a Pro.</p></figcaption></figure>
|
||||
|
||||
Finally, you can [review df-web code](https://github.com/oceanprotocol/df-web/blob/main/src/utils/rewards.js) to understand how the APYs on the UI are calculated.
|
||||
|
||||
|
||||
@ -21,13 +21,13 @@ Go to [Data Farming dApp](https://df.oceandao.org)
|
||||
|
||||
After the dApp loads, look for the menu and click on "Challenges"
|
||||
|
||||
<figure><img src="../../.gitbook/assets/data-farming/challenge-page.png" alt=""><figcaption><p>Find "Challenges" in the menu and click on it</p></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/data-farming/challenge-page.png" alt=""><figcaption><p>Find "Challenges" in the menu and click on it</p></figcaption></figure>
|
||||
|
||||
#### Step 3 - Click on "Participate"
|
||||
|
||||
After clicking on "Participate" you will be [linked to the Challenge DF README](https://github.com/oceanprotocol/predict-eth/blob/main/challenges/challenge-df.md) that outlines all details about the challenge.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/data-farming/challenge-active.png" alt=""><figcaption><p>Click the Participate button</p></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/data-farming/challenge-active.png" alt=""><figcaption><p>Click the Participate button</p></figcaption></figure>
|
||||
|
||||
#### Step 4 - Use README to publish your predictions
|
||||
|
||||
@ -35,7 +35,7 @@ You can see the ongoing challenge right away together with some key informations
|
||||
|
||||
Follow the README steps to publish your model and compete in the challenge.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/data-farming/challenge-df-readme.png" alt=""><figcaption><p>How to submit Challenge DF</p></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/data-farming/challenge-df-readme.png" alt=""><figcaption><p>How to submit Challenge DF</p></figcaption></figure>
|
||||
|
||||
#### Step 5 - Check weekly results
|
||||
|
||||
@ -43,7 +43,7 @@ Challenge DF weekly results become available at the end of every Data Farming ro
|
||||
|
||||
The top 3 competitors win prizes and are visible in the leaderboard.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/data-farming/challenge-history.png" alt=""><figcaption><p>Past Challenges leaderboard</p></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/data-farming/challenge-history.png" alt=""><figcaption><p>Past Challenges leaderboard</p></figcaption></figure>
|
||||
|
||||
#### Step 6 - View and claim Active Rewards.
|
||||
|
||||
@ -53,4 +53,4 @@ To view and claim your rewards:
|
||||
2. Your Challenge DF substream rewards will be displayed to the left besides "rewards". As you can see, it will be added to other active rewards that can be claimed besides "total rewards".
|
||||
3. To claim all Active Rewards including your Challenge DF rewards, simply click on the "Claim Rewards" button.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/data-farming/challenge-substream.png" alt=""><figcaption><p>Click the Claim Rewards button</p></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/data-farming/challenge-substream.png" alt=""><figcaption><p>Click the Claim Rewards button</p></figcaption></figure>
|
||||
|
||||
@ -5,7 +5,7 @@ description: >-
|
||||
|
||||
# Challenge Data Farming
|
||||
|
||||
<figure><img src="../../.gitbook/assets/gif/underwater-you-want-some-of-this.gif" alt=""></figure>
|
||||
<figure><img src="../.gitbook/assets/gif/underwater-you-want-some-of-this.gif" alt=""></figure>
|
||||
|
||||
|
||||
**This page** is about Challenge DF, and [this page](challengedf-guide.md) is a guide.
|
||||
|
||||
@ -4,7 +4,7 @@ description: Unbox your OCEAN rewards
|
||||
|
||||
# Claim Rewards in DF
|
||||
|
||||
<figure><img src="../../.gitbook/assets/gif/underwater-treasure.gif" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/gif/underwater-treasure.gif" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
**This page describes how to claim DF rewards.** (Predictoor DF is an exception, [see here](predictoordf-guide.md).)
|
||||
|
||||
@ -16,7 +16,7 @@ Detailed instructions are below.
|
||||
|
||||
Go to [https://df.oceandao.org/](https://df.oceandao.org), and click the Rewards [link](https://df.oceandao.org/rewards) at the top of the page.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/data-farming/Rewards-Tab.png" alt=""><figcaption><p>Click the Rewards link at the top of the page</p></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/data-farming/Rewards-Tab.png" alt=""><figcaption><p>Click the Rewards link at the top of the page</p></figcaption></figure>
|
||||
|
||||
### Step 2 - Click the pink 'Claim # OCEAN' buttons 🛎️
|
||||
|
||||
@ -24,7 +24,7 @@ At the bottom of the 'Passive Rewards' and 'Active Rewards' panels are the 'Clai
|
||||
|
||||
This is where you click to claim your rewards! Easy peasy. You will need to approve the transactions with your wallet.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/data-farming/claim-rewards.png" alt=""><figcaption><p>Click the pink Claim # Ocean buttons</p></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/data-farming/claim-rewards.png" alt=""><figcaption><p>Click the pink Claim # Ocean buttons</p></figcaption></figure>
|
||||
|
||||
### First time claiming?
|
||||
|
||||
|
||||
@ -5,7 +5,7 @@ description: >-
|
||||
|
||||
# Delegation in Volume DF
|
||||
|
||||
<figure><img src="../../.gitbook/assets/gif/underwater-buddy-peewee.gif" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/gif/underwater-buddy-peewee.gif" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
## About Delegation
|
||||
|
||||
@ -47,4 +47,4 @@ If you receive veOCEAN allocation power from other wallets, then you will receiv
|
||||
|
||||
You _cannot_ re-delegate this veOCEAN further downstream. 
|
||||
|
||||
<figure><img src="../../.gitbook/assets/data-farming/veOCEAN-Delegation.png" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/data-farming/veOCEAN-Delegation.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
@ -5,7 +5,7 @@ description: >-
|
||||
|
||||
# Guide to Passive DF
|
||||
|
||||
<figure><img src="../../.gitbook/assets/gif/aquaman-gold.gif" alt="" width="250"><figcaption><p>Get your gold. Get your veOCEAN.</p></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/gif/aquaman-gold.gif" alt="" width="250"><figcaption><p>Get your gold. Get your veOCEAN.</p></figcaption></figure>
|
||||
|
||||
In order to **get yield in DF**, you will need to lock your OCEAN first! When you lock your OCEAN, you get **veOCEAN** and **weekly passive OCEAN rewards** in return. veOCEAN is a token used in Ocean Protocol's Data Farming dApp to **generate even more yield,** called **Volume DF rewards**, for allocating your veOCEAN to your favorite assets and get a portion of their sales!
|
||||
|
||||
|
||||
@ -5,7 +5,7 @@ description: >-
|
||||
|
||||
# Guide to Predictoor DF
|
||||
|
||||
<figure><img src="../../.gitbook/assets/gif/money-robot.gif" alt=""></figure>
|
||||
<figure><img src="../.gitbook/assets/gif/money-robot.gif" alt=""></figure>
|
||||
|
||||
In Predictoor DF (and Predictoor proper), you run prediction bots to earn continuously. This guide describes how to become eligible for OCEAN rewards and claim them; and the same for Oasis ROSE rewards. And of course first thing you need to do is become a predictoor.
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@ Predictoor DF makes [Active DF](../data-farming/volumedf.md) more attractive, an
|
||||
|
||||
**Predictoor DF makes Volume DF more attractive than status quo**, because the volume-based bounds on weekly rewards trends tend to be markedly higher for prediction feeds. (The Appendix has details.)
|
||||
|
||||
**Curating is straightforward.** Ocean assets with high DCV are easy to identify: it's the 20 OPF-published prediction feeds. This makes the choice of veOCEAN allocation easy: point to those 20 assets [1].
|
||||
**Curating is straightforward.** Ocean assets with high DCV are easy to identify: it's the 20 OPF-published prediction feeds. This makes the choice of veOCEAN allocation easy: point to those 20 assets.
|
||||
|
||||
**Doing Volume DF gives Passive DF rewards too**, of course.
|
||||
|
||||
@ -89,6 +89,6 @@ Therefore `DCV_bound` is higher. Specifically: `DCV_bound = 37000 * (0.001 + 0.2
|
||||
|
||||
## Notes
|
||||
|
||||
[1] The BTC/USDT 5m and 1h feeds follow the same Volume DF mechanics as the other feeds, despite being free on the webapp.
|
||||
The BTC/USDT 5m and 1h feeds follow the same Volume DF mechanics as the other feeds, despite being free on the webapp.
|
||||
|
||||
Details: the BTC feeds _are_ priced at the smart contract level. The webapp receives datatokens for those feeds and makes the prediction values public. Because the BTC feeds _are_ priced, then: their DCV is non-negligible; allocating veOCEAN to them makes sense; and Volume DF rewards accrue to them as well.
|
||||
|
||||
@ -5,7 +5,7 @@ description: >-
|
||||
|
||||
# Guide to Volume DF
|
||||
|
||||
<figure><img src="../../.gitbook/assets/gif/avatar-pick-whale.gif" alt=""><figcaption>Pick your whale</figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/gif/avatar-pick-whale.gif" alt=""><figcaption>Pick your whale</figcaption></figure>
|
||||
|
||||
In Volume DF, you allocate veOCEAN to data assets with high data consume volume (DCV). You do this via the DF dApp.
|
||||
|
||||
@ -21,7 +21,7 @@ We'll show you how!
|
||||
|
||||
#### Step 3 - Click the Volume DF tab in the top menu
|
||||
|
||||
<figure><img src="../../.gitbook/assets/data-farming/volumeDF-page.png" alt=""><figcaption><p>Click the Volume DF page link in the menu</p></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/data-farming/volumeDF-page.png" alt=""><figcaption><p>Click the Volume DF page link in the menu</p></figcaption></figure>
|
||||
|
||||
#### Step 4 - Select the assets which you would like to allocate to by toggling the percentage allocation at the end of the row
|
||||
|
||||
@ -29,14 +29,14 @@ We'll show you how!
|
||||
- Note that if you allocate to an asset that YOU published, then you will get an **effective 2x allocation boost**.
|
||||
- If you are a publisher and curating your own asset, your asset may be styled differently in the UI.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/data-farming/allocations.png" alt=""><figcaption><p>Toggle the percentage of your veOCEAN that you would like to allocate to each asset</p></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/data-farming/allocations.png" alt=""><figcaption><p>Toggle the percentage of your veOCEAN that you would like to allocate to each asset</p></figcaption></figure>
|
||||
|
||||
#### Step 5 - Click the Update Allocations button
|
||||
|
||||
- Click the pink Update Allocations button
|
||||
- Sign the transactions with your wallet & pay the gas fees
|
||||
|
||||
<figure><img src="../../.gitbook/assets/data-farming/update-allocations.png" alt=""><figcaption><p>Click the Update Allocations button</p></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/data-farming/update-allocations.png" alt=""><figcaption><p>Click the Update Allocations button</p></figcaption></figure>
|
||||
|
||||
That's it! You've successfully allocated (aka "voted on") your favorite assets in the Ocean ecosystem using your veOCEAN and are generating active rewards yield. Now, just wait until next Thursday to see if you can [claim any OCEAN rewards](claim-rewards.md) on the Active Rewards section of the [Rewards page](https://df.oceandao.org/rewards) for your portion of the assets' sales. Remember that your first time claiming rewards will require at least one week, but not more than 2 weeks of wait!
|
||||
|
||||
|
||||
@ -207,7 +207,7 @@ In the "publish algorithm" step, to replace the sample algorithm with another on
|
||||
* Use one of the standard [Ocean algo_dockers images](https://github.com/oceanprotocol/algo_dockers) or publish a custom docker image.
|
||||
* Use the image name and tag in the `container` part of the algorithm metadata.
|
||||
* The image must have basic support for installing dependencies. E.g. "pip" for the case of Python. You can use other languages, of course.
|
||||
* More info is available on the [algorithms page](../compute-to-data/compute-to-data-algorithms.md)
|
||||
* More info is available on the [algorithms page](../../developers/compute-to-data/compute-to-data-algorithms.md)
|
||||
|
||||
The function to `pay_for_compute_service` automates order starting, order reusing and performs all the necessary Provider and on-chain requests. It modifies the contents of the given ComputeInput as follows:
|
||||
|
||||
|
||||
@ -29,17 +29,17 @@ print(f" did={ddo.did}")
|
||||
|
||||
You've now published an Ocean asset!
|
||||
|
||||
* [`data_nft`](../contracts/data-nfts.md) is the base (base IP)
|
||||
* [`datatoken`](../contracts/datatokens.md) for access by others (licensing)
|
||||
* [`ddo`](../ddo-specification.md) holding metadata
|
||||
* [`data_nft`](../../developers/contracts/data-nfts.md) is the base (base IP)
|
||||
* [`datatoken`](../../developers/contracts/datatokens.md) for access by others (licensing)
|
||||
* [`ddo`](../../developers/ddo-specification.md) holding metadata
|
||||
|
||||
<figure><img src="../../.gitbook/assets/gif/200.webp" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
### Appendix
|
||||
|
||||
For more information regarding: Data NFT & Datatokens interfaces and how they are implemented in Solidity, we suggest to follow up this [article](../contracts/datanft-and-datatoken.md) and [contracts repo](https://github.com/oceanprotocol/contracts) from GitHub.
|
||||
For more information regarding: Data NFT & Datatokens interfaces and how they are implemented in Solidity, we suggest to follow up this [article](../../developers/contracts/datanft-and-datatoken.md) and [contracts repo](https://github.com/oceanprotocol/contracts) from GitHub.
|
||||
|
||||
As you may want to explore more the DDO specs, structure & meaning, we invite you to consult [DDO Specification](../ddo-specification.md) section.
|
||||
As you may want to explore more the DDO specs, structure & meaning, we invite you to consult [DDO Specification](../../developers/ddo-specification.md) section.
|
||||
|
||||
#### Publishing Alternatives
|
||||
|
||||
|
||||
@ -11,7 +11,7 @@ coverY: 0
|
||||
|
||||
With Ocean, crypto wallets transform into magical data wallets, where your data can roam freely and securely. Crypto exchanges? Well, they've taken on a new role as data marketplaces, where you can showcase and trade your valuable data treasures. And hold on tight because DAOs are here to create epic data co-ops, where collaboration and innovation reign supreme! 🤝
|
||||
|
||||
But hold on tight, because we have even more in store for you! With Ocean Protocol, you gain access to a treasure trove of tools that will unlock your data scientist superpowers and allow you to unleash your creativity. Whether you're a Python aficionado or a JavaScript maestro, we have you covered with [ocean.py](ocean.py/README.md) and [ocean.js](ocean.js/README.md) libraries. So, get ready to dive into the depths of data innovation and create the next groundbreaking dAapp (that's a decentralized App, by the way) using [ocean.js's](ocean.js/README.md) powerful capabilities or unleash your skills with [ocean.py](ocean.py/README.md). It's time to shake up the data world like never before! 🌐🚀
|
||||
But hold on tight, because we have even more in store for you! With Ocean Protocol, you gain access to a treasure trove of tools that will unlock your data scientist superpowers and allow you to unleash your creativity. Whether you're a Python aficionado or a JavaScript maestro, we have you covered with [ocean.py](../data-scientists/ocean.py/README.md) and [ocean.js](ocean.js/README.md) libraries. So, get ready to dive into the depths of data innovation and create the next groundbreaking dAapp (that's a decentralized App, by the way) using [ocean.js's](ocean.js/README.md) powerful capabilities or unleash your skills with [ocean.py](../data-scientists/ocean.py/README.md). It's time to shake up the data world like never before! 🌐🚀
|
||||
|
||||
<figure><img src="../.gitbook/assets/general/developers.png" alt=""><figcaption><p>Ocean Protocol Explorer</p></figcaption></figure>
|
||||
|
||||
|
||||
@ -20,10 +20,10 @@ Above the smart contracts, you'll find essential [libraries](architecture.md#lib
|
||||
|
||||
#### Libraries
|
||||
|
||||
These libraries include [Ocean.js](ocean.js/README.md), a JavaScript library, and [Ocean.py](ocean.py/README.md), a Python library. They serve as powerful tools for developers, enabling integration and interaction with the protocol.
|
||||
These libraries include [Ocean.js](ocean.js/README.md), a JavaScript library, and [Ocean.py](../data-scientists/ocean.py/README.md), a Python library. They serve as powerful tools for developers, enabling integration and interaction with the protocol.
|
||||
|
||||
1. [Ocean.js](ocean.js/README.md): Ocean.js is a JavaScript library that serves as a powerful tool for developers looking to integrate their applications with the Ocean Protocol ecosystem. Designed to facilitate interaction with the protocol, Ocean.js provides a comprehensive set of functionalities, including data tokenization, asset management, and smart contract interaction. Ocean.js simplifies the process of implementing data access controls, building dApps, and exploring data sets within a decentralized environment.
|
||||
2. [Ocean.py](ocean.py/README.md): Ocean.py is a Python library that empowers developers to integrate their applications with the Ocean Protocol ecosystem. With its rich set of functionalities, Ocean.py provides a comprehensive toolkit for interacting with the protocol. Developers and [data scientists](../data-scientists/README.md) can leverage Ocean.py to perform a wide range of tasks, including data tokenization, asset management, and smart contract interactions. This library serves as a bridge between Python and the decentralized world of Ocean Protocol, enabling you to harness the power of decentralized data.
|
||||
2. [Ocean.py](../data-scientists/ocean.py/README.md): Ocean.py is a Python library that empowers developers to integrate their applications with the Ocean Protocol ecosystem. With its rich set of functionalities, Ocean.py provides a comprehensive toolkit for interacting with the protocol. Developers and [data scientists](../data-scientists/README.md) can leverage Ocean.py to perform a wide range of tasks, including data tokenization, asset management, and smart contract interactions. This library serves as a bridge between Python and the decentralized world of Ocean Protocol, enabling you to harness the power of decentralized data.
|
||||
|
||||
#### Middleware components
|
||||
|
||||
|
||||
@ -36,7 +36,7 @@ We suggest reading these guides to get an understanding of how compute-to-data w
|
||||
### Developer Guides
|
||||
|
||||
* [How to use compute to data with ocean.js](../ocean.js/cod-asset.md)
|
||||
* [How to use compute to data with ocean.py](../ocean.py/compute-flow.md)
|
||||
* [How to use compute to data with ocean.py](../../data-scientists/ocean.py/README.md)
|
||||
|
||||
### Infrastructure Deployment Guides
|
||||
|
||||
|
||||
@ -24,7 +24,7 @@ The interaction between the Consumer and the Provider follows a specific workflo
|
||||
Throughout the computation process, the Consumer has the ability to check the status of the job by making a query to the Provider using the `getJobDetails(XXXX)` function, providing the job identifier (`XXXX`) as a reference.
|
||||
|
||||
{% hint style="info" %}
|
||||
You have the option to initiate a compute job using one or more data assets. You can explore this functionality by utilizing the [ocean.py](../ocean.py/README.md) and [ocean.js](../ocean.js/README.md) libraries.
|
||||
You have the option to initiate a compute job using one or more data assets. You can explore this functionality by utilizing the [ocean.py](../../data-scientists/ocean.py/README.md) and [ocean.js](../ocean.js/README.md) libraries.
|
||||
{% endhint %}
|
||||
|
||||
Now, let's delve into the inner workings of the Provider. Initially, it verifies whether the Consumer has sent the appropriate datatokens to gain access to the desired data. Once validated, the Provider interacts with the Operator-Service, a microservice responsible for coordinating the job execution. The Provider submits a request to the Operator-Service, which subsequently forwards the request to the Operator-Engine, the actual compute system in operation.
|
||||
|
||||
@ -21,10 +21,10 @@ Above the smart contracts, you'll find essential [libraries](architecture.md#lib
|
||||
|
||||
#### Libraries
|
||||
|
||||
These libraries include [Ocean.js](../ocean.js/README.md), a JavaScript library, and [Ocean.py](../ocean.py/README.md), a Python library. They serve as powerful tools for developers, enabling integration and interaction with the protocol.
|
||||
These libraries include [Ocean.js](../ocean.js/README.md), a JavaScript library, and [Ocean.py](../../data-scientists/ocean.py/README.md), a Python library. They serve as powerful tools for developers, enabling integration and interaction with the protocol.
|
||||
|
||||
1. [Ocean.js](../ocean.js/README.md): Ocean.js is a JavaScript library that serves as a powerful tool for developers looking to integrate their applications with the Ocean Protocol ecosystem. Designed to facilitate interaction with the protocol, Ocean.js provides a comprehensive set of functionalities, including data tokenization, asset management, and smart contract interaction. Ocean.js simplifies the process of implementing data access controls, building dApps, and exploring data sets within a decentralized environment.
|
||||
2. [Ocean.py](../ocean.py/README.md): Ocean.py is a Python library that empowers developers to integrate their applications with the Ocean Protocol ecosystem. With its rich set of functionalities, Ocean.py provides a comprehensive toolkit for interacting with the protocol. Developers and [data scientists](../../data-scientists/README.md) can leverage Ocean.py to perform a wide range of tasks, including data tokenization, asset management, and smart contract interactions. This library serves as a bridge between Python and the decentralized world of Ocean Protocol, enabling you to harness the power of decentralized data.
|
||||
2. [Ocean.py](../../data-scientists/ocean.py/README.md): Ocean.py is a Python library that empowers developers to integrate their applications with the Ocean Protocol ecosystem. With its rich set of functionalities, Ocean.py provides a comprehensive toolkit for interacting with the protocol. Developers and [data scientists](../../data-scientists/README.md) can leverage Ocean.py to perform a wide range of tasks, including data tokenization, asset management, and smart contract interactions. This library serves as a bridge between Python and the decentralized world of Ocean Protocol, enabling you to harness the power of decentralized data.
|
||||
|
||||
#### Middleware components
|
||||
|
||||
|
||||
@ -54,7 +54,7 @@ Below is a visual representation that illustrates the flow:
|
||||
|
||||
We have some awesome hands-on experience when it comes to publishing a data NFT and minting datatokens.
|
||||
|
||||
* Publish using [ocean.py](../ocean.py/publish-flow.md)
|
||||
* Publish using [ocean.py](../../data-scientists/ocean.py/publish-flow.md)
|
||||
* Publish using [ocean.js](../ocean.js/publish.md)
|
||||
|
||||
### Other References
|
||||
|
||||
@ -182,8 +182,8 @@ function createNftWithErc20WithDispenser(
|
||||
|
||||
</details>
|
||||
|
||||
To make the most of these pricing models, you can rely on user-friendly libraries such as [Ocean.js ](../ocean.js/README.md)and [Ocean.py](../ocean.py/README.md), specifically developed for interacting with Ocean Protocol.
|
||||
To make the most of these pricing models, you can rely on user-friendly libraries such as [Ocean.js ](../ocean.js/README.md)and [Ocean.py](../../data-scientists/ocean.py/README.md), specifically developed for interacting with Ocean Protocol.
|
||||
|
||||
With Ocean.js, you can use the [createFRE() ](../ocean.js/publish.md)function to effortlessly deploy a data NFT (non-fungible token) and datatoken with a fixed-rate exchange pricing model. Similarly, in Ocean.py, the [create\_url\_asset()](../ocean.py/publish-flow.md#create-an-asset--pricing-schema-simultaneously) function allows you to create an asset with fixed pricing. These libraries simplify the process of interacting with Ocean Protocol, managing pricing, and handling asset creation.
|
||||
With Ocean.js, you can use the [createFRE() ](../ocean.js/publish.md)function to effortlessly deploy a data NFT (non-fungible token) and datatoken with a fixed-rate exchange pricing model. Similarly, in Ocean.py, the [create\_url\_asset()](../../data-scientists/ocean.py/publish-flow.md#create-an-asset--pricing-schema-simultaneously) function allows you to create an asset with fixed pricing. These libraries simplify the process of interacting with Ocean Protocol, managing pricing, and handling asset creation.
|
||||
|
||||
By taking advantage of Ocean Protocol's pricing options and leveraging the capabilities of [Ocean.js](../ocean.js/README.md) and [Ocean.py](../ocean.py/README.md) (or by using the [Market](../../user-guides/using-ocean-market.md)), you can effectively monetize your data assets while ensuring transparent and seamless access for data consumers.
|
||||
By taking advantage of Ocean Protocol's pricing options and leveraging the capabilities of [Ocean.js](../ocean.js/README.md) and [Ocean.py](../../data-scientists/ocean.py/README.md) (or by using the [Market](../../user-guides/using-ocean-market.md)), you can effectively monetize your data assets while ensuring transparent and seamless access for data consumers.
|
||||
|
||||
@ -20,7 +20,7 @@ In the case of [ERC20TemplateEnterprise](datatoken-templates.md#enterprise-templ
|
||||
On the other hand, with [ERC20Template](datatoken-templates.md#regular-template), for a fixed rate exchange, the revenue is available at the fixed rate exchange level. The owner or the payment collector has the authority to manually retrieve the revenue.
|
||||
{% endhint %}
|
||||
|
||||
There are several methods available for establishing a new **payment collector**. You have the option to utilize the ERC20Template/ERC20TemplateEnterprise contract directly. Another approach is to leverage the [ocean.py](../ocean.py/README.md) and [ocean.js](../ocean.js/README.md) libraries. Alternatively, you can employ the network explorer associated with your asset. Lastly, you can directly set it up within the Ocean Market.
|
||||
There are several methods available for establishing a new **payment collector**. You have the option to utilize the ERC20Template/ERC20TemplateEnterprise contract directly. Another approach is to leverage the [ocean.py](../../data-scientists/ocean.py/README.md) and [ocean.js](../ocean.js/README.md) libraries. Alternatively, you can employ the network explorer associated with your asset. Lastly, you can directly set it up within the Ocean Market.
|
||||
|
||||
Here are some examples of how to set up a new payment collector using the mentioned methods:
|
||||
|
||||
|
||||
@ -23,7 +23,7 @@ The NFT owner is the owner of the base-IP and is therefore at the highest level.
|
||||
With the exception of the NFT owner role, all other roles can be assigned to multiple users.
|
||||
{% endhint %}
|
||||
|
||||
There are several methods available to assign roles and permissions. One option is to utilize the [ocean.py](../ocean.py/README.md) and [ocean.js](../ocean.js/README.md) libraries that we provide. These libraries offer a streamlined approach for assigning roles and permissions programmatically.
|
||||
There are several methods available to assign roles and permissions. One option is to utilize the [ocean.py](../../data-scientists/ocean.py/README.md) and [ocean.js](../ocean.js/README.md) libraries that we provide. These libraries offer a streamlined approach for assigning roles and permissions programmatically.
|
||||
|
||||
Alternatively, for a more straightforward solution that doesn't require coding, you can utilize the network explorer of your asset's network. By accessing the network explorer, you can directly interact with the contracts associated with your asset. Below, we provide a few examples to help guide you through the process.
|
||||
|
||||
|
||||
@ -18,7 +18,7 @@ The blockchain being public means that transaction information is transparent an
|
||||
<details>
|
||||
<summary>How are datatokens created?</summary>
|
||||
|
||||
Datatokens are created within the Ocean Protocol ecosystem when you tokenize a dataset(convert a dataset into a fungible token that can be traded). More details, on the [datatokens page](../developers/contracts/datatokens)
|
||||
Datatokens are created within the Ocean Protocol ecosystem when you tokenize a dataset(convert a dataset into a fungible token that can be traded). More details, on the [datatokens page](../developers/contracts/datatokens.md)
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
@ -39,4 +39,4 @@ console.log(did)
|
||||
Before creating a DID you should first publish a data NFT, we suggest reading the following sections so you are familiar with the process:
|
||||
|
||||
* [Creating a data NFT with ocean.js](ocean.js/creating-datanft.md)
|
||||
* [Publish flow with ocean.py](ocean.py/publish-flow.md)
|
||||
* [Publish flow with ocean.py](../data-scientists/ocean.py/publish-flow.md)
|
||||
|
||||
@ -80,7 +80,7 @@ While we utilize a specific DDO structure, you have the flexibility to customize
|
||||
{% endhint %}
|
||||
|
||||
{% hint style="info" %}
|
||||
As developers, we understand that you eat, breathe, and live code. That's why we invite you to explore the [ocean.py](ocean.py/publish-flow.md#publishing-alternatives) and [ocean.js](ocean.js/update-metadata.md) pages, where you'll find practical examples of how to set up and update metadata for an asset :computer:
|
||||
As developers, we understand that you eat, breathe, and live code. That's why we invite you to explore the [ocean.py](../data-scientists/ocean.py/publish-flow.md#publishing-alternatives) and [ocean.js](ocean.js/update-metadata.md) pages, where you'll find practical examples of how to set up and update metadata for an asset :computer:
|
||||
{% endhint %}
|
||||
|
||||
You'll have more information about the DIDs, on the [Identifiers](identifiers.md) page.
|
||||
|
||||
@ -4,7 +4,7 @@ description: 'Discover the World of veOCEAN: Retrieving a Stats'
|
||||
|
||||
# Get veOCEAN stats
|
||||
|
||||
If you are already familiarized with veOCEAN, you're off to a great start. However, if you need a refresher, we recommend visiting the [veOCEAN](../../data-farming/veocean-passive.md) page for a quick overview :mag:
|
||||
If you are already familiarized with veOCEAN, you're off to a great start. However, if you need a refresher, we recommend visiting the [veOCEAN](../../data-farming/passivedf.md) page for a quick overview :mag:
|
||||
|
||||
On this page, you'll find a few examples to fetch the stats of veOCEANS from the Ocean Subgraph. These examples serve as a valuable starting point to help you retrieve essential information about veOCEAN. However, if you're eager to delve deeper into the topic, we invite you to visit the [GitHub](https://github.com/oceanprotocol/ocean-subgraph/blob/main/test/integration/VeOcean.test.ts) repository. There, you'll discover a wealth of additional examples, which provide comprehensive insights. Feel free to explore and expand your knowledge! :books:
|
||||
|
||||
|
||||
@ -30,4 +30,4 @@ OCEAN (**OCEAN**) are the native cryptocurrency of the Ocean Protocol ecosystem.
|
||||
|
||||
1. **Data Ownership**: OCEAN empowers data owners by providing them with control over their data assets. Through the use of smart contracts, data owners can define access permissions, usage rights, and pricing terms for their data. By holding and staking OCEAN, data owners can exercise even greater control over their data assets.
|
||||
2. **Data Monetization and Consumption**: OCEAN facilitate seamless and secure transactions between data providers and consumers, fostering a thriving new data economy. Data owners can set a price in OCEAN for consumers to access and utilize their data. This creates opportunities for unlocking value from siloed or otherwise unused data.
|
||||
3. **Stake for veOCEAN and Curate Datasets**: Through the Data Farming initiative, you are incentivized to lock OCEAN for [veOCEAN](../data-farming/df-veocean.md). By staking your OCEAN, you not only support the growth and sustainability of the ecosystem but also earn a share of data asset sales 💰. The Data Farming initiative offers participants a unique opportunity to earn [rewards](../data-farming/README.md) while making a meaningful impact in the data marketplace.
|
||||
3. **Stake for veOCEAN and Curate Datasets**: Through the Data Farming initiative, you are incentivized to lock OCEAN for [veOCEAN](../data-farming/passivedf.md). By staking your OCEAN, you not only support the growth and sustainability of the ecosystem but also earn a share of data asset sales 💰. The Data Farming initiative offers participants a unique opportunity to earn [rewards](../data-farming/README.md) while making a meaningful impact in the data marketplace.
|
||||
|
||||
@ -113,9 +113,9 @@ Furthermore, provider fees are not restricted to data consumption; they can also
|
||||
|
||||
<details>
|
||||
|
||||
<summary><mark style="color:purple;">Earn Rewards</mark><br><br>The <a href="../data-farming/df-volumedf.md">Data Farming</a> initiative is a key feature of Ocean Protocol that empowers participants to earn <a href="../data-farming/">rewards</a> while contributing to a decentralized data economy. By staking OCEAN and actively participating in data markets, users play a vital role in enhancing the availability and accessibility of valuable data assets</summary>
|
||||
<summary><mark style="color:purple;">Earn Rewards</mark><br><br>The <a href="../data-farming/README.md">Data Farming</a> initiative is a key feature of Ocean Protocol that empowers participants to earn <a href="../data-farming/">rewards</a> while contributing to a decentralized data economy. By staking OCEAN and actively participating in data markets, users play a vital role in enhancing the availability and accessibility of valuable data assets</summary>
|
||||
|
||||
Through the Data Farming initiative, you are incentivized to lock OCEAN for [veOCEAN](../data-farming/df-veocean.md). By staking your tokens, you not only support the growth and sustainability of the ecosystem but also earn a share of the generated incentives💰. The Data Farming initiative offers participants a unique opportunity to earn [rewards](../data-farming/README.md) while making a meaningful impact in the data marketplace.
|
||||
Through the Data Farming initiative, you are incentivized to lock OCEAN for [veOCEAN](../data-farming/README.md). By staking your tokens, you not only support the growth and sustainability of the ecosystem but also earn a share of the generated incentives💰. The Data Farming initiative offers participants a unique opportunity to earn [rewards](../data-farming/README.md) while making a meaningful impact in the data marketplace.
|
||||
|
||||
Participating in the Data Farming initiative demonstrates a commitment to the principles of **fairness**, **transparency**, and **collaboration** that underpin Ocean Protocol. It allows you to actively engage with the ecosystem, promoting innovation, and driving the evolution of the decentralized data economy.
|
||||
|
||||
|
||||
@ -88,7 +88,7 @@ All OCEAN have been [minted](https://blog.oceanprotocol.com/control-over-the-oce
|
||||
|
||||
There are more than 540 million OCEAN in circulation; the [OCEAN page](https://oceanprotocol.com/about-us/ocean-token) has the precise number.
|
||||
|
||||
The remaining tokens emit over decades, mostly for Ocean Data Farming. The [Emissions & APYs page](../data-farming/df-emissions-apys) has details.
|
||||
The remaining tokens emit over decades, mostly for Ocean Data Farming. The [Emissions & APYs page](../data-farming/apys-guide.md) has details.
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
@ -128,7 +128,7 @@ In exchange for locking tokens, users can earn rewards. The amount of reward dep
|
||||
|
||||
<summary>Ocean Data Farming (DF)</summary>
|
||||
|
||||
[Ocean Data Farming (DF)](https://df.oceandao.org/) incentivizes for growth of Data Consume Volume (DCV) in the Ocean ecosystem. [DF](../data-farming/df-intro.md) is like DeFi liquidity mining, but tuned for DCV. DF emits OCEAN for passive rewards and active rewards.
|
||||
[Ocean Data Farming (DF)](https://df.oceandao.org/) incentivizes for growth of Data Consume Volume (DCV) in the Ocean ecosystem. [DF](../data-farming/README.md) is like DeFi liquidity mining, but tuned for DCV. DF emits OCEAN for passive rewards and active rewards.
|
||||
|
||||
* As a veOCEAN holder, you get _passive_ rewards by default.
|
||||
* If you _actively_ curate data by allocating veOCEAN towards data assets with high Data Consume Volume (DCV), then you can earn more.
|
||||
@ -139,7 +139,7 @@ In exchange for locking tokens, users can earn rewards. The amount of reward dep
|
||||
|
||||
<summary>Passive Rewards</summary>
|
||||
|
||||
When a user locks their OCEAN for a finite period of time, they get veOCEAN in return. Based on the quantity of veOCEAN, the user accumulates weekly OCEAN rewards. Because rewards are generated without human intervention, these are called [Passive Rewards](../data-farming/df-intro.md#what-are-passive-rewards). OCEAN Data Farming Passive Rewards are claimable every Thursday on the [Rewards page](https://df.oceandao.org/rewards).
|
||||
When a user locks their OCEAN for a finite period of time, they get veOCEAN in return. Based on the quantity of veOCEAN, the user accumulates weekly OCEAN rewards. Because rewards are generated without human intervention, these are called [Passive Rewards](../data-farming/README.md). OCEAN Data Farming Passive Rewards are claimable every Thursday on the [Rewards page](https://df.oceandao.org/rewards).
|
||||
|
||||
</details>
|
||||
|
||||
@ -147,7 +147,7 @@ When a user locks their OCEAN for a finite period of time, they get veOCEAN in r
|
||||
|
||||
<summary>Volume DF</summary>
|
||||
|
||||
When a user allocates veOCEAN to Ocean Market projects, then weekly OCEAN rewards are given to a user based on the sales of those projects. Since these rewards depend on human intervention to decide the allocations, these are categorized as [Volume DF](../data-farming/df-intro.md#what-is-volume-df) rewards. OCEAN Data Farming Volume DF rewards are claimable every Thursday on the [Rewards page](https://df.oceandao.org/rewards).
|
||||
When a user allocates veOCEAN to Ocean Market projects, then weekly OCEAN rewards are given to a user based on the sales of those projects. Since these rewards depend on human intervention to decide the allocations, these are categorized as [Volume DF](../data-farming/README.md) rewards. OCEAN Data Farming Volume DF rewards are claimable every Thursday on the [Rewards page](https://df.oceandao.org/rewards).
|
||||
|
||||
</details>
|
||||
|
||||
@ -157,7 +157,7 @@ When a user allocates veOCEAN to Ocean Market projects, then weekly OCEAN reward
|
||||
|
||||
When users submit accurate predictions for the price of Ethereum to the [Challenge DF program](https://df.oceandao.org/challenge-df), they have a chance to win OCEAN rewards by being in the top 3 submissions based on predicted value accuracy.
|
||||
|
||||
These rewards are classified as [Challenge DF](../data-farming/df-intro.md#what-is-challenge-df) rewards since they require active participation in the challenge. Rewards can be claimed every Thursday on the [Rewards page](https://df.oceandao.org/rewards).
|
||||
These rewards are classified as [Challenge DF](../data-farming/README.md) rewards since they require active participation in the challenge. Rewards can be claimed every Thursday on the [Rewards page](https://df.oceandao.org/rewards).
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
@ -32,6 +32,6 @@ The price to subscribe to one feed for 24 hours is 3.00 OCEAN. This includes all
|
||||
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](../data-farming/df-intro.md#reward-schedule) per week.
|
||||
[Ocean Data Farming](https://df.oceandao.org/rewards) (DF) is an incentives program currently with [150K OCEAN rewards](../data-farming/README.md) 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?](../data-farming/df-intro.md#what-are-active-rewards)
|
||||
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?](../data-farming/volumedf.md)
|
||||
Loading…
Reference in New Issue
Block a user