Merge #290: JoinMarket Orderbook Watcher

8c125ec48c joinmarket-obwatcher: add pkg & module (nixbitcoin)
915df059f4 joinmarket: 0.8.0-bcfa7eb -> 0.8.0-a5e8879 (Erik Arvstedt)
254246cf39 joinmarket: use installPhase (Erik Arvstedt)

Pull request description:

ACKs for top commit:
  erikarvstedt:
    ACK 8c125ec48c

Tree-SHA512: 5e4ba14a2a90c505b7cd7e09c33548d06ec466502c48f8d551a4437c5542dab427ec7f9cb7a15c849cc7ce11685c493b9773ec08591e1980ebe2a84abef17141
This commit is contained in:
Jonas Nick 2021-01-17 20:00:00 +00:00
commit 035438d427
No known key found for this signature in database
GPG Key ID: 4861DBF262123605
12 changed files with 135 additions and 9 deletions

View File

@ -69,6 +69,7 @@ NixOS modules
* [liquid](https://github.com/elementsproject/elements) * [liquid](https://github.com/elementsproject/elements)
* [Lightning Loop](https://github.com/lightninglabs/loop) * [Lightning Loop](https://github.com/lightninglabs/loop)
* [JoinMarket](https://github.com/joinmarket-org/joinmarket-clientserver) * [JoinMarket](https://github.com/joinmarket-org/joinmarket-clientserver)
* [JoinMarket Orderbook Watcher](https://github.com/JoinMarket-Org/joinmarket-clientserver/blob/master/docs/orderbook.md)
* [recurring-donations](modules/recurring-donations.nix): for periodic lightning payments * [recurring-donations](modules/recurring-donations.nix): for periodic lightning payments
* [bitcoin-core-hwi](https://github.com/bitcoin-core/HWI) * [bitcoin-core-hwi](https://github.com/bitcoin-core/HWI)
* Helper * Helper

View File

@ -179,6 +179,8 @@
# earn sats by providing CoinJoin liquidity. This makes it impossible to use other # earn sats by providing CoinJoin liquidity. This makes it impossible to use other
# scripts that access your wallet. # scripts that access your wallet.
# services.joinmarket.yieldgenerator.enable = true; # services.joinmarket.yieldgenerator.enable = true;
# Enable this option to enable the JoinMarket order book watcher.
# services.joinmarket-ob-watcher.enable = true;
# FIXME: Define your hostname. # FIXME: Define your hostname.
networking.hostName = "nix-bitcoin"; networking.hostName = "nix-bitcoin";

View File

@ -0,0 +1,99 @@
{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.services.joinmarket-ob-watcher;
inherit (config) nix-bitcoin-services;
nbPkgs = config.nix-bitcoin.pkgs;
torAddress = builtins.head (builtins.split ":" config.services.tor.client.socksListenAddress);
configFile = builtins.toFile "config" ''
[BLOCKCHAIN]
blockchain_source = no-blockchain
[MESSAGING:server1]
host = darksci3bfoka7tw.onion
channel = joinmarket-pit
port = 6697
usessl = true
socks5 = true
socks5_host = ${torAddress}
socks5_port = 9050
[MESSAGING:server2]
host = ncwkrwxpq2ikcngxq3dy2xctuheniggtqeibvgofixpzvrwpa77tozqd.onion
channel = joinmarket-pit
port = 6667
usessl = false
socks5 = true
socks5_host = ${torAddress}
socks5_port = 9050
'';
in {
options.services.joinmarket-ob-watcher = {
enable = mkEnableOption "JoinMarket orderbook watcher";
address = mkOption {
type = types.str;
default = "127.0.0.1";
description = "HTTP server address.";
};
port = mkOption {
type = types.port;
default = 62601;
description = "HTTP server port.";
};
dataDir = mkOption {
readOnly = true;
default = "/var/lib/joinmarket-ob-watcher";
description = "The data directory for JoinMarket orderbook watcher.";
};
user = mkOption {
type = types.str;
default = "joinmarket-ob-watcher";
description = "The user as which to run JoinMarket orderbook watcher.";
};
group = mkOption {
type = types.str;
default = cfg.user;
description = "The group as which to run JoinMarket orderbook watcher.";
};
# This option is only used by netns-isolation
enforceTor = mkOption {
readOnly = true;
default = true;
};
};
config = mkIf cfg.enable {
services.tor = {
enable = true;
client.enable = true;
};
systemd.services.joinmarket-ob-watcher = {
wantedBy = [ "multi-user.target" ];
requires = [ "tor.service" ];
after = [ "tor.service" ];
preStart = ''
ln -snf ${configFile} ${cfg.dataDir}/joinmarket.cfg
'';
serviceConfig = nix-bitcoin-services.defaultHardening // rec {
StateDirectory = "joinmarket-ob-watcher";
StateDirectoryMode = "0770";
WorkingDirectory = "${cfg.dataDir}"; # The service creates dir 'logs' in the working dir
ExecStart = ''
${nbPkgs.joinmarket}/bin/ob-watcher --datadir=${cfg.dataDir} \
--host=${cfg.address} --port=${toString cfg.port}
'';
User = cfg.user;
Restart = "on-failure";
RestartSec = "10s";
} // nix-bitcoin-services.allowTor;
};
users.users.${cfg.user} = {
group = cfg.group;
home = cfg.dataDir; # The service writes to HOME/.config/matplotlib
};
users.groups.${cfg.group} = {};
};
}

View File

@ -18,6 +18,7 @@ with lib;
./electrs.nix ./electrs.nix
./liquid.nix ./liquid.nix
./joinmarket.nix ./joinmarket.nix
./joinmarket-ob-watcher.nix
./hardware-wallets.nix ./hardware-wallets.nix
./recurring-donations.nix ./recurring-donations.nix

View File

@ -242,6 +242,9 @@ in {
id = 25; id = 25;
connections = [ "bitcoind" ]; connections = [ "bitcoind" ];
}; };
joinmarket-ob-watcher = {
id = 26;
};
}; };
services.bitcoind = { services.bitcoind = {
@ -285,6 +288,8 @@ in {
services.joinmarket.cliExec = mkCliExec "joinmarket"; services.joinmarket.cliExec = mkCliExec "joinmarket";
systemd.services.joinmarket-yieldgenerator.serviceConfig.NetworkNamespacePath = "/var/run/netns/nb-joinmarket"; systemd.services.joinmarket-yieldgenerator.serviceConfig.NetworkNamespacePath = "/var/run/netns/nb-joinmarket";
services.joinmarket-ob-watcher.address = netns.joinmarket-ob-watcher.address;
} }
]); ]);
} }

