GROESTLCOIND(1)

📦 version 29.0, in nixos 26.05

okay so this is the GROESTLCOIND(1) page, straight out of User Commands, and yeah the manual name is literally just groestlcoind so we're folding that in right here at the top and moving on 💖

✨ NAME ✨

groestlcoind — the manual page for groestlcoind v29.0.0. that's it, that's the name, no notes 💅

🦋 SYNOPSIS 🦋

groestlcoind [options]

🌸 DESCRIPTION 🌸

So. Groestlcoin Core daemon version v29.0.0 👑

The Groestlcoin Core daemon (groestlcoind) is a headless program that connects to the Groestlcoin network to validate and relay transactions and blocks, and it relays addresses too. no cap, that's the whole job.

It provides the backbone of the Groestlcoin network, and its RPC, REST and ZMQ services can provide various transaction, block and address-related services. iconic behavior honestly.

There is an optional wallet component which provides transaction services 🎀

It can be used in a headless environment or as part of a server setup. main character energy for your server rack fr fr.

🔥 OPTIONS 🔥

  • -alertnotify=<cmd> — run a command whenever an alert is raised. the %s inside cmd gets swapped out for the message.
  • -allowignoredconf — for backwards compatibility, treat an unused groestlcoin.conf file sitting in the datadir as a warning, not an error. be nice about it basically 🫶
  • -assumevalid=<hex> — if this block is in the chain, assume that it and its ancestors are valid and potentially skip their script verification. <hex> of 0 means verify all. defaults, get ready to copy these exactly:
    • default: 00000000000006713d496168ff30de2814387078da0f048c1baeb048ddafb338
    • testnet3: 000000eb996dbad60acf62dd68022cfd923592db8638bce7447c418fed680286
    • testnet4: 0000000000000000000000000000000000000000000000000000000000000000
    • signet: 00000140d5c39556d9a890c5865c2548d259a49cd1540f680b7f44225561e6e7
  • -blockfilterindex=<type> — maintain an index of compact filters by block (default: 0, values: basic). if <type> isn't supplied, or if <type> = 1, then indexes for all known types get enabled. slay.
  • -blocknotify=<cmd> — run a command when the best block changes. the %s in cmd gets replaced by the block hash 💫
  • -blockreconstructionextratxn=<n> — extra transactions to keep in memory for compact block reconstructions (default: 100).
  • -blocksdir=<dir> — specify the directory to hold the blocks subdirectory for *.dat files (default: <datadir>).
  • -blocksonly — whether to reject transactions from network peers. disables automatic broadcast and rebroadcast of transactions, unless the source peer has the 'forcerelay' permission. RPC transactions are not affected. (default: 0)
  • -blocksxor — whether an XOR-key applies to blocksdir *.dat files. the created XOR-key will be zeros for an existing blocksdir or when -blocksxor=0 is set, and random for a freshly initialized blocksdir. (default: 1)
  • -coinstatsindex — maintain the coinstats index used by the gettxoutsetinfo RPC (default: 0).
  • -conf=<file> — specify path to a read-only configuration file. relative paths will be prefixed by the datadir location. heads up: only useable from the command line, not from the configuration file (default: groestlcoin.conf).
  • -daemon — run in the background as a daemon and accept commands (default: 0).
  • -daemonwait — wait for initialization to be finished before exiting. this implies -daemon (default: 0).
  • -datadir=<dir> — specify data directory.
  • -dbcache=<n> — maximum database cache size <n> MiB (minimum 4, default: 450). make sure you have enough RAM bestie 😭 in addition, unused memory allocated to the mempool is shared with this cache (see -maxmempool).
  • -debuglogfile=<file> — specify location of debug log file (default: debug.log). relative paths will be prefixed by a net-specific datadir location. pass -nodebuglogfile to disable writing the log to a file.
  • -help — print this help message and exit (also -h or -?) 🙋‍♀️
  • -includeconf=<file> — specify an additional configuration file, relative to the -datadir path. note: only useable from the configuration file, not the command line.
  • -loadblock=<file> — imports blocks from an external file on startup.
  • -maxmempool=<n> — keep the transaction memory pool below <n> megabytes (default: 300).
  • -maxorphantx=<n> — keep at most <n> unconnectable transactions in memory (default: 100).
  • -mempoolexpiry=<n> — do not keep transactions in the mempool longer than <n> hours (default: 336).
  • -par=<n> — set the number of script verification threads (0 = auto, up to 15, <0 = leave that many cores free, default: 0).
  • -persistmempool — whether to save the mempool on shutdown and load on restart (default: 1).
  • -persistmempoolv1 — whether a mempool.dat file created by -persistmempool or the savemempool RPC will be written in the legacy format (version 1) or the current format (version 2). this is a temporary option and will be removed in the future. (default: 0)
  • -pid=<file> — specify pid file. relative paths will be prefixed by a net-specific datadir location. (default: groestlcoind.pid)
  • -prune=<n> — reduce storage requirements by enabling pruning (deleting) of old blocks. this allows the pruneblockchain RPC to be called to delete specific blocks, and enables automatic pruning of old blocks if a target size in MiB is provided. this mode is incompatible with -txindex. values: 0 = disable pruning blocks, 1 = allow manual pruning via RPC, >=550 = automatically prune block files to stay under the specified target size in MiB (default: 0).
