Skip to content

Commit 40480d1

Browse files
authored
GH-797: Update min-hops command docs in User Interface (#447)
* GH-797: minor docs modification * GH-797: some TODOs * GH-797: add the definitions for min hops and gas price. * GH-797: remove the markdown code container
1 parent 55851fc commit 40480d1

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

USER-INTERFACE-INTERFACE.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1095,6 +1095,18 @@ even for parameters whose values are natively of other types.
10951095
##### Description:
10961096
If the value of the respective parameter was successfully changed, this is a simple acknowledgment that the change is complete.
10971097

1098+
The following commands can be configured using the `setConfiguration`:
1099+
1100+
1101+
| Name | Parameter | Possible Values |
1102+
|------------------|-----------------|------------------|
1103+
| Gas Price | `--gas-price` | > 0 |
1104+
| Start Block | `--start-block` | > 0 |
1105+
| Min Hops | `--min-hops` | [1, 6] |
1106+
1107+
1108+
Note: The descriptions for the above commands can be found [here](#permitted-names).
1109+
10981110
#### `setup`
10991111
##### Direction: Request
11001112
##### Correspondent: Daemon
@@ -1131,10 +1143,11 @@ be cleared.
11311143
* `db-password` - Password to unlock the sensitive values in the database.
11321144
* `dns-servers` - Comma-separated list of DNS servers to use.
11331145
* `earning-wallet` - Wallet into which earnings should be deposited.
1134-
* `gas-price` - Transaction fee to offer on the blockchain.
1146+
* `gas-price` - The fee per unit of computational effort in blockchain transactions, measured in gwei.
11351147
* `ip` - The public IP address of the Node.
11361148
* `log-level` - The lowest level of logs that should be recorded. `off`, `error`, `warn`, `info`, `debug`, `trace`
11371149
* `mapping-protocol` - The management protocol to try first with the router. `pcp`, `pmp`, `igdp`
1150+
* `min-hops`: The minimum number of hops required for the package to reach the Exit Node.
11381151
* `neighborhood-mode` - `zero-hop`, `originate-only`, `consume-only`, `standard`
11391152
* `neighbors` - Comma-separated list of Node descriptors for neighbors to contact on startup
11401153
* `real-user` - Non-Windows platforms only, only where required: <uid>:<gid>:<home directory>

0 commit comments

Comments
 (0)