oceanprotocol
/
docs
mirror of https://github.com/oceanprotocol/docs.git
1
0
Fork 0
Code Releases Activity

Fixes 1275

This commit is contained in:
Ana Loznianu 2023-10-19 15:54:19 +03:00
parent 0823b7d584
commit 1cd0db3cae
31 changed files with 106 additions and 106 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
SUMMARY.md
View File

@ -9,7 +9,7 @@
- [Set Up MetaMask Wallet](discover/wallets/metamask-setup.md)
- [Networks](discover/networks/README.md)
- [Bridges](discover/networks/bridges.md)
- [Manage Your OCEAN Tokens](discover/wallets-and-ocean-tokens.md)
- [Manage Your OCEAN](discover/wallets-and-ocean-tokens.md)
- [Glossary](discover/glossary.md)
- [FAQ](discover/faq.md)
- [📚 User Guides](user-guides/README.md)

2
contribute/legal-reqs.md
View File

@ -25,7 +25,7 @@ Otherwise you are an "external contributor" and you must do the following:
- If a copyright notice is not present, then add one.
- If the first line of the file is a line beginning with `#!` (e.g. `#!/usr/bin/python3`) then leave that as the first line and add the copyright notice afterwards.
- If a copyright notice is present but it says something like `Copyright 2018 Ocean Protocol Foundation` then please change it to say the above.
- If a copyright notice is present but it says something like `Copyright 2023 Ocean Protocol Foundation` then please change it to say the above.
- Make sure you're using the correct syntax for comments (which varies from language to language). The example shown above is for a Python file.
1. Read the [Developer Certificate of Origin, Version 1.1](https://developercertificate.org/).

2
contribute/projects-using-ocean.md
View File

@ -9,7 +9,7 @@ description: We are so proud of the companies that use Ocean Protocol tools!
From startups to full enterprises, we have so many collaborators using Ocean tech. Curious who's working with Ocean tools? Check out the up-to-date list of collaborators on the [Ecosystem page](https://oceanprotocol.com/ecosystem).
### Show your support by trading OCEAN tokens
### Show your support by trading OCEAN
Visit [Coingecko's OCEAN markets page](https://www.coingecko.com/en/coins/ocean-protocol#markets) to see all the exchanges that support OCEAN. Here, you can see the most liquid exchanges, and many of them even offer liquidity mining and other yield opportunities.

2
developers/build-a-marketplace/README.md
View File

@ -30,7 +30,7 @@ The tutorial covers:
If you’re completely unfamiliar with Ocean Market or web3 applications in general, you will benefit from reading these guides first:
* To use your clone of Ocean Market, you’ll need a [wallet](../../discover/wallets/README.md). We recommend [getting set up with metamask](../../discover/wallets/metamask-setup.md).
* You’ll also need some [Ocean tokens on a testnet](../../discover/wallets-and-ocean-tokens.md) to use your marketplace.
* You’ll also need some [OCEAN on a testnet](../../discover/wallets-and-ocean-tokens.md) to use your marketplace.
* When you have the testnet tokens, have a go at [publishing a data NFT](../../user-guides/publish-data-nfts.md) on Ocean Market.
* Run through the process of [consuming a data asset](../../user-guides/buy-data-nfts.md) on Ocean Market.

2
developers/community-monetization.md
View File

@ -44,4 +44,4 @@ Additionally, provider fees are not limited to data consumption — they can als
**Benefits to the Ocean Community**
We’re always looking to give back to the Ocean community and collecting fees is an important part of that. As mentioned above, the Ocean Protocol Foundation retains the ability to implement community fees on data consumption. The tokens that we receive will either be burned or invested in the community via projects that they are building. These investments will take place either through [Data Farming](../rewards/df-intro.md), [Ocean Shipyard](https://oceanprotocol.com/shipyard), or Ocean Ventures.
Projects that utilize the Ocean token or H2O are subject to a 0.1% fee. In the case of projects that opt to use different tokens, an additional 0.1% fee will be applied. We want to support marketplaces that use other tokens but we also recognize that they don’t bring the same wider benefit to the Ocean community, so we feel this small additional fee is proportionate.
Projects that utilize OCEAN or H2O are subject to a 0.1% fee. In the case of projects that opt to use different tokens, an additional 0.1% fee will be applied. We want to support marketplaces that use other tokens but we also recognize that they don’t bring the same wider benefit to the Ocean community, so we feel this small additional fee is proportionate.

2
developers/contracts/fees.md
View File

@ -38,7 +38,7 @@ When a user exchanges a [datatoken](datatokens.md) for the privilege of download
* You can retrieve them when calling the initialize endpoint.
* Eg: A provider can charge a fixed fee of 10 USDT per consume, irrespective of the pricing schema used (e.g., fixed rate with ETH, BTC, dispenser).
4. **Ocean Community** Fee
* Ocean's smart contracts collect **Ocean Community fees** during order operations. These fees are reinvested in community projects and distributed to the veOcean holders through Data Farming.
* Ocean's smart contracts collect **Ocean Community fees** during order operations. These fees are reinvested in community projects and distributed to the veOCEAN holders through Data Farming.
* This fee is set at the [smart contract](https://github.com/oceanprotocol/contracts/blob/main/contracts/communityFee/OPFCommunityFeeCollector.sol) level.
* It can be updated by Ocean Protocol Foundation. See details in the [smart contracts](https://github.com/oceanprotocol/contracts/blob/main/contracts/pools/FactoryRouter.sol#L391-L407).

4
developers/contracts/pricing-schemas.md
View File

@ -11,9 +11,9 @@ Ocean Protocol offers you flexible and customizable pricing options to monetize
These models are designed to cater to your specific needs and ensure a smooth experience for data consumers.
The price of an asset is determined by the number of tokens (this can be Ocean Tokens or any ERC20 Token configured when published the asset) a buyer must pay to access the data. When users pay the tokens, they get a _datatoken_ in their wallets, a tokenized representation of the access right stored on the blockchain. To read more about datatoken and data NFT click [here](datanft-and-datatoken.md).
The price of an asset is determined by the number of tokens (this can be OCEAN or any ERC20 Token configured when published the asset) a buyer must pay to access the data. When users pay the tokens, they get a _datatoken_ in their wallets, a tokenized representation of the access right stored on the blockchain. To read more about datatoken and data NFT click [here](datanft-and-datatoken.md).
To provide you with even greater flexibility in monetizing your data assets, Ocean Protocol allows you to customize the pricing schema by configuring your own ERC20 token when publishing the asset. This means that instead of using Ocean Tokens as the pricing currency, you can utilize your own token, aligning the pricing structure with your specific requirements and preferences.
To provide you with even greater flexibility in monetizing your data assets, Ocean Protocol allows you to customize the pricing schema by configuring your own ERC20 token when publishing the asset. This means that instead of using OCEAN as the pricing currency, you can utilize your own token, aligning the pricing structure with your specific requirements and preferences.
You can customised your token this way:

2
developers/ocean-cli/publish.md
View File

@ -69,7 +69,7 @@ To initiate the dataset publishing process, we'll start by updating the helper [
```
{% hint style="info" %}
The provided example creates a consumable asset with a predetermined price of 2 OCEAN tokens. If you wish to modify this and create an asset that is freely accessible, you can do so by replacing the value of "stats.price.value" with 0 in the JSON example mentioned above.
The provided example creates a consumable asset with a predetermined price of 2 OCEAN. If you wish to modify this and create an asset that is freely accessible, you can do so by replacing the value of "stats.price.value" with 0 in the JSON example mentioned above.
{% endhint %}
Now, let's run the command to publish the dataset:

8
developers/ocean.py/technical-details.md
View File

@ -6,7 +6,7 @@ description: Technical details about most used ocean.py functions
At the beginning of most flows, we create an `ocean` object, which is an instance of class [`Ocean`](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py). It exposes useful information, including the following:
* properties for config & OCEAN token
* properties for config & OCEAN
* contract objects retrieval
* users' orders
* provider fees
@ -127,7 +127,7 @@ Configuration fields as dictionary.
</details>
### OCEAN Token Address
### OCEAN Address
* **ocean_address**(`self`) -> `str`
@ -138,7 +138,7 @@ It can be called only by Ocean object and returns the address as a `string`.
`str`
OCEAN token address for that network.
OCEAN address for that network.
**Defined in**
@ -161,7 +161,7 @@ OCEAN token address for that network.
```python
@enforce_types
def get_ocean_token_address(config_dict: dict) -> str:
"""Returns the Ocean token address for given network or web3 instance
"""Returns the OCEAN address for given network or web3 instance
Requires either network name or web3 instance.
"""
addresses = get_contracts_addresses(config_dict)

8
developers/subgraph/get-veocean-stats.md
View File

@ -9,16 +9,16 @@ If you are already familiarized with veOCEAN, you're off to a great start. Howev
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:
{% hint style="info" %}
The veOcean is deployed on the Ethereum mainnet, along with two test networks, namely Mumbai and Goerli. The statistical data available is specifically limited to these networks.
The veOCEAN is deployed on the Ethereum mainnet, along with two test networks, namely Mumbai and Goerli. The statistical data available is specifically limited to these networks.
{% endhint %}
###
### Get the total amount of locked Ocean tokens
### Get the total amount of locked OCEAN
{% tabs %}
{% tab title="JavaScript" %}
You can utilize the following JavaScript code snippet to execute the query and retrieve the total number of locked Ocean tokens:
You can utilize the following JavaScript code snippet to execute the query and retrieve the total number of locked OCEAN:
```runkit nodeVersion="18.x.x"
var axios = require('axios');
@ -48,7 +48,7 @@ axios(config)
{% endtab %}
{% tab title="Python" %}
You can employ the following Python script to execute the query and retrieve the total amount of locked Ocean tokens from the subgraph:
You can employ the following Python script to execute the query and retrieve the total amount of locked OCEAN from the subgraph:
**Create script**

10
discover/basic-concepts.md
View File

@ -24,10 +24,10 @@ Ocean Protocol harnesses the power of blockchain to facilitate secure and audita
By integrating blockchain technology, Ocean Protocol establishes a trusted infrastructure for data exchange. It empowers individuals and organizations to securely share, monetize, and leverage data assets while maintaining control and privacy.
### **OCEAN Tokens: Empowering Data Ownership and Monetization**
### **OCEAN: Empowering Data Ownership and Monetization**
Ocean tokens (**OCEAN**) are the native cryptocurrency of the Ocean Protocol ecosystem. They serve as the medium of exchange for data services, enabling data owners, consumers, and service providers to participate in the data economy. Here's how Ocean tokens are used within the ecosystem:
OCEAN (**OCEAN**) are the native cryptocurrency of the Ocean Protocol ecosystem. They serve as the medium of exchange for data services, enabling data owners, consumers, and service providers to participate in the data economy. Here's how OCEAN are used within the ecosystem:
1. **Data Ownership**: Ocean tokens empower 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 tokens, data owners can exercise even greater control over their data assets.
2. **Data Monetization and Consumption**: Ocean tokens facilitate seamless and secure transactions between data providers and consumers, fostering a thriving new data economy. Data owners can set a price in Ocean tokens 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 tokens for [veOCEAN](../rewards/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](../rewards/README.md) while making a meaningful impact in the data marketplace.
1. **Data Ownership**: OCEAN empower 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](../rewards/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](../rewards/README.md) while making a meaningful impact in the data marketplace.

6
discover/explore.md
View File

@ -38,7 +38,7 @@ These are a few examples of what can be built on top of Ocean.
1. [Ocean Waves](https://waves.oceanprotocol.com/) - Decentralized music [marketplace](https://github.com/oceanprotocol/waves)
2. [Ocean Market](https://market.oceanprotocol.com) - Decentralized data [marketplace](https://github.com/oceanprotocol/market)
3. [Autobot](https://autobotocean.com/) - Tokengated [data farming](https://df.oceandao.org/) intelligence app
4. [Ocean Token Gate](https://tokengate.oceanprotocol.com/) - Tokengated [content](https://github.com/oceanprotocol/token-gating-template)
4. [Ocean token-gating](https://tokengate.oceanprotocol.com/) - Tokengated [content](https://github.com/oceanprotocol/token-gating-template)
5. [Acentrik Market](https://market.acentrik.io/) - Enterprise decentralized data marketplace
</details>
@ -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="../rewards/df-volumedf.md">Data Farming</a> initiative is a key feature of Ocean Protocol that empowers participants to earn <a href="../rewards/">rewards</a> while contributing to a decentralized data economy. By staking Ocean tokens 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="../rewards/df-volumedf.md">Data Farming</a> initiative is a key feature of Ocean Protocol that empowers participants to earn <a href="../rewards/">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 tokens for [veOcean](../rewards/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](../rewards/README.md) while making a meaningful impact in the data marketplace.
Through the Data Farming initiative, you are incentivized to lock OCEAN for [veOCEAN](../rewards/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](../rewards/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.

24
discover/faq.md
View File

@ -28,7 +28,7 @@ To understand more about Ocean's vision, check out this [blog post](https://blog
<details>
<summary>How does Ocean Protocol generate revenue?</summary>
The protocol generates revenue through transaction fees. These fees serve multiple purposes: they fund the ongoing development of Ocean technology and support the buy-and-burn process of the Ocean token.
The protocol generates revenue through transaction fees. These fees serve multiple purposes: they fund the ongoing development of Ocean technology and support the buy-and-burn process of the OCEAN.
To get a glimpse of the revenue generated on the Polygon network, which is the most frequently used network, you can find detailed information [here](https://polygonscan.com/address/0x042BFbd88c3998282153088604207b2AeF045b43#tokentxns).
@ -71,11 +71,11 @@ Yes. Ocean Protocol understands that some data is too sensitive to be shared —
<details>
<summary>To what extent is Ocean becoming fully decentralized?</summary>
<summary>To what extent is OCEAN becoming fully decentralized?</summary>
To be fully decentralized means no single point of control, at any level of the stack. The OCEAN token is already fully decentralized. The Ocean core tech stack is already fully decentralized too: smart contracts on permissionless chains, and anyone can run support middleware. The Data Farming incentives program has some centralized components; we aim to decentralize those in the next 12-24 months. ⁣
To be fully decentralized means no single point of control, at any level of the stack. OCEAN is already fully decentralized. The Ocean core tech stack is already fully decentralized too: smart contracts on permissionless chains, and anyone can run support middleware. The Data Farming incentives program has some centralized components; we aim to decentralize those in the next 12-24 months. ⁣
1. Details about the [Ocean Token](https://oceanprotocol.com/about-us/ocean-token).
1. Details about the [OCEAN](https://oceanprotocol.com/about-us/ocean-token).
2. Details about the [Core Stack](../developers/contracts/README.md).
3. Details about [Data Farming](../rewards/README.md).
@ -90,13 +90,13 @@ You can find a list of past data challenges on the [website](https://oceanprotoc
### Tokenomics
<details>
<summary>How does the OCEAN token capture value?</summary>
<summary>How does OCEAN capture value?</summary>
Please see the [token page](https://www.oceanprotocol.com/token) for up-to-date information about OCEAN tokenomics.
</details>
<details>
<summary>What is the circulating supply of Ocean token? What is the emission schedule for OCEAN?</summary>
<summary>What is the circulating supply of OCEAN? What is the emission schedule for OCEAN?</summary>
All 1.41 Billion Ocean have been [minted](https://blog.oceanprotocol.com/control-over-the-ocean-contract-to-be-revoked-soon-overview-6c5b15be2db) with approximately 700 million Ocean in circulation. The remaining 51% of the supply is earmarked on an emission schedule identical to Bitcoin's emission mechanism, including the 4-year half-life.
</details>
@ -104,13 +104,13 @@ All 1.41 Billion Ocean have been [minted](https://blog.oceanprotocol.com/control
<details>
<summary>Can OCEAN supply become deflationary?</summary>
A portion of the revenue earned in the Ocean ecosystem is earmarked for buy-and-burn. If the transaction volume on Ocean reaches scale and is broadly adopted to the point where the buy-burn mechanism outruns the emissions of Ocean token, the Ocean token supply would deflate.
A portion of the revenue earned in the Ocean ecosystem is earmarked for buy-and-burn. If the transaction volume on Ocean reaches scale and is broadly adopted to the point where the buy-burn mechanism outruns the emissions of OCEAN, the supply would deflate.
</details>
<details>
<summary>Does the OCEAN token also have governance functionality?</summary>
<summary>Does OCEAN also have governance functionality?</summary>
During the OceanDAO grants program (2021-2022), the Ocean token was used for community voting and governance. Currently, there are no governance functions associated with the Ocean Token. In the future, when there is a broader adoption of Ocean technology and a vibrant community and ecosystem has formed around Ocean, further options for community governance with the Ocean token will be explored.
During the OceanDAO grants program (2021-2022), OCEAN was used for community voting and governance. Currently, there are no governance functions associated with the token. In the future, when there is a broader adoption of Ocean technology and a vibrant community and ecosystem has formed around Ocean, further options for community governance with OCEAN will be explored.
</details>
<details>
@ -120,14 +120,14 @@ The Ethereum network has the highest liquidity for OCEAN.
</details>
<details>
<summary>Can the Ocean tech stack be used without utilizing the OCEAN token?</summary>
<summary>Can the Ocean tech stack be used without utilizing OCEAN?</summary>
All Ocean modules and components are open-source and freely available to the community. Developers can change the default currency from OCEAN to a different one for their dApp.
</details>
<details>
<summary>How does the ecosystem and the Ocean token benefit from the usage of the open-source tech stack when transactions can be paid in any currency?</summary>
<summary>How does the ecosystem and the token benefit from the usage of the open-source tech stack when transactions can be paid in any currency?</summary>
For each consume transaction, the Ocean community gets a small fee. This happens whether OCEAN is used or not. [Here are details](../developers/contracts/fees.md)"
</details>
@ -151,7 +151,7 @@ Yes there is - the [Autobot](https://autobotocean.com/) one.
The Ocean Market has consistently served as a showcase for the practical application of Ocean technology. Moreover, it has the potential to set a precedent for the development of other marketplaces within the Ocean ecosystem.
However, it's important to note that participants using the Ocean stack are subject to transaction fees, which vary depending on the chosen token. These fees serve the dual purpose of furthering the development of Ocean technology and facilitating the buy-and-burning of the Ocean token.
However, it's important to note that participants using the Ocean stack are subject to transaction fees, which vary depending on the chosen token. These fees serve the dual purpose of furthering the development of Ocean technology and facilitating the buy-and-burning of OCEAN.
</details>

8
discover/glossary.md
View File

@ -20,7 +20,7 @@ Ocean Protocol is a decentralized data exchange protocol that enables individual
<summary>OCEAN</summary>
The Ocean Protocol token (OCEAN) is a utility token used in the Ocean Protocol ecosystem. It serves as a medium of exchange and a unit of value for data services in the network. Participants in the Ocean ecosystem can use OCEAN tokens to buy and sell data, stake on data assets, and participate in the governance of the protocol.
The Ocean Protocol's token (OCEAN) is a utility token used in the Ocean Protocol ecosystem. It serves as a medium of exchange and a unit of value for data services in the network. Participants in the Ocean ecosystem can use OCEAN to buy and sell data, stake on data assets, and participate in the governance of the protocol.
</details>
@ -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 tokens for a finite period of time, they get veOCEAN tokens 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](../rewards/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](../rewards/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).
</details>
@ -147,7 +147,7 @@ When a user locks their OCEAN tokens for a finite period of time, they get veOCE
<summary>Volume DF</summary>
When a user allocates veOCEAN tokens 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](../rewards/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](../rewards/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).
</details>
@ -165,7 +165,7 @@ These rewards are classified as [Challenge DF](../rewards/df-intro.md#what-is-ch
<summary>H2O</summary>
[H2O](https://www.h2odata.xyz/) is a decentralized protocol that introduced the first non-pegged stable asset, $H2O. Initially, it is backed by the OCEAN token but there are plans to be backed by other data tokens.
[H2O](https://www.h2odata.xyz/) is a decentralized protocol that introduced the first non-pegged stable asset, $H2O. Initially, it is backed by OCEAN but there are plans to be backed by other data tokens.
The H2O non-pegged stable asset is a friendly fork of RAI. Whereas RAI uses ether (ETH) as its asset for collateral, H2O uses OCEAN. The price of H2O is managed by an algorithm that rebalances to bring the redemption price close to the market price and participants are incentivized to aid in this process. Traditional stable assets are pegged to a price such as 1 USD. In contrast, RAI (and soon H2O) are free-floating but typically settle around a price; for RAI this has been \~$3.

4
discover/networks/README.md
View File

@ -7,13 +7,13 @@ description: All the public networks the Ocean Protocol contracts are deployed t
Ocean Protocol contracts are deployed on multiple public networks. You can always find the most up-to-date deployment addresses for all individual contracts in the [address.json](https://github.com/oceanprotocol/contracts/blob/v4main/addresses/address.json).
In each network, whether it's the Ethereum mainnet, a testnet, or the Polygon/Matic network, you'll need ETH or Matic to pay for gas and OCEAN for certain actions on the Ocean Protocol network. The Ethereum mainnet and the Polygon network are both live networks and the tokens on these networks have real value. However, the tokens on the test networks are not of real value and are only used for testing purposes. You can obtain testnet ETH and OCEAN tokens from faucets, which are services that provide small amounts of tokens for free.
In each network, whether it's the Ethereum mainnet, a testnet, or the Polygon/Matic network, you'll need ETH or Matic to pay for gas and OCEAN for certain actions on the Ocean Protocol network. The Ethereum mainnet and the Polygon network are both live networks and the tokens on these networks have real value. However, the tokens on the test networks are not of real value and are only used for testing purposes. You can obtain testnet ETH and OCEAN from faucets, which are services that provide small amounts of tokens for free.
### Ethereum Mainnet
The Ethereum mainnet is a production network, which means that it is a live and operational network that handles real transactions and has actual economic value. To connect to the Ethereum mainnet using a wallet such as MetaMask, you can click on the network name dropdown and select Ethereum mainnet from the list of available networks.
<table data-header-hidden><thead><tr><th width="100">Gas Token</th><th></th></tr></thead><tbody><tr><td>OCEAN Token</td><td><a href="https://etherscan.io/token/0x967da4048cD07aB37855c090aAF366e4ce1b9F48">0x967da4048cD07aB37855c090aAF366e4ce1b9F48</a></td></tr><tr><td>Explorer</td><td><a href="https://etherscan.io">https://etherscan.io</a></td></tr></tbody></table>
<table data-header-hidden><thead><tr><th width="100">Gas Token</th><th></th></tr></thead><tbody><tr><td>OCEAN</td><td><a href="https://etherscan.io/token/0x967da4048cD07aB37855c090aAF366e4ce1b9F48">0x967da4048cD07aB37855c090aAF366e4ce1b9F48</a></td></tr><tr><td>Explorer</td><td><a href="https://etherscan.io">https://etherscan.io</a></td></tr></tbody></table>
### Polygon Mainnet

6
discover/networks/bridges.md
View File

@ -7,11 +7,11 @@ description: Transfer tokens between two blockchain networks.
A bridge is a mechanism that connects two or more separate blockchain networks, enabling communication and interoperability between them. Bridges can be designed to facilitate the transfer of assets, data, or messages between different blockchain networks that may operate on different protocols, and consensus mechanisms, or have different native currencies.
We suggest using the following solutions to transfer Ocean tokens between Ethereum mainnet and Polygon or BSC.
We suggest using the following solutions to transfer OCEAN between Ethereum mainnet and Polygon or BSC.
## BNB Smart Chain Bridge
To transfer Ocean tokens to and from the BNB Smart Chain, we recommend using the [Binance Bridge](https://www.bnbchain.org/en/bridge). BSC offers various options such as withdrawing crypto from [Binance](https://www.binance.com/en) and utilizing the [Binance Bridge](https://www.bnbchain.org/en/bridge). You can refer to the Binance Academy article "[How to Get Started with BSC](https://academy.binance.com/en/articles/how-to-get-started-with-binance-smart-chain-bsc)" for more information.
To transfer OCEAN to and from the BNB Smart Chain, we recommend using the [Binance Bridge](https://www.bnbchain.org/en/bridge). BSC offers various options such as withdrawing crypto from [Binance](https://www.binance.com/en) and utilizing the [Binance Bridge](https://www.bnbchain.org/en/bridge). You can refer to the Binance Academy article "[How to Get Started with BSC](https://academy.binance.com/en/articles/how-to-get-started-with-binance-smart-chain-bsc)" for more information.
{% hint style="warning" %}
In case you opt for an alternative bridge option and intend to transfer tokens to Binance, it is **crucial** to ensure that the contract address you are sending the tokens to is correct.
@ -43,7 +43,7 @@ When you access the wallet's main page, you'll be able to view all the tokens yo
![Main wallet page](../../.gitbook/assets/wallet/polygon-wallet-page.png)
In case you are unable to find the Ocean token in the list while depositing, simply click on "Manage token list" and enable the Polygon Tokens option, which contains a greater number of listed tokens. This will add Ocean to the tokens list.
In case you are unable to find OCEAN in the list while depositing, simply click on "Manage token list" and enable the Polygon Tokens option, which contains a greater number of listed tokens. This will add Ocean to the tokens list.
![Ocean on Polygon](../../.gitbook/assets/wallet/polygon-ocean.png)

2
discover/ocean-101.md
View File

@ -10,7 +10,7 @@ Ocean Protocol utilizes a combination of blockchain technology, decentralized ne
2. **Discovery and Access Control**: Data consumers can discover available data assets through decentralized metadata services like Aquarius. Access control mechanisms, such as smart contracts, verify the consumer's permissions and handle the transfer of data access tokens.
3. **Secure Data Exchange**: When a data consumer purchases access to a data asset, the asset's metadata, and access instructions are encrypted by the data provider using the Provider service. The encrypted asset is then securely transferred to the consumer, who can decrypt and utilize it without revealing the asset's URL.
4. [**Compute-to-Data**](../developers/compute-to-data/README.md) **(C2D)**: Ocean Protocol supports C2D capabilities, allowing data consumers to perform computations on data assets without direct access to the underlying data. The compute operations are executed in a secure and controlled environment, ensuring data privacy and compliance.
5. **Incentives and Governance**: Ocean Protocol incorporates tokenomics and a governance framework to incentivize participants and ensure the sustainability and evolution of the ecosystem. Participants can earn and stake Ocean tokens (OCEAN) for veOCEANs, curate data, contribute to the network and participate in governance decisions.
5. **Incentives and Governance**: Ocean Protocol incorporates tokenomics and a governance framework to incentivize participants and ensure the sustainability and evolution of the ecosystem. Participants can earn and stake OCEAN for veOCEAN, curate data, contribute to the network and participate in governance decisions.
Ocean Protocol also combines advanced technologies and web components to create a robust and efficient data ecosystem.

12
discover/wallets-and-ocean-tokens.md
View File

@ -1,12 +1,12 @@
---
description: >-
How to use a crypto wallet to check your OCEAN token balance and send OCEAN
How to use a crypto wallet to check your OCEAN balance and send OCEAN
Tokens to others
---
# Manage Your OCEAN Tokens
# Manage Your OCEAN
If you don't see any Ocean Tokens in your crypto wallet software 🔎 (e.g. MetaMask or MyEtherWallet), don't worry! It might not know how to manage Ocean Tokens yet.
If you don't see any OCEAN in your crypto wallet software 🔎 (e.g. MetaMask or MyEtherWallet), don't worry! It might not know how to manage OCEAN yet.
### Token Information
@ -61,7 +61,7 @@ Almost all ERC-20 wallets require these values for adding a custom token:
</tbody>
</table>
The [OCEAN Token page](https://oceanprotocol.com/token) at oceanprotocol.com has further details.
The [token page](https://oceanprotocol.com/token) at oceanprotocol.com has further details.
### MetaMask
@ -69,7 +69,7 @@ The [OCEAN Token page](https://oceanprotocol.com/token) at oceanprotocol.com has
2. Select the account you want to manage.
3. Scroll down until the `Import Tokens` link is visible, then click on it.
4. Click on `Custom Tokens`.
5. Paste the Ocean Token contract address listed above into the _Token Contract Address_ field. The other two fields should auto-fill. If not, add `OCEAN` for the symbol and `18` for the precision.
5. Paste the OCEAN contract address listed above into the _Token Contract Address_ field. The other two fields should auto-fill. If not, add `OCEAN` for the symbol and `18` for the precision.
6. Click `Add custom token`.
7. Click `Import Tokens`.
@ -78,7 +78,7 @@ If you prefer visual demonstrations, we have prepared a visual demo that illustr
{% embed url="https://app.arcade.software/share/yHiKKN336QGdAkhTlsIh" fullWidth="false" %}
{% endembed %}
MetaMask should now show your Ocean Token (OCEAN) balance, and when you're looking at that, there should be a `Send` button to send Ocean Tokens to others. For help with that, see [the MetaMask docs about how to send tokens](https://metamask.zendesk.com/hc/en-us/articles/360015488931-How-to-Send-Tokens).
MetaMask should now show your OCEAN balance, and when you're looking at that, there should be a `Send` button to send OCEAN to others. For help with that, see [the MetaMask docs about how to send tokens](https://metamask.zendesk.com/hc/en-us/articles/360015488931-How-to-Send-Tokens).
### Other Wallet Software

8
discover/wallets/README.md
View File

@ -16,17 +16,17 @@ In the blockchain world, a wallet is a software program that stores cryptocurren
* **Easiest:** Use the [MetaMask](https://metamask.io/) browser plug-in.
* **Still easy, but more secure:** Get a [Trezor](https://trezor.io/) or [Ledger](https://www.ledger.com/) hardware wallet, and use MetaMask to interact with it.
* The [OCEAN Token page](https://oceanprotocol.com/token) at oceanprotocol.com lists some other possible wallets.
* The [token page](https://oceanprotocol.com/token) at oceanprotocol.com lists some other possible wallets.
### Related Terminology
When you set up a new wallet, it might generate a **seed phrase** for you. Store that seed phrase somewhere secure and non-digital (e.g. on paper in a safe). It's extremely secret and sensitive. Anyone with your wallet's seed phrase could spend all the Ether and Ocean Tokens in all the accounts in your wallet.
When you set up a new wallet, it might generate a **seed phrase** for you. Store that seed phrase somewhere secure and non-digital (e.g. on paper in a safe). It's extremely secret and sensitive. Anyone with your wallet's seed phrase could spend all tokens of all the accounts in your wallet.
Once your wallet is set up, it will have one or more **accounts**.
Each account has several **balances**, e.g. an Ether balance, an Ocean Token balance, and maybe other balances. All balances start at zero.
Each account has several **balances**, e.g. an Ether balance, an OCEAN balance, and maybe other balances. All balances start at zero.
An account's Ether balance might be 7.1 ETH in the Ethereum Mainnet, 2.39 ETH in Görli testnet. You can move ETH from one network to another only with a special setup exchange or bridge. Also, you can't transfer tokens from networks holding value such as Ethereum mainnet to networks not holding value, i.e., testnets like Görli. The same is true of OCEAN token balances.
An account's Ether balance might be 7.1 ETH in the Ethereum Mainnet, 2.39 ETH in Görli testnet. You can move ETH from one network to another only with a special setup exchange or bridge. Also, you can't transfer tokens from networks holding value such as Ethereum mainnet to networks not holding value, i.e., testnets like Görli. The same is true of the OCEAN balances.
Each account has one **private key** and one **address**. The address can be calculated from the private key. You must keep the private key secret because it's what's needed to spend/transfer ETH and OCEAN (or to sign transactions of any kind). You can share the address with others. In fact, if you want someone to send some ETH or OCEAN to an account, you give them the account's address.

2
discover/wallets/metamask-setup.md
View File

@ -30,7 +30,7 @@ Before you can publish or purchase assets, you will need a crypto wallet. As Met
![MetaMask browser extension](../../.gitbook/assets/wallet/metamask-browser-extension.png)
* You can now manage Ether and Ocean Tokens with your wallet. You can copy your account address to the clipboard from the options. When you want someone to send Ether or Ocean Tokens to you, you will have to give them that address. It's not a secret.
* You can now manage ETH and OCEAN with your wallet. You can copy your account address to the clipboard from the options. When you want someone to send ETHs or OCEAN to you, you will have to give them that address. It's not a secret.
![Manage tokens](../../.gitbook/assets/wallet/manage-tokens.png)

4
rewards/README.md
View File

@ -58,7 +58,7 @@ This offers contributors a variety of ways to help Ocean Protocol grow and incre
#### Curate Data with Volume DF
If you have locked your OCEAN tokens in exchange for veOCEAN, this is the ideal opportunity for you to utilize those veOCEAN tokens to earn higher yield.
If you have locked your OCEAN in exchange for veOCEAN, this is the ideal opportunity for you to utilize those veOCEAN to earn higher yield.
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.
@ -82,7 +82,7 @@ The user guide on [how to Challenge DF](user-guides/how-to-challengedf.md) will
## Further Reading
Finally, if you want to continue expanding your knowledge on OCEAN token emissions, APY estimates, and get useful answers to some of the most common questions, you can read the following:
Finally, if you want to continue expanding your knowledge on OCEAN emissions, APY estimates, and get useful answers to some of the most common questions, you can read the following:
[Emissions & APYs](df-emissions-apys.md) will provide you will information about how OCEAN will be released over time through the Data Farming program and provide you with APY studies.

2
rewards/df-challengedf.md
View File

@ -24,7 +24,7 @@ _Total - 5000 OCEAN_
- A fresh challenge [begins and concludes every Thursday](df-intro.md#weekly-rounds).
- You have to submit your entry before the deadline.
- At the beginning of each week, a predetermined amount of OCEAN tokens is allocated as rewards.
- At the beginning of each week, a predetermined amount of OCEAN is allocated as rewards.
- Competitors need to submit 12 predictions by using a DataNFT to share data.
- The rewards are divided into specific amounts for the top three positions.
- The individuals who submit the top three entries will receive rewards, and their wallet addresses will be showcased within the Data Farming dapp.

34
rewards/df-faq.md
View File

@ -7,7 +7,7 @@ description: Frequently Asked Questions about Data Farming
### 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>
<summary>I'm new to Ocean and I want to stake my OCEAN. 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.
@ -24,7 +24,7 @@ We cannot offer guidance as how to allocate your voting power, that's your decis
### Basics
<details>
<summary>Are veOCEAN tokens tradeable or have a market price?</summary>
<summary>Are veOCEAN tradeable or have a market price?</summary>
No. They cannot be traded, transferred, or sold. ⁣
⁣
@ -55,10 +55,10 @@ You can find a list of [all supported chains here](../discover/networks/README.m
<details>
<summary>What is veOcean and staking in context of Ocean Protocol? </summary>
<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)
[veOCEAN](df-veocean.md) (vote-escrowed OCEAN) is a special token in the Ocean Protocol ecosystem. Users can obtain veOCEAN by Locking their OCEAN 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 at - [df.oceandao.org](https://df.oceandao.org)
</details>
@ -73,7 +73,7 @@ You will get passive rewards by default when you lock tokens. On top of that, yo
<details>
<Summary>I locked my OCEAN for veOcean but can't see the rewards. What am I missing?</Summary>
<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. 😊
@ -83,7 +83,7 @@ Please hang in there and stay patient, as it can take almost two weeks to receiv
<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
Yes. When you lock OCEAN, you'll receive them back at the end of the lock-up period. If the value increases during this time, your OCEAN will appreciate in worth. The same principle applies in reverse if the value decreases
</details>
@ -112,7 +112,7 @@ You can also earn active staking rewards by assigning your veOCEAN directly on d
<details>
<summary>Why the ratio between psdnOCEAN and OCEAN tokens is not close to 1:1?</summary>
<summary>Why the ratio between psdnOCEAN and OCEAN 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.
@ -132,7 +132,7 @@ You can convert psdnOCEAN back to OCEAN using the Balancer AMM liquidity [pool](
<details>
<summary>What's the amount of veOcean one can get for locking 1 Ocean token?</summary>
<summary>What's the amount of veOCEAN one can get for locking 1 OCEAN?</summary>
1 veOCEAN if you lock for 4 years. Learn more about VeOCEAN [here](df-veocean.md).
@ -148,11 +148,11 @@ You can't withdraw before the [unlock date](df-veocean.md).
<details>
<summary>Is there a way to transform VeOcean to Ocean gradually over the lock period?</summary>
<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.
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.
To learn more about VeOcean, check out this [resource](df-veocean).
To learn more about veOCEAN, check out this [resource](df-veocean).
</details>
@ -168,7 +168,7 @@ When [gas](https://www.useweb3.xyz/gas) is cheap.
<details>
<summary>When I claim my Ocean tokens, do I need to restake them manually, or are they auto-compounded?</summary>
<summary>When I claim my OCEAN, do I need to restake them manually, or are they auto-compounded?</summary>
They are not auto-compounded.
@ -198,7 +198,7 @@ To boost your APY, consider locking your OCEAN for a more extended period. It's
<details>
<summary>Could you explain the benefits of staking OCEAN tokens and how the APY is calculated?</summary>
<summary>Could you explain the benefits of staking OCEAN and how the APY is calculated?</summary>
Yes, You can find the details in these resources.⁣
1. [Benefits](df-veocean).
@ -284,9 +284,9 @@ However, your voting power is counted progressively throughout the week and requ
<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.
When it comes to active staking, you aren't exposed to additional risks. Your veOCEAN 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.
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 are held securely in lock.
More info [here](user-guides/how-to-volumedf.md).
@ -323,7 +323,7 @@ Caveat: it’s no at least in theory! Sometimes there may be tweaks if there is
<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. ⁣
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 in circulation, out of which approximately 30 million have been locked. ⁣
</details>

4
rewards/df-intro.md
View File

@ -30,7 +30,7 @@ Each Data Farming round has a pool of OCEAN rewards, where 50% of the pool is pa
### What are Passive Rewards?
Passive rewards are the OCEAN rewards paid to Data Farmers just for locking their OCEAN tokens.
Passive rewards are the OCEAN rewards paid to Data Farmers just for locking their OCEAN.
veOCEAN holders can generate yield completely passively if they wish, though they are incentivized with larger real yield if they **actively participate** in farming yield from assets, or completing prediction challenges.
@ -63,7 +63,7 @@ Rewards are paid in OCEAN to contributors actively working to improve Ocean Prot
### What is Volume DF
[Volume DF](df-volumedf.md#curate-data-in-volume-df) 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.
[Volume DF](df-volumedf.md#curate-data-in-volume-df) rewards Data Farmers that allocate their veOCEAN 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/how-to-volumedf.md).

12
rewards/df-veocean.md
View File

@ -11,7 +11,7 @@ description: >-
"ve" stands for <mark style="color:orange;">**vote escrowed**</mark>. And the "vote" part of "ve" and veOCEAN is what you really need to pay attention to in order to truly understand the function of this token.
You see, when you acquire veOCEAN via locking your OCEAN tokens in the Data Farming dApp, the intended use is to **vote on your favorite assets** in the Ocean ecosystem!
You see, when you acquire veOCEAN via locking your OCEAN in the Data Farming dApp, the intended use is to **vote on your favorite assets** in the Ocean ecosystem!
When you allocate to assets that sell, then **you get a portion of the sales**!
@ -32,9 +32,9 @@ veOCEAN allows you to engage with different Ocean Protocol mechanisms and benefi
Users can lock their OCEAN for different lengths of time to gain more veOCEAN **voting power**. The Data Farming dApp is designed to lock OCEAN for **a minimum of 2 weeks and a maximum of four years** (for max rewards). The longer you lock your OCEAN, the more veOCEAN + OCEAN rewards you get!
On the dApp's [veOCEAN page](https://df.oceandao.org/veocean), the "Lock Multiplier" represents the percentage amount of veOCEAN tokens received per OCEAN token locked.
On the dApp's [veOCEAN page](https://df.oceandao.org/veocean), the "Lock Multiplier" represents the percentage amount of veOCEAN received per OCEAN locked.
When users commit to locking their OCEAN tokens for an extended time duration, they are rewarded with an increased amount of veOCEAN tokens. This incentivizes users to have act with strong network support and confidence in the ecosystem.
When users commit to locking their OCEAN for an extended time duration, they are rewarded with an increased amount of veOCEAN. This incentivizes users to have act with strong network support and confidence in the ecosystem.
| Year | Lock Multiplier | veOCEAN |
| ---- | --------------- | ------- |
@ -53,7 +53,7 @@ Your veOCEAN balance will slowly start declining as soon as you receive it.
veOCEAN balance decreases linearly over time until the Lock End Date. When your lock time has lapsed by 50%, you will have 50% of your original veOCEAN balance.
When your lock time ends your veOCEAN balance will hit 0, and your OCEAN tokens can be withdrawn.
When your lock time ends your veOCEAN balance will hit 0, and your OCEAN can be withdrawn.
If you lock 1.0 OCEAN for 4 years, you get 1.0 veOCEAN at the start.
@ -100,9 +100,9 @@ Put another way, from the time you lock OCEAN, you must wait at least a week, an
veOCEAN is architected to be locked (i.e. 'staked') for a certain period of time and cannot be transferred or sold during the lock time that is determined by each user.
So it's important to note that: **"you will not be able to retrieve your locked OCEAN tokens until the Lock End Date you selected on the dApp!**
So it's important to note that: **"you will not be able to retrieve your locked OCEAN until the Lock End Date you selected on the dApp!**
After the Lock End Date, then you can withdraw your principal OCEAN tokens on the [veOCEAN page](https://df.oceandao.org/veocean) on the left side panel.
After the Lock End Date, then you can withdraw your principal OCEAN on the [veOCEAN page](https://df.oceandao.org/veocean) on the left side panel.
### Flow of Value

4
rewards/df-volumedf.md
View File

@ -11,13 +11,13 @@ description: >-
If you obtain veOCEAN to only get passive yield, then you're leaving money on the table.
Volume DF rewards Data Farmers that allocate their veOCEAN tokens to Ocean ecosystem assets.
Volume DF rewards Data Farmers that allocate their veOCEAN to Ocean ecosystem assets.
It's called Volume DF because the amount of rewards relies on assets that are actively generating Data Consume Volume. Therefore, **Volume DF yields depend on the sales produced by these assets and allocations made.**
## Crops of Data
Data Farming rewards farmers that allocate their veOCEAN tokens to assets that **generate revenue** in the Ocean ecosystem. (no revenue, no rewards) In addition, Data Farming incentivizes **publishing** assets in the Ocean ecosystem too - you get **2x the Allocation Power** when you allocate to an asset that you publish!
Data Farming rewards farmers that allocate their veOCEAN to assets that **generate revenue** in the Ocean ecosystem. (no revenue, no rewards) In addition, Data Farming incentivizes **publishing** assets in the Ocean ecosystem too - you get **2x the Allocation Power** when you allocate to an asset that you publish!
Thus, if you really want to max out Volume DF APY:
1. Lock your OCEAN for 4 years to receive 100% voting power.

4
rewards/user-guides/how-to-claim-rewards.md
View File

@ -1,12 +1,12 @@
---
description: How to claim OCEAN token rewards from data farming 🧑‍🌾🥕
description: How to claim OCEAN rewards from data farming 🧑‍🌾🥕
---
# Claim Rewards Data Farming
<figure><img src="../../.gitbook/assets/gif/underwater-treasure.gif" alt=""><figcaption></figcaption></figure>
Ocean Protocol's Data Farming dapp dispenses rewards **every Thursday** to its participants. 💰 To claim your OCEAN token rewards for data farming, simply navigate to the Data Farming [Rewards page](https://df.oceandao.org/rewards) and click the Claim OCEAN rewards buttons that will appear pink and clickable each Thursday. Yeehaw!
Ocean Protocol's Data Farming dapp dispenses rewards **every Thursday** to its participants. 💰 To claim your OCEAN rewards for data farming, simply navigate to the Data Farming [Rewards page](https://df.oceandao.org/rewards) and click the Claim OCEAN rewards buttons that will appear pink and clickable each Thursday. Yeehaw!
You can visit this dApp to [begin Data Farming](https://df.oceandao.org)? Or [follow this user guide](how-to-veocean.md) to get started. 🤠

20
rewards/user-guides/how-to-veocean.md
View File

@ -1,22 +1,22 @@
---
description: Get veOCEAN tokens to use the Data Farming dApp and make yield! 🧑‍🌾🥕
description: Get veOCEAN to use the Data Farming dApp and make yield! 🧑‍🌾🥕
---
<figure><img src="../../.gitbook/assets/gif/super-mario-coins.gif" alt="" width="250"><figcaption><p>Get veOCEAN tokens</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/gif/super-mario-coins.gif" alt="" width="250"><figcaption><p>Get veOCEAN</p></figcaption></figure>
# What is veOCEAN and Passive Rewards
In order to **gain yield Data Farming**, you will need to lock your OCEAN tokens first! When you lock your OCEAN tokens, you get **veOCEAN tokens** 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 tokens to your favorite assets and get a portion of their sales!
In order to **gain yield Data Farming**, 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!
### Don't have OCEAN tokens yet? Get those first!
### Don't have OCEAN yet? Get those first!
#### Step 1 - Get OCEAN tokens
#### Step 1 - Get OCEAN
- Acquire OCEAN via a decentralized exchange (DEX) such as Uniswap or a centralized exchange (CEX) such as Binance, Coinbase, etc.
#### Step 2 - Send to your self-custody wallet
- Send your OCEAN tokens to a self-custody wallet of yours that supports ERC-20 tokens, like Metamask for example.
- Send your OCEAN to a self-custody wallet of yours that supports ERC-20 tokens, like Metamask for example.
### Where the rubber meets the road 🚗💨
@ -32,19 +32,19 @@ Watch and learn, friend
#### Step 4 - Connect Your Wallet + Lock your OCEAN for veOCEAN
- Click on the purple circles in the interactive demo to walk through the steps for locking your OCEAN tokens for veOCEAN tokens.
- Click on the purple circles in the interactive demo to walk through the steps for locking your OCEAN for veOCEAN.
{% embed url="https://app.arcade.software/share/FUSkygksSRsJHwle1zFs" fullWidth="false" %}
{% endembed %}
In this step you will:
- Enter the amount of OCEAN tokens that you are going to lock up
- Select a Lock End Date indicating how many weeks you’re going to lock up your OCEAN tokens. (As the Lock End Date goes farther into the future, your Lock Multiplier increases).
- Enter the amount of OCEAN that you are going to lock up
- Select a Lock End Date indicating how many weeks you’re going to lock up your OCEAN. (As the Lock End Date goes farther into the future, your Lock Multiplier increases).
- Click on the checkbox to agree to the disclaimer.
- Click the pink “Approve # OCEAN” button
- Accept the transaction in your wallet.
- Click the “Create Lock” button.
- Accept the transaction in your wallet.
Congratulations! You have now locked your OCEAN tokens for veOCEAN tokens and are generating passive yield automatically. You can [claim your passive OCEAN rewards](how-to-claim-rewards.md) every Thursday - note that your first time claiming rewards will require at least one week, but not more than 2 weeks of wait!
Congratulations! You have now locked your OCEAN for veOCEAN and are generating passive yield automatically. You can [claim your passive OCEAN rewards](how-to-claim-rewards.md) every Thursday - note that your first time claiming rewards will require at least one week, but not more than 2 weeks of wait!

2
rewards/user-guides/how-to-volumedf.md
View File

@ -43,4 +43,4 @@ We'll show you how!
<figure><img src="../../.gitbook/assets/rewards/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 tokens and are generating active rewards yield. Now, just wait until next Thursday to see if you can [claim any OCEAN rewards](how-to-claim-rewards.md) on the Active Rewards section of the [Rewards page](https://df.oceandao.org/rewards) for your portion of the assets' sales. Remember that your first time claiming rewards will require at least one week, but not more than 2 weeks of wait!
That's it! You've successfully allocated (aka "voted on") your favorite assets in the Ocean ecosystem using your veOCEAN and are generating active rewards yield. Now, just wait until next Thursday to see if you can [claim any OCEAN rewards](how-to-claim-rewards.md) on the Active Rewards section of the [Rewards page](https://df.oceandao.org/rewards) for your portion of the assets' sales. Remember that your first time claiming rewards will require at least one week, but not more than 2 weeks of wait!

8
user-guides/buy-data-nfts.md
View File

@ -28,7 +28,7 @@ Once you're confident that the dataset meets your requirements, you're ready to
#### Step 1 - Buy the asset 🫰
The Buy button is enabled only if the connected wallet address has enough OCEAN tokens to purchase the asset.
The Buy button is enabled only if the connected wallet address has enough OCEAN to purchase the asset.
![Click the large pink Buy button](../.gitbook/assets/market/consume-1.png)
@ -38,11 +38,11 @@ Are you buying an asset on the Polygon network? Then you'll need mOCEAN "matic O
Learn how to get mOCEAN
{% endembed %}
#### Step 2 - Confirm the 1st of 3 transactions - Allow access to OCEAN tokens
#### Step 2 - Confirm the 1st of 3 transactions - Allow access to OCEAN
![Transaction 1: Give the smart contract permission to access OCEAN tokens](../.gitbook/assets/market/consume-2.png)
![Transaction 1: Give the smart contract permission to access OCEAN](../.gitbook/assets/market/consume-2.png)
#### Step 3 - Confirm the 2nd of 3 transactions - Buy the asset in exchange for OCEAN tokens 💸
#### Step 3 - Confirm the 2nd of 3 transactions - Buy the asset in exchange for OCEAN 💸
![Transaction 2: Buy the datatoken giving you access to the asset](../.gitbook/assets/market/consume-3.png)

2
user-guides/using-ocean-market.md
View File

@ -27,4 +27,4 @@ The Ocean Market is a place for buyers + sellers of top-notch data and algorithm
* [Wallet Basics](../discover/wallets/README.md) 👛
* [Set Up MetaMask](../discover/wallets/metamask-setup.md) 🦊
* [Manage Your OCEAN Tokens](../discover/wallets-and-ocean-tokens.md) 🪙
* [Manage Your OCEAN](../discover/wallets-and-ocean-tokens.md) 🪙