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

Merge pull request #1267 from oceanprotocol/Wanderclyffex-patch-2 

Refinement of the FAQ
This commit is contained in:
Ana 2023-10-18 18:40:51 +03:00 committed by GitHub
parent 3f9be6b462 b53e6a76b4
commit 0823b7d584
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
54 changed files with 278 additions and 1030 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -29,7 +29,7 @@ layout: landing
</tr>
<tr>
<td><a href="user-guides/">user-guides</a></td>
<td>Follow our step-by-step instructions for a no-code solution to unleash the power of Ocean Protocol technologies!</td>
<td>Follow the step-by-step instructions for a no-code solution to unleash the power of Ocean Protocol technologies!</td>
<td></td>
<td></td>
<td><a href="user-guides/">user-guides</a></td>

3
SUMMARY.md
View File

@ -103,6 +103,7 @@
- [Encryption / Decryption](developers/provider/encryption-decryption.md)
- [Compute Endpoints](developers/provider/compute-endpoints.md)
- [Authentication Endpoints](developers/provider/authentication-endpoints.md)
- [Developer FAQ](developers/dev-faq.md)
- [📊 Data Science](data-science/README.md)
- [Data Value Creation Loop](data-science/the-data-value-creation-loop.md)
- [What data is valuable?](data-science/data-engineers.md)
@ -136,6 +137,6 @@
- [Delegate Curation](rewards/user-guides/how-to-delegate.md)
- [Predict with Challenge DF](rewards/user-guides/how-to-challengedf.md)
* [🤝 Contribute](contribute/README.md)
* [Partners & Collaborators](contribute/projects-using-ocean.md)
* [Collaborators](contribute/projects-using-ocean.md)
* [Contributor Code of Conduct](contribute/code-of-conduct.md)
* [Legal Requirements](contribute/legal-reqs.md)

25
contribute/README.md
View File