⚠️ warning, bestie: reverting this setting requires re-downloading the entire blockchain. like, the whole thing 💀
  • -reindex — if enabled, wipe chain state and block index, and rebuild them from blk*.dat files on disk. also wipe and rebuild other optional indexes that are active. if an assumeutxo snapshot was loaded, its chainstate will be wiped as well. the snapshot can then be reloaded via RPC. spring cleaning fr 🧹
  • -reindex-chainstate — if enabled, wipe chain state, and rebuild it from blk*.dat files on disk. if an assumeutxo snapshot was loaded, its chainstate will be wiped as well. the snapshot can then be reloaded via RPC.
  • -settings=<file> — specify path to the dynamic settings data file. can be disabled with -nosettings. the file is written at runtime and not meant to be edited by users — use groestlcoin.conf instead for custom settings. relative paths will be prefixed by datadir location. (default: settings.json)
  • -shutdownnotify=<cmd> — run a command immediately before beginning shutdown. the need for shutdown may be urgent, so be careful not to delay it long. if the command doesn't require interaction with the server, consider having it fork into the background 🙈
  • -startupnotify=<cmd> — run a command on startup.
  • -txindex — maintain a full transaction index, used by the getrawtransaction rpc call (default: 0).
  • -version — print version and exit.

🌈 Connection options 🌈

  • -addnode=<ip> — add a node to connect to and attempt to keep the connection open (see the addnode RPC help for more info). this option can be specified multiple times to add multiple nodes; connections are limited to 8 at a time and are counted separately from the -maxconnections limit.
  • -asmap=<file> — specify asn mapping used for bucketing of the peers (default: ip_asn.map). relative paths will be prefixed by the net-specific datadir location.
  • -bantime=<n> — default duration (in seconds) of manually configured bans (default: 86400).
  • -bind=<addr>[:<port>][=onion] — bind to the given address and always listen on it (default: 0.0.0.0). use [host]:port notation for IPv6. append =onion to tag any incoming connections to that address and port as incoming Tor connections. defaults: 127.0.0.1:1332=onion, testnet3: 127.0.0.1:17778=onion, testnet4: 127.0.0.1:48334=onion, signet: 127.0.0.1:31332=onion, regtest: 127.0.0.1:18889=onion 🧅
  • -cjdnsreachable — if set, then this host is configured for CJDNS (connecting to fc00::/8 addresses would lead us to the CJDNS network, see doc/cjdns.md) (default: 0).
  • -connect=<ip> — connect only to the specified node; -noconnect disables automatic connections (the rules for this peer are the same as for -addnode). this option can be specified multiple times to connect to multiple nodes.
  • -discover — discover own IP addresses (default: 1 when listening and no -externalip or -proxy).
  • -dns — allow DNS lookups for -addnode, -seednode and -connect (default: 1).
  • -dnsseed — query for peer addresses via DNS lookup, if low on addresses (default: 1 unless -connect used or -maxconnections=0).
  • -externalip=<ip> — specify your own public address.
  • -fixedseeds — allow fixed seeds if DNS seeds don't provide peers (default: 1).
  • -forcednsseed — always query for peer addresses via DNS lookup (default: 0).
  • -i2pacceptincoming — whether to accept inbound I2P connections (default: 1). ignored if -i2psam is not set. listening for inbound I2P connections is done through the SAM proxy, not by binding to a local address and port.
  • -i2psam=<ip:port> — I2P SAM proxy to reach I2P peers and accept I2P connections (default: none).
  • -listen — accept connections from outside (default: 1 if no -proxy, -connect or -maxconnections=0).
  • -listenonion — automatically create Tor onion service (default: 1).
  • -maxconnections=<n> — maintain at most <n> automatic connections to peers (default: 125). this limit does not apply to connections manually added via -addnode or the addnode RPC, which have a separate limit of 8.
  • -maxreceivebuffer=<n> — maximum per-connection receive buffer, <n>*1000 bytes (default: 5000).
  • -maxsendbuffer=<n> — maximum per-connection memory usage for the send buffer, <n>*1000 bytes (default: 1000).
  • -maxuploadtarget=<n> — tries to keep outbound traffic under the given target per 24h. the limit does not apply to peers with 'download' permission or blocks created within the past week. 0 = no limit (default: 0M). optional suffix units [k|K|m|M|g|G|t|T] (default: M). lowercase is 1000 base while uppercase is 1024 base 🧮
  • -natpmp — use PCP or NAT-PMP to map the listening port (default: 0).
  • -networkactive — ok this one's description is literally still loading, it's spilling over into part 2 bestie 💀 hold that thought

