diff --git a/modules/reth/args.nix b/modules/reth/args.nix index d488e5a2..561b5d8a 100644 --- a/modules/reth/args.nix +++ b/modules/reth/args.nix @@ -3,13 +3,13 @@ with lib; { datadir = mkOption { type = types.nullOr types.str; default = null; - description = mdDoc "Data directory for Reth. Defaults to '%S/reth-\', which generally resolves to /var/lib/reth-\."; + description = "Data directory for Reth. Defaults to '%S/reth-\', which generally resolves to /var/lib/reth-\."; }; port = mkOption { type = types.port; default = 30303; - description = mdDoc "Network listening port."; + description = "Network listening port."; }; chain = mkOption { @@ -20,74 +20,74 @@ with lib; { "dev" ]; default = "mainnet"; - description = mdDoc "Name of the network to join. If null the network is mainnet."; + description = "Name of the network to join. If null the network is mainnet."; }; full = mkOption { type = types.bool; default = false; - description = mdDoc "Run full node. Only the most recent [`MINIMUM_PRUNING_DISTANCE`] block states are stored. This flag takes priority over pruning configuration in reth.toml"; + description = "Run full node. Only the most recent [`MINIMUM_PRUNING_DISTANCE`] block states are stored. This flag takes priority over pruning configuration in reth.toml"; }; http = { enable = mkOption { type = types.bool; default = true; - description = mdDoc "Enable HTTP-RPC server"; + description = "Enable HTTP-RPC server"; }; addr = mkOption { type = types.str; default = "127.0.0.1"; - description = mdDoc "HTTP-RPC server listening interface."; + description = "HTTP-RPC server listening interface."; }; port = mkOption { type = types.port; default = 8545; - description = mdDoc "HTTP-RPC server listening port."; + description = "HTTP-RPC server listening port."; }; corsdomain = mkOption { type = types.nullOr (types.listOf types.str); default = null; - description = mdDoc "List of domains from which to accept cross origin requests."; + description = "List of domains from which to accept cross origin requests."; example = ["*"]; }; api = mkOption { type = types.nullOr (types.listOf types.str); - description = mdDoc "API's offered over the HTTP-RPC interface."; + description = "API's offered over the HTTP-RPC interface."; example = ["net" "eth"]; }; }; ws = { - enable = mkEnableOption (mdDoc "Reth WebSocket API"); + enable = mkEnableOption ("Reth WebSocket API"); addr = mkOption { type = types.nullOr types.str; default = null; - description = mdDoc "WS server listening interface."; + description = "WS server listening interface."; example = "127.0.0.1"; }; port = mkOption { type = types.nullOr types.port; default = null; - description = mdDoc "WS server listening port."; + description = "WS server listening port."; example = 8545; }; origins = mkOption { type = types.nullOr (types.listOf types.str); default = null; - description = mdDoc "List of origins from which to accept `WebSocket` requests"; + description = "List of origins from which to accept `WebSocket` requests"; }; api = mkOption { type = types.nullOr (types.listOf types.str); default = null; - description = mdDoc "API's offered over the WS interface."; + description = "API's offered over the WS interface."; example = ["net" "eth"]; }; }; @@ -96,36 +96,36 @@ with lib; { addr = mkOption { type = types.str; default = "127.0.0.1"; - description = mdDoc "HTTP-RPC server listening interface for the Engine API."; + description = "HTTP-RPC server listening interface for the Engine API."; }; port = mkOption { type = types.port; default = 8551; - description = mdDoc "HTTP-RPC server listening port for the Engine API"; + description = "HTTP-RPC server listening port for the Engine API"; }; jwtsecret = mkOption { type = types.nullOr types.str; default = null; - description = mdDoc "Path to the token that ensures safe connection between CL and EL."; + description = "Path to the token that ensures safe connection between CL and EL."; example = "/var/run/reth/jwtsecret"; }; }; metrics = { - enable = mkEnableOption (mdDoc "Enable Prometheus metrics collection and reporting."); + enable = mkEnableOption ("Enable Prometheus metrics collection and reporting."); addr = mkOption { type = types.str; default = "127.0.0.1"; - description = mdDoc "Enable stand-alone metrics HTTP server listening interface."; + description = "Enable stand-alone metrics HTTP server listening interface."; }; port = mkOption { type = types.port; default = 6060; - description = mdDoc "Metrics HTTP server listening port"; + description = "Metrics HTTP server listening port"; }; }; @@ -134,14 +134,14 @@ with lib; { mkOption { type = types.nullOr (types.enum ["terminal" "log-fmt" "json"]); default = null; - description = mdDoc "The format to use for logs written to ${channel}."; + description = "The format to use for logs written to ${channel}."; example = "log-fmt"; }; mkFilterOpt = channel: mkOption { type = types.nullOr types.str; default = null; - description = mdDoc "The filter to use for logs written to ${channel}."; + description = "The filter to use for logs written to ${channel}."; example = "info"; }; in { @@ -155,7 +155,7 @@ with lib; { directory = mkOption { type = types.nullOr types.str; default = null; - description = mdDoc "The path to put log files in"; + description = "The path to put log files in"; example = "/var/log/reth"; }; }; diff --git a/modules/reth/options.nix b/modules/reth/options.nix index 3260af7f..1f01978b 100644 --- a/modules/reth/options.nix +++ b/modules/reth/options.nix @@ -7,15 +7,15 @@ rethOpts = with lib; { options = { - enable = mkEnableOption (mdDoc "Reth Ethereum Node."); + enable = mkEnableOption ("Reth Ethereum Node."); - subVolume = mkEnableOption (mdDoc "Use a subvolume for the state directory if the underlying filesystem supports it e.g. btrfs"); + subVolume = mkEnableOption ("Use a subvolume for the state directory if the underlying filesystem supports it e.g. btrfs"); inherit args; extraArgs = mkOption { type = types.listOf types.str; - description = mdDoc "Additional arguments to pass to Reth."; + description = "Additional arguments to pass to Reth."; default = []; }; @@ -23,13 +23,13 @@ type = types.package; default = pkgs.reth; defaultText = literalExpression "pkgs.reth"; - description = mdDoc "Package to use as Reth node."; + description = "Package to use as Reth node."; }; openFirewall = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Open ports in the firewall for any enabled networking services"; + description = lib."Open ports in the firewall for any enabled networking services"; }; }; }; @@ -38,6 +38,6 @@ in { mkOption { type = types.attrsOf (types.submodule rethOpts); default = {}; - description = mdDoc "Specification of one or more Reth instances."; + description = "Specification of one or more Reth instances."; }; }