nix-bitcoin/modules/electrs.nix

120 lines
3.8 KiB
Nix
Raw Normal View History

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.services.electrs;
inherit (config) nix-bitcoin-services;
secretsDir = config.nix-bitcoin.secretsDir;
2020-09-27 03:43:14 -07:00
bitcoind = config.services.bitcoind;
in {
options.services.electrs = {
2020-03-04 09:08:59 -08:00
enable = mkEnableOption "electrs";
dataDir = mkOption {
type = types.path;
default = "/var/lib/electrs";
description = "The data directory for electrs.";
};
user = mkOption {
type = types.str;
default = "electrs";
description = "The user as which to run electrs.";
};
group = mkOption {
type = types.str;
default = cfg.user;
description = "The group as which to run electrs.";
};
high-memory = mkOption {
type = types.bool;
default = false;
description = ''
2020-03-04 09:08:47 -08:00
If enabled, the electrs service will sync faster on high-memory systems ( 8GB).
'';
};
2020-03-04 09:09:02 -08:00
address = mkOption {
type = types.str;
default = "127.0.0.1";
2020-09-27 03:43:16 -07:00
description = "RPC and monitoring listening address.";
2020-03-04 09:09:02 -08:00
};
port = mkOption {
2020-06-02 08:09:52 -07:00
type = types.port;
2020-03-04 09:08:47 -08:00
default = 50001;
description = "RPC port.";
};
2020-09-27 03:43:16 -07:00
monitoringPort = mkOption {
type = types.port;
default = 4224;
description = "Prometheus monitoring port.";
};
extraArgs = mkOption {
type = types.separatedString " ";
default = "";
description = "Extra command line arguments passed to electrs.";
};
2019-08-07 06:06:14 -07:00
enforceTor = nix-bitcoin-services.enforceTor;
};
config = mkIf cfg.enable {
2020-06-15 03:34:11 -07:00
assertions = [
2020-09-27 03:43:14 -07:00
{ assertion = bitcoind.prune == 0;
2020-06-15 03:34:11 -07:00
message = "electrs does not support bitcoind pruning.";
}
];
2020-10-18 05:49:20 -07:00
services.bitcoind.enable = true;
systemd.tmpfiles.rules = [
"d '${cfg.dataDir}' 0770 ${cfg.user} ${cfg.group} - -"
];
systemd.services.electrs = {
2020-03-04 09:08:58 -08:00
description = "Electrs Electrum Server";
wantedBy = [ "multi-user.target" ];
requires = [ "bitcoind.service" ];
after = [ "bitcoind.service" ];
preStart = ''
2020-09-27 03:43:14 -07:00
echo "cookie = \"${bitcoind.rpc.users.public.name}:$(cat ${secretsDir}/bitcoin-rpcpassword-public)\"" \
> electrs.toml
2020-03-04 09:08:51 -08:00
'';
serviceConfig = nix-bitcoin-services.defaultHardening // {
RuntimeDirectory = "electrs";
RuntimeDirectoryMode = "700";
WorkingDirectory = "/run/electrs";
ExecStart = ''
${config.nix-bitcoin.pkgs.electrs}/bin/electrs -vvv \
${if cfg.high-memory then
2020-09-27 03:43:14 -07:00
traceIf (!bitcoind.dataDirReadableByGroup) ''
Warning: For optimal electrs syncing performance, enable services.bitcoind.dataDirReadableByGroup.
Note that this disables wallet support in bitcoind.
'' ""
else
"--jsonrpc-import --index-batch-size=10"
} \
2020-10-16 08:43:09 -07:00
--network=${bitcoind.makeNetworkName "bitcoin" "regtest"} \
--db-dir='${cfg.dataDir}' \
2020-09-27 03:43:14 -07:00
--daemon-dir='${bitcoind.dataDir}' \
2020-09-27 03:43:16 -07:00
--electrum-rpc-addr=${cfg.address}:${toString cfg.port} \
--monitoring-addr=${cfg.address}:${toString cfg.monitoringPort} \
--daemon-rpc-addr=${bitcoind.rpc.address}:${toString bitcoind.rpc.port} \
${cfg.extraArgs}
'';
2020-03-04 09:09:00 -08:00
User = cfg.user;
Group = cfg.group;
Restart = "on-failure";
RestartSec = "10s";
2020-09-27 03:43:14 -07:00
ReadWritePaths = "${cfg.dataDir} ${if cfg.high-memory then "${bitcoind.dataDir}" else ""}";
} // (if cfg.enforceTor
then nix-bitcoin-services.allowTor
else nix-bitcoin-services.allowAnyIP
);
};
2019-04-26 02:09:55 -07:00
users.users.${cfg.user} = {
description = "electrs User";
group = cfg.group;
extraGroups = [ "bitcoinrpc" ] ++ optionals cfg.high-memory [ "bitcoin" ];
};
users.groups.${cfg.group} = {};
};
}