@ -11,22 +11,22 @@ coverY: 0
### Report a bug 🐞
Do you think you see a bug in our code? To report a bug that _isn't a vulnerability_, go to the relevant GitHub repository, click on the _Issues_ tab, and select _Bug Report_.
Have you found a bug in the code? To report a bug that _isn't a vulnerability_, go to the relevant GitHub repository, click on the _Issues_ tab, and select _Bug Report_.
First, make sure that you search existing open + closed issues + PRs to see if your bug has already been reported there. If not, then go ahead and create a new bug report! 🦸
#### Do you see an error in the Ocean Market?
Follow our steps below to properly document your bug! Paste the screenshots into your GitHub issue.
Follow the steps below to properly document your bug! Paste the screenshots into your GitHub issue.
{% embed url="https://app.arcade.software/share/fUNrK6z2eurJ2C1ty2OG" fullWidth="false" %}
{% endembed %}
### Report vulnerabilities
For all the super sleuths out there, you may be able to earn a bounty for reporting vulnerabilities in sensitive parts of our code. Check out our page on [Immunify](https://immunefi.com/bounty/oceanprotocol/) for the latest bug bounties available. You can also responsibly disclose flaws by emailing us at [security@oceanprotocol.com](mailto:security@oceanprotocol.com).
For all the super sleuths out there, you may be able to earn a bounty for reporting vulnerabilities in sensitive parts of the code. Check out this page on [Immunify](https://immunefi.com/bounty/oceanprotocol/) for the latest bug bounties available. You can also responsibly disclose flaws by emailing us at [security@oceanprotocol.com](mailto:security@oceanprotocol.com).
<figure><img src="../.gitbook/assets/gif/matrix-code.gif" alt=""><figcaption><p>Did you find a glitch in our code matrix?</p></figcaption></figure>
<figure><img src="../.gitbook/assets/gif/matrix-code.gif" alt=""><figcaption><p>Did you find a glitch in the code matrix?</p></figcaption></figure>
### Suggest a new feature 🤔💭
@ -36,14 +36,14 @@ As with bug reports, don't forget to search existing open + closed issues + PRs
### Improve core software
It takes a tribe of awesome coders to build our tech stack, and you're invited to pitch in 😊 We'd love to have you contribute to any repository within the `oceanprotocol` [GitHub](https://github.com/oceanprotocol) organization!
It takes a tribe of awesome coders to build a tech stack, and you're invited to pitch in 😊 We'd love to have you contribute to any repository within the `oceanprotocol` [GitHub](https://github.com/oceanprotocol) organization!
Before you start coding, please follow these basic guidelines:
* If no feature request issue for your case is present, **please open one first before starting to work on something, so it can be discussed openly with Ocean core team**.
* Make yourself familiar with the repository-specific contribution requirements and code style requirements.
* Because of the weird world of intellectual property, we need you to follow the [legal requirements](legal-reqs.md) for contributing code.
* Be excellent to each other in the comments, as outlined in our [Contributor Code of Conduct](code-of-conduct.md).
* Be excellent to each other in the comments, as outlined in the [Contributor Code of Conduct](code-of-conduct.md).
#### Your contribution workflow
@ -58,22 +58,21 @@ Before you start coding, please follow these basic guidelines:
Depending on the release management of each repository, your contribution will be either included in a next release, or deployed live automatically.
Except for GitHub, you can chat with most Ocean Protocol core developers in our [Discord](https://discord.gg/TnXjkR5) if you have further development questions.
Except for GitHub, you can chat with most Ocean Protocol core developers in the [Discord](https://discord.gg/TnXjkR5) if you have further development questions.
### Develop a dApp or integration on top of Ocean Protocol
We LOVE builders of dApps on Ocean! Nothing makes us feel prouder than seeing you create awesome things with our open-source tools.
We LOVE builders of dApps on Ocean! Nothing makes us feel prouder than seeing you create awesome things with these open-source tools.
If you need ANY help, then we're here to talk with you on [Discord](https://discord.gg/TnXjkR5) to give you advice. We're also consistently improving our docs to help you. And... you're here :)
If you need ANY help, then we're here to talk with you on [Discord](https://discord.gg/TnXjkR5) to give you advice. We're also consistently improving these docs to help you. And... you're here :)
### Improve our docs
### Improve the docs
Our docs repo can always be improved. If you found a mistake or have an improvement to make, then follow the steps in our [contribution workflow](./#your-contribution-workflow) to commit your changes.
The docs repo can always be improved. If you found a mistake or have an improvement to make, then follow the steps in the [contribution workflow](./#your-contribution-workflow) to submit your changes.
### Apply for a developer job
Do you REALLY love building on Ocean Protocol? Consider joining us full-time! Our openings are listed at [https://github.com/oceanprotocol/jobs](https://github.com/oceanprotocol/jobs).
Check our [Community Page](https://www.oceanprotocol.com/community) for our social media links where you can join the buzz around Ocean or chat with us directly 😊 Toodles!
Scroll a bit further, and at this page's footer, you'll find the social media links that allow you to join the Ocean community or engage in direct chats with us. 😊 Toodles!

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

@ -1,13 +1,13 @@
---
title: Partners & Collaborators
title: Collaborators
description: We are so proud of the companies that use Ocean Protocol tools!
---
# Partners & Collaborators
# Collaborators
<figure><img src="../.gitbook/assets/gif/anchorman-teamwork.gif" alt=""><figcaption></figcaption></figure>
From startups to full enterprises, we have so many partners and collaborators using Ocean tech. Curious who's working with Ocean tools? Check out our up-to-date list of our partners and collaborators on the [Ecosystem page](https://oceanprotocol.com/ecosystem) of our website.
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

2
data-science/README.md
View File

@ -10,7 +10,7 @@ coverY: 0
### Why should data scientists use Ocean Protocol?
Ocean Protocol is built for data scientists to **monetize data effectively and** solve the ["Data Value Creation Loop"](the-data-value-creation-loop.md). Our [open-source tools](https://github.com/oceanprotocol) tackle some of **the biggest problems for data scientists**: how to sell data anonymously, how to sell compute jobs on datasets, how to control access to data, etc. By using blockchain architecture, Ocean achieves several tactical advantages over Web2 to solve these data sharing problems.
Ocean Protocol is built for data scientists to **monetize data effectively and** solve the ["Data Value Creation Loop"](the-data-value-creation-loop.md). These [open-source tools](https://github.com/oceanprotocol) tackle some of **the biggest problems for data scientists**: how to sell data anonymously, how to sell compute jobs on datasets, how to control access to data, and many more. By leveraging blockchain architecture, Ocean achieves several tactical advantages over Web2 to solve these data sharing problems.
### What are some use cases for Ocean Protocol?

6
data-science/data-engineers.md
View File

@ -8,19 +8,19 @@ description: How to research where supply meets demand... 💰🧑‍🏫
### Simple Truths
A lot of people miss the mark on tokenizing data that actually _sells_. If your goal is to make money, then you have to research target audiences, who's currently buying data, and \*correctly price\* your data to meet that demand.
A lot of people miss the mark on tokenizing data that actually _sells_. If your goal is to make money, then you have to research target audiences, who's currently buying data, and **correctly price** your data to meet that demand.
To figure out which market segments are paying for data, then it may help you to **go to the Ocean Market and sort by Sales.**
But even then, it's not enough to just publish useful data on Ocean. **You need to market your data** **assets** to close sales.
Have you tried all these things and are still having trouble making money? Never fear! You can enter one of our [data challenges](https://oceanprotocol.com/challenges) to make sweet OCEAN rewards and build your data science skills.
If you're still encountering challenges in generating income, don't worry! You can enter one of the [data challenges](https://oceanprotocol.com/challenges) to make sweet OCEAN rewards and build your data science skills.
But what if you're a well-heeled company looking to create dApps or source data predictions? You can kickstart the value creation loop by working with Ocean Protocol to [sponsor a data challenge](../user-guides/sponsor-a-data-challenge.md).
### What data could be useful for dApp builders?
* **Government Open Data:** Governments serve as a rich and reliable source of data. However, this data often lacks proper documentation or poses challenges for data scientists to work with effectively. One idea is to clean and organize this data in a way that others can tap into this wealth of information with ease. For example, in one of our [data challenges](https://desights.ai/shared/challenge/8) we leveraged public real estate data from Dubai to build use cases for understanding and predicting valuations and rents. Local, state, and federal governments around the world provide access to valuable data. So make consuming that data easier to help consumers build useful products and help your local community.
* **Government Open Data:** Governments serve as a rich and reliable source of data. However, this data often lacks proper documentation or poses challenges for data scientists to work with effectively. One idea is to clean and organize this data in a way that others can tap into this wealth of information with ease. For example, in one of the [data challenges](https://desights.ai/shared/challenge/8) we leveraged public real estate data from Dubai to build use cases for understanding and predicting valuations and rents. Local, state, and federal governments around the world provide access to valuable data. So make consuming that data easier to help consumers build useful products and help your local community.
* **Public APIs:** Data scientists can use free, public APIs to tokenize data in such a way that consumers can easily access it. [This ](https://github.com/public-apis/public-apis)is a repository of some public APIs for a wide range of topics, from weather to gaming to finance.
* **On-Chain Data:** There is consistent demand for good decentralized finance (DeFi) data and an emerging need for decentralized social data. Thus, data scientists can query blockchain data to build and sell valuable datasets for consumers.
* **Datasets for training AI and foundation models:** Much of the uniqueness and value in your data consists of aggregating and cleaning data from different sources. You can scrape the web or source data from other sources to present to AI/ML engineers looking for data to train their models.

8
defi/README.md
View File

@ -24,7 +24,7 @@ Data Farming offers a weekly rewards via [Challenge DF](../rewards/df-challenged
In this competition, participants use machine learning to submit future ETH prices for the next 12 hours as accurately as possible. They upload these predictions to Ocean Market as data NFTs.
Check our [Challenge DF page](https://df.oceandao.org/challenge-df) and join the active Predict ETH challenge!
Check out the [Challenge DF page](https://df.oceandao.org/challenge-df) and join the active Predict ETH challenge!
Wondering how to start predicting the price of ETH? We have a [blogpost](https://blog.oceanprotocol.com/capitalize-with-ocean-protocol-a-predict-eth-tutorial-b2da136633f0?source=search\_post---------0----------------------------) 📖 for that!
@ -32,16 +32,16 @@ Wondering how to start predicting the price of ETH? We have a [blogpost](https:/
There are a variety of NFTs on the Ocean Market that offer profitable algorithms for crypto trading using [Trading View](https://www.tradingview.com) and [freqtrade](http://freqtrade.io) open-source Github library. Not sure how to algorithmically trade crypto? We have a few tutorials for that:
Check out our video [tutorial](https://www.youtube.com/watch?v=c7A4vA8YUyI) on how to begin algorithmically trading crypto with no experience using an EMA crossover strategy on the Ocean Market!
Check out this video [tutorial](https://www.youtube.com/watch?v=c7A4vA8YUyI) on how to begin algorithmically trading crypto with no experience using an EMA crossover strategy on the Ocean Market!
{% embed url="https://www.youtube.com/watch?v=c7A4vA8YUyI" %}
Are you more of a reader? Check out our [blogpost](https://blog.oceanprotocol.com/capitalize-with-ocean-protocol-a-sma-algorithmic-trading-tutorial-a2490661ab85) 📖 how to use a Python SMA crossover strategy with grid search optimization to begin accurately predicting ETH.
Are you more of a reader? Check out this [blogpost](https://blog.oceanprotocol.com/capitalize-with-ocean-protocol-a-sma-algorithmic-trading-tutorial-a2490661ab85) 📖 how to use a Python SMA crossover strategy with grid search optimization to begin accurately predicting ETH.
## Create Trading Strategy NFTs 📲
Do you have a valuable trading strategy that you want to share or sell? You can anonymously upload your trading strategies as NFTs on-chain using the Ocean Market!
Check out our video tutorial 🧑‍🏫 how to [publish trading strategy NFTs](https://youtu.be/Q4jj5ukiTZA) on-chain 🔗 with the Ocean Market!
Check out this video tutorial 🧑‍🏫 about how to [publish trading strategy NFTs](https://youtu.be/Q4jj5ukiTZA) on-chain 🔗 with the Ocean Market!
{% embed url="https://youtu.be/Q4jj5ukiTZA" %}

2
developers/barge/README.md
View File

@ -17,6 +17,6 @@ By utilizing the Barge component, developers gain the freedom to conduct experim
{% hint style="warning" %}
⚠️ We've got an important heads-up about Barge that we want to share with you. Brace yourself, because **Barge is not for the faint-hearted**! Here's the deal: the barge works great on Linux, but we need to be honest about its limitations on macOS. And, well, it doesn't work at all on Windows. Sorry, Windows users!
To make things easier for everyone, we **strongly** recommend giving a try first on a **testnet**. Everything is configured already so it should be sufficient for your needs as well. Visit our [networks](../../discover/networks/README.md) page to have clarity on the available test networks. ⚠️
To make things easier for everyone, we **strongly** recommend giving a try first on a **testnet**. Everything is configured already so it should be sufficient for your needs as well. Visit the [networks](../../discover/networks/README.md) page to have clarity on the available test networks. ⚠️
{% endhint %}

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

@ -42,5 +42,5 @@ If you’re completely unfamiliar with Ocean Market or web3 applications in gene
* You’ll need a Github account to fork Ocean Market via [Github](https://github.com/).
{% hint style="warning" %}
Let's emphasize an important aspect of building dApps. It's crucial to keep in mind that practically everything can be added to the blockchain 😵 When you integrate with our components, it becomes **crucial** for you, as a developer, to ensure **proper sanitization** of the responses on your end. This means you should carefully **validate and filter** the data received to **prevent** any potential vulnerabilities or security risks in your applications.
Let's emphasize an important aspect of building dApps. It's crucial to keep in mind that practically everything can be added to the blockchain 😵 When you integrate with these components, it becomes **crucial** for you, as a developer, to ensure **proper sanitization** of the responses on your end. This means you should carefully **validate and filter** the data received to **prevent** any potential vulnerabilities or security risks in your applications.
{% endhint %}

4
developers/build-a-marketplace/customising-your-market.md
View File

@ -123,7 +123,7 @@ Great, now our publish page explains that users should be publishing photos and
![Market Customisation](../../.gitbook/assets/market/publish-page-2.png)
There is one more thing that is fun to change before we move away from the publish form. You’ll notice that Ocean Market V4 now has a cool SVG generation feature that creates the images for the Data NFT. It creates a series of pink waves. Let’s change this so that it uses our brand colors in the waves!
There is one more thing that is fun to change before we move away from the publish form. You’ll notice that Ocean Market now has a cool SVG generation feature that creates the images for the Data NFT. It creates a series of pink waves. Let’s change this so that it uses our brand colors in the waves!
Open up `/src/@utils/SvgWaves.ts` and have a look at lines 27 to 30 where the colors are specified. Currently, the pink color is the one used in the SVG generator. You can replace this with your own brand color:
@ -174,7 +174,7 @@ NEXT_PUBLIC_CONSUME_MARKET_FIXED_SWAP_FEE="0.01"
### Change the Fee Address
At this point, we have made a lot of changes and hopefully, you’re happy with the way that your marketplace is looking. Given that you now have your own awesome photo marketplace, it’s about time we talked about monetizing it. Yup, that’s right - you will earn a [commission](../contracts/fees.md) when people buy and sell photos in your marketplace. In Ocean V4, there are a whole host of new [fees](../contracts/fees.md) and customization options that you can use. In order to receive the fees you’ll need to set the address where you want to receive these fees in.
At this point, we have made a lot of changes and hopefully, you’re happy with the way that your marketplace is looking. Given that you now have your own awesome photo marketplace, it’s about time we talked about monetizing it. Yup, that’s right - you will earn a [commission](../contracts/fees.md) when people buy and sell photos in your marketplace. In Ocean, there are a whole host of [fees](../contracts/fees.md) and customization options that you can use. In order to receive the fees you’ll need to set the address where you want to receive these fees in.
When someone sets the pricing for their photos in your marketplace, they are informed that a commission will be sent to the owner of the marketplace. You see that at the moment this fee is set to zero, so you’ll want to increase that.

12
developers/community-monetization.md
View File

@ -4,27 +4,27 @@ description: How can you build a self sufficient project?
# Community Monetization
Our intentions with all of the V4 updates are to ensure that your project is able to become self-sufficient and profitable in the long run (if that’s your aim). We love projects that are built on top of Ocean and we want to ensure that you are able to generate enough income to keep your project running well into the future.
The intentions with all of the updates are to ensure that your project is able to become self-sufficient and profitable in the long run (if that’s your aim). We love projects that are built on top of Ocean and we want to ensure that you are able to generate enough income to keep your project running well into the future.
### 1. Publishing & Selling Data
**Do you have data that you can monetize?** :thinking:
Ocean V3 introduced the new crypto primitives of “data on-ramp” and “data off-ramp” via datatokens. The publisher creates ERC20 datatokens for a dataset (on-ramp). Then, anyone can access that dataset by acquiring and sending datatokens to the publisher via Ocean handshaking (data off-ramp). As a publisher, it’s in your best interest to create and publish useful data — datasets that people want to consume — because the more they consume the more you can **earn**. This is the heart of Ocean utility: connecting data publishers with data consumers :people\_hugging:
Ocean introduced the new crypto primitives of “data on-ramp” and “data off-ramp” via datatokens. The publisher creates ERC20 datatokens for a dataset (on-ramp). Then, anyone can access that dataset by acquiring and sending datatokens to the publisher via Ocean handshaking (data off-ramp). As a publisher, it’s in your best interest to create and publish useful data — datasets that people want to consume — because the more they consume the more you can **earn**. This is the heart of Ocean utility: connecting data publishers with data consumers :people\_hugging:
The datasets can take one of many shapes. For AI use cases, they may be raw datasets, cleaned-up datasets, feature-engineered **data**, **AI models**, **AI model predictions**, or otherwise. (They can even be other forms of copyright-style IP such as **photos**, **videos**, or **music**!) Algorithms themselves may be sold as part of Ocean’s Compute-to-Data feature.
The first opportunity of data NFTs is the potential to sell the base intellectual property (IP) as an exclusive license to others. This is akin to EMI selling the Beatles’ master tapes to Universal Music: whoever owns the masters has the right to create records, CDs, and digital [sub-licenses](../discover/glossary.md). It’s the same for data: as the data NFT owner you have the **exclusive right** to create ERC20 datatoken sub-licenses. With Ocean V4, this right is now transferable as a data NFT. You can sell these data NFTs in **OpenSea** and other NFT marketplaces.
The first opportunity of data NFTs is the potential to sell the base intellectual property (IP) as an exclusive license to others. This is akin to EMI selling the Beatles’ master tapes to Universal Music: whoever owns the masters has the right to create records, CDs, and digital [sub-licenses](../discover/glossary.md). It’s the same for data: as the data NFT owner you have the **exclusive right** to create ERC20 datatoken sub-licenses. With Ocean, this right is now transferable as a data NFT. You can sell these data NFTs in **OpenSea** and other NFT marketplaces.
If you’re part of an established organization or a growing startup, you’ll also love the new role structure that comes with data NFTs. For example, you can specify a different address to collect [revenue](contracts/revenue.md) compared to the address that owns the NFT. It’s now possible to fully administer your project through these [roles](contracts/roles.md).
**In short, if you have data to sell, then Ocean V4 gives you superpowers to scale up and manage your data project. We hope this enables you to bring your data to new audiences and increase your profits.**
**In short, if you have data to sell, then Ocean gives you superpowers to scale up and manage your data project. We hope this enables you to bring your data to new audiences and increase your profits.**
### 2. Running Your Own Data dApp
We have always been super encouraging of anyone who wishes to build a dApp on top of Ocean or to fork Ocean Market and make their own data marketplace. With the V4 release, we have taken this to the next level and introduced more opportunities and even more fee customization options.
We have always been super encouraging of anyone who wishes to build a dApp on top of Ocean or to fork Ocean Market and make their own data marketplace. And now, we have taken this to the next level and introduced more opportunities and even more fee customization options.
Unlike in V3, where the fee collection was limited to the consume action with a fixed value of 0.1%, V4 empowers dApp operators like yourself to have greater flexibility and control over the fees you can charge. This means you can tailor the fee structure to suit your specific needs and ensure the sustainability of your project. **V4 smart contracts enable you to collect a fee not only in consume, but also in fixed-rate exchange, also you can set the fee value.** For more detailed information regarding the fees, we invite you to visit the [fees](contracts/fees.md) page.
Ocean empowers dApp owners like yourself to have greater flexibility and control over the fees you can charge. This means you can tailor the fee structure to suit your specific needs and ensure the sustainability of your project. **The smart contracts enable you to collect a fee not only in consume, but also in fixed-rate exchange, also you can set the fee value.** For more detailed information regarding the fees, we invite you to visit the [fees](contracts/fees.md) page.
Another new opportunity is using your own **ERC20** token in your dApp, where it’s used as the unit of exchange. This is fully supported and can be a great way to ensure the sustainability of your project.

20
developers/contracts/README.md
View File

@ -4,9 +4,9 @@ description: Empowering the Decentralised Data Economy
# Contracts
The [V4 release](https://blog.oceanprotocol.com/ocean-v4-overview-1ccd4a7ce150) of Ocean Protocol introduces a comprehensive and enhanced suite of [smart contracts](https://github.com/oceanprotocol/contracts/tree/main/contracts) that serve as the backbone of the decentralized data economy. These contracts facilitate secure, transparent, and efficient interactions among data providers, consumers, and ecosystem participants. With the introduction of V4 contracts, Ocean Protocol propels itself forward, delivering substantial functionality, scalability, and flexibility advancements.
The suite of smart contracts serve as the backbone of the decentralized data economy. These contracts facilitate secure, transparent, and efficient interactions among data providers, consumers, and ecosystem participants.
The V4 smart contracts have been deployed across multiple [networks](../../discover/networks/README.md) and are readily accessible through the GitHub [repository](https://github.com/oceanprotocol/contracts/tree/main/contracts). The V4 introduces significant enhancements that encompass the following key **features**:
The smart contracts have been deployed across multiple [networks](../../discover/networks/README.md) and are readily accessible through the GitHub [repository](https://github.com/oceanprotocol/contracts/tree/main/contracts). They introduced significant enhancements that encompass the following key **features**:
### [**Data NFTs**](data-nfts.md) **for Enhanced Data IP Management**
@ -16,28 +16,28 @@ However, Ocean V3 faced limitations in terms of flexibility. It lacked support f
Ocean V4 effectively tackles these challenges by adopting **ERC721** **tokens** to explicitly represent the **base IP** as "data NFTs" (Non-Fungible Tokens). [**Data NFT**](data-nfts.md) owners can now deploy ERC20 "datatoken" contracts specific to their data NFTs, with each datatoken contract offering its own distinct licensing terms.
By utilizing ERC721 tokens, Ocean V4 **grants data creators greater flexibility and control over licensing arrangements**. The introduction of data NFTs allows for the representation of [base IP](../../discover/glossary.md) and the creation of customized ERC20 datatoken contracts tailored to individual licensing requirements.
By utilizing ERC721 tokens, Ocean **grants data creators greater flexibility and control over licensing arrangements**. The introduction of data NFTs allows for the representation of [base IP](../../discover/glossary.md) and the creation of customized ERC20 datatoken contracts tailored to individual licensing requirements.
<figure><img src="../../.gitbook/assets/contracts/v4_contracts_overview.png" alt=""><figcaption><p>Ocean Protocol V4 Smart Contracts</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/contracts/v4_contracts_overview.png" alt=""><figcaption><p>Ocean Protocol Smart Contracts</p></figcaption></figure>
### [**Community monetization**](../community-monetization.md), to help the community create sustainable businesses.
Ocean V4 brings forth enhanced opportunities for marketplace operators, creating a conducive environment for the emergence of a thriving market of **third-party Providers**.
Ocean brings forth enhanced opportunities for dApp owners, creating a conducive environment for the emergence of a thriving market of **third-party Providers**.
With Ocean V4, marketplace operators can unlock additional benefits. Firstly, the V4 smart contracts empower marketplace operators to collect [fees](fees.md) not only during **data consumption** but also through **fixed-rate exchanges**. This expanded revenue model allows operators to derive more value from the ecosystem. Moreover, in Ocean V4, the marketplace operator has the authority to determine the fee value, providing them with **increased control** over their pricing strategies.
With Ocean, dApp owners can unlock additional benefits. Firstly, the smart contracts empower dApp owners to collect [fees](fees.md) not only during **data consumption** but also through **fixed-rate exchanges**. This expanded revenue model allows owners to derive more value from the ecosystem. Moreover, in Ocean, the dApp operator has the authority to determine the fee value, providing them with **increased control** over their pricing strategies.
In addition to empowering marketplace operators, Ocean V4 facilitates the participation of third-party [Providers](../provider/README.md) who can offer compute services in exchange for a fee. This paves the way for the development of a diverse marketplace of Providers. This model supports both centralized trusted providers, where data publishers and consumers have established trust relationships, as well as trustless providers that leverage decentralization or other privacy-preserving mechanisms.
In addition to empowering dApp owners, Ocean facilitates the participation of third-party [Providers](../provider/README.md) who can offer compute services in exchange for a fee. This paves the way for the development of a diverse marketplace of Providers. This model supports both centralized trusted providers, where data publishers and consumers have established trust relationships, as well as trustless providers that leverage decentralization or other privacy-preserving mechanisms.
By enabling a marketplace of [Providers](../provider/README.md), Ocean V4 fosters competition, innovation, and choice. It creates an ecosystem where various providers can offer their compute services, catering to the diverse needs of data publishers and consumers. Whether based on trust or privacy-preserving mechanisms, this expansion in provider options enhances the overall functionality and accessibility of the Ocean Protocol ecosystem.
By enabling a marketplace of [Providers](../provider/README.md), Ocean fosters competition, innovation, and choice. It creates an ecosystem where various providers can offer their compute services, catering to the diverse needs of data publishers and consumers. Whether based on trust or privacy-preserving mechanisms, this expansion in provider options enhances the overall functionality and accessibility of the Ocean Protocol ecosystem.
Key features of the V4 smart contracts:
Key features of the smart contracts:
* Base IP is now represented by a data [NFT](data-nfts.md), from which a data publisher can create multiple ERC20s [datatokens](datatokens.md) representing different types of access for the same dataset.
* Interoperability with the NFT ecosystem (and DeFi & DAO tools).
* Allows new data [NFT & datatoken templates](datatoken-templates.md), for flexibility and future-proofing.
* Besides base data IP, you can use data NFTs to **implement comments & ratings, verifiable claims, identity credentials, and social media posts**. They can point to parent data NFTs, enabling the nesting of comments on comments, or replies to tweets. All on-chain, GDPR-compliant, easily searched, with js & py drivers 🤯
* Introduce an advanced [Fee](fees.md) structure both for Marketplace and Provider runners 💰
* Introduce an advanced [Fee](fees.md) structure both for dApp and provider runners 💰
* [Roles](roles.md) Administration: there are now multiple roles for a more flexible administration both at [NFT](data-nfts.md) and [ERC20](datatokens.md) levels 👥
* When the NFT is transferred, it auto-updates all permissions, e.g. who receives payment, or who can mint derivative ERC20 datatokens.
* Key-value store in the NFT contract: NFT contract can be used to store custom key-value pairs (ERC725Y standard) enabling applications like soulbound tokens and Sybil protection approaches 🗃️

12
developers/contracts/data-nfts.md
View File

@ -8,7 +8,7 @@ A non-fungible token stored on the blockchain represents a unique asset. NFTs ca
## What is a Data NFT?
A data NFT represents the **copyright** (or **exclusive license** against copyright) for a data asset on the blockchain — we call this the “**base IP**”. When a user publishes a dataset in Ocean V4, they create a new NFT as part of the process. This data NFT is proof of your claim of base IP. Assuming a valid claim, you are entitled to the revenue from that asset, just like a title deed gives you the right to receive rent.
A data NFT represents the **copyright** (or **exclusive license** against copyright) for a data asset on the blockchain — we call this the “**base IP**”. When a user publishes a dataset in Ocean, they create a new NFT as part of the process. This data NFT is proof of your claim of base IP. Assuming a valid claim, you are entitled to the revenue from that asset, just like a title deed gives you the right to receive rent.
The data NFT smart contract holds metadata about the data asset, stores roles like “who can mint datatokens” or “who controls fees”, and an open-ended key-value store to enable custom fields.
@ -31,16 +31,14 @@ With data NFTs, you are able to take advantage of the broader NFT ecosystem and
### Implementation in Ocean Protocol
We have implemented data NFTs using the [ERC721 standard](https://erc721.org/). Ocean Protocol defines the [ERC721Factory](https://github.com/oceanprotocol/contracts/blob/v4main/contracts/ERC721Factory.sol) contract, allowing **Base IP holders** to create their ERC721 contract instances on any supported networks. The deployed contract stores Metadata, ownership, sub-license information, and permissions. The contract creator can also create and mint ERC20 token instances for sub-licensing the **Base IP**.
We have implemented data NFTs using the [ERC721 standard](https://erc721.org/). Ocean Protocol defines the [ERC721Factory](https://github.com/oceanprotocol/contracts/blob/main/contracts/ERC721Factory.sol) contract, allowing **Base IP holders** to create their ERC721 contract instances on any supported networks. The deployed contract stores Metadata, ownership, sub-license information, and permissions. The contract creator can also create and mint ERC20 token instances for sub-licensing the **Base IP**.
ERC721 tokens are non-fungible, and thus cannot be used for automatic price discovery like ERC20 tokens. ERC721 and ERC20 combined together can be used for sub-licensing. Ocean Protocol's [ERC721Template](https://github.com/oceanprotocol/contracts/blob/v4main/contracts/templates/ERC721Template.sol) solves this problem by using ERC721 for tokenizing the **Base IP** and tokenizing sub-licenses by using ERC20. To save gas fees, it uses [ERC1167](https://eips.ethereum.org/EIPS/eip-1167) proxy approach on the **ERC721 template**.
ERC721 tokens are non-fungible, and thus cannot be used for automatic price discovery like ERC20 tokens. ERC721 and ERC20 combined together can be used for sub-licensing. Ocean Protocol's [ERC721Template](https://github.com/oceanprotocol/contracts/blob/main/contracts/templates/ERC721Template.sol) solves this problem by using ERC721 for tokenizing the **Base IP** and tokenizing sub-licenses by using ERC20. To save gas fees, it uses [ERC1167](https://eips.ethereum.org/EIPS/eip-1167) proxy approach on the **ERC721 template**.
Our implementation has been built on top of the battle-tested [OpenZeppelin contract library](https://docs.openzeppelin.com/contracts/4.x/erc721). However, there are a bunch of interesting parts of our implementation that go a bit beyond an out-of-the-box NFT. The data NFTs can be easily managed from any NFT marketplace like [OpenSea](https://opensea.io/).
Our implementation has been built on top of the battle-tested [OpenZeppelin contract library](https://docs.openzeppelin.com/contracts/4.x/erc721). However, there are a bunch of interesting parts of the implementation that go a bit beyond an out-of-the-box NFT. The data NFTs can be easily managed from any NFT marketplace like [OpenSea](https://opensea.io/).
<figure><img src="../../.gitbook/assets/wallet/data_nft_open_sea.png" alt=""><figcaption><p>Data NFT on Open Sea</p></figcaption></figure>
Ocean V4’s data NFT factory can deploy different types of data NFTs based on a variety of templates. Some templates could be tuned for data unions, others for DeFi, and others yet for enterprise use cases.
Something else that we’re super excited about in our data NFTs is a cutting-edge standard called [ERC725](https://github.com/ERC725Alliance/erc725/blob/main/docs/ERC-725.md) being driven by our friends at [Lukso](https://lukso.network/about). The ERC725y feature enables the NFT owner (or a user with the “store updater” role) to input and update information in a key-value store. These values can be viewed externally by anyone.
Something else that we’re super excited about in the data NFTs is a cutting-edge standard called [ERC725](https://github.com/ERC725Alliance/erc725/blob/main/docs/ERC-725.md) being driven by our friends at [Lukso](https://lukso.network/about). The ERC725y feature enables the NFT owner (or a user with the “store updater” role) to input and update information in a key-value store. These values can be viewed externally by anyone.
ERC725y is incredibly flexible and can be used to store any string; you could use it for anything from additional metadata to encrypted values. This helps future-proof the data NFTs and ensure that they are suitable for a wide range of projects that have not been launched yet. As you can imagine, the inclusion of ERC725y has huge potential and we look forward to seeing the different ways people end up using it. If you’re interested in using this, take a look at [EIP725](https://eips.ethereum.org/EIPS/eip-725#erc725y).

4
developers/contracts/datanft-and-datatoken.md
View File

@ -30,9 +30,9 @@ For a more comprehensive exploration of intellectual property and its practical
What happends under the hood? 🤔
Publishing with V4 smart contracts in Ocean Protocol involves a well-defined process that streamlines the publishing of data assets. It provides a systematic approach to ensure efficient management and exchange of data within the Ocean Protocol ecosystem. By leveraging smart contracts, publishers can securely create and deploy data NFTs, allowing them to tokenize and represent their data assets. Additionally, the flexibility of V4 smart contracts enables publishers to define pricing schemas for datatokens, facilitating fair and transparent transactions. This publishing framework empowers data publishers by providing them with greater control and access to a global marketplace, while ensuring trust, immutability, and traceability of their published data assets.
Publishing with smart contracts in Ocean Protocol involves a well-defined process that streamlines the publishing of data assets. It provides a systematic approach to ensure efficient management and exchange of data within the Ocean Protocol ecosystem. By leveraging smart contracts, publishers can securely create and deploy data NFTs, allowing them to tokenize and represent their data assets. Additionally, the flexibility of the smart contracts enables publishers to define pricing schemas for datatokens, facilitating fair and transparent transactions. This publishing framework empowers data publishers by providing them with greater control and access to a global marketplace, while ensuring trust, immutability, and traceability of their published data assets.
The V4 smart contracts publishing includes the following steps:
The smart contracts publishing includes the following steps:
1. The data publisher initiates the creation of a new data NFT.
2. The data NFT factory deploys the template for the new data NFT.

4
developers/contracts/datatoken-templates.md
View File

@ -21,11 +21,11 @@ The details regarding currently supported **datatoken templates** are as follows
### **Regular template**
The regular template allows users to buy/sell/hold datatokens. The datatokens can be minted by the address having a [`MINTER`](roles.md#minter) role, making the supply of datatoken variable. This template is assigned _**`templateId =`**_`1` and the source code is available [here](https://github.com/oceanprotocol/contracts/blob/v4main/contracts/templates/ERC20Template.sol).
The regular template allows users to buy/sell/hold datatokens. The datatokens can be minted by the address having a [`MINTER`](roles.md#minter) role, making the supply of datatoken variable. This template is assigned _**`templateId =`**_`1` and the source code is available [here](https://github.com/oceanprotocol/contracts/blob/main/contracts/templates/ERC20Template.sol).
### **Enterprise template**
The enterprise template has additional functions apart from methods in the ERC20 interface. This additional feature allows access to the service by paying in the basetoken instead of the datatoken. Internally, the smart contract handles the conversion of basetoken to datatoken, initiating an order to access the service, and minting/burning the datatoken. The total supply of the datatoken effectively remains 0 in the case of the enterprise template. This template is assigned _**`templateId =`**_`2` and the source code is available [here](https://github.com/oceanprotocol/contracts/blob/v4main/contracts/templates/ERC20TemplateEnterprise.sol).
The enterprise template has additional functions apart from methods in the ERC20 interface. This additional feature allows access to the service by paying in the basetoken instead of the datatoken. Internally, the smart contract handles the conversion of basetoken to datatoken, initiating an order to access the service, and minting/burning the datatoken. The total supply of the datatoken effectively remains 0 in the case of the enterprise template. This template is assigned _**`templateId =`**_`2` and the source code is available [here](https://github.com/oceanprotocol/contracts/blob/main/contracts/templates/ERC20TemplateEnterprise.sol).
#### Set the template

2
developers/contracts/fees.md
View File

@ -40,7 +40,7 @@ When a user exchanges a [datatoken](datatokens.md) for the privilege of download
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.
* 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 our [smart contracts](https://github.com/oceanprotocol/contracts/blob/main/contracts/pools/FactoryRouter.sol#L391-L407).
* 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).
<details>

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

@ -68,7 +68,7 @@ With the fixed pricing model, you have the power to set a specific price for you
This datatoken represents the access right to your data, so buyers don't have to worry about the technical details. If you ever want to adjust the price of your dataset, you have the flexibility to do so whenever you need.
The fixed pricing model relies on the [createNftWithErc20WithFixedRate](https://github.com/oceanprotocol/contracts/blob/main/contracts/ERC721Factory.sol#LL674C14-L674C45) in our smart contract, which securely stores the pricing information for assets published using this model.
The fixed pricing model relies on the [createWithDecimals](https://github.com/oceanprotocol/contracts/blob/d288e3f94cf6ba2be151a3284da0a3606a263bb9/contracts/pools/fixedRate/FixedRateExchange.sol#L201) in the smart contract, which securely stores the pricing information for assets published using this model.
<details>
@ -131,7 +131,7 @@ On the other hand, the free pricing model gives data consumers access to your as
In this model, datatokens are allocated to a dispenser smart contract, which dispenses data tokens to users at no charge when they access your asset. This is perfect if you want to make your data widely available and encourage collaboration. It's particularly suitable for individuals and organizations working in the public domain or for assets that need to comply with open-access licenses.
The fixed pricing model relies on the [createNftWithErc20WithDispenser](https://github.com/oceanprotocol/contracts/blob/main/contracts/ERC721Factory.sol#LL713C14-L713C45) in our smart contract, which securely stores the pricing information for assets published using this model.
The free pricing model relies on the [create](https://github.com/oceanprotocol/contracts/blob/d288e3f94cf6ba2be151a3284da0a3606a263bb9/contracts/pools/dispenser/Dispenser.sol#L154) in the smart contract, which securely stores the pricing information for assets published using this model.
<details>

8
developers/ddo-specification.md
View File

@ -153,8 +153,8 @@ A DDO in Ocean has these required attributes:
"nft": {
"address": "0x123",
"name": "Ocean Protocol Asset v4",
"symbol": "OCEAN-A-v4",
"name": "Ocean Protocol Asset",
"symbol": "OCEAN-A",
"owner": "0x0000000",
"state": 0,
"created": "2000-10-31T01:30:00",
@ -373,8 +373,8 @@ The `nft` object contains information about the ERC721 NFT contract which repres
{
"nft": {
"address": "0x000000",
"name": "Ocean Protocol Asset v4",
"symbol": "OCEAN-A-v4",
"name": "Ocean Protocol Asset",
"symbol": "OCEAN-A",
"owner": "0x0000000",
"state": 0,
"created": "2000-10-31T01:30:00Z"

81
developers/dev-faq.md Normal file
View File

@ -0,0 +1,81 @@
---
title: Development FAQ
description: Frequently Asked Questions About Ocean Technology
---
## Development FAQ
Have some questions about the Ocean Protocol tech stack?
Hopefully, you'll find the answers here! If not then please don't hesitate to reach out to us on [discord](https://discord.gg/EdmenE7eTj) - there are no stupid questions!
<details>
<summary>The blockchain is public - does this mean that anyone can access my data?</summary>
The blockchain being public means that transaction information is transparent and can be viewed by anyone. However, your data isn't directly accessible to the public. Ocean Protocol employs various mechanisms, including encryption and access control, to safeguard your data. Access to the data is determined by the permissions you set, ensuring that only authorized users can retrieve and work with your data. So, while blockchain transactions are public, your data remains protected and accessible only to those with proper authorization.
</details>
<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)
</details>
<details>
<summary>How does the datatoken creator make money?</summary>
You can generate revenue as a dataset publisher by selling datatokens to access your published dataset. For more details, please visit the [community monetization](https://docs.oceanprotocol.com/developers/community-monetization#1.-publishing-and-selling-data) page.
</details>
<details>
<summary>Where can I find information about the number of datatokens created and track their progress?</summary>
To access this data, some technical expertise is required. You can find this information at the subgraph level. In the documentation, we provide a few examples of how to retrieve this data using JavaScript. Feel free to give it a shot by visiting this [page](../developers/subgraph/list-datatokens). If it doesn't meet your requirements, don't hesitate to reach out to us on Discord.
</details>
<details>
<summary>How can developers use Ocean technology to build their own data marketplaces?</summary>
You can fork Ocean Market and then make changes as you wish. Please see the [customising your market](../developers/build-a-marketplace/customising-your-market) page for details.
</details>
<details>
<summary>Is there a trading platform or stock exchange that has successfully forked the Ocean marketplace codebase?</summary>
Ocean technology is actively used by Daimler/Acentrik, deltaDAO/GAIA-X, and several other entities. You can find further details on the Ocean [ecosystem page](https://oceanprotocol.com/explore/ecosystem).
</details>
<details>
<summary>What are the Ocean faucets and how can they be used?</summary>
An Ocean faucet is a site to get (fake) OCEAN for use on a given testnet. There's an Ocean faucet for each testnet that Ocean is deployed to. The [networks](../discover/networks/) page have more information.
</details>
<details>
<summary>How can I convert tokens from the BEP20 network to the ERC20 network?</summary>
Please follow this [tutorial](../discover/networks/bridges#bnb-smart-chain-bridge) to bridge from/to BNB Smart Chain. Please double-check the addresses and make sure you are using the right smart contracts.
</details>
<details>
<summary>How to bridge my mOcean back to Ocean?</summary>
Please follow this [tutorial](../discover/networks/bridges#polygon-ex-matic-bridge) to bridge to/from Polygon mainnet. Please double-check the addresses and make sure you are using the right smart contracts.
</details>
<details>
<summary>Is it possible to reverse engineer a dataset on Ocean by having access to both the algorithm and the output? </summary>
Not to our knowledge. But please, give it a shot and share the results with us 😄
PS: We offer good rewards 😇
</details>
<details>
<summary>If a dataset consists of 100 individuals' private data, does this solution allow each individual to maintain sovereign control over their data while still enabling algorithms to compute as if it were one dataset?</summary>
Yes. Each individual could publish their dataset themselves, to get a data NFT. From the data NFT, they can mint datatokens which are to access the data. They have sovereign control over this, as hold the keys to the data NFTs and datatokens, and have great flexibility in how to give others access. For example, they could send a datatoken to a DAO for the DAO can manage. Or they could grant datatoken-minting permissions to the DAO. The DAO could use this to assemble a dataset across 100 individuals. ⁣
⁣
Learn more about Data NFTs on the [Docs](../developers/contracts/data-nfts).
</details>

4
developers/metadata.md
View File

@ -16,7 +16,7 @@ So, for example, imagine you're searching for data on Spanish almond production
* **dateCreated**, e.g. “2007–01–20”
* **datePublished**, e.g. “2022–11–10T12:32:15Z”
* **author**, e.g. “Spanish Almond Board”
* **license**, e.g. “SAB Data License v4”
* **license**, e.g. “SAB Data License”
* technical information about the **files**, such as the content type.
Other metadata might also be available. For example:
@ -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 our [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](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.

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

@ -74,4 +74,4 @@ npm run cli h
<figure><img src="../../.gitbook/assets/cli/usage.png" alt=""><figcaption>Available CLI commands & options</figcaption></figure>
With the Ocean CLI successfully installed and configured, you're ready to dive into its capabilities and unlock the full potential of Ocean Protocol. If you encounter any issues during the setup process or have questions, feel free to seek assistance from our [support](https://discord.com/invite/TnXjkR5) team. 🌊
With the Ocean CLI successfully installed and configured, you're ready to dive into its capabilities and unlock the full potential of Ocean Protocol. If you encounter any issues during the setup process or have questions, feel free to seek assistance from the [support](https://discord.com/invite/TnXjkR5) team. 🌊

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

@ -1,6 +1,6 @@
# Publish a Dataset 📤
Once you've configured the RPC environment variable, you're ready to publish a new dataset on the connected network. Our flexible setup allows you to switch to a different network simply by substituting the RPC endpoint with one corresponding to another network. 🌐
Once you've configured the RPC environment variable, you're ready to publish a new dataset on the connected network. The flexible setup allows you to switch to a different network simply by substituting the RPC endpoint with one corresponding to another network. 🌐
To initiate the dataset publishing process, we'll start by updating the helper [DDO](../ddo-specification.md)(Decentralized Data Object) example named "SimpleDownloadDataset.json." This example can be found in the `./metadata` folder, located at the root directory of the cloned Ocean CLI project.

2
developers/ocean.js/README.md
View File

@ -20,7 +20,7 @@ Introducing Ocean.JS
The Ocean.js library adopts the module architectural pattern, ensuring clear separation and organization of code units. Utilizing ES6 modules simplifies the process by allowing you to import only the necessary module for your specific task.
Our module structure follows this format:
The module structure follows this format:
* Types
* Config

2
developers/ocean.js/creating-datanft.md
View File

@ -72,7 +72,7 @@ node create_dataNFT.js
{% endtab %}
{% endtabs %}
* Checkout our [code examples](https://github.com/oceanprotocol/ocean.js/blob/main/CodeExamples.md#L0-L1) or [compute to data examples](https://github.com/oceanprotocol/ocean.js/blob/main/ComputeExamples.md#L417) to see how you can use ocean.js.
* Check out these [code examples](https://github.com/oceanprotocol/ocean.js/blob/main/CodeExamples.md#L0-L1) or [compute to data examples](https://github.com/oceanprotocol/ocean.js/blob/main/ComputeExamples.md#L417) to see how you can use ocean.js.
* If you have any difficulties or if you have further questions about how to use ocean.js please reach out to us on [Discord](https://discord.gg/TnXjkR5).
* If you notice any bugs or issues with ocean.js please [open an issue on github](https://github.com/oceanprotocol/ocean.js/issues/new?assignees=\&labels=bug\&template=bug\_report.md\&title=).
* Visit the [Ocean Protocol website](https://oceanprotocol.com/) for general information about Ocean Protocol.

2
developers/ocean.js/update-metadata.md
View File

@ -87,7 +87,7 @@ node updateMetadata.js
{% endtab %}
{% endtabs %}
We provided several code examples using the Ocean.js library for interacting with the Ocean Protocol. Some highlights from our [code examples](https://github.com/oceanprotocol/ocean.js/blob/main/CodeExamples.md) ([compute examples](https://github.com/oceanprotocol/ocean.js/blob/main/ComputeExamples.md)) are:
We provided several code examples using the Ocean.js library for interacting with the Ocean Protocol. Some highlights from the [code examples](https://github.com/oceanprotocol/ocean.js/blob/main/CodeExamples.md) ([compute examples](https://github.com/oceanprotocol/ocean.js/blob/main/ComputeExamples.md)) are:
1. **Minting an NFT** - This example demonstrates how to mint an NFT (Non-Fungible Token) using the Ocean.js library. It shows the necessary steps, including creating a NFTFactory instance, defining NFT parameters, and calling the `create()` method to mint the NFT.
2. **Publishing a dataset** - This example explains how to publish a dataset on the Ocean Protocol network. It covers steps such as creating a DDO, signing the DDO, and publish the dataset.

27
developers/ocean.py/README.md
View File

@ -4,33 +4,12 @@
Attention all data enthusiasts! Are you an inquisitive data scientist intrigued by the world of Web3 and blockchain, but unsure of where to begin? Have you developed a groundbreaking AI algorithm and desire to transform it into profitable success? Perhaps you're engaged in training a highly lucrative model (LLM) and seek to define precise licensing terms for your valuable data. Or maybe you simply wish to sell your data while maintaining utmost privacy and control.
Well, brace yourselves for some exhilarating news! Introducing ocean.py, a Python library that possesses a touch of magic. 🎩🐍 It empowers you to discreetly and securely publish, exchange, and effortlessly consume data. 🐙💦 Collaborating with the Ocean Protocol 🌊, it unlocks a plethora of advantages mentioned earlier. So get ready to take the plunge into the vast ocean of data with a resounding splash of excitement! 💦🌊
This is where ocean.py can help. It is a Python library for data scientists to privately & securely publish, exchange, and consume data. 🐙💦
<figure><img src="../../.gitbook/assets/components/ocean_py.png" alt="" width="375"><figcaption><p>ocean.py library</p></figcaption></figure>
### Overview
ocean.py serves as a connection layer bridging the V4 smart contracts and various components such as [Provider](https://github.com/oceanprotocol/provider), [Aquarius](https://github.com/oceanprotocol/aquarius), and [Compute to Data engine](https://github.com/oceanprotocol/operator-service) within Ocean Protocol. This pythonic library brings all these elements together, facilitating seamless integration and interaction. By acting as an intermediary, ocean.py enables developers to easily leverage the functionalities offered by Ocean Protocol, making it a valuable tool in building applications and solutions that utilize decentralized data marketplaces. Its purpose is to simplify the process of connecting with smart contracts and accessing services provided by Provider, Aquarius, and Compute to Data engine, providing a convenient and efficient development experience for users.
#### Architectural point of view
ocean.py is like the conductor of an underwater orchestra, guiding different marine creatures (modules) to work together harmoniously. It's an open-source library that makes swimming in the vast sea of data a breeze! 🌊
The head of our library is the "[Ocean](technical-details.md)" class. It oversees everything and keeps track of the data flow.
Now, let's take a closer look at those amazing branches:
1. **Data Discovery Branch**: This branch discovers & creates valuable datasets stored in the Ocean Protocol ecosystem. It navigates through metadata and identifies the hidden treasures of the data assets.
2. **Data Access Branch**: Just like a skilled locksmith, this branch unlocks the doors to the datasets, facilitating access and content retrieval. It interacts with the Ocean Protocol's smart contracts to securely fetch the desired data.
3. **Data Transformation Branch**: Transforming data is like wielding magic, and this arm is the magician! It performs enchanting operations on the data, such as reformatting, reorganizing, or even enriching it, making it ready for the next steps.
4. **Model Deployment Branch**: This branch deploy the Ocean smart contract objects wrapped models using [Brownie](https://github.com/eth-brownie/brownie), making them accessible for utilization within the library.
5. **Model Training Branch**: This branch collaborates with Compute-To-Data engine in order to run algorithms and to train models using the transformed data.
6. **Model Monitoring Branch**: This branch monitors the received algorithm result logs from Compute-to-Data engine, tracking their performance.
So, in the realm of ocean.py's integration with Ocean Protocol's smart contracts, the six versatile branches embark on an exciting journey. Together, they form a powerful team, navigating the depths of the Ocean ecosystem. 🌊🐙
### ocean.py Strengths 💪
ocean.py lets you do the following things:
* Publish data services: downloadable files or compute-to-data. Create an ERC721 data NFT for each service, and ERC20 datatoken for access (1.0 datatokens to access).
@ -41,9 +20,7 @@ If you prefer video format, please check this video below, otherwise let's move
{% embed url="https://youtu.be/8uZC6PC9PBM" %}
### ocean.py Quickstart 🚀
### Quickstart 🚀
To kickstart your adventure with ocean.py, we set out the following steps to get you zooming ahead in no time!

4
developers/ocean.py/compute-flow.md
View File

@ -200,14 +200,14 @@ You should see something like this:
### Appendix. Tips & tricks
This README has a simple ML algorithm. However, Ocean C2D is not limited to usage in ML. The file [c2d-flow-more-examples.md](https://github.com/oceanprotocol/ocean.py/blob/v4main/READMEs/c2d-flow-more-examples.md) has examples from vision and other fields.
This README has a simple ML algorithm. However, Ocean C2D is not limited to usage in ML. The file [c2d-flow-more-examples.md](https://github.com/oceanprotocol/ocean.py/blob/main/READMEs/c2d-flow-more-examples.md) has examples from vision and other fields.
In the "publish algorithm" step, to replace the sample algorithm with another one:
* 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: [https://docs.oceanprotocol.com/tutorials/compute-to-data-algorithms/](../compute-to-data/compute-to-data-algorithms.md)
* More info is available on the [algorithms page](../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:

2
developers/ocean.py/local-setup.md
View File

@ -12,7 +12,7 @@ Here are the following steps for configuring ocean.py on Ganache network using b
### Prerequisites
Ahoy there, matey! 🌊⚓️ When it comes to setting up ocean.py locally, we're diving into the world of Docker containers. These clever containers hold our trusty local blockchain nodes (Ganache) and the mighty Ocean middleware (Aquarius metadata cache and Provider to aid in consuming data assets). But fear not, for a smooth sailing experience, you'll need to ensure the following Docker components are shipshape and ready to go:
Ahoy there, matey! 🌊⚓️ When it comes to setting up ocean.py locally, we're diving into the world of Docker containers. These clever containers hold the trusty local blockchain nodes (Ganache) and the mighty Ocean middleware (Aquarius metadata cache and Provider to aid in consuming data assets). But fear not, for a smooth sailing experience, you'll need to ensure the following Docker components are shipshape and ready to go:
1. [Docker](https://docs.docker.com/engine/install/) 🐳
2. [Docker Compose](https://docs.docker.com/compose/install/) 🛠️

2
developers/subgraph/README.md
View File

@ -32,7 +32,7 @@ When it comes to fetching valuable information about [Data NFTs](../contracts/da
| ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| Ethereum | [Subgraph](https://v4.subgraph.mainnet.oceanprotocol.com) | [GraphiQL](https://v4.subgraph.mainnet.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql) |
| Polygon | [Subgraph](https://v4.subgraph.polygon.oceanprotocol.com/) | [GraphiQL](https://v4.subgraph.polygon.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql) |
| Binance Smart Chain | [Subgraph](https://v4.subgraph.bsc.oceanprotocol.com) | [GraphiQL](https://v4.subgraph.bsc.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql) |
| BNB Smart Chain | [Subgraph](https://v4.subgraph.bsc.oceanprotocol.com) | [GraphiQL](https://v4.subgraph.bsc.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql) |
| Energy Web Chain | [Subgraph](https://v4.subgraph.energyweb.oceanprotocol.com) | [GraphiQL](https://v4.subgraph.energyweb.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql) |
| Moonriver | [Subgraph](https://v4.subgraph.moonriver.oceanprotocol.com) | [GraphiQL](https://v4.subgraph.moonriver.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql) |
| Mumbai | [Subgraph](https://v4.subgraph.mumbai.oceanprotocol.com) | [GraphiQL](https://v4.subgraph.mumbai.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql) |

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

@ -6,7 +6,7 @@ description: 'Discover the World of veOCEAN: Retrieving a 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](../../rewards/df-veocean.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 our [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:
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.

12
discover/README.md
View File

@ -26,13 +26,15 @@ If we don't enable personal **sovereignty** over our data, then we could be at t
That's why we made the decision to take action, and it led to the creation of the **Ocean Protocol**.
**Ocean Protocol aims to kick-start a new data economy by giving power back to people and giving researchers the data they need. Ocean Protocol technology enables data to become an asset.**
**Ocean Protocol was founded to level the playing field for AI and data.**
By providing a decentralized and open platform and the tools for data sharing, **Ocean Protocol** aims to address these concerns and create a more equitable and collaborative data economy.
Ocean’s tools enable people to privately & securely publish, exchange, and consume data.
We believe that data is a valuable resource that should be accessible to **everyone** :people\_holding\_hands:, not just a select few large corporations. We aim to empower data providers to monetize their data and enable data consumers to access high-quality data for their projects. Ultimately, we seek to establish a more equitable and collaborative data economy that benefits businesses, researchers, and communities worldwide.
{% hint style="info" %}
If you're wondering which types of data can be monetized through Ocean Protocol, the answer is that virtually any kind of data can be sold via the platform! 📊🎶📸🎥💼🎫🌐 This includes AI data, ML models, music data, images, videos, trading data, tickets, and essentially anything that can be accessed online.
{% endhint %}
To find out more about the amazing team behind Ocean, you can visit our [website](https://oceanprotocol.com/about).
To find out more about the amazing team behind Ocean, you can visit the [website](https://oceanprotocol.com/about-us/foundation).
Now that we've made you curious about our mission and how we're making a difference in the world, you won't want to miss this video featuring our co-founder, [Trent McConaghy](http://www.trent.st/). He'll share some fascinating insights into what we're doing and why it matters.
@ -42,4 +44,4 @@ A new data economy with power to the people - Trent McConaghy
### Ocean Protocol Whitepaper
If you'd like to explore the details of our technology, feel free to dive into our [whitepaper](https://oceanprotocol.com/tech-whitepaper.pdf)! It's a comprehensive resource that explains all the technical details and the core concepts that drive Ocean Protocol. It's a great way to get a deeper understanding of what we're all about.
If you'd like to explore the details of the technology, feel free to dive into the [whitepaper](https://oceanprotocol.com/tech-whitepaper.pdf)! It's a comprehensive resource that explains all the technical details and the core concepts that drive Ocean Protocol. It's a great way to get a deeper understanding of what we're all about.

21
discover/explore.md
View File

@ -18,7 +18,7 @@ By leveraging **blockchain technology** and **smart contracts**, Ocean Protocol
<figure><img src="../.gitbook/assets/general/explore_ocean.png" alt=""><figcaption><p>A vast ocean of data awaits you...</p></figcaption></figure>
Get a glimpse into some of the things you can do with Ocean Protocol. The opportunities with our protocol to leverage an "Ocean of data" are great and ever-evolving. Together, we'll dive deeper and uncover even more ways to harness the power of decentralized data.
Get a glimpse into some of the things you can do with Ocean Protocol. The opportunities with the protocol to leverage an "Ocean of data" are great and ever-evolving. Together, we'll dive deeper and uncover even more ways to harness the power of decentralized data.
<details>
@ -58,8 +58,7 @@ You can choose from two options:
<summary><mark style="color:blue;"><strong>Tokengate Your dApp or Content</strong></mark><br><br>Are you interested in token gating your dApp or content using an Ocean data NFT? We offer you all the code and support that you need to make this happen.</summary>
Feel free to fork the [Ocean Token Gate template](https://github.com/oceanprotocol/token-gating-template) code and customize it to start building your dApp from scratch. If you already have an existing dApp of yours, then you can also modify it simply to use an Ocean data NFT. The [Ocean Token Gate repo](https://github.com/oceanprotocol/token-gating-template) will be helpful to inform your coding to do this, of course. But we also explain the [smart contract mechanics](../developers/contracts/) of Data NFTs and Datatokens[ in our docs](../developers/contracts/) for you to understand the code better. Remember, we're always here to help guide you with any coding questions on [Discord](https://discord.gg/TnXjkR5).
Feel free to fork the [Ocean token-gating template](https://github.com/oceanprotocol/token-gating-template) code and customize it to start building your dApp from scratch. If you already have an existing dApp of yours, then you can also modify it simply to use an Ocean data NFT.
</details>
<details>
@ -134,17 +133,23 @@ By participating in Ocean Data Challenges, you can tackle real-world problems, l
<summary><mark style="color:blue;">Become an Ambassador</mark><br><br>Becoming an <a href="https://oceanambassadors.community/">Ocean Ambassador</a> presents a unique opportunity to actively contribute to the growth and adoption of Ocean Protocol while being at the forefront of the decentralized data revolution.</summary>
As an Ocean Ambassador, you become an advocate for the protocol, promoting its vision of democratizing data and empowering individuals. By sharing your knowledge and enthusiasm, you can educate others about the benefits and potential of Ocean Protocol, inspiring them to join the ecosystem. As part of a global community of like-minded individuals, you gain access to exclusive resources, networking opportunities, and collaborations that further enhance your expertise in the data economy. As an Ambassador, you play a vital role in shaping the future of data by driving awareness, fostering innovation, and helping to build a more open and equitable data ecosystem.
As an Ocean Ambassador, you become an advocate for the protocol, promoting its vision of democratizing data and empowering individuals. By sharing your knowledge and enthusiasm, you can educate others about the benefits and potential of Ocean Protocol, inspiring them to join the ecosystem. As part of a global community of like-minded individuals, you gain access to exclusive resources, networking opportunities, and collaborations that further enhance your expertise in the data economy. As an Ambassador, you play a vital role in shaping the future of data by driving awareness, fostering innovation, and helping to build a more open and equitable data ecosystem. Of course, the Ocean Protocol Ambassador Program rewards contributors with weekly bounties and discretionary grants for growing the Ocean Protocol communtiy worldwide.
Follow the steps below to become an ambassador:
To become a member of the Ambassador Program, follow these steps:
1. Join Ocean Protocol's [Discord](https://discord.com/invite/TnXjkR5) server
2. Join the Discord channel called #treasure-hunter.
3. Access the application form: "[Apply](https://discord.com/channels/612953348487905282/1133478278531911790) to use this channel."
4. Answer the questions in the application form.
5. Once you've completed the application process, you can start earning experience points (XP) by actively engaging in discussions on various topics related to the Ocean Protocol.
</details>
<details>
<summary><mark style="color:green;">Contribute to Ocean Code Development</mark><br><br>Make a positive impact in the Web3 data economy by contributing to <a href="https://github.com/oceanprotocol">Ocean's open source code</a> on Github! From feature requests to pull requests, contributions of all kinds are appreciated.</summary>
To begin, [visit our Github page](https://github.com/oceanprotocol) where you can see the repos and contributors. If you're going to contribute code to a repo, then we ask that you fork the code first, make your changes, and then create a pull request for us to review. If you are reporting an issue, then please first search the existing issues to see if it is documented yet. If not, then please open a new issue by describe your problem as best as possible and include screenshots.
We also welcome you to join our [Discord developer community](https://discord.gg/TnXjkR5) where you can get rapid, practical advice on using Ocean tech but also get to know Ocean core team more personally!
To begin, [visit the Ocean Github page](https://github.com/oceanprotocol) where you can see the repos and contributors. If you're going to contribute code to a repo, then we ask that you fork the code first, make your changes, and then create a pull request for us to review. If you are reporting an issue, then please first search the existing issues to see if it is documented yet. If not, then please open a new issue by describe your problem as best as possible and include screenshots.
We also welcome you to join the [Discord developer community](https://discord.gg/TnXjkR5) where you can get rapid, practical advice on using Ocean tech but also get to know Ocean core team more personally!
</details>
This is just the beginning of what Ocean Protocol has to offer. Join us as we explore, innovate, and push the boundaries of what's possible with decentralized data. Together, we can shape a future where data is accessible, secure and empowers individuals and organizations alike. Let's dive in and discover the endless possibilities of Ocean Protocol :ocean:

918
discover/faq.md
View File

File diff suppressed because it is too large Load Diff

2
discover/glossary.md
View File

@ -274,7 +274,7 @@ In the context of Ocean Protocol, interoperability enables the integration of th
Smart contracts are self-executing digital contracts that allow for the automation and verification of transactions without the need for a third party. They are programmed using code and operate on a decentralized blockchain network. Smart contracts are designed to enforce the rules and regulations of a contract, ensuring that all parties involved fulfill their obligations. Once the conditions of the contract are met, the smart contract automatically executes the transaction, ensuring that the terms of the contract are enforced in a transparent and secure manner.
Ocean ecosystem smart contracts are deployed on multiple blockchains like Polygon, Energy Web Chain, Binance Smart Chain, and others. The code is open source and available on the organization's [GitHub](https://github.com/oceanprotocol/contracts).
Ocean ecosystem smart contracts are deployed on multiple blockchains like Polygon, Energy Web Chain, BNB Smart Chain, and others. The code is open source and available on the organization's [GitHub](https://github.com/oceanprotocol/contracts).
</details>

8
discover/networks/README.md
View File

@ -23,17 +23,17 @@ Ocean Protocol is also deployed to Polygon Mainnet, which is another production
**Bridge**
Check our Polygon Bridge [guide](bridges.md) to learn how you can deposit, withdraw and send tokens.
Check out the Polygon Bridge [guide](bridges.md) to learn how you can deposit, withdraw and send tokens.
### Binance Smart Chain
### BNB Smart Chain
Ocean Protocol is also deployed to Binance Smart Chain (BSC), which is another production network. The native token of the Binance Smart Chain is BNB, which is the token of the Binance exchange. If Binance Smart Chain is not listed as a predefined network in your wallet, you can manually connect to it by following Binance's [guide](https://academy.binance.com/en/articles/connecting-metamask-to-binance-smart-chain), which provides detailed instructions on how to connect to Binance Smart Chain.
Ocean Protocol is also deployed to BNB Smart Chain, which is another production network. The native token of the BNB Smart Chain is BNB, which is the token of the Binance exchange. If BNB Smart Chain is not listed as a predefined network in your wallet, you can manually connect to it by following Binance's [guide](https://academy.binance.com/en/articles/connecting-metamask-to-binance-smart-chain), which provides detailed instructions on how to connect to BNB Smart Chain.
<table data-header-hidden><thead><tr><th width="100">Gas Token</th><th>BSC BNB(Native token)</th></tr></thead><tbody><tr><td>OCEAN</td><td><a href="https://bscscan.com/token/0xdce07662ca8ebc241316a15b611c89711414dd1a">0xdce07662ca8ebc241316a15b611c89711414dd1a</a></td></tr><tr><td>Explorer</td><td><a href="https://bscscan.com/">https://bscscan.com/</a></td></tr></tbody></table>
**Bridge**
Check our BSC Bridge [guide](bridges.md#binance-smart-chain-bsc-bridge) to learn how you can deposit, withdraw and send tokens.
Check out the BSC Bridge [guide](bridges.md#bnb-smart-chain-bridge) to learn how you can deposit, withdraw and send tokens.
### Energy Web Chain

9
discover/networks/bridges.md
View File

@ -9,9 +9,9 @@ A bridge is a mechanism that connects two or more separate blockchain networks,
We suggest using the following solutions to transfer Ocean tokens between Ethereum mainnet and Polygon or BSC.
## Binance Smart Chain (BSC) Bridge
## BNB Smart Chain Bridge
To transfer Ocean tokens to and from the Binance 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 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.
{% 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.
@ -35,7 +35,7 @@ All you need to do is click on the [wallet](https://wallet.polygon.technology/)
You might come across the name "Matic" in some places instead of "Polygon" because the network is still using its old brand name in certain instances. Don't worry though, it's the same network whether you see Matic or Polygon.
Check out our [blog post](https://blog.oceanprotocol.com/ocean-on-polygon-network-8abad19cbf47) for more details.
Check out this [blog post](https://blog.oceanprotocol.com/ocean-on-polygon-network-8abad19cbf47) for more details.
#### Deposit Tokens
@ -67,7 +67,7 @@ The easiest one is to go to the [polygon network explorer](https://polygonscan.c
<figure><img src="../../.gitbook/assets/wallet/polygon-explorer.png" alt=""><figcaption></figcaption></figure>
Alternatively, you can manually configure the network on Metamask by using the following parameters. To learn how to set up a custom network in Metamask using these values, you can refer to our guide.
Alternatively, you can manually configure the network on Metamask by using the following parameters. To learn how to set up a custom network in Metamask using these values, you can refer to this [guide](../wallets/metamask-setup.md#set-up-custom-network).
| What | Value |
| ------------------ | ---------------------------------------------------- |
@ -77,4 +77,3 @@ Alternatively, you can manually configure the network on Metamask by using the f
| Currency Symbol | `MATIC` |
| Block Explorer URL | [`https://polygonscan.com`](https://polygonscan.com) |
Follow our guide to learn how to use those values to [set up a custom network in MetaMask](../wallets/metamask-setup.md#set-up-custom-network).

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

@ -35,7 +35,7 @@ Almost all ERC-20 wallets require these values for adding a custom token:
<td>18</td>
</tr>
<tr>
<td><strong>BSC</strong><br><strong>Binance Smart Chain</strong></td>
<td><strong>BNB</strong><br><strong>BNB Smart Chain</strong></td>
<td>0xdce07662ca8ebc241316a15b611c89711414dd1a</td>
<td>OCEAN</td>
<td>18</td>

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

@ -34,7 +34,7 @@ Before you can publish or purchase assets, you will need a crypto wallet. As Met
![Manage tokens](../../.gitbook/assets/wallet/manage-tokens.png)
You can also watch our [tutorial video snippets](https://www.youtube.com/playlist?list=PL\_dn0wVs9kWolBCbtHaFxsi408cumOeth) if you want more help setting up MetaMask.
You can also watch this [video tutorial](https://www.youtube.com/playlist?list=PL\_dn0wVs9kWolBCbtHaFxsi408cumOeth) if you want more help setting up MetaMask.
### Set Up Custom Network

4
infrastructure/README.md
View File

@ -8,7 +8,7 @@ coverY: 0
There are many ways in which the components can be deployed, from simple configurations used for development and testing to complex configurations, used for production systems.
All the Ocean Protocol components ([Provider](../developers/provider/README.md), [Aquarius](../developers/aquarius/README.md), [Subgraph](../developers/subgraph/README.md)) are designed to run in Docker containers, on a Linux operating system. For simple configurations, we rely on Docker Engine and Docker Compose products to deploy and run our components, while for complex configurations we use Kubernetes. The guides included in this section will present both deployment options.
All the Ocean Protocol components ([Provider](../developers/provider/README.md), [Aquarius](../developers/aquarius/README.md), [Subgraph](../developers/subgraph/README.md)) are designed to run in Docker containers, on a Linux operating system. For simple configurations, we rely on Docker Engine and Docker Compose products to deploy and run the components, while for complex configurations we use Kubernetes. The guides included in this section will present both deployment options.
Please note that deploying the Ocean components requires a good understanding of:
@ -16,6 +16,6 @@ Please note that deploying the Ocean components requires a good understanding of
* Docker Engine
* Docker Compose or Kubernetes (depending on the configuration chosen for the component deployment)
Please note that although Ocean Marketplace is not a core component of our stack but rather an example of what can be achieved with our technology, in this section we included a guide on how to deploy it.
Please note that Ocean Marketplace is not a core component of the stack but rather an example of what can be achieved with the technology, in this section we included a guide on how to deploy it.
All components need to be deployed on a server, so we included a guide about how to install and configure a server will all the necessary tools.

2
infrastructure/deploying-marketplace.md
View File

@ -47,7 +47,7 @@ NEXT_PUBLIC_METADATACACHE_URI=https://v4.aquarius.oceanprotocol.com
### Create a \`Dockerfile\` file and copy the below content into it.
In the following Dockerfile, replace \<YOUR\_GIT\_REPO\_URL> with the url of your Ocean Market fork repository or use "https://github.com/oceanprotocol/market.git" if you want to deploy our standard image of Ocean Market.
In the following Dockerfile, replace \<YOUR\_GIT\_REPO\_URL> with the url of your Ocean Market fork repository or use "https://github.com/oceanprotocol/market.git" if you want to deploy the standard image of Ocean Market.
<pre class="language-docker" data-title="Dockerfile"><code class="lang-docker">FROM node:16
<strong>RUN git clone &#x3C;YOUR_GIT_REPO_URL> /usr/app/market

4
rewards/README.md
View File

@ -88,8 +88,8 @@ Finally, if you want to continue expanding your knowledge on OCEAN token emissio
[Data Farming Background](df-emissions-apys.md#a-brief-history-of-data-farming) will provide you with a lot more information about Data Farming, how the program evolved, and explain detailed mechanisms of the program such as the Reward Function.
Our [FAQ](df-faq.md) answers many different questions about staking, chains, deployments, and other details that may be valuable to you.
The [FAQ](df-faq.md) answers many different questions about staking, chains, deployments, and other details that may be valuable to you.
## Reference
All content within has been assembled via reference of the [Ocean Data Farming Series](https://blog.oceanprotocol.com/ocean-data-farming-series-c7922f1d0e45), official [Ocean Protocol github repositories](https://github.com/oceanprotocol/), and [v4 Whitepapers](https://oceanprotocol.com/tech-whitepaper.pdf).
All content within has been assembled via reference of the [Ocean Data Farming Series](https://blog.oceanprotocol.com/ocean-data-farming-series-c7922f1d0e45), official [Ocean Protocol github repositories](https://github.com/oceanprotocol/), and [Whitepapers](https://oceanprotocol.com/tech-whitepaper.pdf).

2
rewards/df-challengedf.md
View File

@ -33,7 +33,7 @@ For the full details on how to submit, please read the [Where to start](#where-t
### What do I gain from this?
- Earn OCEAN rewards, [claimable inside our app](https://df.oceandao.org/rewards)
- Earn OCEAN rewards, [claimable inside the app](https://df.oceandao.org/rewards)
- Gain in-depth knowledge of the Ocean Protocol stack.
- Increase your visibility by achieving a place on the podium.
- Create valuable assets that can be monetized on the Ocean Marketplace.

20
rewards/df-faq.md
View File

@ -7,11 +7,11 @@ 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 tokens. Can you show me how? Where can I learn about APY and locks?</summary>
Absolutely, we've adopted the voting escrowed system from Curve Finance (veCRV) and created veOCEAN.
veOCEAN lets you lock $OCEAN to receive veOCEAN. You then automatically access Passive Rewards via Data Farming while learning more about Active Rewards. Here are some handy resources to help you get started:
veOCEAN lets you lock OCEAN to receive veOCEAN. You then automatically access Passive Rewards via Data Farming while learning more about Active Rewards. Here are some handy resources to help you get started:
1. [Tutorial](user-guides/how-to-volumedf.md)
2. [Estimate your APY](user-guides/how-to-estimate-apy.md)
@ -43,7 +43,7 @@ You can delegate veOCEAN to others in order to facilitate farming, however, you
<summary>Which networks are eligible for Data Farming?</summary>
You participate by default in Passive Rewards when you lock $OCEAN on Ethereum Mainnet.
You participate by default in Passive Rewards when you lock OCEAN on Ethereum Mainnet.
Data assets for Volume DF may be published in any network where Ocean’s deployed in production: Eth Mainnet, Polygon, BSC, and more.
@ -91,7 +91,7 @@ Yes. When you lock Ocean tokens, you'll receive them back at the end of the lock
<summary>Is it possible to only participate in Passive Rewards? Or should I participate in Active Rewards?</summary>
You participate by default in Passive Rewards when you lock $OCEAN.
You participate by default in Passive Rewards when you lock OCEAN.
But to maximize your rewards, you will also need to engage in Active Rewards.
@ -120,9 +120,9 @@ The ratio stands at 80% to 20%, creating an imbalanced pool that minimizes price
<details>
<Summary> How to convert PsdnOcean back to $OCEAN ?</Summary>
<Summary> How to convert PsdnOcean back to OCEAN ?</Summary>
You can convert psdnOCEAN back to $OCEAN using the Balancer AMM liquidity [pool](https://app.balancer.fi/#/ethereum/pool/0xf8c4cd95c7496cb7c8d97202cf7e5b8da2204c2b00020000000000000000039e).
You can convert psdnOCEAN back to OCEAN using the Balancer AMM liquidity [pool](https://app.balancer.fi/#/ethereum/pool/0xf8c4cd95c7496cb7c8d97202cf7e5b8da2204c2b00020000000000000000039e).
[Price information](https://www.geckoterminal.com/eth/pools/0xf8c4cd95c7496cb7c8d97202cf7e5b8da2204c2b) for psdnOCEAN.
@ -180,9 +180,9 @@ They can be claimed/redeposited whenever you want. If you don't claim, they just
<details>
<summary>Are rewards paid out in veOCEAN or $OCEAN?</summary>
<summary>Are rewards paid out in veOCEAN or OCEAN?</summary>
All rewards in Data Farming are paid out in $OCEAN and can be claimed at the every epoch.
All rewards in Data Farming are paid out in OCEAN and can be claimed at the every epoch.
</details>
@ -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 tokens and how the APY is calculated?</summary>
Yes, You can find the details in these resources.⁣
1. [Benefits](df-veocean).
@ -331,6 +331,6 @@ You can find the statistics for the number of locked tokens [here](https://autob
<summary>Is there a way to check the duration and amounts of veOCEAN locked on-chain for all wallets?</summary>
Yes, this information is available. Indeed, there is a technical aspect involved. You'll need to have some technical knowledge because you'll be required to query our subgraph. You can find a working example of how to get the list of holders [in our subgraph documentation](../developers/subgraph/get-veocean-stats#get-the-veocean-holders-list). Feel free to run the script by clicking on the "run" button.
Yes, this information is available. Indeed, there is a technical aspect involved. You'll need to have some technical knowledge because you'll be required to query the subgraph. You can find a working example of how to get the list of holders [in the subgraph documentation](../developers/subgraph/get-veocean-stats#get-the-veocean-holders-list). Feel free to run the script by clicking on the "run" button.
</details>

4
rewards/df-intro.md
View File

@ -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#allocating-veocean) rewards Data Farmers that allocate their veOCEAN tokens to Ocean datasets. It's called Volume DF because the amount of rewards relies on assets that are actively generating Data Consume Volume.
[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.
You can visit the follow tutorial learn how to [access Volume DF](user-guides/how-to-volumedf.md).
@ -111,4 +111,4 @@ The table below shows the total amount of OCEAN rewards that will be distributed
## [GET STARTED DATA FARMING HERE.](https://df.oceandao.org)
### Unsure how? Our [guides](../user-guides/README.md) will show you how to do the basics.
### Unsure how? These [guides](../user-guides/README.md) will show you how to do the basics.

2
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 our 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 tokens 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**!

2
rewards/df-volumedf.md
View File

@ -92,6 +92,6 @@ The asset may be of any type — dataset, an algorithm for Compute-to-Data, or a
To qualify for DF, an asset must also:
* Have been created by Ocean Smart contracts [deployed](https://github.com/oceanprotocol/contracts/blob/v4main/addresses/address.json) by OPF to [production networks](../discover/networks/README.md)
* Have been created by Ocean Smart contracts [deployed](https://github.com/oceanprotocol/contracts/blob/main/addresses/address.json) by OPF to [production networks](../discover/networks/README.md)
* The asset must be listed on Ocean Market
* Can’t be in [purgatory](https://github.com/oceanprotocol/list-purgatory/blob/main/policies/README.md)

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

@ -8,7 +8,7 @@ description: How to claim OCEAN token rewards from data farming 🧑‍🌾🥕
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!
You can visit our dApp to [begin Data Farming](https://df.oceandao.org)? Or [follow this user guide](how-to-veocean.md) to get started. 🤠
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. 🤠
### Step 1 - Navigate to the Data Farming Rewards page

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

@ -32,7 +32,7 @@ Watch and learn, friend
#### Step 4 - Connect Your Wallet + Lock your OCEAN for veOCEAN
- Click on the purple circles in our 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 tokens for veOCEAN tokens.
{% embed url="https://app.arcade.software/share/FUSkygksSRsJHwle1zFs" fullWidth="false" %}
{% endembed %}

2
user-guides/asset-hosting/README.md
View File

@ -10,7 +10,7 @@ The most important thing to remember is that wherever you host your asset... it
### Publish. Cool. Things.
**If you want to publish cool things on the Ocean Marketplace, then you'll first need a place to host your assets!** You have SO many options where to host your asset including centralized and decentralized storage systems. Places to host may include: Github, IPFS, Arweave, AWS, Azure, Google Cloud, and your own personal home server (if that's you, then you probably don't need a tutorial on hosting assets). Really, anywhere with a downloadable link to your asset is fine.
If you want to publish cool things on the Ocean Marketplace, then you'll first need a place to host your assets as **Ocean doesn't store data**; you're responsible for hosting it on your chosen service and providing the necessary details for publication. You have SO many options where to host your asset including centralized and decentralized storage systems. Places to host may include: Github, IPFS, Arweave, AWS, Azure, Google Cloud, and your own personal home server (if that's you, then you probably don't need a tutorial on hosting assets). Really, anywhere with a downloadable link to your asset is fine.
In this section, we'll walk you through three options to store your assets: Arweave (decentralized storage), AWS (centralized storage), and Azure (centralized storage). Let's goooooo!

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

@ -6,9 +6,19 @@ description: How to Buy and Download Data on the Ocean Market
<figure><img src="../.gitbook/assets/gif/clueless-shopping.gif" alt=""><figcaption><p>That moment when you buy your first datatoken</p></figcaption></figure>
Before we go shopping, it's important to note that the primary responsibility for data validation rests with the customer. To evaluate the quality of the data, take into account the following questions:
1. What is the reputation of the dataset's publisher?
2. Does the dataset include well-defined metadata and provenance information?
3. Is sample data available for evaluation?
4. What is the dataset's rating within the marketplace? (Check the star rating we've implemented.)
5. Is the publisher responsive to inquiries? You can initiate a direct message to the publisher via the marketplace to engage in discussions before making a data purchase.
Once you're confident that the dataset meets your requirements, you're ready to make your purchase! 🛒📊
### Let's Go Shopping! 💁‍♀️🛍️
1. Go to the [Ocean Market](https://v4.market.oceanprotocol.com/).
1. Go to the [Ocean Market](https://market.oceanprotocol.com/).
2. Search for NFTs using the search bar in the top right corner of the page. The Ocean Marketplace provides features to search for Data/Algorithm NFTs by text, and users can also sort the result by published date.
3. Connect your wallet. If you know the network the asset is hosted on, then you can also select the network from the dropdown to the left of the Connect Wallet button to filter!
@ -22,7 +32,7 @@ The Buy button is enabled only if the connected wallet address has enough OCEAN
![Click the large pink Buy button](../.gitbook/assets/market/consume-1.png)
Are you buying an asset on the Polygon network? Then you'll need mOCEAN "matic OCEAN" to buy assets! Watch our tutorial how to get mOCEAN so that you can go shopping on the Ocean Market 🤑🛒
Are you buying an asset on the Polygon network? Then you'll need mOCEAN "matic OCEAN" to buy assets! Watch this tutorial about how to get mOCEAN so that you can go shopping on the Ocean Market 🤑🛒
{% embed url="https://www.youtube.com/watch?v=W5eIipUHl-w" %}
Learn how to get mOCEAN

2
user-guides/compute-to-data/README.md
View File

@ -18,7 +18,7 @@ Enter, **Compute-to-Data** (also lovingly called C2D 🥰). Ocean Protocol's C2D
You will need to accomplish **3 main steps** in establishing a compute-to-data flow: [create an algorithm](make-a-boss-c2d-algorithm.md) that's compatible with C2D, [publish your C2D-specific algorithm NFT](publish-a-c2d-algorithm-nft.md), then [publish your data NFT with C2D configurations](publish-a-c2d-data-nft.md) allowing the algorithm to compute on it. That's it! Then you'll be able to sell compute jobs 🤩 Read the steps in this section's three subpages to create & sell a compute job from start to finish. 💪😃
Or you could watch our video tutorial about it below:
Or you could watch this video tutorial about it below:
{% embed url="https://youtu.be/2AF9mkqlf5Y" %}

2
user-guides/join-a-data-challenge.md
View File

@ -16,7 +16,7 @@ Ocean Protocol's data challenges are open competitions where participants must s
### Where can I find the data challenges?
[Discover our open challenges here.](https://oceanprotocol.com/challenges)
[Discover open challenges here.](https://oceanprotocol.com/challenges)
### What is the typical flow for a data challenge?

10
user-guides/publish-data-nfts.md
View File

@ -19,12 +19,12 @@ The publishing process on the Ocean Market both mints (i.e. creates) a [data NFT
### No code flow
{% embed url="https://www.youtube.com/watch?v=3NGSmfXkHAQ" %}
Don't enjoy reading? Watch our video tutorial!
Don't enjoy reading? Watch the video tutorial!
{% endembed %}
#### Getting Started 🏃💨
1. Go to the [Ocean Market](https://v4.market.oceanprotocol.com).
1. Go to the [Ocean Market](https://market.oceanprotocol.com).
2. Connect your wallet.
3. Select the network where you would like to publish your NFT (ex. Ethereum, Polygon, etc).
@ -123,12 +123,12 @@ Now, your data NFT is successfully published and available in the Ocean Market!
![Successful publish](../.gitbook/assets/market/publish-7.png)
On the [profile page](https://v4.market.oceanprotocol.com/profile), a publisher has access to all their published assets.
On the [profile page](https://market.oceanprotocol.com/profile), a publisher has access to all their published assets.
### Code flow
* **Python:** Are you looking at how to publish a data NFT using Python? Follow our ocean.py [Publish Flow](../developers/ocean.py/publish-flow.md) to mint a data NFT and datatoken using Python.
* **Javascript**: Are you looking at how to publish a data NFT using Javascript? Follow our ocean.js [Publish Flow](../developers/ocean.js/publish.md) to mint a data NFT and datatoken using Javascript.
* **Python:** Are you looking at how to publish a data NFT using Python? Follow the ocean.py [Publish Flow](../developers/ocean.py/publish-flow.md) to mint a data NFT and datatoken using Python.
* **Javascript**: Are you looking at how to publish a data NFT using Javascript? Follow the ocean.js [Publish Flow](../developers/ocean.js/publish.md) to mint a data NFT and datatoken using Javascript.
#### More Info 🧐

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

@ -8,7 +8,7 @@ description: Buy, mint, and sell all sorts of data on the Ocean Market
### What is the [Ocean Market](https://market.oceanprotocol.com/)? 🛒
The Ocean Market is a place for buyers + sellers of top-notch data and algorithms to exchange goods. Our market also gives you easy-to-use publishing and purchasing tools to monetize your intellectual property. 🤑 What's not to love? 💕
The Ocean Market is a place for buyers + sellers of top-notch data and algorithms to exchange goods. The market also gives you easy-to-use publishing and purchasing tools to monetize your intellectual property. 🤑 What's not to love? 💕
#### **You can:**