Enable all P2P network activity (default: 1). Can be changed by the setnetworkactive RPC command ✨

  • -onion=<ip:port|path> — bestie, this is your separate SOCKS5 proxy for reaching peers through Tor onion services 🧅 set -noonion to turn it off (default: -proxy). It can also be a local file path, as long as you prefix it with unix:.
  • -onlynet=<net> — makes your automatic outbound connections go only to network <net> (ipv4, ipv6, onion, i2p, cjdns) 🎯 inbound and manual connections are literally not affected by this, so don't panic. You can drop this option multiple times to allow multiple networks, slay.
  • -peerblockfilters — serve compact block filters to peers per BIP 157 (default: 0)
  • -peerbloomfilters — support filtering of blocks and transactions with bloom filters (default: 1)
  • -port=<port> — listen for connections on <port> (default: 1331, testnet3: 17777, testnet4: 48333, signet: 31331, regtest: 18888) 📞 not relevant for I2P (see doc/i2p.md). If you set it to a value x, the default onion listening port becomes x+1 — cute, right?
  • -proxy=<ip:port|path> — connect through a SOCKS5 proxy, set -noproxy to disable (default: disabled). It may be a local file path prefixed with unix: if the proxy supports it 💅
  • -proxyrandomize — randomize credentials for every single proxy connection, which enables Tor stream isolation (default: 1) 🌀
  • -seednode=<ip> — connect to a node just to retrieve peer addresses, then dip ✌️ you can specify this option multiple times to hit multiple nodes, and during startup seednodes get tried before dnsseeds.
  • -timeout=<n> — socket connection timeout in milliseconds. If an initial attempt to connect is still unsuccessful after that amount of time, it gets dropped (minimum: 1, default: 5000) ⏳
  • -torcontrol=<ip>:<port> — Tor control host and port to use if onion listening is enabled (default: 127.0.0.1:9051). If you don't specify a port, the default port of 9051 gets used, no biggie.
  • -torpassword=<pass> — Tor control port password (default: empty) 🔐
  • -v2transport — support v2 transport (default: 1) 🚀
  • -whitebind=<[permissions@]addr> — bind to the given address and hand permission flags to the peers connecting to it. Use [host]:port notation for IPv6 💖 allowed permissions, and this is the whole list, don't come for me:
    • bloomfilter — allow requesting BIP37 filtered blocks and transactions
    • noban — do not ban for misbehavior; implies download
    • forcerelay — relay transactions that are already in the mempool; implies relay
    • relay — relay even in -blocksonly mode, and unlimited transaction announcements
    • mempool — allow requesting BIP35 mempool contents
    • download — allow getheaders during IBD, no disconnect after maxuploadtarget limit
    • addr — responses to GETADDR avoid hitting the cache and contain random records with the most up-to-date info

