Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

protocols/gossipsub: Allow publishing to anything that implements Into<TopicHash> #2862

Merged
merged 6 commits into from
Sep 5, 2022
Merged

protocols/gossipsub: Allow publishing to anything that implements Into<TopicHash> #2862

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
354b8bc
Less hashing
GamePad64 Aug 31, 2022
8472253
Change docstring
GamePad64 Aug 31, 2022
1dfcb93
Add changelog item.
GamePad64 Sep 1, 2022
056961d
Merge branch 'master' into gossipsub-publish-to-topichash
GamePad64 Sep 2, 2022
8839fe5
Merge branch 'master' into gossipsub-publish-to-topichash
GamePad64 Sep 3, 2022
7b98491
Merge branch 'master' into gossipsub-publish-to-topichash
GamePad64 Sep 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions protocols/gossipsub/src/behaviour.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -586,20 +586,29 @@ where
Ok(true)
}

/// Publishes a message with multiple topics to the network.
/// Publishes a message to a topic in the network.
pub fn publish<H: Hasher>(
&mut self,
topic: Topic<H>,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
topic: Topic<H>,
topic: impl Into<TopicHash>,

Would it make sense to generalise the API to this instead of duplicating the function?
This would allow you to pass either a topic or a topic hash.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @AgeManning What do you think of this API change?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this approach, as it extends the existing API without overcomplicating it. Changed this PR to match this comment and added a changelog item.

data: impl Into<Vec<u8>>,
) -> Result<MessageId, PublishError> {
self.publish_to_topichash(topic.into(), data)
}

/// Publishes a message to a topic in the network using TopicHash.
pub fn publish_to_topichash(
&mut self,
topic: TopicHash,
data: impl Into<Vec<u8>>,
) -> Result<MessageId, PublishError> {
let data = data.into();

// Transform the data before building a raw_message.
let transformed_data = self
.data_transform
.outbound_transform(&topic.hash(), data.clone())?;
.outbound_transform(&topic, data.clone())?;

let raw_message = self.build_raw_message(topic.into(), transformed_data)?;
let raw_message = self.build_raw_message(topic, transformed_data)?;

// calculate the message id from the un-transformed data
let msg_id = self.config.message_id(&GossipsubMessage {
Expand Down