Add comments to joinmarket.nix

2024-07-23 09:29:02 +02:00
parent ac4ea8fa10
commit 0e317a5a1b
1 changed files with 16 additions and 2 deletions
@@ -1,5 +1,19 @@
+### JOINMARKET
 {
-  services.joinmarket = {
+  services = {
+    joinmarket = {
+    # Set this to enable the JoinMarket service, including its command-line scripts.
+    # These scripts have prefix 'jm-', like 'jm-tumbler'.
+    # Note: JoinMarket has full access to bitcoind, including its wallet functionality.
    enable = true;
+    # 
+    # Set this to enable the JoinMarket Yield Generator Bot. You will be able to
+    # earn sats by providing CoinJoin liquidity. This makes it impossible to use other
+    # scripts that access your wallet.
+    # services.joinmarket.yieldgenerator.enable = true;
+    #
+    };
+    # Set this to enable the JoinMarket order book watcher.
+    joinmarket-ob-watcher.enable = true;
  }; 
 }