waku-org
/
docs.waku.org
mirror of https://github.com/waku-org/docs.waku.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

remove JSON-RPC configuration (#186)

This commit is contained in:
LordGhostX 2024-03-20 14:56:30 +01:00 committed by GitHub
parent 6879a4665b
commit fd5979fa4c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 114 additions and 126 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/guides/nwaku/config-methods.md
View File

@ -86,7 +86,6 @@ The default configuration is used when no other options are specified. By defaul
- Generate a new `Node Key` and `PeerID`. - Generate a new `Node Key` and `PeerID`.
- Listen for incoming libp2p connections on the default TCP port (`60000`). - Listen for incoming libp2p connections on the default TCP port (`60000`).
- Subscribe to the default Pub/Sub topic (`/waku/2/default-waku/proto`). - Subscribe to the default Pub/Sub topic (`/waku/2/default-waku/proto`).
- Start the `JSON-RPC` server on the default port (`8545`).
- Enable the `Relay` protocol for relaying messages. - Enable the `Relay` protocol for relaying messages.
- Enable the `Store` protocol as a client, allowing it to query peers for historical messages but not store any message itself. - Enable the `Store` protocol as a client, allowing it to query peers for historical messages but not store any message itself.

38
docs/guides/nwaku/config-options.md
View File

@ -8,21 +8,21 @@ Here are the available node configuration options, along with their default valu
## Application-level config ## Application-level config
| Name | Default Value | Description | | Name | Default Value | Description |
| - | - | - | | ----------------- | --------------------------- | --------------------------------------------------------------------------------------------------- |
| `config-file` | | Loads configuration from a TOML file (cmd-line parameters take precedence) | | `config-file` | | Loads configuration from a TOML file (cmd-line parameters take precedence) |
| `protected-topic` | `newSeq[ProtectedTopic](0)` | Topics and its public key to be used for message validation, topic:pubkey. Argument may be repeated | | `protected-topic` | `newSeq[ProtectedTopic](0)` | Topics and its public key to be used for message validation, topic:pubkey. Argument may be repeated |
## Log config ## Log config
| Name | Default Value | Description | | Name | Default Value | Description |
| - | - | - | | ------------ | ------------------------ | -------------------------------------------------------------------------------------------------- |
| `log-level` | `logging.LogLevel.INFO` | Sets the log level for process. Supported levels: TRACE, DEBUG, INFO, NOTICE, WARN, ERROR or FATAL | | `log-level` | `logging.LogLevel.INFO` | Sets the log level for process. Supported levels: TRACE, DEBUG, INFO, NOTICE, WARN, ERROR or FATAL |
| `log-format` | `logging.LogFormat.TEXT` | Specifies what kind of logs should be written to stdout. Supported formats: TEXT, JSON | | `log-format` | `logging.LogFormat.TEXT` | Specifies what kind of logs should be written to stdout. Supported formats: TEXT, JSON |
## General node config ## General node config
| Name | Default Value | Description | | Name | Default Value | Description |
| - | - | - | | --------------------- | ------------------------ | ------------------------------------------------------------------------------------------------------- |
| `cluster-id` | `0` | Cluster id that the node is running in. Node in a different cluster id is disconnected | | `cluster-id` | `0` | Cluster id that the node is running in. Node in a different cluster id is disconnected |
| `agent-string` | `nwaku` | Node agent string which is used as identifier in network | | `agent-string` | `nwaku` | Node agent string which is used as identifier in network |
| `nodekey` | | P2P node private key as 64-char hex string | | `nodekey` | | P2P node private key as 64-char hex string |
@ -40,7 +40,7 @@ Here are the available node configuration options, along with their default valu
## DNS addrs config ## DNS addrs config
| Name | Default Value | Description | | Name | Default Value | Description |
| - | - | - | | ----------------------- | ------------------------ | ------------------------------------------------------------------------------------ |
| `dns-addrs` | `true` | Enable resolution of `dnsaddr`, `dns4` or `dns6` multiaddrs | | `dns-addrs` | `true` | Enable resolution of `dnsaddr`, `dns4` or `dns6` multiaddrs |
| `dns-addrs-name-server` | `["1.1.1.1", "1.0.0.1"]` | DNS name server IPs to query for DNS multiaddrs resolution. Argument may be repeated | | `dns-addrs-name-server` | `["1.1.1.1", "1.0.0.1"]` | DNS name server IPs to query for DNS multiaddrs resolution. Argument may be repeated |
| `dns4-domain-name` | | The domain name resolving to the node's public IPv4 address | | `dns4-domain-name` | | The domain name resolving to the node's public IPv4 address |
@ -48,7 +48,7 @@ Here are the available node configuration options, along with their default valu
## Relay config ## Relay config
| Name | Default Value | Description | | Name | Default Value | Description |
| - | - | - | | -------------------------------- | ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `relay` | `true` | Enable relay protocol: true\|false | | `relay` | `true` | Enable relay protocol: true\|false |
| `relay-peer-exchange` | `false` | Enable gossipsub peer exchange in relay protocol: true\|false | | `relay-peer-exchange` | `false` | Enable gossipsub peer exchange in relay protocol: true\|false |
| `rln-relay` | `false` | Enable spam protection through rln-relay: true\|false | | `rln-relay` | `false` | Enable spam protection through rln-relay: true\|false |
@ -73,7 +73,7 @@ Here are the available node configuration options, along with their default valu
## Store and message store config ## Store and message store config
| Name | Default Value | Description | | Name | Default Value | Description |
| - | - | - | | -------------------------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `store` | `false` | Enable/disable waku store protocol | | `store` | `false` | Enable/disable waku store protocol |
| `storenode` | | Peer multiaddress to query for storage | | `storenode` | | Peer multiaddress to query for storage |
| `store-message-retention-policy` | `time:172800` | Message store retention policy. Time retention policy: `time:<seconds>`. Capacity retention policy: `capacity:<count>`. Size retention policy: `size:<xMB/xGB>`. Set to `none` to disable | | `store-message-retention-policy` | `time:172800` | Message store retention policy. Time retention policy: `time:<seconds>`. Capacity retention policy: `capacity:<count>`. Size retention policy: `size:<xMB/xGB>`. Set to `none` to disable |
@ -84,7 +84,7 @@ Here are the available node configuration options, along with their default valu
## Filter config ## Filter config
| Name | Default Value | Description | | Name | Default Value | Description |
| - | - | - | | ----------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------- |
| `filter` | `false` | Enable filter protocol: true\|false | | `filter` | `false` | Enable filter protocol: true\|false |
| `filternode` | | Peer multiaddr to request content filtering of messages | | `filternode` | | Peer multiaddr to request content filtering of messages |
| `filter-timeout` | `14400 # 4 hours` | Timeout for filter node in seconds | | `filter-timeout` | `14400 # 4 hours` | Timeout for filter node in seconds |
@ -95,24 +95,14 @@ Here are the available node configuration options, along with their default valu
## Light push config ## Light push config
| Name | Default Value | Description | | Name | Default Value | Description |
| - | - | - | | --------------- | ------------- | --------------------------------------------------------- |
| `lightpush` | `false` | Enable lightpush protocol: true\|false | | `lightpush` | `false` | Enable lightpush protocol: true\|false |
| `lightpushnode` | | Peer multiaddr to request lightpush of published messages | | `lightpushnode` | | Peer multiaddr to request lightpush of published messages |
## JSON-RPC config
| Name | Default Value | Description |
| - | - | - |
| `rpc` | `true` | Enable Waku JSON-RPC server: true\|false |
| `rpc-address` | `127.0.0.1` | Listening address of the JSON-RPC server |
| `rpc-port` | `8545` | Listening port of the JSON-RPC server |
| `rpc-admin` | `false` | Enable access to JSON-RPC Admin API: true\|false |
| `rpc-private` | `false` | Enable access to JSON-RPC Private API: true\|false |
## REST HTTP config ## REST HTTP config
| Name | Default Value | Description | | Name | Default Value | Description |
| - | - | - | | --------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `rest` | `false` | Enable Waku REST HTTP server: true\|false | | `rest` | `false` | Enable Waku REST HTTP server: true\|false |
| `rest-address` | `127.0.0.1` | Listening address of the REST HTTP server | | `rest-address` | `127.0.0.1` | Listening address of the REST HTTP server |
| `rest-port` | `8645` | Listening port of the REST HTTP server | | `rest-port` | `8645` | Listening port of the REST HTTP server |
@ -124,7 +114,7 @@ Here are the available node configuration options, along with their default valu
## Metrics config ## Metrics config
| Name | Default Value | Description | | Name | Default Value | Description |
| - | - | - | | ------------------------ | ------------- | ----------------------------------------- |
| `metrics-server` | `false` | Enable the metrics server: true\|false | | `metrics-server` | `false` | Enable the metrics server: true\|false |
| `metrics-server-address` | `127.0.0.1` | Listening address of the metrics server | | `metrics-server-address` | `127.0.0.1` | Listening address of the metrics server |
| `metrics-server-port` | `8008` | Listening HTTP port of the metrics server | | `metrics-server-port` | `8008` | Listening HTTP port of the metrics server |
@ -133,7 +123,7 @@ Here are the available node configuration options, along with their default valu
## DNS discovery config ## DNS discovery config
| Name | Default Value | Description | | Name | Default Value | Description |
| - | - | - | | --------------------------- | ------------------------ | ---------------------------------------------------------- |
| `dns-discovery` | `false` | Enable discovering nodes via DNS | | `dns-discovery` | `false` | Enable discovering nodes via DNS |
| `dns-discovery-url` | | URL for DNS node list in format 'enrtree://<key\>@<fqdn\>' | | `dns-discovery-url` | | URL for DNS node list in format 'enrtree://<key\>@<fqdn\>' |
| `dns-discovery-name-server` | `["1.1.1.1", "1.0.0.1"]` | DNS name server IPs to query. Argument may be repeated | | `dns-discovery-name-server` | `["1.1.1.1", "1.0.0.1"]` | DNS name server IPs to query. Argument may be repeated |
@ -141,7 +131,7 @@ Here are the available node configuration options, along with their default valu
## Discv5 config ## Discv5 config
| Name | Default Value | Description | | Name | Default Value | Description |
| - | - | - | | ------------------------ | ------------- | -------------------------------------------------------------------------------------------------- |
| `discv5-discovery` | `false` | Enable discovering nodes via Node Discovery v5 | | `discv5-discovery` | `false` | Enable discovering nodes via Node Discovery v5 |
| `discv5-udp-port` | `9000` | Listening UDP port for Node Discovery v5 | | `discv5-udp-port` | `9000` | Listening UDP port for Node Discovery v5 |
| `discv5-bootstrap-node` | | Text-encoded ENR for bootstrap node. Used when connecting to the network. Argument may be repeated | | `discv5-bootstrap-node` | | Text-encoded ENR for bootstrap node. Used when connecting to the network. Argument may be repeated |
@ -153,14 +143,14 @@ Here are the available node configuration options, along with their default valu
## Waku peer exchange config ## Waku peer exchange config
| Name | Default Value | Description | | Name | Default Value | Description |
| - | - | - | | -------------------- | ------------- | ------------------------------------------------------------------------------------------------- |
| `peer-exchange` | `false` | Enable waku peer exchange protocol (responder side): true\|false | | `peer-exchange` | `false` | Enable waku peer exchange protocol (responder side): true\|false |
| `peer-exchange-node` | | Peer multiaddr to send peer exchange requests to. (enables peer exchange protocol requester side) | | `peer-exchange-node` | | Peer multiaddr to send peer exchange requests to. (enables peer exchange protocol requester side) |
## WebSocket config ## WebSocket config
| Name | Default Value | Description | | Name | Default Value | Description |
| - | - | - | | ---------------------------- | ------------- | ------------------------------------------------------ |
| `websocket-support` | `false` | Enable websocket: true\|false | | `websocket-support` | `false` | Enable websocket: true\|false |
| `websocket-port` | `8000` | WebSocket listening port | | `websocket-port` | `8000` | WebSocket listening port |
| `websocket-secure-support` | `false` | Enable secure websocket: true\|false | | `websocket-secure-support` | `false` | Enable secure websocket: true\|false |

1
docs/guides/nwaku/run-docker.md
View File

@ -43,7 +43,6 @@ docker run -i -t -p 60000:60000 -p 9000:9000/udp statusteam/nim-waku:v0.20.0 \
--dns-discovery=true \ --dns-discovery=true \
--dns-discovery-url=enrtree://AIRVQ5DDA4FFWLRBCHJWUWOO6X6S4ZTZ5B667LQ6AJU6PEYDLRD5O@sandbox.waku.nodes.status.im \ --dns-discovery-url=enrtree://AIRVQ5DDA4FFWLRBCHJWUWOO6X6S4ZTZ5B667LQ6AJU6PEYDLRD5O@sandbox.waku.nodes.status.im \
--discv5-discovery=true \ --discv5-discovery=true \
--rpc-address=0.0.0.0 \
--nat=extip:[YOUR PUBLIC IP] # or, if you are behind a nat: --nat=any --nat=extip:[YOUR PUBLIC IP] # or, if you are behind a nat: --nat=any
``` ```

2
docs/rules-of-engagement.md
View File

@ -67,7 +67,7 @@ If no code is provided to help with the investigation, then there is nothing the
For any unresolved issue, the project must open an issue on the related GitHub repository under the [waku-org](https://github.com/waku-org) organisation. For any unresolved issue, the project must open an issue on the related GitHub repository under the [waku-org](https://github.com/waku-org) organisation.
::: :::
# 5. Ongoing relation ## 5. Ongoing relation
Once the project application is live, the Waku team is keen to maintain regular contact. This can include discussion around performance, bugs found by users, etc. Once the project application is live, the Waku team is keen to maintain regular contact. This can include discussion around performance, bugs found by users, etc.

2
scripts/config-table-generator.py
View File

@ -25,7 +25,7 @@ def parse_table_heading(line: str) -> Tuple[str, bool]:
'Discovery V5': 'Discv5', 'Websocket': 'WebSocket' 'Discovery V5': 'Discv5', 'Websocket': 'WebSocket'
} }
table_heading = word_replace_re.sub(lambda match: word_replace_dict[match.group(0)], table_heading) table_heading = word_replace_re.sub(lambda match: word_replace_dict[match.group(0)], table_heading)
return '## ' + table_heading, Trues return '## ' + table_heading, True
def fetch_config_file(config_path: str) -> str: def fetch_config_file(config_path: str) -> str:
config_file = requests.get(config_path) config_file = requests.get(config_path)