feat: set cluster ID as optional when specifying shard info #1780
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
size-limit report 📦
|
weboko
approved these changes
Jan 11, 2024
adklempner
force-pushed
the
adklempner/default-cluster-id
branch
from
0957c59 to
e5f0cf4
Compare
packages/interfaces/src/message.ts
Outdated
| @@ -1,7 +1,7 @@ | |||
| import type { PubsubTopic } from "./misc.js"; | |||
|
|
|||
| export interface SingleShardInfo { | |||
| clusterId: number; | |||
| clusterId?: number; | |||
There was a problem hiding this comment.
instead of making this optional, i'd rather use DEFAULT_CLUSTER_ID that refers to 1 for TWN.
There was a problem hiding this comment.
let's do this a followup PR @adklempner
There was a problem hiding this comment.
@danisharora099 I made an update in my latest commit that makes all the fields required and instead uses Partial<ShardingParams> in all SDK create node functions, which are converted to regular ShardingParams before being used internally
adklempner
force-pushed
the
adklempner/default-cluster-id
branch
6 times, most recently
from
8286264 to
c548c42
Compare
danisharora099
approved these changes
Jan 24, 2024
adklempner
force-pushed
the
adklempner/default-cluster-id
branch
from
c548c42 to
68d3229
Compare
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 setup a node for autosharding, a user needs to explicitly specify both content topics and a cluster id to determine the pubsub topics. According to the RFC, the Waku Network always uses a cluster id of 1.
Solution
Makes
clusterId(and all other fields inShardingParams) optional when user creates a node using the sdk functions, by acceptingPartial<ShardingParams>.Each sdk function calls a sharding util function to validated the parameters and replace any missing ones with defaults where possible.
Internally, we mostly use
ShardingParamswhere all fields are required.Notes