mirror of
https://github.com/logos-messaging/specs.git
synced 2026-01-02 14:13:06 +00:00
fix inconsistencies
This commit is contained in:
parent
0c64eaac58
commit
82181bf2c1
@ -120,7 +120,7 @@ types:
|
|||||||
mode:
|
mode:
|
||||||
type: string
|
type: string
|
||||||
constraints: [ "edge", "relay" ]
|
constraints: [ "edge", "relay" ]
|
||||||
default: "_platform dependent_"
|
default: "relay" # "edge" for mobile and browser devices.
|
||||||
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."
|
||||||
waku_config:
|
waku_config:
|
||||||
type: WakuConfig
|
type: WakuConfig
|
||||||
@ -128,15 +128,14 @@ types:
|
|||||||
message_confirmation:
|
message_confirmation:
|
||||||
type: array<string>
|
type: array<string>
|
||||||
constraints: [ "store", "filter" ]
|
constraints: [ "store", "filter" ]
|
||||||
default: [ "none" ]
|
default: []
|
||||||
description: "Whether to apply peer-to-peer reliability strategies to confirm that outgoing message have been received by other peers."
|
description: "Whether to apply peer-to-peer reliability strategies to confirm that outgoing message have been received by other peers."
|
||||||
networking_config:
|
networking_config:
|
||||||
type: NetworkConfig
|
type: NetworkConfig
|
||||||
default: DefaultNetworkingConfig
|
default: DefaultNetworkingConfig
|
||||||
# TODO: to be reviewed, developers have expressed that accepting an object implementing specific traits is useful.
|
|
||||||
eth_rpc_endpoints:
|
eth_rpc_endpoints:
|
||||||
type: array<string>
|
type: array<string>
|
||||||
description: "Eth/Web3 RPC endpoint URLs"
|
description: "Eth/Web3 RPC endpoint URLs, required for RLN message validation. Accepting an object for ETH RPC will be added at a later stage. Fail-over available by passing multiple URLs"
|
||||||
|
|
||||||
WakuConfig:
|
WakuConfig:
|
||||||
type: object
|
type: object
|
||||||
@ -144,7 +143,7 @@ types:
|
|||||||
entry_nodes:
|
entry_nodes:
|
||||||
type: array<string>
|
type: array<string>
|
||||||
default: []
|
default: []
|
||||||
description: "Nodes to connect to; used for discovery bootstrapping and quick connectivity. entree and multiaddr formats are accepted. If not provided, node does not bootstrap to the network (local dev)."
|
description: "Nodes to connect to; used for discovery bootstrapping and quick connectivity. enrtree and multiaddr formats are accepted. If not provided, node does not bootstrap to the network (local dev)."
|
||||||
static_store_nodes:
|
static_store_nodes:
|
||||||
type: array<string>
|
type: array<string>
|
||||||
default: []
|
default: []
|
||||||
@ -162,7 +161,7 @@ types:
|
|||||||
default: DefaultMessageValidation
|
default: DefaultMessageValidation
|
||||||
|
|
||||||
NetworkingConfig:
|
NetworkingConfig:
|
||||||
type: string
|
type: object
|
||||||
fields:
|
fields:
|
||||||
listen_ipv4:
|
listen_ipv4:
|
||||||
type: string
|
type: string
|
||||||
@ -218,8 +217,8 @@ functions:
|
|||||||
createNode:
|
createNode:
|
||||||
description: "Initialise a Waku node instance"
|
description: "Initialise a Waku node instance"
|
||||||
parameters:
|
parameters:
|
||||||
- name: config
|
- name: nodeConfig
|
||||||
type: Config
|
type: NodeConfig
|
||||||
description: "The Waku node configuration."
|
description: "The Waku node configuration."
|
||||||
returns:
|
returns:
|
||||||
type: result<WakuNode, error>
|
type: result<WakuNode, error>
|
||||||
@ -233,7 +232,7 @@ values:
|
|||||||
DefaultNetworkingConfig:
|
DefaultNetworkingConfig:
|
||||||
type: NetworkConfig
|
type: NetworkConfig
|
||||||
fields:
|
fields:
|
||||||
listen_address: "0.0.0.0"
|
listen_ipv4: "0.0.0.0"
|
||||||
p2p_tcp_port: 60000
|
p2p_tcp_port: 60000
|
||||||
discv5_udp_port: 9000
|
discv5_udp_port: 9000
|
||||||
|
|
||||||
@ -246,13 +245,13 @@ values:
|
|||||||
cluster_id: 1
|
cluster_id: 1
|
||||||
auto_sharding_config:
|
auto_sharding_config:
|
||||||
fields:
|
fields:
|
||||||
numShardsInCluster: 8
|
num_shards_in_cluster: 8
|
||||||
message_validation: TheWakuNetworkMessageValidation
|
message_validation: TheWakuNetworkMessageValidation
|
||||||
|
|
||||||
TheWakuNetworkMessageValidation:
|
TheWakuNetworkMessageValidation:
|
||||||
type: MessageValidation
|
type: MessageValidation
|
||||||
fields:
|
fields:
|
||||||
max_message_bytes_uint: 153600 # 150 KiB
|
max_message_size: "150 KiB"
|
||||||
rln_config:
|
rln_config:
|
||||||
fields:
|
fields:
|
||||||
contract_address: "0xB9cd878C90E49F797B4431fBF4fb333108CB90e6"
|
contract_address: "0xB9cd878C90E49F797B4431fBF4fb333108CB90e6"
|
||||||
@ -270,12 +269,14 @@ values:
|
|||||||
DefaultMessageValidation:
|
DefaultMessageValidation:
|
||||||
type: MessageValidation
|
type: MessageValidation
|
||||||
fields:
|
fields:
|
||||||
max_message_bytes_uint: 153600 # 150 KiB
|
max_message_size: "150 KiB"
|
||||||
rln_config: none
|
rln_config: none
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Extended definitions
|
#### Extended definitions
|
||||||
|
|
||||||
|
**`mode`**:
|
||||||
|
|
||||||
If the `mode` set is `edge`, the initialised `WakuNode` MUST mount:
|
If the `mode` set is `edge`, the initialised `WakuNode` MUST mount:
|
||||||
|
|
||||||
- [LIGHTPUSH](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/19/lightpush.md) as client
|
- [LIGHTPUSH](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/19/lightpush.md) as client
|
||||||
@ -303,6 +304,14 @@ And must use mount and use the following protocols to discover peers:
|
|||||||
`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 strong hardware or bandwidth restrictions.
|
whereas `relay` SHOULD be used if node has no strong hardware or bandwidth restrictions.
|
||||||
|
|
||||||
|
**`message_confirmation`**:
|
||||||
|
|
||||||
|
As defined in [P2P-RELIABILITY](/standards/application/p2p-reliability.md).
|
||||||
|
Proceed with confirmation on whether outgoing messages were received by other nodes in the network.
|
||||||
|
|
||||||
|
- `store`: [Store-based reliability for publishing is enabled](/standards/application/p2p-reliability.md#1-store-based-reliability-for-publishing)
|
||||||
|
- `filter`: [Retransmit on possible message loss detection](/standards/application/p2p-reliability.md#4-retransmit-on-possible-message-loss-detection) by installing filter subscription(s) matching the content topic(s) used for publishing.
|
||||||
|
|
||||||
## The Validation API
|
## The Validation API
|
||||||
|
|
||||||
[WAKU2-RLN-RELAY](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md) is currently the primary message validation mechanism in place.
|
[WAKU2-RLN-RELAY](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md) is currently the primary message validation mechanism in place.
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user