From d5c688a3278ac7ab59130effb9159a8812a53d4d Mon Sep 17 00:00:00 2001 From: fryorcraken Date: Tue, 24 Jun 2025 12:43:11 +1000 Subject: [PATCH] set default value --- standards/application/waku-api.md | 73 ++++++++++++++++++++----------- 1 file changed, 47 insertions(+), 26 deletions(-) diff --git a/standards/application/waku-api.md b/standards/application/waku-api.md index c6b026a..65789cc 100644 --- a/standards/application/waku-api.md +++ b/standards/application/waku-api.md @@ -118,41 +118,44 @@ types: Config: type: struct fields: - operating_mode: + mode: type: string constraints: ["edge", "relay"] description: "The mode of operation of the Waku node. Core protocols used by the node are inferred from this mode." network_config: - type: struct + type: NetworkConfig default: TheWakuNetworkPreset - fields: - boostrap_nodes: - type: array - default: "" - description: "Bootstrap nodes, entree and multiaddr formats are accepted." - static_store_nodes: - type: array - default: [] - description: "Only the passed nodes are used for store queries, discovered store nodes are discarded." - clusterId: - type: uint - default: 1 - sharding_mode: - constraints: ["auto", "static"] - auto_sharding_config: - type: optionAutoShardingConfig - default: none - description: "The auto-sharding config, if sharding mode is `auto`" - active_relay_shards: - type: array - constraints: operating_mode == "relay" - default: [] - description: "The shards for relay to subscribe to and participate in." + active_relay_shards: + type: array + 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: + boostrap_nodes: + type: array + default: "" + description: "Bootstrap nodes, entree and multiaddr formats are accepted." + static_store_nodes: + type: array + default: [] + description: "Only the passed nodes are used for store queries, discovered store nodes are discarded." + cluster_id: + type: uint + default: 1 + sharding_mode: + constraints: ["auto", "static"] + auto_sharding_config: + type: option + default: none + description: "The auto-sharding config, if sharding mode is `auto`" + AutoShardingConfig: type: struct fields: @@ -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, 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 See [WAKU2-ADVERSARIAL-MODELS](https://github.com/waku-org/specs/blob/master/informational/adversarial-models.md).