{ config, lib, pkgs, ... }: with lib; let options.services.rtl = { enable = mkEnableOption "Ride The Lightning, a web interface for lnd and clightning"; address = mkOption { type = types.str; default = "127.0.0.1"; description = mdDoc "HTTP server address."; }; port = mkOption { type = types.port; default = 3000; description = mdDoc "HTTP server port."; }; dataDir = mkOption { type = types.path; default = "/var/lib/rtl"; description = mdDoc "The data directory for RTL."; }; nodes = { clightning = { enable = mkOption { type = types.bool; default = false; description = mdDoc "Enable the clightning node interface."; }; extraConfig = mkOption { type = with types; attrsOf anything; default = {}; example = { Settings.userPersona = "MERCHANT"; Settings.logLevel = "DEBUG"; }; description = mdDoc '' Extra clightning node configuration. See here for all available options: https://github.com/Ride-The-Lightning/RTL/blob/master/.github/docs/Application_configurations.md ''; }; }; lnd = { enable = mkOption { type = types.bool; default = false; description = mdDoc "Enable the lnd node interface."; }; loop = mkOption { type = types.bool; default = false; description = mdDoc "Enable swaps with lightning-loop."; }; extraConfig = mkOption { type = with types; attrsOf anything; default = {}; example = { Settings.userPersona = "MERCHANT"; Settings.logLevel = "DEBUG"; }; description = mdDoc '' Extra lnd node configuration. See here for all available options: https://github.com/Ride-The-Lightning/RTL/blob/master/.github/docs/Application_configurations.md ''; }; }; reverseOrder = mkOption { type = types.bool; default = false; description = mdDoc '' Reverse the order of nodes shown in the UI. By default, clightning is shown before lnd. ''; }; }; nightTheme = mkOption { type = types.bool; default = false; description = mdDoc "Enable the Night UI Theme."; }; extraCurrency = mkOption { type = with types; nullOr str; default = null; example = "USD"; description = mdDoc '' Currency code (ISO 4217) of the extra currency used for displaying balances. When set, this option enables online currency rate fetching. Warning: Rate fetching requires outgoing clearnet connections, so option {option}`tor.enforce` is automatically disabled. ''; }; user = mkOption { type = types.str; default = "rtl"; description = mdDoc "The user as which to run RTL."; }; group = mkOption { type = types.str; default = cfg.user; description = mdDoc "The group as which to run RTL."; }; tor.enforce = nbLib.tor.enforce; }; cfg = config.services.rtl; nbLib = config.nix-bitcoin.lib; nbPkgs = config.nix-bitcoin.pkgs; secretsDir = config.nix-bitcoin.secretsDir; inherit (nbLib) optionalAttr; node = { isLnd, index }: { inherit index; lnNode = "Node"; lnImplementation = if isLnd then "LND" else "CLT"; Authentication = { ${optionalAttr (isLnd && lndLoopEnabled) "swapMacaroonPath"} = "${lightning-loop.dataDir}/${bitcoind.network}"; macaroonPath = if isLnd then "${cfg.dataDir}/macaroons" else "${clightning-rest.dataDir}/certs"; }; Settings = { userPersona = "OPERATOR"; themeMode = if cfg.nightTheme then "NIGHT" else "DAY"; themeColor = "PURPLE"; ${optionalAttr isLnd "channelBackupPath"} = "${cfg.dataDir}/backup/lnd"; logLevel = "INFO"; fiatConversion = cfg.extraCurrency != null; ${optionalAttr (cfg.extraCurrency != null) "currencyUnit"} = cfg.extraCurrency; ${optionalAttr (isLnd && lndLoopEnabled) "swapServerUrl"} = "https://${nbLib.addressWithPort lightning-loop.restAddress lightning-loop.restPort}"; lnServerUrl = "https://${ if isLnd then nbLib.addressWithPort lnd.restAddress lnd.restPort else nbLib.addressWithPort clightning-rest.address clightning-rest.port }"; }; }; nodes' = optional cfg.nodes.clightning.enable (recursiveUpdate (node { isLnd = false; index = 1; }) cfg.nodes.clightning.extraConfig) ++ optional cfg.nodes.lnd.enable (recursiveUpdate (node { isLnd = true; index = 2; }) cfg.nodes.lnd.extraConfig); nodes = if cfg.nodes.reverseOrder then reverseList nodes' else nodes'; rtlConfig = { multiPass = "@multiPass@"; host = cfg.address; port = cfg.port; SSO.rtlSSO = 0; inherit nodes; }; configFile = builtins.toFile "config" (builtins.toJSON rtlConfig); inherit (config.services) bitcoind lnd clightning-rest lightning-loop; lndLoopEnabled = cfg.nodes.lnd.enable && cfg.nodes.lnd.loop; in { inherit options; config = mkIf cfg.enable { assertions = [ { assertion = cfg.nodes.clightning.enable || cfg.nodes.lnd.enable; message = '' RTL: At least one of `nodes.lnd.enable` or `nodes.clightning.enable` must be `true`. ''; } ]; services.lnd.enable = mkIf cfg.nodes.lnd.enable true; services.lightning-loop.enable = mkIf lndLoopEnabled true; services.clightning-rest.enable = mkIf cfg.nodes.clightning.enable true; systemd.tmpfiles.rules = [ "d '${cfg.dataDir}' 0770 ${cfg.user} ${cfg.group} - -" ]; services.rtl.tor.enforce = mkIf (cfg.extraCurrency != null) false; systemd.services.rtl = rec { wantedBy = [ "multi-user.target" ]; requires = optional cfg.nodes.clightning.enable "clightning-rest.service" ++ optional cfg.nodes.lnd.enable "lnd.service"; after = requires ++ [ "nix-bitcoin-secrets.target" ]; environment.RTL_CONFIG_PATH = cfg.dataDir; environment.DB_DIRECTORY_PATH = cfg.dataDir; serviceConfig = nbLib.defaultHardening // { ExecStartPre = [ (nbLib.script "rtl-setup-config" '' <${configFile} sed "s|@multiPass@|$(cat ${secretsDir}/rtl-password)|" \ > '${cfg.dataDir}/RTL-Config.json' '') ] ++ optional cfg.nodes.lnd.enable (nbLib.rootScript "rtl-copy-macaroon" '' install -D -o ${cfg.user} -g ${cfg.group} ${lnd.networkDir}/admin.macaroon \ '${cfg.dataDir}/macaroons/admin.macaroon' ''); ExecStart = "${nbPkgs.rtl}/bin/rtl"; # Show "rtl" instead of "node" in the journal SyslogIdentifier = "rtl"; User = cfg.user; Restart = "on-failure"; RestartSec = "10s"; ReadWritePaths = [ cfg.dataDir ]; } // nbLib.allowedIPAddresses cfg.tor.enforce // nbLib.nodejs; }; users.users.${cfg.user} = { isSystemUser = true; group = cfg.group; extraGroups = # Reads cert and macaroon from the clightning-rest datadir optional cfg.nodes.clightning.enable clightning-rest.group ++ optional lndLoopEnabled lnd.group; }; users.groups.${cfg.group} = {}; nix-bitcoin.secrets.rtl-password.user = cfg.user; nix-bitcoin.generateSecretsCmds.rtl = '' makePasswordSecret rtl-password ''; }; }