logos-messaging/specs
1
0
Fork 0
mirror of https://github.com/logos-messaging/specs.git synced 2026-01-07 16:43:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

set default value

Browse Source
This commit is contained in:
fryorcraken 2025-06-24 12:43:11 +10:00
parent adaba5428b
commit d5c688a327
No known key found for this signature in database
GPG Key ID: A82ED75A8DFC50A4
1 changed files with 47 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
standards/application/waku-api.md
View File

@ -118,13 +118,25 @@ types:
Config: Config:
type: struct type: struct
fields: fields:
operating_mode: mode:
type: string type: string
constraints: ["edge", "relay"] constraints: ["edge", "relay"]
description: "The mode of operation of the Waku node. Core protocols used by the node are inferred from this mode." description: "The mode of operation of the Waku node. Core protocols used by the node are inferred from this mode."
network_config: network_config:
type: struct type: NetworkConfig
default: TheWakuNetworkPreset default: TheWakuNetworkPreset
active_relay_shards:
type: array<uint>
constraints: mode == "relay"
default: []
description: "The shards for relay to subscribe to and participate in."
store_confirmation:
type: bool
default: false
description: "No-payload store hash queries are made to confirm whether outbound messages where received by remote store node."
NetworkConfig:
type: struct
fields: fields:
boostrap_nodes: boostrap_nodes:
type: array<string> type: array<string>
@ -134,24 +146,15 @@ types:
type: array<string> type: array<string>
default: [] default: []
description: "Only the passed nodes are used for store queries, discovered store nodes are discarded." description: "Only the passed nodes are used for store queries, discovered store nodes are discarded."
clusterId: cluster_id:
type: uint type: uint
default: 1 default: 1
sharding_mode: sharding_mode:
constraints: ["auto", "static"] constraints: ["auto", "static"]
auto_sharding_config: auto_sharding_config:
type: optionAutoShardingConfig type: option<AutoShardingConfig>
default: none default: none
description: "The auto-sharding config, if sharding mode is `auto`" description: "The auto-sharding config, if sharding mode is `auto`"
active_relay_shards:
type: array<uint>
constraints: operating_mode == "relay"
default: []
description: "The shards for relay to subscribe to and participate in."
store_confirmation:
type: bool
default: false
description: "No-payload store hash queries are made to confirm whether outbound messages where received by remote store node."
AutoShardingConfig: AutoShardingConfig:
type: struct type: struct
@ -195,6 +198,24 @@ If the node is configured in `relay` mode, it MUST:
`edge` mode SHOULD be used if node functions in resource restricted environment, `edge` mode SHOULD be used if node functions in resource restricted environment,
whereas `relay` SHOULD be used if node has no hard restrictions. whereas `relay` SHOULD be used if node has no hard restrictions.
#### Default Values
```yaml
values:
TheWakuNetworkPreset:
type: NetworkConfig
fields:
bootstrap_nodes: ["enrtree://AIRVQ5DDA4FFWLRBCHJWUWOO6X6S4ZTZ5B667LQ6AJU6PEYDLRD5O@sandbox.waku.nodes.status.im"]
static_store_nodes: #TODO: enter sandbox store nodes multiaddr
cluster_id: 1
sharding_mode: "auto"
auto_sharding_config: TheWakuNetworkAutoShardingConfig
TheWakuNetworkAutoShardingConfig:
type: AutoShardingConfig
fields:
numShardsInCluster: 8
```
## Security/Privacy Considerations ## Security/Privacy Considerations
See [WAKU2-ADVERSARIAL-MODELS](https://github.com/waku-org/specs/blob/master/informational/adversarial-models.md). See [WAKU2-ADVERSARIAL-MODELS](https://github.com/waku-org/specs/blob/master/informational/adversarial-models.md).