pkgs: add meta attr

Also add more detailed `enable` option descriptions.

modules/btcpayserver.nix

@@ -4,7 +4,7 @@ with lib;
 let
   options.services = {
     btcpayserver = {
-      enable = mkEnableOption "btcpayserver";
+      enable = mkEnableOption "btcpayserver, a self-hosted Bitcoin payment processor";
       address = mkOption {
         type = types.str;
         default = "127.0.0.1";

modules/clightning.nix

@@ -3,7 +3,7 @@
 with lib;
 let
   options.services.clightning = {
-    enable = mkEnableOption "clightning";
+    enable = mkEnableOption "clightning, a Lightning Network implementation in C";
     address = mkOption {
       type = types.str;
       default = "127.0.0.1";

modules/electrs.nix

@@ -3,7 +3,7 @@
 with lib;
 let
   options.services.electrs = {
-    enable = mkEnableOption "electrs";
+    enable = mkEnableOption "electrs, an Electrum server implemented in Rust";
     address = mkOption {
       type = types.str;
       default = "127.0.0.1";

modules/joinmarket.nix

@@ -3,7 +3,7 @@
 with lib;
 let
   options.services.joinmarket = {
-    enable = mkEnableOption "JoinMarket";
+    enable = mkEnableOption "JoinMarket, a Bitcoin CoinJoin implementation";
     payjoinAddress = mkOption {
       type = types.str;
       default = "127.0.0.1";
@@ -58,7 +58,7 @@ let
     inherit (nbLib) cliExec;
 
     yieldgenerator = {
-      enable = mkEnableOption "yield generator bot";
+      enable = mkEnableOption "JoinMarket yield generator bot";
       ordertype = mkOption {
         type = types.enum [ "reloffer" "absoffer" ];
         default = "reloffer";

modules/lightning-loop.nix

@@ -3,7 +3,7 @@
 with lib;
 let
   options.services.lightning-loop = {
-    enable = mkEnableOption "lightning-loop";
+    enable = mkEnableOption "Lightning Loop, a non-custodial off/on chain bridge";
     rpcAddress = mkOption {
        type = types.str;
        default = "localhost";

modules/lightning-pool.nix

@@ -3,7 +3,7 @@
 with lib;
 let
   options.services.lightning-pool = {
-    enable = mkEnableOption "lightning-pool";
+    enable = mkEnableOption "Lightning Pool, a marketplace for inbound lightning liquidity ";
     rpcAddress = mkOption {
        type = types.str;
        default = "localhost";

modules/liquid.nix

@@ -4,7 +4,7 @@ with lib;
 let
   options = {
     services.liquidd = {
-      enable = mkEnableOption "Liquid sidechain";
+      enable = mkEnableOption "Liquid Bitcoin sidechain daemon";
       address = mkOption {
         type = types.str;
         default = "127.0.0.1";

modules/lnd.nix

@@ -3,7 +3,7 @@
 with lib;
 let
   options.services.lnd = {
-    enable = mkEnableOption "Lightning Network Daemon";
+    enable = mkEnableOption "Lightning Network daemon, a Lightning Network implementation in Go";
     address = mkOption {
       type = types.str;
       default = "localhost";

modules/rtl.nix

@@ -3,7 +3,7 @@
 with lib;
 let
   options.services.rtl = {
-    enable = mkEnableOption "rtl";
+    enable = mkEnableOption "Ride The Lightning, a web interface for lnd and clightning ";
     address = mkOption {
       type = types.str;
       default = "127.0.0.1";

pkgs/cl-rest/default.nix

@@ -1,4 +1,4 @@
-{ pkgs, makeWrapper }:
+{ pkgs, lib, makeWrapper }:
 let
   inherit (pkgs) nodejs;
   nodePackages = import ./composition.nix { inherit pkgs nodejs; };
@@ -12,4 +12,12 @@ nodePackages.package.overrideAttrs (old: {
     makeWrapper ${nodejs}/bin/node $out/bin/cl-rest \
       --add-flags $out/lib/node_modules/c-lightning-rest/cl-rest
   '';
+
+  meta = with lib; {
+    description = "REST API for C-Lightning";
+    homepage = "https://github.com/Ride-The-Lightning/c-lightning-REST";
+    license = licenses.mit;
+    maintainers = with maintainers; [ nixbitcoin earvstedt ];
+    platforms = platforms.unix;
+  };
 })

pkgs/clboss/default.nix

@@ -19,8 +19,8 @@ stdenv.mkDerivation rec {
   meta = with lib; {
     description = "Automated C-Lightning Node Manager";
     homepage = "https://github.com/ZmnSCPxj/clboss";
-    maintainers = with maintainers; [ nixbitcoin ];
     license = licenses.mit;
+    maintainers = with maintainers; [ nixbitcoin ];
     platforms = platforms.linux;
   };
 }

pkgs/clightning-plugins/default.nix

@@ -13,19 +13,22 @@ let
   version = builtins.substring 0 7 src.rev;
 
   plugins = with nbPython3Packages; {
-    helpme = {};
+    helpme = { description = "Walks you through setting up a c-lightning node, offering advice for common problems"; };
-    monitor = {};
+    monitor = { description = "Helps you analyze the health of your peers and channels"; };
     prometheus = {
+      description = "Lightning node exporter for the prometheus timeseries server";
       extraPkgs = [ prometheus_client ];
       patchRequirements =
         "--replace prometheus-client==0.6.0 prometheus-client==0.11.0"
         + " --replace pyln-client~=0.9.3 pyln-client~=0.10.1";
     };
-    rebalance = {};
+    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";
       extraPkgs = [ twisted txzmq ];
     };
@@ -58,6 +61,14 @@ let
       '';
 
       passthru.path = "${drv}/${script}";
+
+      meta = with lib; {
+        inherit (plugin) description;
+        homepage = "https://github.com/lightningd/plugins";
+        license = licenses.bsd3;
+        maintainers = with maintainers; [ nixbitcoin earvstedt ];
+        platforms = platforms.unix;
+      };
     };
   in drv;
 

pkgs/joinmarket/default.nix

@@ -54,4 +54,12 @@ stdenv.mkDerivation {
     # These files must be placed in the same dir as ob-watcher
     cp -r scripts/obwatch/{orderbook.html,sybil_attack_calculations.py,vendor} $obw
   '';
+
+  meta = with lib; {
+    description = "Bitcoin CoinJoin implementation";
+    homepage = "https://github.com/JoinMarket-Org/joinmarket-clientserver";
+    license = licenses.gpl3Only;
+    maintainers = with maintainers; [ nixbitcoin ];
+    platforms = platforms.unix;
+  };
 }

pkgs/liquid-swap/default.nix

@@ -14,5 +14,12 @@ buildPythonPackage rec {
   installFlags = [ ".[CLI]" ];
   # The tests unfortunately seem to require the PyQt for the GUI
   doCheck = false;
-}
 
+  meta = with lib; {
+    description = "Swap issued assets on the Liquid network using confidential transactions";
+    homepage = "https://github.com/Blockstream/liquid-swap";
+    license = licenses.gpl3Only;
+    maintainers = with maintainers; [ nixbitcoin ];
+    platforms = platforms.unix;
+  };
+}

pkgs/rtl/default.nix

@@ -1,4 +1,4 @@
-{ pkgs, makeWrapper }:
+{ pkgs, lib, makeWrapper }:
 let
   inherit (pkgs) nodejs;
   nodePackages = import ./composition.nix { inherit pkgs nodejs; };
@@ -12,4 +12,12 @@ nodePackages.package.overrideAttrs (old: {
     makeWrapper ${nodejs}/bin/node $out/bin/rtl \
       --add-flags $out/lib/node_modules/rtl/rtl
   '';
+
+  meta = with lib; {
+    description = "A web interface for LND, c-lightning and Eclair";
+    homepage = "https://github.com/Ride-The-Lightning/RTL";
+    license = licenses.mit;
+    maintainers = with maintainers; [ nixbitcoin earvstedt ];
+    platforms = platforms.unix;
+  };
 })

pkgs/secp256k1/default.nix

@@ -19,8 +19,8 @@ stdenv.mkDerivation {
   meta = with lib; {
     description = "Optimized C library for EC operations on curve secp256k1";
     homepage = "https://github.com/bitcoin-core/secp256k1";
-    license = with licenses; [ mit ];
+    license = licenses.mit;
     maintainers = with maintainers; [ nixbitcoin ];
-    platforms = with platforms; unix;
+    platforms = platforms.unix;
   };
 }

pkgs/spark-wallet/default.nix

@@ -1,8 +1,16 @@
-{ pkgs }:
+{ pkgs, lib }:
 let
   nodePackages = import ./composition.nix { inherit pkgs; };
 in
 nodePackages.package.override {
   # Required because spark-wallet uses `npm-shrinkwrap.json` as the lock file
   reconstructLock = true;
+
+  meta = with lib; {
+    description = "A minimalistic wallet GUI for c-lightning";
+    homepage = "https://github.com/shesek/spark-wallet";
+    license = licenses.mit;
+    maintainers = with maintainers; [ nixbitcoin earvstedt ];
+    platforms = platforms.unix;
+  };
 }