View File

@ -19,6 +19,7 @@ let
spark-wallet = mkInfo ""; spark-wallet = mkInfo "";
btcpayserver = mkInfo ""; btcpayserver = mkInfo "";
liquidd = mkInfo ""; liquidd = mkInfo "";
joinmarket-ob-watcher = mkInfo "";
# Only add sshd when it has an onion service # Only add sshd when it has an onion service
sshd = name: cfg: mkIfOnionPort "sshd" (onionPort: '' sshd = name: cfg: mkIfOnionPort "sshd" (onionPort: ''
add_service("sshd", """set_onion_address(info, "sshd", ${onionPort})""") add_service("sshd", """set_onion_address(info, "sshd", ${onionPort})""")

View File

@ -115,6 +115,9 @@ in {
btcpayserver = { btcpayserver = {
externalPort = 80; externalPort = 80;
}; };
joinmarket-ob-watcher = {
externalPort = 80;
};
}; };
} }
]; ];

View File

@ -28,5 +28,6 @@ in {
liquidd.enable = defaultTrue; liquidd.enable = defaultTrue;
electrs.enable = defaultTrue; electrs.enable = defaultTrue;
spark-wallet.enable = defaultTrue; spark-wallet.enable = defaultTrue;
joinmarket-ob-watcher.enable = defaultTrue;
}; };
} }

View File

