1 #!/usr/bin/env python3
2 # Copyright (c) 2020-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 datacarrier functionality"""
6 from test_framework.messages import (
7 CTxOut,
8 MAX_OP_RETURN_RELAY,
9 )
10 from test_framework.script import (
11 CScript,
12 OP_RETURN,
13 )
14 from test_framework.test_framework import BitcoinTestFramework
15 from test_framework.test_node import TestNode
16 from test_framework.util import (
17 assert_equal,
18 assert_raises_rpc_error,
19 )
20 from test_framework.wallet import MiniWallet
21 22 from random import randbytes
23 24 # The historical maximum, now used to test coverage
25 CUSTOM_DATACARRIER_ARG = 83
26 27 class DataCarrierTest(BitcoinTestFramework):
28 def set_test_params(self):
29 self.num_nodes = 4
30 self.extra_args = [
31 [], # default is uncapped
32 ["-datacarrier=0"], # no relay of datacarrier
33 ["-datacarrier=1", f"-datacarriersize={CUSTOM_DATACARRIER_ARG}"],
34 ["-datacarrier=1", "-datacarriersize=2"],
35 ]
36 37 def test_null_data_transaction(self, node: TestNode, data, success: bool) -> None:
38 tx = self.wallet.create_self_transfer(fee_rate=0)["tx"]
39 data = [] if data is None else [data]
40 tx.vout.append(CTxOut(nValue=0, scriptPubKey=CScript([OP_RETURN] + data)))
41 tx.vout[0].nValue -= tx.get_vsize() # simply pay 1sat/vbyte fee
42 43 tx_hex = tx.serialize().hex()
44 45 if success:
46 self.wallet.sendrawtransaction(from_node=node, tx_hex=tx_hex)
47 assert tx.txid_hex in node.getrawmempool(True), f'{tx_hex} not in mempool'
48 else:
49 assert_raises_rpc_error(-26, "datacarrier", self.wallet.sendrawtransaction, from_node=node, tx_hex=tx_hex)
50 51 def run_test(self):
52 self.wallet = MiniWallet(self.nodes[0])
53 54 # Test that bare multisig is allowed by default. Do it here rather than create a new test for it.
55 assert_equal(self.nodes[0].getmempoolinfo()["permitbaremultisig"], True)
56 57 assert_equal(self.nodes[0].getmempoolinfo()["maxdatacarriersize"], MAX_OP_RETURN_RELAY)
58 assert_equal(self.nodes[1].getmempoolinfo()["maxdatacarriersize"], 0)
59 assert_equal(self.nodes[2].getmempoolinfo()["maxdatacarriersize"], CUSTOM_DATACARRIER_ARG)
60 assert_equal(self.nodes[3].getmempoolinfo()["maxdatacarriersize"], 2)
61 62 # By default, any size is allowed.
63 64 # If it is custom set to 83, the historical value,
65 # only 80 bytes are used for data (+1 for OP_RETURN, +2 for the pushdata opcodes).
66 custom_size_data = randbytes(CUSTOM_DATACARRIER_ARG - 3)
67 too_long_data = randbytes(CUSTOM_DATACARRIER_ARG - 2)
68 extremely_long_data = randbytes(MAX_OP_RETURN_RELAY - 200)
69 one_byte = randbytes(1)
70 zero_bytes = randbytes(0)
71 72 self.log.info("Testing a null data transaction succeeds for default arg regardless of size.")
73 self.test_null_data_transaction(node=self.nodes[0], data=too_long_data, success=True)
74 self.test_null_data_transaction(node=self.nodes[0], data=extremely_long_data, success=True)
75 76 self.log.info("Testing a null data transaction with -datacarrier=false.")
77 self.test_null_data_transaction(node=self.nodes[1], data=custom_size_data, success=False)
78 79 self.log.info("Testing a null data transaction with a size larger than accepted by -datacarriersize.")
80 self.test_null_data_transaction(node=self.nodes[2], data=too_long_data, success=False)
81 82 self.log.info("Testing a null data transaction with a size equal to -datacarriersize.")
83 self.test_null_data_transaction(node=self.nodes[2], data=custom_size_data, success=True)
84 85 self.log.info("Testing a null data transaction with no data.")
86 self.test_null_data_transaction(node=self.nodes[0], data=None, success=True)
87 self.test_null_data_transaction(node=self.nodes[1], data=None, success=False)
88 self.test_null_data_transaction(node=self.nodes[2], data=None, success=True)
89 self.test_null_data_transaction(node=self.nodes[3], data=None, success=True)
90 91 self.log.info("Testing a null data transaction with zero bytes of data.")
92 self.test_null_data_transaction(node=self.nodes[0], data=zero_bytes, success=True)
93 self.test_null_data_transaction(node=self.nodes[1], data=zero_bytes, success=False)
94 self.test_null_data_transaction(node=self.nodes[2], data=zero_bytes, success=True)
95 self.test_null_data_transaction(node=self.nodes[3], data=zero_bytes, success=True)
96 97 self.log.info("Testing a null data transaction with one byte of data.")
98 self.test_null_data_transaction(node=self.nodes[0], data=one_byte, success=True)
99 self.test_null_data_transaction(node=self.nodes[1], data=one_byte, success=False)
100 self.test_null_data_transaction(node=self.nodes[2], data=one_byte, success=True)
101 self.test_null_data_transaction(node=self.nodes[3], data=one_byte, success=False)
102 103 if __name__ == '__main__':
104 DataCarrierTest(__file__).main()
105