wallet_groups.py raw

   1  #!/usr/bin/env python3
   2  # Copyright (c) 2018-2022 The Limenka developers
   3  # Distributed under the MIT software license, see the accompanying
   4  # file COPYING or http://www.opensource.org/licenses/mit-license.php.
   5  """Test wallet group functionality."""
   6  
   7  from test_framework.blocktools import COINBASE_MATURITY
   8  from test_framework.test_framework import LimenkaTestFramework
   9  from test_framework.messages import (
  10      tx_from_hex,
  11  )
  12  from test_framework.util import (
  13      assert_approx,
  14      assert_equal,
  15  )
  16  
  17  
  18  class WalletGroupTest(LimenkaTestFramework):
  19      def add_options(self, parser):
  20          self.add_wallet_options(parser)
  21  
  22      def set_test_params(self):
  23          self.setup_clean_chain = True
  24          self.num_nodes = 5
  25          # whitelist peers to speed up tx relay / mempool sync
  26          self.noban_tx_relay = True
  27          self.extra_args = [
  28              [],
  29              [],
  30              ["-avoidpartialspends"],
  31              ["-maxapsfee=0.00002719"],
  32              ["-maxapsfee=0.00002720"],
  33          ]
  34  
  35          for args in self.extra_args:
  36              args.append(f"-paytxfee={20 * 1e3 / 1e8}")  # apply feerate of 20 sats/vB across all nodes
  37  
  38          self.rpc_timeout = 480
  39  
  40      def skip_test_if_missing_module(self):
  41          self.skip_if_no_wallet()
  42  
  43      def run_test(self):
  44          self.log.info("Setting up")
  45          # Mine some coins
  46          self.generate(self.nodes[0], COINBASE_MATURITY + 1)
  47  
  48          # Get some addresses from the two nodes
  49          addr1 = [self.nodes[1].getnewaddress() for _ in range(3)]
  50          addr2 = [self.nodes[2].getnewaddress() for _ in range(3)]
  51          addrs = addr1 + addr2
  52  
  53          # Send 1 + 0.5 coin to each address
  54          [self.nodes[0].sendtoaddress(addr, 1.0) for addr in addrs]
  55          [self.nodes[0].sendtoaddress(addr, 0.5) for addr in addrs]
  56  
  57          self.generate(self.nodes[0], 1)
  58  
  59          # For each node, send 0.2 coins back to 0;
  60          # - node[1] should pick one 0.5 UTXO and leave the rest
  61          # - node[2] should pick one (1.0 + 0.5) UTXO group corresponding to a
  62          #   given address, and leave the rest
  63          self.log.info("Test sending transactions picks one UTXO group and leaves the rest")
  64          txid1 = self.nodes[1].sendtoaddress(self.nodes[0].getnewaddress(), 0.2)
  65          tx1 = self.nodes[1].getrawtransaction(txid1, True)
  66          # txid1 should have 1 input and 2 outputs
  67          assert_equal(1, len(tx1["vin"]))
  68          assert_equal(2, len(tx1["vout"]))
  69          # one output should be 0.2, the other should be ~0.3
  70          v = [vout["value"] for vout in tx1["vout"]]
  71          v.sort()
  72          assert_approx(v[0], vexp=0.2, vspan=0.0001)
  73          assert_approx(v[1], vexp=0.3, vspan=0.0001)
  74  
  75          txid2 = self.nodes[2].sendtoaddress(self.nodes[0].getnewaddress(), 0.2)
  76          tx2 = self.nodes[2].getrawtransaction(txid2, True)
  77          # txid2 should have 2 inputs and 2 outputs
  78          assert_equal(2, len(tx2["vin"]))
  79          assert_equal(2, len(tx2["vout"]))
  80          # one output should be 0.2, the other should be ~1.3
  81          v = [vout["value"] for vout in tx2["vout"]]
  82          v.sort()
  83          assert_approx(v[0], vexp=0.2, vspan=0.0001)
  84          assert_approx(v[1], vexp=1.3, vspan=0.0001)
  85  
  86          self.log.info("Test avoiding partial spends if warranted, even if avoidpartialspends is disabled")
  87          self.sync_all()
  88          self.generate(self.nodes[0], 1)
  89          # Nodes 1-2 now have confirmed UTXOs (letters denote destinations):
  90          # Node #1:      Node #2:
  91          # - A  1.0      - D0 1.0
  92          # - B0 1.0      - D1 0.5
  93          # - B1 0.5      - E0 1.0
  94          # - C0 1.0      - E1 0.5
  95          # - C1 0.5      - F  ~1.3
  96          # - D ~0.3
  97          assert_approx(self.nodes[1].getbalance(), vexp=4.3, vspan=0.0001)
  98          assert_approx(self.nodes[2].getbalance(), vexp=4.3, vspan=0.0001)
  99          # Sending 1.4 btc should pick one 1.0 + one more. For node #1,
 100          # this could be (A / B0 / C0) + (B1 / C1 / D). We ensure that it is
 101          # B0 + B1 or C0 + C1, because this avoids partial spends while not being
 102          # detrimental to transaction cost
 103          txid3 = self.nodes[1].sendtoaddress(self.nodes[0].getnewaddress(), 1.4)
 104          tx3 = self.nodes[1].getrawtransaction(txid3, True)
 105          # tx3 should have 2 inputs and 2 outputs
 106          assert_equal(2, len(tx3["vin"]))
 107          assert_equal(2, len(tx3["vout"]))
 108          # the accumulated value should be 1.5, so the outputs should be
 109          # ~0.1 and 1.4 and should come from the same destination
 110          values = [vout["value"] for vout in tx3["vout"]]
 111          values.sort()
 112          assert_approx(values[0], vexp=0.1, vspan=0.0001)
 113          assert_approx(values[1], vexp=1.4, vspan=0.0001)
 114  
 115          input_txids = [vin["txid"] for vin in tx3["vin"]]
 116          input_addrs = [self.nodes[1].gettransaction(txid)['details'][0]['address'] for txid in input_txids]
 117          assert_equal(input_addrs[0], input_addrs[1])
 118          # Node 2 enforces avoidpartialspends so needs no checking here
 119  
 120          tx4_ungrouped_fee = 2820
 121          tx4_grouped_fee = 4160
 122          tx5_6_ungrouped_fee = 5520
 123          tx5_6_grouped_fee = 8240
 124  
 125          self.log.info("Test wallet option maxapsfee")
 126          addr_aps = self.nodes[3].getnewaddress()
 127          self.nodes[0].sendtoaddress(addr_aps, 1.0)
 128          self.nodes[0].sendtoaddress(addr_aps, 1.0)
 129          self.generate(self.nodes[0], 1)
 130          with self.nodes[3].assert_debug_log([f'Fee non-grouped = {tx4_ungrouped_fee}, grouped = {tx4_grouped_fee}, using grouped']):
 131              txid4 = self.nodes[3].sendtoaddress(self.nodes[0].getnewaddress(), 0.1)
 132          tx4 = self.nodes[3].getrawtransaction(txid4, True)
 133          # tx4 should have 2 inputs and 2 outputs although one output would
 134          # have been enough and the transaction caused higher fees
 135          assert_equal(2, len(tx4["vin"]))
 136          assert_equal(2, len(tx4["vout"]))
 137  
 138          addr_aps2 = self.nodes[3].getnewaddress()
 139          [self.nodes[0].sendtoaddress(addr_aps2, 1.0) for _ in range(5)]
 140          self.generate(self.nodes[0], 1)
 141          with self.nodes[3].assert_debug_log([f'Fee non-grouped = {tx5_6_ungrouped_fee}, grouped = {tx5_6_grouped_fee}, using non-grouped']):
 142              txid5 = self.nodes[3].sendtoaddress(self.nodes[0].getnewaddress(), 2.95)
 143          tx5 = self.nodes[3].getrawtransaction(txid5, True)
 144          # tx5 should have 3 inputs (1.0, 1.0, 1.0) and 2 outputs
 145          assert_equal(3, len(tx5["vin"]))
 146          assert_equal(2, len(tx5["vout"]))
 147  
 148          # Test wallet option maxapsfee with node 4, which sets maxapsfee
 149          # 1 sat higher, crossing the threshold from non-grouped to grouped.
 150          self.log.info("Test wallet option maxapsfee threshold from non-grouped to grouped")
 151          addr_aps3 = self.nodes[4].getnewaddress()
 152          [self.nodes[0].sendtoaddress(addr_aps3, 1.0) for _ in range(5)]
 153          self.generate(self.nodes[0], 1)
 154          with self.nodes[4].assert_debug_log([f'Fee non-grouped = {tx5_6_ungrouped_fee}, grouped = {tx5_6_grouped_fee}, using grouped']):
 155              txid6 = self.nodes[4].sendtoaddress(self.nodes[0].getnewaddress(), 2.95)
 156          tx6 = self.nodes[4].getrawtransaction(txid6, True)
 157          # tx6 should have 5 inputs and 2 outputs
 158          assert_equal(5, len(tx6["vin"]))
 159          assert_equal(2, len(tx6["vout"]))
 160  
 161          # Empty out node2's wallet
 162          self.nodes[2].sendall(recipients=[self.nodes[0].getnewaddress()])
 163          self.sync_all()
 164          self.generate(self.nodes[0], 1)
 165  
 166          self.log.info("Fill a wallet with 10,000 outputs corresponding to the same scriptPubKey")
 167          for _ in range(5):
 168              raw_tx = self.nodes[0].createrawtransaction([{"txid":"0"*64, "vout":0}], [{addr2[0]: 0.05}])
 169              tx = tx_from_hex(raw_tx)
 170              tx.vin = []
 171              tx.vout = [tx.vout[0]] * 2000
 172              funded_tx = self.nodes[0].fundrawtransaction(tx.serialize().hex())
 173              signed_tx = self.nodes[0].signrawtransactionwithwallet(funded_tx['hex'])
 174              self.nodes[0].sendrawtransaction(signed_tx['hex'])
 175              self.generate(self.nodes[0], 1)
 176  
 177          # Check that we can create a transaction that only requires ~100 of our
 178          # utxos, without pulling in all outputs and creating a transaction that
 179          # is way too big.
 180          self.log.info("Test creating txn that only requires ~100 of our UTXOs without pulling in all outputs")
 181          assert self.nodes[2].sendtoaddress(address=addr2[0], amount=5)
 182  
 183  
 184  if __name__ == '__main__':
 185      WalletGroupTest(__file__).main()
 186