@ -1,10 +1,10 @@
{ stdenv, lib, fetchurl, python3, nbPython3Packages, pkgs }: { stdenv, lib, fetchurl, python3, nbPython3Packages, pkgs }:
let let
version = "0.8.0-bcfa7eb"; version = "0.8.0-a5e8879";
src = fetchurl { src = fetchurl {
url = "https://github.com/JoinMarket-Org/joinmarket-clientserver/archive/bcfa7eb4ea3ca51b7ecae9aebe65c634a4ab8b0e.tar.gz"; url = "https://github.com/JoinMarket-Org/joinmarket-clientserver/archive/a5e8879d119c8702476da32957d2cfecc3584c89.tar.gz";
sha256 = "05akzaxi2vqh3hln6qkr6frfas9xd0d95xa3wd56pj8bzknd410m"; sha256 = "1l98mjk5rc5kji4yads6iicvyps0blsddwzclsiv0ha1az6dzpci";
}; };
runtimePackages = with nbPython3Packages; [ runtimePackages = with nbPython3Packages; [
@ -12,6 +12,7 @@ let
joinmarketclient joinmarketclient
joinmarketbitcoin joinmarketbitcoin
joinmarketdaemon joinmarketdaemon
matplotlib # for ob-watcher
]; ];
pythonEnv = python3.withPackages (_: runtimePackages); pythonEnv = python3.withPackages (_: runtimePackages);
@ -22,15 +23,16 @@ stdenv.mkDerivation {
buildInputs = [ pythonEnv ]; buildInputs = [ pythonEnv ];
buildCommand = '' installPhase = ''
mkdir -p $src-unpacked $out/bin mkdir -p $out/bin
tar xzf $src --strip 1 -C $src-unpacked
# add-utxo.py -> bin/jm-add-utxo # add-utxo.py -> bin/jm-add-utxo
cpBin() { cpBin() {
cp $src-unpacked/scripts/$1 $out/bin/jm-''${1%.py} cp scripts/$1 $out/bin/jm-''${1%.py}
} }
cp $src-unpacked/scripts/joinmarketd.py $out/bin/joinmarketd
cp scripts/joinmarketd.py $out/bin/joinmarketd
cp scripts/obwatch/ob-watcher.py $out/bin/ob-watcher
cpBin add-utxo.py cpBin add-utxo.py
cpBin convert_old_wallet.py cpBin convert_old_wallet.py
cpBin receive-payjoin.py cpBin receive-payjoin.py
@ -43,5 +45,8 @@ stdenv.mkDerivation {
chmod +x -R $out/bin chmod +x -R $out/bin
patchShebangs $out/bin patchShebangs $out/bin
# This file must be placed in the same dir as ob-watcher
cp scripts/obwatch/orderbook.html $out/bin/orderbook.html
''; '';
} }

View File

@ -9,7 +9,7 @@ cd $TMPDIR
echo "Fetching latest release" echo "Fetching latest release"
git clone https://github.com/joinmarket-org/joinmarket-clientserver 2> /dev/null git clone https://github.com/joinmarket-org/joinmarket-clientserver 2> /dev/null
cd joinmarket-clientserver cd joinmarket-clientserver
latest=bcfa7eb4ea3ca51b7ecae9aebe65c634a4ab8b0e latest=a5e8879d119c8702476da32957d2cfecc3584c89
echo "Latest release is ${latest}" echo "Latest release is ${latest}"
# GPG verification # GPG verification

View File

@ -60,6 +60,7 @@ let testEnv = rec {
tests.joinmarket = cfg.joinmarket.enable; tests.joinmarket = cfg.joinmarket.enable;
tests.joinmarket-yieldgenerator = cfg.joinmarket.yieldgenerator.enable; tests.joinmarket-yieldgenerator = cfg.joinmarket.yieldgenerator.enable;
tests.joinmarket-ob-watcher = cfg.joinmarket-ob-watcher.enable;
services.joinmarket.yieldgenerator = { services.joinmarket.yieldgenerator = {
enable = config.services.joinmarket.enable; enable = config.services.joinmarket.enable;
customParameters = '' customParameters = ''
@ -119,6 +120,7 @@ let testEnv = rec {
services.liquidd.enable = true; services.liquidd.enable = true;
services.btcpayserver.enable = true; services.btcpayserver.enable = true;
services.joinmarket.enable = true; services.joinmarket.enable = true;
services.joinmarket-ob-watcher.enable = true;
services.backups.enable = true; services.backups.enable = true;
nix-bitcoin.nodeinfo.enable = true; nix-bitcoin.nodeinfo.enable = true;

View File

@ -216,6 +216,12 @@ def _():
) )
@test("joinmarket-ob-watcher")
def _():
assert_running("joinmarket-ob-watcher")
machine.wait_until_succeeds(log_has_string("joinmarket-ob-watcher", "Starting ob-watcher"))
@test("nodeinfo") @test("nodeinfo")
def _(): def _():
status, _ = machine.execute("systemctl is-enabled --quiet onion-addresses 2> /dev/null") status, _ = machine.execute("systemctl is-enabled --quiet onion-addresses 2> /dev/null")