From 7cc5f138052a716b5c29685d66787044190bc0af Mon Sep 17 00:00:00 2001 From: Ana Loznianu Date: Tue, 18 Jul 2023 13:32:00 +0300 Subject: [PATCH 1/2] 1228 - Update end-of-life state & cleanup --- SUMMARY.md | 2 +- developers/ddo-specification.md | 11 ++++++++++- .../{remove-asset.md => asset-visibility.md} | 13 +------------ 3 files changed, 12 insertions(+), 14 deletions(-) rename developers/ocean.js/{remove-asset.md => asset-visibility.md} (57%) diff --git a/SUMMARY.md b/SUMMARY.md index 229486e0..398cc588 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -84,7 +84,7 @@ * [Publish](developers/ocean.js/publish.md) * [Mint Datatokens](developers/ocean.js/mint-datatoken.md) * [Update Metadata](developers/ocean.js/update-metadata.md) - * [Asset Visibility](developers/ocean.js/remove-asset.md) + * [Asset Visibility](developers/ocean.js/asset-visibility.md) * [Consume Asset](developers/ocean.js/consume-asset.md) * [Run C2D Jobs](developers/ocean.js/cod-asset.md) * [Compute to data](developers/compute-to-data/README.md) diff --git a/developers/ddo-specification.md b/developers/ddo-specification.md index ac5417e5..63aab321 100644 --- a/developers/ddo-specification.md +++ b/developers/ddo-specification.md @@ -342,7 +342,16 @@ _Aquarius_ should always verify the checksum after data is decrypted via a _Prov Each asset has a state, which is held by the NFT contract. The possible states are: -
StateDescriptionDiscoverable in Ocean MarketOrdering allowedListed under profile
0ActiveYesYesYes
1End-of-lifeNoNoNo
2Deprecated (by another asset)NoNoNo
3Revoked by publisherNoNoNo
4Ordering is temporary disabledYesNoYes
5Asset unlisted.NoYesYes
+
StateDescriptionDiscoverable in Ocean MarketOrdering allowedListed under profile
0ActiveYesYesYes
1End-of-lifeYesNoNo
2Deprecated (by another asset)NoNoNo
3Revoked by publisherNoNoNo
4Ordering is temporary disabledYesNoYes
5Asset unlisted.NoYesYes
+ +States details: + +1. **Active**: Assets in the "Active" state are fully functional and available for discovery in Ocean Market, and other components. Users can search for, view, and interact with these assets. Ordering is allowed, which means users can place orders to purchase or access the asset's services. +2. **End-of-life**: Assets in the "End-of-life" state are no longer discoverable. They are typically deprecated or outdated and are no longer actively promoted or maintained. Users cannot place orders or interact with these assets, and they are not listed under the owner's profile. +3. **Deprecated (by another asset)**: This state indicates that another asset has deprecated the current asset. Deprecated assets are not discoverable, and ordering is not allowed. Similar to the "End-of-life" state, deprecated assets are not listed under the owner's profile. +4. **Revoked by publisher**: When an asset is revoked by its publisher, it means that the publisher has explicitly revoked access or ownership rights to the asset. Revoked assets are not discoverable, and ordering is not allowed. +5. **Ordering is temporarily disabled**: Assets in this state are still discoverable, but ordering functionality is temporarily disabled. Users can view the asset and gather information, but they cannot place orders at that moment. However, these assets are still listed under the owner's profile. +6. **Asset unlisted**: Assets in the "Asset unlisted" state are not discoverable. However, users can still place orders for these assets, making them accessible. Unlisted assets are listed under the owner's profile, allowing users to view and access them. ### Aquarius Enhanced DDO Response diff --git a/developers/ocean.js/remove-asset.md b/developers/ocean.js/asset-visibility.md similarity index 57% rename from developers/ocean.js/remove-asset.md rename to developers/ocean.js/asset-visibility.md index 73e052ae..9ab0a1bd 100644 --- a/developers/ocean.js/remove-asset.md +++ b/developers/ocean.js/asset-visibility.md @@ -1,17 +1,6 @@ # Asset Visibility -In the Ocean Protocol ecosystem, each asset is associated with a state that is maintained by the NFT (Non-Fungible Token) contract. The [state of an asset](../ddo-specification.md#state) determines its visibility and availability for different actions on platforms like Ocean Market, as well as its appearance in user profiles. The following table outlines the possible states and their characteristics: - -
StateDescriptionDiscoverable in Ocean MarketOrdering AllowedListed Under Profile
0ActiveYesYesYes
1End-of-lifeNoNoNo
2Deprecated (by another asset)NoNoNo
3Revoked by publisherNoNoNo
4Ordering is temporarily disabledYesNoYes
5Asset unlistedNoYesYes
- -Now let's explain each state in more detail: - -1. **Active**: Assets in the "Active" state are fully functional and available for discovery in Ocean Market, and other components. Users can search for, view, and interact with these assets. Ordering is allowed, which means users can place orders to purchase or access the asset's services. -2. **End-of-life**: Assets in the "End-of-life" state are no longer discoverable. They are typically deprecated or outdated and are no longer actively promoted or maintained. Users cannot place orders or interact with these assets, and they are not listed under the owner's profile. -3. **Deprecated (by another asset)**: This state indicates that another asset has deprecated the current asset. Deprecated assets are not discoverable, and ordering is not allowed. Similar to the "End-of-life" state, deprecated assets are not listed under the owner's profile. -4. **Revoked by publisher**: When an asset is revoked by its publisher, it means that the publisher has explicitly revoked access or ownership rights to the asset. Revoked assets are not discoverable, and ordering is not allowed. -5. **Ordering is temporarily disabled**: Assets in this state are still discoverable, but ordering functionality is temporarily disabled. Users can view the asset and gather information, but they cannot place orders at that moment. However, these assets are still listed under the owner's profile. -6. **Asset unlisted**: Assets in the "Asset unlisted" state are not discoverable. However, users can still place orders for these assets, making them accessible. Unlisted assets are listed under the owner's profile, allowing users to view and access them. +In the Ocean Protocol ecosystem, each asset is associated with a state that is maintained by the NFT (Non-Fungible Token) contract. The [state of an asset](../ddo-specification.md#state) determines its visibility and availability for different actions on platforms like Ocean Market, as well as its appearance in user profiles. To explore the various asset's state in detail, please check out the [DDO Specification](../ddo-specification.md#state) page. It provides comprehensive information about the different states that assets can be in. By assigning specific states to assets, Ocean Protocol enables a structured approach to asset management and visibility. These states help regulate asset discoverability, ordering permissions, and the representation of assets in user profiles, ensuring a controlled and reliable asset ecosystem. From 9731aa9c9ffcd529552bcf2b0c956f0233f8447b Mon Sep 17 00:00:00 2001 From: Ana Loznianu Date: Tue, 18 Jul 2023 13:34:38 +0300 Subject: [PATCH 2/2] Updated end of life state --- developers/ddo-specification.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/developers/ddo-specification.md b/developers/ddo-specification.md index 63aab321..ee758514 100644 --- a/developers/ddo-specification.md +++ b/developers/ddo-specification.md @@ -347,7 +347,7 @@ Each asset has a state, which is held by the NFT contract. The possible states a States details: 1. **Active**: Assets in the "Active" state are fully functional and available for discovery in Ocean Market, and other components. Users can search for, view, and interact with these assets. Ordering is allowed, which means users can place orders to purchase or access the asset's services. -2. **End-of-life**: Assets in the "End-of-life" state are no longer discoverable. They are typically deprecated or outdated and are no longer actively promoted or maintained. Users cannot place orders or interact with these assets, and they are not listed under the owner's profile. +2. **End-of-life**: Assets in the "End-of-life" state remain discoverable but cannot be ordered. This state indicates that the assets are usually deprecated or outdated, and they are no longer actively promoted or maintained. 3. **Deprecated (by another asset)**: This state indicates that another asset has deprecated the current asset. Deprecated assets are not discoverable, and ordering is not allowed. Similar to the "End-of-life" state, deprecated assets are not listed under the owner's profile. 4. **Revoked by publisher**: When an asset is revoked by its publisher, it means that the publisher has explicitly revoked access or ownership rights to the asset. Revoked assets are not discoverable, and ordering is not allowed. 5. **Ordering is temporarily disabled**: Assets in this state are still discoverable, but ordering functionality is temporarily disabled. Users can view the asset and gather information, but they cannot place orders at that moment. However, these assets are still listed under the owner's profile.