joinmarket-webui / jam

Your sats. Your privacy. Your profit.
https://jamapp.org
MIT License
264 stars 54 forks source link

Documentation for `joinmarket.cfg` #30

Open dergigi opened 2 years ago

dergigi commented 2 years ago

The full joinmarket.cfg config file contains many settings and multiple sections (daemon, blockchain, messaging, logging, timeout, policy, payjoin, yield generator), not all of which are immediately relevant to most users.

We should understand and document all settings, and break them down into two or three different sections, e.g. basic / advanced / expert.

Rough tasks list:

All of the above should serve as a base for implementing #12

theborakompanioni commented 2 years ago

Also, we need to come up with default values (or setting them by some other mechanism) for max_cj_fee_abs and/or max_cj_fee_rel as they are needed before sending payments via the jsonrpc api of jmwalletd (https://github.com/JoinMarket-Org/joinmarket-clientserver/blob/d98cb36fb422edefab969a911564987f7878f021/jmclient/jmclient/wallet_rpc.py#L837-L845).

dergigi commented 2 years ago

Yes, sane default values would be great. To set them properly we need to do some order book parsing as sketched out in #14 I'm afraid. However, we can probably do some guesstimates first and hide some complexity from the user.

dergigi commented 2 years ago

Started some work on this, see the "Configuration" page in the wiki.

editwentyone commented 2 years ago

this could also help: https://github.com/joinmarket-webui/joinmarket-webui/issues/72#issuecomment-1086865264