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.

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

Add some help to the command line #11739

Merged
merged 10 commits into from
Nov 1, 2023
Merged

Conversation

lontivero
Copy link
Collaborator

@lontivero lontivero commented Oct 18, 2023

This PR add some help (not yet really) using the config metadata

$ wassabeed --help
Wasabi Daemon 2.0.4.0
Usage: Wasabi Daemon [OPTION]...

Available options are:
  --blockonlymode                  Indicate Wasabi should only listen for 
                                   blocks and not for transactions

  --coordinatoridentifier          -

  --downloadnewversion             Indicate new version of Wasabi should 
                                   be downloaded automatically

  --dustthreshold                  Threshold amount under which coin 
                                   received from others to reused 
                                   addresses are considered a dust attack

  --enablegpu                      Indicate Wasabi should use the GPU

  --jsonrpcpassword                The user password that is authorized to 
                                   make requests to the Json RPC server

  --jsonrpcserverenabled           Indicate the Json RPC Server should be 
                                   started and accepting requests

  --jsonrpcserverprefixes          Json RPC server prefixes

  --jsonrpcuser                    The user name that is authorized to 
                                   make requests to the Json RPC server

  --localbitcoincoredatadir        Specify the DataDir to be used by the 
                                   bitcoin node

  --loglevel                       Level of detail in the logs (trace, 
                                   debug, info, warning, error or 
                                   critical)

  --mainnetbackenduri              Url to the backend server to connect to 
                                   when network is main

  --mainnetbitcoinp2pendpoint      -

  --mainnetcoordinatoruri          Url to the coordinator server to 
                                   connect to when network is main

  --network                        Bitcoin network to use (main, testnet 
                                   or regtest)

  --regtestbackenduri              Url to the backend server to connect to 
                                   when network is regtest

  --regtestbitcoinp2pendpoint      -

  --regtestcoordinatoruri          Url to the coordinator server to 
                                   connect to when network is regtest

  --rpconionenabled                Indicate the Json RPC Server should be 
                                   published as an Tor Onion service

  --startlocalbitcoincoreonstartup Indicate that bitcoin node should be 
                                   started when wasabi starts

  --stoplocalbitcoincoreonshutdown Indicate that bitcoin node should be 
                                   stopped when finishes

  --terminatetoronexit             Indicate the Tor process must be 
                                   stopped when Wasabi finishes

  --testnetbackenduri              Url to the backend server to connect to 
                                   when network is testnet

  --testnetbitcoinp2pendpoint      -

  --testnetcoordinatoruri          Url to the coordinator server to 
                                   connect to when network is testnet

  --usetor                         Indicate all the communication have to 
                                   go thru the Tor network

MaxHillebrand
MaxHillebrand previously approved these changes Oct 19, 2023
Copy link
Collaborator

@MaxHillebrand MaxHillebrand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cACK, very helpful!

What does (source: config file) mean, and does it have to be mentioned in every line of the help output?

Copy link
Collaborator

@yahiheb yahiheb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small tweaks to the help text.

WalletWasabi.Daemon/Config.cs Outdated Show resolved Hide resolved
WalletWasabi.Daemon/Config.cs Outdated Show resolved Hide resolved
WalletWasabi.Daemon/Config.cs Outdated Show resolved Hide resolved
WalletWasabi.Daemon/Config.cs Outdated Show resolved Hide resolved
WalletWasabi.Daemon/Config.cs Outdated Show resolved Hide resolved
WalletWasabi.Daemon/Config.cs Outdated Show resolved Hide resolved
WalletWasabi.Daemon/Config.cs Outdated Show resolved Hide resolved
WalletWasabi.Daemon/Config.cs Outdated Show resolved Hide resolved
WalletWasabi.Daemon/Config.cs Outdated Show resolved Hide resolved
WalletWasabi.Daemon/Config.cs Outdated Show resolved Hide resolved
WalletWasabi.Daemon/Config.cs Outdated Show resolved Hide resolved
@lontivero
Copy link
Collaborator Author

@yahiheb the location is URL because is to identify a resource in the internet. URI is a bit more generic.

This is an URI:

bitcoin:175tWpb8K1S7NmH4Zx6rewF9WQrcZv245W?amount=20.3&label=Luke-Jr

while this one is an URL:

https://github.com/zkSNACKs/WalletWasabi/pull/11739

It is also an URI but URL is more accurate term for these kind of resources.

@yahiheb
Copy link
Collaborator

yahiheb commented Oct 27, 2023

@yahiheb the location is URL because is to identify a resource in the internet. URI is a bit more generic.

My bad, I changed that back to URL.

@kiminuo
Copy link
Collaborator

kiminuo commented Oct 27, 2023

@yahiheb the location is URL because is to identify a resource in the internet. URI is a bit more generic.

This is an URI:

bitcoin:175tWpb8K1S7NmH4Zx6rewF9WQrcZv245W?amount=20.3&label=Luke-Jr

while this one is an URL:

https://github.com/zkSNACKs/WalletWasabi/pull/11739

It is also an URI but URL is more accurate term for these kind of resources.

That was my suggestion actually. Anyway, isn't it a bit weird to have a parameter name ending with "uri" and a corresponding help text starting with "URL ..."? Anyway, either is fine with me.

btw: Adding default values for config options would be another worthy improvement IMO. See, eg, https://linux.die.net/man/1/tor:

image

@lontivero
Copy link
Collaborator Author

Ok, let's go with URI then, it's not wrong. I added the default values in the first version but it was difficult to explain where those values came from, that's why i removed them.

Co-authored-by: Kimi <58662979+kiminuo@users.noreply.github.com>
@lontivero lontivero changed the title [WIP] Add some help to the command line Add some help to the command line Nov 1, 2023
@lontivero lontivero marked this pull request as ready for review November 1, 2023 14:13
"Stop the Tor process when Wasabi is closed",
GetBoolValue("TerminateTorOnExit", PersistentConfig.TerminateTorOnExit, cliArgs)),
[ nameof(DownloadNewVersion)] = (
"Automatically download any new released version of Wasabi",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it any new version, or just the major version?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

any new version.
In the GUI the update available message is only with major version.
Auto download always gets the latest release

@lontivero lontivero merged commit 36e8cbf into WalletWasabi:master Nov 1, 2023
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants