feat!: deprecate named pubsub topics and use static/auto sharding #2097
Conversation
This file contains 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
simplify network config type, all protocols use pubsub topic internally
danisharora099
changed the title
size-limit report 📦
|
danisharora099
changed the title
danisharora099
changed the title
adklempner
approved these changes
Aug 12, 2024
| @@ -45,7 +41,9 @@ class Metadata extends BaseProtocol implements IMetadata { | |||
| * Make a metadata query to a peer | |||
| */ | |||
| public async query(peerId: PeerId): Promise<MetadataQueryResult> { | |||
| const request = proto_metadata.WakuMetadataRequest.encode(this.shardInfo); | |||
| const request = proto_metadata.WakuMetadataRequest.encode( | |||
| pubsubTopicsToShardInfo(this.pubsubTopics) | |||
There was a problem hiding this comment.
nit: if this.pubsubTopics is not expected to change, then we can probably just create the shard info during construction and store it as another class variable
There was a problem hiding this comment.
i like where you're coming from; however apart from this place, shard info is not passed anywhere else so why introduce another variable? 🤔
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Problem
To configure pubsub topics on a Waku node, there have been three ways:
Based on #1690, we want to deprecate support for named pubsub topics, and only allow configuration using Static Sharding and Auto Sharding.
Solution
NetworkConfig: StaticSharding | AutoShardingNetworkConfigto The Waku Network:clusterId: 1, shards: [0,1,2,3,4,5,6,7]Notes
ApplicationInfoas a type, and only relies onContentTopicInfoandShardInfoApplicationInfoshould be specified as astringto be used as a param inNetworkConfigContentTopicInfoandShardInfoare also represented asAutoShardingandStaticShardingrespectivelyNetworkConfigis only used as a type for consumer-facing API,NetworkConfigis thus translated into relevant pubsub topics, based on the type, and thereafter used as astring[]representing pubsub topics throughout the codebase as planned.Contribution checklist:
!in title if breaks public API;