2018-11-22 10:49:53 -08:00
|
|
|
{ config, lib, pkgs, ... }:
|
|
|
|
|
|
|
|
with lib;
|
|
|
|
let
|
|
|
|
options.services.clightning = {
|
2021-12-14 10:51:23 -08:00
|
|
|
enable = mkEnableOption "clightning, a Lightning Network implementation in C";
|
2021-01-14 04:24:04 -08:00
|
|
|
address = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "127.0.0.1";
|
2021-10-01 02:51:55 -07:00
|
|
|
description = "Address to listen for peer connections.";
|
2021-01-14 04:24:04 -08:00
|
|
|
};
|
|
|
|
port = mkOption {
|
|
|
|
type = types.port;
|
|
|
|
default = 9735;
|
|
|
|
description = "Port to listen for peer connections.";
|
2018-11-22 10:49:53 -08:00
|
|
|
};
|
2019-03-07 04:16:11 -08:00
|
|
|
proxy = mkOption {
|
2019-10-15 00:37:32 -07:00
|
|
|
type = types.nullOr types.str;
|
2021-11-28 12:24:49 -08:00
|
|
|
default = if cfg.tor.proxy then config.nix-bitcoin.torClientAddressWithPort else null;
|
2021-02-01 13:53:04 -08:00
|
|
|
description = ''
|
|
|
|
Socks proxy for connecting to Tor nodes (or for all connections if option always-use-proxy is set).
|
|
|
|
'';
|
2019-03-07 04:16:11 -08:00
|
|
|
};
|
|
|
|
always-use-proxy = mkOption {
|
|
|
|
type = types.bool;
|
2021-11-28 12:24:49 -08:00
|
|
|
default = cfg.tor.proxy;
|
2019-03-07 04:16:11 -08:00
|
|
|
description = ''
|
2021-02-01 13:53:04 -08:00
|
|
|
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 address information.
|
2019-03-07 04:16:11 -08:00
|
|
|
'';
|
|
|
|
};
|
2018-11-28 15:54:19 -08:00
|
|
|
dataDir = mkOption {
|
|
|
|
type = types.path;
|
|
|
|
default = "/var/lib/clightning";
|
2019-01-02 13:40:53 -08:00
|
|
|
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.";
|
|
|
|
};
|
2022-01-06 04:40:52 -08:00
|
|
|
wallet = mkOption {
|
|
|
|
type = types.nullOr types.str;
|
|
|
|
default = null;
|
|
|
|
example = "sqlite3:///var/lib/clightning/bitcoin/lightningd.sqlite3";
|
|
|
|
description = ''
|
|
|
|
Wallet data scheme (sqlite3 or postgres) and location/connection
|
|
|
|
parameters, as fully qualified data source name.
|
|
|
|
'';
|
|
|
|
};
|
2020-09-28 04:09:07 -07:00
|
|
|
extraConfig = mkOption {
|
|
|
|
type = types.lines;
|
|
|
|
default = "";
|
2021-11-26 06:13:29 -08:00
|
|
|
example = ''
|
|
|
|
alias=mynode
|
|
|
|
'';
|
|
|
|
description = ''
|
|
|
|
Extra lines appended to the configuration file.
|
|
|
|
|
|
|
|
See all available options at
|
|
|
|
https://github.com/ElementsProject/lightning/blob/master/doc/lightningd-config.5.md
|
|
|
|
or by running `lightningd --help`.
|
|
|
|
'';
|
2020-09-28 04:09:07 -07:00
|
|
|
};
|
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.";
|
|
|
|
};
|
2022-05-22 06:56:15 -07:00
|
|
|
package = mkOption {
|
|
|
|
type = types.package;
|
|
|
|
default = nbPkgs.clightning;
|
|
|
|
defaultText = "config.nix-bitcoin.pkgs.clightning";
|
|
|
|
description = "The package providing clightning binaries.";
|
|
|
|
};
|
2019-11-27 05:04:33 -08:00
|
|
|
cli = mkOption {
|
|
|
|
readOnly = true;
|
2022-11-08 13:45:19 -08:00
|
|
|
default = pkgs.writers.writeBashBin "lightning-cli" ''
|
2022-05-22 06:56:15 -07:00
|
|
|
${cfg.package}/bin/lightning-cli --lightning-dir='${cfg.dataDir}' "$@"
|
2019-11-27 05:04:33 -08:00
|
|
|
'';
|
2021-12-07 19:07:28 -08:00
|
|
|
defaultText = "(See source)";
|
2019-11-27 05:04:33 -08:00
|
|
|
description = "Binary to connect with the clightning instance.";
|
|
|
|
};
|
2021-01-14 04:24:20 -08:00
|
|
|
getPublicAddressCmd = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "";
|
|
|
|
description = ''
|
|
|
|
Bash expression which outputs the public service address to announce to peers.
|
|
|
|
If left empty, no address is announced.
|
|
|
|
'';
|
|
|
|
};
|
2021-11-28 12:24:49 -08:00
|
|
|
tor = nbLib.tor;
|
2018-11-22 10:49:53 -08:00
|
|
|
};
|
|
|
|
|
2021-09-13 04:40:47 -07:00
|
|
|
cfg = config.services.clightning;
|
|
|
|
nbLib = config.nix-bitcoin.lib;
|
|
|
|
nbPkgs = config.nix-bitcoin.pkgs;
|
2021-09-13 04:40:49 -07:00
|
|
|
|
2021-09-13 04:40:47 -07:00
|
|
|
network = config.services.bitcoind.makeNetworkName "bitcoin" "regtest";
|
|
|
|
configFile = pkgs.writeText "config" ''
|
|
|
|
network=${network}
|
|
|
|
bitcoin-datadir=${config.services.bitcoind.dataDir}
|
|
|
|
${optionalString (cfg.proxy != null) "proxy=${cfg.proxy}"}
|
|
|
|
always-use-proxy=${boolToString cfg.always-use-proxy}
|
|
|
|
bind-addr=${cfg.address}:${toString cfg.port}
|
2021-10-01 02:51:57 -07:00
|
|
|
bitcoin-rpcconnect=${nbLib.address config.services.bitcoind.rpc.address}
|
2021-09-13 04:40:47 -07:00
|
|
|
bitcoin-rpcport=${toString config.services.bitcoind.rpc.port}
|
|
|
|
bitcoin-rpcuser=${config.services.bitcoind.rpc.users.public.name}
|
|
|
|
rpc-file-mode=0660
|
2021-11-26 06:13:29 -08:00
|
|
|
log-timestamps=false
|
2022-01-06 04:40:52 -08:00
|
|
|
${optionalString (cfg.wallet != null) "wallet=${cfg.wallet}"}
|
2021-09-13 04:40:47 -07:00
|
|
|
${cfg.extraConfig}
|
|
|
|
'';
|
2021-10-26 12:27:48 -07:00
|
|
|
|
2021-10-30 05:55:55 -07:00
|
|
|
# If a public clightning onion service is enabled, use the onion port as the public port
|
|
|
|
publicPort = if (config.nix-bitcoin.onionServices.clightning.enable or false)
|
|
|
|
&& config.nix-bitcoin.onionServices.clightning.public
|
|
|
|
then
|
2021-10-26 12:27:48 -07:00
|
|
|
(builtins.elemAt config.services.tor.relay.onionServices.clightning.map 0).port
|
|
|
|
else
|
|
|
|
cfg.port;
|
2021-09-13 04:40:47 -07:00
|
|
|
in {
|
|
|
|
inherit options;
|
|
|
|
|
2018-11-22 10:49:53 -08:00
|
|
|
config = mkIf cfg.enable {
|
2021-01-14 04:24:32 -08:00
|
|
|
services.bitcoind = {
|
|
|
|
enable = true;
|
|
|
|
# Increase rpc thread count due to reports that lightning implementations fail
|
|
|
|
# under high bitcoind rpc load
|
|
|
|
rpc.threads = 16;
|
|
|
|
};
|
2020-10-18 05:49:20 -07:00
|
|
|
|
2022-05-22 06:56:15 -07:00
|
|
|
environment.systemPackages = [ cfg.package (hiPrio cfg.cli) ];
|
2018-11-28 15:54:19 -08:00
|
|
|
|
2020-05-06 03:43:57 -07:00
|
|
|
systemd.tmpfiles.rules = [
|
2020-05-19 09:09:22 -07:00
|
|
|
"d '${cfg.dataDir}' 0770 ${cfg.user} ${cfg.group} - -"
|
2020-05-06 03:43:57 -07:00
|
|
|
];
|
|
|
|
|
2019-01-02 07:17:57 -08:00
|
|
|
systemd.services.clightning = {
|
2020-11-09 13:09:09 -08:00
|
|
|
path = [ nbPkgs.bitcoind ];
|
2019-01-02 07:17:57 -08:00
|
|
|
wantedBy = [ "multi-user.target" ];
|
2021-01-14 04:24:20 -08:00
|
|
|
requires = [ "bitcoind.service" ];
|
|
|
|
after = [ "bitcoind.service" ];
|
2019-01-02 07:17:57 -08:00
|
|
|
preStart = ''
|
|
|
|
# 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
|
2021-11-26 06:13:29 -08:00
|
|
|
umask u=rw,g=r,o=
|
2021-01-14 04:24:20 -08:00
|
|
|
{
|
2021-11-26 06:13:29 -08:00
|
|
|
cat ${configFile}
|
2021-01-14 04:24:20 -08:00
|
|
|
echo "bitcoin-rpcpassword=$(cat ${config.nix-bitcoin.secretsDir}/bitcoin-rpcpassword-public)"
|
|
|
|
${optionalString (cfg.getPublicAddressCmd != "") ''
|
2021-10-26 12:27:48 -07:00
|
|
|
echo "announce-addr=$(${cfg.getPublicAddressCmd}):${toString publicPort}"
|
2021-01-14 04:24:20 -08:00
|
|
|
''}
|
2021-11-26 06:13:29 -08:00
|
|
|
} > '${cfg.dataDir}/config'
|
2021-02-01 13:53:21 -08:00
|
|
|
'';
|
2021-02-03 13:44:41 -08:00
|
|
|
serviceConfig = nbLib.defaultHardening // {
|
2022-05-22 06:56:15 -07:00
|
|
|
ExecStart = "${cfg.package}/bin/lightningd --lightning-dir=${cfg.dataDir}";
|
2021-02-01 13:53:12 -08:00
|
|
|
User = cfg.user;
|
2019-01-02 07:17:57 -08:00
|
|
|
Restart = "on-failure";
|
|
|
|
RestartSec = "10s";
|
2022-05-07 11:34:21 -07:00
|
|
|
ReadWritePaths = [ cfg.dataDir ];
|
2021-11-28 12:24:49 -08:00
|
|
|
} // nbLib.allowedIPAddresses cfg.tor.enforce;
|
2019-11-27 05:04:38 -08:00
|
|
|
# Wait until the rpc socket appears
|
|
|
|
postStart = ''
|
2020-10-16 08:43:04 -07:00
|
|
|
while [[ ! -e ${cfg.networkDir}/lightning-rpc ]]; do
|
2020-01-09 05:27:45 -08:00
|
|
|
sleep 0.1
|
|
|
|
done
|
2020-05-18 07:32:49 -07:00
|
|
|
# Needed to enable lightning-cli for users with group 'clightning'
|
2020-10-16 08:43:04 -07:00
|
|
|
chmod g+x ${cfg.networkDir}
|
2019-11-27 05:04:38 -08:00
|
|
|
'';
|
2018-11-22 10:49:53 -08:00
|
|
|
};
|
2021-02-01 13:53:22 -08:00
|
|
|
|
|
|
|
users.users.${cfg.user} = {
|
2021-08-04 15:48:59 -07:00
|
|
|
isSystemUser = true;
|
2021-02-01 13:53:22 -08:00
|
|
|
group = cfg.group;
|
2021-02-18 02:42:21 -08:00
|
|
|
extraGroups = [ "bitcoinrpc-public" ];
|
2021-02-01 13:53:22 -08:00
|
|
|
};
|
|
|
|
users.groups.${cfg.group} = {};
|
|
|
|
nix-bitcoin.operator.groups = [ cfg.group ];
|
2019-01-02 07:17:57 -08:00
|
|
|
};
|
2018-11-22 10:49:53 -08:00
|
|
|
}
|