Skip to content

Instantly share code, notes, and snippets.

@b-rucel
Created August 5, 2022 17:04
Show Gist options
  • Save b-rucel/bd826eb16caeadc64c78554cd8b76716 to your computer and use it in GitHub Desktop.
Save b-rucel/bd826eb16caeadc64c78554cd8b76716 to your computer and use it in GitHub Desktop.
pivxd
PIVX Core Daemon version v5.4.0
Usage: pivxd [options] Start PIVX Core Daemon
#### Options:
-?
This help message
- version
Print version and exit
-alertnotify=<cmd>
Execute command when a relevant alert is received or we see a really
long fork (%s in cmd is replaced by message)
-blocksdir=<dir>
Specify directory to hold blocks subdirectory for *.dat files (default:
<datadir>)
-blocknotify=<cmd>
Execute command when the best block changes (%s in cmd is replaced by
block hash)
-checkblocks=<n>
How many blocks to check at startup (default: 6, 0 = all)
-checklevel=<n>
How thorough the block verification of -checkblocks is (0-4, default: 3)
-conf=<file>
Specify configuration file (default: pivx.conf)
-daemon
Run in the background as a daemon and accept commands
-datadir=<dir>
Specify data directory
-paramsdir=<dir>
Specify zk params directory (default: /crypto/.pivx-params)
-debuglogfile=<file>
Specify location of debug log file: this can be an absolute path or a
path relative to the data directory (default: debug.log)
-disablesystemnotifications
Disable OS notifications for incoming transactions (default: 0)
-dbcache=<n>
Set database cache size in megabytes (4 to 16384, default: 300)
-loadblock=<file>
Imports blocks from external blk000??.dat file on startup
-maxreorg=<n>
Set the Maximum reorg depth (default: 100)
-maxorphantx=<n>
Keep at most <n> unconnectable transactions in memory (default: 25)
-maxmempool=<n>
Keep the transaction memory pool below <n> megabytes (default: 300)
-mempoolexpiry=<n>
Do not keep transactions in the mempool longer than <n> hours (default:
72)
-persistmempool
Whether to save the mempool on shutdown and load on restart (default: 1)
-par=<n>
Set the number of script verification threads (-1 to 16, 0 = auto, <0 =
leave that many cores free, default: 0)
-pid=<file>
Specify pid file (default: pivx.pid)
-reindex-chainstate
Rebuild chain state from the currently indexed blocks
-reindex
Rebuild block chain index from current blk000??.dat files on startup
-resync
Delete blockchain folders and resync from scratch on startup
-sysperms
Create new files with system default permissions, instead of umask 077
(only effective with disabled wallet functionality)
-txindex
Maintain a full transaction index, used by the getrawtransaction rpc
call (default: 1)
-forcestart
Attempt to force blockchain corruption recovery on startup
Connection options:
-addnode=<ip>
Add a node to connect to and attempt to keep the connection open
-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.
-banscore=<n>
Threshold for disconnecting misbehaving peers (default: 100)
-bantime=<n>
Number of seconds to keep misbehaving peers from reconnecting (default:
86400)
-bind=<addr>
Bind to given address and always listen on it. Use [host]:port notation
for IPv6
-connect=<ip>
Connect only to the specified node(s); -noconnect or -connect=0 alone to
disable automatic connections
-discover
Discover own IP address (default: 1 when listening and no -externalip)
-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/-noconnect)
-externalip=<ip>
Specify your own public address
-forcednsseed
Always query for peer addresses via DNS lookup (default: 0)
-listen
Accept connections from outside (default: 1 if no -proxy or
-connect/-noconnect)
-listenonion
Automatically create Tor hidden service (default: 1)
-maxconnections=<n>
Maintain at most <n> connections to peers (default: 125)
-maxreceivebuffer=<n>
Maximum per-connection receive buffer, <n>*1000 bytes (default: 5000)
-maxsendbuffer=<n>
Maximum per-connection send buffer, <n>*1000 bytes (default: 1000)
-onion=<ip:port>
Use separate SOCKS5 proxy to reach peers via Tor hidden services
(default: -proxy)
-onlynet=<net>
Only connect to nodes in network <net> (ipv4, ipv6 or onion)
-permitbaremultisig
Relay non-P2SH multisig (default: 1)
-peerbloomfilters
Support filtering of blocks and transaction with bloom filters (default:
1)
-port=<port>
Listen for connections on <port> (default: 51472 or testnet: 51474)
-proxy=<ip:port>
Connect through SOCKS5 proxy
-proxyrandomize
Randomize credentials for every proxy connection. This enables Tor
stream isolation (default: 1)
-seednode=<ip>
Connect to a node to retrieve peer addresses, and disconnect
-timeout=<n>
Specify connection timeout in milliseconds (minimum: 1, default: 5000)
-torcontrol=<ip>:<port>
Tor control port to use if onion listening enabled (default:
127.0.0.1:9051)
-torpassword=<pass>
Tor control port password (default: empty)
-upnp
Use UPnP to map the listening port (default: 0)
-natpmp
Use NAT-PMP to map the listening port (default: 0)
-whitebind=<addr>
Bind to given address and whitelist peers connecting to it. Use
[host]:port notation for IPv6
-whitelist=<netmask>
Whitelist peers connecting from the given netmask or IP address. Can be
specified multiple times. Whitelisted peers cannot be DoS banned and
their transactions are always relayed, even if they are already in the
mempool, useful e.g. for a gateway
Wallet options:
-createwalletbackups=<n>
Number of automatic wallet backups (default: 10)
-disablewallet
Do not load the wallet and disable wallet RPC calls (default: 0)
-keypool=<n>
Set key pool size to <n> (default: 100)
-legacywallet
On first run, create a legacy wallet instead of a HD wallet
-maxtxfee=<amt>
Maximum total fees to use in a single wallet transaction, setting too
low may abort large transactions (default: 1.00)
-mintxfee=<amt>
Fees (in PIV/Kb) smaller than this are considered zero fee for
transaction creation (default: 0.0001)
-paytxfee=<amt>
Fee (in PIV/kB) to add to transactions you send (default: 0.00)
-rescan
Rescan the block chain for missing wallet transactions on startup
-salvagewallet
Attempt to recover private keys from a corrupt wallet file on startup
-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: 1)
-upgradewallet
Upgrade wallet to latest format on startup
-wallet=<path>
Specify wallet database path. Can be specified multiple times to load
multiple wallets. Path is interpreted relative to <walletdir> if it is
not absolute, and will be created if it does not exist (as a directory
containing a wallet.dat file and log files). For backwards compatibility
this will also accept names of existing data files in <walletdir>.)
-walletdir=<dir>
Specify directory to hold wallets (default: <datadir>/wallets if it
exists, otherwise <datadir>)
-walletnotify=<cmd>
Execute command when a wallet transaction changes (%s in cmd is replaced
by TxID)
-zapwallettxes=<mode>
Delete all wallet transactions and only recover those parts of the
blockchain through -rescan on startup(1 = keep tx meta data e.g. payment
request information, 2 = drop tx meta data)
Mining/Staking options:
-coldstaking=<n>
Enable cold staking functionality (0-1, default: 1). Disabled if
staking=0
-gen
Generate coins (default: 0)
-genproclimit=<n>
Set the number of threads for coin generation if enabled (-1 = all
cores, default: 1)
-minstakesplit=<amt>
Minimum positive amount (in PIV) allowed by GUI and RPC for the stake
split threshold (default: 100.00)
-staking=<n>
Enable staking functionality (0-1, default: 1)
ZeroMQ notification options:
-zmqpubhashblock=<address>
Enable publish hash block in <address>
-zmqpubhashtx=<address>
Enable publish hash transaction in <address>
-zmqpubrawblock=<address>
Enable publish raw block in <address>
-zmqpubrawtx=<address>
Enable publish raw transaction in <address>
Debugging/Testing options:
-uacomment=<cmt>
Append comment to the user agent string
-debug=<category>
Output debugging information (default: 0, supplying <category> is
optional). If <category> is not supplied, output all debugging
information. <category> can be: net, tor, mempool, http, bench, zmq, db,
rpc, estimatefee, addrman, selectcoins, reindex, cmpctblock, rand,
prune, proxy, mempoolrej, libevent, coindb, qt, leveldb, staking,
masternode, mnbudget, zero, mnping, sapling, sporks, validation.
-debugexclude=<category>
Exclude debugging information for a category. Can be used in conjunction
with -debug=1 to output debug logs for all categories except one or more
specified categories.
-help-debug
Show all debugging options (usage: --help -help-debug)
-logips
Include IP addresses in debug output (default: 0)
-logtimestamps
Prepend debug output with timestamp (default: 1)
-logtimemicros
Add microsecond precision to debug timestamps (default: 0)
-maxtipage=<n>
Maximum tip age in seconds to consider node in initial block download
(default: 86400)
-minrelaytxfee=<amt>
Fees (in PIV/Kb) smaller than this are considered zero fee for relaying,
mining and transaction creation (default: 0.0001)
-printtoconsole
Send trace/debug info to console instead of debug.log file (default: 0)
-shrinkdebugfile
Shrink debug.log file on client startup (default: 1 when no -debug)
Chain selection options:
-testnet
Use the test chain
-litemode=<n>
Disable all PIVX specific functionality (Masternodes, Budgeting) (0-1,
default: 0)
#### Masternode options:
- masternode=<n>
Enable the client to act as a masternode (0-1, default: 0)
- mnconf=<file>
Specify masternode configuration file (default: masternode.conf)
- mnconflock=<n>
Lock masternodes from masternode configuration file (default: 1)
- masternodeprivkey=<n>
Set the masternode private key
-masternodeaddr=<n>
Set external address:port to get to this masternode (example:
128.127.106.235:51472)
-budgetvotemode=<mode>
Change automatic finalized budget voting behavior. mode=auto: Vote for
only exact finalized budget match to my generated budget. (string,
default: auto)
-mnoperatorprivatekey=<WIF>
Set the masternode operator private key. Only valid with -masternode=1.
When set, the masternode acts as a deterministic masternode.
Node relay options:
-datacarrier
Relay and mine data carrier transactions (default: 1)
-datacarriersize
Maximum size of data in data carrier transactions we relay and mine
(default: 83)
Block creation options:
-blockmaxsize=<n>
Set maximum block size in bytes (default: 750000)
RPC server options:
-server
Accept command line and JSON-RPC commands
-rest
Accept public REST requests (default: 0)
-rpcbind=<addr>
Bind to given address to listen for JSON-RPC connections. Do not expose
the RPC server to untrusted networks such as the public internet! This
option is ignored unless -rpcallowip is also passed. 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 i.e.,
localhost)
-rpccookiefile=<loc>
Location of the auth cookie (default: data dir)
-rpcuser=<user>
Username for JSON-RPC connections
-rpcpassword=<pw>
Password for JSON-RPC connections
-rpcauth=<userpw>
Username and hashed password for JSON-RPC connections. The field
<userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A canonical
python script is included in share/rpcuser. The client then connects
normally using the rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of
arguments. This option can be specified multiple times
-rpcport=<port>
Listen for JSON-RPC connections on <port> (default: 51473 or testnet:
51475)
-rpcallowip=<ip>
Allow JSON-RPC connections from specified source. Valid for <ip> are a
single IP (e.g. 1.2.3.4), a network/netmask (e.g. 1.2.3.4/255.255.255.0)
or a network/CIDR (e.g. 1.2.3.4/24). This option can be specified
multiple times
-rpcthreads=<n>
Set the number of threads to service RPC calls (default: 4)
-blockspamfilter=<n>
Use block spam filter (default: 1)
-blockspamfiltermaxsize=<n>
Maximum size of the list of indexes in the block spam filter (default:
100)
-blockspamfiltermaxavg=<n>
Maximum average size of an index occurrence in the block spam filter
(default: 10)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment