mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
GITBOOK-435: change request with no subject merged in GitBook
This commit is contained in:
parent
9a743177e1
commit
ef64b26eff
Binary file not shown.
Before Width: | Height: | Size: 320 KiB |
Binary file not shown.
Before Width: | Height: | Size: 78 KiB |
Binary file not shown.
Before Width: | Height: | Size: 77 KiB |
Binary file not shown.
Before Width: | Height: | Size: 77 KiB |
Binary file not shown.
BIN
.gitbook/assets/to-the-computer.gif
Normal file
BIN
.gitbook/assets/to-the-computer.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 2.2 MiB |
@ -1,6 +1,6 @@
|
||||
---
|
||||
description: Help for wherever you are on your Ocean Protocol journey.
|
||||
cover: .gitbook/assets/cover/contribute (1) (1) (2).png
|
||||
cover: .gitbook/assets/cover/contribute (1).png
|
||||
coverY: 0
|
||||
layout: landing
|
||||
---
|
||||
|
@ -41,7 +41,7 @@
|
||||
* [Asset Pricing](developers/asset-pricing.md)
|
||||
* [Fees](developers/fees.md)
|
||||
* [Metadata](developers/contracts/metadata.md)
|
||||
* [Fractional Ownership](developers/contracts/fractional-ownership.md)
|
||||
* [Fractional Ownership](developers/datanft-and-datatoken/fractional-ownership.md)
|
||||
* [Community Monetization](developers/community-monetization.md)
|
||||
* [Identifiers & Metadata](developers/Identifiers-Metadata.md)
|
||||
* [DDO Specification](developers/ddo-specification.md)
|
||||
@ -73,7 +73,7 @@
|
||||
* [Publish](developers/ocean.js/publish.md)
|
||||
* [Mint Datatokens](developers/ocean.js/mint-datatoken.md)
|
||||
* [Update Metadata](developers/ocean.js/update-metadata.md)
|
||||
* [Remove Asset](developers/ocean.js/remove-asset.md)
|
||||
* [Asset Visibility](developers/ocean.js/remove-asset.md)
|
||||
* [CoD Asset](developers/ocean.js/cod-asset.md)
|
||||
* [Compute to data](developers/compute-to-data/README.md)
|
||||
* [Architecture](developers/compute-to-data/compute-to-data-architecture.md)
|
||||
|
@ -1,17 +1,19 @@
|
||||
---
|
||||
title: Ways to Contribute
|
||||
description: Help to improve and develop Ocean core software.
|
||||
description: Help develop Ocean Protocol software like a superhero
|
||||
cover: ../.gitbook/assets/cover/contribute.png
|
||||
coverY: 0
|
||||
---
|
||||
|
||||
# 🤝 Contribute
|
||||
|
||||
### Report a bug
|
||||
<figure><img src="../.gitbook/assets/to-the-computer.gif" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
To report a bug that isn't a vulnerability, go to the relevant GitHub repository, click on the _Issues_ tab and select _Bug report_.
|
||||
### Report a bug 🐞
|
||||
|
||||
Before reporting a bug, search existing open and closed issues and PRs to see if something has already been reported. If not, then go ahead and create a new bug report, following the structure suggested in the issue template.
|
||||
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_.
|
||||
|
||||
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! 🦸
|
||||
|
||||
### Report Vulnerabilities
|
||||
|
||||
|
@ -1,2 +1,19 @@
|
||||
# CoD Asset
|
||||
|
||||
**Overview**
|
||||
|
||||
Compute-to-Data is a powerful feature of Ocean Protocol that enables privacy-preserving data analysis and computation. With Compute-to-Data, data owners can maintain control over their data while allowing external parties to perform computations on that data. 
|
||||
|
||||
This documentation provides an overview of Compute-to-Data in Ocean Protocol and explains how to use it with Ocean.js. For detailed code examples and implementation details, please refer to the official [Ocean.js](https://github.com/oceanprotocol/ocean.js) GitHub repository.
|
||||
|
||||
**Getting Started**
|
||||
|
||||
To get started with Compute-to-Data using Ocean.js, follow these steps:
|
||||
|
||||
1. **Environment Setup**: Ensure that you have the necessary dependencies and libraries installed to work with Ocean.js. Refer to the Ocean.js documentation for detailed instructions on setting up your development environment.
|
||||
2. **Connecting to the Ocean Protocol Network**: Establish a connection to the Ocean Protocol network using Ocean.js. This connection will enable you to interact with the various components of Ocean Protocol, including Compute-to-Data.
|
||||
3. **Registering a Compute-to-Data Service**: As a data provider, you can register a Compute-to-Data service using Ocean.js. This process involves specifying the data you want to expose and defining the computation tasks that can be performed on it.
|
||||
4. **Searching and Consuming Compute-to-Data Services**: As a data consumer, you can search for Compute-to-Data services available on the Ocean Protocol network. Utilize Ocean.js to discover services based on data types, pricing, and other parameters.
|
||||
5. **Executing Computations on Data**: Once you have identified a suitable Compute-to-Data service, use Ocean.js to execute computations on the provided data. The actual computation is performed by the service provider, and the results are securely returned to you.
|
||||
|
||||
Please note that the implementation details of Compute-to-Data can vary depending on your specific use case. The code examples available in the Ocean.js GitHub repository provide comprehensive illustrations of working with Compute-to-Data in Ocean Protocol. Visit [CodeExample.md](https://github.com/oceanprotocol/ocean.js/blob/main/ComputeExamples.md) for detailed code snippets and explanations that guide you through leveraging Compute-to-Data capabilities.
|
||||
|
@ -1,2 +1,23 @@
|
||||
# Remove Asset
|
||||
# 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:
|
||||
|
||||
| State | Description | Discoverable in Ocean Market | Ordering Allowed | Listed Under Profile |
|
||||
| ----- | -------------------------------- | ---------------------------- | ---------------- | -------------------- |
|
||||
| `0` | Active | Yes | Yes | Yes |
|
||||
| `1` | End-of-life | No | No | No |
|
||||
| `2` | Deprecated (by another asset) | No | No | No |
|
||||
| `3` | Revoked by publisher | No | No | No |
|
||||
| `4` | Ordering is temporarily disabled | Yes | No | Yes |
|
||||
| `5` | Asset unlisted | No | Yes | Yes |
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
Loading…
Reference in New Issue
Block a user