mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
GITBOOK-338: change request with no subject merged in GitBook
This commit is contained in:
mariacarmina.cretu
gitbook-bot
parent
5f516de8f5
commit
afe50c183d
@ -39,8 +39,8 @@
|
||||
* [Fractional Ownership](developers/datanft-and-datatoken/fractional-ownership.md)
|
||||
* [Contracts](developers/contracts/README.md)
|
||||
* [Roles](developers/contracts/roles.md)
|
||||
* [Fees](developers/contracts/fees.md)
|
||||
* [Asset Pricing](developers/contracts/asset-pricing.md)
|
||||
* [Fees](developers/fees.md)
|
||||
* [Asset Pricing](developers/asset-pricing.md)
|
||||
* [Identifiers & Metadata](developers/Identifiers-Metadata.md)
|
||||
* [DDO Specification](developers/ddo-specification.md)
|
||||
* [Storage Specifications](developers/storage-specifications.md)
|
||||
|
||||
@ -18,7 +18,7 @@ Ocean Protocol was built for a world running on data and AI in mind. At the base
|
||||
* Access control is one of the most important parts of data sharing. Ocean Protocol is a standard for managing access control across various storage providers. Publishers can add the credentials for accessing their data assets directly into the assets they list on Ocean. Publishers can also utilize a fine-grained allow list for whitelisting only specific wallets are able to purchase their assets. The fine-grained access control of Ocean Protocol makes it easier for data publishers to interact with each others assets across different storage providers while ensuring only those they want to share the data with can access it. They can also ensure only whitelisted algorithms from trusted parties are allowed to run any computation on their data. To learn more, check out our [fine-grained access control section.](../developers/Fine-Grained-Permissions.md)\
|
||||
|
||||
* Crypto-native Payments
|
||||
* Utilizing Ocean Protocol contracts for payment processing brings numerous benefits compared to the traditional financial system. One major advantage is the significantly lower transaction fees, ranging from 0.1% to 0.2% per transaction, which can be a major reduction compared to the 2-6% typically associated with traditional financial systems. Another key benefit is the instant settlement feature nature of crypto. Payments are processed immediately, ensuring that funds are readily available for immediate use. This eliminates the usual wait of several days associated with traditional systems and avoids any additional charges that may arise from delayed settlements. This instant settlement also provides a zero counterparty risk environment. With the absence of chargebacks, businesses can enjoy greater stability in their revenue streams. This feature provides assurance and peace of mind, eliminating the concerns associated with potential payment reversals. Moreover, users can transact with each other with far greater ease across borders. Users can use any ERC20 token to transact, such as OCEAN or USDC. This provides a standard for selling products around the world. To learn more, check out our our [asset pricing](../developers/contracts/asset-pricing.md) and [contracts ](../developers/contracts/)sections.\
|
||||
* Utilizing Ocean Protocol contracts for payment processing brings numerous benefits compared to the traditional financial system. One major advantage is the significantly lower transaction fees, ranging from 0.1% to 0.2% per transaction, which can be a major reduction compared to the 2-6% typically associated with traditional financial systems. Another key benefit is the instant settlement feature nature of crypto. Payments are processed immediately, ensuring that funds are readily available for immediate use. This eliminates the usual wait of several days associated with traditional systems and avoids any additional charges that may arise from delayed settlements. This instant settlement also provides a zero counterparty risk environment. With the absence of chargebacks, businesses can enjoy greater stability in their revenue streams. This feature provides assurance and peace of mind, eliminating the concerns associated with potential payment reversals. Moreover, users can transact with each other with far greater ease across borders. Users can use any ERC20 token to transact, such as OCEAN or USDC. This provides a standard for selling products around the world. To learn more, check out our our [asset pricing](../developers/asset-pricing.md) and [contracts ](../developers/contracts/)sections.\
|
||||
|
||||
* Provenance of data
|
||||
|
||||
|
||||
@ -1,5 +1,4 @@
|
||||
---
|
||||
title: Asset Pricing
|
||||
description: Choose the revenue model during asset publishing
|
||||
---
|
||||
|
||||
@ -7,7 +6,7 @@ description: Choose the revenue model during asset publishing
|
||||
|
||||
Ocean Protocol offers two types of pricing options for asset monetization. The publisher can choose a pricing model which best suits their needs while publishing an asset. The pricing model selected cannot be changed once the asset is published.
|
||||
|
||||
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](../datanft-and-datatoken/).
|
||||
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](datanft-and-datatoken/).
|
||||
|
||||
### Fixed pricing
|
||||
|
||||
@ -17,7 +16,7 @@ A [FixedRateExchange](https://github.com/oceanprotocol/contracts/blob/v4main/con
|
||||
|
||||
The image below shows how to set the fixed pricing of an asset in the Ocean's Marketplace. Here, the price of the asset is set to 10 Ocean tokens.
|
||||
|
||||
|
||||
|
||||
|
||||
### Free pricing
|
||||
|
||||
@ -29,4 +28,4 @@ Free pricing is suitable for individuals and organizations working in the public
|
||||
|
||||
The image below shows how to set free access to an asset in the Ocean's Marketplace.
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Once someone has generated datatokens, they can be used in any ERC20 exchange, c
|
||||
|
||||
The marketplaces are decentralized (no single owner or controller), and non-custodial (only the data owner holds the keys for the datatokens).
|
||||
|
||||
Ocean Market supports fixed pricing or free pricing. For more detials on pricing schema refer [this guide](../contracts/asset-pricing.md).
|
||||
Ocean Market supports fixed pricing or free pricing. For more detials on pricing schema refer [this guide](../asset-pricing.md).
|
||||
|
||||
Complementary to Ocean Market, Ocean has reference code to ease building **third-party data marketplaces**, such as for logistics ([dexFreight data marketplace](https://blog.oceanprotocol.com/dexfreight-ocean-protocol-partner-to-enable-transportation-logistics-companies-to-monetize-data-7aa839195ac)) or mobility ([Daimler](https://blog.oceanprotocol.com/ocean-protocol-delivers-proof-of-concept-for-daimler-ag-in-collaboration-with-daimler-south-east-564aa7d959ca)).
|
||||
|
||||
|
||||
@ -1,5 +1,4 @@
|
||||
---
|
||||
title: Fees
|
||||
description: The Ocean Protocol defines various fees for creating a sustainability loop.
|
||||
---
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Publish
|
||||
|
||||
This tutorial guides you through the process of creating your own data NFT and a datatoken using Ocean libraries. To know more about data NFTs and datatokens please refer [this page](../datanft-and-datatoken/). Ocean Protocol supports different pricing schemes which can be set while publishing an asset. Please refer [this page](../contracts/asset-pricing.md) for more details on pricing schemes.
|
||||
This tutorial guides you through the process of creating your own data NFT and a datatoken using Ocean libraries. To know more about data NFTs and datatokens please refer [this page](../datanft-and-datatoken/). Ocean Protocol supports different pricing schemes which can be set while publishing an asset. Please refer [this page](../asset-pricing.md) for more details on pricing schemes.
|
||||
|
||||
#### Prerequisites
|
||||
|
||||
|
||||
@ -151,12 +151,209 @@ It can be called within Ocean class and returns the OCEAN Datatoken.
|
||||
|
||||
Ocean smart contracts:
|
||||
|
||||
* `ocean.data_nft_factory -> DataNFTFactoryContract`
|
||||
* `ocean.dispenser -> Dispenser` - faucets for free data
|
||||
* `ocean.fixed_rate_exchange -> FixedRateExchange` - exchanges for priced data
|
||||
<details>
|
||||
|
||||
<summary><a href="https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py#LL117C1-L120C80"><code>ocean.data_nft_factory -> DataNFTFactoryContract</code></a></summary>
|
||||
|
||||
It is a property for getting `Data NFT Factory` object for the singleton smart contract.\
|
||||
It can be called within Ocean class and returns the `DataNFTFactoryContract` instance.
|
||||
|
||||
{% code overflow="wrap" %}
|
||||
```python
|
||||
@property
|
||||
@enforce_types
|
||||
def data_nft_factory(self) -> DataNFTFactoryContract:
|
||||
return DataNFTFactoryContract(self.config, self._addr("ERC721Factory"))
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary><a href="https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py#LL122C1-L125C63"><code>ocean.dispenser -> Dispenser</code></a></summary>
|
||||
|
||||
`Dispenser` is represented by a faucet for free data.\
|
||||
It is a property for getting `Dispenser` object for the singleton smart contract.\
|
||||
It can be called within Ocean class and returns the `Dispenser` instance.
|
||||
|
||||
```python
|
||||
@property
|
||||
@enforce_types
|
||||
def dispenser(self) -> Dispenser:
|
||||
return Dispenser(self.config, self._addr("Dispenser"))
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary><a href="https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py#LL127C1-L130C72"><code>ocean.fixed_rate_exchange -> FixedRateExchange</code></a></summary>
|
||||
|
||||
Exchange is used for priced data.\
|
||||
It is a property for getting `FixedRateExchange` object for the singleton smart contract.\
|
||||
It can be called within Ocean class and returns the `FixedRateExchange` instance.
|
||||
|
||||
```python
|
||||
@property
|
||||
@enforce_types
|
||||
def fixed_rate_exchange(self) -> FixedRateExchange:
|
||||
return FixedRateExchange(self.config, self._addr("FixedPrice"))
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
Simple getters:
|
||||
|
||||
* `ocean.get_nft_token(self, token_address: str) -> DataNFT`
|
||||
* `ocean.get_datatoken(self, token_address: str) -> Datatoken`
|
||||
* `ocean.get_user_orders(self, address: str, datatoken: str)`
|
||||
<details>
|
||||
|
||||
<summary><a href="https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py#LL139C5-L145C51"><code>ocean.get_nft_token(self, token_address: str) -> DataNFT</code></a></summary>
|
||||
|
||||
It is a getter for a specific data NFT object based on its checksumed address.\
|
||||
It can be called within Ocean class with a string `token_address` as parameter which returns the `DataNFT` instance.
|
||||
|
||||
```python
|
||||
@enforce_types
|
||||
def get_nft_token(self, token_address: str) -> DataNFT:
|
||||
"""
|
||||
:param token_address: Token contract address, str
|
||||
:return: `DataNFT` instance
|
||||
"""
|
||||
return DataNFT(self.config, token_address)
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary><a href="https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py#LL147C5-L153C67"><code>ocean.get_datatoken(self, token_address: str) -> DatatokenBase</code></a></summary>
|
||||
|
||||
It is a getter for a specific `datatoken` object based on its checksumed address.\
|
||||
It can be called within Ocean class with a string `token_address` as parameter which returns the `DatatokenBase` instance depending on datatoken's template index.
|
||||
|
||||
```python
|
||||
@enforce_types
|
||||
def get_datatoken(self, token_address: str) -> DatatokenBase:
|
||||
"""
|
||||
:param token_address: Token contract address, str
|
||||
:return: `Datatoken1` or `Datatoken2` instance
|
||||
"""
|
||||
return DatatokenBase.get_typed(self.config, token_address)
|
||||
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary><a href="https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py#LL157C5-L173C23"><code>ocean.get_user_orders(self, address: str, datatoken: str)</code></a></summary>
|
||||
|
||||
Returns the list of orders that were made by a certain user on a specific datatoken.
|
||||
|
||||
As parameters:
|
||||
|
||||
1. `address` - ETH wallet address of that user
|
||||
2. `datatoken` - datatoken address
|
||||
|
||||
\
|
||||
It can be called within Ocean class.
|
||||
|
||||
{% code overflow="wrap" %}
|
||||
```python
|
||||
@enforce_types
|
||||
def get_user_orders(self, address: str, datatoken: str) -> List[AttributeDict]:
|
||||
"""
|
||||
:return: List of orders `[Order]`
|
||||
"""
|
||||
dt = DatatokenBase.get_typed(self.config_dict, datatoken)
|
||||
_orders = []
|
||||
for log in dt.get_start_order_logs(address):
|
||||
a = dict(log.args.items())
|
||||
a["amount"] = int(log.args.amount)
|
||||
a["address"] = log.address
|
||||
a["transactionHash"] = log.transactionHash
|
||||
a = AttributeDict(a.items())
|
||||
|
||||
_orders.append(a)
|
||||
|
||||
return _orders
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
Provider fees:
|
||||
|
||||
<details>
|
||||
|
||||
<summary><a href="https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py#LL177C4-L189C1"><code>ocean.retrieve_provider_fees( self, ddo: DDO, access_service: Service, publisher_wallet ) -> dict:</code></a></summary>
|
||||
|
||||
Calls Provider to compute provider fees as dictionary for access service.
|
||||
|
||||
As parameters:
|
||||
|
||||
1. `ddo` - the data asset which has the DDO object
|
||||
2. `access_service` - Service instance for the service that needs the provider fees
|
||||
3. `publisher_wallet` - Wallet instance of the user that wants to retrieve the provider fees
|
||||
|
||||
{% code overflow="wrap" %}
|
||||
```python
|
||||
@enforce_types
|
||||
def retrieve_provider_fees(
|
||||
self, ddo: DDO, access_service: Service, publisher_wallet
|
||||
) -> dict:
|
||||
|
||||
initialize_response = DataServiceProvider.initialize(
|
||||
ddo.did, access_service, consumer_address=publisher_wallet.address
|
||||
)
|
||||
initialize_data = initialize_response.json()
|
||||
provider_fees = initialize_data["providerFee"]
|
||||
|
||||
return provider_fees
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary><a href="https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py#LL190C4-L210C1"><code>ocean.retrieve_provider_fees_for_compute( self, datasets: List[ComputeInput], algorithm_data: Union[ComputeInput, AlgorithmMetadata], consumer_address: str, compute_environment: str, valid_until: int, ) -> dict:</code></a></summary>
|
||||
|
||||
Calls Provider to generate provider fees as dictionary for compute service.
|
||||
|
||||
As parameters:
|
||||
|
||||
1. `datasets` - list of `ComputeInput` which contains the data assets
|
||||
2. `algorithm_data` - necessary data for algorithm and it can be either a `ComputeInput` object, either just the algorithm metadata, `AlgorithmMetadata`
|
||||
3. `consumer_address` - address of the compute consumer wallet which is requesting the provider fees
|
||||
4. `compute_environment` - id provided from the compute environment as `string`
|
||||
5. `valid_until` - timestamp in UNIX miliseconds for the duration of provider fees for the compute service.
|
||||
|
||||
{% code overflow="wrap" %}
|
||||
```python
|
||||
@enforce_types
|
||||
def retrieve_provider_fees_for_compute(
|
||||
self,
|
||||
datasets: List[ComputeInput],
|
||||
algorithm_data: Union[ComputeInput, AlgorithmMetadata],
|
||||
consumer_address: str,
|
||||
compute_environment: str,
|
||||
valid_until: int,
|
||||
) -> dict:
|
||||
|
||||
initialize_compute_response = DataServiceProvider.initialize_compute(
|
||||
[x.as_dictionary() for x in datasets],
|
||||
algorithm_data.as_dictionary(),
|
||||
datasets[0].service.service_endpoint,
|
||||
consumer_address,
|
||||
compute_environment,
|
||||
valid_until,
|
||||
)
|
||||
|
||||
return initialize_compute_response.json()
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
</details>
|
||||
|
||||
@ -4,7 +4,7 @@ description: 'Discover the World of NFTs: Retrieving a List of Fixed-rate exchan
|
||||
|
||||
# Get fixed-rate exchanges
|
||||
|
||||
Having gained knowledge about fetching lists of data NFTs and datatokens and extracting specific information about each, let's now explore the process of retrieving the information of fixed-rate exchanges. A fixed-rate exchange refers to a mechanism where data assets can be traded at a predetermined rate or price. These exchanges offer stability and predictability in data transactions, enabling users to securely and reliably exchange data assets based on fixed rates. If you need a refresher on fixed-rate exchanges, visit the [asset pricing](../contracts/asset-pricing.md#fixed-pricing) page.
|
||||
Having gained knowledge about fetching lists of data NFTs and datatokens and extracting specific information about each, let's now explore the process of retrieving the information of fixed-rate exchanges. A fixed-rate exchange refers to a mechanism where data assets can be traded at a predetermined rate or price. These exchanges offer stability and predictability in data transactions, enabling users to securely and reliably exchange data assets based on fixed rates. If you need a refresher on fixed-rate exchanges, visit the [asset pricing](../asset-pricing.md#fixed-pricing) page.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -95,9 +95,9 @@ With the _fixed pricing_ schema, the publisher sets the price that buyers will p
|
||||
|
||||
With the _free pricing_ schema, the publisher provides an asset that is free to be downloaded by anyone.
|
||||
|
||||
For more information on the pricing models, please refer this [document](../developers/contracts/asset-pricing.md).
|
||||
For more information on the pricing models, please refer this [document](../developers/asset-pricing.md).
|
||||
|
||||
For a deep dive into the fee structure, please refer to this [document](../developers/contracts/fees.md).
|
||||
For a deep dive into the fee structure, please refer to this [document](../developers/fees.md).
|
||||
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user