mining_prioritisetransaction.py raw
1 #!/usr/bin/env python3
2 # Copyright (c) 2015-present The Bitcoin Core 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 the prioritisetransaction mining RPC."""
6
7 from decimal import Decimal
8 import time
9
10 from test_framework.blocktools import NORMAL_GBT_REQUEST_PARAMS
11 from test_framework.messages import (
12 COIN,
13 MAX_BLOCK_WEIGHT,
14 )
15 from test_framework.test_framework import BitcoinTestFramework
16 from test_framework.util import (
17 assert_not_equal,
18 assert_equal,
19 assert_raises_rpc_error,
20 create_lots_of_big_transactions,
21 gen_return_txouts,
22 )
23 from test_framework.wallet import MiniWallet
24
25
26 class PrioritiseTransactionTest(BitcoinTestFramework):
27 def set_test_params(self):
28 self.num_nodes = 1
29 self.extra_args = [[
30 "-printpriority=1",
31 ]] * self.num_nodes
32 self.supports_cli = False
33
34 def clear_prioritisation(self, node):
35 for txid, info in node.getprioritisedtransactions().items():
36 delta = info["fee_delta"]
37 node.prioritisetransaction(txid, 0, -delta)
38 assert_equal(node.getprioritisedtransactions(), {})
39
40 def test_large_fee_bump(self):
41 self.log.info("Test that a large fee delta is honoured")
42 tx = self.wallet.create_self_transfer()
43 txid = tx["txid"]
44 fee_delta = int(86 * COIN) # large enough to not fit into (u)int32_t
45 self.nodes[0].prioritisetransaction(txid=txid, fee_delta=fee_delta)
46 assert_equal(
47 self.nodes[0].getprioritisedtransactions(),
48 {
49 txid: {
50 "fee_delta": fee_delta,
51 "in_mempool": False,
52 },
53 },
54 )
55 self.nodes[0].sendrawtransaction(tx["hex"])
56 expected_modified_fee = tx["fee"] + Decimal(fee_delta) / COIN
57 assert_equal(
58 self.nodes[0].getprioritisedtransactions(),
59 {
60 txid: {
61 "fee_delta": fee_delta,
62 "in_mempool": True,
63 "modified_fee": int(expected_modified_fee * COIN),
64 },
65 },
66 )
67 # This transaction forms its own chunk.
68 mempool_entry = self.nodes[0].getrawmempool(verbose=True)[txid]
69 assert_equal(mempool_entry["fees"]["base"], tx["fee"])
70 assert_equal(mempool_entry["fees"]["modified"], expected_modified_fee)
71 assert_equal(mempool_entry["fees"]["ancestor"], expected_modified_fee)
72 assert_equal(mempool_entry["fees"]["descendant"], expected_modified_fee)
73 assert_equal(mempool_entry["fees"]["chunk"], expected_modified_fee)
74 assert_equal(mempool_entry["chunkweight"], mempool_entry["weight"])
75 append_chunk_info = self.nodes[0].getmempoolcluster(txid)
76 assert_equal(
77 append_chunk_info,
78 {
79 "clusterweight": mempool_entry["weight"],
80 "txcount": 1,
81 "chunks": [{
82 "chunkfee": expected_modified_fee,
83 "chunkweight": mempool_entry["weight"],
84 "txs": [txid],
85 }],
86 },
87 )
88 self.generate(self.nodes[0], 1)
89 assert_equal(self.nodes[0].getprioritisedtransactions(), {})
90
91 def test_replacement(self):
92 self.log.info("Test tx prioritisation stays after a tx is replaced")
93 conflicting_input = self.wallet.get_utxo()
94 tx_replacee = self.wallet.create_self_transfer(utxo_to_spend=conflicting_input, fee_rate=Decimal("0.0001"))
95 tx_replacement = self.wallet.create_self_transfer(utxo_to_spend=conflicting_input, fee_rate=Decimal("0.005"))
96 # Add 1 satoshi fee delta to replacee
97 self.nodes[0].prioritisetransaction(tx_replacee["txid"], 0, 100)
98 assert_equal(self.nodes[0].getprioritisedtransactions(), { tx_replacee["txid"] : { "fee_delta" : 100, "in_mempool" : False}})
99 self.nodes[0].sendrawtransaction(tx_replacee["hex"])
100 assert_equal(self.nodes[0].getprioritisedtransactions(), { tx_replacee["txid"] : { "fee_delta" : 100, "in_mempool" : True, "modified_fee": int(tx_replacee["fee"] * COIN + 100)}})
101 self.nodes[0].sendrawtransaction(tx_replacement["hex"])
102 assert tx_replacee["txid"] not in self.nodes[0].getrawmempool()
103 assert_equal(self.nodes[0].getprioritisedtransactions(), { tx_replacee["txid"] : { "fee_delta" : 100, "in_mempool" : False}})
104
105 # PrioritiseTransaction is additive
106 self.nodes[0].prioritisetransaction(tx_replacee["txid"], 0, COIN)
107 self.nodes[0].sendrawtransaction(tx_replacee["hex"])
108 assert_equal(self.nodes[0].getprioritisedtransactions(), { tx_replacee["txid"] : { "fee_delta" : COIN + 100, "in_mempool" : True, "modified_fee": int(tx_replacee["fee"] * COIN + COIN + 100)}})
109 self.generate(self.nodes[0], 1)
110 assert_equal(self.nodes[0].getprioritisedtransactions(), {})
111
112 def test_diamond(self):
113 self.log.info("Test diamond-shape package with priority")
114 mock_time = int(time.time())
115 self.nodes[0].setmocktime(mock_time)
116
117 # tx_a
118 # / \
119 # / \
120 # tx_b tx_c
121 # \ /
122 # \ /
123 # tx_d
124
125 tx_o_a = self.wallet.send_self_transfer_multi(
126 from_node=self.nodes[0],
127 num_outputs=2,
128 )
129 txid_a = tx_o_a["txid"]
130
131 tx_o_b, tx_o_c = [self.wallet.send_self_transfer(
132 from_node=self.nodes[0],
133 utxo_to_spend=u,
134 ) for u in tx_o_a["new_utxos"]]
135 txid_b = tx_o_b["txid"]
136 txid_c = tx_o_c["txid"]
137
138 tx_o_d = self.wallet.send_self_transfer_multi(
139 from_node=self.nodes[0],
140 utxos_to_spend=[
141 self.wallet.get_utxo(txid=txid_b),
142 self.wallet.get_utxo(txid=txid_c),
143 ],
144 )
145 txid_d = tx_o_d["txid"]
146
147 self.log.info("Test priority while txs are in mempool")
148 raw_before = self.nodes[0].getrawmempool(verbose=True)
149 fee_delta_b = Decimal(9999) / COIN
150 fee_delta_c_1 = Decimal(-1234) / COIN
151 fee_delta_c_2 = Decimal(8888) / COIN
152 self.nodes[0].prioritisetransaction(txid=txid_b, fee_delta=int(fee_delta_b * COIN))
153 self.nodes[0].prioritisetransaction(txid=txid_c, fee_delta=int(fee_delta_c_1 * COIN))
154 self.nodes[0].prioritisetransaction(txid=txid_c, fee_delta=int(fee_delta_c_2 * COIN))
155 raw_before[txid_a]["fees"]["descendant"] += fee_delta_b + fee_delta_c_1 + fee_delta_c_2
156 # We expect tx_a to have a chunk fee that includes tx_b and tx_c.
157 raw_before[txid_a]["fees"]["chunk"] += fee_delta_b + fee_delta_c_1 + fee_delta_c_2
158 raw_before[txid_b]["fees"]["modified"] += fee_delta_b
159 raw_before[txid_b]["fees"]["ancestor"] += fee_delta_b
160 raw_before[txid_b]["fees"]["descendant"] += fee_delta_b
161 # We also expect tx_b and tx_c to have their chunk fees modified too,
162 # since they chunk together.
163 raw_before[txid_b]["fees"]["chunk"] += fee_delta_b + fee_delta_c_1 + fee_delta_c_2
164 raw_before[txid_c]["fees"]["modified"] += fee_delta_c_1 + fee_delta_c_2
165 raw_before[txid_c]["fees"]["ancestor"] += fee_delta_c_1 + fee_delta_c_2
166 raw_before[txid_c]["fees"]["descendant"] += fee_delta_c_1 + fee_delta_c_2
167 raw_before[txid_c]["fees"]["chunk"] += fee_delta_b + fee_delta_c_1 + fee_delta_c_2
168 raw_before[txid_d]["fees"]["ancestor"] += fee_delta_b + fee_delta_c_1 + fee_delta_c_2
169 raw_after = self.nodes[0].getrawmempool(verbose=True)
170 # Don't bother comparing cluster ids, which are not meant to be stable.
171 assert_equal(raw_before[txid_a], raw_after[txid_a])
172 assert_equal(raw_before, raw_after)
173 assert_equal(self.nodes[0].getprioritisedtransactions(), {txid_b: {"fee_delta" : fee_delta_b*COIN, "in_mempool" : True, "modified_fee": int(fee_delta_b*COIN + COIN * tx_o_b["fee"])}, txid_c: {"fee_delta" : (fee_delta_c_1 + fee_delta_c_2)*COIN, "in_mempool" : True, "modified_fee": int((fee_delta_c_1 + fee_delta_c_2 ) * COIN + COIN * tx_o_c["fee"])}})
174 # Clear prioritisation, otherwise the transactions' fee deltas are persisted to mempool.dat and loaded again when the node
175 # is restarted at the end of this subtest. Deltas are removed when a transaction is mined, but only at that time. We do
176 # not check whether mapDeltas transactions were mined when loading from mempool.dat.
177 self.clear_prioritisation(node=self.nodes[0])
178
179 self.log.info("Test priority while txs are not in mempool")
180 self.restart_node(0, extra_args=["-nopersistmempool"])
181 self.nodes[0].setmocktime(mock_time)
182 assert_equal(self.nodes[0].getmempoolinfo()["size"], 0)
183 self.nodes[0].prioritisetransaction(txid=txid_b, fee_delta=int(fee_delta_b * COIN))
184 self.nodes[0].prioritisetransaction(txid=txid_c, fee_delta=int(fee_delta_c_1 * COIN))
185 self.nodes[0].prioritisetransaction(txid=txid_c, fee_delta=int(fee_delta_c_2 * COIN))
186 assert_equal(self.nodes[0].getprioritisedtransactions(), {txid_b: {"fee_delta" : fee_delta_b*COIN, "in_mempool" : False}, txid_c: {"fee_delta" : (fee_delta_c_1 + fee_delta_c_2)*COIN, "in_mempool" : False}})
187 for t in [tx_o_a["hex"], tx_o_b["hex"], tx_o_c["hex"], tx_o_d["hex"]]:
188 self.nodes[0].sendrawtransaction(t)
189 raw_after = self.nodes[0].getrawmempool(verbose=True)
190 assert_equal(raw_before[txid_a], raw_after[txid_a])
191 assert_equal(raw_before, raw_after)
192 assert_equal(self.nodes[0].getprioritisedtransactions(), {txid_b: {"fee_delta" : fee_delta_b*COIN, "in_mempool" : True, "modified_fee": int(fee_delta_b*COIN + COIN * tx_o_b["fee"])}, txid_c: {"fee_delta" : (fee_delta_c_1 + fee_delta_c_2)*COIN, "in_mempool" : True, "modified_fee": int((fee_delta_c_1 + fee_delta_c_2 ) * COIN + COIN * tx_o_c["fee"])}})
193
194 # Clear mempool
195 self.generate(self.nodes[0], 1)
196 # Prioritisation for transactions is automatically deleted after they are mined.
197 assert_equal(self.nodes[0].getprioritisedtransactions(), {})
198
199 # Use default extra_args
200 self.restart_node(0)
201 assert_equal(self.nodes[0].getprioritisedtransactions(), {})
202
203 def run_test(self):
204 self.wallet = MiniWallet(self.nodes[0])
205
206 # Test `prioritisetransaction` required parameters
207 assert_raises_rpc_error(-1, "prioritisetransaction", self.nodes[0].prioritisetransaction)
208 assert_raises_rpc_error(-1, "prioritisetransaction", self.nodes[0].prioritisetransaction, '')
209 assert_raises_rpc_error(-1, "prioritisetransaction", self.nodes[0].prioritisetransaction, '', 0)
210
211 # Test `prioritisetransaction` invalid extra parameters
212 assert_raises_rpc_error(-1, "prioritisetransaction", self.nodes[0].prioritisetransaction, '', 0, 0, 0)
213
214 # Test `getprioritisedtransactions` invalid parameters
215 assert_raises_rpc_error(-1, "getprioritisedtransactions",
216 self.nodes[0].getprioritisedtransactions, True)
217
218 # Test `prioritisetransaction` invalid `txid`
219 assert_raises_rpc_error(-8, "txid must be of length 64 (not 3, for 'foo')", self.nodes[0].prioritisetransaction, txid='foo', fee_delta=0)
220 assert_raises_rpc_error(-8, "txid must be hexadecimal string (not 'Zd1d4e24ed99057e84c3f80fd8fbec79ed9e1acee37da269356ecea000000000')", self.nodes[0].prioritisetransaction, txid='Zd1d4e24ed99057e84c3f80fd8fbec79ed9e1acee37da269356ecea000000000', fee_delta=0)
221
222 # Test `prioritisetransaction` invalid `dummy`
223 txid = '1d1d4e24ed99057e84c3f80fd8fbec79ed9e1acee37da269356ecea000000000'
224 assert_raises_rpc_error(-3, "JSON value of type string is not of expected type number", self.nodes[0].prioritisetransaction, txid, 'foo', 0)
225 assert_raises_rpc_error(-8, "Priority is no longer supported, dummy argument to prioritisetransaction must be 0.", self.nodes[0].prioritisetransaction, txid, 1, 0)
226
227 # Test `prioritisetransaction` invalid `fee_delta`
228 assert_raises_rpc_error(-3, "JSON value of type string is not of expected type number", self.nodes[0].prioritisetransaction, txid=txid, fee_delta='foo')
229
230 self.test_large_fee_bump()
231 self.test_replacement()
232 self.test_diamond()
233
234 self.txouts = gen_return_txouts()
235 self.relayfee = self.nodes[0].getnetworkinfo()['relayfee']
236
237 utxo_count = 90
238 utxos = self.wallet.send_self_transfer_multi(from_node=self.nodes[0], num_outputs=utxo_count)['new_utxos']
239 self.generate(self.wallet, 1)
240 assert_equal(len(self.nodes[0].getrawmempool()), 0)
241
242 base_fee = self.relayfee*100 # our transactions are smaller than 100kb
243 txids = []
244
245 # Create 3 batches of transactions at 3 different fee rate levels
246 range_size = utxo_count // 3
247 for i in range(3):
248 txids.append([])
249 start_range = i * range_size
250 end_range = start_range + range_size
251 txids[i] = create_lots_of_big_transactions(
252 self.wallet,
253 self.nodes[0],
254 (i+1) * base_fee,
255 end_range - start_range,
256 self.txouts,
257 utxos[start_range:end_range])
258
259 # Make sure that the size of each group of transactions exceeds
260 # MAX_BLOCK_WEIGHT // 4 -- otherwise the test needs to be revised to
261 # create more transactions.
262 mempool = self.nodes[0].getrawmempool(True)
263 sizes = [0, 0, 0]
264 for i in range(3):
265 for j in txids[i]:
266 assert j in mempool
267 sizes[i] += mempool[j]['vsize']
268 assert sizes[i] > MAX_BLOCK_WEIGHT // 4 # Fail => raise utxo_count
269
270 assert_equal(self.nodes[0].getprioritisedtransactions(), {})
271 # add a fee delta to something in the cheapest bucket and make sure it gets mined
272 # also check that a different entry in the cheapest bucket is NOT mined
273 self.nodes[0].prioritisetransaction(txid=txids[0][0], fee_delta=int(3*base_fee*COIN))
274 assert_equal(self.nodes[0].getprioritisedtransactions(), {txids[0][0] : { "fee_delta" : 3*base_fee*COIN, "in_mempool" : True, "modified_fee": int(3*base_fee*COIN + COIN * 1 * base_fee)}})
275
276 # Priority disappears when prioritisetransaction is called with an inverse value...
277 self.nodes[0].prioritisetransaction(txid=txids[0][0], fee_delta=int(-3*base_fee*COIN))
278 assert txids[0][0] not in self.nodes[0].getprioritisedtransactions()
279 # ... and reappears when prioritisetransaction is called again.
280 self.nodes[0].prioritisetransaction(txid=txids[0][0], fee_delta=int(3*base_fee*COIN))
281 assert txids[0][0] in self.nodes[0].getprioritisedtransactions()
282
283 self.generate(self.nodes[0], 1)
284
285 mempool = self.nodes[0].getrawmempool()
286 self.log.info("Assert that prioritised transaction was mined")
287 assert txids[0][0] not in mempool
288 assert txids[0][1] in mempool
289
290 high_fee_tx = None
291 for x in txids[2]:
292 if x not in mempool:
293 high_fee_tx = x
294
295 # Something high-fee should have been mined!
296 assert high_fee_tx is not None
297
298 # Add a prioritisation before a tx is in the mempool (de-prioritising a
299 # high-fee transaction so that it's now low fee).
300 self.nodes[0].prioritisetransaction(txid=high_fee_tx, fee_delta=-int(2*base_fee*COIN))
301 assert_equal(self.nodes[0].getprioritisedtransactions()[high_fee_tx], { "fee_delta" : -2*base_fee*COIN, "in_mempool" : False})
302
303 # Add everything back to mempool
304 self.nodes[0].invalidateblock(self.nodes[0].getbestblockhash())
305
306 # Check to make sure our high fee rate tx is back in the mempool
307 mempool = self.nodes[0].getrawmempool()
308 assert high_fee_tx in mempool
309
310 # Now verify the modified-high feerate transaction isn't mined before
311 # the other high fee transactions. Keep mining until our mempool has
312 # decreased by all the high fee size that we calculated above.
313 while (self.nodes[0].getmempoolinfo()['bytes'] > sizes[0] + sizes[1]):
314 self.generate(self.nodes[0], 1, sync_fun=self.no_op)
315
316 # High fee transaction should not have been mined, but other high fee rate
317 # transactions should have been.
318 mempool = self.nodes[0].getrawmempool()
319 self.log.info("Assert that de-prioritised transaction is still in mempool")
320 assert high_fee_tx in mempool
321 assert_equal(self.nodes[0].getprioritisedtransactions()[high_fee_tx], { "fee_delta" : -2*base_fee*COIN, "in_mempool" : True, "modified_fee": int(-2*base_fee*COIN + COIN * 3 * base_fee)})
322 for x in txids[2]:
323 if (x != high_fee_tx):
324 assert x not in mempool
325
326
327 self.log.info("Assert that 0 delta is never added to mapDeltas")
328 tx_id_zero_del = self.wallet.create_self_transfer()['txid']
329 self.nodes[0].prioritisetransaction(txid=tx_id_zero_del, fee_delta=0)
330 assert tx_id_zero_del not in self.nodes[0].getprioritisedtransactions()
331
332 # Create a free transaction. Should be rejected.
333 tx_res = self.wallet.create_self_transfer(fee_rate=0)
334 tx_hex = tx_res['hex']
335 tx_id = tx_res['txid']
336
337 # This will raise an exception due to min relay fee not being met
338 assert_raises_rpc_error(-26, "min relay fee not met", self.nodes[0].sendrawtransaction, tx_hex)
339 assert tx_id not in self.nodes[0].getrawmempool()
340
341 # This is a less than 1000-byte transaction, so just set the fee
342 # to be the minimum for a 1000-byte transaction and check that it is
343 # accepted.
344 self.nodes[0].prioritisetransaction(txid=tx_id, fee_delta=int(self.relayfee*COIN))
345 assert_equal(self.nodes[0].getprioritisedtransactions()[tx_id], { "fee_delta" : self.relayfee*COIN, "in_mempool" : False})
346
347 self.log.info("Assert that prioritised free transaction is accepted to mempool")
348 assert_equal(self.nodes[0].sendrawtransaction(tx_hex), tx_id)
349 assert tx_id in self.nodes[0].getrawmempool()
350 assert_equal(self.nodes[0].getprioritisedtransactions()[tx_id], { "fee_delta" : self.relayfee*COIN, "in_mempool" : True, "modified_fee": int(self.relayfee*COIN + COIN * tx_res["fee"])})
351
352 # Test that calling prioritisetransaction is sufficient to trigger
353 # getblocktemplate to (eventually) return a new block.
354 mock_time = int(time.time())
355 self.nodes[0].setmocktime(mock_time)
356 template = self.nodes[0].getblocktemplate(NORMAL_GBT_REQUEST_PARAMS)
357 self.nodes[0].prioritisetransaction(txid=tx_id, fee_delta=-int(self.relayfee*COIN))
358
359 # Calling prioritisetransaction with the inverse amount should delete its prioritisation entry
360 assert tx_id not in self.nodes[0].getprioritisedtransactions()
361
362 self.nodes[0].setmocktime(mock_time+10)
363 new_template = self.nodes[0].getblocktemplate(NORMAL_GBT_REQUEST_PARAMS)
364
365 assert_not_equal(template, new_template)
366
367 if __name__ == '__main__':
368 PrioritiseTransactionTest(__file__).main()
369