Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

GH-797: Update min-hops command docs in User Interface #447

Merged
merged 4 commits into from
May 29, 2024
Merged

GH-797: Update min-hops command docs in User Interface #447

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f946038
GH-797: minor docs modification
utkarshg6 May 22, 2024
24873cb
GH-797: some TODOs
utkarshg6 May 24, 2024
d000b05
GH-797: add the definitions for min hops and gas price.
utkarshg6 May 28, 2024
93b00e8
GH-797: remove the markdown code container
utkarshg6 May 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion USER-INTERFACE-INTERFACE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1095,6 +1095,18 @@ even for parameters whose values are natively of other types.
##### Description:
If the value of the respective parameter was successfully changed, this is a simple acknowledgment that the change is complete.

The following commands can be configured using the `setConfiguration`:


| Name | Parameter | Possible Values |
|------------------|-----------------|------------------|
| Gas Price | `--gas-price` | > 0 |
| Start Block | `--start-block` | > 0 |
| Min Hops | `--min-hops` | [1, 6] |


Note: The descriptions for the above commands can be found [here](#permitted-names).

#### `setup`
##### Direction: Request
##### Correspondent: Daemon
Expand Down Expand Up @@ -1131,10 +1143,11 @@ be cleared.
* `db-password` - Password to unlock the sensitive values in the database.
* `dns-servers` - Comma-separated list of DNS servers to use.
* `earning-wallet` - Wallet into which earnings should be deposited.
* `gas-price` - Transaction fee to offer on the blockchain.
* `gas-price` - The fee per unit of computational effort in blockchain transactions, measured in gwei.
* `ip` - The public IP address of the Node.
* `log-level` - The lowest level of logs that should be recorded. `off`, `error`, `warn`, `info`, `debug`, `trace`
* `mapping-protocol` - The management protocol to try first with the router. `pcp`, `pmp`, `igdp`
* `min-hops`: The minimum number of hops required for the package to reach the Exit Node.
* `neighborhood-mode` - `zero-hop`, `originate-only`, `consume-only`, `standard`
* `neighbors` - Comma-separated list of Node descriptors for neighbors to contact on startup
* `real-user` - Non-Windows platforms only, only where required: <uid>:<gid>:<home directory>
Expand Down
Loading