aiolabs/nix-bitcoin
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

treewide: remove obsolete mdDoc

Browse source
This commit is contained in:
Erik Arvstedt 2024-07-15 20:31:27 +02:00
parent 83eb1de24b
commit fc703c38c9
No known key found for this signature in database
GPG key ID: 33312B944DD97846
34 changed files with 265 additions and 265 deletions
Download patch file Download diff file Expand all files Collapse all files

72
modules/bitcoind.nix
View file

@ -8,20 +8,20 @@ let
address = mkOption {
type = types.str;
default = "127.0.0.1";
description = mdDoc "Address to listen for peer connections.";
description = "Address to listen for peer connections.";
};
port = mkOption {
type = types.port;
default = if !cfg.regtest then 8333 else 18444;
defaultText = "if !cfg.regtest then 8333 else 18444";
description = mdDoc "Port to listen for peer connections.";
description = "Port to listen for peer connections.";
};
onionPort = mkOption {
type = types.nullOr types.port;
# When the bitcoind onion service is enabled, add an onion-tagged socket
# to distinguish local connections from Tor connections
default = if (config.nix-bitcoin.onionServices.bitcoind.enable or false) then 8334 else null;
description = mdDoc ''
description = ''
Port to listen for Tor peer connections.
If set, inbound connections to this port are tagged as onion peers.
'';
@ -29,7 +29,7 @@ let
listen = mkOption {
type = types.bool;
default = false;
description = mdDoc ''
description = ''
Listen for peer connections at `address:port`
and `address:onionPort` (if {option}`onionPort` is set).
'';
@ -37,7 +37,7 @@ let
listenWhitelisted = mkOption {
type = types.bool;
default = false;
description = mdDoc ''
description = ''
Listen for peer connections at `address:whitelistedPort`.
Peers connected through this socket are automatically whitelisted.
'';
@ -45,12 +45,12 @@ let
whitelistedPort = mkOption {
type = types.port;
default = 8335;
description = mdDoc "See `listenWhitelisted`.";
description = "See `listenWhitelisted`.";
};
getPublicAddressCmd = mkOption {
type = types.str;
default = "";
description = mdDoc ''
description = ''
Bash expression which outputs the public service address to announce to peers.
If left empty, no address is announced.
'';
@ -59,7 +59,7 @@ let
type = types.package;
default = config.nix-bitcoin.pkgs.bitcoind;
defaultText = "config.nix-bitcoin.pkgs.bitcoind";
description = mdDoc "The package providing bitcoin binaries.";
description = "The package providing bitcoin binaries.";
};
extraConfig = mkOption {
type = types.lines;
@ -68,18 +68,18 @@ let
par=16
logips=1
'';
description = mdDoc "Extra lines appended to {file}`bitcoin.conf`.";
description = "Extra lines appended to {file}`bitcoin.conf`.";
};
dataDir = mkOption {
type = types.path;
default = "/var/lib/bitcoind";
description = mdDoc "The data directory for bitcoind.";
description = "The data directory for bitcoind.";
};
rpc = {
address = mkOption {
type = types.str;
default = "127.0.0.1";
description = mdDoc ''
description = ''
Address to listen for JSON-RPC connections.
'';
};
@ -87,23 +87,23 @@ let
type = types.port;
default = if !cfg.regtest then 8332 else 18443;
defaultText = "if !cfg.regtest then 8332 else 18443";
description = mdDoc "Port to listen for JSON-RPC connections.";
description = "Port to listen for JSON-RPC connections.";
};
threads = mkOption {
type = types.nullOr types.ints.u16;
default = null;
description = mdDoc "The number of threads to service RPC calls.";
description = "The number of threads to service RPC calls.";
};
allowip = mkOption {
type = types.listOf types.str;
default = [ "127.0.0.1" ];
description = mdDoc ''
description = ''
Allow JSON-RPC connections from specified sources.
'';
};
users = mkOption {
default = {};
description = mdDoc ''
description = ''
Allowed users for JSON-RPC connections.
'';
example = {
@ -118,14 +118,14 @@ let
type = types.str;
default = name;
example = "alice";
description = mdDoc ''
description = ''
Username for JSON-RPC connections.
'';
};
passwordHMAC = mkOption {
type = types.str;
example = "f7efda5c189b999524f151318c0c86$d5b51b3beffbc02b724e5d095828e0bc8b2456e9ac8757ae3211a5d9b16a22ae";
description = mdDoc ''
description = ''
Password HMAC-SHA-256 for JSON-RPC connections. Must be a string of the
format `<SALT-HEX>$<HMAC-HEX>`.
'';
@ -138,7 +138,7 @@ let
rpcwhitelist = mkOption {
type = types.listOf types.str;
default = [];
description = mdDoc ''
description = ''
List of allowed rpc calls for each user.
If empty list, rpcwhitelist is disabled for that user.
'';
@ -150,7 +150,7 @@ let
regtest = mkOption {
type = types.bool;
default = false;
description = mdDoc "Enable regtest mode.";
description = "Enable regtest mode.";
};
network = mkOption {
readOnly = true;
@ -163,12 +163,12 @@ let
proxy = mkOption {
type = types.nullOr types.str;
default = if cfg.tor.proxy then config.nix-bitcoin.torClientAddressWithPort else null;
description = mdDoc "Connect through SOCKS5 proxy";
description = "Connect through SOCKS5 proxy";
};
i2p = mkOption {
type = types.enum [ false true "only-outgoing" ];
default = false;
description = mdDoc ''
description = ''
Enable peer connections via i2p.
With `only-outgoing`, incoming i2p connections are disabled.
'';
@ -176,7 +176,7 @@ let
dataDirReadableByGroup = mkOption {
type = types.bool;
default = false;
description = mdDoc ''
description = ''
If enabled, data dir content is readable by the bitcoind service group.
Warning: This disables bitcoind's wallet support.
'';
@ -184,7 +184,7 @@ let
sysperms = mkOption {
type = types.nullOr types.bool;
default = null;
description = mdDoc ''
description = ''
Create new files with system default permissions, instead of umask 077
(only effective with disabled wallet functionality)
'';
@ -192,7 +192,7 @@ let
disablewallet = mkOption {
type = types.nullOr types.bool;
default = null;
description = mdDoc ''
description = ''
Do not load the wallet and disable wallet RPC calls
'';
};
@ -200,13 +200,13 @@ let
type = types.nullOr (types.ints.between 4 16384);
default = null;
example = 4000;
description = mdDoc "Override the default database cache size in MiB.";
description = "Override the default database cache size in MiB.";
};
prune = mkOption {
type = types.ints.unsigned;
default = 0;
example = 10000;
description = mdDoc ''
description = ''
Automatically prune block files to stay under the specified target size in MiB.
Value 0 disables pruning.
'';
@ -214,25 +214,25 @@ let
txindex = mkOption {
type = types.bool;
default = false;
description = mdDoc "Enable the transaction index.";
description = "Enable the transaction index.";
};
zmqpubrawblock = mkOption {
type = types.nullOr types.str;
default = null;
example = "tcp://127.0.0.1:28332";
description = mdDoc "ZMQ address for zmqpubrawblock notifications";
description = "ZMQ address for zmqpubrawblock notifications";
};
zmqpubrawtx = mkOption {
type = types.nullOr types.str;
default = null;
example = "tcp://127.0.0.1:28333";
description = mdDoc "ZMQ address for zmqpubrawtx notifications";
description = "ZMQ address for zmqpubrawtx notifications";
};
assumevalid = mkOption {
type = types.nullOr types.str;
default = null;
example = "00000000000000000000e5abc3a74fe27dc0ead9c70ea1deb456f11c15fd7bc6";
description = mdDoc ''
description = ''
If this block is in the chain assume that it and its ancestors are
valid and potentially skip their script verification.
'';
@ -241,28 +241,28 @@ let
type = types.listOf types.str;
default = [];
example = [ "ecoc5q34tmbq54wl.onion" ];
description = mdDoc "Add nodes to connect to and attempt to keep the connections open";
description = "Add nodes to connect to and attempt to keep the connections open";
};
discover = mkOption {
type = types.nullOr types.bool;
default = null;
description = mdDoc "Discover own IP addresses";
description = "Discover own IP addresses";
};
addresstype = mkOption {
type = types.nullOr types.str;
default = null;
example = "bech32";
description = mdDoc "The type of addresses to use";
description = "The type of addresses to use";
};
user = mkOption {
type = types.str;
default = "bitcoin";
description = mdDoc "The user as which to run bitcoind.";
description = "The user as which to run bitcoind.";
};
group = mkOption {
type = types.str;
default = cfg.user;
description = mdDoc "The group as which to run bitcoind.";
description = "The group as which to run bitcoind.";
};
cli = mkOption {
readOnly = true;
@ -271,7 +271,7 @@ let
exec ${cfg.package}/bin/bitcoin-cli -datadir='${cfg.dataDir}' "$@"
'';
defaultText = "(See source)";
description = mdDoc "Binary to connect with the bitcoind instance.";
description = "Binary to connect with the bitcoind instance.";
};
tor = nbLib.tor;
};