mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
More changes requested in the review
This commit is contained in:
Ana Loznianu
parent
2b989f59cf
commit
b96b6ff30f
@ -24,7 +24,7 @@ Follow the steps below to properly document your bug! Paste the screenshots into
|
||||
|
||||
### Report vulnerabilities
|
||||
|
||||
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 the 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 the code matrix?</p></figcaption></figure>
|
||||
|
||||
@ -62,9 +62,9 @@ Except for GitHub, you can chat with most Ocean Protocol core developers in the
|
||||
|
||||
### 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 the 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 the 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 the docs
|
||||
|
||||
@ -72,7 +72,7 @@ The docs repo can always be improved. If you found a mistake or have an improvem
|
||||
|
||||
### Apply for a developer job
|
||||
|
||||
Do you REALLY love building on Ocean Protocol? Consider joining us full-time! The openings are listed at [https://github.com/oceanprotocol/jobs](https://github.com/oceanprotocol/jobs).
|
||||
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).
|
||||
|
||||
|
||||
|
||||
|
||||
@ -7,7 +7,7 @@ description: We are so proud of the companies that use Ocean Protocol tools!
|
||||
|
||||
<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 the up-to-date list of partners and collaborators on the [Ecosystem page](https://oceanprotocol.com/ecosystem) of the website.
|
||||
From startups to full enterprises, we have so many partners and collaborators using Ocean tech. Curious who's working with Ocean tools? Check out the up-to-date list of partners and collaborators on the [Ecosystem page](https://oceanprotocol.com/ecosystem).
|
||||
|
||||
### Show your support by trading OCEAN tokens
|
||||
|
||||
|
||||
@ -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). The [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, etc. By using blockchain architecture, Ocean achieves several tactical advantages over Web2 to solve these data sharing problems.
|
||||
|
||||
### What are some use cases for Ocean Protocol?
|
||||
|
||||
|
||||
@ -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 the [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 the 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 the [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 the 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" %}
|
||||
|
||||
@ -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 the 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 %}
|
||||
|
||||
@ -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, 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.
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ If you’re part of an established organization or a growing startup, you’ll a
|
||||
|
||||
### 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 latest 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.
|
||||
|
||||
Ocean 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. **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.
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ description: Empowering the Decentralised Data Economy
|
||||
|
||||
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 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). Ocean introduced 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**
|
||||
|
||||
@ -37,7 +37,7 @@ Key features of the smart contracts:
|
||||
* 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 aApp 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 🗃️
|
||||
|
||||
@ -35,7 +35,7 @@ We have implemented data NFTs using the [ERC721 standard](https://erc721.org/).
|
||||
|
||||
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**.
|
||||
|
||||
The 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/).
|
||||
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>
|
||||
|
||||
|
||||
@ -72,7 +72,7 @@ node create_dataNFT.js
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
* Checkout the [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.
|
||||
|
||||
@ -16,7 +16,7 @@ ocean.py serves as a connection layer bridging the smart contracts and various c
|
||||
|
||||
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 the library is the "[Ocean](technical-details.md)" class. It oversees everything and keeps track of the data flow.
|
||||
The head of this 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:
|
||||
|
||||
|
||||
@ -23,7 +23,7 @@ Ocean Protocol is also deployed to Polygon Mainnet, which is another production
|
||||
|
||||
**Bridge**
|
||||
|
||||
Check the 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
|
||||
|
||||
|
||||
@ -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 the 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
|
||||
|
||||
|
||||
@ -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 the video tutorial about it below:
|
||||
Or you could watch this video tutorial about it below:
|
||||
|
||||
{% embed url="https://youtu.be/2AF9mkqlf5Y" %}
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user