From b221f4e624e79e7d9ab0a3ac74a9a3ffdf2ca010 Mon Sep 17 00:00:00 2001 From: Andrew Poelstra Date: Wed, 22 Sep 2021 16:42:40 +0000 Subject: [PATCH] doc: update manpages for 0.21.0 Basically I just ran for bin in elements-cli elementsd elements-tx elements-wallet do help2man ./src/$bin > ./doc/man/$bin.1 echo "Done $bin" done --- doc/man/elements-cli.1 | 130 +++++++-- doc/man/elements-tx.1 | 107 +++++-- doc/man/elements-wallet.1 | 181 ++++++++++-- doc/man/elementsd.1 | 568 ++++++++++++++++++++++++++++++++------ 4 files changed, 820 insertions(+), 166 deletions(-) diff --git a/doc/man/elements-cli.1 b/doc/man/elements-cli.1 index 1f0b48904d..55c21d0e59 100644 --- a/doc/man/elements-cli.1 +++ b/doc/man/elements-cli.1 @@ -1,7 +1,7 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.10. -.TH ELEMENTS-CLI "1" "May 2019" "elements-cli v0.17.0.1" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.3. +.TH ELEMENTS-CLI "1" "September 2021" "elements-cli elements-0.21.0_rc1" "User Commands" .SH NAME -elements-cli \- manual page for elements-cli v0.17.0.1 +elements-cli \- manual page for elements-cli elements-0.21.0_rc1 .SH SYNOPSIS .B elements-cli [\fI\,options\/\fR] \fI\, \/\fR[\fI\,params\/\fR] \fI\,Send command to Elements Core\/\fR @@ -15,7 +15,7 @@ elements-cli \- manual page for elements-cli v0.17.0.1 .B elements-cli [\fI\,options\/\fR] \fI\,help Get help for a command\/\fR .SH DESCRIPTION -Elements Core RPC client version v0.17.0.1\-dirty +Elements Core RPC client version elements\-0.21.0_rc1 .SH OPTIONS .HP \-? @@ -31,6 +31,15 @@ location. (default: elements.conf) .IP Specify data directory .HP +\fB\-generate\fR +.IP +Generate blocks immediately, equivalent to RPC generatenewaddress +followed by RPC generatetoaddress. Optional positional integer +arguments are number of blocks to generate (default: 1) and +maximum iterations to try (default: 1000000), equivalent to RPC +generatetoaddress nblocks and maxtries arguments. Example: +bitcoin\-cli \fB\-generate\fR 4 1000 +.HP \fB\-getinfo\fR .IP Get general information from the remote server. Note that unlike @@ -43,6 +52,12 @@ be as of a different block from the chain state reported) .IP Pass named instead of positional arguments (default: false) .HP +\fB\-netinfo\fR +.IP +Get network peer connection information from the remote server. An +optional integer argument from 0 to 4 can be passed for different +peers listings (default: 0). +.HP \fB\-rpcclienttimeout=\fR .IP Timeout in seconds during HTTP requests, or 0 for no timeout. (default: @@ -63,8 +78,8 @@ Password for JSON\-RPC connections .HP \fB\-rpcport=\fR .IP -Connect to JSON\-RPC on (default: 8332, testnet: 18332, regtest: -18443) +Connect to JSON\-RPC on (default: 7041, testnet: 18332, signet: +38332, regtest: 18443) .HP \fB\-rpcuser=\fR .IP @@ -77,7 +92,7 @@ Wait for RPC server to start \fB\-rpcwallet=\fR .IP Send RPC for non\-default wallet on RPC server (needs to exactly match -corresponding \fB\-wallet\fR option passed to the daemon). This changes +corresponding \fB\-wallet\fR option passed to elementsd). This changes the RPC endpoint used, e.g. http://127.0.0.1:8332/wallet/ .HP @@ -92,18 +107,28 @@ is used for the RPC password. .IP Read RPC password from standard input as a single line. When combined with \fB\-stdin\fR, the first line from standard input is used for the -RPC password. +RPC password. When combined with \fB\-stdinwalletpassphrase\fR, +\fB\-stdinrpcpass\fR consumes the first line, and \fB\-stdinwalletpassphrase\fR +consumes the second. +.HP +\fB\-stdinwalletpassphrase\fR +.IP +Read wallet passphrase from standard input as a single line. When +combined with \fB\-stdin\fR, the first line from standard input is used +for the wallet passphrase. .HP \fB\-version\fR .IP Print version and exit .PP +Debugging/Testing options: +.PP Chain selection options: .HP \fB\-chain=\fR .IP -Use the chain (default: main). Reserved values: main, test, -regtest +Use the chain (default: liquidv1). Reserved values: main, test, +signet, regtest, liquidv1, liquidv1test .HP \fB\-con_blockheightinheader\fR .IP @@ -136,7 +161,8 @@ signatures are necessary to solve it. .HP \fB\-fedpegscript\fR .IP -The script for the federated peg. +The script for the federated peg enforce from genesis block. This script +may stop being enforced once dynamic federations activates. .HP \fB\-parentgenesisblockhash\fR .IP @@ -147,9 +173,27 @@ The genesis blockhash of the parent chain. Signed blockchain enumberance. Only active when `\-con_signed_blocks` set to true. .HP +\fB\-signet\fR +.IP +Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network +is defined by the \fB\-signetchallenge\fR parameter +.HP +\fB\-signetchallenge\fR +.IP +Blocks must satisfy the given script to be considered valid (only for +signet networks; defaults to the global default signet test +network challenge) +.HP +\fB\-signetseednode\fR +.IP +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)) +.HP \fB\-testnet\fR .IP -Use the test chain +Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. .PP Elements Options: .HP @@ -158,7 +202,7 @@ Elements Options: Defines the amount of block subsidy to start with, at genesis block, in satoshis. .HP -\fB\-con_connect_coinbase\fR +\fB\-con_connect_genesis_outputs\fR .IP Connect outputs in genesis block to utxo database. .HP @@ -167,6 +211,18 @@ Connect outputs in genesis block to utxo database. Starting height for CSV deployment. (default: \fB\-1\fR, which means ACTIVE from genesis) .HP +\fB\-con_dyna_deploy_signal\fR +.IP +Whether to signal for the Dynamic Federations deployment (default: +false). +.HP +\fB\-con_dyna_deploy_start\fR +.IP +Starting height for Dynamic Federations deployment. Once active, +signblockscript becomes a BIP141 WSH scriptPubKey of the original +signblockscript. All other dynamic parameters stay +constant.(default: \fB\-1\fR, which means ACTIVE from genesis) +.HP \fB\-con_elementsmode\fR .TP Use Elements\-like instead of Core\-like witness encoding. @@ -179,27 +235,45 @@ required for CA/CT. (default: true) All non\-zero valued coinbase outputs must go to this scriptPubKey, if set. .HP +\fB\-con_taproot_signal_start\fR +.IP +Whether, and at what blockheight, to start signalling for Taproot +activation (default: false) (regtest, Liquid testnet, or custom +only). +.HP +\fB\-dynamic_epoch_length\fR +.IP +Per\-chain parameter that sets how many blocks dynamic federation voting +and enforcement are in effect for. +.HP \fB\-enforce_pak\fR .IP Causes standardness checks to enforce Pegout Authorization Key(PAK) -validation, and miner to include PAK commitments when configured. -Can not be set when acceptnonstdtx is set to true. +validation before dynamic federations, and consensus enforcement +after. .HP \fB\-multi_data_permitted\fR .IP -Allow relay of multiple OP_RETURN outputs. (default: true) +Allow relay of multiple OP_RETURN outputs. (default: \fB\-enforce_pak\fR) .HP \fB\-pak\fR .IP -Entries in the PAK list. Order of entries matter. -.SH COPYRIGHT -Copyright (C) 2009-2019 The Elements Project developers -Copyright (C) 2009-2019 The Bitcoin Core developers - -Please contribute if you find Elements Core useful. Visit - for further information about the software. -The source code is available from . - -This is experimental software. -Distributed under the MIT software license, see the accompanying file COPYING -or +Sets the 'first extension space' field to the pak entries ala +pre\-dynamic federations. Only used for testing in custom chains. +.HP +\fB\-total_valid_epochs\fR +.IP +Per\-chain parameter that sets how long a particular fedpegscript is in +effect for. +.SH "SEE ALSO" +The full documentation for +.B elements-cli +is maintained as a Texinfo manual. If the +.B info +and +.B elements-cli +programs are properly installed at your site, the command +.IP +.B info elements-cli +.PP +should give you access to the complete manual. diff --git a/doc/man/elements-tx.1 b/doc/man/elements-tx.1 index d22150ed69..c758e3291f 100644 --- a/doc/man/elements-tx.1 +++ b/doc/man/elements-tx.1 @@ -1,7 +1,7 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.10. -.TH ELEMENTS-TX "1" "May 2019" "elements-tx v0.17.0.1" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.3. +.TH ELEMENTS-TX "1" "September 2021" "elements-tx elements-0.21.0_rc1" "User Commands" .SH NAME -elements-tx \- manual page for elements-tx v0.17.0.1 +elements-tx \- manual page for elements-tx elements-0.21.0_rc1 .SH SYNOPSIS .B elements-tx [\fI\,options\/\fR] \fI\, \/\fR[\fI\,commands\/\fR] \fI\,Update hex-encoded bitcoin transaction\/\fR @@ -9,12 +9,12 @@ elements-tx \- manual page for elements-tx v0.17.0.1 .B elements-tx [\fI\,options\/\fR] \fI\,-create \/\fR[\fI\,commands\/\fR] \fI\,Create hex-encoded bitcoin transaction\/\fR .SH DESCRIPTION -Elements Core elements\-tx utility version v0.17.0.1\-dirty +Elements Core elements\-tx utility version elements\-0.21.0_rc1 .SH OPTIONS .HP \-? .IP -This help message +Print this help message and exit .HP \fB\-create\fR .IP @@ -28,12 +28,14 @@ Select JSON output .IP Output only the hex\-encoded transaction id of the resultant transaction. .PP +Debugging/Testing options: +.PP Chain selection options: .HP \fB\-chain=\fR .IP -Use the chain (default: main). Reserved values: main, test, -regtest +Use the chain (default: liquidv1). Reserved values: main, test, +signet, regtest, liquidv1, liquidv1test .HP \fB\-con_blockheightinheader\fR .IP @@ -66,7 +68,8 @@ signatures are necessary to solve it. .HP \fB\-fedpegscript\fR .IP -The script for the federated peg. +The script for the federated peg enforce from genesis block. This script +may stop being enforced once dynamic federations activates. .HP \fB\-parentgenesisblockhash\fR .IP @@ -77,17 +80,36 @@ The genesis blockhash of the parent chain. Signed blockchain enumberance. Only active when `\-con_signed_blocks` set to true. .HP +\fB\-signet\fR +.IP +Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network +is defined by the \fB\-signetchallenge\fR parameter +.HP +\fB\-signetchallenge\fR +.IP +Blocks must satisfy the given script to be considered valid (only for +signet networks; defaults to the global default signet test +network challenge) +.HP +\fB\-signetseednode\fR +.IP +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)) +.HP \fB\-testnet\fR .IP -Use the test chain +Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. .PP Elements Options: .HP \fB\-con_blocksubsidy\fR .IP -Defines the amount of block subsidy to start with, at genesis block. +Defines the amount of block subsidy to start with, at genesis block, in +satoshis. .HP -\fB\-con_connect_coinbase\fR +\fB\-con_connect_genesis_outputs\fR .IP Connect outputs in genesis block to utxo database. .HP @@ -96,6 +118,18 @@ Connect outputs in genesis block to utxo database. Starting height for CSV deployment. (default: \fB\-1\fR, which means ACTIVE from genesis) .HP +\fB\-con_dyna_deploy_signal\fR +.IP +Whether to signal for the Dynamic Federations deployment (default: +false). +.HP +\fB\-con_dyna_deploy_start\fR +.IP +Starting height for Dynamic Federations deployment. Once active, +signblockscript becomes a BIP141 WSH scriptPubKey of the original +signblockscript. All other dynamic parameters stay +constant.(default: \fB\-1\fR, which means ACTIVE from genesis) +.HP \fB\-con_elementsmode\fR .TP Use Elements\-like instead of Core\-like witness encoding. @@ -108,19 +142,36 @@ required for CA/CT. (default: true) All non\-zero valued coinbase outputs must go to this scriptPubKey, if set. .HP +\fB\-con_taproot_signal_start\fR +.IP +Whether, and at what blockheight, to start signalling for Taproot +activation (default: false) (regtest, Liquid testnet, or custom +only). +.HP +\fB\-dynamic_epoch_length\fR +.IP +Per\-chain parameter that sets how many blocks dynamic federation voting +and enforcement are in effect for. +.HP \fB\-enforce_pak\fR .IP Causes standardness checks to enforce Pegout Authorization Key(PAK) -validation, and miner to include PAK commitments when configured. -Can not be set when acceptnonstdtx is set to true. +validation before dynamic federations, and consensus enforcement +after. .HP \fB\-multi_data_permitted\fR .IP -Allow relay of multiple OP_RETURN outputs. (default: true) +Allow relay of multiple OP_RETURN outputs. (default: \fB\-enforce_pak\fR) .HP \fB\-pak\fR .IP -Entries in the PAK list. Order of entries matter. +Sets the 'first extension space' field to the pak entries ala +pre\-dynamic federations. Only used for testing in custom chains. +.HP +\fB\-total_valid_epochs\fR +.IP +Per\-chain parameter that sets how long a particular fedpegscript is in +effect for. .PP Commands: .IP @@ -180,7 +231,7 @@ sign=SIGHASH\-FLAGS .IP Add zero or more signatures to transaction. This command requires JSON registers:prevtxs=JSON object, privatekeys=JSON object. See -signrawtransaction docs for format of sighash flags, JSON +signrawtransactionwithkey docs for format of sighash flags, JSON objects. .PP Register Commands: @@ -197,15 +248,15 @@ Load JSON file FILENAME into register NAME set=NAME:JSON\-STRING .IP Set register NAME to given JSON\-STRING -.SH COPYRIGHT -Copyright (C) 2009-2019 The Elements Project developers -Copyright (C) 2009-2019 The Bitcoin Core developers - -Please contribute if you find Elements Core useful. Visit - for further information about the software. -The source code is available from . - -This is experimental software. -Distributed under the MIT software license, see the accompanying file COPYING -or - +.SH "SEE ALSO" +The full documentation for +.B elements-tx +is maintained as a Texinfo manual. If the +.B info +and +.B elements-tx +programs are properly installed at your site, the command +.IP +.B info elements-tx +.PP +should give you access to the complete manual. diff --git a/doc/man/elements-wallet.1 b/doc/man/elements-wallet.1 index b6bc88cf58..cb888494aa 100644 --- a/doc/man/elements-wallet.1 +++ b/doc/man/elements-wallet.1 @@ -1,12 +1,12 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. -.TH ELEMENTS-WALLET "1" "February 2019" "elements-wallet v0.17.99.0" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.3. +.TH ELEMENTS-WALLET "1" "September 2021" "elements-wallet elements-0.21.0_rc1" "User Commands" .SH NAME -elements-wallet \- manual page for elements-wallet v0.17.99.0 +elements-wallet \- manual page for elements-wallet elements-0.21.0_rc1 .SH DESCRIPTION -Elements Core elements\-wallet version v0.17.99.0 +Elements Core elements\-wallet version elements\-0.21.0_rc1 .PP -wallet\-tool is an offline tool for creating and interacting with Elements Core wallet files. -By default wallet\-tool will act on wallets in the default mainnet wallet directory in the datadir. +elements\-wallet is an offline tool for creating and interacting with Elements Core wallet files. +By default elements\-wallet will act on wallets in the default mainnet wallet directory in the datadir. To change the target wallet, use the \fB\-datadir\fR, \fB\-wallet\fR and \fB\-testnet\fR/\-regtest arguments. .SS "Usage:" .IP @@ -34,13 +34,150 @@ Output debugging information (default: 0). \fB\-printtoconsole\fR .IP Send trace/debug info to console (default: 1 when no \fB\-debug\fR is true, 0 -otherwise. +otherwise). .PP Chain selection options: .HP +\fB\-chain=\fR +.IP +Use the chain (default: liquidv1). Reserved values: main, test, +signet, regtest, liquidv1, liquidv1test +.HP +\fB\-con_blockheightinheader\fR +.IP +Whether the chain includes the block height directly in the header, for +easier validation of block height in low\-resource environments. +(default: true) +.HP +\fB\-con_has_parent_chain\fR +.IP +Whether or not there is a parent chain. +.HP +\fB\-con_max_block_sig_size\fR +.IP +Max allowed witness data for the signed block header. +.HP +\fB\-con_parent_chain_signblockscript\fR +.IP +Whether parent chain uses pow or signed blocks. If the parent chain uses +signed blocks, the challenge (scriptPubKey) script. If not, an +empty string. (default: empty script [ie parent uses pow]) +.HP +\fB\-con_parentpowlimit\fR +.IP +The proof\-of\-work limit value for the parent chain. +.HP +\fB\-con_signed_blocks\fR +.IP +Signed blockchain. Uses input of `\-signblockscript` to define what +signatures are necessary to solve it. +.HP +\fB\-fedpegscript\fR +.IP +The script for the federated peg enforce from genesis block. This script +may stop being enforced once dynamic federations activates. +.HP +\fB\-parentgenesisblockhash\fR +.IP +The genesis blockhash of the parent chain. +.HP +\fB\-signblockscript\fR +.IP +Signed blockchain enumberance. Only active when `\-con_signed_blocks` set +to true. +.HP +\fB\-signet\fR +.IP +Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network +is defined by the \fB\-signetchallenge\fR parameter +.HP +\fB\-signetchallenge\fR +.IP +Blocks must satisfy the given script to be considered valid (only for +signet networks; defaults to the global default signet test +network challenge) +.HP +\fB\-signetseednode\fR +.IP +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)) +.HP \fB\-testnet\fR .IP -Use the test chain +Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. +.PP +Elements Options: +.HP +\fB\-con_blocksubsidy\fR +.IP +Defines the amount of block subsidy to start with, at genesis block, in +satoshis. +.HP +\fB\-con_connect_genesis_outputs\fR +.IP +Connect outputs in genesis block to utxo database. +.HP +\fB\-con_csv_deploy_start\fR +.IP +Starting height for CSV deployment. (default: \fB\-1\fR, which means ACTIVE +from genesis) +.HP +\fB\-con_dyna_deploy_signal\fR +.IP +Whether to signal for the Dynamic Federations deployment (default: +false). +.HP +\fB\-con_dyna_deploy_start\fR +.IP +Starting height for Dynamic Federations deployment. Once active, +signblockscript becomes a BIP141 WSH scriptPubKey of the original +signblockscript. All other dynamic parameters stay +constant.(default: \fB\-1\fR, which means ACTIVE from genesis) +.HP +\fB\-con_elementsmode\fR +.TP +Use Elements\-like instead of Core\-like witness encoding. +This is +.IP +required for CA/CT. (default: true) +.HP +\fB\-con_mandatorycoinbase\fR +.IP +All non\-zero valued coinbase outputs must go to this scriptPubKey, if +set. +.HP +\fB\-con_taproot_signal_start\fR +.IP +Whether, and at what blockheight, to start signalling for Taproot +activation (default: false) (regtest, Liquid testnet, or custom +only). +.HP +\fB\-dynamic_epoch_length\fR +.IP +Per\-chain parameter that sets how many blocks dynamic federation voting +and enforcement are in effect for. +.HP +\fB\-enforce_pak\fR +.IP +Causes standardness checks to enforce Pegout Authorization Key(PAK) +validation before dynamic federations, and consensus enforcement +after. +.HP +\fB\-multi_data_permitted\fR +.IP +Allow relay of multiple OP_RETURN outputs. (default: \fB\-enforce_pak\fR) +.HP +\fB\-pak\fR +.IP +Sets the 'first extension space' field to the pak entries ala +pre\-dynamic federations. Only used for testing in custom chains. +.HP +\fB\-total_valid_epochs\fR +.IP +Per\-chain parameter that sets how long a particular fedpegscript is in +effect for. .PP Commands: .IP @@ -51,14 +188,20 @@ Create new wallet file info .IP Get wallet info -.SH COPYRIGHT -Copyright (C) 2009-2020 The Elements Project developers -Copyright (C) 2009-2019 The Bitcoin Core developers - -Please contribute if you find Bitcoin Core useful. Visit - for further information about the software. -The source code is available from . - -This is experimental software. -Distributed under the MIT software license, see the accompanying file COPYING -or +.IP +salvage +.IP +Attempt to recover private keys from a corrupt wallet. Warning: +\&'salvage' is experimental. +.SH "SEE ALSO" +The full documentation for +.B elements-wallet +is maintained as a Texinfo manual. If the +.B info +and +.B elements-wallet +programs are properly installed at your site, the command +.IP +.B info elements-wallet +.PP +should give you access to the complete manual. diff --git a/doc/man/elementsd.1 b/doc/man/elementsd.1 index c81693970a..b1ac8ee050 100644 --- a/doc/man/elementsd.1 +++ b/doc/man/elementsd.1 @@ -1,12 +1,12 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. -.TH ELEMENTSD "1" "February 2019" "elementsd v0.17.99.0" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.3. +.TH ELEMENTSD "1" "September 2021" "elementsd elements-0.21.0_rc1" "User Commands" .SH NAME -elementsd \- manual page for elementsd v0.17.99.0 +elementsd \- manual page for elementsd elements-0.21.0_rc1 .SH SYNOPSIS .B elementsd -[\fI\,options\/\fR] \fI\,Start Elements Core Daemon\/\fR +[\fI\,options\/\fR] \fI\,Start Elements Core\/\fR .SH DESCRIPTION -Elements Core Daemon version v0.17.99.0 +Elements Core version elements\-0.21.0_rc1 .SH OPTIONS .HP \-? @@ -23,9 +23,17 @@ long fork (%s in cmd is replaced by message) If this block is in the chain assume that it and its ancestors are valid and potentially skip their script verification (0 to verify all, default: -0000000000000000002e63058c023a9a1de233554f28c7b21380b6c9003f36a8, +0000000000000000000000000000000000000000000000000000000000000000, testnet: -0000000000000037a8cd3e06cd5edbfe9dd1dbcc5dacab279376ef7cfc2b4c75) +000000000000006433d1efec504c53ca332b64963c425395515b01977bd7b3b0, +signet: +0000002a1de0f46379358c1fd09906f7ac59adf3712323ed90eb59e4c183c020) +.HP +\fB\-blockfilterindex=\fR +.IP +Maintain an index of compact filters by block (default: 0, values: +basic). If is not supplied or if = 1, indexes for +all known types are enabled. .HP \fB\-blocknotify=\fR .IP @@ -39,12 +47,20 @@ Extra transactions to keep in memory for compact block reconstructions .HP \fB\-blocksdir=\fR .IP -Specify blocks directory (default: /blocks) +Specify directory to hold blocks subdirectory for *.dat files (default: +) +.HP +\fB\-blocksonly\fR +.IP +Whether to reject transactions from network peers. Automatic broadcast +and rebroadcast of any transactions from inbound peers is +disabled, unless the peer has the 'forcerelay' permission. RPC +transactions are not affected. (default: 0) .HP \fB\-conf=\fR .IP -Specify configuration file. Relative paths will be prefixed by datadir -location. (default: elements.conf) +Specify path to read\-only configuration file. Relative paths will be +prefixed by datadir location. (default: elements.conf) .HP \fB\-daemon\fR .IP @@ -56,7 +72,9 @@ Specify data directory .HP \fB\-dbcache=\fR .IP -Set database cache size in MiB (4 to 16384, default: 450) +Maximum database cache size MiB (4 to 16384, default: 450). In +addition, unused mempool memory is shared for this cache (see +\fB\-maxmempool\fR). .HP \fB\-debuglogfile=\fR .IP @@ -71,7 +89,7 @@ Specify additional configuration file, relative to the \fB\-datadir\fR path .HP \fB\-loadblock=\fR .IP -Imports blocks from external blk000??.dat file on startup +Imports blocks from external file on startup .HP \fB\-maxmempool=\fR .IP @@ -88,7 +106,7 @@ Do not keep transactions in the mempool longer than hours (default: .HP \fB\-par=\fR .IP -Set the number of script verification threads (\fB\-8\fR to 16, 0 = auto, <0 = +Set the number of script verification threads (\fB\-64\fR to 15, 0 = auto, <0 = leave that many cores free, default: 0) .HP \fB\-persistmempool\fR @@ -122,6 +140,18 @@ Rebuild chain state from the currently indexed blocks. When in pruning mode or if blocks on disk might be corrupted, use full \fB\-reindex\fR instead. .HP +\fB\-settings=\fR +.IP +Specify path to dynamic settings data file. Can be disabled with +\fB\-nosettings\fR. File is written at runtime and not meant to be +edited by users (use elements.conf instead for custom settings). +Relative paths will be prefixed by datadir location. (default: +settings.json) +.HP +\fB\-startupnotify=\fR +.IP +Execute command on startup. +.HP \fB\-sysperms\fR .IP Create new files with system default permissions, instead of umask 077 @@ -144,19 +174,24 @@ Add a node to connect to and attempt to keep the connection open (see the `addnode` RPC command help for more info). This option can be specified multiple times to add multiple nodes. .HP -\fB\-banscore=\fR +\fB\-asmap=\fR .IP -Threshold for disconnecting misbehaving peers (default: 100) +Specify asn mapping used for bucketing of the peers (default: +ip_asn.map). Relative paths will be prefixed by the net\-specific +datadir location. .HP \fB\-bantime=\fR .IP -Number of seconds to keep misbehaving peers from reconnecting (default: +Default duration (in seconds) of manually configured bans (default: 86400) .HP -\fB\-bind=\fR +\fB\-bind=\fR[:][=onion] .IP -Bind to given address and always listen on it. Use [host]:port notation -for IPv6 +Bind to 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 +(default: 127.0.0.1:37041=onion, testnet: 127.0.0.1:18334=onion, +signet: 127.0.0.1:38334=onion, regtest: 127.0.0.1:18445=onion) .HP \fB\-connect=\fR .IP @@ -193,7 +228,7 @@ Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\ .HP \fB\-listenonion\fR .IP -Automatically create Tor hidden service (default: 1) +Automatically create Tor onion service (default: 1) .HP \fB\-maxconnections=\fR .IP @@ -215,12 +250,18 @@ amount. (default: 4200 seconds) .HP \fB\-maxuploadtarget=\fR .IP -Tries to keep outbound traffic under the given target (in MiB per 24h), -0 = no limit (default: 0) +Tries to keep outbound traffic under the given target (in MiB per 24h). +Limit does not apply to peers with 'download' permission. 0 = no +limit (default: 0) +.HP +\fB\-networkactive\fR +.IP +Enable all P2P network activity (default: 1). Can be changed by the +setnetworkactive RPC command .HP \fB\-onion=\fR .IP -Use separate SOCKS5 proxy to reach peers via Tor hidden services, set +Use separate SOCKS5 proxy to reach peers via Tor onion services, set \fB\-noonion\fR to disable (default: \fB\-proxy\fR) .HP \fB\-onlynet=\fR @@ -230,10 +271,14 @@ onion). Incoming connections are not affected by this option. This option can be specified multiple times to allow multiple networks. .HP +\fB\-peerblockfilters\fR +.IP +Serve compact block filters to peers per BIP 157 (default: 0) +.HP \fB\-peerbloomfilters\fR .IP Support filtering of blocks and transaction with bloom filters (default: -1) +0) .HP \fB\-permitbaremultisig\fR .IP @@ -241,8 +286,9 @@ Relay non\-P2SH multisig (default: 1) .HP \fB\-port=\fR .IP -Listen for connections on (default: 8333, testnet: 18333, -regtest: 18444) +Listen for connections on . Nodes not using the default ports +(default: 7042, testnet: 18333, signet: 38333, regtest: 18444) +are unlikely to get incoming connections. .HP \fB\-proxy=\fR .IP @@ -273,29 +319,35 @@ Tor control port to use if onion listening enabled (default: .IP Tor control port password (default: empty) .HP -\fB\-upnp\fR +\fB\-whitebind=\fR<[permissions@]addr> .IP -Use UPnP to map the listening port (default: 0) +Bind to the given address and add permission flags to the peers +connecting to it. Use [host]:port notation for IPv6. Allowed +permissions: 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 \fB\-blocksonly\fR 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. .HP -\fB\-whitebind=\fR +\fB\-whitelist=\fR<[permissions@]IP address or network> .IP -Bind to given address and whitelist peers connecting to it. Use -[host]:port notation for IPv6 -.HP -\fB\-whitelist=\fR -.IP -Whitelist peers connecting from the given IP address (e.g. 1.2.3.4) or -CIDR notated network (e.g. 1.2.3.0/24). 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 +Add permission flags to the peers connecting from the given IP address +(e.g. 1.2.3.4) or CIDR\-notated network (e.g. 1.2.3.0/24). Uses +the same permissions as \fB\-whitebind\fR. Can be specified multiple +times. .PP Wallet options: .HP \fB\-addresstype\fR .IP What type of addresses to use ("legacy", "p2sh\-segwit", or "bech32", -default: "p2sh\-segwit") +default: "bech32") .HP \fB\-avoidpartialspends\fR .IP @@ -303,7 +355,8 @@ Group outputs by address, selecting all or none, instead of selecting on a per\-output basis. Privacy is improved as an address is only used once (unless someone sends to it after spending from it), but may result in slightly higher fees as suboptimal coin -selection may result due to the added limitation (default: 0) +selection may result due to the added limitation (default: 0 +(always enabled for wallets with "avoid_reuse" enabled)) .HP \fB\-changetype\fR .IP @@ -327,16 +380,25 @@ limited by the fee estimate for the longest target \fB\-fallbackfee=\fR .IP A fee rate (in BTC/kB) that will be used when fee estimation has -insufficient data (default: 0.0002) +insufficient data. 0 to entirely disable the fallbackfee feature. +(default: 0.00) .HP \fB\-keypool=\fR .IP -Set key pool size to (default: 1000) +Set key pool size to (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. +.HP +\fB\-maxapsfee=\fR +.IP +Spend up to this amount in additional (absolute) fees (in BTC) if it +allows the use of partial spend avoidance (default: 0.00) .HP \fB\-mintxfee=\fR .IP Fees (in BTC/kB) smaller than this are considered zero fee for -transaction creation (default: 0.00001) +transaction creation (default: 0.000001) .HP \fB\-paytxfee=\fR .IP @@ -346,10 +408,6 @@ Fee (in BTC/kB) to add to transactions you send (default: 0.00) .IP Rescan the block chain for missing wallet transactions on startup .HP -\fB\-salvagewallet\fR -.IP -Attempt to recover private keys from a corrupt wallet on startup -.HP \fB\-spendzeroconfchange\fR .IP Spend unconfirmed change when sending transactions (default: 1) @@ -359,18 +417,15 @@ Spend unconfirmed change when sending transactions (default: 1) If paytxfee is not set, include enough fee so transactions begin confirmation on average within n blocks (default: 6) .HP -\fB\-upgradewallet\fR -.IP -Upgrade wallet to latest format on startup -.HP \fB\-wallet=\fR .IP -Specify wallet database path. Can be specified multiple times to load -multiple wallets. Path is interpreted relative to 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 .) +Specify wallet path to load at startup. Can be used multiple times to +load multiple wallets. Path is to a directory containing wallet +data and log files. If the path is not absolute, it is +interpreted relative to . This only loads existing +wallets and does not create new ones. For backwards compatibility +this also accepts names of existing top\-level data files in +. .HP \fB\-walletbroadcast\fR .IP @@ -383,18 +438,15 @@ exists, otherwise ) .HP \fB\-walletnotify=\fR .IP -Execute command when a wallet transaction changes (%s in cmd is replaced -by TxID) +Execute command when a wallet transaction changes. %s in cmd is replaced +by TxID and %w is replaced by wallet name. %w is not currently +implemented on windows. On systems where %w is supported, it +should NOT be quoted because this would break shell escaping used +to invoke the command. .HP \fB\-walletrbf\fR .IP -Send transactions with full\-RBF opt\-in enabled (RPC only, default: 0) -.HP -\fB\-zapwallettxes=\fR -.IP -Delete all wallet transactions and only recover those parts of the -blockchain through \fB\-rescan\fR on startup (1 = keep tx meta data e.g. -payment request information, 2 = drop tx meta data) +Send transactions with full\-RBF opt\-in enabled (RPC only, default: 1) .PP ZeroMQ notification options: .HP @@ -402,17 +454,43 @@ ZeroMQ notification options: .IP Enable publish hash block in
.HP +\fB\-zmqpubhashblockhwm=\fR +.IP +Set publish hash block outbound message high water mark (default: 1000) +.HP \fB\-zmqpubhashtx=\fR
.IP Enable publish hash transaction in
.HP +\fB\-zmqpubhashtxhwm=\fR +.IP +Set publish hash transaction outbound message high water mark (default: +1000) +.HP \fB\-zmqpubrawblock=\fR
.IP Enable publish raw block in
.HP +\fB\-zmqpubrawblockhwm=\fR +.IP +Set publish raw block outbound message high water mark (default: 1000) +.HP \fB\-zmqpubrawtx=\fR
.IP Enable publish raw transaction in
+.HP +\fB\-zmqpubrawtxhwm=\fR +.IP +Set publish raw transaction outbound message high water mark (default: +1000) +.HP +\fB\-zmqpubsequence=\fR
+.IP +Enable publish hash block and tx sequence in
+.HP +\fB\-zmqpubsequencehwm=\fR +.IP +Set publish hash sequence message high water mark (default: 1000) .PP Debugging/Testing options: .HP @@ -421,9 +499,9 @@ Debugging/Testing options: Output debugging information (default: \fB\-nodebug\fR, supplying is optional). If is not supplied or if = 1, output all debugging information. can be: net, tor, -mempool, http, bench, zmq, db, rpc, estimatefee, addrman, +mempool, http, bench, zmq, walletdb, rpc, estimatefee, addrman, selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej, -libevent, coindb, qt, leveldb. +libevent, coindb, qt, leveldb, validation. .HP \fB\-debugexclude=\fR .IP @@ -439,15 +517,19 @@ Print help message with debugging options and exit .IP Include IP addresses in debug output (default: 0) .HP +\fB\-logthreadnames\fR +.IP +Prepend debug output with name of the originating thread (only available +on platforms supporting thread_local) (default: 0) +.HP \fB\-logtimestamps\fR .IP Prepend debug output with timestamp (default: 1) .HP \fB\-maxtxfee=\fR .IP -Maximum total fees (in BTC) to use in a single wallet transaction or raw -transaction; setting this too low may abort large transactions -(default: 0.10) +Maximum total fees (in BTC) to use in a single wallet transaction; +setting this too low may abort large transactions (default: 0.10) .HP \fB\-printtoconsole\fR .IP @@ -464,9 +546,158 @@ Append comment to the user agent string .PP Chain selection options: .HP +\fB\-bech32_hrp\fR +.IP +The human\-readable part of the chain's bech32 encoding. (default: ex) +.HP +\fB\-blech32_hrp\fR +.IP +The human\-readable part of the chain's blech32 encoding. Used in +confidential addresses.(default: lq) +.HP +\fB\-chain=\fR +.IP +Use the chain (default: liquidv1). Reserved values: main, test, +signet, regtest, liquidv1, liquidv1test +.HP +\fB\-con_blockheightinheader\fR +.IP +Whether the chain includes the block height directly in the header, for +easier validation of block height in low\-resource environments. +(default: true) +.HP +\fB\-con_has_parent_chain\fR +.IP +Whether or not there is a parent chain. +.HP +\fB\-con_max_block_sig_size\fR +.IP +Max allowed witness data for the signed block header. +.HP +\fB\-con_parent_chain_signblockscript\fR +.IP +Whether parent chain uses pow or signed blocks. If the parent chain uses +signed blocks, the challenge (scriptPubKey) script. If not, an +empty string. (default: empty script [ie parent uses pow]) +.HP +\fB\-con_parent_pegged_asset=\fR +.IP +Asset ID (hex) for pegged asset for when parent chain has CA. (default: +0x00) +.HP +\fB\-con_parentpowlimit\fR +.IP +The proof\-of\-work limit value for the parent chain. +.HP +\fB\-con_signed_blocks\fR +.IP +Signed blockchain. Uses input of `\-signblockscript` to define what +signatures are necessary to solve it. +.HP +\fB\-ct_bits\fR +.IP +The default number of hiding bits in a rangeproof. Will be exceeded to +cover amounts exceeding the maximum hiding value. (default: 52) +.HP +\fB\-ct_exponent\fR +.IP +The hiding exponent. (default: 0) +.HP +\fB\-extprvkeyprefix\fR +.IP +The 4\-byte prefix, in hex, of the chain's base58 extended private key +encoding. (default: 0488ade4) +.HP +\fB\-extpubkeyprefix\fR +.IP +The 4\-byte prefix, in hex, of the chain's base58 extended public key +encoding. (default: 0488b21e) +.HP +\fB\-fedpegscript\fR +.IP +The script for the federated peg enforce from genesis block. This script +may stop being enforced once dynamic federations activates. +.HP +\fB\-feeasset=\fR +.IP +Asset ID (hex) for mempool/relay fees (default: +6f0279e9ed041c3d710a9f57d0c02928416460c4b722ae3457a11eec381c526d) +.HP +\fB\-initialreissuancetokens=\fR +.IP +The amount of reissuance tokens created in the genesis block. (default: +0) +.HP +\fB\-parent_bech32_hrp\fR +.IP +The human\-readable part of the parent chain's bech32 encoding. (default: +bc) +.HP +\fB\-parent_blech32_hrp\fR +.IP +The human\-readable part of the parent chain's blech32 encoding. +(default: bc) +.HP +\fB\-parentgenesisblockhash\fR +.IP +The genesis blockhash of the parent chain. +.HP +\fB\-parentpubkeyprefix\fR +.IP +The byte prefix, in decimal, of the parent chain's base58 pubkey +address. (default: 111) +.HP +\fB\-parentscriptprefix\fR +.IP +The byte prefix, in decimal, of the parent chain's base58 script +address. (default: 196) +.HP +\fB\-pubkeyprefix\fR +.IP +The byte prefix, in decimal, of the chain's base58 pubkey address. +(default: 57) +.HP +\fB\-scriptprefix\fR +.IP +The byte prefix, in decimal, of the chain's base58 script address. +(default: 39) +.HP +\fB\-secretprefix\fR +.IP +The byte prefix, in decimal, of the chain's base58 secret key encoding. +(default: 128) +.HP +\fB\-signblockscript\fR +.IP +Signed blockchain enumberance. Only active when `\-con_signed_blocks` set +to true. +.HP +\fB\-signet\fR +.IP +Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network +is defined by the \fB\-signetchallenge\fR parameter +.HP +\fB\-signetchallenge\fR +.IP +Blocks must satisfy the given script to be considered valid (only for +signet networks; defaults to the global default signet test +network challenge) +.HP +\fB\-signetseednode\fR +.IP +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)) +.HP +\fB\-subsidyasset=\fR +.IP +Asset ID (hex) for the block subsidy (default: +6f0279e9ed041c3d710a9f57d0c02928416460c4b722ae3457a11eec381c526d) +.HP \fB\-testnet\fR .IP -Use the test chain +Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. .PP Node relay options: .HP @@ -487,17 +718,19 @@ Maximum size of data in data carrier transactions we relay and mine \fB\-minrelaytxfee=\fR .IP Fees (in BTC/kB) smaller than this are considered zero fee for relaying, -mining and transaction creation (default: 0.00001) +mining and transaction creation (default: 0.000001) .HP \fB\-whitelistforcerelay\fR .IP -Force relay of transactions from whitelisted peers even if they violate -local relay policy (default: 0) +Add 'forcerelay' permission to whitelisted inbound peers with default +permissions. This will relay transactions even if the +transactions were already in the mempool. (default: 0) .HP \fB\-whitelistrelay\fR .IP -Accept relayed transactions received from whitelisted peers even when -not relaying transactions (default: 1) +Add 'relay' permission to whitelisted inbound peers with default +permissions. This will accept relayed transactions even when not +relaying transactions (default: 1) .PP Block creation options: .HP @@ -508,7 +741,7 @@ Set maximum BIP141 block weight (default: 3996000) \fB\-blockmintxfee=\fR .IP Set lowest fee rate (in BTC/kB) for transactions to be included in block -creation. (default: 0.00001) +creation. (default: 0.000001) .PP RPC server options: .HP @@ -552,8 +785,8 @@ Password for JSON\-RPC connections .HP \fB\-rpcport=\fR .IP -Listen for JSON\-RPC connections on (default: 8332, testnet: -18332, regtest: 18443) +Listen for JSON\-RPC connections on (default: 7041, testnet: +18332, signet: 38332, regtest: 18443) .HP \fB\-rpcserialversion\fR .IP @@ -568,16 +801,169 @@ Set the number of threads to service RPC calls (default: 4) .IP Username for JSON\-RPC connections .HP +\fB\-rpcwhitelist=\fR +.IP +Set a whitelist to filter incoming RPC calls for a specific user. The +field comes in the format: :,,...,. If multiple whitelists are set for a given user, +they are set\-intersected. See \fB\-rpcwhitelistdefault\fR documentation +for information on default whitelist behavior. +.HP +\fB\-rpcwhitelistdefault\fR +.IP +Sets default behavior for rpc whitelisting. Unless rpcwhitelistdefault +is set to 0, if any \fB\-rpcwhitelist\fR 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 +\fB\-rpcwhitelist\fR is set, rpc server acts as if all rpc users are +subject to empty whitelists. +.HP \fB\-server\fR .IP Accept command line and JSON\-RPC commands -.SH COPYRIGHT -Copyright (C) 2009-2019 The Bitcoin Core developers - -Please contribute if you find Bitcoin Core useful. Visit - for further information about the software. -The source code is available from . - -This is experimental software. -Distributed under the MIT software license, see the accompanying file COPYING -or +.PP +Elements Options: +.HP +\fB\-assetdir\fR +.IP +Entries of pet names of assets, in this format:asset=: