dash/test/functional
pasta 37e026a038
Merge #6074: backport: merge bitcoin#18344, #20867, #20286, #21359, #21910, #19651, #21934, #22722, #20295, #23702, partial bitcoin#23706 (rpc backports)
b23d94b14f partial bitcoin#23706: getblockfrompeer followups (Kittywhiskers Van Gogh)
7e5cc5e375 merge bitcoin#23702: Add missing optional to getblockfrompeer (Kittywhiskers Van Gogh)
c294457b52 merge bitcoin#20295: getblockfrompeer (Kittywhiskers Van Gogh)
63ac87f011 merge bitcoin#22722: update estimatesmartfee rpc to return max of estimateSmartFee, mempoolMinFee and minRelayTxFee. (Kittywhiskers Van Gogh)
07e4c2cdd0 merge bitcoin#21934: Include versionbits signalling details during LOCKED_IN (Kittywhiskers Van Gogh)
960e7687d4 merge bitcoin#19651: importdescriptors update existing (Kittywhiskers Van Gogh)
1f31823fed merge bitcoin#21910: remove redundant fOnlySafe argument (Kittywhiskers Van Gogh)
69c5aa8947 merge bitcoin#21359: include_unsafe option for fundrawtransaction (Kittywhiskers Van Gogh)
169dce7e50 merge bitcoin#20286: deprecate addresses and reqSigs from rpc outputs (Kittywhiskers Van Gogh)
7cddf70c58 merge bitcoin#20867: Support up to 20 keys for multisig under Segwit context (Kittywhiskers Van Gogh)
7c59923845 merge bitcoin#18344: Fix nit in getblockchaininfo (Kittywhiskers Van Gogh)
ec0803a0f5 refactor: align `TxToUniv` argument list with upstream (Kittywhiskers Van Gogh)

