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

Documentation for joinmarket.cfg #30

Open
1 of 4 tasks
dergigi opened this issue Jan 28, 2022 · 4 comments
Open
1 of 4 tasks

Documentation for joinmarket.cfg #30

dergigi opened this issue Jan 28, 2022 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@dergigi
Copy link
Contributor

dergigi commented Jan 28, 2022

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:

  • 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 dergigi added the documentation Improvements or additions to documentation label Jan 28, 2022
@dergigi dergigi added this to the v0.0.3 - Make it Work milestone Jan 28, 2022
@dergigi dergigi self-assigned this Jan 28, 2022
@theborakompanioni
Copy link
Collaborator

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
Copy link
Contributor Author

dergigi commented Feb 2, 2022

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
Copy link
Contributor Author

dergigi commented Feb 2, 2022

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

@editwentyone
Copy link

this could also help: #72 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: No status
Development

No branches or pull requests

3 participants