heierbtc/nix-bitcoin
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
85bbdb857a
nix-bitcoin/modules/lightning-pool.nix

112 lines
3.5 KiB
Nix
Raw Normal View History

pool: add pkg, module & tests
2021-03-01 09:59:23 +00:00
{ config, lib, pkgs, ... }:
with lib;
let
options.services.lightning-pool = {
pkgs: add `meta` attr Also add more detailed `enable` option descriptions.
2021-12-14 18:51:23 +00:00
enable = mkEnableOption "Lightning Pool, a marketplace for inbound lightning liquidity ";
pool: add pkg, module & tests
2021-03-01 09:59:23 +00:00
rpcAddress = mkOption {
type = types.str;
rtl: fix lnd, lightning-loop connection errors lnd and lightning-loop resolve `localhost` to an IPv4 address when creating RPC sockets. Since NixOS 23.05, RTL (nodejs) resolves `localhost` to an IPv6 address when connecting to lnd and lightning-loop, which leads to connection errors. To fix these and other potential errors, replace all instances of `localhost` with `127.0.0.1`.
2023-07-29 16:58:55 +00:00
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 "Address to listen for gRPC connections.";
pool: add pkg, module & tests
2021-03-01 09:59:23 +00:00
};
rpcPort = mkOption {
type = types.port;
default = 12010;
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 "Port to listen for gRPC connections.";
pool: add pkg, module & tests
2021-03-01 09:59:23 +00:00
};
restAddress = mkOption {
type = types.str;
default = cfg.rpcAddress;
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 "Address to listen for REST connections.";
pool: add pkg, module & tests
2021-03-01 09:59:23 +00:00
};
restPort = mkOption {
type = types.port;
default = 8281;
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 "Port to listen for REST connections.";
pool: add pkg, module & tests
2021-03-01 09:59:23 +00:00
};
package = mkOption {
type = types.package;
default = config.nix-bitcoin.pkgs.lightning-pool;
nix-bitcoin.nix: add `defaultText` (automatic) This enables generating module option documentation. This commit was genereated by running the following script inside the repo root dir: def add_default_text(file) src = File.read(file) src2 = src.gsub(/( = mkOption\s+\{[^{]*?)(\n\s+default = )(.*?);$(.*?\})/m) do |str| pre, defaultVar, default, post = Regexp.last_match.captures replacement = if !post.include?('defaultText =') if default =~ /\bpkgs\b/ defaultText = default.lines.length == 1 ? default : "(See source)" "#{pre}#{defaultVar}#{default};#{defaultVar.sub('default', 'defaultText')}#{defaultText.inspect};#{post}" end end replacement or str end File.write(file, src2) if src2 != src end Dir["modules/**/*.nix"].each do |f| next if File.basename(f) == "nix-bitcoin.nix" add_default_text f end
2021-12-08 03:07:28 +00:00
defaultText = "config.nix-bitcoin.pkgs.lightning-pool";
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 package providing lightning-pool binaries.";
pool: add pkg, module & tests
2021-03-01 09:59:23 +00:00
};
dataDir = mkOption {
type = types.path;
default = "/var/lib/lightning-pool";
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 lightning-pool.";
pool: add pkg, module & tests
2021-03-01 09:59:23 +00:00
};
proxy = mkOption {
type = types.nullOr types.str;
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
default = if cfg.tor.proxy then config.nix-bitcoin.torClientAddressWithPort else null;
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 "host:port of SOCKS5 proxy for connnecting to the pool auction server.";
pool: add pkg, module & tests
2021-03-01 09:59:23 +00:00
};
extraConfig = mkOption {
type = types.lines;
default = "";
example = ''
debuglevel=trace
'';
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 "Extra lines appended to the configuration file.";
pool: add pkg, module & tests
2021-03-01 09:59:23 +00:00
};
cli = mkOption {
treewide: set shebang for bash scripts These scripts previously failed when called with syscalls like `execve` (used by, e.g., Python's `subprocess.run`) that use no default interpreter for scripts without a shebang.
2022-11-08 21:45:19 +00:00
default = pkgs.writers.writeBashBin "pool" ''
pool: add pkg, module & tests
2021-03-01 09:59:23 +00:00
exec ${cfg.package}/bin/pool \
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
--rpcserver ${nbLib.addressWithPort cfg.rpcAddress cfg.rpcPort} \
pool: add pkg, module & tests
2021-03-01 09:59:23 +00:00
--network ${network} \
--basedir '${cfg.dataDir}' "$@"
'';
nix-bitcoin.nix: add `defaultText` (automatic) This enables generating module option documentation. This commit was genereated by running the following script inside the repo root dir: def add_default_text(file) src = File.read(file) src2 = src.gsub(/( = mkOption\s+\{[^{]*?)(\n\s+default = )(.*?);$(.*?\})/m) do |str| pre, defaultVar, default, post = Regexp.last_match.captures replacement = if !post.include?('defaultText =') if default =~ /\bpkgs\b/ defaultText = default.lines.length == 1 ? default : "(See source)" "#{pre}#{defaultVar}#{default};#{defaultVar.sub('default', 'defaultText')}#{defaultText.inspect};#{post}" end end replacement or str end File.write(file, src2) if src2 != src end Dir["modules/**/*.nix"].each do |f| next if File.basename(f) == "nix-bitcoin.nix" add_default_text f end
2021-12-08 03:07:28 +00:00
defaultText = "(See source)";
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 "Binary to connect with the lightning-pool instance.";
pool: add pkg, module & tests
2021-03-01 09:59:23 +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
tor = nbLib.tor;
pool: add pkg, module & tests
2021-03-01 09:59:23 +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
cfg = config.services.lightning-pool;
nbLib = config.nix-bitcoin.lib;
lnd = config.services.lnd;
network = config.services.bitcoind.network;
configFile = builtins.toFile "pool.conf" ''
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
rpclisten=${cfg.rpcAddress}:${toString cfg.rpcPort}
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
restlisten=${cfg.restAddress}:${toString cfg.restPort}
${optionalString (cfg.proxy != null) "proxy=${cfg.proxy}"}
lnd.host=${lnd.rpcAddress}:${toString lnd.rpcPort}
lnd.macaroondir=${lnd.networkDir}
lnd.tlspath=${lnd.certPath}
${cfg.extraConfig}
'';
in {
inherit options;
pool: add pkg, module & tests
2021-03-01 09:59:23 +00:00
config = mkIf cfg.enable {
services.lnd.enable = true;
environment.systemPackages = [ cfg.package (hiPrio cfg.cli) ];
systemd.tmpfiles.rules = [
"d '${cfg.dataDir}' 0770 lnd lnd - -"
];
systemd.services.lightning-pool = {
wantedBy = [ "multi-user.target" ];
requires = [ "lnd.service" ];
after = [ "lnd.service" ];
preStart = ''
mkdir -p '${cfg.dataDir}/${network}'
ln -sfn ${configFile} '${cfg.dataDir}/${network}/poold.conf'
'';
serviceConfig = nbLib.defaultHardening // {
ExecStart = "${cfg.package}/bin/poold --basedir='${cfg.dataDir}' --network=${network}";
User = "lnd";
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)
services: add finer-grained address family restrictions Due to a possible NixOS bug, this commit has no effect on NixOS 20.09 where `RestrictAddressFamilies` is a no-op. It's only relevant for NixOS unstable with cgroups v2. bitcoind+zmq: instead of allowing all address families, only add the required AF_NETLINK family. lnd: lnd only runs a zmq client, not a server, therefore it requires no additional address families. lightning-pool, clightning-plugin-zmq: add AF_NETLINK.
2021-03-22 12:19:46 +00:00
// nbLib.allowNetlink; # required by gRPC-Go
pool: add pkg, module & tests
2021-03-01 09:59:23 +00:00
};
};
}
Reference in New Issue Copy Permalink