Pull request description:

  ## Additional Information

  * Closes https://github.com/dashpay/dash/issues/6000

  * `TxToUniv`'s argument list needed to be rearranged to match upstream as closely as possible (i.e. placing Dash-specific arguments at the end of the list to allow for code to be backported unmodified, relying on default arguments instead of having to modify each invocation to insert the default argument in between).

    This was due to a new `TxToUniv` variant being introduced in [bitcoin#20286](https://github.com/bitcoin/bitcoin/pull/20286)

  * The maximum number of public keys in a multisig remains the same. The upper limit for bare multisigs is and always has been `MAX_PUBKEYS_PER_MULTISIG` ([source](19512988c6/src/script/interpreter.cpp (L1143-L1144))), which has always been 20 ([source](19512988c6/src/script/script.h (L28-L29))). The limit of up to 16 comes from P2SH overhead ([source](19512988c6/src/script/descriptor.cpp (L877-L880))) and that hasn't changed.

    In effect, what [bitcoin#20867](https://github.com/bitcoin/bitcoin/pull/20867) does to Dash Core is change the error from "too many public keys" (as we'll be testing against the bare multisig limit) to "excessive redeemScript size" ([source](19512988c6/src/rpc/util.cpp (L223-L225))) (which is the _true_ limitation).

  * Backporting [bitcoin#21934](https://github.com/bitcoin/bitcoin/pull/21934) required a minor change in the condition needed to emit `activation_height` as `has_signal` in the preceding block will evaluate true for both `STARTED` and `LOCKED_IN` while earlier it would only for `STARTED`.

  * In [bitcoin#22722](https://github.com/bitcoin/bitcoin/pull/22722), a `self.stop_node` had to be added to account for the absurd fee warning that a new test condition introduces.

  * [bitcoin#23706](https://github.com/bitcoin/bitcoin/pull/23706) is partial due to commits in it that rely on RPC type enforcement, which is currently not implemented in Dash Core.

  * `feature_dip3_deterministicmns.py` depends on the reporting of `addresses` to validate multisigs containing expected payees. There is no replacement RPC call to report the pubkeys that compose a multisig address. In the interm, the `-deprecatedrpc=addresses` flag has been enabled to allow the test to run otherwise unmodified.

  ## Breaking Changes

  * The following RPCs:  `gettxout`, `getrawtransaction`, `decoderawtransaction`, `decodescript`, `gettransaction`, and REST endpoints: `/rest/tx`, `/rest/getutxos`, `/rest/block` deprecated the following fields (which are no longer returned in the responses by default): `addresses`, `reqSigs`.

    The `-deprecatedrpc=addresses` flag must be passed for these fields to be included in the RPC response. Note that these fields are attributes of the `scriptPubKey` object returned in the RPC response. However, in the response of `decodescript` these fields are top-level attributes, and included again as attributes of the `scriptPubKey` object.

  * When creating a hex-encoded Dash transaction using the `dash-tx` utility with the `-json` option set, the following fields: `addresses`, `reqSigs` are no longer returned in the tx output of the response.

  * The error message for attempts at making multisigs with >16 pubkeys will change to an "excessive redeemScript size" instead of the previous "too many public keys".

  ## Checklist:

  - [x] I have performed a self-review of my own code
  - [x] I have commented my code, particularly in hard-to-understand areas **(note: N/A)**
  - [x] I have added or updated relevant unit/integration/functional/e2e tests
  - [x] I have made corresponding changes to the documentation
  - [x] I have assigned this pull request to a milestone _(for repository code-owners and collaborators only)_

ACKs for top commit:
  UdjinM6:
    utACK b23d94b14f
  PastaPastaPasta:
    utACK b23d94b14f

Tree-SHA512: 659d9ba3a0a9f8594b307a7056ab172309d5a0d9efec605bc4b345f7e0fb1032ad303af9e8f51dbd6549e82d0b738ad41eae8a5b3aebf59081f39df0d4b5ec7c
2024-06-27 17:37:09 -05:00
..
data Merge #18836: wallet: upgradewallet fixes and additional tests 2024-05-10 13:59:59 +07:00
test_framework merge bitcoin#20286: deprecate addresses and reqSigs from rpc outputs 2024-06-27 19:27:37 +00:00
.gitignore
combine_logs.py
combined_log_template.html
create_cache.py
example_test.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
feature_abortnode.py Merge #19752: test: Update wait_until usage in tests not to use the one from utils 2024-01-20 00:07:11 +07:00
feature_addressindex.py
feature_addrman.py addrman: allow for silent overwriting of inconsistent peers.dat 2024-06-27 06:09:30 +00:00
feature_anchors.py merge bitcoin#22879: Fix format string in deserialize error 2024-06-10 17:15:04 +00:00
feature_asmap.py
feature_asset_locks.py Merge bitcoin/bitcoin#22257: test: refactor: various (de)serialization helpers cleanups/improvements 2024-03-22 10:29:15 -05:00
feature_assumevalid.py Merge #19752: test: Update wait_until usage in tests not to use the one from utils 2024-01-20 00:07:11 +07:00
feature_backwards_compatibility.py fix: feature_backwards compatible works now with as expected if no bdb compiled 2024-04-12 17:34:03 +07:00
feature_bind_extra.py Merge bitcoin/bitcoin#25333: test: Fix out-of-range port collisions 2024-06-08 20:59:34 -05:00
feature_bind_port_discover.py merge bitcoin#20196: fix GetListenPort() to derive the proper port 2024-06-12 16:37:12 +00:00
feature_bind_port_externalip.py merge bitcoin#20196: fix GetListenPort() to derive the proper port 2024-06-12 16:37:12 +00:00
feature_bip68_sequence.py Merge #5978: backport: merge bitcoin#21594, #21843, #22306, #22211, #22387, #21528, #22616, #22604, #22960, #23218 (networking backports: part 3) 2024-04-15 10:49:14 -05:00
feature_block.py merge bitcoin#20167: Add test for -blockversion 2024-02-06 08:44:05 -06:00
feature_blockfilterindex_prune.py Merge #19752: test: Update wait_until usage in tests not to use the one from utils 2024-01-20 00:07:11 +07:00
feature_blocksdir.py
feature_cltv.py Merge #21377: Speedy trial support for versionbits 2024-04-23 22:41:10 +07:00
feature_coinstatsindex.py Merge bitcoin/bitcoin#22257: test: refactor: various (de)serialization helpers cleanups/improvements 2024-03-22 10:29:15 -05:00
feature_config_args.py Merge bitcoin/bitcoin#21814: test: Fix feature_config_args.py intermittent issue 2024-04-23 22:41:08 +07:00
feature_csv_activation.py Merge bitcoin/bitcoin#22257: test: refactor: various (de)serialization helpers cleanups/improvements 2024-03-22 10:29:15 -05:00
feature_dbcrash.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
feature_dersig.py Merge #21377: Speedy trial support for versionbits 2024-04-23 22:41:10 +07:00
feature_dip3_deterministicmns.py merge bitcoin#20286: deprecate addresses and reqSigs from rpc outputs 2024-06-27 19:27:37 +00:00
feature_dip3_v19.py Merge bitcoin/bitcoin#22257: test: refactor: various (de)serialization helpers cleanups/improvements 2024-03-22 10:29:15 -05:00
feature_dip4_coinbasemerkleroots.py Merge bitcoin/bitcoin#22257: test: refactor: various (de)serialization helpers cleanups/improvements 2024-03-22 10:29:15 -05:00
feature_dip0020_activation.py Merge bitcoin/bitcoin#22257: test: refactor: various (de)serialization helpers cleanups/improvements 2024-03-22 10:29:15 -05:00
feature_discover.py Merge bitcoin/bitcoin#24269: test: add functional test for -discover 2024-06-10 11:00:46 -05:00
feature_fee_estimation.py merge bitcoin#22722: update estimatesmartfee rpc to return max of estimateSmartFee, mempoolMinFee and minRelayTxFee. 2024-06-27 19:27:38 +00:00
feature_filelock.py fix: remove workarounds introduced due to missing bitcoin#20267 (bdb is not compiled) 2024-04-11 02:37:03 +07:00
feature_governance_cl.py fix: force mnsync to skip gov obj sync on reconnection 2024-06-04 18:16:18 +03:00
feature_governance_objects.py
feature_governance.py merge bitcoin#20286: deprecate addresses and reqSigs from rpc outputs 2024-06-27 19:27:37 +00:00
feature_help.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
feature_includeconf.py
feature_llmq_chainlocks.py non-scripted-diff: bump copyright year to 2023 2024-02-24 11:05:37 -06:00
feature_llmq_connections.py non-scripted-diff: bump copyright year to 2023 2024-02-24 11:05:37 -06:00
feature_llmq_data_recovery.py Merge #21377: Speedy trial support for versionbits 2024-04-23 22:41:10 +07:00
feature_llmq_dkgerrors.py non-scripted-diff: bump copyright year to 2023 2024-02-24 11:05:37 -06:00
feature_llmq_evo.py Merge bitcoin/bitcoin#22257: test: refactor: various (de)serialization helpers cleanups/improvements 2024-03-22 10:29:15 -05:00
feature_llmq_is_cl_conflicts.py Merge bitcoin/bitcoin#22257: test: refactor: various (de)serialization helpers cleanups/improvements 2024-03-22 10:29:15 -05:00
feature_llmq_is_retroactive.py non-scripted-diff: bump copyright year to 2023 2024-02-24 11:05:37 -06:00
feature_llmq_rotation.py Merge bitcoin/bitcoin#22257: test: refactor: various (de)serialization helpers cleanups/improvements 2024-03-22 10:29:15 -05:00
feature_llmq_signing.py Merge #19816: test: Rename wait until helper to wait_until_helper 2024-03-06 02:00:39 +07:00
feature_llmq_simplepose.py non-scripted-diff: bump copyright year to 2023 2024-02-24 11:05:37 -06:00
feature_loadblock.py
feature_logging.py
feature_maxuploadtarget.py merge bitcoin#22960: Set peertimeout in write_config 2024-04-12 16:55:06 +00:00
feature_minchainwork.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
feature_mnehf.py Merge #21377: Speedy trial support for versionbits 2024-04-23 22:41:10 +07:00
feature_multikeysporks.py Merge #19816: test: Rename wait until helper to wait_until_helper 2024-03-06 02:00:39 +07:00
feature_new_quorum_type_activation.py Merge #21377: Speedy trial support for versionbits 2024-04-23 22:41:10 +07:00
feature_notifications.py partial Merge #18878: test: Add test for conflicted wallet tx notifications 2024-05-27 21:55:54 +07:00
feature_nulldummy.py Merge #21373: test: generate fewer blocks in feature_nulldummy to fix timeouts, speed up 2024-04-23 22:41:11 +07:00
feature_proxy.py Merge bitcoin/bitcoin#24258: test: check localaddresses in getnetworkinfo for nodes with proxy 2024-06-11 12:09:21 -05:00
feature_pruning.py Merge bitcoin/bitcoin#26380: Revert "test: check importing wallets when blocks are pruned throw an error" 2024-06-10 11:00:47 -05:00
feature_reindex.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
feature_settings.py
feature_shutdown.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
feature_spentindex.py
feature_sporks.py Merge #19816: test: Rename wait until helper to wait_until_helper 2024-03-06 02:00:39 +07:00
feature_startupnotify.py Merge bitcoin/bitcoin#23979: test: wait for rather than assert presence of file in startupnotify test 2024-06-06 22:57:57 -05:00
feature_timestampindex.py
feature_txindex.py
feature_uacomment.py
feature_utxo_set_hash.py Merge #21390: test: Test improvements for UTXO set hash tests 2024-04-11 02:26:01 +07:00
feature_versionbits_warning.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
interface_bitcoin_cli.py Merge #6050: backport: trivial 2024 06 07 2024-06-10 17:35:10 -05:00
interface_http.py
interface_rest.py
interface_rpc.py
interface_zmq_dash.py Merge bitcoin/bitcoin#22257: test: refactor: various (de)serialization helpers cleanups/improvements 2024-03-22 10:29:15 -05:00
interface_zmq.py Merge #5981: backport: bitcoin#19136, #21063, #21277, #21302, partial #20267 - descriptor wallets part IV 2024-04-16 08:56:59 -05:00
mempool_accept.py Merge bitcoin/bitcoin#22257: test: refactor: various (de)serialization helpers cleanups/improvements 2024-03-22 10:29:15 -05:00
mempool_compatibility.py Merge #20688: test: run mempool_compatibility.py even with wallet disabled 2024-01-26 12:50:30 -06:00
mempool_expiry.py Merge #20276: test: run mempool_expiry.py even with wallet disabled 2024-01-26 12:50:31 -06:00
mempool_limit.py
mempool_package_onemore.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
mempool_packages.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
mempool_persist.py Merge #19752: test: Update wait_until usage in tests not to use the one from utils 2024-01-20 00:07:11 +07:00
mempool_reorg.py
mempool_resurrect.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
mempool_spend_coinbase.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
mempool_unbroadcast.py
mempool_updatefromblock.py
mining_basic.py Merge #16551: test: Test that low difficulty chain fork is rejected 2024-04-03 14:16:43 +07:00
mining_getblocktemplate_longpoll.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
mining_prioritisetransaction.py
p2p_add_connections.py merge bitcoin#19315: Allow outbound & block-relay-only connections in functional tests 2024-04-03 16:06:40 +00:00
p2p_addr_relay.py merge bitcoin#23380: Fix AddrMan::Add() return semantics and logging 2024-06-10 17:16:38 +00:00
p2p_addrfetch.py Merge bitcoin/bitcoin#22096: p2p: AddrFetch - don't disconnect on self-announcements 2024-05-27 12:18:23 -05:00
p2p_addrv2_relay.py merge bitcoin#23380: Fix AddrMan::Add() return semantics and logging 2024-06-10 17:16:38 +00:00
p2p_blockfilters.py Merge bitcoin/bitcoin#24698: test: -peerblockfilters without -blockfilterindex raises an error 2024-06-06 22:58:29 -05:00
p2p_blocksonly.py Merge #19770: RPC: getpeerinfo: Deprecate "whitelisted" field (replaced by "permissions") 2024-05-29 14:03:56 +07:00
p2p_compactblocks_blocksonly.py merge bitcoin#22340: Use legacy relaying to download blocks in blocks-only mode 2024-06-10 17:31:24 +00:00
p2p_compactblocks_hb.py merge bitcoin#22147: p2p: Protect last outbound HB compact block peer 2024-06-10 17:31:24 +00:00
p2p_compactblocks.py merge bitcoin#20799: Only support version 2 compact blocks 2024-06-10 17:31:24 +00:00
p2p_connect_to_devnet.py non-scripted-diff: bump copyright year to 2023 2024-02-24 11:05:37 -06:00
p2p_disconnect_ban.py Merge #19877: [test] clarify rpc_net & p2p_disconnect_ban functional tests 2024-05-29 14:03:57 +07:00
p2p_dos_header_tree.py Merge #16551: test: Test that low difficulty chain fork is rejected 2024-04-03 14:16:43 +07:00
p2p_eviction.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
p2p_filter.py merge bitcoin#20286: deprecate addresses and reqSigs from rpc outputs 2024-06-27 19:27:37 +00:00
p2p_fingerprint.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
p2p_getaddr_caching.py Merge bitcoin/bitcoin#25333: test: Fix out-of-range port collisions 2024-06-08 20:59:34 -05:00
p2p_getdata.py Merge #20022: test: use explicit p2p objects where available 2024-01-27 22:55:29 -06:00
p2p_i2p_ports.py
p2p_i2p_sessions.py merge bitcoin#26838: I2P documentation updates 2024-05-29 11:48:38 -05:00
p2p_instantsend.py non-scripted-diff: bump copyright year to 2023 2024-02-24 11:05:37 -06:00
p2p_invalid_block.py Merge bitcoin/bitcoin#22120: test: p2p_invalid_block: Check that a block rejected due to too-new tim… 2024-05-19 11:11:34 -05:00
p2p_invalid_locator.py Merge #19804: test/refactor: reference p2p objects explicitly and remove confusing Test_Node.p2p property 2024-01-27 22:55:29 -06:00
p2p_invalid_messages.py Merge #20079: p2p: Treat handshake misbehavior like unknown message 2024-06-20 02:25:45 +07:00
p2p_invalid_tx.py Merge #19804: test/refactor: reference p2p objects explicitly and remove confusing Test_Node.p2p property 2024-01-27 22:55:29 -06:00
p2p_leak_tx.py Merge #20126: test: p2p_leak_tx.py improvements (use MiniWallet, add p2p_lock acquires) 2024-01-26 12:50:31 -06:00
p2p_leak.py Merge #20079: p2p: Treat handshake misbehavior like unknown message 2024-06-20 02:25:45 +07:00
p2p_message_capture.py partial bitcoin#20196: fix GetListenPort() to derive the proper port 2024-04-26 20:25:31 +00:00
p2p_nobloomfilter_messages.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
p2p_node_network_limited.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
p2p_permissions.py Merge #19770: RPC: getpeerinfo: Deprecate "whitelisted" field (replaced by "permissions") 2024-05-29 14:03:56 +07:00
p2p_ping.py Merge bitcoin/bitcoin#26546: test: remove unused class NodePongAdd1 2024-06-10 11:00:47 -05:00
p2p_quorum_data.py Merge #20993: test: store subversion (user agent) as string in msg_version 2024-04-11 02:25:08 +07:00
p2p_sendheaders_compressed.py non-scripted-diff: bump copyright year to 2023 2024-02-24 11:05:37 -06:00
p2p_sendheaders.py Merge #19752: test: Update wait_until usage in tests not to use the one from utils 2024-01-20 00:07:11 +07:00
p2p_timeouts.py Merge #20079: p2p: Treat handshake misbehavior like unknown message 2024-06-20 02:25:45 +07:00
p2p_tx_download.py Merge bitcoin/bitcoin#22257: test: refactor: various (de)serialization helpers cleanups/improvements 2024-03-22 10:29:15 -05:00
p2p_unrequested_blocks.py
README.md Merge #20691: ci, doc: Travis CI features and mentions cleanup 2024-03-27 00:48:26 +07:00
rpc_addresses_deprecation.py merge bitcoin#20286: deprecate addresses and reqSigs from rpc outputs 2024-06-27 19:27:37 +00:00
rpc_bind.py
rpc_blockchain.py Merge #21200: test: Speed up rpc_blockchain.py by removing miniwallet.generate() 2024-06-20 12:23:14 +07:00
rpc_coinjoin.py
rpc_createmultisig.py merge bitcoin#20286: deprecate addresses and reqSigs from rpc outputs 2024-06-27 19:27:37 +00:00
rpc_decodescript.py Merge bitcoin/bitcoin#22257: test: refactor: various (de)serialization helpers cleanups/improvements 2024-03-22 10:29:15 -05:00
rpc_deprecated.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
rpc_deriveaddresses.py
rpc_dumptxoutset.py Merge bitcoin/bitcoin#21681: validation: fix ActivateSnapshot to use hardcoded nChainTx 2024-04-23 22:41:09 +07:00
rpc_estimatefee.py
rpc_fundrawtransaction.py merge bitcoin#21359: include_unsafe option for fundrawtransaction 2024-06-27 19:27:37 +00:00
rpc_generate.py Merge #19717: rpc: Assert that RPCArg names are equal to CRPCCommand ones (mining,zmq,rpcdump) 2024-03-17 13:02:58 -05:00
rpc_generateblock.py merge bitcoin#20286: deprecate addresses and reqSigs from rpc outputs 2024-06-27 19:27:37 +00:00
rpc_getblockfilter.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
rpc_getblockfrompeer.py partial bitcoin#23706: getblockfrompeer followups 2024-06-27 19:28:32 +00:00
rpc_getblockstats.py
rpc_getchaintips.py
rpc_getdescriptorinfo.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
rpc_getpeerinfo_deprecation.py Merge #19725: [RPC] Add connection type to getpeerinfo, improve logs 2024-05-29 14:03:55 +07:00
rpc_help.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
rpc_invalid_address_message.py Merge #20832: rpc: Better error messages for invalid addresses 2024-02-01 11:09:04 -06:00
rpc_invalidateblock.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
rpc_masternode.py non-scripted-diff: bump copyright year to 2023 2024-02-24 11:05:37 -06:00
rpc_misc.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
rpc_mnauth.py non-scripted-diff: bump copyright year to 2023 2024-02-24 11:05:37 -06:00
rpc_named_arguments.py
rpc_net.py merge bitcoin#23077: Full CJDNS support 2024-05-29 18:07:44 +00:00
rpc_packages.py Merge bitcoin/bitcoin#22257: test: refactor: various (de)serialization helpers cleanups/improvements 2024-03-22 10:29:15 -05:00
rpc_platform_filter.py feat: rpc external users are comma separated list 2024-06-12 19:46:22 +07:00
rpc_preciousblock.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
rpc_psbt.py merge bitcoin#21359: include_unsafe option for fundrawtransaction 2024-06-27 19:27:37 +00:00
rpc_quorum.py non-scripted-diff: bump copyright year to 2023 2024-02-24 11:05:37 -06:00
rpc_rawtransaction.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
rpc_scantxoutset.py
rpc_setban.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
rpc_signmessage.py
rpc_signrawtransaction.py
rpc_txoutproof.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
rpc_uptime.py
rpc_users.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
rpc_verifychainlock.py non-scripted-diff: bump copyright year to 2023 2024-02-24 11:05:37 -06:00
rpc_verifyislock.py Merge bitcoin/bitcoin#22257: test: refactor: various (de)serialization helpers cleanups/improvements 2024-03-22 10:29:15 -05:00
rpc_whitelist.py
rpc_wipewallettxes.py
test_runner.py merge bitcoin#20295: getblockfrompeer 2024-06-27 19:28:32 +00:00
test-shell.md
tool_wallet.py Merge #20715: util: Add ArgsManager::GetCommand() and use it in bitcoin-wallet 2024-06-20 12:23:02 +07:00
wallet_abandonconflict.py
wallet_avoidreuse.py Merge #16528: Native Descriptor Wallets using DescriptorScriptPubKeyMan 2024-03-07 01:23:15 +07:00
wallet_backup.py Merge bitcoin/bitcoin#22541: Add a new RPC command: restorewallet 2024-05-24 13:30:00 -05:00
wallet_balance.py Merge #18788: tests: Update more tests to work with descriptor wallets 2024-03-09 03:01:24 +07:00
wallet_basic.py merge bitcoin#20286: deprecate addresses and reqSigs from rpc outputs 2024-06-27 19:27:37 +00:00
wallet_change_address.py merge bitcoin#20286: deprecate addresses and reqSigs from rpc outputs 2024-06-27 19:27:37 +00:00
wallet_coinbase_category.py Merge bitcoin/bitcoin#25589: test: speedup wallet_coinbase_category.py 2024-02-27 10:02:44 -06:00
wallet_create_tx.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
wallet_createwallet.py Merge #18788: tests: Update more tests to work with descriptor wallets 2024-03-09 03:01:24 +07:00
wallet_descriptor.py Merge #5981: backport: bitcoin#19136, #21063, #21277, #21302, partial #20267 - descriptor wallets part IV 2024-04-16 08:56:59 -05:00
wallet_disable.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
wallet_dump.py
wallet_encryption.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
wallet_fallbackfee.py Merge #18202: refactor: consolidate sendmany and sendtoaddress code 2024-05-29 13:57:02 +07:00
wallet_groups.py Merge #21411: test: add logging, reduce blocks, move sync_all in wallet_ groups 2024-04-11 02:26:01 +07:00
wallet_hd.py merge bitcoin#20286: deprecate addresses and reqSigs from rpc outputs 2024-06-27 19:27:37 +00:00
wallet_import_rescan.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
wallet_import_with_label.py
wallet_importdescriptors.py merge bitcoin#19651: importdescriptors update existing 2024-06-27 19:27:37 +00:00
wallet_importmulti.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
wallet_importprunedfunds.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
wallet_keypool_hd.py Merge bitcoin/bitcoin#29510: wallet: getrawchangeaddress and getnewaddress failures should not affect keypools for descriptor wallets 2024-03-07 01:23:24 +07:00
wallet_keypool_topup.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
wallet_keypool.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
wallet_labels.py Merge #18788: tests: Update more tests to work with descriptor wallets 2024-03-09 03:01:24 +07:00
wallet_listdescriptors.py Merge bitcoin/bitcoin#21329: descriptor wallet: Cache last hardened xpub and use in normalized descriptors 2024-05-10 14:02:01 +07:00
wallet_listreceivedby.py
wallet_listsinceblock.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
wallet_listtransactions.py Merge bitcoin/bitcoin#22423: test: wallet_listtransactions improvements (speedup, cleanup, logging) 2024-05-18 17:54:16 -05:00
wallet_mnemonicbits.py
wallet_multiwallet.py Merge #20540: test: Fix wallet_multiwallet issue on windows 2024-03-22 11:20:57 -05:00
wallet_orphanedreward.py Merge bitcoin/bitcoin#22187: test: Add sync_blocks in wallet_orphanedreward.py 2024-04-23 09:15:19 -05:00
wallet_reorgsrestore.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
wallet_resendwallettransactions.py merge bitcoin#21160: Move tx inventory into net_processing 2024-04-26 20:25:55 +00:00
wallet_send.py merge bitcoin#21359: include_unsafe option for fundrawtransaction 2024-06-27 19:27:37 +00:00
wallet_startup.py Merge #20813: scripted-diff: Bump copyright headers 2024-04-10 03:19:34 +07:00
wallet_txn_clone.py merge bitcoin#20286: deprecate addresses and reqSigs from rpc outputs 2024-06-27 19:27:37 +00:00
wallet_txn_doublespend.py Merge #21200: test: Speed up rpc_blockchain.py by removing miniwallet.generate() 2024-06-20 12:23:14 +07:00
wallet_upgradetohd.py merge bitcoin#20286: deprecate addresses and reqSigs from rpc outputs 2024-06-27 19:27:37 +00:00
wallet_upgradewallet.py Merge #20403: wallet: upgradewallet fixes, improvements, test coverage 2024-05-10 13:59:59 +07:00
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() and setup_xxxx() methods at the top of the subclass, then locally-defined helper methods, then the run_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, eg feature_rbf.py
    • interface for tests for other interfaces (REST, ZMQ, etc), eg interface_rest.py
    • mempool for tests for mempool behaviour, eg mempool_reorg.py
    • mining for tests for mining features, eg mining_prioritisetransaction.py
    • p2p for tests that explicitly test the p2p interface, eg p2p_disconnect_ban.py
    • rpc for tests for individual RPC methods or features, eg rpc_listtransactions.py
    • tool for tests for tools, eg tool_wallet.py
    • wallet for tests for wallet features, eg wallet_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, not rpc_decode_script.py
  • Don't use the redundant word test in the name, eg interface_zmq.py, not interface_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 in set_test_params() to True to initialize an empty blockchain and start from the Genesis block, rather than load a premined blockchain from cache with the default value of False. 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 and CTransaction 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 RPCs
  • ProcessMessage() in /src/net_processing.cpp for parsing P2P messages

Using the P2P interface

  • P2Ps 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.

P2PConnections 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 TestNodes):

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: