From bdb8b9a347e68f80a2e8d44ce5590a2e8214b6bb Mon Sep 17 00:00:00 2001 From: Sebastian Falbesoner Date: Thu, 17 Jun 2021 17:43:02 +0200 Subject: [PATCH] test: doc: improve doc for `from_hex` helper (mention `to_hex` alternative) --- test/functional/test_framework/messages.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/test/functional/test_framework/messages.py b/test/functional/test_framework/messages.py index a0e1a6bc127..504c8c70d43 100755 --- a/test/functional/test_framework/messages.py +++ b/test/functional/test_framework/messages.py @@ -190,8 +190,12 @@ def ser_string_vector(l): return r -# Deserialize from a hex string representation (eg from RPC) def from_hex(obj, hex_string): + """Deserialize from a hex string representation (e.g. from RPC) + + Note that there is no complementary helper like e.g. `to_hex` for the + inverse operation. To serialize a message object to a hex string, simply + use obj.serialize().hex()""" obj.deserialize(BytesIO(hex_str_to_bytes(hex_string))) return obj