Skip to content

Commit 8c3ee84

Browse files
daGscheiddaGscheid
authored
Merge pull request #51 from stereum-dev/ClientOptionTable
ADD: Client Options Table to Web Docs
2 parents d762542 + c589ffd commit 8c3ee84

File tree

1 file changed

+179
-0
lines changed

1 file changed

+179
-0
lines changed

‎docs/01-technical/05-client-options.md

+179
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
1+
# Client Options
2+
## Execution Clients
3+
### Besu
4+
Option | Command | Description | Default Value
5+
|---|---|---|---|
6+
Gas Limit | --target-gas-limit | Overwrites default gas limit | No default value
7+
P2P Host Address | --p2p-host | Address for P2P | 0.0.0.0
8+
P2P Port | --p2p-port | Port for P2P | 30303
9+
RPC HTTP Host Address | --rpc-http-host | Address for RPC HTTP | 0.0.0.0
10+
RPC HTTP Port | --rpc-http-port | Port for RPC HTTP | 8545
11+
RPC Websocket Host Address | --rpc-ws-host | Address for RPC websocket | 0.0.0.0
12+
RPC Websocket Port | --rpc-ws-port | Port for RPC websocket | 8546
13+
Metrics Host Address | --metrics-host | Address for metrics exporter | 0.0.0.0
14+
Metrics Port | --metrics-port | Port for metrics exporter | 9545
15+
Engine RPC Port | --engine-rpc-port | Port to provide consensus client APIS on | 8551
16+
### Erigon
17+
Option | Command | Description | Default Value
18+
|---|---|---|---|
19+
Gas Limit | --miner.gaslimit | Overwrites default gas limit | No default value
20+
RPC Authentication Host Address | --authrpc.addr | HTTP-RPC server listening interface for the Engine API | 0.0.0.0
21+
RPC Authentication Port | --authrpc.port | HTTP-RPC server listening port for the Engine API | 8551
22+
HTTP Host Address | --http.addr | Address for RPC HTTP | 0.0.0.0
23+
HTTP Port | --http.port | Port for RPC HTTP | 8545
24+
Metrics Host Address | --metrics.addr | Address for metrics exporter | 0.0.0.0
25+
Metrics Port | --metrics.port | Port for metrics exporter | 6060
26+
Prune history | --prune | Prune history | true (h)*
27+
Prune receipts | --prune | Prune receipts | false (r)*
28+
Prune transaction | --prune | Prune transaction | true (t)*
29+
Prune call traces | --prune | Prune call traces | true (c)*
30+
31+
*values are added to --prune as --prune=htc
32+
### Geth
33+
Option | Command | Description | Default Value
34+
|---|---|---|---|
35+
Gas Limit | --miner.gaslimit | Overwrites default gas limit | No default value
36+
HTTP Host Address | --http.addr | Address for RPC HTTP | 0.0.0.0
37+
HTTP Port | --http.port | Port for RPC HTTP | 8545
38+
Websocket Host Address | --ws.addr | Address for RPC websocket | 0.0.0.0
39+
Websocket Port | --ws.port | Port for RPC websocket | 8546
40+
RPC Authentication Host Address | --authrpc.addr | HTTP-RPC server listening interface for the Engine API | 0.0.0.0
41+
RPC Authentication Port | --authrpc.port | HTTP-RPC server listening port for the Engine API | 8551
42+
Metrics Host Address | --metrics.addr | Address for metrics exporter | 0.0.0.0
43+
Metrics Port | --metrics.port | Port for metrics exporter | 6060
44+
### Nethermind
45+
Option | Command | Description | Default Value
46+
|---|---|---|---|
47+
Pruning Mode | --Pruning.Mode | Set pruning mode | Hybrid
48+
Gas Limit | --Blocks.TargetBlockGasLimit | Overwrites default gas limit | No default value
49+
Network Discovery Port | --Network.DiscoveryPort | UDP port for P2P | 30303
50+
Network P2P Port | --Network.P2PPort | TCP port for P2P | 30303
51+
RPC Host Address | --JsonRpc.Host | HTTP-RPC server listening interface for the Engine API | 0.0.0.0
52+
RPC Engine Host Address | --JsonRpc.EngineHost | HTTP-RPC server listening port for the Engine API | 0.0.0.0
53+
RPC Websocket Port | --JsonRpc.WebSocketsPort | Port for RPC websocket | 8546
54+
Metrics Port | --Metrics.ExposePort | Port for metrics exporter | 6060
55+
Available Space Check | --Pruning.AvailableSpaceCheckEnabled | Enable available space check | TRUE
56+
Cache MB | --Pruning.CacheMb | In-memory cache size in MB | 1024
57+
Persistence Interval | --Pruning.PersistenceInterval | Block persistance frequency | 8192
58+
Pruning Boundary | --Pruning.PruningBoundary | Past N states before state gets pruned | 64
59+
Tracked Past Key Count Memory Ratio | --Pruning.TrackedPastKeyCountMemoryRatio | Ratio of memory out of cacheMB | 0.1
60+
Full Pruning Completion Behavior | --Pruning.FullPruningCompletionBehavior | Behavior after pruning completion | None
61+
Disable Low Priority Writes | --Pruning.FullPruningDisableLowPriorityWrites | Disable low priority writes | FALSE
62+
Max Degree Of Parallelism | --Pruning.FullPruningMaxDegreeOfParallelism | Max number of parallel tasks | 0
63+
Memory Budget Mb | --Pruning.FullPruningMemoryBudgetMb | Memory Budget in MB | 4000
64+
Minimum Delay Hours | --Pruning.FullPruningMinimumDelayHours | Minumum delay between prunes in hours | 240
65+
Threshold Mb | --Pruning.FullPruningThresholdMb | Threshold to trigger Full Prune in MB | 256000
66+
Full Pruning Trigger | --Pruning.FullPruningTrigger | Trigger for Full Prune | StateDbSize
67+
### Reth
68+
Option | Command | Description | Default Value
69+
|---|---|---|---|
70+
Gas Limit | --max_cumulative_gas | Overwrites default gas limit | No default value
71+
RPC Authentication Host Address | --authrpc.addr | HTTP-RPC server listening interface for the Engine API | 0.0.0.0
72+
RPC Authentication Port | --authrpc.port | HTTP-RPC server listening port for the Engine API | 8551
73+
Websocket Host Address | --ws.addr | Address for RPC websocket | 0.0.0.0
74+
Websocket Port | --ws.port | Port for RPC websocket | 8546
75+
HTTP Host Address | --http.addr | Address for RPC HTTP | 0.0.0.0
76+
HTTP Port | --http.port | Port for RPC HTTP | 8545
77+
Metrics Host Address/Port | --metrics | Address and port for metrics exporter | 0.0.0.0:6060
78+
## Consensus Clients
79+
### Lighthouse
80+
Option | Command | Description | Default Value
81+
|---|---|---|---|
82+
External IP Address | --enr-address | External IP Address | No default value
83+
Disable ENR auto update | --disable-enr-auto-update | Disable ENR auto update | false
84+
External TCP/UDP port | --enr-tcp-port, --enr-udp-port, --port | Port for TCP/UDP | 9000
85+
Metrics Address | --metrics-address | Address for metrics exporter | 0.0.0.0
86+
HTTP Address | --http-address | Address for the RESTful HTTP API | 0.0.0.0
87+
Slasher | --slasher | Runs a slasher alongside the beacon node | Enabled by default
88+
### Lodestar
89+
Option | Command | Description | Default Value
90+
|---|---|---|---|
91+
External IP Address | --enr.ip | External IP Address | No default value
92+
Enable NAT | --nat | Enable NAT auto update | false
93+
External TCP/UDP port | --enr.tcp.port, --enr.udp.port, --port | Port for TCP/UDP | 9000
94+
Metrics Host Address | --metrics.address | Address for metrics exporter | 0.0.0.0
95+
Metrics Port | --metrics.port | Port for metrics exporter | 8008
96+
Rest Address | --rest.address | Address for HTTP API | 0.0.0.0
97+
Rest Port | --rest.port | Port for HTTP API | 9596
98+
### Nimbus
99+
Option | Command | Description | Default Value
100+
|---|---|---|---|
101+
Pruning Mode | --history | Select pruning mode | prune
102+
External IP Address | --nat:extip | External IP Address | No default value
103+
Disable ENR auto update | --enr-auto-update | Enable ENR auto update | false
104+
External TCP/UDP port | --tcp-port, --udp-port | Port for TCP/UDP | 9000
105+
Metrics Address | --metrics-address | Address for metrics exporter | 0.0.0.0
106+
Metrics Port | --metrics-port | Port for metrics exporter | 8008
107+
Rest Address | --rest-address | Address for HTTP API | 0.0.0.0
108+
Rest Port | --rest-port | Port for HTTP API | 5052
109+
### Prysm
110+
Option | Command | Description | Default Value
111+
|---|---|---|---|
112+
External IP Address | --p2p-host-ip | External IP Address | No default value
113+
External TCP/UDP port | --p2p-tcp-port,--p2p-udp-port | Port for TCP/UDP | 13001
114+
Monitoring Host Address | --monitoring-host | Address for metrics exporter | 0.0.0.0
115+
Monitoring Port | --monitoring-port | Port for metrics exporter | 8080
116+
RPC Host Address | --rpc-host | Address for RPC listener | 0.0.0.0
117+
GRPC Gateway Host Address | --grpc-gateway-host | Address for gateway server | 0.0.0.0
118+
### Teku
119+
Option | Command | Description | Default Value
120+
|---|---|---|---|
121+
RAM Usage Limit | JAVA_OPTS: -Xmx | RAM useage limit in GB | 6
122+
External IP Address | --p2p-advertised-ip | External IP Address | No default value
123+
External TCP/UDP port | --p2p-port, --p2p-advertised-port | Port for TCP/UDP | 9001
124+
Metrics Interface Address | --metrics-interface | Address for metrics exporter | 0.0.0.0
125+
Metrics Port | --metrics-port | Port for metrics exporter | 8008
126+
Rest API Interface Address | --rest-api-interface | Address for HTTP API | 0.0.0.0
127+
Rest API Interface Port | --rest-api-port | Port for HTTP API | 5051
128+
## Validator Clients
129+
### Lighthouse
130+
Option | Command | Description | Default Value
131+
|---|---|---|---|
132+
Default Fee Recipient | --suggested-fee-recipient | Set fee recipient | 0x0000000000000000000000000000000000000000
133+
Doppelganger Protection | --enable-doppelganger-protection | Enable doppelganger protection | Added by default
134+
Gas Limit | --gas-limit | Overwrites default gas limit | No default value
135+
Metrics Address | --metrics-address | Address for metrics exporter | 0.0.0.0
136+
HTTP Address | --http-address | Address for the RESTful HTTP API | 0.0.0.0
137+
HTTP Port | --http-port | Port for the RESTful HTTP API | 5062
138+
### Lodestar
139+
Option | Command | Description | Default Value
140+
|---|---|---|---|
141+
Default Fee Recipient | --suggestedFeeRecipient | Set fee recipient | 0x0000000000000000000000000000000000000000
142+
Doppelganger Protection | --doppelgangerProtection | Enable doppelganger protection | TRUE
143+
Gas Limit | --defaultGasLimit | Overwrites default gas limit | No default value
144+
Metrics Address | --metrics.address | Address for metrics exporter | 0.0.0.0
145+
Metrics Port | --metrics.port | Port for metrics exporter | 5064
146+
Keymanager Address | --keymanager.address | Address for key manager API | 0.0.0.0
147+
Keymanager Port | --keymanager.port | Port for key manager API | 5062
148+
### Nimbus
149+
Option | Command | Description | Default Value
150+
|---|---|---|---|
151+
Default Fee Recipient | --suggested-fee-recipient | Set fee recipient | 0x0000000000000000000000000000000000000000
152+
Doppelganger Protection | --doppelganger-protection | Enable doppelganger protection | TRUE
153+
Gas Limit | --suggester-gas-limit | Overwrites default gas limit | No default value
154+
Keymanager Adress | --keymanager-address | Address for key manager API | 0.0.0.0
155+
Keymanager Port | --keymanager-port | Port for key manager API | 5052
156+
Metrics Address | --metrics-address | Address for metrics exporter | 0.0.0.0
157+
Metrics Port | --metrics-port | Port for metrics exporter | 8108
158+
### Prysm
159+
Option | Command | Description | Default Value
160+
|---|---|---|---|
161+
Default Fee Recipient | --suggested-fee-recipient | Set fee recipient | 0x0000000000000000000000000000000000000000
162+
Doppelganger Protection | --doppelganger-protection | Enable doppelganger protection | TRUE
163+
Gas Limit | --suggester-gas-limit | Overwrites default gas limit | No default value
164+
Monitoring Host Address | --monitoring-host | Address for metrics exporter | 0.0.0.0
165+
Monitoring Port | --monitoring-port | Port for metrics exporter | 8081
166+
RPC Host Address | --rpc-host | Address for RPC listener | 0.0.0.0
167+
GRPC Gateway Host Adress | --grpc-gateway-host | Gateway address | 0.0.0.0
168+
GRPC Gateway Port | --grpc-gateway-port | Gateway port | 7500
169+
### Teku
170+
Option | Command | Description | Default Value
171+
|---|---|---|---|
172+
RAM Usage Limit | JAVA_OPTS: -Xmx | RAM useage limit in GB | 4
173+
Default Fee Recipient | --suggested-fee-recipient | Set fee recipient | 0x0000000000000000000000000000000000000000
174+
Doppelganger Protection | --doppelganger-protection | Enable doppelganger protection | TRUE
175+
Gas Limit | --gas-limit | Overwrites default gas limit | No default value
176+
Monitoring Host Address | --monitoring-host | Address for metrics exporter | 0.0.0.0
177+
Metrics Interface Address | --metrics-interface | Address for metrics exporter | 0.0.0.0
178+
Metrics Port | --metrics-port | Port for metrics exporter | 8008
179+
Rest API Interface Port | --validator-api-port | Port for Rest API | 5052

0 commit comments

Comments
 (0)