| .. | ||
| compute-to-data-c2d.md | ||
| node-architecture.md | ||
| README.md | ||
| description |
|---|
| The new Ocean stack |
Ocean Node
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, Aquarius and 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.
The node is structured into separate layers, including the network layer for communication, and the components layer for core services like the Indexer and Provider. This layered architecture ensures efficient data management and high security.
Flexibility and extensibility are key features of Ocean Node, allowing multiple compute engines, such as Docker and Kubernetes, to be managed within the same framework. The orchestration layer coordinates interactions between the core node and execution environments, ensuring the smooth operation of compute tasks.
For details on how to run a node see the readme in the GitHub repository.
Ocean Node replaces the Provider:
- The Node is the only component that can access your data
- It performs checks on-chain for buyer permissions and payments
- Encrypts the URL and metadata during publish
- Decrypts the URL when the dataset is downloaded or a compute job is started
- Provides access to data assets by streaming data (and never the URL)
- Provides compute services (connects to C2D environment)
- Typically run by the Data owner
Ocean Node replaces 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.
- It monitors events: It continually checks for MetadataCreated and MetadataUpdated events, processing these events and updating them in the database.
- 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.
Ocean Node replaces the Subgraph:
- Indexing the data from the smart contact events.
- The data is indexed and updated in real-time.
- Providing an API which receives and responds to queries.
- Simplifying the development experience for anyone building on Ocean.
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.
{% embed url="https://github.com/oceanprotocol/ocean-node/blob/develop/API.md" %}