heierbtc/nix-bitcoin
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
3d26f72b7f
nix-bitcoin/modules/joinmarket.nix

409 lines
13 KiB
Nix
Raw Normal View History

joinmarket: add module
2020-04-23 16:18:47 +00:00
{ config, lib, pkgs, ... }:
with lib;
let
modules: move options to the top This greatly improves readability and makes it easier to discover options. This commit was genereated by running the following script inside the repo root dir: #!/usr/bin/env ruby def transform(src) return false if src.include?('inherit options;') success = false options = nil src.sub!(/^ options.*?^ }.*?;/m) do |match| options = match " inherit options;" end return false if !options src.sub!(/^with lib;\s*let\n+/m) do |match| success = true <<~EOF with lib; let #{options} EOF end success end Dir['modules/**/*.nix'].each do |f| src = File.read(f) if transform(src) puts "Changed file #{f}" File.write(f, src) end end
2021-09-13 11:40:47 +00:00
options.services.joinmarket = {
pkgs: add `meta` attr Also add more detailed `enable` option descriptions.
2021-12-14 18:51:23 +00:00
enable = mkEnableOption "JoinMarket, a Bitcoin CoinJoin implementation";
joinmarket: 0.9.2 -> 0.9.3
2021-10-24 19:14:09 +00:00
payjoinAddress = mkOption {
type = types.str;
default = "127.0.0.1";
treewide: use `mdDoc` for descriptions Enable markdown syntax (instead of docbook) for descriptions. This only affects external doc tooling that renders the descriptions.
2022-12-18 12:13:47 +00:00
description = mdDoc ''
joinmarket: 0.9.2 -> 0.9.3
2021-10-24 19:14:09 +00:00
The address where payjoin onion connections are forwarded to.
This address is never used directly, it only serves as the internal endpoint
for the payjoin onion service.
The onion service is automatically setup by joinmarket and accepts
connections at port 80.
'';
};
payjoinPort = mkOption {
type = types.port;
default = 64180; # A random private port
treewide: use `mdDoc` for descriptions Enable markdown syntax (instead of docbook) for descriptions. This only affects external doc tooling that renders the descriptions.
2022-12-18 12:13:47 +00:00
description = mdDoc "The port corresponding to option {option}`payjoinAddress`.";
joinmarket: 0.9.2 -> 0.9.3
2021-10-24 19:14:09 +00:00
};
joinmarket: 0.9.5 -> 0.9.6
2022-05-27 09:06:14 +00:00
messagingAddress = mkOption {
type = types.str;
default = "127.0.0.1";
treewide: use `mdDoc` for descriptions Enable markdown syntax (instead of docbook) for descriptions. This only affects external doc tooling that renders the descriptions.
2022-12-18 12:13:47 +00:00
description = mdDoc ''
joinmarket: 0.9.5 -> 0.9.6
2022-05-27 09:06:14 +00:00
The address where messaging onion connections are forwarded to.
This address is never used directly, it only serves as the internal endpoint
for the messaging onion service.
The onion service is automatically setup by joinmarket.
'';
};
messagingPort = mkOption {
type = types.port;
default = 64181; # payjoinPort + 1
treewide: use `mdDoc` for descriptions Enable markdown syntax (instead of docbook) for descriptions. This only affects external doc tooling that renders the descriptions.
2022-12-18 12:13:47 +00:00
description = mdDoc "The port corresponding to option {option}`messagingAddress`.";
joinmarket: 0.9.5 -> 0.9.6
2022-05-27 09:06:14 +00:00
};
modules: move options to the top This greatly improves readability and makes it easier to discover options. This commit was genereated by running the following script inside the repo root dir: #!/usr/bin/env ruby def transform(src) return false if src.include?('inherit options;') success = false options = nil src.sub!(/^ options.*?^ }.*?;/m) do |match| options = match " inherit options;" end return false if !options src.sub!(/^with lib;\s*let\n+/m) do |match| success = true <<~EOF with lib; let #{options} EOF end success end Dir['modules/**/*.nix'].each do |f| src = File.read(f) if transform(src) puts "Changed file #{f}" File.write(f, src) end end
2021-09-13 11:40:47 +00:00
dataDir = mkOption {
type = types.path;
default = "/var/lib/joinmarket";
treewide: use `mdDoc` for descriptions Enable markdown syntax (instead of docbook) for descriptions. This only affects external doc tooling that renders the descriptions.
2022-12-18 12:13:47 +00:00
description = mdDoc "The data directory for JoinMarket.";
modules: move options to the top This greatly improves readability and makes it easier to discover options. This commit was genereated by running the following script inside the repo root dir: #!/usr/bin/env ruby def transform(src) return false if src.include?('inherit options;') success = false options = nil src.sub!(/^ options.*?^ }.*?;/m) do |match| options = match " inherit options;" end return false if !options src.sub!(/^with lib;\s*let\n+/m) do |match| success = true <<~EOF with lib; let #{options} EOF end success end Dir['modules/**/*.nix'].each do |f| src = File.read(f) if transform(src) puts "Changed file #{f}" File.write(f, src) end end
2021-09-13 11:40:47 +00:00
};
modules: move user/group options to bottom These are insignificant, generic options; place them above readonly options. We already do this in other services. Also move user/group config to bottom in spark-wallet.
2021-09-13 11:40:48 +00:00
rpcWalletFile = mkOption {
type = types.nullOr types.str;
default = "jm_wallet";
treewide: use `mdDoc` for descriptions Enable markdown syntax (instead of docbook) for descriptions. This only affects external doc tooling that renders the descriptions.
2022-12-18 12:13:47 +00:00
description = mdDoc ''
modules: move user/group options to bottom These are insignificant, generic options; place them above readonly options. We already do this in other services. Also move user/group config to bottom in spark-wallet.
2021-09-13 11:40:48 +00:00
Name of the watch-only bitcoind wallet the JoinMarket addresses are imported to.
'';
};
modules: move options to the top This greatly improves readability and makes it easier to discover options. This commit was genereated by running the following script inside the repo root dir: #!/usr/bin/env ruby def transform(src) return false if src.include?('inherit options;') success = false options = nil src.sub!(/^ options.*?^ }.*?;/m) do |match| options = match " inherit options;" end return false if !options src.sub!(/^with lib;\s*let\n+/m) do |match| success = true <<~EOF with lib; let #{options} EOF end success end Dir['modules/**/*.nix'].each do |f| src = File.read(f) if transform(src) puts "Changed file #{f}" File.write(f, src) end end
2021-09-13 11:40:47 +00:00
user = mkOption {
type = types.str;
default = "joinmarket";
treewide: use `mdDoc` for descriptions Enable markdown syntax (instead of docbook) for descriptions. This only affects external doc tooling that renders the descriptions.
2022-12-18 12:13:47 +00:00
description = mdDoc "The user as which to run JoinMarket.";
modules: move options to the top This greatly improves readability and makes it easier to discover options. This commit was genereated by running the following script inside the repo root dir: #!/usr/bin/env ruby def transform(src) return false if src.include?('inherit options;') success = false options = nil src.sub!(/^ options.*?^ }.*?;/m) do |match| options = match " inherit options;" end return false if !options src.sub!(/^with lib;\s*let\n+/m) do |match| success = true <<~EOF with lib; let #{options} EOF end success end Dir['modules/**/*.nix'].each do |f| src = File.read(f) if transform(src) puts "Changed file #{f}" File.write(f, src) end end
2021-09-13 11:40:47 +00:00
};
group = mkOption {
type = types.str;
default = cfg.user;
treewide: use `mdDoc` for descriptions Enable markdown syntax (instead of docbook) for descriptions. This only affects external doc tooling that renders the descriptions.
2022-12-18 12:13:47 +00:00
description = mdDoc "The group as which to run JoinMarket.";
modules: move options to the top This greatly improves readability and makes it easier to discover options. This commit was genereated by running the following script inside the repo root dir: #!/usr/bin/env ruby def transform(src) return false if src.include?('inherit options;') success = false options = nil src.sub!(/^ options.*?^ }.*?;/m) do |match| options = match " inherit options;" end return false if !options src.sub!(/^with lib;\s*let\n+/m) do |match| success = true <<~EOF with lib; let #{options} EOF end success end Dir['modules/**/*.nix'].each do |f| src = File.read(f) if transform(src) puts "Changed file #{f}" File.write(f, src) end end
2021-09-13 11:40:47 +00:00
};
cli = mkOption {
default = cli;
treewide: add `defaultText` (manual) This enables generating module option documentation. Add `defaultText` to options where the default value can't be evaluated during metadata generation.
2021-12-08 03:07:27 +00:00
defaultText = "(See source)";
modules: move options to the top This greatly improves readability and makes it easier to discover options. This commit was genereated by running the following script inside the repo root dir: #!/usr/bin/env ruby def transform(src) return false if src.include?('inherit options;') success = false options = nil src.sub!(/^ options.*?^ }.*?;/m) do |match| options = match " inherit options;" end return false if !options src.sub!(/^with lib;\s*let\n+/m) do |match| success = true <<~EOF with lib; let #{options} EOF end success end Dir['modules/**/*.nix'].each do |f| src = File.read(f) if transform(src) puts "Changed file #{f}" File.write(f, src) end end
2021-09-13 11:40:47 +00:00
};
joinmarket: share IRC server definitions between jm and ob-watcher Also add server name comments.
2021-10-13 12:44:36 +00:00
# Used by ./joinmarket-ob-watcher.nix
joinmarket: 0.9.5 -> 0.9.6
2022-05-27 09:06:14 +00:00
messagingConfig = mkOption {
joinmarket: share IRC server definitions between jm and ob-watcher Also add server name comments.
2021-10-13 12:44:36 +00:00
readOnly = true;
joinmarket: 0.9.5 -> 0.9.6
2022-05-27 09:06:14 +00:00
default = messagingConfig;
treewide: add `defaultText` (manual) This enables generating module option documentation. Add `defaultText` to options where the default value can't be evaluated during metadata generation.
2021-12-08 03:07:27 +00:00
defaultText = "(See source)";
joinmarket: share IRC server definitions between jm and ob-watcher Also add server name comments.
2021-10-13 12:44:36 +00:00
};
services: add `tor.*` options Split `enforceTor` into `tor.proxy` and `tor.enforce`. By enabling `tor.proxy` without `tor.enforce`, a service can accept incoming clearnet connections. E.g., this allows setting up a Tor-proxied bitcoind node that accepts RPC connections from LAN.
2021-11-28 20:24:49 +00:00
# This option is only used by netns-isolation.
# Tor is always enabled.
tor.enforce = nbLib.tor.enforce;
modules: move options to the top This greatly improves readability and makes it easier to discover options. This commit was genereated by running the following script inside the repo root dir: #!/usr/bin/env ruby def transform(src) return false if src.include?('inherit options;') success = false options = nil src.sub!(/^ options.*?^ }.*?;/m) do |match| options = match " inherit options;" end return false if !options src.sub!(/^with lib;\s*let\n+/m) do |match| success = true <<~EOF with lib; let #{options} EOF end success end Dir['modules/**/*.nix'].each do |f| src = File.read(f) if transform(src) puts "Changed file #{f}" File.write(f, src) end end
2021-09-13 11:40:47 +00:00
inherit (nbLib) cliExec;
yieldgenerator = {
pkgs: add `meta` attr Also add more detailed `enable` option descriptions.
2021-12-14 18:51:23 +00:00
enable = mkEnableOption "JoinMarket yield generator bot";
modules: move options to the top This greatly improves readability and makes it easier to discover options. This commit was genereated by running the following script inside the repo root dir: #!/usr/bin/env ruby def transform(src) return false if src.include?('inherit options;') success = false options = nil src.sub!(/^ options.*?^ }.*?;/m) do |match| options = match " inherit options;" end return false if !options src.sub!(/^with lib;\s*let\n+/m) do |match| success = true <<~EOF with lib; let #{options} EOF end success end Dir['modules/**/*.nix'].each do |f| src = File.read(f) if transform(src) puts "Changed file #{f}" File.write(f, src) end end
2021-09-13 11:40:47 +00:00
ordertype = mkOption {
type = types.enum [ "reloffer" "absoffer" ];
default = "reloffer";
treewide: use `mdDoc` for descriptions Enable markdown syntax (instead of docbook) for descriptions. This only affects external doc tooling that renders the descriptions.
2022-12-18 12:13:47 +00:00
description = mdDoc ''
Which fee type to actually use.
modules: move options to the top This greatly improves readability and makes it easier to discover options. This commit was genereated by running the following script inside the repo root dir: #!/usr/bin/env ruby def transform(src) return false if src.include?('inherit options;') success = false options = nil src.sub!(/^ options.*?^ }.*?;/m) do |match| options = match " inherit options;" end return false if !options src.sub!(/^with lib;\s*let\n+/m) do |match| success = true <<~EOF with lib; let #{options} EOF end success end Dir['modules/**/*.nix'].each do |f| src = File.read(f) if transform(src) puts "Changed file #{f}" File.write(f, src) end end
2021-09-13 11:40:47 +00:00
'';
};
cjfee_a = mkOption {
type = types.ints.unsigned;
default = 500;
treewide: use `mdDoc` for descriptions Enable markdown syntax (instead of docbook) for descriptions. This only affects external doc tooling that renders the descriptions.
2022-12-18 12:13:47 +00:00
description = mdDoc ''
Absolute offer fee you wish to receive for coinjoins (cj) in Satoshis.
modules: move options to the top This greatly improves readability and makes it easier to discover options. This commit was genereated by running the following script inside the repo root dir: #!/usr/bin/env ruby def transform(src) return false if src.include?('inherit options;') success = false options = nil src.sub!(/^ options.*?^ }.*?;/m) do |match| options = match " inherit options;" end return false if !options src.sub!(/^with lib;\s*let\n+/m) do |match| success = true <<~EOF with lib; let #{options} EOF end success end Dir['modules/**/*.nix'].each do |f| src = File.read(f) if transform(src) puts "Changed file #{f}" File.write(f, src) end end
2021-09-13 11:40:47 +00:00
'';
};
cjfee_r = mkOption {
type = types.float;
default = 0.00002;
treewide: use `mdDoc` for descriptions Enable markdown syntax (instead of docbook) for descriptions. This only affects external doc tooling that renders the descriptions.
2022-12-18 12:13:47 +00:00
description = mdDoc ''
Relative offer fee you wish to receive based on a cj's amount.
modules: move options to the top This greatly improves readability and makes it easier to discover options. This commit was genereated by running the following script inside the repo root dir: #!/usr/bin/env ruby def transform(src) return false if src.include?('inherit options;') success = false options = nil src.sub!(/^ options.*?^ }.*?;/m) do |match| options = match " inherit options;" end return false if !options src.sub!(/^with lib;\s*let\n+/m) do |match| success = true <<~EOF with lib; let #{options} EOF end success end Dir['modules/**/*.nix'].each do |f| src = File.read(f) if transform(src) puts "Changed file #{f}" File.write(f, src) end end
2021-09-13 11:40:47 +00:00
'';
};
cjfee_factor = mkOption {
type = types.float;
default = 0.1;
treewide: use `mdDoc` for descriptions Enable markdown syntax (instead of docbook) for descriptions. This only affects external doc tooling that renders the descriptions.
2022-12-18 12:13:47 +00:00
description = mdDoc ''
Variance around the average cj fee.
modules: move options to the top This greatly improves readability and makes it easier to discover options. This commit was genereated by running the following script inside the repo root dir: #!/usr/bin/env ruby def transform(src) return false if src.include?('inherit options;') success = false options = nil src.sub!(/^ options.*?^ }.*?;/m) do |match| options = match " inherit options;" end return false if !options src.sub!(/^with lib;\s*let\n+/m) do |match| success = true <<~EOF with lib; let #{options} EOF end success end Dir['modules/**/*.nix'].each do |f| src = File.read(f) if transform(src) puts "Changed file #{f}" File.write(f, src) end end
2021-09-13 11:40:47 +00:00
'';
};
txfee = mkOption {
type = types.ints.unsigned;
default = 100;
treewide: use `mdDoc` for descriptions Enable markdown syntax (instead of docbook) for descriptions. This only affects external doc tooling that renders the descriptions.
2022-12-18 12:13:47 +00:00
description = mdDoc ''
The average transaction fee you're adding to coinjoin transactions.
modules: move options to the top This greatly improves readability and makes it easier to discover options. This commit was genereated by running the following script inside the repo root dir: #!/usr/bin/env ruby def transform(src) return false if src.include?('inherit options;') success = false options = nil src.sub!(/^ options.*?^ }.*?;/m) do |match| options = match " inherit options;" end return false if !options src.sub!(/^with lib;\s*let\n+/m) do |match| success = true <<~EOF with lib; let #{options} EOF end success end Dir['modules/**/*.nix'].each do |f| src = File.read(f) if transform(src) puts "Changed file #{f}" File.write(f, src) end end
2021-09-13 11:40:47 +00:00
'';
};
joinmarket: 0.9.2 -> 0.9.3
2021-10-24 19:14:09 +00:00
txfee_contribution_factor = mkOption {
modules: move options to the top This greatly improves readability and makes it easier to discover options. This commit was genereated by running the following script inside the repo root dir: #!/usr/bin/env ruby def transform(src) return false if src.include?('inherit options;') success = false options = nil src.sub!(/^ options.*?^ }.*?;/m) do |match| options = match " inherit options;" end return false if !options src.sub!(/^with lib;\s*let\n+/m) do |match| success = true <<~EOF with lib; let #{options} EOF end success end Dir['modules/**/*.nix'].each do |f| src = File.read(f) if transform(src) puts "Changed file #{f}" File.write(f, src) end end
2021-09-13 11:40:47 +00:00
type = types.float;
default = 0.3;
treewide: use `mdDoc` for descriptions Enable markdown syntax (instead of docbook) for descriptions. This only affects external doc tooling that renders the descriptions.
2022-12-18 12:13:47 +00:00
description = mdDoc ''
Variance around the average tx fee.
modules: move options to the top This greatly improves readability and makes it easier to discover options. This commit was genereated by running the following script inside the repo root dir: #!/usr/bin/env ruby def transform(src) return false if src.include?('inherit options;') success = false options = nil src.sub!(/^ options.*?^ }.*?;/m) do |match| options = match " inherit options;" end return false if !options src.sub!(/^with lib;\s*let\n+/m) do |match| success = true <<~EOF with lib; let #{options} EOF end success end Dir['modules/**/*.nix'].each do |f| src = File.read(f) if transform(src) puts "Changed file #{f}" File.write(f, src) end end
2021-09-13 11:40:47 +00:00
'';
};
minsize = mkOption {
type = types.ints.unsigned;
default = 100000;
treewide: use `mdDoc` for descriptions Enable markdown syntax (instead of docbook) for descriptions. This only affects external doc tooling that renders the descriptions.
2022-12-18 12:13:47 +00:00
description = mdDoc ''
modules: move options to the top This greatly improves readability and makes it easier to discover options. This commit was genereated by running the following script inside the repo root dir: #!/usr/bin/env ruby def transform(src) return false if src.include?('inherit options;') success = false options = nil src.sub!(/^ options.*?^ }.*?;/m) do |match| options = match " inherit options;" end return false if !options src.sub!(/^with lib;\s*let\n+/m) do |match| success = true <<~EOF with lib; let #{options} EOF end success end Dir['modules/**/*.nix'].each do |f| src = File.read(f) if transform(src) puts "Changed file #{f}" File.write(f, src) end end
2021-09-13 11:40:47 +00:00
Minimum size of your cj offer in Satoshis. Lower cj amounts will be disregarded.
'';
};
size_factor = mkOption {
type = types.float;
default = 0.1;
treewide: use `mdDoc` for descriptions Enable markdown syntax (instead of docbook) for descriptions. This only affects external doc tooling that renders the descriptions.
2022-12-18 12:13:47 +00:00
description = mdDoc ''
Variance around all offer sizes.
modules: move options to the top This greatly improves readability and makes it easier to discover options. This commit was genereated by running the following script inside the repo root dir: #!/usr/bin/env ruby def transform(src) return false if src.include?('inherit options;') success = false options = nil src.sub!(/^ options.*?^ }.*?;/m) do |match| options = match " inherit options;" end return false if !options src.sub!(/^with lib;\s*let\n+/m) do |match| success = true <<~EOF with lib; let #{options} EOF end success end Dir['modules/**/*.nix'].each do |f| src = File.read(f) if transform(src) puts "Changed file #{f}" File.write(f, src) end end
2021-09-13 11:40:47 +00:00
'';
};
};
};
joinmarket: add module
2020-04-23 16:18:47 +00:00
cfg = config.services.joinmarket;
rename nix-bitcoin-services.nix -> lib.nix
2021-02-03 21:44:41 +00:00
nbLib = config.nix-bitcoin.lib;
add option nix-bitcoin.pkgs, remove overlay This works around a nixpkgs bug where overlays are ignored in containers.
2020-11-09 21:09:09 +00:00
nbPkgs = config.nix-bitcoin.pkgs;
joinmarket: add module
2020-04-23 16:18:47 +00:00
secretsDir = config.nix-bitcoin.secretsDir;
services: use doas if enabled - Remove sudo from recurring-donations path because it's not used by the service - Use doas instead of sudo in secure-node.nix
2021-01-30 22:08:43 +00:00
runAsUser = config.nix-bitcoin.runAsUserCmd;
joinmarket: add module
2020-04-23 16:18:47 +00:00
joinmarket: add variable 'bitcoind'
2020-10-16 15:43:13 +00:00
inherit (config.services) bitcoind;
services: use new 'tor' options
2021-08-04 22:49:00 +00:00
torAddress = config.services.tor.client.socksListenAddress;
socks5Settings = ''
socks5 = true
socks5_host = ${torAddress.addr}
socks5_port = ${toString torAddress.port}
'';
joinmarket: 0.9.5 -> 0.9.6
2022-05-27 09:06:14 +00:00
messagingConfig = ''
[MESSAGING:onion]
type = onion
${socks5Settings}
tor_control_host = unix:/run/tor/control
# required option, but ignored for unix socket host
tor_control_port = 9051
onion_serving_host = ${cfg.messagingAddress}
onion_serving_port = ${toString cfg.messagingPort}
hidden_service_dir =
directory_nodes = 3kxw6lf5vf6y26emzwgibzhrzhmhqiw6ekrek3nqfjjmhwznb2moonad.onion:5222,jmdirjmioywe2s5jad7ts6kgcqg66rj6wujj6q77n6wbdrgocqwexzid.onion:5222,bqlpq6ak24mwvuixixitift4yu42nxchlilrcqwk2ugn45tdclg42qid.onion:5222
joinmarket: share IRC server definitions between jm and ob-watcher Also add server name comments.
2021-10-13 12:44:36 +00:00
# irc.darkscience.net
[MESSAGING:server1]
host = darkirc6tqgpnwd3blln3yfv5ckl47eg7llfxkmtovrv7c7iwohhb6ad.onion
channel = joinmarket-pit
port = 6697
usessl = true
${socks5Settings}
joinmarket: 0.9.5 -> 0.9.6
2022-05-27 09:06:14 +00:00
# ilita
joinmarket: share IRC server definitions between jm and ob-watcher Also add server name comments.
2021-10-13 12:44:36 +00:00
[MESSAGING:server2]
joinmarket: 0.9.5 -> 0.9.6
2022-05-27 09:06:14 +00:00
host = ilitafrzzgxymv6umx2ux7kbz3imyeko6cnqkvy4nisjjj4qpqkrptid.onion
joinmarket: share IRC server definitions between jm and ob-watcher Also add server name comments.
2021-10-13 12:44:36 +00:00
channel = joinmarket-pit
port = 6667
usessl = false
${socks5Settings}
joinmarket: enable Agora as a third IRC server
2021-10-13 12:45:52 +00:00
joinmarket: 0.9.5 -> 0.9.6
2022-05-27 09:06:14 +00:00
# irc.hackint.org
joinmarket: 0.9.4 -> 0.9.5 Notes - We can no longer test for `unknown error in JSON-RPC`. `jm-ob-watcher` now simply outputs `Starting ob-watcher`. Tested working on https://nixbitcoin.org/orderbook. - Removed Agora IRC server since it is offline semi-permanently. Should probably also be removed upstream. - Includes patch for https://github.com/JoinMarket-Org/joinmarket-clientserver/issues/1193
2022-02-22 13:49:19 +00:00
[MESSAGING:server3]
joinmarket: 0.9.5 -> 0.9.6
2022-05-27 09:06:14 +00:00
host = ncwkrwxpq2ikcngxq3dy2xctuheniggtqeibvgofixpzvrwpa77tozqd.onion
joinmarket: 0.9.3 -> 0.9.4 Ilita IRC server & use upstream twisted again
2021-12-08 12:16:14 +00:00
channel = joinmarket-pit
port = 6667
usessl = false
${socks5Settings}
joinmarket: share IRC server definitions between jm and ob-watcher Also add server name comments.
2021-10-13 12:44:36 +00:00
'';
joinmarket: move comment out of config file
2020-10-16 15:43:14 +00:00
# Based on https://github.com/JoinMarket-Org/joinmarket-clientserver/blob/master/jmclient/jmclient/configure.py
joinmarket: 0.8.0-a5e8879 -> 0.8.1 - Update joinmarket package - Revert unofficial release settings - Move Yield Generator config to configFile - Add new config option max_sweep_fee_change
2021-02-10 14:02:05 +00:00
yg = cfg.yieldgenerator;
joinmarket: add module
2020-04-23 16:18:47 +00:00
configFile = builtins.toFile "config" ''
[DAEMON]
no_daemon = 0
daemon_port = 27183
daemon_host = localhost
use_ssl = false
[BLOCKCHAIN]
test: make joinmarket work with regtest
2021-10-25 13:30:53 +00:00
blockchain_source = ${bitcoind.makeNetworkName "bitcoin-rpc" "regtest"}
network = ${bitcoind.makeNetworkName "mainnet" "testnet"}
services: support 0.0.0.0/:: in `address` options Previously, client services didn't decode these special INADDR_ANY addresses and failed to connect.
2021-10-01 09:51:57 +00:00
rpc_host = ${nbLib.address bitcoind.rpc.address}
joinmarket: don't hardcode bitcoind rpc port
2020-10-16 15:43:15 +00:00
rpc_port = ${toString bitcoind.rpc.port}
joinmarket: add variable 'bitcoind'
2020-10-16 15:43:13 +00:00
rpc_user = ${bitcoind.rpc.users.privileged.name}
joinmarket: create bitcoind wallet Starting with 0.21.0, bitcoin no longer automatically creates and loads a default wallet. This was being ignored because of a JoinMarket issue [1] in CI builds prior to this version. Now a watch-only Bitcoin Core wallet is created in ExecStartPost. [1] https://github.com/JoinMarket-Org/joinmarket-clientserver/issues/812
2021-08-08 08:58:49 +00:00
${optionalString (cfg.rpcWalletFile != null) "rpc_wallet_file = ${cfg.rpcWalletFile}"}
joinmarket: add module
2020-04-23 16:18:47 +00:00
joinmarket: 0.9.5 -> 0.9.6
2022-05-27 09:06:14 +00:00
${messagingConfig}
joinmarket: add module
2020-04-23 16:18:47 +00:00
[LOGGING]
console_log_level = INFO
color = false
[POLICY]
segwit = true
joinmarket: 0.7.4 -> 0.8.0-bcfa7eb Update to 0.8.0 with hotfix for genwallet script Includes module versioning error with migration instructions
2020-12-14 17:12:11 +00:00
native = true
joinmarket: add module
2020-04-23 16:18:47 +00:00
merge_algorithm = default
tx_fees = 3
joinmarket: 0.9.2 -> 0.9.3
2021-10-24 19:14:09 +00:00
tx_fees_factor = 0.2
joinmarket: add module
2020-04-23 16:18:47 +00:00
absurd_fee_per_kb = 350000
joinmarket: 0.8.0-a5e8879 -> 0.8.1 - Update joinmarket package - Revert unofficial release settings - Move Yield Generator config to configFile - Add new config option max_sweep_fee_change
2021-02-10 14:02:05 +00:00
max_sweep_fee_change = 0.8
joinmarket: add module
2020-04-23 16:18:47 +00:00
tx_broadcast = self
minimum_makers = 4
max_sats_freeze_reuse = -1
joinmarket: fix fidelity bond default values
2022-01-11 11:05:42 +00:00
interest_rate = 0.015
bondless_makers_allowance = 0.125
joinmarket: 0.9.5 -> 0.9.6
2022-05-27 09:06:14 +00:00
bond_value_exponent = 1.3
joinmarket: add module
2020-04-23 16:18:47 +00:00
taker_utxo_retries = 3
taker_utxo_age = 5
taker_utxo_amtpercent = 20
accept_commitment_broadcasts = 1
commit_file_location = cmtdata/commitments.json
joinmarket: 0.9.5 -> 0.9.6
2022-05-27 09:06:14 +00:00
commitment_list_location = cmtdata/commitmentlist
joinmarket: add payjoin configuration
2020-10-29 12:46:36 +00:00
[PAYJOIN]
payjoin_version = 1
disable_output_substitution = 0
max_additional_fee_contribution = default
min_fee_rate = 1.1
services: use new 'tor' options
2021-08-04 22:49:00 +00:00
onion_socks5_host = ${torAddress.addr}
onion_socks5_port = ${toString torAddress.port}
joinmarket: add payjoin configuration
2020-10-29 12:46:36 +00:00
tor_control_host = unix:/run/tor/control
joinmarket: 0.9.5 -> 0.9.6
2022-05-27 09:06:14 +00:00
# Required option, but unused because `tor_control_host` is a Unix socket
tor_control_port = 9051
joinmarket: 0.9.2 -> 0.9.3
2021-10-24 19:14:09 +00:00
onion_serving_host = ${cfg.payjoinAddress}
onion_serving_port = ${toString cfg.payjoinPort}
joinmarket: add payjoin configuration
2020-10-29 12:46:36 +00:00
hidden_service_ssl = false
joinmarket: 0.8.0-a5e8879 -> 0.8.1 - Update joinmarket package - Revert unofficial release settings - Move Yield Generator config to configFile - Add new config option max_sweep_fee_change
2021-02-10 14:02:05 +00:00
[YIELDGENERATOR]
ordertype = ${yg.ordertype}
cjfee_a = ${toString yg.cjfee_a}
cjfee_r = ${toString yg.cjfee_r}
cjfee_factor = ${toString yg.cjfee_factor}
joinmarket: 0.9.2 -> 0.9.3
2021-10-24 19:14:09 +00:00
txfee_contribution = 0
txfee_contribution_factor = ${toString yg.txfee_contribution_factor}
joinmarket: 0.8.0-a5e8879 -> 0.8.1 - Update joinmarket package - Revert unofficial release settings - Move Yield Generator config to configFile - Add new config option max_sweep_fee_change
2021-02-10 14:02:05 +00:00
minsize = ${toString yg.minsize}
size_factor = ${toString yg.size_factor}
gaplimit = 6
joinmarket: 0.8.1 -> 0.8.2 - add SNICKER to default config - update package - ob-watcher: copy vendorized js and css dependencies - add missing dependency to jmbase - use cryptography from pinned.nixpkgs-unstable
2021-03-09 16:48:25 +00:00
[SNICKER]
enabled = false
lowest_net_gain = 0
servers = cn5lfwvrswicuxn3gjsxoved6l2gu5hdvwy5l3ev7kg6j7lbji2k7hqd.onion,
polling_interval_minutes = 60
joinmarket: add module
2020-04-23 16:18:47 +00:00
'';
# The jm scripts create a 'logs' dir in the working dir,
# so run them inside dataDir.
cli = pkgs.runCommand "joinmarket-cli" {} ''
shellcheck: prevent globbing and word splitting in unit shell scripts
2022-07-31 21:32:12 +00:00
mkdir -p "$out/bin"
add option nix-bitcoin.pkgs, remove overlay This works around a nixpkgs bug where overlays are ignored in containers.
2020-11-09 21:09:09 +00:00
jm=${nbPkgs.joinmarket}/bin
shellcheck: prevent globbing and word splitting in unit shell scripts
2022-07-31 21:32:12 +00:00
cd "$jm"
joinmarket: add module
2020-04-23 16:18:47 +00:00
for bin in jm-*; do
{
echo "#!${pkgs.bash}/bin/bash";
shellcheck: prevent globbing and word splitting in unit shell scripts
2022-07-31 21:32:12 +00:00
echo "cd '${cfg.dataDir}' && ${cfg.cliExec} ${runAsUser} ${cfg.user} "$jm/$bin" --datadir='${cfg.dataDir}' \"\$@\"";
} > "$out/bin/$bin"
joinmarket: add module
2020-04-23 16:18:47 +00:00
done
shellcheck: prevent globbing and word splitting in unit shell scripts
2022-07-31 21:32:12 +00:00
chmod -R +x "$out/bin"
joinmarket: add module
2020-04-23 16:18:47 +00:00
'';
in {
modules: move options to the top This greatly improves readability and makes it easier to discover options. This commit was genereated by running the following script inside the repo root dir: #!/usr/bin/env ruby def transform(src) return false if src.include?('inherit options;') success = false options = nil src.sub!(/^ options.*?^ }.*?;/m) do |match| options = match " inherit options;" end return false if !options src.sub!(/^with lib;\s*let\n+/m) do |match| success = true <<~EOF with lib; let #{options} EOF end success end Dir['modules/**/*.nix'].each do |f| src = File.read(f) if transform(src) puts "Changed file #{f}" File.write(f, src) end end
2021-09-13 11:40:47 +00:00
inherit options;
joinmarket: add module
2020-04-23 16:18:47 +00:00
config = mkIf cfg.enable (mkMerge [{
services: use consistent layout Use the following order of definitions for all services: - assertions - configuration of other services - environment.systemPackages - tmpfiles - own service - users - secrets
2021-02-01 21:53:22 +00:00
services.bitcoind = {
enable = true;
disablewallet = false;
extract operator module
2020-09-28 11:09:03 +00:00
};
joinmarket: add module
2020-04-23 16:18:47 +00:00
services: use consistent layout Use the following order of definitions for all services: - assertions - configuration of other services - environment.systemPackages - tmpfiles - own service - users - secrets
2021-02-01 21:53:22 +00:00
# Joinmarket is Tor-only
joinmarket: add module
2020-04-23 16:18:47 +00:00
services.tor = {
enable = true;
client.enable = true;
joinmarket: explain need for tor control socket
2021-02-01 21:53:18 +00:00
# Needed for payjoin onion service creation
joinmarket: add payjoin configuration
2020-10-29 12:46:36 +00:00
controlSocket.enable = true;
joinmarket: add module
2020-04-23 16:18:47 +00:00
};
services: use consistent layout Use the following order of definitions for all services: - assertions - configuration of other services - environment.systemPackages - tmpfiles - own service - users - secrets
2021-02-01 21:53:22 +00:00
environment.systemPackages = [
(hiPrio cfg.cli)
];
systemd.tmpfiles.rules = [
"d '${cfg.dataDir}' 0770 ${cfg.user} ${cfg.group} - -"
];
joinmarket: add module
2020-04-23 16:18:47 +00:00
systemd.services.joinmarket = {
wantedBy = [ "multi-user.target" ];
requires = [ "bitcoind.service" ];
after = [ "bitcoind.service" ];
joinmarket: use preStart, postStart
2021-08-08 08:58:52 +00:00
preStart = ''
joinmarket: fix leaking passwords Previously, `bitcoin-rpcpassword-privileged` and `jm-wallet-password` were passed as world readable arguments to sed and jm-genwallet subprocesses.
2021-08-27 15:09:11 +00:00
{
cat ${configFile}
echo
echo '[BLOCKCHAIN]'
echo "rpc_password = $(cat ${secretsDir}/bitcoin-rpcpassword-privileged)"
} > '${cfg.dataDir}/joinmarket.cfg'
'';
test: make joinmarket work with regtest
2021-10-25 13:30:53 +00:00
postStart = ''
joinmarket: use preStart, postStart
2021-08-08 08:58:52 +00:00
walletname=wallet.jmdat
shellcheck: prevent globbing and word splitting in unit shell scripts
2022-07-31 21:32:12 +00:00
wallet="${cfg.dataDir}/wallets/$walletname"
joinmarket: use preStart, postStart
2021-08-08 08:58:52 +00:00
if [[ ! -f $wallet ]]; then
${optionalString (cfg.rpcWalletFile != null) ''
echo "Create watch-only wallet ${cfg.rpcWalletFile}"
joinmarket: allow recreating wallet from seed This allows users to easily upgrade their wallets to use Fidelity Bonds.
2021-08-27 12:37:44 +00:00
if ! output=$(${bitcoind.cli}/bin/bitcoin-cli -named createwallet \
test: make joinmarket work with regtest
2021-10-25 13:30:53 +00:00
wallet_name="${cfg.rpcWalletFile}" \
joinmarket: explicitly create no descriptor wallet The default value of `descriptors` has changed from `false` to `true` in Bitcoin Core 23.0.
2022-05-05 12:50:19 +00:00
descriptors=false \
test: make joinmarket work with regtest
2021-10-25 13:30:53 +00:00
${optionalString (!bitcoind.regtest) "disable_private_keys=true"} 2>&1
); then
joinmarket: allow recreating wallet from seed This allows users to easily upgrade their wallets to use Fidelity Bonds.
2021-08-27 12:37:44 +00:00
# Ignore error if bitcoind wallet already exists
if [[ $output != *"already exists"* ]]; then
echo "$output"
exit 1
fi
fi
joinmarket: use preStart, postStart
2021-08-08 08:58:52 +00:00
''}
shellcheck: prevent globbing and word splitting in unit shell scripts
2022-07-31 21:32:12 +00:00
joinmarket: allow recreating wallet from seed This allows users to easily upgrade their wallets to use Fidelity Bonds.
2021-08-27 12:37:44 +00:00
# Restore wallet from seed if available
shellcheck: prevent globbing and word splitting in unit shell scripts
2022-07-31 21:32:12 +00:00
seed=()
joinmarket: allow recreating wallet from seed This allows users to easily upgrade their wallets to use Fidelity Bonds.
2021-08-27 12:37:44 +00:00
if [[ -e jm-wallet-seed ]]; then
shellcheck: prevent globbing and word splitting in unit shell scripts
2022-07-31 21:32:12 +00:00
seed=(--recovery-seed-file jm-wallet-seed)
joinmarket: allow recreating wallet from seed This allows users to easily upgrade their wallets to use Fidelity Bonds.
2021-08-27 12:37:44 +00:00
fi
shellcheck: prevent globbing and word splitting in unit shell scripts
2022-07-31 21:32:12 +00:00
cd "${cfg.dataDir}"
joinmarket: fix leaking passwords Previously, `bitcoin-rpcpassword-privileged` and `jm-wallet-password` were passed as world readable arguments to sed and jm-genwallet subprocesses.
2021-08-27 15:09:11 +00:00
# Strip trailing newline from password file
shellcheck: prevent globbing and word splitting in unit shell scripts
2022-07-31 21:32:12 +00:00
if ! tr -d '\n' < '${secretsDir}/jm-wallet-password' \
joinmarket: fix leaking passwords Previously, `bitcoin-rpcpassword-privileged` and `jm-wallet-password` were passed as world readable arguments to sed and jm-genwallet subprocesses.
2021-08-27 15:09:11 +00:00
| ${nbPkgs.joinmarket}/bin/jm-genwallet \
shellcheck: prevent globbing and word splitting in unit shell scripts
2022-07-31 21:32:12 +00:00
--datadir="${cfg.dataDir}" --wallet-password-stdin "''${seed[@]}" "$walletname" \
| (if ((! ''${#seed[@]})); then
joinmarket: allow recreating wallet from seed This allows users to easily upgrade their wallets to use Fidelity Bonds.
2021-08-27 12:37:44 +00:00
umask u=r,go=
grep -ohP '(?<=recovery_seed:).*' > jm-wallet-seed
else
cat > /dev/null
fi); then
joinmarket: use preStart, postStart
2021-08-08 08:58:52 +00:00
echo "wallet creation failed"
rm -f "$wallet" jm-wallet-seed
exit 1
fi
fi
'';
serviceConfig = nbLib.defaultHardening // {
add option nix-bitcoin.pkgs, remove overlay This works around a nixpkgs bug where overlays are ignored in containers.
2020-11-09 21:09:09 +00:00
ExecStart = "${nbPkgs.joinmarket}/bin/joinmarketd";
treewide: remove unneeded string literals
2021-02-01 21:53:12 +00:00
WorkingDirectory = cfg.dataDir; # The service creates 'commitmentlist' in the working dir
User = cfg.user;
joinmarket: add module
2020-04-23 16:18:47 +00:00
Restart = "on-failure";
RestartSec = "10s";
services: set systemd list options as list values This makes our list definitions mergeable with custom list values set by users. Previously, a module error ("value is a string while a list was expected") was thrown instead. This commit was partly auto-generated with this script: #!/usr/bin/env ruby Dir["**/*.nix"].each do |file| src = File.read(file) fixed = src.gsub(/ReadWritePaths *= *(.*?);/) do "ReadWritePaths = [ #{$1} ];" end File.write(file, fixed) if fixed != src end
2022-05-07 18:34:21 +00:00
ReadWritePaths = [ cfg.dataDir ];
services: add `tor.*` options Split `enforceTor` into `tor.proxy` and `tor.enforce`. By enabling `tor.proxy` without `tor.enforce`, a service can accept incoming clearnet connections. E.g., this allows setting up a Tor-proxied bitcoind node that accepts RPC connections from LAN.
2021-11-28 20:24:49 +00:00
} // nbLib.allowedIPAddresses cfg.tor.enforce;
joinmarket: add module
2020-04-23 16:18:47 +00:00
};
services: use consistent layout Use the following order of definitions for all services: - assertions - configuration of other services - environment.systemPackages - tmpfiles - own service - users - secrets
2021-02-01 21:53:22 +00:00
users.users.${cfg.user} = {
services: set isSystemUser for service users 'isSystemUser' has to be explicitly set in NixOS 21.05. Previously, it was the implicit default.
2021-08-04 22:48:59 +00:00
isSystemUser = true;
services: use consistent layout Use the following order of definitions for all services: - assertions - configuration of other services - environment.systemPackages - tmpfiles - own service - users - secrets
2021-02-01 21:53:22 +00:00
group = cfg.group;
home = cfg.dataDir;
# Allow access to the tor control socket, needed for payjoin onion service creation
joinmarket: run with group 'bitcoin' Don't copy bitcoin-rpcpassword-privileged as root, instead run service with group "bitcoin". Same effect, less complexity. Note, PoLP still obeyed for joinmarket-ob-watcher.
2021-08-08 08:58:48 +00:00
extraGroups = [ "tor" "bitcoin" ];
services: use consistent layout Use the following order of definitions for all services: - assertions - configuration of other services - environment.systemPackages - tmpfiles - own service - users - secrets
2021-02-01 21:53:22 +00:00
};
users.groups.${cfg.group} = {};
nix-bitcoin.operator = {
groups = [ cfg.group ];
joinmarket: fix allowRunAsUsers setting This option requires user names instead of groups.
2021-08-15 09:28:38 +00:00
allowRunAsUsers = [ cfg.user ];
services: use consistent layout Use the following order of definitions for all services: - assertions - configuration of other services - environment.systemPackages - tmpfiles - own service - users - secrets
2021-02-01 21:53:22 +00:00
};
joinmarket: add module
2020-04-23 16:18:47 +00:00
nix-bitcoin.secrets.jm-wallet-password.user = cfg.user;
secrets: allow extending generate-secrets `generate-secrets` is no longer a monolithic script. Instead, it's composed of the values of option `nix-bitcoin.generateSecretsCmds`. This has the following advantages: - generate-secrets is now extensible by users - Only secrets of enabled services are generated - RPC IPs in the `lnd` and `loop` certs are no longer hardcoded. Secrets are no longer automatically generated when entering nix-shell. Instead, they are generated before deployment (via `krops-deploy`) because secrets generation is now dependant on the node configuration.
2021-09-08 15:01:18 +00:00
nix-bitcoin.generateSecretsCmds.joinmarket = ''
makePasswordSecret jm-wallet-password
'';
joinmarket: always synchronize secrets.jm-wallet-password secrets.jm-wallet-password is always needed by joinmarket, not just when joinmarket.yieldgenerator.enable
2020-12-30 15:02:42 +00:00
}
joinmarket: add module
2020-04-23 16:18:47 +00:00
joinmarket: always synchronize secrets.jm-wallet-password secrets.jm-wallet-password is always needed by joinmarket, not just when joinmarket.yieldgenerator.enable
2020-12-30 15:02:42 +00:00
(mkIf cfg.yieldgenerator.enable {
joinmarket: 0.8.0-a5e8879 -> 0.8.1 - Update joinmarket package - Revert unofficial release settings - Move Yield Generator config to configFile - Add new config option max_sweep_fee_change
2021-02-10 14:02:05 +00:00
systemd.services.joinmarket-yieldgenerator = {
joinmarket: add module
2020-04-23 16:18:47 +00:00
wantedBy = [ "joinmarket.service" ];
requires = [ "joinmarket.service" ];
after = [ "joinmarket.service" ];
joinmarket-yieldgenerator: simplify start script
2021-08-27 15:06:17 +00:00
script = ''
tr -d "\n" <"${secretsDir}/jm-wallet-password" \
| ${nbPkgs.joinmarket}/bin/jm-yg-privacyenhanced --datadir='${cfg.dataDir}' \
--wallet-password-stdin wallet.jmdat
joinmarket: add module
2020-04-23 16:18:47 +00:00
'';
rename nix-bitcoin-services.nix -> lib.nix
2021-02-03 21:44:41 +00:00
serviceConfig = nbLib.defaultHardening // rec {
treewide: remove unneeded string literals
2021-02-01 21:53:12 +00:00
WorkingDirectory = cfg.dataDir; # The service creates dir 'logs' in the working dir
joinmarket-yieldgenerator: improve systemd journal output Journal entries now look like `joinmarket-yieldgenerator[9795]: User data location: /var/lib/joinmarket` instead of `bash[9795]: User data location: /var/lib/joinmarket`
2021-02-01 21:53:20 +00:00
# Show "joinmarket-yieldgenerator" instead of "bash" in the journal.
joinmarket-yieldgenerator: simplify start script
2021-08-27 15:06:17 +00:00
# The start script has to run alongside the main process
joinmarket-yieldgenerator: improve systemd journal output Journal entries now look like `joinmarket-yieldgenerator[9795]: User data location: /var/lib/joinmarket` instead of `bash[9795]: User data location: /var/lib/joinmarket`
2021-02-01 21:53:20 +00:00
# because it provides the wallet password via stdin to the main process
SyslogIdentifier = "joinmarket-yieldgenerator";
treewide: remove unneeded string literals
2021-02-01 21:53:12 +00:00
User = cfg.user;
services: set systemd list options as list values This makes our list definitions mergeable with custom list values set by users. Previously, a module error ("value is a string while a list was expected") was thrown instead. This commit was partly auto-generated with this script: #!/usr/bin/env ruby Dir["**/*.nix"].each do |file| src = File.read(file) fixed = src.gsub(/ReadWritePaths *= *(.*?);/) do "ReadWritePaths = [ #{$1} ];" end File.write(file, fixed) if fixed != src end
2022-05-07 18:34:21 +00:00
ReadWritePaths = [ cfg.dataDir ];
rename nix-bitcoin-services.nix -> lib.nix
2021-02-03 21:44:41 +00:00
} // nbLib.allowTor;
joinmarket: add module
2020-04-23 16:18:47 +00:00
};
})
]);
}
Reference in New Issue Copy Permalink