Specify multiple permissions separated by commas (default: download,noban,mempool,relay). Can be specified multiple times 👑

  • -whitelist=<[permissions@]IP address or network> — same energy, but for peers using a given IP address (e.g. 1.2.3.4) or a CIDR-notated network (e.g. 1.2.3.0/24). Uses the exact same permissions as -whitebind 💫 and there are two bonus flags, in and out, which control whether permissions apply to incoming connections and/or manual ones (default: incoming only). Can be specified multiple times.

🎀 Wallet options 🎀

  • -addresstype — what type of addresses to use ("legacy", "p2sh-segwit", "bech32", or "bech32m", default: "bech32") 💳
  • -avoidpartialspends — group outputs by address, selecting many (possibly all) or none, instead of selecting on a per-output basis. Privacy goes up because addresses are mostly swept with fewer transactions and outputs get aggregated into clean change addresses 🧼 but heads up: it may also result in higher fees, because coin selection is less optimal thanks to this added limitation, and possibly because a larger-than-necessary number of inputs gets used. Always enabled for wallets with "avoid_reuse" enabled, otherwise default: 0.
  • -changetype — what type of change to use ("legacy", "p2sh-segwit", "bech32", or "bech32m"). Default is "legacy" when -addresstype=legacy, otherwise it's an implementation detail 🙈
  • -consolidatefeerate=<amt> — the maximum feerate (in GRS/kvB) at which transaction building may use more inputs than strictly necessary, so that the wallet's UTXO pool can be reduced (default: 0.0001) 🧹
  • -disablewallet — do not load the wallet and disable wallet RPC calls 🚫
  • -discardfee=<amt> — the fee rate (in GRS/kvB) that signals your tolerance for discarding change by adding it to the fee (default: 0.0001). Note: an output is discarded if it is dust at this rate, but we will always discard up to the dust relay fee, and a discard fee above that is limited by the fee estimate for the longest target.
  • -fallbackfee=<amt> — a fee rate (in GRS/kvB) used when fee estimation has insufficient data. Set it to 0 to entirely disable the fallbackfee feature. (default: 0.0002)
  • -keypool=<n> — set key pool size to <n> (default: 1000).
⚠️ Warning: smaller sizes may increase the risk of losing funds when restoring from an old backup, if none of the addresses in the original keypool have been used. Like, don't do it.
  • -maxapsfee=<n> — spend up to this amount in additional (absolute) fees (in GRS) if it allows the use of partial spend avoidance (default: 0.00) 💸
  • -mintxfee=<amt> — fee rates (in GRS/kvB) smaller than this are considered zero fee for transaction creation (default: 0.00001)
  • -paytxfee=<amt> — fee rate (in GRS/kvB) to add to transactions you send (default: 0.00) 💰
  • -signer=<cmd> — external signing tool, see doc/external-signer.md 🖊️
  • -spendzeroconfchange — spend unconfirmed change when sending transactions (default: 1)
  • -txconfirmtarget=<n> — if paytxfee is not set, include enough fee so transactions begin confirmation on average within n blocks (default: 6) ⏱️
  • -wallet=<path> — specify a wallet path to load at startup. Can be used multiple times to load multiple wallets 👜 the path is to a directory containing wallet data and log files. If the path isn't absolute, it's interpreted relative to <walletdir>. This only loads existing wallets and does not create new ones, ok? For backwards compatibility it also accepts names of existing top-level data files in <walletdir>.
  • -walletbroadcast — make the wallet broadcast transactions (default: 1) 📡
  • -walletdir=<dir> — specify the directory to hold wallets (default: <datadir>/wallets if it exists, otherwise <datadir>)
  • -walletnotify=<cmd> — execute a command when a wallet transaction changes 🔔 %s in cmd is replaced by TxID, %w is replaced by wallet name, %b is replaced by the hash of the block including the transaction (set to 'unconfirmed' if the transaction is not included) and %h is replaced by the block height (-1 if not included). %w is not currently implemented on windows. On systems where %w is supported, it should NOT be quoted, because that would break the shell escaping used to invoke the command 🙅‍♀️
  • -walletrbf — send transactions with full-RBF opt-in enabled (RPC only, default: 1) 🚀

