f436c20bc4
05e82d86b09d914ebce05dbc92a7299cb026847b wallet: override minfee checks (fOverrideFeeRate) for fee_rate (Jon Atack) 9a670b4f07a6140de809d73cbd7f3e614eb6ea74 wallet: update sendtoaddress, send RPC examples with fee_rate (Jon Atack) be481b72e24fb6834bd674cd8daee67c6938b42d wallet: use MIN_RELAY_TX_FEE in bumpfee help (Jon Atack) 449b730579566459e350703611629e63e54657ed wallet: provide valid values if invalid estimate mode passed (Jon Atack) 6da3afbaee5809ebf6d88efaa3958c505c2d71c7 wallet: update remaining rpcwallet fee rate units to BTC/kvB (Jon Atack) 173b5b5fe07d45be5a1e5bc7a5df996f20ab1e85 wallet: update fee rate units, use sat/vB for fee_rate error messages (Jon Atack) 7f9835a05abf3e168ad93e7195cbaa4bf61b9b07 wallet: remove fee rates from conf_target helps (Jon Atack) b7994c01e9a3251536fe6538a22f614774eec82d wallet: add fee_rate unit warnings to bumpfee (Jon Atack) 410e471fa42d3db04e8879c71f8c824dcc151a83 wallet: remove redundant bumpfee fee_rate checks (Jon Atack) a0d495747320c79b27a83c216dcc526ac8df8f24 wallet: introduce fee_rate (sat/vB) param/option (Jon Atack) e21212f01b7c41eba13b0479b252053cf482bc1f wallet: remove unneeded WALLET_BTC_KB_TO_SAT_B constant (Jon Atack) 6112cf20d43b0be34fe0edce2ac3e6b27cae1bbe wallet: add CFeeRate ctor doxygen documentation (Jon Atack) 3f7279161347543ce4e997d78ea89a4043491145 wallet: fix bug in RPC send options (Jon Atack) Pull request description: This PR builds on #11413 and #20220 to address #19543. - replace overloading the conf_target and estimate_mode params with `fee_rate` in sat/vB in the sendtoaddress, sendmany, send, fundrawtransaction, walletcreatefundedpsbt, and bumpfee RPCs - allow non-actionable conf_target value of `0` and estimate_mode value of `""` to be passed to use `fee_rate` as a positional argument, in addition to as a named argument - fix a bug in the experimental send RPC described in https://github.com/bitcoin/bitcoin/pull/20220#discussion_r513789526 where args were not being passed correctly into the options values - update the feerate error message units for these RPCs from BTC/kB to sat/vB - update the test coverage, help docs, doxygen docs, and some of the RPC examples - other changes to address the excellent review feedback See this wallet meeting log for more context: http://www.erisian.com.au/bitcoin-core-dev/log-2020-11-06.html#l-309 ACKs for top commit: achow101: re-ACK 05e82d8 MarcoFalke: review ACK 05e82d86b0 did not test and found a few style nits, which can be fixed later 🍯 Xekyo: tACK 05e82d86b09d914ebce05dbc92a7299cb026847b Sjors: utACK 05e82d86b09d914ebce05dbc92a7299cb026847b Tree-SHA512: a4ee5f184ada53f1840b2923d25873bda88c5a2ae48e67eeea2417a0b35154798cfdb3c147b05dd56bd6608a784e1b91623bb985ee2ab9ef2baaec22206d0a9c |
||
---|---|---|
.. | ||
data | ||
test_framework | ||
.gitignore | ||
combine_logs.py | ||
combined_log_template.html | ||
create_cache.py | ||
example_test.py | ||
feature_abortnode.py | ||
feature_addressindex.py | ||
feature_addrman.py | ||
feature_anchors.py | ||
feature_asmap.py | ||
feature_asset_locks.py | ||
feature_assumevalid.py | ||
feature_backwards_compatibility.py | ||
feature_bind_extra.py | ||
feature_bind_port_discover.py | ||
feature_bind_port_externalip.py | ||
feature_bip68_sequence.py | ||
feature_block.py | ||
feature_blockfilterindex_prune.py | ||
feature_blocksdir.py | ||
feature_cltv.py | ||
feature_coinstatsindex.py | ||
feature_config_args.py | ||
feature_csv_activation.py | ||
feature_dbcrash.py | ||
feature_dersig.py | ||
feature_dip3_deterministicmns.py | ||
feature_dip3_v19.py | ||
feature_dip4_coinbasemerkleroots.py | ||
feature_dip0020_activation.py | ||
feature_dirsymlinks.py | ||
feature_discover.py | ||
feature_fee_estimation.py | ||
feature_filelock.py | ||
feature_governance_cl.py | ||
feature_governance_objects.py | ||
feature_governance.py | ||
feature_help.py | ||
feature_includeconf.py | ||
feature_llmq_chainlocks.py | ||
feature_llmq_connections.py | ||
feature_llmq_data_recovery.py | ||
feature_llmq_dkgerrors.py | ||
feature_llmq_evo.py | ||
feature_llmq_is_cl_conflicts.py | ||
feature_llmq_is_retroactive.py | ||
feature_llmq_rotation.py | ||
feature_llmq_signing.py | ||
feature_llmq_simplepose.py | ||
feature_loadblock.py | ||
feature_logging.py | ||
feature_maxuploadtarget.py | ||
feature_minchainwork.py | ||
feature_mnehf.py | ||
feature_multikeysporks.py | ||
feature_new_quorum_type_activation.py | ||
feature_notifications.py | ||
feature_nulldummy.py | ||
feature_proxy.py | ||
feature_pruning.py | ||
feature_reindex.py | ||
feature_settings.py | ||
feature_shutdown.py | ||
feature_spentindex.py | ||
feature_sporks.py | ||
feature_startupnotify.py | ||
feature_timestampindex.py | ||
feature_txindex.py | ||
feature_uacomment.py | ||
feature_utxo_set_hash.py | ||
feature_versionbits_warning.py | ||
interface_bitcoin_cli.py | ||
interface_http.py | ||
interface_rest.py | ||
interface_rpc.py | ||
interface_usdt_net.py | ||
interface_usdt_utxocache.py | ||
interface_usdt_validation.py | ||
interface_zmq_dash.py | ||
interface_zmq.py | ||
mempool_accept.py | ||
mempool_compatibility.py | ||
mempool_expiry.py | ||
mempool_limit.py | ||
mempool_package_limits.py | ||
mempool_package_onemore.py | ||
mempool_packages.py | ||
mempool_persist.py | ||
mempool_reorg.py | ||
mempool_resurrect.py | ||
mempool_spend_coinbase.py | ||
mempool_unbroadcast.py | ||
mempool_updatefromblock.py | ||
mining_basic.py | ||
mining_getblocktemplate_longpoll.py | ||
mining_prioritisetransaction.py | ||
p2p_add_connections.py | ||
p2p_addr_relay.py | ||
p2p_addrfetch.py | ||
p2p_addrv2_relay.py | ||
p2p_block_sync.py | ||
p2p_blockfilters.py | ||
p2p_blocksonly.py | ||
p2p_compactblocks_blocksonly.py | ||
p2p_compactblocks_hb.py | ||
p2p_compactblocks.py | ||
p2p_connect_to_devnet.py | ||
p2p_disconnect_ban.py | ||
p2p_dos_header_tree.py | ||
p2p_eviction.py | ||
p2p_filter.py | ||
p2p_fingerprint.py | ||
p2p_getaddr_caching.py | ||
p2p_getdata.py | ||
p2p_governance_invs.py | ||
p2p_i2p_ports.py | ||
p2p_i2p_sessions.py | ||
p2p_ibd_txrelay.py | ||
p2p_initial_headers_sync.py | ||
p2p_instantsend.py | ||
p2p_invalid_block.py | ||
p2p_invalid_locator.py | ||
p2p_invalid_messages.py | ||
p2p_invalid_tx.py | ||
p2p_leak_tx.py | ||
p2p_leak.py | ||
p2p_message_capture.py | ||
p2p_nobloomfilter_messages.py | ||
p2p_node_network_limited.py | ||
p2p_permissions.py | ||
p2p_ping.py | ||
p2p_quorum_data.py | ||
p2p_sendheaders_compressed.py | ||
p2p_sendheaders.py | ||
p2p_timeouts.py | ||
p2p_tx_download.py | ||
p2p_unrequested_blocks.py | ||
README.md | ||
rpc_addresses_deprecation.py | ||
rpc_bind.py | ||
rpc_blockchain.py | ||
rpc_coinjoin.py | ||
rpc_createmultisig.py | ||
rpc_decodescript.py | ||
rpc_deprecated.py | ||
rpc_deriveaddresses.py | ||
rpc_dumptxoutset.py | ||
rpc_estimatefee.py | ||
rpc_fundrawtransaction.py | ||
rpc_generate.py | ||
rpc_generateblock.py | ||
rpc_getblockfilter.py | ||
rpc_getblockfrompeer.py | ||
rpc_getblockstats.py | ||
rpc_getchaintips.py | ||
rpc_getdescriptorinfo.py | ||
rpc_getpeerinfo_deprecation.py | ||
rpc_help.py | ||
rpc_invalid_address_message.py | ||
rpc_invalidateblock.py | ||
rpc_masternode.py | ||
rpc_misc.py | ||
rpc_mnauth.py | ||
rpc_named_arguments.py | ||
rpc_net.py | ||
rpc_packages.py | ||
rpc_platform_filter.py | ||
rpc_preciousblock.py | ||
rpc_psbt.py | ||
rpc_quorum.py | ||
rpc_rawtransaction.py | ||
rpc_scantxoutset.py | ||
rpc_setban.py | ||
rpc_signmessage.py | ||
rpc_signrawtransaction.py | ||
rpc_txoutproof.py | ||
rpc_uptime.py | ||
rpc_users.py | ||
rpc_verifychainlock.py | ||
rpc_verifyislock.py | ||
rpc_whitelist.py | ||
rpc_wipewallettxes.py | ||
test_runner.py | ||
test-shell.md | ||
tool_wallet.py | ||
wallet_abandonconflict.py | ||
wallet_avoidreuse.py | ||
wallet_backup.py | ||
wallet_balance.py | ||
wallet_basic.py | ||
wallet_change_address.py | ||
wallet_coinbase_category.py | ||
wallet_create_tx.py | ||
wallet_createwallet.py | ||
wallet_descriptor.py | ||
wallet_disable.py | ||
wallet_dump.py | ||
wallet_encryption.py | ||
wallet_fallbackfee.py | ||
wallet_groups.py | ||
wallet_hd.py | ||
wallet_import_rescan.py | ||
wallet_import_with_label.py | ||
wallet_importdescriptors.py | ||
wallet_importmulti.py | ||
wallet_importprunedfunds.py | ||
wallet_keypool_hd.py | ||
wallet_keypool_topup.py | ||
wallet_keypool.py | ||
wallet_labels.py | ||
wallet_listdescriptors.py | ||
wallet_listreceivedby.py | ||
wallet_listsinceblock.py | ||
wallet_listtransactions.py | ||
wallet_mnemonicbits.py | ||
wallet_multiwallet.py | ||
wallet_orphanedreward.py | ||
wallet_reorgsrestore.py | ||
wallet_resendwallettransactions.py | ||
wallet_send.py | ||
wallet_startup.py | ||
wallet_txn_clone.py | ||
wallet_txn_doublespend.py | ||
wallet_upgradetohd.py | ||
wallet_upgradewallet.py | ||
wallet_watchonly.py |
Functional tests
Writing Functional Tests
Example test
The file test/functional/example_test.py is a heavily commented example of a test case that uses both the RPC and P2P interfaces. If you are writing your first test, copy that file and modify to fit your needs.
Coverage
Running test/functional/test_runner.py
with the --coverage
argument tracks which RPCs are
called by the tests and prints a report of uncovered RPCs in the summary. This
can be used (along with the --extended
argument) to find out which RPCs we
don't have test cases for.
Style guidelines
- Where possible, try to adhere to PEP-8 guidelines
- Use a python linter like flake8 before submitting PRs to catch common style nits (eg trailing whitespace, unused imports, etc)
- The oldest supported Python version is specified in doc/dependencies.md. Consider using pyenv, which checks .python-version, to prevent accidentally introducing modern syntax from an unsupported Python version. The CI linter job also checks this, but possibly not in all cases.
- See the python lint script that checks for violations that could lead to bugs and issues in the test code.
- Use type hints in your code to improve code readability and to detect possible bugs earlier.
- Avoid wildcard imports.
- If more than one name from a module is needed, use lexicographically sorted multi-line imports in order to reduce the possibility of potential merge conflicts.
- Use a module-level docstring to describe what the test is testing, and how it is testing it.
- When subclassing the BitcoinTestFramework, place overrides for the
set_test_params()
,add_options()
andsetup_xxxx()
methods at the top of the subclass, then locally-defined helper methods, then therun_test()
method. - Use
f'{x}'
for string formatting in preference to'{}'.format(x)
or'%s' % x
.
Naming guidelines
- Name the test
<area>_test.py
, where area can be one of the following:feature
for tests for full features that aren't wallet/mining/mempool, egfeature_rbf.py
interface
for tests for other interfaces (REST, ZMQ, etc), eginterface_rest.py
mempool
for tests for mempool behaviour, egmempool_reorg.py
mining
for tests for mining features, egmining_prioritisetransaction.py
p2p
for tests that explicitly test the p2p interface, egp2p_disconnect_ban.py
rpc
for tests for individual RPC methods or features, egrpc_listtransactions.py
tool
for tests for tools, egtool_wallet.py
wallet
for tests for wallet features, egwallet_keypool.py
- Use an underscore to separate words
- exception: for tests for specific RPCs or command line options which don't include underscores, name the test after the exact RPC or argument name, eg
rpc_decodescript.py
, notrpc_decode_script.py
- exception: for tests for specific RPCs or command line options which don't include underscores, name the test after the exact RPC or argument name, eg
- Don't use the redundant word
test
in the name, eginterface_zmq.py
, notinterface_zmq_test.py
General test-writing advice
- Instead of inline comments or no test documentation at all, log the comments to the test log, e.g.
self.log.info('Create enough transactions to fill a block')
. Logs make the test code easier to read and the test logic easier to debug. - Set
self.num_nodes
to the minimum number of nodes necessary for the test. Having additional unrequired nodes adds to the execution time of the test as well as memory/CPU/disk requirements (which is important when running tests in parallel). - Avoid stop-starting the nodes multiple times during the test if possible. A stop-start takes several seconds, so doing it several times blows up the runtime of the test.
- Set the
self.setup_clean_chain
variable inset_test_params()
toTrue
to initialize an empty blockchain and start from the Genesis block, rather than load a premined blockchain from cache with the default value ofFalse
. The cached data directories contain a 200-block pre-mined blockchain with the spendable mining rewards being split between four nodes. Each node has 25 mature block subsidies (25x500=12500 DASH) in its wallet. Using them is much more efficient than mining blocks in your test. - When calling RPCs with lots of arguments, consider using named keyword arguments instead of positional arguments to make the intent of the call clear to readers.
- Many of the core test framework classes such as
CBlock
andCTransaction
don't allow new attributes to be added to their objects at runtime like typical Python objects allow. This helps prevent unpredictable side effects from typographical errors or usage of the objects outside of their intended purpose.
RPC and P2P definitions
Test writers may find it helpful to refer to the definitions for the RPC and P2P messages. These can be found in the following source files:
/src/rpc/*
for RPCs/src/wallet/rpc*
for wallet RPCsProcessMessage()
in/src/net_processing.cpp
for parsing P2P messages
Using the P2P interface
-
P2P
s can be used to test specific P2P protocol behavior. p2p.py contains test framework p2p objects and messages.py contains all the definitions for objects passed over the network (CBlock
,CTransaction
, etc, along with the network-level wrappers for them,msg_block
,msg_tx
, etc). -
P2P tests have two threads. One thread handles all network communication with the dashd(s) being tested in a callback-based event loop; the other implements the test logic.
-
P2PConnection
is the class used to connect to a dashd.P2PInterface
contains the higher level logic for processing P2P payloads and connecting to the Bitcoin Core node application logic. For custom behaviour, subclass the P2PInterface object and override the callback methods.
P2PConnection
s can be used as such:
p2p_conn = node.add_p2p_connection(P2PInterface())
p2p_conn.send_and_ping(msg)
They can also be referenced by indexing into a TestNode
's p2ps
list, which
contains the list of test framework p2p
objects connected to itself
(it does not include any TestNode
s):
node.p2ps[0].sync_with_ping()
More examples can be found in p2p_unrequested_blocks.py, p2p_compactblocks.py.
Prototyping tests
The TestShell
class exposes the BitcoinTestFramework
functionality to interactive Python3 environments and can be used to prototype
tests. This may be especially useful in a REPL environment with session logging
utilities, such as
IPython.
The logs of such interactive sessions can later be adapted into permanent test
cases.
Test framework modules
The following are useful modules for test developers. They are located in test/functional/test_framework/.
authproxy.py
Taken from the python-bitcoinrpc repository.
test_framework.py
Base class for functional tests.
util.py
Generally useful functions.
p2p.py
Test objects for interacting with a dashd node over the p2p interface.
script.py
Utilities for manipulating transaction scripts (originally from python-bitcoinlib)
key.py
Test-only secp256k1 elliptic curve implementation
blocktools.py
Helper functions for creating blocks and transactions.
Benchmarking with perf
An easy way to profile node performance during functional tests is provided
for Linux platforms using perf
.
Perf will sample the running node and will generate profile data in the node's
datadir. The profile data can then be presented using perf report
or a graphical
tool like hotspot.
There are two ways of invoking perf: one is to use the --perf
flag when
running tests, which will profile each node during the entire test run: perf
begins to profile when the node starts and ends when it shuts down. The other
way is the use the profile_with_perf
context manager, e.g.
with node.profile_with_perf("send-big-msgs"):
# Perform activity on the node you're interested in profiling, e.g.:
for _ in range(10000):
node.p2ps[0].send_message(some_large_message)
To see useful textual output, run
perf report -i /path/to/datadir/send-big-msgs.perf.data.xxxx --stdio | c++filt | less
See also:
- Installing perf
- Perf examples
- Hotspot: a GUI for perf output analysis