oceanprotocol/docs
1
0
Fork 0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-26 19:49:26 +01:00
Code Releases Activity

GITBOOK-646: Added aquarius and provider diagrams

Browse Source
This commit is contained in:
Ana Loznianu 2023-07-15 09:28:36 +00:00 committed by gitbook-bot
parent e2b0fdebf6
commit bc8c8299eb
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
5 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
.gitbook/assets/aquarius.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 38 KiB

BIN
.gitbook/assets/provider.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 42 KiB

6
developers/aquarius/README.md
View File

@ -6,7 +6,11 @@ Aquarius is a tool that tracks and caches the metadata from each chain where the
The core job of Aquarius is to continually look out for new metadata being created or updated on the blockchain. Whenever such events occur, Aquarius takes note of them, processes this information, and adds it to its database. This allows it to keep an up-to-date record of the metadata activity on the chains.
Aquarius has its own interface (API) that allows you to easily query this metadata. With Aquarius, you don't need to do the time-consuming task of scanning the data chains yourself. It offers you a convenient shortcut to the information you need. It's ideal for when you need a search feature within your Dapp.
Aquarius has its own interface (API) that allows you to easily query this metadata. With Aquarius, you don't need to do the time-consuming task of scanning the data chains yourself. It offers you a convenient shortcut to the information you need. It's ideal for when you need a search feature within your dApp.
<figure><img src="../../.gitbook/assets/aquarius.png" alt=""><figcaption><p>Aquarius high level overview</p></figcaption></figure>
### What does Aquarius do?

6
developers/contracts/README.md
View File

@ -24,9 +24,7 @@ By utilizing ERC721 tokens, Ocean V4 **grants data creators greater flexibility
Publishing with V4 smart contracts in Ocean Protocol involves a well-defined process that streamlines the publishing of data assets. It provides a systematic approach to ensure efficient management and exchange of data within the Ocean Protocol ecosystem. By leveraging smart contracts, publishers can securely create and deploy data NFTs, allowing them to tokenize and represent their data assets. Additionally, the flexibility of V4 smart contracts enables publishers to define pricing schemas for datatokens, facilitating fair and transparent transactions. This publishing framework empowers data publishers by providing them with greater control and access to a global marketplace, while ensuring trust, immutability, and traceability of their published data assets.
The V4 smart contracts publishing flow can be described as follows:
The V4 smart contracts publishing includes the following steps:
1. The data publisher initiates the creation of a new data NFT.
2. The data NFT factory deploys the template for the new data NFT.
@ -42,7 +40,7 @@ The V4 smart contracts publishing flow can be described as follows:
12. The datatoken templated deploys the Datatoken-2 contract.
13. The datatoken templated creates a dispenser for the Datatoken-2 contract.
Below is a visual representation that illustrates the flow for easier understanding
Below is a visual representation that illustrates the flow:
<figure><img src="../../.gitbook/assets/publish_dataNFT_detailed_flow.png" alt=""><figcaption><p>Publishing flow</p></figcaption></figure>

10
developers/provider/README.md
View File

@ -26,6 +26,12 @@ Additionally, the Provider service offers compute services by establishing a con
* Provides compute services (connects to C2D environment)
* Typically run by the Data owner
<figure><img src="../../.gitbook/assets/provider.png" alt=""><figcaption><p>Ocean Provider - publish &#x26; consume</p></figcaption></figure>
In the publishing process, the provider plays a crucial role by encrypting the DDO using its private key. Then, the encrypted DDO is stored on the blockchain.
During the consumption flow, after a consumer obtains access to the asset by purchasing a datatoken, the provider takes responsibility for decrypting the DDO and fetching data from the source used by the data publisher.
### What technology is used?
* Python: This is the main programming language used in Provider.
@ -34,10 +40,10 @@ Additionally, the Provider service offers compute services by establishing a con
### How to run the provider?
We recommend checking the README in the Provider [GitHub repository](https://github.com/oceanprotocol/provider) for the steps to run the Provider. If you see any errors in the instructions, please open an issue within the GitHub repository.&#x20;
We recommend checking the README in the Provider [GitHub repository](https://github.com/oceanprotocol/provider) for the steps to run the Provider. If you see any errors in the instructions, please open an issue within the GitHub repository.
### Ocean Provider Endpoints Specification
The following pages in this section specify the endpoints for Ocean Provider that have been implemented by the core developers.
For inspecting the errors received from `Provider` and their reasons, please revise this [document](https://github.com/oceanprotocol/provider/blob/main/ocean_provider/routes/README.md).
For inspecting the errors received from `Provider` and their reasons, please revise this [document](https://github.com/oceanprotocol/provider/blob/main/ocean\_provider/routes/README.md).