🧚 Debugging/Testing options 🧚

  • -debug=<category> — output debug and trace logging (default: -nodebug, and supplying <category> is optional). If <category> isn't supplied, or if it's 1 or "all", you get all the debug logging 💥 if <category> is 0 or "none", any other categories are ignored. Other valid values for <category> are: addrman, bench, blockstorage, cmpctblock, coindb, estimatefee, http, i2p, ipc, leveldb, libevent, mempool, mempoolrej, net, proxy, prune, qt, rand, reindex, rpc, scan, selectcoins, tor, txpackages, txreconciliation, validation, walletdb, zmq. This option can be specified multiple times to output multiple categories 👑
  • -debugexclude=<category> — exclude debug and trace logging for a category. Can be used together with -debug=1 to output debug and trace logging for every category except the specified one 🙈 this option can be specified multiple times to exclude multiple categories. This takes priority over "-debug".
  • -help-debug — print the help message with debugging options and exit 📖
  • -logips — include IP addresses in debug output (default: 0)
  • -loglevelalways — always prepend a category and level (default: 0)
  • -logsourcelocations — prepend debug output with the name of the originating source location (source file, line number and function name) (default: 0) 📍
  • -logthreadnames — prepend debug output with the name of the originating thread (default: 0) 🧵
  • -logtimestamps — prepend debug output with a timestamp (default: 1) ⏰
  • -maxtxfee=<amt> — maximum total fees (in GRS) to use in a single wallet transaction.
💀 setting this too low may abort large transactions! (default: 0.10)
  • -printtoconsole — send trace/debug info to console (default: 1 when no -daemon. To disable logging to file, set -nodebuglogfile) 📝
  • -shrinkdebugfile — shrink debug.log file on client startup (default: 1 when no -debug)
  • -uacomment=<cmt> — append a comment to the user agent string 🏷️

🌈 Chain selection options 🌈

  • -chain=<chain> — use the chain <chain> (default: main). Allowed values: main, test, testnet4, signet, regtest 🔗
  • -signet — use the signet chain. Equivalent to -chain=signet. Note that the network is defined by the -signetchallenge parameter 💫
  • -signetchallenge — blocks must satisfy the given script to be considered valid (only for signet networks; defaults to the global default signet test network challenge) 🧩
  • -signetseednode — specify a seed node for the signet network, in the hostname[:port] format, e.g. sig.net:1234 (may be used multiple times to specify multiple seed nodes; defaults to the global default signet test network seed node(s)) 🌱
  • -testnet —
  • -testnet3 — uses the testnet3 chain, equivalent to -chain=test. ngl bestie, support for testnet3 is deprecated and it's getting removed in an upcoming release, so consider sliding over to testnet4 now with -testnet4. 💀
  • -testnet4 — uses the testnet4 chain. Equivalent to -chain=testnet4. slay, the fresh one ✨

Node relay options:

  • -bytespersigop — equivalent bytes per sigop in transactions, for relay and mining (default: 20)
  • -datacarrier — relay and mine data carrier transactions (default: 1)
  • -datacarriersize — relay and mine transactions whose data-carrying raw scriptPubKey is this size or smaller (default: 83)
  • -minrelaytxfee=<amt> — fees (in GRS/kvB) below this are treated as zero fee for relaying, mining and transaction creation (default: 0.00001)
  • -permitbaremultisig — relay transactions that create non-P2SH multisig outputs (default: 1)
  • -whitelistforcerelay — gives whitelisted peers with default permissions the 'forcerelay' permission. this relays transactions even if they were already chillin' in the mempool (default: 0)
  • -whitelistrelay — gives whitelisted peers with default permissions the 'relay' permission. this accepts relayed transactions even when it isn't relaying transactions itself (default: 1)

