nix-bitcoin/modules/clightning.nix

155 lines
5.5 KiB
Nix
Raw Normal View History

2018-11-22 10:49:53 -08:00
{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.services.clightning;
inherit (config) nix-bitcoin-services;
onion-chef-service = (if cfg.announce-tor then [ "onion-chef.service" ] else []);
2020-10-16 08:43:01 -07:00
network = config.services.bitcoind.makeNetworkName "bitcoin" "regtest";
2018-11-22 10:49:53 -08:00
configFile = pkgs.writeText "config" ''
2020-10-16 08:43:01 -07:00
network=${network}
bitcoin-datadir=${config.services.bitcoind.dataDir}
${optionalString (cfg.proxy != null) "proxy=${cfg.proxy}"}
always-use-proxy=${if cfg.always-use-proxy then "true" else "false"}
bind-addr=${cfg.bind-addr}:${toString cfg.bindport}
bitcoin-rpcconnect=${builtins.elemAt config.services.bitcoind.rpcbind 0}
bitcoin-rpcport=${toString config.services.bitcoind.rpc.port}
bitcoin-rpcuser=${config.services.bitcoind.rpc.users.public.name}
rpc-file-mode=0660
2020-09-28 04:09:07 -07:00
${cfg.extraConfig}
2018-11-22 10:49:53 -08:00
'';
in {
options.services.clightning = {
enable = mkOption {
type = types.bool;
default = false;
description = ''
If enabled, the clightning service will be installed.
'';
};
autolisten = mkOption {
type = types.bool;
default = false;
description = ''
Bind (and maybe announce) on IPv4 and IPv6 interfaces if no addr,
bind-addr or announce-addr options are specified.
2018-11-22 10:49:53 -08:00
'';
};
proxy = mkOption {
type = types.nullOr types.str;
default = if cfg.enforceTor then config.services.tor.client.socksListenAddress else null;
description = "Set a socks proxy to use to connect to Tor nodes (or for all connections if *always-use-proxy* is set)";
};
always-use-proxy = mkOption {
type = types.bool;
default = cfg.enforceTor;
description = ''
Always use the *proxy*, even to connect to normal IP addresses (you can still connect to Unix domain sockets manually). This also disables all DNS lookups, to avoid leaking information.
'';
};
bind-addr = mkOption {
type = pkgs.nix-bitcoin.lib.ipv4Address;
default = "127.0.0.1";
description = "Set an IP address or UNIX domain socket to listen to";
};
2020-08-04 00:35:07 -07:00
bindport = mkOption {
type = types.port;
default = 9735;
description = "Set a Port to listen to locally";
};
announce-tor = mkOption {
type = types.bool;
default = false;
description = "Announce clightning Tor Hidden Service";
};
2018-11-28 15:54:19 -08:00
dataDir = mkOption {
type = types.path;
default = "/var/lib/clightning";
description = "The data directory for clightning.";
2018-11-28 15:54:19 -08:00
};
2020-10-16 08:43:04 -07:00
networkDir = mkOption {
readOnly = true;
default = "${cfg.dataDir}/${network}";
description = "The network data directory.";
};
2020-09-28 04:09:07 -07:00
extraConfig = mkOption {
type = types.lines;
default = "";
description = "Additional lines appended to the config file.";
};
2020-05-19 09:09:22 -07:00
user = mkOption {
type = types.str;
default = "clightning";
description = "The user as which to run clightning.";
};
group = mkOption {
type = types.str;
default = cfg.user;
description = "The group as which to run clightning.";
};
cli = mkOption {
readOnly = true;
default = pkgs.writeScriptBin "lightning-cli"
''
${pkgs.nix-bitcoin.clightning}/bin/lightning-cli --lightning-dir='${cfg.dataDir}' "$@"
'';
description = "Binary to connect with the clightning instance.";
};
enforceTor = nix-bitcoin-services.enforceTor;
2018-11-22 10:49:53 -08:00
};
config = mkIf cfg.enable {
2020-10-18 05:49:20 -07:00
services.bitcoind.enable = true;
environment.systemPackages = [ pkgs.nix-bitcoin.clightning (hiPrio cfg.cli) ];
2020-05-19 09:09:22 -07:00
users.users.${cfg.user} = {
2019-01-02 07:17:57 -08:00
description = "clightning User";
2020-05-19 09:09:22 -07:00
group = cfg.group;
extraGroups = [ "bitcoinrpc" ];
2019-01-02 07:17:57 -08:00
};
2020-05-19 09:09:22 -07:00
users.groups.${cfg.group} = {};
2020-09-28 04:09:03 -07:00
nix-bitcoin.operator.groups = [ cfg.group ];
2018-11-28 15:54:19 -08:00
systemd.tmpfiles.rules = [
2020-05-19 09:09:22 -07:00
"d '${cfg.dataDir}' 0770 ${cfg.user} ${cfg.group} - -"
];
services.onion-chef.access.clightning = if cfg.announce-tor then [ "clightning" ] else [];
2019-01-02 07:17:57 -08:00
systemd.services.clightning = {
description = "Run clightningd";
path = [ pkgs.nix-bitcoin.bitcoind ];
2019-01-02 07:17:57 -08:00
wantedBy = [ "multi-user.target" ];
requires = [ "bitcoind.service" ] ++ onion-chef-service;
after = [ "bitcoind.service" ] ++ onion-chef-service;
2019-01-02 07:17:57 -08:00
preStart = ''
cp ${configFile} ${cfg.dataDir}/config
2020-05-19 09:09:22 -07:00
chown -R '${cfg.user}:${cfg.group}' '${cfg.dataDir}'
2019-01-02 07:17:57 -08:00
# The RPC socket has to be removed otherwise we might have stale sockets
2020-10-16 08:43:04 -07:00
rm -f ${cfg.networkDir}/lightning-rpc
chmod 640 ${cfg.dataDir}/config
echo "bitcoin-rpcpassword=$(cat ${config.nix-bitcoin.secretsDir}/bitcoin-rpcpassword-public)" >> '${cfg.dataDir}/config'
${optionalString cfg.announce-tor "echo announce-addr=$(cat /var/lib/onion-chef/clightning/clightning) >> '${cfg.dataDir}/config'"}
2019-01-02 07:17:57 -08:00
'';
serviceConfig = nix-bitcoin-services.defaultHardening // {
ExecStart = "${pkgs.nix-bitcoin.clightning}/bin/lightningd --lightning-dir=${cfg.dataDir}";
2020-05-19 09:09:22 -07:00
User = "${cfg.user}";
2019-01-02 07:17:57 -08:00
Restart = "on-failure";
RestartSec = "10s";
ReadWritePaths = "${cfg.dataDir}";
} // (if cfg.enforceTor
then nix-bitcoin-services.allowTor
else nix-bitcoin-services.allowAnyIP
);
# Wait until the rpc socket appears
postStart = ''
2020-10-16 08:43:04 -07:00
while [[ ! -e ${cfg.networkDir}/lightning-rpc ]]; do
sleep 0.1
done
# Needed to enable lightning-cli for users with group 'clightning'
2020-10-16 08:43:04 -07:00
chmod g+x ${cfg.networkDir}
'';
2018-11-22 10:49:53 -08:00
};
2019-01-02 07:17:57 -08:00
};
2018-11-22 10:49:53 -08:00
}