No OneTemporary
Actions

Size

41 KB

Subscribers

None

View Options

	diff --git a/test/functional/chronik_electrum_blockchain.py b/test/functional/chronik_electrum_blockchain.py
	index b41add29b..cae86fc02 100644
	--- a/test/functional/chronik_electrum_blockchain.py
	+++ b/test/functional/chronik_electrum_blockchain.py
	@@ -1,923 +1,923 @@
	# Copyright (c) 2024-present The Bitcoin developers
	# Distributed under the MIT software license, see the accompanying
	# file COPYING or http://www.opensource.org/licenses/mit-license.php.
	"""
	Test Chronik's electrum interface: blockchain.* methods
	"""
	from test_framework.address import ADDRESS_ECREG_UNSPENDABLE
	from test_framework.blocktools import (
	GENESIS_BLOCK_HASH,
	GENESIS_CB_SCRIPT_PUBKEY,
	GENESIS_CB_SCRIPT_SIG,
	GENESIS_CB_TXID,
	TIME_GENESIS_BLOCK,
	)
	from test_framework.hash import hex_be_sha256
	from test_framework.merkle import merkle_root_and_branch
	from test_framework.messages import (
	XEC,
	COutPoint,
	CTransaction,
	CTxIn,
	CTxOut,
	FromHex,
	ToHex,
	)
	from test_framework.script import OP_RETURN, OP_TRUE, CScript
	from test_framework.test_framework import BitcoinTestFramework
	from test_framework.util import assert_equal, chronikelectrum_port, hex_to_be_bytes
	from test_framework.wallet import MiniWallet

	COINBASE_TX_HEX = (
	"01000000010000000000000000000000000000000000000000000000000000000000000000ffffffff4d"
	+ GENESIS_CB_SCRIPT_SIG.hex()
	+ "ffffffff0100f2052a0100000043"
	+ GENESIS_CB_SCRIPT_PUBKEY.hex()
	+ "00000000"
	)

	max_int32 = 2**31 - 1
	max_int64 = 2**63 - 1


	class ChronikElectrumBlockchain(BitcoinTestFramework):
	def set_test_params(self):
	self.num_nodes = 1
	self.extra_args = [
	[
	"-chronik",
	f"-chronikelectrumbind=127.0.0.1:{chronikelectrum_port(0)}",
	"-chronikscripthashindex=1",
	]
	]

	def skip_test_if_missing_module(self):
	self.skip_if_no_chronik()

	def run_test(self):
	self.client = self.nodes[0].get_chronik_electrum_client()
	self.node = self.nodes[0]
	self.wallet = MiniWallet(self.node)

	self.test_invalid_params()
	self.test_transaction_get()
	self.test_transaction_get_height()
	self.test_transaction_broadcast()
	self.test_transaction_get_merkle()
	self.test_block_header()
	self.test_scripthash()
	self.test_headers_subscribe()

	def test_invalid_params(self):
	# Invalid params type
	for response in (
	self.client.synchronous_request("blockchain.transaction.get", params="foo"),
	self.client.synchronous_request("blockchain.transaction.get", params=42),
	):
	assert_equal(
	response.error,
	{"code": -32602, "message": "'params' must be an array or an object"},
	)

	assert_equal(
	self.client.synchronous_request(
	"blockchain.transaction.get", params=None
	).error,
	{"code": -32602, "message": "Missing required params"},
	)

	# Too many params
	for response in (
	self.client.blockchain.transaction.get(1, 2, 3),
	self.client.blockchain.transaction.get(txid=1, verbose=2, blockhash=3),
	):
	assert_equal(
	response.error,
	{"code": -32602, "message": "Expected at most 2 parameters"},
	)
	assert_equal(
	self.client.blockchain.transaction.get_height(1, 2).error,
	{"code": -32602, "message": "Expected at most 1 parameter"},
	)

	# Missing mandatory argument in otherwise valid params
	for response in (
	self.client.synchronous_request("blockchain.transaction.get", params=[]),
	self.client.synchronous_request("blockchain.transaction.get", params={}),
	self.client.synchronous_request(
	"blockchain.transaction.get",
	params={"nottxid": 32 * "ff", "verbose": False},
	),
	self.client.blockchain.transaction.get(verbose=True),
	):
	assert_equal(
	response.error,
	{"code": -32602, "message": "Missing mandatory 'txid' parameter"},
	)

	# Non-string json type for txid
	assert_equal(
	self.client.blockchain.transaction.get(txid=int(32 * "ff", 16)).error,
	{"code": 1, "message": "Invalid tx hash"},
	)

	for response in (
	# non-hex characters
	self.client.blockchain.transaction.get("les sanglots longs"),
	# odd number of hex chars
	self.client.blockchain.transaction.get(GENESIS_CB_TXID[:-1]),
	# valid hex but invalid length for a txid
	self.client.blockchain.transaction.get(GENESIS_CB_TXID[:-2]),
	):
	assert_equal(
	response.error,
	{"code": 1, "message": "Invalid tx hash"},
	)

	# Invalid type for boolean argument
	assert_equal(
	self.client.blockchain.transaction.get(
	txid=32 * "ff", verbose="true"
	).error,
	{
	"code": 1,
	"message": "Invalid verbose argument; expected boolean",
	},
	)

	# Valid txid, but no such transaction was found
	assert_equal(
	self.client.blockchain.transaction.get(txid=32 * "ff").error,
	{
	"code": 1,
	"message": "No transaction matching the requested hash was found",
	},
	)

	def test_transaction_get(self):
	for response in (
	self.client.blockchain.transaction.get(GENESIS_CB_TXID),
	self.client.blockchain.transaction.get(GENESIS_CB_TXID, False),
	self.client.blockchain.transaction.get(txid=GENESIS_CB_TXID),
	self.client.blockchain.transaction.get(txid=GENESIS_CB_TXID, verbose=False),
	):
	assert_equal(response.result, COINBASE_TX_HEX)

	for response in (
	self.client.blockchain.transaction.get(GENESIS_CB_TXID, True),
	self.client.blockchain.transaction.get(txid=GENESIS_CB_TXID, verbose=True),
	):
	assert_equal(
	response.result,
	{
	"blockhash": GENESIS_BLOCK_HASH,
	"blocktime": TIME_GENESIS_BLOCK,
	"confirmations": 201,
	"hash": GENESIS_CB_TXID,
	"hex": COINBASE_TX_HEX,
	"time": 0,
	},
	)

	self.generate(self.wallet, 2)
	assert_equal(
	self.client.blockchain.transaction.get(
	txid=GENESIS_CB_TXID, verbose=True
	).result["confirmations"],
	203,
	)

	def test_transaction_get_height(self):
	response = self.client.blockchain.transaction.get_height(GENESIS_CB_TXID)
	assert_equal(response.result, 0)

	self.wallet.rescan_utxos()
	tx = self.wallet.create_self_transfer()

	response = self.client.blockchain.transaction.broadcast(tx["hex"])
	assert_equal(response.result, tx["txid"])
	self.node.syncwithvalidationinterfacequeue()

	response = self.client.blockchain.transaction.get(tx["txid"])
	assert_equal(response.result, tx["hex"])

	# A mempool transaction has height 0
	response = self.client.blockchain.transaction.get_height(tx["txid"])
	assert_equal(response.result, 0)

	# Mine the tx
	self.generate(self.wallet, 1)
	response = self.client.blockchain.transaction.get_height(tx["txid"])
	assert_equal(response.result, 203)

	response = self.client.blockchain.transaction.get_height(32 * "ff")
	assert_equal(response.error, {"code": -32600, "message": "Unknown txid"})

	def test_transaction_broadcast(self):
	tx_reference = self.wallet.create_self_transfer(target_size=100)
	raw_tx_reference = tx_reference["hex"]

	# broadcasting is allowed as long as the transaction is not mined
	for _ in range(3):
	response = self.client.blockchain.transaction.broadcast(raw_tx_reference)
	assert_equal(response.result, tx_reference["txid"])

	self.generate(self.wallet, 1)
	response = self.client.blockchain.transaction.broadcast(raw_tx_reference)
	assert_equal(
	response.error, {"code": 1, "message": "Transaction already in block chain"}
	)

	# different transaction that spend the same input
	tx_obj = self.wallet.create_self_transfer(target_size=200)["tx"]
	tx_obj.vin[0] = tx_reference["tx"].vin[0]
	response = self.client.blockchain.transaction.broadcast(ToHex(tx_obj))
	assert_equal(
	response.error,
	{"code": 1, "message": "Missing inputs: bad-txns-inputs-missingorspent"},
	)

	tx_obj = FromHex(CTransaction(), raw_tx_reference)
	tx_obj.vin[0].scriptSig = b"aaaaaaaaaaaaaaa"
	response = self.client.blockchain.transaction.broadcast(ToHex(tx_obj))
	assert_equal(
	response.error,
	{
	"code": 1,
	"message": "Transaction rejected by mempool: scriptsig-not-pushonly",
	},
	)

	tx_obj = FromHex(CTransaction(), raw_tx_reference)
	tx_obj.vout[0].scriptPubKey = CScript([OP_RETURN, b"\xff"])
	tx_obj.vout = [tx_obj.vout[0]] * 2
	response = self.client.blockchain.transaction.broadcast(ToHex(tx_obj))
	assert_equal(
	response.error,
	{"code": 1, "message": "Transaction rejected by mempool: multi-op-return"},
	)

	tx_obj = FromHex(CTransaction(), raw_tx_reference)
	tx_obj.vin[0].nSequence = 0xFFFFFFFE
	tx_obj.nLockTime = self.node.getblockcount() + 1
	response = self.client.blockchain.transaction.broadcast(ToHex(tx_obj))
	assert_equal(
	response.error,
	{
	"code": 1,
	"message": "Transaction rejected by mempool: bad-txns-nonfinal, non-final transaction",
	},
	)

	tx_obj = FromHex(CTransaction(), raw_tx_reference)
	tx_obj.vout = []
	response = self.client.blockchain.transaction.broadcast(ToHex(tx_obj))
	assert_equal(
	response.error,
	{
	"code": 1,
	"message": "Transaction rejected by mempool: bad-txns-vout-empty",
	},
	)

	# Non-standard script
	tx_obj.vout.append(CTxOut(0, CScript([OP_TRUE])))
	response = self.client.blockchain.transaction.broadcast(ToHex(tx_obj))
	assert_equal(
	response.error,
	{"code": 1, "message": "Transaction rejected by mempool: scriptpubkey"},
	)

	tx_obj.vout[0] = CTxOut(0, CScript([OP_RETURN, b"\xff"]))
	assert len(ToHex(tx_obj)) // 2 < 100
	response = self.client.blockchain.transaction.broadcast(ToHex(tx_obj))
	assert_equal(
	response.error,
	{
	"code": 1,
	"message": "Transaction rejected by mempool: bad-txns-undersize",
	},
	)

	tx_obj = self.wallet.create_self_transfer(target_size=100_001)["tx"]
	response = self.client.blockchain.transaction.broadcast(ToHex(tx_obj))
	assert_equal(
	response.error,
	{"code": 1, "message": "Transaction rejected by mempool: tx-size"},
	)

	tx_obj = FromHex(CTransaction(), raw_tx_reference)
	tx_obj.vin.append(tx_obj.vin[0])
	response = self.client.blockchain.transaction.broadcast(ToHex(tx_obj))
	assert_equal(
	response.error,
	{
	"code": 1,
	"message": "Transaction rejected by mempool: bad-txns-inputs-duplicate",
	},
	)

	tx_obj.vin = []
	response = self.client.blockchain.transaction.broadcast(ToHex(tx_obj))
	assert_equal(
	response.error,
	{
	"code": 1,
	"message": "Transaction rejected by mempool: bad-txns-vin-empty",
	},
	)

	tx_obj = FromHex(CTransaction(), raw_tx_reference)
	tx_obj.nVersion = 1337
	response = self.client.blockchain.transaction.broadcast(ToHex(tx_obj))
	assert_equal(
	response.error,
	{"code": 1, "message": "Transaction rejected by mempool: version"},
	)

	# Coinbase input in first position
	tx_obj = FromHex(CTransaction(), raw_tx_reference)
	tx_obj.vin[0] = CTxIn(COutPoint(txid=0, n=0xFFFFFFFF))
	response = self.client.blockchain.transaction.broadcast(ToHex(tx_obj))
	assert_equal(
	response.error,
	{"code": 1, "message": "Transaction rejected by mempool: bad-tx-coinbase"},
	)

	# Coinbase input in second position
	tx_obj = FromHex(CTransaction(), raw_tx_reference)
	tx_obj.vin.append(CTxIn(COutPoint(txid=0, n=0xFFFFFFFF)))
	response = self.client.blockchain.transaction.broadcast(ToHex(tx_obj))
	assert_equal(
	response.error,
	{
	"code": 1,
	"message": "Transaction rejected by mempool: bad-txns-prevout-null",
	},
	)

	tx = self.wallet.create_self_transfer(fee_rate=0, fee=0)
	response = self.client.blockchain.transaction.broadcast(tx["hex"])
	assert_equal(
	response.error,
	{
	"code": 1,
	"message": "Transaction rejected by mempool: min relay fee not met, 0 < 100",
	},
	)

	tx = self.wallet.create_self_transfer(fee_rate=10_000_000, fee=0)
	response = self.client.blockchain.transaction.broadcast(tx["hex"])
	assert_equal(
	response.error,
	{
	"code": 1,
	"message": "Fee exceeds maximum configured by user (e.g. -maxtxfee, maxfeerate)",
	},
	)

	# Mine enough blocks to ensure that the following test does not try to spend
	# a utxo already spent in a previous test.
	# Invalidate two blocks, so that miniwallet has access to a coin that
	# will mature in the next block.
	self.generate(self.wallet, 100)
	chain_height = self.node.getblockcount() - 3
	block_to_invalidate = self.node.getblockhash(chain_height + 1)
	self.node.invalidateblock(block_to_invalidate)
	immature_txid = self.nodes[0].getblock(
	self.nodes[0].getblockhash(chain_height - 100 + 2)
	)["tx"][0]
	immature_utxo = self.wallet.get_utxo(txid=immature_txid)
	tx = self.wallet.create_self_transfer(utxo_to_spend=immature_utxo)
	response = self.client.blockchain.transaction.broadcast(tx["hex"])
	assert_equal(
	response.error,
	{
	"code": 1,
	"message": "Transaction rejected by mempool: bad-txns-premature-spend-of-coinbase, tried to spend coinbase at depth 99",
	},
	)

	def test_transaction_get_merkle(self):
	for _ in range(42):
	self.wallet.send_self_transfer(from_node=self.node)
	block_hash = self.generate(self.node, 1)[0]
	block_info = self.node.getblock(block_hash)
	height = block_info["height"]
	txids_hex = block_info["tx"]
	txids = [hex_to_be_bytes(txid) for txid in txids_hex]

	for i in range(len(txids)):
	_root, branch = merkle_root_and_branch(txids, i)
	assert_equal(
	self.client.blockchain.transaction.get_merkle(txids_hex[i]).result,
	{
	"block_height": height,
	"merkle": [h[::-1].hex() for h in branch],
	"pos": i,
	},
	)

	# We can optionally specify the correct block height as 2nd argument
	assert_equal(
	self.client.blockchain.transaction.get_merkle(
	txid=txids_hex[-1], height=height
	).result,
	{
	"block_height": height,
	"merkle": [h[::-1].hex() for h in branch],
	"pos": len(txids) - 1,
	},
	)

	assert_equal(
	self.client.blockchain.transaction.get_merkle(32 * "ff").error,
	{
	"code": 1,
	"message": "No confirmed transaction matching the requested hash was found",
	},
	)

	for wrong_height in (1, height - 1, height + 1, max_int32):
	assert_equal(
	self.client.blockchain.transaction.get_merkle(
	txids_hex[-1], wrong_height
	).error,
	{
	"code": 1,
	"message": f"No transaction matching the requested hash found at height {wrong_height}",
	},
	)

	for invalid_height in (-1, max_int32 + 1, max_int64, max_int64 + 1):
	assert_equal(
	self.client.blockchain.transaction.get_merkle(
	txids_hex[-1], invalid_height
	).error,
	{
	"code": 1,
	"message": "Invalid height argument; expected non-negative numeric value",
	},
	)

	def test_block_header(self):
	block_hashes = [
	self.node.getblockhash(i) for i in range(self.node.getblockcount() + 1)
	]
	block_hashes_bytes = [hex_to_be_bytes(bh) for bh in block_hashes]
	headers = [self.node.getblockheader(bh, False) for bh in block_hashes]
	tip_height = len(headers) - 1

	self.log.info("Testing the blockchain.block.header RPC")
	response = self.client.blockchain.block.header(0)
	assert_equal(response.result, headers[0])

	response = self.client.blockchain.block.header(
	len(block_hashes) // 2, tip_height
	)
	root, branch = merkle_root_and_branch(
	block_hashes_bytes, len(block_hashes) // 2
	)
	assert_equal(
	response.result,
	{
	"branch": [h[::-1].hex() for h in branch],
	"header": headers[len(block_hashes) // 2],
	"root": root[::-1].hex(),
	},
	)

	for bh in ("toto", -1, max_int32 + 1, max_int64, max_int64 + 1):
	for rpc_call in (
	lambda h: self.client.blockchain.block.header(h),
	lambda h: self.client.blockchain.block.headers(start_height=h, count=0),
	):
	assert_equal(
	rpc_call(bh).error,
	{
	"code": 1,
	"message": "Invalid height",
	},
	)

	for cp_height in ("toto", -1, max_int32 + 1, max_int64, max_int64 + 1):
	for rpc_call in (
	lambda h: self.client.blockchain.block.header(0, h),
	lambda h: self.client.blockchain.block.headers(0, 10, h),
	):
	assert_equal(
	rpc_call(cp_height).error,
	{
	"code": 1,
	"message": "Invalid cp_height",
	},
	)

	for bh in (max_int32, tip_height + 1):
	assert_equal(
	self.client.blockchain.block.header(bh).error,
	{
	"code": 1,
	"message": f"Height {bh} is out of range",
	},
	)

	assert_equal(
	self.client.blockchain.block.header(2, 1).error,
	{
	"code": 1,
	"message": f"header height 2 must be <= cp_height 1 which must be <= chain height {tip_height}",
	},
	)

	self.log.info("Testing the blockchain.block.headers RPC")
	# Fulcrum basically just ignores the other parameters when count = 0,
	# unless they reach a much higher limit than tip_height.
	for start_height in (0, 5, max_int32):
	# Note that Fulcrum has a lower hard limit than max int32 start_height
	# before returning a RPC error: Storage::MAX_HEADERS = 100'000'000.
	# So it is a minor difference in behavior to not error in such a case for
	# 100'000'000 < start_height <= 2**31
	count = 0
	assert_equal(
	self.client.blockchain.block.headers(start_height, count).result,
	{"count": 0, "hex": "", "max": 2016},
	)

	for bh in range(0, tip_height + 1):
	assert_equal(
	self.client.blockchain.block.headers(start_height=bh, count=1).result,
	{"count": 1, "hex": headers[bh], "max": 2016},
	)

	start_height = 5
	count = 6
	assert_equal(
	self.client.blockchain.block.headers(start_height, count).result,
	{
	"count": 6,
	"hex": "".join(headers[start_height : start_height + count]),
	"max": 2016,
	},
	)

	cp_height = 21
	root, branch = merkle_root_and_branch(
	block_hashes_bytes[: cp_height + 1], start_height + count - 1
	)
	assert_equal(
	self.client.blockchain.block.headers(start_height, count, cp_height).result,
	{
	"branch": [h[::-1].hex() for h in branch],
	"count": 6,
	"hex": "".join(headers[start_height : start_height + count]),
	"max": 2016,
	"root": root[::-1].hex(),
	},
	)

	# The RPC may return less than {count} headers if the chain is not long enough
	start_height = 4
	for excessive_count in (tip_height - start_height + 2, max_int32):
	response = self.client.blockchain.block.headers(
	start_height, excessive_count
	)
	assert_equal(
	response.result,
	{
	"count": tip_height - start_height + 1,
	"hex": "".join(headers[start_height:]),
	"max": 2016,
	},
	)

	for count in ("toto", -1, max_int32 + 1, max_int64, max_int64 + 1):
	assert_equal(
	self.client.blockchain.block.headers(0, count).error,
	{
	"code": 1,
	"message": "Invalid count",
	},
	)

	for cp_height in (1, 8, tip_height + 1, max_int32):
	assert_equal(
	self.client.blockchain.block.headers(0, 10, cp_height).error,
	{
	"code": 1,
	"message": (
	f"header height + (count - 1) 9 must be <= cp_height {cp_height} "
	f"which must be <= chain height {tip_height}"
	),
	},
	)

	def test_scripthash(self):
	for invalid_scripthash in (31 * "ff", 31 * "ff" + "f", 42, False, "spam"):
	assert_equal(
	self.client.blockchain.scripthash.get_balance(invalid_scripthash).error,
	{
	"code": 1,
	"message": "Invalid scripthash",
	},
	)
	assert_equal(
	self.client.blockchain.scripthash.get_history(invalid_scripthash).error,
	{
	"code": 1,
	"message": "Invalid scripthash",
	},
	)
	assert_equal(
	self.client.blockchain.scripthash.listunspent(invalid_scripthash).error,
	{
	"code": 1,
	"message": "Invalid scripthash",
	},
	)

	# valid hash, but not associated with any known script
	assert_equal(
	self.client.blockchain.scripthash.get_balance(32 * "ff").result,
	{
	"confirmed": 0,
	"unconfirmed": 0,
	},
	)
	assert_equal(
	self.client.blockchain.scripthash.get_history(32 * "ff").result,
	[],
	)
	assert_equal(
	self.client.blockchain.scripthash.listunspent(32 * "ff").result,
	[],
	)

	# Mine a block just to be sure all the utxos are confirmed
	self.generate(self.wallet, 1)
	value = sum(
	[
	utxo["value"]
	for utxo in self.wallet.get_utxos(
	include_immature_coinbase=True, mark_as_spent=False
	)
	]
	)
	scripthash = hex_be_sha256(self.wallet.get_scriptPubKey())
	assert_equal(
	self.client.blockchain.scripthash.get_balance(scripthash).result,
	{
	"confirmed": value * XEC,
	"unconfirmed": 0,
	},
	)

	tx = self.wallet.send_self_transfer(from_node=self.node)
	assert_equal(
	self.client.blockchain.scripthash.get_balance(scripthash).result,
	{"confirmed": value * XEC, "unconfirmed": -tx["fee"] * XEC},
	)

	self.generatetoaddress(self.node, 1, ADDRESS_ECREG_UNSPENDABLE)
	assert_equal(
	self.client.blockchain.scripthash.get_balance(scripthash).result,
	{
	"confirmed": (value - tx["fee"]) * XEC,
	"unconfirmed": 0,
	},
	)

	# Send transactions to a previously unused script
	script = CScript(
	bytes.fromhex("76a91462e907b15cbf27d5425399ebf6f0fb50ebb88f1888ac")
	)
	scripthash = hex_be_sha256(script)
	confirmed = 0
	unconfirmed = 0
	history = []
	utxos = []

	def utxo_sorting_key(utxo):
	return utxo["tx_hash"], utxo["tx_pos"]

	def assert_scripthash_balance_and_history(check_sorting=True):
	assert_equal(
	self.client.blockchain.scripthash.get_balance(scripthash).result,
	{
	"confirmed": confirmed,
	"unconfirmed": unconfirmed,
	},
	)
	actual_history = self.client.blockchain.scripthash.get_history(
	scripthash
	).result
	expected_history = history
	actual_utxos = self.client.blockchain.scripthash.listunspent(
	scripthash
	).result
	expected_utxos = utxos
	if not check_sorting:
	# Enforce any unique arbitrary sorting so we can compare equality
	# between the two lists.
	def sorting_key(hist_item):
	return hist_item["tx_hash"]

	actual_history = sorted(actual_history, key=sorting_key)
	expected_history = sorted(expected_history, key=sorting_key)

	actual_utxos = sorted(actual_utxos, key=utxo_sorting_key)
	expected_utxos = sorted(expected_utxos, key=utxo_sorting_key)
	assert_equal(actual_history, expected_history)
	assert_equal(actual_utxos, expected_utxos)

	assert_scripthash_balance_and_history()

	def add_unconfirmed_transaction(amount: int, fee: int) -> tuple[str, int]:
	nonlocal unconfirmed
	nonlocal history
	nonlocal utxos
	txid, n = self.wallet.send_to(
	from_node=self.node, scriptPubKey=script, amount=amount, fee=fee
	)
	unconfirmed += amount
	history.append({"fee": fee, "height": 0, "tx_hash": txid})
	utxos.append({"height": 0, "tx_hash": txid, "tx_pos": n, "value": amount})
	return txid, n

	for _ in range(4):
	txid, n = add_unconfirmed_transaction(amount=1337, fee=1000)
	assert_scripthash_balance_and_history()

	# Confirm the transaction
	self.generatetoaddress(self.node, 1, ADDRESS_ECREG_UNSPENDABLE)
	confirmed += 1337
	unconfirmed -= 1337
	h = self.node.getblockcount()
	history.pop()
	history.append({"height": h, "tx_hash": txid})
	utxos.pop()
	utxos.append({"height": h, "tx_hash": txid, "tx_pos": n, "value": 1337})
	assert_scripthash_balance_and_history()

	# History with multiple unconfirmed transactions
	for _ in range(3):
	add_unconfirmed_transaction(amount=888, fee=999)
	# We cannot guarantee the sorting of unconfirmed transactions
	assert_scripthash_balance_and_history(check_sorting=False)

	# Test an excessive transaction history
	history_len = len(
	self.client.blockchain.scripthash.get_history(scripthash).result
	)

	self.stop_node(0)

	self.nodes[0].assert_start_raises_init_error(
	extra_args=self.extra_args[0] + ["-chronikelectrummaxhistory=-1"],
	expected_msg="Error: The -chronikelectrummaxhistory value should be withing the range [1, 4294967295].",
	)

	self.nodes[0].assert_start_raises_init_error(
	extra_args=self.extra_args[0] + ["-chronikelectrummaxhistory=0"],
	expected_msg="Error: The -chronikelectrummaxhistory value should be withing the range [1, 4294967295].",
	)

	self.nodes[0].assert_start_raises_init_error(
	extra_args=self.extra_args[0] + ["-chronikelectrummaxhistory=4294967296"],
	expected_msg="Error: The -chronikelectrummaxhistory value should be withing the range [1, 4294967295].",
	)

	self.start_node(
	0,
	extra_args=self.extra_args[0]
	+ [f"-chronikelectrummaxhistory={history_len + 1}"],
	)
	self.client = self.nodes[0].get_chronik_electrum_client()
	# We can add one more transaction
	add_unconfirmed_transaction(amount=777, fee=998)
	assert_scripthash_balance_and_history(check_sorting=False)

	# The next transaction makes the tx history too long.
	add_unconfirmed_transaction(amount=777, fee=998)
	msg = f"transaction history for scripthash {scripthash} exceeds limit ({history_len + 1})"
	assert_equal(
	self.client.blockchain.scripthash.get_history(scripthash).error,
	{
	"code": 1,
	"message": msg,
	},
	)
	# We compute the balance on demand, so this RPC is also limited by the max
	# history parameter.
	assert_equal(
	self.client.blockchain.scripthash.get_balance(scripthash).error,
	{
	"code": 1,
	"message": msg,
	},
	)
	# But the listunspent RPC is unaffected.
	assert_equal(
	sorted(
	self.client.blockchain.scripthash.listunspent(scripthash).result,
	key=utxo_sorting_key,
	),
	sorted(utxos, key=utxo_sorting_key),
	)

	def test_headers_subscribe(self):
	self.log.info("Test the blockchain.headers.subscribe endpoint")

	def new_header():
	tip = self.generate(self.node, 1)[0]
	height = self.node.getblockcount()
	header_hex = self.node.getblockheader(tip, verbose=False)
	return height, header_hex

	(height, header_hex) = new_header()

	sub_message = self.client.blockchain.headers.subscribe()
	assert_equal(
	sub_message.result,
	{
	"height": height,
	"hex": header_hex,
	},
	)

	# Subscribing again is a no-op and returns the same result
	for _ in range(3):
	sub_message = self.client.blockchain.headers.subscribe()
	assert_equal(
	sub_message.result,
	{
	"height": height,
	"hex": header_hex,
	},
	)

	def check_notification(clients, height, header_hex):
	for client in clients:
	notification = client.wait_for_notification(
	"blockchain.headers.subscribe"
	- )
	+ )[0]
	assert_equal(notification["height"], height)
	assert_equal(notification["hex"], header_hex)

	# Mine a block and check we get the message we subscribed for
	(height, header_hex) = new_header()
	check_notification([self.client], height, header_hex)

	# Let's add more clients
	client2 = self.node.get_chronik_electrum_client()
	sub_message = client2.blockchain.headers.subscribe()
	assert_equal(
	sub_message.result,
	{
	"height": height,
	"hex": header_hex,
	},
	)

	# At this stage both self.client and client2 will receive header
	# notifications
	(height, header_hex) = new_header()
	check_notification([self.client, client2], height, header_hex)

	client3 = self.node.get_chronik_electrum_client()
	sub_message = client3.blockchain.headers.subscribe()
	assert_equal(
	sub_message.result,
	{
	"height": height,
	"hex": header_hex,
	},
	)

	# At this stage self.client, client2 and client3 will receive header
	# notifications
	(height, header_hex) = new_header()
	check_notification([self.client, client2, client3], height, header_hex)

	# Unsubscribe client2
	unsub_message = client2.blockchain.headers.unsubscribe()
	assert_equal(unsub_message.result, True)

	# From now on client2 won't receive the header notifications anymore
	(height, header_hex) = new_header()
	check_notification([self.client, client3], height, header_hex)

	try:
	client2.wait_for_notification("blockchain.headers.subscribe", timeout=1)
	assert False, "Received an unexpected header notification"
	except TimeoutError:
	pass

	# Unsubscribing more is a no-op and returns False
	for _ in range(3):
	unsub_message = client2.blockchain.headers.unsubscribe()
	assert_equal(unsub_message.result, False)


	if __name__ == "__main__":
	ChronikElectrumBlockchain().main()
	diff --git a/test/functional/test_framework/jsonrpctools.py b/test/functional/test_framework/jsonrpctools.py
	index 8b018deaa..6ddd115bb 100644
	--- a/test/functional/test_framework/jsonrpctools.py
	+++ b/test/functional/test_framework/jsonrpctools.py
	@@ -1,167 +1,167 @@
	# Copyright (c) 2024-present The Bitcoin developers
	# Distributed under the MIT software license, see the accompanying
	# file COPYING or http://www.opensource.org/licenses/mit-license.php.
	from __future__ import annotations

	import json
	import socket
	from typing import Any, Optional

	-from .util import assert_equal
	+from .util import assert_equal, assert_greater_than


	class OversizedResponseError(Exception):
	pass


	class JsonRpcResponse:
	def __init__(
	self,
	id_: Optional[int],
	result: Optional[Any] = None,
	error: Optional[dict] = None,
	):
	self.id = id_
	self.result = result
	self.error = error

	def __str__(self):
	return (
	f"JsonRpcResponse(id={self.id}, result={self.result}, error={self.error})"
	)


	class MethodNameProxy:
	"""Recursive proxy. The final proxy in the chain is the one doing the RPC call"""

	def __init__(self, client: ChronikElectrumClient, name: str, parent_name: str = ""):
	self.client = client
	self.parent_name = parent_name
	self.name = name

	def __getattr__(self, item) -> MethodNameProxy:
	if self.parent_name:
	parent_name = f"{self.parent_name}.{self.name}"
	else:
	parent_name = self.name
	return MethodNameProxy(self.client, item, parent_name)

	def __call__(self, args, *kwargs) -> JsonRpcResponse:
	method = f"{self.parent_name}.{self.name}" if self.parent_name else self.name
	params: Optional[list[Any] \| dict[str, Any]]
	if not kwargs and not args:
	params = None
	elif not kwargs:
	# all positional params. Make it a list, as json doesn't support tuples
	params = list(args)
	elif not args:
	# all named params
	params = kwargs
	else:
	raise RuntimeError("Params must be all positional or all named arguments")
	return self.client.synchronous_request(method, params)


	class ChronikElectrumClient:
	"""JSONRPC client.

	>>> client = ChronikElectrumClient("127.0.0.1", 500001)
	>>> client.blockchain.transaction.get_height("3fbe7aebbe4210d667c2eb96d7efa5b43bb3d7a4c00dc08c16ad4e4ce4d2ea9b")
	JsonRpcResponse(id=0, result=875001, error=None)
	>>> client.spam.foo.bar()
	JsonRpcResponse(id=0, result=None, error={'code': -32601, 'message': 'Method not found'})
	"""

	DEFAULT_TIMEOUT = 30
	MAX_DATA_SIZE = 10_000_000

	def __init__(self, host: str, port: int, timeout=DEFAULT_TIMEOUT) -> None:
	self.host = host
	self.port = port
	self.timeout = timeout

	self.id = -1
	# Data buffer. Messages are separated by \n but we might have several in
	# a single frame so we keep track of the remaining in order to properly
	# rebuild the messages.
	self.data = b""

	self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
	self.sock.settimeout(timeout)
	self.sock.connect((host, port))

	def __getattr__(self, item):
	"""Build a recursive proxy. For instance if the caller calls
	client.blockchain.transaction.get(txid), it will create a
	MethodNameProxy(name="blockchain") which will in turn create a
	MethodNameProxy(name="transaction", parent_name="blockchain") which will
	create a MethodNameProxy(name="get", parent_name="blockchain.transaction").
	That last level of proxy will then execute the jsonrpc call with
	method blockchain.transaction.get and params [txid].
	"""
	return MethodNameProxy(self, item)

	def _recv(self):
	# We need the initial check because self.data might already contain
	# the messages and we don't want to block on sock.recv() in this case
	while b"\n" not in self.data:
	self.data += self.sock.recv(1024)

	# Break early, we will check the length of the message
	if b"\n" in self.data:
	break

	# There is no \n, we don't allow for more data than the max size.
	# This is also an exit condition to avoid looping indefinitely if
	# there is no \n
	if len(self.data) > self.MAX_DATA_SIZE:
	raise OversizedResponseError()

	# We might have several messages, but only return the first one
	(message, self.data) = self.data.split(b"\n", maxsplit=1)

	# Account for the trailing \n that we just removed as 1 byte
	if len(message) + 1 > self.MAX_DATA_SIZE:
	raise OversizedResponseError()

	return json.loads(message.decode("utf-8"))

	def synchronous_request(
	self, method: str, params: Optional[list \| dict]
	) -> JsonRpcResponse:
	self.id += 1
	request = {"jsonrpc": "2.0", "method": method, "id": self.id}
	if params is not None:
	request["params"] = params
	self.sock.send(json.dumps(request).encode("utf-8") + b"\n")

	json_reply = self._recv()

	# As per the JSONRPC spec, we cannot have both an error and a result
	assert "error" not in json_reply or "result" not in json_reply
	assert_equal(json_reply.get("id"), self.id)
	return JsonRpcResponse(
	json_reply.get("id"), json_reply.get("result"), json_reply.get("error")
	)

	def wait_for_notification(self, method: str, timeout=None):
	prev_timeout = self.sock.gettimeout()
	# If set, timeout should override the current socket timeout. We make
	# sure to restore the previous valus after the message is received
	self.sock.settimeout(timeout or prev_timeout)

	json_reply = self._recv()

	self.sock.settimeout(prev_timeout)

	# A notification can't be an error
	assert "error" not in json_reply
	# A notification has no id but a method field
	assert "id" not in json_reply
	assert_equal(json_reply.get("method"), method)
	assert "params" in json_reply
	- assert_equal(len(json_reply["params"]), 1)
	+ assert_greater_than(len(json_reply["params"]), 0)

	# The "result" is within a "params" field. There is no point returning
	# a JsonRpcResponse here as we only care about the result
	- return json_reply["params"][0]
	+ return json_reply["params"]

File Metadata

Mime Type: text/x-diff
Expires: Thu, May 22, 01:16 (19 h, 46 m)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 5864456
Default Alt Text: (41 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions