From 01eedf3821f2c3ee6bab8733f8549531c844add7 Mon Sep 17 00:00:00 2001 From: Sebastian Falbesoner Date: Sat, 5 Jun 2021 19:01:00 +0200 Subject: [PATCH] test: doc: improve doc for chain_transaction() helper Change to docstring format and describe the functions purpose, its parameters and return value in more detail. --- test/functional/test_framework/util.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/test/functional/test_framework/util.py b/test/functional/test_framework/util.py index 4b5d14ebf9e..f354ae0075d 100644 --- a/test/functional/test_framework/util.py +++ b/test/functional/test_framework/util.py @@ -481,9 +481,13 @@ def create_confirmed_utxos(fee, node, count): return utxos -# Build a transaction that spends parent_txid:vout -# Return amount sent def chain_transaction(node, parent_txids, vouts, value, fee, num_outputs): + """Build and send a transaction that spends the given inputs (specified + by lists of parent_txid:vout each), with the desired total value and fee, + equally divided up to the desired number of outputs. + + Returns a tuple with the txid and the amount sent per output. + """ send_value = satoshi_round((value - fee)/num_outputs) inputs = [] for (txid, vout) in zip(parent_txids, vouts):