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

Updating to say ocean nodes instead of ocean node

Browse Source
This commit is contained in:
Jamie Hewitt 2024-08-12 19:32:33 +01:00
parent b4ffd6c95a
commit 2e30e4e009
5 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
SUMMARY.md
View File

@ -25,7 +25,7 @@
* [Liquidity Pools \[deprecated\]](user-guides/remove-liquidity-pools.md) * [Liquidity Pools \[deprecated\]](user-guides/remove-liquidity-pools.md)
* [💻 Developers](developers/README.md) * [💻 Developers](developers/README.md)
* [Architecture Overview](developers/architecture.md) * [Architecture Overview](developers/architecture.md)
* [Ocean Node](developers/ocean-node/README.md) * [Ocean Nodes](developers/ocean-node/README.md)
* [Node Architecture](developers/ocean-node/node-architecture.md) * [Node Architecture](developers/ocean-node/node-architecture.md)
* [Contracts](developers/contracts/README.md) * [Contracts](developers/contracts/README.md)
* [Data NFTs](developers/contracts/data-nfts.md) * [Data NFTs](developers/contracts/data-nfts.md)

6
developers/architecture.md
View File

@ -25,13 +25,13 @@ These libraries include [Ocean.js](ocean.js), a JavaScript library, and [Ocean.p
1. [Ocean.js](ocean.js): Ocean.js is a JavaScript library that serves as a powerful tool for developers looking to integrate their applications with the Ocean Protocol ecosystem. Designed to facilitate interaction with the protocol, Ocean.js provides a comprehensive set of functionalities, including data tokenization, asset management, and smart contract interaction. Ocean.js simplifies the process of implementing data access controls, building dApps, and exploring data sets within a decentralized environment. 1. [Ocean.js](ocean.js): Ocean.js is a JavaScript library that serves as a powerful tool for developers looking to integrate their applications with the Ocean Protocol ecosystem. Designed to facilitate interaction with the protocol, Ocean.js provides a comprehensive set of functionalities, including data tokenization, asset management, and smart contract interaction. Ocean.js simplifies the process of implementing data access controls, building dApps, and exploring data sets within a decentralized environment.
2. [Ocean.py](../data-scientists/ocean.py): Ocean.py is a Python library that empowers developers to integrate their applications with the Ocean Protocol ecosystem. With its rich set of functionalities, Ocean.py provides a comprehensive toolkit for interacting with the protocol. Developers and [data scientists](../data-scientists/) can leverage Ocean.py to perform a wide range of tasks, including data tokenization, asset management, and smart contract interactions. This library serves as a bridge between Python and the decentralized world of Ocean Protocol, enabling you to harness the power of decentralized data. 2. [Ocean.py](../data-scientists/ocean.py): Ocean.py is a Python library that empowers developers to integrate their applications with the Ocean Protocol ecosystem. With its rich set of functionalities, Ocean.py provides a comprehensive toolkit for interacting with the protocol. Developers and [data scientists](../data-scientists/) can leverage Ocean.py to perform a wide range of tasks, including data tokenization, asset management, and smart contract interactions. This library serves as a bridge between Python and the decentralized world of Ocean Protocol, enabling you to harness the power of decentralized data.
#### Ocean Node #### Ocean Nodes
Ocean Node is a single component which runs all core middleware services within the Ocean stack. It replaces the roles of Aquarius, Provider and the Subgraph. It integrates the Indexer for metadata management and the Provider for secure data access. It ensures efficient and reliable interactions within the Ocean Protocol network. Ocean Node is a single component which runs all core middleware services within the Ocean stack. It replaces the roles of Aquarius, Provider and the Subgraph. It integrates the Indexer for metadata management and the Provider for secure data access. It ensures efficient and reliable interactions within the Ocean Protocol network.
Ocean Node handles network communication through libp2p, supports secure data handling, and enables flexible compute-to-data operations.  Ocean Nodes handles network communication through libp2p, supports secure data handling, and enables flexible compute-to-data operations. 
The functions of Ocean node include: The functions of Ocean nodes include:
* It is crucial in handling the asset downloads, it streams the purchased data directly to the buyer. * It is crucial in handling the asset downloads, it streams the purchased data directly to the buyer.
* It conducts the permission an access checks during the consume flow.  * It conducts the permission an access checks during the consume flow. 

14
developers/ocean-node/README.md
View File

@ -2,9 +2,9 @@
description: The new Ocean stack description: The new Ocean stack
--- ---
# Ocean Node # Ocean Nodes
Ocean Node is a vital part of the Ocean Protocol core technology stack. Ocean Node is a monorepo that replaces the three previous components: [Provider](../old-infrastructure/provider/), [Aquarius](../old-infrastructure/aquarius/) and [subgraph](../old-infrastructure/subgraph/). It has been designed to significantly simplify the process of starting the Ocean stack - it runs everything you need with one simple command. Ocean Nodes are a vital part of the Ocean Protocol core technology stack. The Ocean Nodes monorepo that replaces the three previous components: [Provider](../old-infrastructure/provider/), [Aquarius](../old-infrastructure/aquarius/) and [subgraph](../old-infrastructure/subgraph/). It has been designed to significantly simplify the process of starting the Ocean stack - it runs everything you need with one simple command.
It integrates multiple services for secure and efficient data operations, utilizing technologies like libp2p for peer-to-peer communication and multi-party computation (MPC) for secure data handling. Its modular and scalable architecture supports various use cases, from simple data retrieval to complex compute-to-data (C2D) tasks. It integrates multiple services for secure and efficient data operations, utilizing technologies like libp2p for peer-to-peer communication and multi-party computation (MPC) for secure data handling. Its modular and scalable architecture supports various use cases, from simple data retrieval to complex compute-to-data (C2D) tasks.
@ -14,7 +14,7 @@ Flexibility and extensibility are key features of Ocean Node, allowing multiple
For details on how to run a node see the [readme](https://github.com/oceanprotocol/ocean-node/) in the GitHub repository. For details on how to run a node see the [readme](https://github.com/oceanprotocol/ocean-node/) in the GitHub repository.
#### Ocean Node replaces the Provider: <a href="#what-does-the-provider-do" id="what-does-the-provider-do"></a> #### Ocean Nodes replace the Provider: <a href="#what-does-the-provider-do" id="what-does-the-provider-do"></a>
* The Node is the only component that can access your data * The Node is the only component that can access your data
* It performs checks on-chain for buyer permissions and payments * It performs checks on-chain for buyer permissions and payments
@ -24,7 +24,7 @@ For details on how to run a node see the [readme](https://github.com/oceanprotoc
* Provides compute services (connects to C2D environment) * Provides compute services (connects to C2D environment)
* Typically run by the Data owner * Typically run by the Data owner
#### Ocean Node replaces Aquarius: <a href="#what-does-aquarius-do" id="what-does-aquarius-do"></a> #### Ocean Nodes replace Aquarius: <a href="#what-does-aquarius-do" id="what-does-aquarius-do"></a>
* A new component called Indexer replaces the functionality of Aquarius. * A new component called Indexer replaces the functionality of Aquarius.
* The indexer acts as a cache for on-chain data. It stores the metadata from the smart contract events off-chain in a Typesense database. * The indexer acts as a cache for on-chain data. It stores the metadata from the smart contract events off-chain in a Typesense database.
@ -32,7 +32,7 @@ For details on how to run a node see the [readme](https://github.com/oceanprotoc
* Serves as an API: It provides a REST API that fetches data from the off-chain datastore. * Serves as an API: It provides a REST API that fetches data from the off-chain datastore.
* Offers easy query access: The API provides a convenient method to access metadata without scanning the blockchain. * Offers easy query access: The API provides a convenient method to access metadata without scanning the blockchain.
**Ocean Node replaces the Subgraph:** **Ocean Nodes replace the Subgraph:**
* Indexing the data from the smart contact events. * Indexing the data from the smart contact events.
* The data is indexed and updated in real-time.&#x20; * The data is indexed and updated in real-time.&#x20;
@ -43,13 +43,13 @@ For details on how to run a node see the [readme](https://github.com/oceanprotoc
### API ### API
For details on all of the HTTP endpoints exposed by the Ocean Node API, refer to the API.md file in the github repository. For details on all of the HTTP endpoints exposed by the Ocean Nodes API, refer to the API.md file in the github repository.
{% embed url="https://github.com/oceanprotocol/ocean-node/blob/develop/API.md" %} {% embed url="https://github.com/oceanprotocol/ocean-node/blob/develop/API.md" %}
### &#x20;Compute to Data (C2D) ### &#x20;Compute to Data (C2D)
The Ocean node provides a convenient and easy way to run a compute-to-data environment. This gives you the opportunity to monetize your node as you can charge fees for using the C2D environment and there are also additional incentives provided Ocean Protocol Foundation (OPF). Soon we will also be releasing C2D V2 which will provide different environments and new ways to pay for computation.&#x20; The Ocean nodes provide a convenient and easy way to run a compute-to-data environment. This gives you the opportunity to monetize your node as you can charge fees for using the C2D environment and there are also additional incentives provided Ocean Protocol Foundation (OPF). Soon we will also be releasing C2D V2 which will provide different environments and new ways to pay for computation.&#x20;

4
developers/ocean-node/node-architecture.md
View File

@ -1,6 +1,6 @@
# Node Architecture # Node Architecture
Ocean Node is the core infrastructure component within the Ocean Protocol ecosystem, designed to facilitate decentralized data exchange and management. It operates by leveraging a multi-layered architecture that includes network, components, and module layers.&#x20; Ocean Nodes are the core infrastructure component within the Ocean Protocol ecosystem, designed to facilitate decentralized data exchange and management. It operates by leveraging a multi-layered architecture that includes network, components, and module layers.&#x20;
Key features include secure peer-to-peer communication via libp2p, flexible and secure encryption solutions, and support for various Compute-to-Data (C2D) operations.&#x20; Key features include secure peer-to-peer communication via libp2p, flexible and secure encryption solutions, and support for various Compute-to-Data (C2D) operations.&#x20;
@ -14,7 +14,7 @@ The Node stack is divided into the following layers:
* Components layer (Indexer, Provider) * Components layer (Indexer, Provider)
* Modules layer * Modules layer
<figure><img src="../../.gitbook/assets/image (1).png" alt=""><figcaption><p>Ocean Node Infrastructure diagram</p></figcaption></figure> <figure><img src="../../.gitbook/assets/image (1).png" alt=""><figcaption><p>Ocean Nodes Infrastructure diagram</p></figcaption></figure>
### Features ### Features

2
developers/old-infrastructure/README.md
View File

@ -1,6 +1,6 @@
# Old Infrastructure # Old Infrastructure
Ocean Protocol is now using Ocean Node for all backend infrastructure. Previously we used these three components:&#x20; Ocean Protocol is now using Ocean Nodes for all backend infrastructure. Previously we used these three components:&#x20;
1. [Aquarius](aquarius/): Aquarius is a metadata cache used to enhance search efficiency by caching on-chain data into Elasticsearch. By accelerating metadata retrieval, Aquarius enables faster and more efficient data discovery. 1. [Aquarius](aquarius/): Aquarius is a metadata cache used to enhance search efficiency by caching on-chain data into Elasticsearch. By accelerating metadata retrieval, Aquarius enables faster and more efficient data discovery.
2. [Provider](provider/): The Provider component was used to facilitate various operations within the ecosystem. It assists in asset downloading, handles [DDO](../ddo-specification.md) (Decentralized Data Object) encryption, and establishes communication with the operator-service for Compute-to-Data jobs. This ensures secure and streamlined interactions between different participants. 2. [Provider](provider/): The Provider component was used to facilitate various operations within the ecosystem. It assists in asset downloading, handles [DDO](../ddo-specification.md) (Decentralized Data Object) encryption, and establishes communication with the operator-service for Compute-to-Data jobs. This ensures secure and streamlined interactions between different participants.