logos-messaging/specs
1
0
Fork 0
mirror of https://github.com/logos-messaging/specs.git synced 2026-01-03 22:53:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

add shardsUnderCluster prop

Browse Source
This commit is contained in:
Sasha 2025-04-04 20:03:05 +02:00
parent cd55755ffc
commit cb446bd873
No known key found for this signature in database
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
standards/application/messaging-api.md
View File

@ -76,6 +76,7 @@ focusing exclusively on settings explicitly required by the `Messaging API`.
mode: "edge" | "relay"; mode: "edge" | "relay";
clusterId: number; clusterId: number;
shards: number[]; shards: number[];
shardsUnderCluster?: number;
storeNodes?: string[]; storeNodes?: string[];
preferredServiceNodes?: string[]; preferredServiceNodes?: string[];
bootstrapNodes: string[]; bootstrapNodes: string[];
@ -112,6 +113,12 @@ It signifies which cluster a node MUST be operating at as per [RELAY-SHARDING](h
This property MUST be provided. This property MUST be provided.
An array of shard under a specified cluster that node MUST operate at as per [RELAY-SHARDING](https://github.com/waku-org/specs/blob/186ce335667bdfdb6b2ce69ad7b2a3a3791b1ba6/standards/core/relay-sharding.md). An array of shard under a specified cluster that node MUST operate at as per [RELAY-SHARDING](https://github.com/waku-org/specs/blob/186ce335667bdfdb6b2ce69ad7b2a3a3791b1ba6/standards/core/relay-sharding.md).
##### `shardsUnderCluster`
This is an optional property that MUST be a positive integer.
If not provided, it defaults to 8.
This property is used to automatically map a provided `contentTopic` to the appropriate `shards` under the specified `clusterId`.
For further details, refer to the [RELAY-SHARDING](https://github.com/waku-org/specs/blob/master/standards/core/relay-sharding.md#content-topics-format-for-autosharding) specification.
##### `storeNodes` ##### `storeNodes`
A list of `Multiaddr` addresses to remote peers that MUST be used for retrieving past messages or performing infrequent queries using the [STORE](https://github.com/vacp2p/rfc-index/blob/8ee2a6d6b232838d83374c35e2413f84436ecf64/waku/standards/core/13/store.md) protocol. A list of `Multiaddr` addresses to remote peers that MUST be used for retrieving past messages or performing infrequent queries using the [STORE](https://github.com/vacp2p/rfc-index/blob/8ee2a6d6b232838d83374c35e2413f84436ecf64/waku/standards/core/13/store.md) protocol.
If not provided, the implementation SHOULD utilize either `preferredServiceNodes` or nodes discovered via the network. If not provided, the implementation SHOULD utilize either `preferredServiceNodes` or nodes discovered via the network.