feat: implement gossipsub partial messages extension by jxs · Pull Request #577 · sigp/rust-libp2p

jxs · 2025-09-16T18:47:13Z

Description

This is a draft implementation of partial messages for gossipsub following the spec PR and based on the Go implementation. Still WIP but should give a good idea of the direction we're heading.

…sipsub-partial-messages

MarcoPolo · 2025-09-16T21:33:16Z

protocols/gossipsub/src/behaviour.rs

+        {
+            // Return err if trying to publish the same partial message state we currently have.
+            if existing.available_parts() == partial_message.available_parts() {
+                return Err(PublishError::Duplicate);


I don't think this is correct.

Imagine you have parts 1,2,3.

You tell your peers about those parts.

A peer comes back and says I want part 2.

You republish with the same parts in order to respond.

You get this error and fail to respond.

thanks for explaining Marco, updated as we spoke

MarcoPolo · 2025-09-16T21:33:54Z

protocols/gossipsub/src/behaviour.rs

    data_transform: D,

+    /// Partial messages received.
+    partial_messages: HashMap<TopicHash, HashMap<Vec<u8>, P>>,


Do you need to store P here? I think it's better if P is owned solely by the application.

yup, you are right, thanks Marco!

MarcoPolo · 2025-09-16T21:35:51Z

protocols/gossipsub/src/types.rs

+pub(crate) struct PartialData {
+    pub(crate) ihave: Vec<u8>,
+    pub(crate) iwant: Vec<u8>,
+    pub(crate) message: Vec<u8>,


Is it useful to store the message here? It seems like wasted space, you only use it to check if the peer is sending you a duplicate.

Might be simpler to let the application handle dupes.

thanks Marco, I only left wanted and has wanted to avoid sending the same message and has to avoid notifying the application layer of duplicates.
Thanks!

and create a paralel list for the partial_only topics.

dknopik

Some thoughts and some nitpicks.

dknopik · 2025-10-09T14:23:08Z

protocols/gossipsub/src/types.rs

 #[derive(Debug)]
 pub enum RpcOut {
-    /// Publish a Gossipsub message on network.`timeout` limits the duration the message
+    /// PublishV a Gossipsub message on network.`timeout` limits the duration the message


Accidental change

thanks, updated!

dknopik · 2025-10-09T14:25:06Z

protocols/gossipsub/src/partial.rs

+
+    /// Returns metadata describing which parts of the message are available and which parts we want.
+    ///
+    /// This metadata is application-defined and should encode information about


Partial sentence

thanks Daniel, updated

dknopik · 2025-10-09T14:34:14Z

protocols/gossipsub/src/behaviour.rs

+    // If partial set, filter out peers who only want partial messages for the topic.
+    fn get_publish_peers(&mut self, topic_hash: &TopicHash, partial: bool) -> HashSet<PeerId> {


The fact that partial being true causes the filtering is confusing, as this is set to true on non-partial messages and vice-versa. I'd either call this filter_partial or invert the condition.

yup, agreed and updated. Thanks Daniel!

dknopik · 2025-10-09T14:44:55Z

protocols/gossipsub/src/partial.rs

+    /// - Optional remaining metadata if more parts are still available after this one
+    fn partial_message_bytes_from_metadata(
+        &self,
+        metadata: Option<impl AsRef<[u8]>>,


It is unclear to me what the expected behaviour is if metadata is None. I guess usually send everything we have to the peer?

For Ethereum this is the case where we still haven't received a peer's metadata and could maybe eager push data to them. There are, at a high level, 3 options:

Don't return anything.

Return everything (probably not what we want to do)

Return cells we didn't have locally (cells that we got from the network, not getBlobs).

dknopik · 2025-10-09T14:47:06Z

protocols/gossipsub/src/partial.rs

+    fn partial_message_bytes_from_metadata(
+        &self,
+        metadata: Option<impl AsRef<[u8]>>,
+    ) -> Result<(impl AsRef<[u8]>, Option<impl AsRef<[u8]>>), PartialMessageError>;


If I understand correctly, if we have nothing to send to the peer, we return Ok((vec![], metadata)). This seems unintuitive and potentially inefficient to me, as we have to clone metadata and publish_partial has to compare it to the previous value. Maybe change it to allow returning Ok(None) to signal this?

dknopik · 2025-10-09T14:51:25Z

protocols/gossipsub/src/behaviour.rs

-                    timeout: Delay::new(self.config.publish_queue_duration()),
+                RpcOut::PartialMessage {
+                    message: message_data,
+                    metadata: partial_message.parts_metadata().as_ref().to_vec(),


Maybe get partial_message.parts_metadata() before the loop to avoid useless re-encoding (in case the implementation encodes ad-hoc)?

yeah nice catch, before each peer had its own metadata so this was not possible. Updated!

dknopik · 2025-10-09T15:16:34Z

protocols/gossipsub/src/partial.rs

+    ///
+    /// Returns `Ok(())` if the data was successfully integrated, or `Err`,
+    /// if the data was invalid or couldn't be processed.
+    fn extend_from_encoded_partial_message(


This is unused as far as I can tell. Yes, something like this is likely needed by the application, but as the behaviour does not need to access this, we can leave the exact interface up to the application (as maybe some external info is needed to extend the partial message).

yup, good point. Removed it

…d before

Signed-off-by: Marco Munizaga <git@marcopolo.io>

Improve gossipsub behavior tests structure. Split the already big enough file into multiple test files according to their `Behaviour` tests category. Document the shared test primitives and rename structures, `InjectNodes` to `BehaviourTestBuilder` and remove the `inject_nodes` functions to use `Default`. This will help with the new tests for partial messages on sigp#577 which will be eventually moved here Pull-Request: #6232.

To help with the upcoming [partial messages](sigp#577) Pull-Request: #6234.

improve transient peers gathering missing code removal

supports partials we were gathering the opposite

to only use one topic field per sent messages and peer partials

… gossip

… DEFAULT

…ation layer new changes if we didn't have anything to send to the peer

jxs added 8 commits September 9, 2025 10:48

feat(gossipsub): implement gossipsub 1.3

6313068

implement test extesion

53cc7e8

Add PartialMessage trait implementation

4249ccb

implement sending and receiving partial messages at te protocol level

9aa7ead

add partial_publish method

bc45d3e

update trait extend method to receive slice instead

8b1c086

implement Partial message handling and publishing at the behaviour level

b1b8dbe

Merge branch 'sigp-gossipsub' of github.com:sigp/rust-libp2p into gos…

e7250f5

…sipsub-partial-messages

MarcoPolo reviewed Sep 16, 2025

View reviewed changes

address Marco's review

6370514

jxs force-pushed the gossipsub-partial-messages branch 5 times, most recently from cb0e925 to e6f1ae4 Compare September 26, 2025 11:35

jxs added 3 commits September 26, 2025 15:23

feature gate partial messages

909a68f

remove PartialIDONWANT from proto to follow spec

046ad47

update trait return types and remove non used impl

69c2d95

jxs force-pushed the gossipsub-partial-messages branch from e6f1ae4 to 69c2d95 Compare September 26, 2025 14:24

jxs added 10 commits September 26, 2025 15:29

fixup! feature gate partial messages

45c2bc1

update to spec changes

85b92f3

update extension message priority to highest

b6478d5

add missing proto field SubOpts partial

5e98f1a

implement subscription options partial

f77490c

publish only full messages to partial false peers

1bfbc55

revert to only using TopicHash,

33783bd

and create a paralel list for the partial_only topics.

add partial option to subscribe and unsubscribe methods

438a297

polish PR

6cb5244

push publish method above for smaller diff

bc3d7ba

dknopik reviewed Oct 9, 2025

View reviewed changes

dknopik added 2 commits December 12, 2025 14:11

fix never sending any partial message unless another has been receive…

62a9fc4

…d before

do not return early in handle_partial_messsage if it pushes data

7751293

jxs mentioned this pull request Dec 16, 2025

chore(gossipsub): improve test structure libp2p/rust-libp2p#6232

Merged

update partial message codepoints

5673256

Signed-off-by: Marco Munizaga <git@marcopolo.io>

jxs force-pushed the gossipsub-partial-messages branch from 33d825a to 5673256 Compare December 17, 2025 17:09

jxs mentioned this pull request Dec 18, 2025

feat(gossipsub): log when sending and receiving gossipsub messages libp2p/rust-libp2p#6234

Merged

mergify bot pushed a commit to libp2p/rust-libp2p that referenced this pull request Dec 19, 2025

feat(gossipsub): log when sending and receiving gossipsub messages

646fd16

To help with the upcoming [partial messages](sigp#577) Pull-Request: #6234.

jxs added 4 commits January 12, 2026 12:55

merge master

6fc2b06

refactor partial messages internals

4a01d9c

fix tests

1b441ff

fix re-publishing of PartialAction

655bcb6

jxs force-pushed the gossipsub-partial-messages branch from 004f101 to 655bcb6 Compare January 15, 2026 11:06

jxs added 8 commits January 15, 2026 11:27

improve imports and rename PartialMessagesError to PartialError

6cf8139

more improvements

278c153

update Partial api

922e5c2

do not parse partial messages by penalized peers

8f03b0b

add updated metrics

c3e6c83

namespace partial_messages types re-exports

911f9d9

Add missing transient peers when publishing

e2bcf85

improve transient peers gathering missing code removal

fix bug where for partial messages instead of gathering the nodes that

bd02db8

supports partials we were gathering the opposite

jxs force-pushed the gossipsub-partial-messages branch from d9e634e to bd02db8 Compare January 21, 2026 13:46

jxs added 2 commits January 27, 2026 11:39

refactor partial_messages module,

d136bd2

to only use one topic field per sent messages and peer partials

update rand to 0.9

5e69df8

jxs force-pushed the gossipsub-partial-messages branch from 9a49c46 to 350a697 Compare January 28, 2026 13:37

implement gossip during partial messages heartbeat

7a86d8b

jxs force-pushed the gossipsub-partial-messages branch from 350a697 to 7a86d8b Compare January 28, 2026 13:57

jxs added 3 commits February 3, 2026 14:37

add gossip-lazy and gossip factor calculations into partial heartbeat…

3aeefa1

… gossip

set max number of metadata messages per peer during gossip, TODO: SET…

b515b4c

… DEFAULT

add first tests and fix bug where we were not returning to the applic…

f5da15b

…ation layer new changes if we didn't have anything to send to the peer

		// If partial set, filter out peers who only want partial messages for the topic.
		fn get_publish_peers(&mut self, topic_hash: &TopicHash, partial: bool) -> HashSet<PeerId> {

Conversation

jxs commented Sep 16, 2025

Description

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dknopik left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dknopik Oct 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

dknopik Oct 9, 2025 •

edited

Loading