Skip to content

Commit 33dd60e

Browse files
minhd-vuminhd-vu
committed
docs: make gen-doc
1 parent 2e58eb5 commit 33dd60e

File tree

1 file changed

+40
-38
lines changed

1 file changed

+40
-38
lines changed

‎doc/polycli_p2p_sensor.md‎

Lines changed: 40 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -23,44 +23,46 @@ If no nodes.json file exists, it will be created.
2323
## Flags
2424

2525
```bash
26-
--api-port uint port API server will listen on (default 8080)
27-
-b, --bootnodes string comma separated nodes used for bootstrapping
28-
--database string which database to persist data to, options are:
29-
- datastore (GCP Datastore)
30-
- json (output to stdout)
31-
- none (no persistence) (default "none")
32-
-d, --database-id string datastore database ID
33-
--dial-ratio int ratio of inbound to dialed connections (dial ratio of 2 allows 1/2 of connections to be dialed, setting to 0 defaults to 3)
34-
--discovery-dns string DNS discovery ENR tree URL
35-
--discovery-port int UDP P2P discovery port (default 30303)
36-
--fork-id bytesHex hex encoded fork ID (omit 0x) (default F097BC13)
37-
--genesis-hash string genesis block hash (default "0xa9c28ce2141b56c474f1dc504bee9b01eb1bd7d1a507580d5519d4437a97de1b")
38-
-h, --help help for sensor
39-
--key string hex-encoded private key (cannot be set with --key-file)
40-
-k, --key-file string private key file (cannot be set with --key)
41-
-D, --max-db-concurrency int maximum number of concurrent database operations to perform (increasing this
42-
will result in less chance of missing data but can significantly increase memory usage) (default 10000)
43-
-m, --max-peers int maximum number of peers to connect to (default 2000)
44-
--nat string NAT port mapping mechanism (any|none|upnp|pmp|pmp:<IP>|extip:<IP>) (default "any")
45-
-n, --network-id uint filter discovered nodes by this network ID
46-
--no-discovery disable P2P peer discovery
47-
--port int TCP network listening port (default 30303)
48-
--pprof run pprof server
49-
--pprof-port uint port pprof runs on (default 6060)
50-
-p, --project-id string GCP project ID
51-
--prom run Prometheus server (default true)
52-
--prom-port uint port Prometheus runs on (default 2112)
53-
--rpc string RPC endpoint used to fetch latest block (default "https://polygon-rpc.com")
54-
--rpc-port uint port for JSON-RPC server to receive transactions (default 8545)
55-
-s, --sensor-id string sensor ID when writing block/tx events
56-
--static-nodes string static nodes file
57-
--trusted-nodes string trusted nodes file
58-
--ttl duration time to live (default 336h0m0s)
59-
--write-block-events write block events to database (default true)
60-
-B, --write-blocks write blocks to database (default true)
61-
--write-peers write peers to database (default true)
62-
--write-tx-events write transaction events to database (this option can significantly increase CPU and memory usage) (default true)
63-
-t, --write-txs write transactions to database (this option can significantly increase CPU and memory usage) (default true)
26+
--api-port uint port API server will listen on (default 8080)
27+
-b, --bootnodes string comma separated nodes used for bootstrapping
28+
--database string which database to persist data to, options are:
29+
- datastore (GCP Datastore)
30+
- json (output to stdout)
31+
- none (no persistence) (default "none")
32+
-d, --database-id string datastore database ID
33+
--dial-ratio int ratio of inbound to dialed connections (dial ratio of 2 allows 1/2 of connections to be dialed, setting to 0 defaults to 3)
34+
--discovery-dns string DNS discovery ENR tree URL
35+
--discovery-port int UDP P2P discovery port (default 30303)
36+
--fork-id bytesHex hex encoded fork ID (omit 0x) (default F097BC13)
37+
--genesis-hash string genesis block hash (default "0xa9c28ce2141b56c474f1dc504bee9b01eb1bd7d1a507580d5519d4437a97de1b")
38+
-h, --help help for sensor
39+
--key string hex-encoded private key (cannot be set with --key-file)
40+
-k, --key-file string private key file (cannot be set with --key)
41+
-D, --max-db-concurrency int maximum number of concurrent database operations to perform (increasing this
42+
will result in less chance of missing data but can significantly increase memory usage) (default 10000)
43+
-m, --max-peers int maximum number of peers to connect to (default 2000)
44+
--max-requests int maximum request IDs to track per peer (0 for no limit) (default 2048)
45+
--nat string NAT port mapping mechanism (any|none|upnp|pmp|pmp:<IP>|extip:<IP>) (default "any")
46+
-n, --network-id uint filter discovered nodes by this network ID
47+
--no-discovery disable P2P peer discovery
48+
--port int TCP network listening port (default 30303)
49+
--pprof run pprof server
50+
--pprof-port uint port pprof runs on (default 6060)
51+
-p, --project-id string GCP project ID
52+
--prom run Prometheus server (default true)
53+
--prom-port uint port Prometheus runs on (default 2112)
54+
--requests-cache-ttl duration time to live for requests cache entries (0 for no expiration) (default 5m0s)
55+
--rpc string RPC endpoint used to fetch latest block (default "https://polygon-rpc.com")
56+
--rpc-port uint port for JSON-RPC server to receive transactions (default 8545)
57+
-s, --sensor-id string sensor ID when writing block/tx events
58+
--static-nodes string static nodes file
59+
--trusted-nodes string trusted nodes file
60+
--ttl duration time to live (default 336h0m0s)
61+
--write-block-events write block events to database (default true)
62+
-B, --write-blocks write blocks to database (default true)
63+
--write-peers write peers to database (default true)
64+
--write-tx-events write transaction events to database (this option can significantly increase CPU and memory usage) (default true)
65+
-t, --write-txs write transactions to database (this option can significantly increase CPU and memory usage) (default true)
6466
```
6567

6668
The command also inherits flags from parent commands.

0 commit comments

Comments
 (0)