jam icon indicating copy to clipboard operation
jam copied to clipboard

Documentation for `joinmarket.cfg`

Open dergigi opened this issue 3 years ago • 6 comments

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:

  • [x] Research joinmarket.cfg
  • [ ] Rank-order by importance and/or use-case
  • [ ] Write copy, find proper names and descriptions for settings (in cooperation with @GBKS)
  • [ ] Update the JM docs upstream

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

dergigi avatar Jan 28 '22 22:01 dergigi

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).

theborakompanioni avatar Jan 31 '22 13:01 theborakompanioni

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 avatar Feb 02 '22 10:02 dergigi

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

dergigi avatar Feb 02 '22 10:02 dergigi

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

editwentyone avatar Apr 05 '22 08:04 editwentyone