mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
GITBOOK-456: change request with no subject merged in GitBook
This commit is contained in:
enzo
gitbook-bot
parent
1423348c6e
commit
6f831c0ce3
@ -4,8 +4,9 @@
|
||||
* [🌊 Discover](discover/README.md)
|
||||
* [Explore](discover/explore.md)
|
||||
* [Basic Concepts](discover/engage.md)
|
||||
* [Wallets](discover/wallets.md)
|
||||
* [Set Up MetaMask Wallet](discover/metamask-setup.md)
|
||||
* [Ocean 101](discover/ocean-101.md)
|
||||
* [Wallets](discover/wallets/README.md)
|
||||
* [Set Up MetaMask Wallet](discover/wallets/metamask-setup.md)
|
||||
* [Networks](discover/networks/README.md)
|
||||
* [Bridges](discover/networks/bridges.md)
|
||||
* [Manage Your OCEAN Tokens](discover/wallets-and-ocean-tokens.md)
|
||||
@ -38,7 +39,7 @@
|
||||
* [Datatoken Templates](developers/contracts/datatoken-templates.md)
|
||||
* [Roles](developers/contracts/roles.md)
|
||||
* [Revenue](developers/contracts/revenue.md)
|
||||
* [Asset Pricing](developers/asset-pricing.md)
|
||||
* [Pricing Schemas](developers/asset-pricing.md)
|
||||
* [Fees](developers/fees.md)
|
||||
* [Metadata](developers/contracts/metadata.md)
|
||||
* [Fractional Ownership](developers/fractional-ownership.md)
|
||||
|
||||
@ -23,4 +23,4 @@ These [smart contracts](contracts/) form the backbone of Ocean Protocol, empower
|
||||
|
||||
<figure><img src="../.gitbook/assets/smart-contracts.png" alt=""><figcaption><p>Smart Contracts</p></figcaption></figure>
|
||||
|
||||
Now, if you're new to the world of web3 and blockchain technologies, fear not! We've got you covered. Before diving into the depths of Ocean Protocol, we recommend starting with some introductory guides. These [guides](../user-guides/) will gently introduce you to the magical world of [web3](../discover/wallets.md) and help you understand the [basics](../discover/wallets-and-ocean-tokens.md) before you embark on your epic data-driven adventure.
|
||||
Now, if you're new to the world of web3 and blockchain technologies, fear not! We've got you covered. Before diving into the depths of Ocean Protocol, we recommend starting with some introductory guides. These [guides](../user-guides/) will gently introduce you to the magical world of [web3](../discover/wallets/) and help you understand the [basics](../discover/wallets-and-ocean-tokens.md) before you embark on your epic data-driven adventure.
|
||||
|
||||
@ -46,7 +46,7 @@ Prominently featured within this layer is [Ocean Market](../user-guides/using-oc
|
||||
|
||||
### Layer 4: The Friendly Wallets
|
||||
|
||||
At the top of the Ocean Protocol ecosystem, we find the esteemed [Web 3 Wallets](../discover/wallets.md), the gateway for users to immerse themselves in the world of decentralized data transactions. These wallets serve as trusted companions, enabling users to seamlessly transact within the ecosystem, purchase and sell data NFTs, and acquire valuable datatokens. For a more detailed exploration of Web 3 Wallets and their capabilities, you can refer to the [wallet intro page](../discover/wallets.md).
|
||||
At the top of the Ocean Protocol ecosystem, we find the esteemed [Web 3 Wallets](../discover/wallets/), the gateway for users to immerse themselves in the world of decentralized data transactions. These wallets serve as trusted companions, enabling users to seamlessly transact within the ecosystem, purchase and sell data NFTs, and acquire valuable datatokens. For a more detailed exploration of Web 3 Wallets and their capabilities, you can refer to the [wallet intro page](../discover/wallets/).
|
||||
|
||||
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
description: Choose the revenue model during asset publishing.
|
||||
---
|
||||
|
||||
# Asset Pricing
|
||||
# Pricing Schemas
|
||||
|
||||
Ocean Protocol offers you flexible and customizable pricing options to monetize your valuable data assets. You have two main pricing models to choose from: 
|
||||
|
||||
@ -11,11 +11,58 @@ Ocean Protocol offers you flexible and customizable pricing options to monetize
|
||||
|
||||
These models are designed to cater to your specific needs and ensure a smooth experience for data consumers.
|
||||
|
||||
The price of an asset is determined by the number of Ocean tokens a buyer must pay to access the asset. When users pay the right amount of Ocean tokens, they get a _datatoken_ in their wallets, a tokenized representation of the access right stored on the blockchain. To read more about datatoken and data NFT click [here](contracts/datanft-and-datatoken.md).
|
||||
The price of an asset is determined by the number of tokens (this can be Ocean Tokens or any ERC20 Token configured when published the asset) a buyer must pay to access the data. When users pay the tokens, they get a _datatoken_ in their wallets, a tokenized representation of the access right stored on the blockchain. To read more about datatoken and data NFT click [here](contracts/datanft-and-datatoken.md).
|
||||
|
||||
To provide you with even greater flexibility in monetizing your data assets, Ocean Protocol allows you to customize the pricing schema by configuring your own ERC20 token when publishing the asset. This means that instead of using Ocean Tokens as the pricing currency, you can utilize your own token, aligning the pricing structure with your specific requirements and preferences.
|
||||
|
||||
You can customised your token this way:
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Ocean Market" %}
|
||||
```javascript
|
||||
NEXT_PUBLIC_OCEAN_TOKEN_ADDRESS='0x00000' // YOUR TOKEN'S ADDRESS
|
||||
```
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="Ocean.js" %}
|
||||
<pre class="language-javascript"><code class="lang-javascript"><strong>// https://github.com/oceanprotocol/ocean.js/blob/main/CodeExamples.md#61-publish-a-dataset-create-nft--datatoken-with-a-fixed-rate-exchange
|
||||
</strong><strong>const freParams: FreCreationParams = {
|
||||
</strong> fixedRateAddress: addresses.FixedPrice,
|
||||
baseTokenAddress: addresses.Ocean, // you can customize this with any ERC20 token
|
||||
owner: await publisherAccount.getAddress(),
|
||||
marketFeeCollector: await publisherAccount.getAddress(),
|
||||
baseTokenDecimals: 18,
|
||||
datatokenDecimals: 18,
|
||||
fixedRate: '1',
|
||||
marketFee: '0.001',
|
||||
allowedConsumer: ZERO_ADDRESS,
|
||||
withMint: true
|
||||
}
|
||||
</code></pre>
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="Ocean.py" %}
|
||||
```python
|
||||
exchange_args = ExchangeArguments(
|
||||
rate=to_wei(1), # you can customize this with any price
|
||||
base_token_addr=OCEAN.address, # you can customize this with any ERC20 token
|
||||
owner_addr=publisher_wallet.address,
|
||||
publish_market_fee_collector=ZERO_ADDRESS,
|
||||
publish_market_fee=0,
|
||||
with_mint=True,
|
||||
allowed_swapper=ZERO_ADDRESS,
|
||||
full_info=False,
|
||||
dt_decimals=datatoken.decimals()
|
||||
)
|
||||
```
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
Furthermore, Ocean Protocol recognizes that different data assets may have distinct pricing needs. That's why the platform supports multiple pricing schemas, allowing you to implement various pricing models for different datasets or use cases. This flexibility ensures that you can tailor the pricing strategy to each specific asset, maximizing its value and potential for monetization.
|
||||
|
||||
### Fixed pricing
|
||||
|
||||
With the fixed pricing model, you have the power to set a specific price for your data assets in Ocean tokens (OCEAN). This means that buyers interested in accessing your data will need to pay the designated amount of OCEAN. To make things even easier, Ocean Market automatically creates a special token called a "datatoken" behind the scenes. 
|
||||
With the fixed pricing model, you have the power to set a specific price for your data assets. This means that buyers interested in accessing your data will need to pay the designated amount of configured tokens. To make things even easier, Ocean automatically creates a special token called a "datatoken" behind the scenes. 
|
||||
|
||||
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. 
|
||||
|
||||
@ -135,6 +182,8 @@ function createNftWithErc20WithDispenser(
|
||||
|
||||
</details>
|
||||
|
||||
To make the most of these pricing models, you can rely on user-friendly libraries such as [Ocean.js ](ocean.js/)and [Ocean.py](ocean.py/), specifically developed for interacting with Ocean Protocol. With Ocean.js, you can use the [createFRE() ](ocean.js/publish.md)function to effortlessly deploy a data NFT (non-fungible token) and datatoken with a fixed-rate exchange pricing model. Similarly, in Ocean.py, the [create\_url\_asset()](ocean.py/publish-flow.md#create-an-asset-and-pricing-schema-simultaneously) function allows you to create an asset with fixed pricing. These libraries simplify the process of interacting with Ocean Protocol, managing pricing, and handling asset creation.
|
||||
To make the most of these pricing models, you can rely on user-friendly libraries such as [Ocean.js ](ocean.js/)and [Ocean.py](ocean.py/), specifically developed for interacting with Ocean Protocol. 
|
||||
|
||||
With Ocean.js, you can use the [createFRE() ](ocean.js/publish.md)function to effortlessly deploy a data NFT (non-fungible token) and datatoken with a fixed-rate exchange pricing model. Similarly, in Ocean.py, the [create\_url\_asset()](ocean.py/publish-flow.md#create-an-asset-and-pricing-schema-simultaneously) function allows you to create an asset with fixed pricing. These libraries simplify the process of interacting with Ocean Protocol, managing pricing, and handling asset creation.
|
||||
|
||||
By taking advantage of Ocean Protocol's pricing options and leveraging the capabilities of [Ocean.js](ocean.js/) and [Ocean.py](ocean.py/) (or by using the [Market](../user-guides/using-ocean-market.md)), you can effectively monetize your data assets while ensuring transparent and seamless access for data consumers. 
|
||||
|
||||
@ -23,7 +23,7 @@ What are your thoughts on this? From where we stand, it seems like we're rapidly
|
||||
|
||||
That's why we made the decision to take action, and it led to the creation of **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 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.**
|
||||
|
||||
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.
|
||||
|
||||
|
||||
@ -77,4 +77,4 @@ 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](../metamask-setup.md#set-up-custom-network).
|
||||
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).
|
||||
|
||||
35
discover/ocean-101.md
Normal file
35
discover/ocean-101.md
Normal file
@ -0,0 +1,35 @@
|
||||
# Ocean 101
|
||||
|
||||
## Introduction to Ocean Protocol
|
||||
|
||||
Ocean Protocol is a decentralized data exchange protocol that aims to unlock the value of data and enable secure and privacy-preserving data sharing and monetization. It provides a framework for building data marketplaces that facilitate the exchange of data assets while ensuring data privacy, security, and compliance.
|
||||
|
||||
## What is Ocean Used For?
|
||||
|
||||
Ocean Protocol is used for a variety of purposes, including:
|
||||
|
||||
1. Data Sharing: Ocean Protocol allows individuals and organizations to share data securely and privately, enabling data owners to monetize their data assets while maintaining control over their data.
|
||||
2. Data Monetization: Data owners can monetize their data by offering it for sale or by providing data services through compute-to-data (C2D) capabilities. Data consumers can access and utilize data assets to train machine learning models, perform data analysis, and drive insights.
|
||||
3. Decentralized Data Marketplaces: Ocean Protocol facilitates the creation of decentralized data marketplaces where data providers can list their data assets and data consumers can discover and access them. These marketplaces operate on a peer-to-peer basis, eliminating the need for intermediaries and providing more efficient and transparent data transactions.
|
||||
4. AI Development: Ocean Protocol supports the development of AI models by providing access to diverse and high-quality datasets. Data scientists and AI developers can leverage these datasets to train and improve their models, leading to more accurate and robust AI systems.
|
||||
|
||||
## Why Does Ocean Exist?
|
||||
|
||||
Ocean Protocol exists to address several challenges in the current data ecosystem:
|
||||
|
||||
1. Data Silos: Data is often locked within organizations and inaccessible to others. Ocean Protocol aims to break down these data silos and enable data sharing across different entities, fostering collaboration and innovation.
|
||||
2. Lack of Privacy: Traditional data sharing methods often compromise privacy. Ocean Protocol incorporates privacy-preserving techniques, such as encryption and access control, to ensure that data owners maintain control over their data and only share it with authorized parties.
|
||||
3. Limited Data Monetization: Many data owners struggle to monetize their data assets effectively. Ocean Protocol provides a platform for data owners to list their data assets and earn revenue by selling or offering data services, creating new opportunities for data monetization.
|
||||
4. Intermediaries and Inefficiencies: The current data economy rely on intermediaries, which introduce additional costs and complexities. Ocean Protocol eliminates intermediaries by leveraging blockchain technology and smart contracts, enabling direct peer-to-peer transactions and reducing friction in data exchange.
|
||||
|
||||
## How Does Ocean Work?
|
||||
|
||||
Ocean Protocol utilizes a combination of blockchain technology, decentralized networks, and cryptographic techniques to facilitate secure and privacy-preserving data sharing. Here's an overview of how Ocean works:
|
||||
|
||||
1. Asset Registration: Data providers register their data assets on the Ocean blockchain, providing metadata that describes the asset, its usage terms, and pricing information. This metadata is stored on-chain and can be accessed by potential data consumers.
|
||||
2. Discovery and Access Control: Data consumers can discover available data assets through decentralized metadata services like Aquarius. Access control mechanisms, such as smart contracts, verify the consumer's permissions and handle the transfer of data access tokens.
|
||||
3. Secure Data Exchange: When a data consumer purchases access to a data asset, the asset's metadata and access instructions are encrypted by the data provider using the Provider service. The encrypted asset is then securely transferred to the consumer, who can decrypt and utilize it without revealing the asset's URL.
|
||||
4. Compute-to-Data (C2D): Ocean Protocol supports C2D capabilities, allowing data consumers to perform computations on data assets without direct access to the underlying data. The compute operations are executed in a secure and controlled environment, ensuring data privacy and compliance.
|
||||
5. Incentives and Governance: Ocean Protocol incorporates tokeconomics and a governance framework to incentivize participants and ensure the sustainability and evolution of the ecosystem. Participants can earn and stake Ocean tokens (OCEAN) to access data, contribute to the network, and participate in governance decisions.
|
||||
|
||||
It's a decentralized data exchange protocol that transforms the way we share, monetize, and make the most out of data. By tackling issues such as data silos, limited monetization options, privacy worries, and the hassles of middlemen, Ocean Protocol gives people and organizations the power to unleash the true value of their data. With its decentralized marketplaces, rock-solid data sharing methods, and privacy protection measures, Ocean Protocol opens doors for collaboration, sparks innovation, and encourages responsible and ethical data usage. It's all about making data work for everyone in a fair and transparent data economy.
|
||||
@ -6,7 +6,7 @@ description: Fundamental knowledge of using ERC-20 crypto wallets.
|
||||
|
||||
Ocean Protocol users require an ERC-20 compatible wallet to manage their OCEAN and ETH tokens. In this guide, we will provide some recommendations for different wallet options.
|
||||
|
||||
<figure><img src="../.gitbook/assets/whats-a-wallet.gif" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/whats-a-wallet.gif" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
### What is a wallet?
|
||||
|
||||
@ -12,27 +12,27 @@ Before you can publish or purchase assets, you will need a crypto wallet. As Met
|
||||
|
||||
1. Go to the [Chrome Web Store for extensions](https://chrome.google.com/webstore/category/extensions) and search for MetaMask.
|
||||
|
||||
|
||||
|
||||
|
||||
* Install MetaMask. The wallet provides a friendly user interface that will help you through each step. MetaMask gives you two options: importing an existing wallet or creating a new one. Choose to `Create a Wallet`:
|
||||
|
||||
|
||||
|
||||
|
||||
* In the next step create a new password for your wallet. Read through and accept the terms and conditions. After that, MetaMask will generate Secret Backup Phrase for you. Write it down and store it in a safe place.
|
||||
|
||||
|
||||
|
||||
|
||||
* Continue forward. On the next page, MetaMask will ask you to confirm the backup phrase. Select the words in the correct sequence:
|
||||
|
||||
|
||||
|
||||
|
||||
* Voila! Your account is now created. You can access MetaMask via the browser extension in the top right corner of your browser.
|
||||
|
||||
|
||||
|
||||
|
||||
* You can now manage Ether and Ocean Tokens with your wallet. You can copy your account address to the clipboard from the options. When you want someone to send Ether or Ocean Tokens to you, you will have to give them that address. It's not a secret.
|
||||
|
||||
|
||||
|
||||
|
||||
You can also watch our [tutorial video snippets](https://www.youtube.com/playlist?list=PL\_dn0wVs9kWolBCbtHaFxsi408cumOeth) if you want more help setting up MetaMask.
|
||||
|
||||
@ -42,7 +42,7 @@ Sometimes it is required to use custom or external networks in MetaMask. We can
|
||||
|
||||
Open the Settings menu and find the `Networks` option. When you open it, you'll be able to see all available networks your MetaMask wallet currently use. Click the `Add Network` button.
|
||||
|
||||
|
||||
|
||||
|
||||
There are a few empty inputs we need to fill in:
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
description: Buy, mint, and sell all sorts of data on the Ocean Market
|
||||
---
|
||||
|
||||
# Guide to Ocean Market
|
||||
# Guide to the Ocean Market
|
||||
|
||||
<figure><img src="../.gitbook/assets/shopping-minions.gif" alt=""><figcaption><p>Retail therapy mood!</p></figcaption></figure>
|
||||
|
||||
@ -25,6 +25,6 @@ The Ocean Market is a place for buyers + sellers of top-notch data and algorithm
|
||||
|
||||
**If you are new to web3** and blockchain technologies then we suggest you first get familiar with some Web3 basics:
|
||||
|
||||
* [Wallet Basics](../discover/wallets.md) 👛
|
||||
* [Set Up MetaMask](../discover/metamask-setup.md) [Wallet ](../discover/metamask-setup.md)🦊
|
||||
* [Wallet Basics](../discover/wallets/) 👛
|
||||
* [Set Up MetaMask](../discover/wallets/metamask-setup.md) [Wallet ](../discover/wallets/metamask-setup.md)🦊
|
||||
* [Manage Your OCEAN Tokens](../discover/wallets-and-ocean-tokens.md) 🪙
|
||||
|
||||
Loading…
Reference in New Issue
Block a user