feat: enhance OptimumP2P documentation - #17
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
hpsing
reviewed
Jul 29, 2025
|
|
||
| The data flow diagram illustrates how OptimumP2P integrates with blockchain infrastructure to provide enhanced data propagation. The system operates through three main components: the Validator Node, the Optimum Service, and the Networks layer. | ||
|
|
||
| At the **Validator Node** level, the Optimum Agent interfaces directly with the blockchain client through IPC (Inter-Process Communication). Transaction data flows from the blockchain client to the Optimum Agent, which serves as the bridge between the blockchain infrastructure and the OptimumP2P network. |
hpsing
reviewed
Jul 29, 2025
|
|
||
| At the **Validator Node** level, the Optimum Agent interfaces directly with the blockchain client through IPC (Inter-Process Communication). Transaction data flows from the blockchain client to the Optimum Agent, which serves as the bridge between the blockchain infrastructure and the OptimumP2P network. | ||
|
|
||
| The **Optimum Service** acts as the central processing unit where the core RLNC encoding and network coordination takes place. When transaction data arrives from the Optimum Agent, the service applies Random Linear Network Coding to create redundant, encoded shards that can be efficiently propagated across the network. |
hpsing
reviewed
Jul 29, 2025
|
|
||
| ## Security Model | ||
|
|
||
| OptimumP2P implements a comprehensive security model to protect against various attack vectors. The system uses Boneh-Lynn-Shacham (BLS) signatures to provide authentication and non-repudiation for all network communications. Cryptographic hashing ensures data integrity throughout the network, while distributed key management with on-chain registration and verification provides secure identity management. |
hpsing
reviewed
Jul 30, 2025
Comment on lines
16
to
21
| OptimumP2P addresses these limitations through RLNC, a technique that enables optimal data propagation in distributed networks. Instead of forwarding entire messages, nodes transmit smaller, coded pieces (shards) of the original data. | ||
|
|
||
| <div class="theme-aware-image"> | ||
| <img src="/static/img/P2P_data_flow_light.png" alt="OptimumP2P Data Flow" class="light-mode-only"> | ||
| <img src="/static/img/P2P_data_flow_dark.png" alt="OptimumP2P Data Flow" class="dark-mode-only"> | ||
| </div> |
hpsing
reviewed
Jul 30, 2025
|
|
||
| The data flow diagram illustrates how OptimumP2P integrates with blockchain infrastructure to provide enhanced data propagation. The system operates through three main components: the Validator Node, the Optimum Service, and the Networks layer. | ||
| The data flow involves three main components: | ||
| 1. **Validator Node Integration**: OptimumP2P interfaces directly with a blockchain client to access data, such as newly produced blocks or transactions. |
hpsing
reviewed
Jul 31, 2025
|
|
||
| * High latency: Peers must receive full messages before forwarding. | ||
| * Bandwidth waste: Peers may receive multiple redundant copies of the same message. | ||
| OptimumP2P is implemented as a P2P node that can run either the traditional [GossipSub](https://github.com/libp2p/specs/tree/master/pubsub/gossipsub) protocol or the enhanced OptimumP2P protocol with RLNC. The node maintains: |
Member
There was a problem hiding this comment.
right now, because of the sidecar we have added that has given the option to run either of the algorithms (gossipsub or optimump2p)
hpsing
reviewed
Jul 31, 2025
|
|
||
| ## RLNC and OptimumP2P | ||
| * **[libp2p](https://docs.libp2p.io/) Host**: The underlying network layer for peer connections | ||
| * **Protocol Selection**: Can run [GossipSub](https://github.com/libp2p/specs/tree/master/pubsub/gossipsub), OptimumP2P, or both protocols simultaneously |
Member
There was a problem hiding this comment.
no protocol selection, it's a sidecar feature, which is a temporary
hpsing
reviewed
Jul 31, 2025
| 1. **Message Preparation**: The original message is prepared for coding by adding length prefixes and padding if necessary | ||
| 2. **RLNC Encoding**: The message is divided into `k` fragments and encoded using RLNC into multiple shards using configurable parameters: | ||
| * `ShredFactor`: Controls how the data is fragmented | ||
| * `PublisherShardMultiplier`: Determines how many shards to create initially |
Member
There was a problem hiding this comment.
Add a section about the parameters and cite here as a ref.
hpsing
reviewed
Jul 31, 2025
Comment on lines
+64
to
+70
| ## Beyond Just Validators: Ecosystem-Wide Benefits | ||
|
|
||
| OptimumP2P serves as a foundational, general-purpose data propagation protocol with benefits extending across various blockchain use cases. | ||
|
|
||
|  | ||
|
|
||
| The diagram above shows an example sidecar integration pattern where OptimumP2P runs alongside existing consensus layer clients. This allows validators to benefit from enhanced data propagation without modifying their core consensus software. |
Member
There was a problem hiding this comment.
Let's not use it here; it may create confusion
hpsing
reviewed
Jul 31, 2025
| * Improves experience for multiplayer, onchain games and social dApps | ||
| * Reduces costs of redundant relay infra through efficient data spreading | ||
|
|
||
| ## Security Model |
Member
There was a problem hiding this comment.
Discuss with @kishori82 about discussing or mentioning RUGBY protocol here
hpsing
reviewed
Jul 31, 2025
| * **GRAFT/PRUNE**: Manages mesh topology similar to [GossipSub](https://github.com/libp2p/specs/tree/master/pubsub/gossipsub) | ||
|
|
||
| ## Beyond Just Validators: Ecosystem-Wide Benefits | ||
| ## Configuration Parameters |
Member
There was a problem hiding this comment.
We can improve it more; let's add it as an issue and address it later with hackathon docs.
hpsing
reviewed
Jul 31, 2025
|
|
||
| These parameters can be adjusted based on network conditions, bandwidth constraints, and latency requirements to optimize OptimumP2P performance for specific use cases. | ||
|
|
||
| ## Beyond Just Validators: Ecosystem-Wide Benefits |
Member
There was a problem hiding this comment.
Beyond Just Validators looks confusing, let's not use it, let's add it as one 1of the use cases.
hpsing
approved these changes
Jul 31, 2025
hpsing
left a comment
hpsing
left a comment
Member
There was a problem hiding this comment.
couple of comments else LGTM! good job 🥇 . get a final review from @kishori82
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.