From 96bc89b85e3df7d83af0cff5a1179e5250fc2ef8 Mon Sep 17 00:00:00 2001 From: Yudis-bit Date: Sat, 14 Nov 2026 00:27:24 +0700 Subject: [PATCH] descriptor: reject uncompressed keys in tr() (closes #180) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit BIP 386 requires all key expressions under tr() to produce x-only public keys. Uncompressed public keys and uncompressed WIF private keys under tr()—whether parsed from strings or constructed directly via Descriptor(..., taproot=True)—are refused with DescriptorError. Signed-off-by: Yudis-bit --- src/embit/descriptor/descriptor.py | 3 +++ tests/tests/test_descriptor.py | 35 +++++++++++++++++++++++++++++- 2 files changed, 37 insertions(+), 1 deletion(-) diff --git a/src/embit/descriptor/descriptor.py b/src/embit/descriptor/descriptor.py index fd3c3057..2e000cd0 100644 --- a/src/embit/descriptor/descriptor.py +++ b/src/embit/descriptor/descriptor.py @@ -46,6 +46,9 @@ def __init__( # make sure all keys are either taproot or not for k in self.keys: k.taproot = taproot + # BIP-386: uncompressed keys are not allowed in tr() + if self.taproot and not getattr(k.key, "compressed", True): + raise DescriptorError("Uncompressed keys are not allowed in tr()") @property def script_len(self): diff --git a/tests/tests/test_descriptor.py b/tests/tests/test_descriptor.py index 2101227b..831fdd22 100644 --- a/tests/tests/test_descriptor.py +++ b/tests/tests/test_descriptor.py @@ -1,5 +1,5 @@ from unittest import TestCase -from binascii import hexlify +from binascii import hexlify, unhexlify from embit.descriptor import Descriptor, Key from embit.descriptor.arguments import KeyHash, Number from embit.descriptor.miniscript import OPERATORS, WRAPPERS @@ -248,6 +248,39 @@ def test_descriptor_from_string_validation(self): with self.assertRaises(DescriptorError): Descriptor.from_string(d) + def test_tr_uncompressed_key(self): + U = ( + "04c6047f9441ed7d6d3045406e95c07cd85c778e4b8cef3ca7abac09b95c709ee51ae" + "168fea63dc339a3c58419466ceaeef7f632653266d0e1236431a950cfe52a" + ) + UWIF = "5HpjE2Hs7vjU4SN3YyPQCdhzCu92WoEeuE6PWNuiPyTu3ESGnzn" + C = "0279be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798" + X = "79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798" + # BIP 386: uncompressed keys are not allowed in tr() + for d in [ + "tr(%s)" % U, + "tr(%s)" % UWIF, + "tr(%s,pk(%s))" % (C, U), + "tr(%s,multi_a(1,%s))" % (C, U), + "tr(%s,{pk(%s),pk(%s)})" % (C, C, U), + "tr(%s,{pk(%s),{pk(%s),multi_a(1,%s)}})" % (C, C, C, U), + ]: + self.assertRaises(DescriptorError, Descriptor.from_string, d) + + # direct construction with uncompressed key must also fail + ukey = Key(ec.PublicKey.parse(unhexlify(U))) + self.assertRaises(DescriptorError, Descriptor, key=ukey, taproot=True) + + # compressed and x-only keys are valid + for d in [ + "tr(%s)" % C, + "tr(%s)" % X, + "tr(%s,pk(%s))" % (C, C), + "tr(%s,multi_a(1,%s))" % (C, C), + "tr(%s,{pk(%s),pk(%s)})" % (C, C, X), + ]: + Descriptor.from_string(d) + def test_keys(self): keys = [ "[f45912ab/44h/12/32h]xpub6F6wWxm8F64iBHNhyaoh3QKCuuMUY5pfPPr1H1WuZXUXeXtZ21qjFN5ykaqnLL1jtPEFB9d94CyZrcYWKVdSiJKQ6mLGEB5sfrGFBpg6wgA",