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

3
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`.
- Listen for incoming libp2p connections on the default TCP port (`60000`).
- 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 `Store` protocol as a client, allowing it to query peers for historical messages but not store any message itself.
@ -98,4 +97,4 @@ To see the default values of all [configuration options](/guides/nwaku/config-op
:::tip
To explore the available node configuration options, have a look at the [Node Configuration Options](/guides/nwaku/config-options) guide.
:::
:::

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

@ -7,165 +7,155 @@ Here are the available node configuration options, along with their default valu
## Application-level config
| Name | Default Value | Description |
| - | - | - |
| `config-file` | | Loads configuration from a TOML file (cmd-line parameters take precedence) |
| Name | Default Value | Description |
| ----------------- | --------------------------- | --------------------------------------------------------------------------------------------------- |
| `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 |
## Log config
| 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-format` | `logging.LogFormat.TEXT` | Specifies what kind of logs should be written to stdout. Supported formats: TEXT, JSON |
| 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-format` | `logging.LogFormat.TEXT` | Specifies what kind of logs should be written to stdout. Supported formats: TEXT, JSON |
## General node config
| Name | Default Value | Description |
| - | - | - |
| `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 |
| `nodekey` | | P2P node private key as 64-char hex string |
| `listen-address` | `defaultListenAddress()` | Listening address for LibP2P (and Discovery v5, if enabled) traffic |
| `tcp-port` | `60000` | TCP listening port |
| `ports-shift` | `0` | Add a shift to all port numbers |
| `nat` | any | Specify method to use for determining public address. Must be one of: any, none, upnp, pmp, extip:<IP\> |
| `ext-multiaddr` | | External multiaddresses to advertise to the network. Argument may be repeated |
| `ext-multiaddr-only` | `false` | Only announce external multiaddresses |
| `max-connections` | `50` | Maximum allowed number of libp2p connections |
| `max-relay-peers` | | Maximum allowed number of relay peers |
| `peer-store-capacity` | | Maximum stored peers in the peerstore |
| `peer-persistence` | `false` | Enable peer persistence |
| Name | Default Value | Description |
| --------------------- | ------------------------ | ------------------------------------------------------------------------------------------------------- |
| `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 |
| `nodekey` | | P2P node private key as 64-char hex string |
| `listen-address` | `defaultListenAddress()` | Listening address for LibP2P (and Discovery v5, if enabled) traffic |
| `tcp-port` | `60000` | TCP listening port |
| `ports-shift` | `0` | Add a shift to all port numbers |
| `nat` | any | Specify method to use for determining public address. Must be one of: any, none, upnp, pmp, extip:<IP\> |
| `ext-multiaddr` | | External multiaddresses to advertise to the network. Argument may be repeated |
| `ext-multiaddr-only` | `false` | Only announce external multiaddresses |
| `max-connections` | `50` | Maximum allowed number of libp2p connections |
| `max-relay-peers` | | Maximum allowed number of relay peers |
| `peer-store-capacity` | | Maximum stored peers in the peerstore |
| `peer-persistence` | `false` | Enable peer persistence |
## DNS addrs config
| Name | Default Value | Description |
| - | - | - |
| `dns-addrs` | `true` | Enable resolution of `dnsaddr`, `dns4` or `dns6` multiaddrs |
| Name | Default Value | Description |
| ----------------------- | ------------------------ | ------------------------------------------------------------------------------------ |
| `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 |
| `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 |
## Relay config
| Name | Default Value | Description |
| - | - | - |
| `relay` | `true` | Enable 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-cred-path` | | The path for persisting rln-relay credential |
| `rln-relay-membership-index` | | The index of the onchain commitment to use |
| `rln-relay-dynamic` | `false` | Enable waku-rln-relay with on-chain dynamic group management: true\|false |
| `rln-relay-id-key` | | Rln relay identity secret key as a Hex string |
| `rln-relay-id-commitment-key` | | Rln relay identity commitment key as a Hex string |
| `rln-relay-eth-client-address` | `ws://localhost:8540/` | WebSocket address of an Ethereum testnet client e.g., `ws://localhost:8540/` |
| `rln-relay-eth-contract-address` | | Address of membership contract on an Ethereum testnet |
| `rln-relay-eth-private-key` | | Private key for broadcasting transactions |
| `execute` | `false` | Runs the registration function on-chain. By default, a dry-run will occur |
| `rln-relay-cred-password` | | Password for encrypting RLN credentials |
| `rln-relay-tree-path` | | Path to the RLN merkle tree sled db (https://github.com/spacejam/sled) |
| `rln-relay-bandwidth-threshold` | `0 # to maintain backwards compatibility` | Message rate in bytes/sec after which verification of proofs should happen |
| `staticnode` | | Peer multiaddr to directly connect with. Argument may be repeated |
| `keep-alive` | `false` | Enable keep-alive for idle connections: true\|false |
| `topic` | `["/waku/2/default-waku/proto"]` | Default topic to subscribe to. Argument may be repeated. Deprecated! Please use `pubsub-topic` and/or `content-topic` instead |
| `pubsub-topic` | | Default pubsub topic to subscribe to. Argument may be repeated |
| `content-topic` | | Default content topic to subscribe to. Argument may be repeated |
| Name | Default Value | Description |
| -------------------------------- | ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `relay` | `true` | Enable 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-cred-path` | | The path for persisting rln-relay credential |
| `rln-relay-membership-index` | | The index of the onchain commitment to use |
| `rln-relay-dynamic` | `false` | Enable waku-rln-relay with on-chain dynamic group management: true\|false |
| `rln-relay-id-key` | | Rln relay identity secret key as a Hex string |
| `rln-relay-id-commitment-key` | | Rln relay identity commitment key as a Hex string |
| `rln-relay-eth-client-address` | `ws://localhost:8540/` | WebSocket address of an Ethereum testnet client e.g., `ws://localhost:8540/` |
| `rln-relay-eth-contract-address` | | Address of membership contract on an Ethereum testnet |
| `rln-relay-eth-private-key` | | Private key for broadcasting transactions |
| `execute` | `false` | Runs the registration function on-chain. By default, a dry-run will occur |
| `rln-relay-cred-password` | | Password for encrypting RLN credentials |
| `rln-relay-tree-path` | | Path to the RLN merkle tree sled db (https://github.com/spacejam/sled) |
| `rln-relay-bandwidth-threshold` | `0 # to maintain backwards compatibility` | Message rate in bytes/sec after which verification of proofs should happen |
| `staticnode` | | Peer multiaddr to directly connect with. Argument may be repeated |
| `keep-alive` | `false` | Enable keep-alive for idle connections: true\|false |
| `topic` | `["/waku/2/default-waku/proto"]` | Default topic to subscribe to. Argument may be repeated. Deprecated! Please use `pubsub-topic` and/or `content-topic` instead |
| `pubsub-topic` | | Default pubsub topic to subscribe to. Argument may be repeated |
| `content-topic` | | Default content topic to subscribe to. Argument may be repeated |
## Store and message store config
| Name | Default Value | Description |
| - | - | - |
| `store` | `false` | Enable/disable waku store protocol |
| `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-db-url` | `sqlite://store.sqlite3` | The database connection URL for persistent storage |
| `store-message-db-vacuum` | `false` | Enable database vacuuming at start. Only supported by SQLite database engine |
| `store-message-db-migration` | `true` | Enable database migration at start |
| Name | Default Value | Description |
| -------------------------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `store` | `false` | Enable/disable waku store protocol |
| `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-db-url` | `sqlite://store.sqlite3` | The database connection URL for persistent storage |
| `store-message-db-vacuum` | `false` | Enable database vacuuming at start. Only supported by SQLite database engine |
| `store-message-db-migration` | `true` | Enable database migration at start |
## Filter config
| Name | Default Value | Description |
| - | - | - |
| `filter` | `false` | Enable filter protocol: true\|false |
| `filternode` | | Peer multiaddr to request content filtering of messages |
| `filter-timeout` | `14400 # 4 hours` | Timeout for filter node in seconds |
| `filter-subscription-timeout` | `300 # 5 minutes` | Timeout for filter subscription without ping or refresh it, in seconds. Only for v2 filter protocol |
| `filter-max-peers-to-serve` | `1000` | Maximum number of peers to serve at a time. Only for v2 filter protocol |
| `filter-max-criteria` | `1000` | Maximum number of pubsub and content topic combinations per peer at a time. Only for v2 filter protocol |
| Name | Default Value | Description |
| ----------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------- |
| `filter` | `false` | Enable filter protocol: true\|false |
| `filternode` | | Peer multiaddr to request content filtering of messages |
| `filter-timeout` | `14400 # 4 hours` | Timeout for filter node in seconds |
| `filter-subscription-timeout` | `300 # 5 minutes` | Timeout for filter subscription without ping or refresh it, in seconds. Only for v2 filter protocol |
| `filter-max-peers-to-serve` | `1000` | Maximum number of peers to serve at a time. Only for v2 filter protocol |
| `filter-max-criteria` | `1000` | Maximum number of pubsub and content topic combinations per peer at a time. Only for v2 filter protocol |
## Light push config
| Name | Default Value | Description |
| - | - | - |
| `lightpush` | `false` | Enable lightpush protocol: true\|false |
| `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 |
| Name | Default Value | Description |
| --------------- | ------------- | --------------------------------------------------------- |
| `lightpush` | `false` | Enable lightpush protocol: true\|false |
| `lightpushnode` | | Peer multiaddr to request lightpush of published messages |
## REST HTTP config
| Name | Default Value | Description |
| - | - | - |
| `rest` | `false` | Enable Waku REST HTTP server: true\|false |
| `rest-address` | `127.0.0.1` | Listening address of the REST HTTP server |
| `rest-port` | `8645` | Listening port of the REST HTTP server |
| `rest-relay-cache-capacity` | `30` | Capacity of the Relay REST API message cache |
| `rest-admin` | `false` | Enable access to REST HTTP Admin API: true\|false |
| `rest-private` | `false` | Enable access to REST HTTP Private API: true\|false |
| `rest-allow-origin` | | Allow cross-origin requests from the specified origin. When using the REST API in a browser, specify the origin host to get a valid response from the node REST HTTP server. This option may be repeated and can contain wildcards (?,\*) for defining URLs and ports such as `localhost:*`, `127.0.0.1:8080`, or allow any website with `*` |
| Name | Default Value | Description |
| --------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `rest` | `false` | Enable Waku REST HTTP server: true\|false |
| `rest-address` | `127.0.0.1` | Listening address of the REST HTTP server |
| `rest-port` | `8645` | Listening port of the REST HTTP server |
| `rest-relay-cache-capacity` | `30` | Capacity of the Relay REST API message cache |
| `rest-admin` | `false` | Enable access to REST HTTP Admin API: true\|false |
| `rest-private` | `false` | Enable access to REST HTTP Private API: true\|false |
| `rest-allow-origin` | | Allow cross-origin requests from the specified origin. When using the REST API in a browser, specify the origin host to get a valid response from the node REST HTTP server. This option may be repeated and can contain wildcards (?,\*) for defining URLs and ports such as `localhost:*`, `127.0.0.1:8080`, or allow any website with `*` |
## Metrics config
| Name | Default Value | Description |
| - | - | - |
| `metrics-server` | `false` | Enable the metrics server: true\|false |
| `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-logging` | `true` | Enable metrics logging: true\|false |
| Name | Default Value | Description |
| ------------------------ | ------------- | ----------------------------------------- |
| `metrics-server` | `false` | Enable the metrics server: true\|false |
| `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-logging` | `true` | Enable metrics logging: true\|false |
## DNS discovery config
| Name | Default Value | Description |
| - | - | - |
| `dns-discovery` | `false` | Enable discovering nodes via DNS |
| `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 |
| Name | Default Value | Description |
| --------------------------- | ------------------------ | ---------------------------------------------------------- |
| `dns-discovery` | `false` | Enable discovering nodes via DNS |
| `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 |
## Discv5 config
| Name | Default Value | Description |
| - | - | - |
| `discv5-discovery` | `false` | Enable discovering nodes via 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-enr-auto-update` | `false` | Discovery can automatically update its ENR with the IP address |
| `discv5-table-ip-limit` | `10` | Maximum amount of nodes with the same IP in discv5 routing tables |
| `discv5-bucket-ip-limit` | `2` | Maximum amount of nodes with the same IP in discv5 routing table buckets |
| `discv5-bits-per-hop` | `1` | Kademlia's b variable, increase for less hops per lookup |
| Name | Default Value | Description |
| ------------------------ | ------------- | -------------------------------------------------------------------------------------------------- |
| `discv5-discovery` | `false` | Enable discovering nodes via 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-enr-auto-update` | `false` | Discovery can automatically update its ENR with the IP address |
| `discv5-table-ip-limit` | `10` | Maximum amount of nodes with the same IP in discv5 routing tables |
| `discv5-bucket-ip-limit` | `2` | Maximum amount of nodes with the same IP in discv5 routing table buckets |
| `discv5-bits-per-hop` | `1` | Kademlia's b variable, increase for less hops per lookup |
## Waku peer exchange config
| Name | Default Value | Description |
| - | - | - |
| `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) |
| Name | Default Value | Description |
| -------------------- | ------------- | ------------------------------------------------------------------------------------------------- |
| `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) |
## WebSocket config
| Name | Default Value | Description |
| - | - | - |
| `websocket-support` | `false` | Enable websocket: true\|false |
| `websocket-port` | `8000` | WebSocket listening port |
| `websocket-secure-support` | `false` | Enable secure websocket: true\|false |
| `websocket-secure-key-path` | | Secure websocket key path: '/path/to/key.txt' |
| `websocket-secure-cert-path` | | Secure websocket Certificate path: '/path/to/cert.txt' |
| Name | Default Value | Description |
| ---------------------------- | ------------- | ------------------------------------------------------ |
| `websocket-support` | `false` | Enable websocket: true\|false |
| `websocket-port` | `8000` | WebSocket listening port |
| `websocket-secure-support` | `false` | Enable secure websocket: true\|false |
| `websocket-secure-key-path` | | Secure websocket key path: '/path/to/key.txt' |
| `websocket-secure-cert-path` | | Secure websocket Certificate path: '/path/to/cert.txt' |
:::tip
To configure your node using the provided configuration options, have a look at the [Node Configuration Methods](/guides/nwaku/config-methods) guide.

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-url=enrtree://AIRVQ5DDA4FFWLRBCHJWUWOO6X6S4ZTZ5B667LQ6AJU6PEYDLRD5O@sandbox.waku.nodes.status.im \
--discv5-discovery=true \
--rpc-address=0.0.0.0 \
--nat=extip:[YOUR PUBLIC IP] # or, if you are behind a nat: --nat=any
```

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

@ -67,10 +67,10 @@ 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.
:::
# 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.
The Waku team is keen to regularly present new and upcoming development to project team, highlight items that are particularly relevant.
If a project wishes to take onboard any new Waku protocol, or decide to extend their product with a new functionality using Waku, the circle can resume from [step 1](#1-initial-discussion).
If a project wishes to take onboard any new Waku protocol, or decide to extend their product with a new functionality using Waku, the circle can resume from [step 1](#1-initial-discussion).

6
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'
}
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:
config_file = requests.get(config_path)
@ -56,7 +56,7 @@ def extract_config(config_path: str) -> str:
table_heading, is_valid_heading = parse_table_heading(line)
if is_valid_heading:
config_table += f"\n{table_heading}\n\n| Name | Default Value | Description |\n| - | - | - |\n"
if line.startswith("name:"):
row["name"] = extract_config_param(line, "name")
@ -80,4 +80,4 @@ def extract_config(config_path: str) -> str:
if __name__ == "__main__":
config_path = "https://raw.githubusercontent.com/waku-org/nwaku/master/apps/wakunode2/external_config.nim"
table_data = extract_config(config_path)
print(table_data)
print(table_data)