Block creation options:

  • -blockmaxweight=<n> — sets the maximum BIP141 block weight (default: 4000000) 👑
  • -blockmintxfee=<amt> — sets the lowest fee rate (in GRS/kvB) for transactions to be included in block creation (default: 0.00001)
  • -blockreservedweight=<n> — reserves space for the fixed-size block header plus the largest coinbase transaction the mining software might add to the block (default: 8000).

RPC server options:

  • -rest — accept public REST requests (default: 0)
  • -rpcallowip=<ip> — allow JSON-RPC connections from the specified source. valid <ip> values are a single IP (e.g. 1.2.3.4), a network/netmask (e.g. 1.2.3.4/255.255.255.0), a network/CIDR (e.g. 1.2.3.4/24), all ipv4 (0.0.0.0/0), or all ipv6 (::/0). this option can be specified multiple times 🫶
  • -rpcauth=<userpw> — username and HMAC-SHA-256 hashed password for JSON-RPC connections. the <userpw> field comes in the format: <USERNAME>:<SALT>$<HASH>. a canonical python script is included in share/rpcauth. the client then connects normally using the rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. this option can be specified multiple times
  • -rpcbind=<addr>[:port] — bind to the given address to listen for JSON-RPC connections.
⚠️ do NOT expose the RPC server to untrusted networks like the public internet, bestie, i'm so serious 🙈 this option is ignored unless -rpcallowip is also passed. the port is optional and overrides -rpcport. use [host]:port notation for IPv6. this option can be specified multiple times (default: 127.0.0.1 and ::1, aka localhost)
  • -rpccookiefile=<loc> — location of the auth cookie. relative paths get prefixed by a net-specific datadir location. (default: data dir) 🍪
  • -rpccookieperms=<readable-by> — sets permissions on the RPC auth cookie file so it's readable by [owner|group|all] (default: owner [via umask 0077])
  • -rpcpassword=<pw> — password for JSON-RPC connections
  • -rpcport=<port> — listen for JSON-RPC connections on <port> (default: 1441, testnet3: 17766, testnet4: 41441, signet: 31441, regtest: 18443)
  • -rpcthreads=<n> — sets the number of threads servicing RPC calls (default: 16)
  • -rpcuser=<user> — username for JSON-RPC connections
  • -rpcwhitelist=<whitelist> — sets a whitelist to filter incoming RPC calls for a specific user. the <whitelist> field comes in the format: <USERNAME>:<rpc 1>,<rpc 2>,...,<rpc n>. if multiple whitelists are set for one user, they're set-intersected 🔀. check the -rpcwhitelistdefault docs for how default whitelist behavior works.
  • -rpcwhitelistdefault — sets the default behavior for rpc whitelisting. unless rpcwhitelistdefault is set to 0, if any -rpcwhitelist is set, the rpc server acts as if all rpc users are subject to empty-unless-otherwise-specified whitelists. if rpcwhitelistdefault is set to 1 and no -rpcwhitelist is set, the rpc server acts as if all rpc users are subject to empty whitelists.
  • -server — accept command line and JSON-RPC commands

Copyright (C) 2014-2025 The Groestlcoin Core developers Copyright (C) 2009-2025 The Bitcoin Core developers

please contribute if you find Groestlcoin Core useful, fr fr 🫶 visit <https://groestlcoin.org/> for more info about the software. the source code lives at <https://github.com/Groestlcoin/groestlcoin>.

this is experimental software, bestie — not a drill 💀 distributed under the MIT software license, see the accompanying file COPYING or <https://opensource.org/licenses/MIT>

🌈 SEE ALSO

groestlcoind(1), groestlcoin-cli(1), groestlcoin-tx(1), groestlcoin-wallet(1), groestlcoin-util(1), groestlcoin-qt(1)

and that's a wrap, bestie 🎀 this is groestlcoind v29.0.0, dated April 2025 — go read the other pages, you're gonna slay ✨💅

📦 where this page comes from