Merge fort-nix/nix-bitcoin#689: Update clightning plugins and remove unmaintained plugins

5730afe48e obsolete-options: add removed clightning plugins (Erik Arvstedt)
aec25c7d04 clightning-plugins: update (Jonas Nick)
b27078efa5 clightning-plugins: remove unmaintained summary plugin (Jonas Nick)
24bc983363 clightning-plugins: remove unmaintained plugins prometheus & helpme (Jonas Nick)

Pull request description:

ACKs for top commit:
  erikarvstedt:
    ACK 5730afe48e

Tree-SHA512: 2f8e5552a680fb80792fb595587af4c848513c69d7290494ab7133e2b50c341b2d055fc24f598dc82e222c892697c37be7895cc7e9da67f6d2bba024af6e09c0

README.md

@@ -74,11 +74,8 @@ NixOS modules ([src](modules/modules.nix))
     Available plugins:
     * [clboss](https://github.com/ZmnSCPxj/clboss): automated C-Lightning Node Manager
     * [currencyrate](https://github.com/lightningd/plugins/tree/master/currencyrate): currency converter
-    * [helpme](https://github.com/lightningd/plugins/tree/master/helpme): walks you through setting up a fresh c-lightning node
     * [monitor](https://github.com/lightningd/plugins/tree/master/monitor): helps you analyze the health of your peers and channels
-    * [prometheus](https://github.com/lightningd/plugins/tree/master/prometheus): lightning node exporter for the prometheus timeseries server
     * [rebalance](https://github.com/lightningd/plugins/tree/master/rebalance): keeps your channels balanced
-    * [summary](https://github.com/lightningd/plugins/tree/master/summary): print a nice summary of the node status
     * [trustedcoin](https://github.com/nbd-wtf/trustedcoin) ([experimental](docs/services.md#trustedcoin)): replaces bitcoind with trusted public explorers
     * [zmq](https://github.com/lightningd/plugins/tree/master/zmq): publishes notifications via ZeroMQ to configured endpoints
   * [clightning-rest](https://github.com/Ride-The-Lightning/c-lightning-REST): REST server for clightning

docs/services.md

@@ -571,13 +571,13 @@ You can activate and configure these plugins like so:
 services.clightning = {
     enable = true;
     plugins = {
-        prometheus.enable = true;
+        clboss.enable = true;
-        prometheus.listen = "0.0.0.0:9900";
+        clboss.min-onchain = 40000;
     };
 };
 ```
 
-Please have a look at the module for a plugin (e.g. [prometheus.nix](../modules/clightning-plugins/prometheus.nix)) to learn its configuration options.
+Please have a look at the module for a plugin (e.g. [clboss.nix](../modules/clightning-plugins/clboss.nix)) to learn its configuration options.
 
 ### Trustedcoin
 When `services.clightning.tor.proxy` is enabled, [trustedcoin](https://github.com/nbd-wtf/trustedcoin)

examples/configuration.nix

@@ -52,7 +52,7 @@
   #
   # == Plugins
   # See ../README.md (Features → clightning) for the list of available plugins.
-  # services.clightning.plugins.prometheus.enable = true;
+  # services.clightning.plugins.clboss.enable = true;
   #
   # == REST server
   # Set this to create a clightning REST onion service.

modules/clightning-plugins/default.nix

@@ -4,7 +4,6 @@ with lib;
 let
   options.services.clightning.plugins = {
     currencyrate.enable = mkEnableOption "Currencyrate (clightning plugin)";
-    helpme.enable = mkEnableOption "Help me (clightning plugin)";
     monitor.enable = mkEnableOption "Monitor (clightning plugin)";
     rebalance.enable = mkEnableOption "Rebalance (clightning plugin)";
   };
@@ -15,8 +14,6 @@ in {
   imports = [
     ./clboss.nix
     ./feeadjuster.nix
-    ./prometheus.nix
-    ./summary.nix
     ./trustedcoin.nix
     ./zmq.nix
   ];
@@ -26,7 +23,6 @@ in {
   config = {
     services.clightning.extraConfig = mkMerge [
       (mkIf cfg.currencyrate.enable "plugin=${pluginPkgs.currencyrate.path}")
-      (mkIf cfg.helpme.enable "plugin=${pluginPkgs.helpme.path}")
       (mkIf cfg.monitor.enable "plugin=${pluginPkgs.monitor.path}")
       (mkIf cfg.rebalance.enable "plugin=${pluginPkgs.rebalance.path}")
     ];

modules/clightning-plugins/prometheus.nix

@@ -1,21 +0,0 @@
-{ config, lib, ... }:
-
-with lib;
-let cfg = config.services.clightning.plugins.prometheus; in
-{
-  options.services.clightning.plugins.prometheus = {
-    enable = mkEnableOption "Prometheus (clightning plugin)";
-    listen = mkOption {
-      type = types.str;
-      default = "0.0.0.0:9750";
-      description = "Address and port to bind to.";
-    };
-  };
-
-  config = mkIf cfg.enable {
-    services.clightning.extraConfig = ''
-      plugin=${config.nix-bitcoin.pkgs.clightning-plugins.prometheus.path}
-      prometheus-listen=${cfg.listen}
-    '';
-  };
-}

modules/clightning-plugins/summary.nix

@@ -1,39 +0,0 @@
-{ config, lib, ... }:
-
-with lib;
-let cfg = config.services.clightning.plugins.summary; in
-{
-  options.services.clightning.plugins.summary = {
-    enable = mkEnableOption "Summary (clightning plugin)";
-    currency = mkOption {
-      type = types.str;
-      default = "USD";
-      description = mdDoc "The currency to look up on btcaverage.";
-    };
-    currencyPrefix = mkOption {
-      type = types.str;
-      default = "USD $";
-      description = mdDoc "The prefix to use for the currency.";
-    };
-    availabilityInterval = mkOption {
-      type = types.int;
-      default = 300;
-      description = mdDoc "How often in seconds the availability should be calculated.";
-    };
-    availabilityWindow = mkOption {
-      type = types.int;
-      default = 72;
-      description = mdDoc "How many hours the availability should be averaged over.";
-    };
-  };
-
-  config = mkIf cfg.enable {
-    services.clightning.extraConfig = ''
-      plugin=${config.nix-bitcoin.pkgs.clightning-plugins.summary.path}
-      summary-currency="${cfg.currency}"
-      summary-currency-prefix="${cfg.currencyPrefix}"
-      summary-availability-interval=${toString cfg.availabilityInterval}
-      summary-availability-window=${toString cfg.availabilityWindow}
-    '';
-  };
-}

modules/obsolete-options.nix

@@ -107,7 +107,15 @@ in {
     (mkRemovedOptionModule [ "services" "clightning" "plugins" "clboss" "acknowledgeDeprecation" ] ''
       `clboss` is maintained again and has been un-deprecated.
     '')
-  ];
+  ]
+  ++
+  # 0.0.106
+  (map (plugin:
+    mkRemovedOptionModule [ "services" "clightning" "plugins" plugin ] ''
+      This plugin is no longer maintained.
+    '')
+    [ "summary" "helpme" "prometheus" ]
+  );
   config = {
     # Migrate old clightning-rest datadir from nix-bitcoin versions < 0.0.70
     systemd.services.clightning-rest-migrate-datadir = let

pkgs/clightning-plugins/default.nix

@@ -6,8 +6,8 @@ let
   src = pkgs.fetchFromGitHub {
     owner = "lightningd";
     repo = "plugins";
-    rev = "ce078bb74e10b5dea779fcd9fbe77e1d3e72db7a";
+    rev = "83a80d134ecb2adc6647235d56195332e846f5cb";
-    hash = "sha256-SCHSJzXe1l14hVT47SU3lWDxKCKwwICjXjSDpjUX96U";
+    sha256 = "1vwsvrak2jkcdfcaj426z4qk8shpkqhrqlfnb9i43w24ry7sqzy1";
   };
 
   version = builtins.substring 0 7 src.rev;
@@ -20,27 +20,13 @@ let
     feeadjuster = {
       description = "Dynamically changes channel fees to keep your channels more balanced";
     };
-    helpme = {
-      description = "Walks you through setting up a c-lightning node, offering advice for common problems";
-    };
     monitor = {
       description = "Helps you analyze the health of your peers and channels";
       extraPkgs = [ packaging ];
     };
-    prometheus = {
-      description = "Lightning node exporter for the prometheus timeseries server";
-      extraPkgs = [ prometheus_client ];
-      patchRequirements =
-        "--replace prometheus-client==0.6.0 prometheus-client==0.17.1"
-        + " --replace pyln-client~=0.9.3 pyln-client~=24.02";
-    };
     rebalance = {
       description = "Keeps your channels balanced";
     };
-    summary = {
-      description = "Prints a summary of the node status";
-      extraPkgs = [ packaging requests ];
-    };
     zmq = {
       description = "Publishes notifications via ZeroMQ to configured endpoints";
       scriptName = "cl-zmq";

test/tests.nix

@@ -49,6 +49,9 @@ let
         removed = [
           # Only defined via `obsolete-options.nix`
           "commando"
+          "helpme"
+          "prometheus"
+          "summary"
         ];
         available = subtractLists removed (builtins.attrNames plugins);
         enabled = builtins.filter (plugin: plugins.${plugin}.enable) available;
@@ -152,11 +155,8 @@ let
       services.clightning.plugins = {
         clboss.enable = true;
         feeadjuster.enable = true;
-        helpme.enable = true;
         monitor.enable = true;
-        prometheus.enable = true;
         rebalance.enable = true;
-        summary.enable = true;
         zmq = let tcpEndpoint = "tcp://127.0.0.1:5501"; in {
           enable = true;
           channel-opened = tcpEndpoint;