Cardano Rust Ouroboros Network
This crate implements the networking layer for the Ouroboros blockchain protocol. This networking crate is undergoing active refactoring to use Tokio (see Project); meanwhile it may be reasonable to use pallas, specifically pallas-miniprotocols and pallas-multiplexer which use MSPC channels which currenlty provide more stability.
Mini-protocol Implementation Status
| Protocol Name | Implementation Status |
|---|---|
| BlockFetch | Implemented |
| ChainSync | Implemented |
| Handshake | Implemented |
| KeepAlive | Not Implemented |
| LocalStateQuery | Not Implemented |
| LocalTxMonitor | Not Implemented |
| LocalTxSubmission | Not Implemented |
| TipSample | Not Implemented |
| TxSubmission | Partially Implemented |
| TxSubmission2 | Not Implemented |
Contributing
Submit Pull Requests
This repository implements a GitHub Action to make sure that the PR name follows Conventional Commits specification. Make sure your PRs follow the referred specification to pass Continuous Integration testing.
Cardano Project Catalyst
We regularly apply for funding from individual funds of Cardano Project Catalyst, below you can see our history of applications for funding:
Closed Funding Rounds
- Fund 6 - Ouroboros Rust Networking Crate, project not funded
- 14 000 USD requested, but was over budget for Fund 6
- Fund 3 - Ouroboros Rust Networking Crate, project not funded
- 7 000 USD requested, but was over budget for Fund 3
Ouroboros Network Protocol Documenation
There are two documents which describe various levels of the networking layer of the Cardano Node Shelley implementation:
This document explains the technical requirements and key constraints for the networking layer of the Cardano Shelley implementation of Ouroboros Praos. This is a design document.
This document is a technical specification of the networking protocol. It includes serialisation formats, necessary details of multiplexer and technical specifications of mini-protocols used by either node-to-node and node-to-client flavors of the protocol.
Wireshark Plug-in
Emurgo CDDL CodeGen
Codegen serialization logic for CBOR automatically from a CDDL specification.
Instead of hand-writing CBOR code and writing tests to make sure it matches your CDDL spec, it's much faster to just generate the code from the spec! It will save time and make it easier to keep all your code in sync with any changes to your specification.
You can learn more about CDDL here.
Reference implementations
- Haskell Cardano Node Ouroboros Network Framework
- Haskell Cardano Node Ouroboros Network
Rust Sub-set of Cardano Node Ouroboros Network Protocols- CNCLI now uses this Rust crate for networking layer
- Pallas - Rust-native building blocks for the Cardano blockchain ecosystem
License
This project is licensed under:
- Mozilla Public License 2.0 (LICENSE or https://spdx.org/licenses/MPL-2.0.html)
If for some reason you need different license, please open an issue, we will evaluate your request for project-specific licensing.