refactor: add helper for finding collateral vout

Author: kwvg

test/functional/feature_dip3_deterministicmns.py

@@ -13,6 +13,7 @@
 from test_framework.blocktools import create_block_with_mnpayments
 from test_framework.messages import tx_from_hex
 from test_framework.test_framework import (
+    MASTERNODE_COLLATERAL,
     BitcoinTestFramework,
     MasternodeInfo,
 )
@@ -49,7 +50,7 @@ def start_controller_node(self):
 
     def run_test(self):
         self.log.info("funding controller node")
-        while self.nodes[0].getbalance() < (self.num_initial_mn + 3) * 1000:
+        while self.nodes[0].getbalance() < (self.num_initial_mn + 3) * MASTERNODE_COLLATERAL:
             self.generate(self.nodes[0], 10, sync_fun=self.no_op) # generate enough for collaterals
         self.log.info("controller node has {} dash".format(self.nodes[0].getbalance()))
 
@@ -228,34 +229,17 @@ def prepare_mn(self, node, idx, alias) -> MasternodeInfo:
         return mn
 
     def create_mn_collateral(self, node, mn: MasternodeInfo):
-        txid = node.sendtoaddress(mn.collateral_address, 1000)
-        vout = None
-
+        txid = node.sendtoaddress(mn.collateral_address, mn.get_collateral_value())
         self.generate(node, 1, sync_fun=self.no_op)
-        rawtx = node.getrawtransaction(txid, 1)
-        for txout in rawtx['vout']:
-            if txout['value'] == Decimal(1000):
-                vout = txout['n']
-                break
-        assert vout is not None
-
+        vout = mn.get_collateral_vout(node, txid)
         mn.set_params(collateral_txid=txid, collateral_vout=vout)
 
     # register a protx MN and also fund it (using collateral inside ProRegTx)
     def register_fund_mn(self, node, mn: MasternodeInfo):
-        node.sendtoaddress(mn.fundsAddr, 1000.001)
-
-        proTxHash = node.protx('register_fund' if softfork_active(node, 'v19') else 'register_fund_legacy', mn.collateral_address, '127.0.0.1:%d' % mn.nodePort, mn.ownerAddr, mn.pubKeyOperator, mn.votingAddr, mn.operator_reward, mn.rewards_address, mn.fundsAddr)
-        vout = None
-
-        rawtx = node.getrawtransaction(proTxHash, 1)
-        for txout in rawtx['vout']:
-            if txout['value'] == Decimal(1000):
-                vout = txout['n']
-                break
-        assert vout is not None
-
-        mn.set_params(proTxHash=proTxHash, collateral_txid=proTxHash, collateral_vout=vout)
+        node.sendtoaddress(mn.fundsAddr, mn.get_collateral_value() + 0.001)
+        txid = node.protx('register_fund' if softfork_active(node, 'v19') else 'register_fund_legacy', mn.collateral_address, '127.0.0.1:%d' % mn.nodePort, mn.ownerAddr, mn.pubKeyOperator, mn.votingAddr, mn.operator_reward, mn.rewards_address, mn.fundsAddr)
+        vout = mn.get_collateral_vout(node, txid)
+        mn.set_params(proTxHash=txid, collateral_txid=txid, collateral_vout=vout)
 
     # create a protx MN which refers to an existing collateral
     def register_mn(self, node, mn: MasternodeInfo):
@@ -275,7 +259,7 @@ def start_mn(self, mn: MasternodeInfo):
         self.sync_all()
 
     def spend_mn_collateral(self, mn: MasternodeInfo, with_dummy_input_output=False):
-        return self.spend_input(mn.collateral_txid, mn.collateral_vout, 1000, with_dummy_input_output)
+        return self.spend_input(mn.collateral_txid, mn.collateral_vout, mn.get_collateral_value(), with_dummy_input_output)
 
     def update_mn_payee(self, mn: MasternodeInfo, payee):
         self.nodes[0].sendtoaddress(mn.fundsAddr, 0.001)

test/functional/test_framework/test_framework.py

@@ -1173,6 +1173,18 @@ def generate_addresses(self, node: TestNode, force_all: bool = False):
             self.pubKeyOperator = bls_ret['public']
             self.keyOperator = bls_ret['secret']
 
+    def get_collateral_value(self) -> int:
+        return EVONODE_COLLATERAL if self.evo else MASTERNODE_COLLATERAL
+
+    def get_collateral_vout(self, node: TestNode, txid: str, should_throw: bool = True) -> int:
+        for txout in node.getrawtransaction(txid, 1)['vout']:
+            if txout['value'] == self.get_collateral_value():
+                return txout['n']
+        if should_throw:
+            raise AssertionError(f"Unable to find collateral vout from txid {txid}")
+        else:
+            return -1
+
     def __init__(self, evo: bool, legacy: bool):
         self.evo = evo
         self.legacy = legacy
@@ -1372,19 +1384,11 @@ def dynamically_prepare_masternode(self, idx, node_p2p_port, evo=False, rnd=None
         platform_p2p_port = '%d' % (node_p2p_port + 101)
         platform_http_port = '%d' % (node_p2p_port + 102)
 
-        collateral_amount = EVONODE_COLLATERAL if evo else MASTERNODE_COLLATERAL
-        outputs = {mn.collateral_address: collateral_amount, mn.fundsAddr: 1}
+        outputs = {mn.collateral_address: mn.get_collateral_value(), mn.fundsAddr: 1}
         collateral_txid = self.nodes[0].sendmany("", outputs)
         self.bump_mocktime(10 * 60 + 1) # to make tx safe to include in block
         mn.bury_tx(self, genIdx=0, txid=collateral_txid, depth=1)
-
-        rawtx = self.nodes[0].getrawtransaction(collateral_txid, 1)
-        collateral_vout = 0
-        for txout in rawtx['vout']:
-            if txout['value'] == Decimal(collateral_amount):
-                collateral_vout = txout['n']
-                break
-        assert collateral_vout is not None
+        collateral_vout = mn.get_collateral_vout(self.nodes[0], collateral_txid)
 
         ipAndPort = '127.0.0.1:%d' % node_p2p_port
         operatorReward = idx
@@ -1441,16 +1445,11 @@ def prepare_masternode(self, idx):
         mn = MasternodeInfo(evo=False, legacy=(not softfork_active(self.nodes[0], 'v19')))
         mn.generate_addresses(self.nodes[0])
 
-        collateral_amount = MASTERNODE_COLLATERAL
-        txid = self.nodes[0].sendtoaddress(mn.fundsAddr, collateral_amount)
+        txid = self.nodes[0].sendtoaddress(mn.fundsAddr, mn.get_collateral_value())
         collateral_vout = 0
         register_fund = (idx % 2) == 0
         if not register_fund:
-            txraw = self.nodes[0].getrawtransaction(txid, True)
-            for vout_idx in range(0, len(txraw["vout"])):
-                vout = txraw["vout"][vout_idx]
-                if vout["value"] == collateral_amount:
-                    collateral_vout = vout_idx
+            collateral_vout = mn.get_collateral_vout(self.nodes[0], txid)
             self.nodes[0].lockunspent(False, [{'txid': txid, 'vout': collateral_vout}])
 
         # send to same address to reserve some funds for fees