diff --git a/CHANGELOG.md b/CHANGELOG.md index 9b11788d..9101d0bc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [Unreleased] + +### Fixed + +- `tr()` accepted tapscript leaves that are not valid miniscript, such as + `and_v(pk(A),1)`. A leaf is now type-checked and must be of type `B`, as a + `wsh()` script is. +- `tr()` accepted leaves that Bitcoin Core rejects as not sane: a leaf that a + witness without a signature satisfies, such as `older(10)`, and a leaf that + repeats a key. These, and leaves that are not valid miniscript, used to load + and now raise `DescriptorError`. `TapLeaf` also refuses a miniscript parsed + without `taproot=True`. + ## [0.8.2] - 2026-08-08 ### Changed diff --git a/src/embit/descriptor/miniscript.py b/src/embit/descriptor/miniscript.py index 9783afc1..e5aa03cc 100644 --- a/src/embit/descriptor/miniscript.py +++ b/src/embit/descriptor/miniscript.py @@ -71,7 +71,8 @@ def wrapped(m_script): wrappers, op = op.split(":") # handle boolean literals: 0 or 1 if op in ("0", "1"): - miniscript = JustOne() if op == "1" else JustZero() + literal = JustOne if op == "1" else JustZero + miniscript = literal(taproot=taproot) return wrapped(miniscript) if char != b"(": raise MiniscriptError("Missing operator") @@ -130,7 +131,7 @@ def len_args(self): class JustZero(Miniscript): TYPE = "B" - PROPS = "zud" + PROPS = "zuds" def inner_compile(self): return Number(0).compile() @@ -168,7 +169,7 @@ class PkK(OneArg): NAME = "pk_k" ARGCLS = Key TYPE = "K" - PROPS = "ondu" + PROPS = "ondus" def inner_compile(self): return self.carg @@ -182,7 +183,7 @@ class PkH(OneArg): NAME = "pk_h" ARGCLS = KeyHash TYPE = "K" - PROPS = "ndu" + PROPS = "ndus" def inner_compile(self): return b"\x76\xa9" + self.carg + b"\x88" @@ -285,7 +286,7 @@ def verify(self): @property def properties(self): - # props: z=zXzYzZ; o=zXoYoZ or oXzYzZ; u=uYuZ; d=dZ + # props: z=zXzYzZ; o=zXoYoZ or oXzYzZ; u=uYuZ; d=dZ; s=sZ(sX or sY) props = "" px, py, pz = [arg.properties for arg in self.args] if "z" in px and "z" in py and "z" in pz: @@ -298,6 +299,8 @@ def properties(self): props += "u" if "d" in pz: props += "d" + if "s" in pz and ("s" in px or "s" in py): + props += "s" return props def inner_compile(self): @@ -341,7 +344,7 @@ def type(self): @property def properties(self): - # z=zXzY; o=zXoY or zYoX; n=nX or zXnY; u=uY + # z=zXzY; o=zXoY or zYoX; n=nX or zXnY; u=uY; s=sX or sY px, py = [arg.properties for arg in self.args] props = "" if "z" in px and "z" in py: @@ -352,6 +355,8 @@ def properties(self): props += "n" if "u" in py: props += "u" + if "s" in px or "s" in py: + props += "s" return props @@ -378,7 +383,7 @@ def verify(self): @property def properties(self): - # z=zXzY; o=zXoY or zYoX; n=nX or zXnY; d=dXdY; u + # z=zXzY; o=zXoY or zYoX; n=nX or zXnY; d=dXdY; u; s=sX or sY px, py = [arg.properties for arg in self.args] props = "" if "z" in px and "z" in py: @@ -390,6 +395,8 @@ def properties(self): if "d" in px and "d" in py: props += "d" props += "u" + if "s" in px or "s" in py: + props += "s" return props @@ -431,10 +438,10 @@ def verify(self): @property def properties(self): - # props: z=zXzYzZ; o=zXoYoZ or oXzYzZ; u=uYuZ; d=dZ + # props: z=zXzYzZ; o=zXoYoZ or oXzYzZ; u=uYuZ; d=dZ; s=sZ(sX or sY) props = "" px, py = [arg.properties for arg in self.args] - pz = "zud" + pz = "zuds" if "z" in px and "z" in py and "z" in pz: props += "z" if ("z" in px and "o" in py and "o" in pz) or ( @@ -445,6 +452,8 @@ def properties(self): props += "u" if "d" in pz: props += "d" + if "s" in pz and ("s" in px or "s" in py): + props += "s" return props @@ -475,7 +484,7 @@ def verify(self): @property def properties(self): - # z=zXzZ; o=zXoZ or zZoX; d; u + # z=zXzZ; o=zXoZ or zZoX; d; u; s=sXsZ props = "" px, pz = [arg.properties for arg in self.args] if "z" in px and "z" in pz: @@ -483,6 +492,8 @@ def properties(self): if ("z" in px and "o" in pz) or ("z" in pz and "o" in px): props += "o" props += "du" + if "s" in px and "s" in pz: + props += "s" return props @@ -512,13 +523,15 @@ def verify(self): @property def properties(self): - # z=zXzZ; o=oXzZ + # z=zXzZ; o=oXzZ; s=sXsZ props = "" px, pz = [arg.properties for arg in self.args] if "z" in px and "z" in pz: props += "z" if "o" in px and "z" in pz: props += "o" + if "s" in px and "s" in pz: + props += "s" return props @@ -548,7 +561,7 @@ def verify(self): @property def properties(self): - # z=zXzZ; o=oXzZ; d=dZ; u=uZ + # z=zXzZ; o=oXzZ; d=dZ; u=uZ; s=sXsZ props = "" px, pz = [arg.properties for arg in self.args] if "z" in px and "z" in pz: @@ -559,6 +572,8 @@ def properties(self): props += "d" if "u" in pz: props += "u" + if "s" in px and "s" in pz: + props += "s" return props @@ -594,7 +609,7 @@ def type(self): @property def properties(self): - # o=zXzZ; u=uXuZ; d=dX or dZ + # o=zXzZ; u=uXuZ; d=dX or dZ; s=sXsZ props = "" px, pz = [arg.properties for arg in self.args] if "z" in px and "z" in pz: @@ -603,6 +618,8 @@ def properties(self): props += "u" if "d" in px or "d" in pz: props += "d" + if "s" in px and "s" in pz: + props += "s" return props @@ -646,7 +663,7 @@ def verify(self): @property def properties(self): - # z=all are z; o=all are z except one is o; d; u + # z=all are z; o=all are z except one is o; d; u; s=at least n-k+1 are s props = "" parr = [arg.properties for arg in self.args[1:]] zarr = ["z" for p in parr if "z" in p] @@ -656,6 +673,8 @@ def properties(self): if len(noz) == 1 and "o" in noz[0]: props += "o" props += "du" + if len([p for p in parr if "s" in p]) >= len(parr) - self.args[0].num + 1: + props += "s" return props @@ -665,7 +684,7 @@ class Multi(Miniscript): NARGS = None ARGCLS = (Number, Key) TYPE = "B" - PROPS = "ndu" + PROPS = "ndus" _expected_taproot = False def __init__(self, *args, **kwargs): @@ -744,7 +763,7 @@ class Pk(OneArg): NAME = "pk" ARGCLS = Key TYPE = "B" - PROPS = "ondu" + PROPS = "ondus" def inner_compile(self): return self.carg + b"\xac" @@ -758,7 +777,7 @@ class Pkh(OneArg): NAME = "pkh" ARGCLS = KeyHash TYPE = "B" - PROPS = "ndu" + PROPS = "ndus" def inner_compile(self): return b"\x76\xa9" + self.carg + b"\x88\xac" @@ -835,6 +854,8 @@ def properties(self): props += "d" if "u" in px: props += "u" + if "s" in px: + props += "s" return props @@ -863,6 +884,8 @@ def properties(self): props += "d" if "u" in px: props += "u" + if "s" in px: + props += "s" return props @@ -888,7 +911,7 @@ def properties(self): for p in ["o", "n", "d"]: if p in px: props += p - props += "u" + props += "us" return props @@ -921,6 +944,8 @@ def properties(self): props += "n" if "u" in py: props += "u" + if "s" in px: + props += "s" return props @@ -951,6 +976,8 @@ def properties(self): px = self.arg.properties if "z" in px: props += "o" + if "s" in px: + props += "s" return props @@ -973,7 +1000,7 @@ def verify(self): def properties(self): props = "" px = self.arg.properties - for p in ["z", "o", "n"]: + for p in ["z", "o", "n", "s"]: if p in px: props += p return props @@ -997,7 +1024,7 @@ def verify(self): def properties(self): props = "nd" px = self.arg.properties - for p in ["o", "u"]: + for p in ["o", "u", "s"]: if p in px: props += p return props @@ -1022,7 +1049,7 @@ def verify(self): def properties(self): props = "u" px = self.arg.properties - for p in ["z", "o", "n", "d"]: + for p in ["z", "o", "n", "d", "s"]: if p in px: props += p return props @@ -1046,13 +1073,15 @@ def verify(self): @property def properties(self): - # o=zXzZ; u=uXuZ; d=dX or dZ + # o=zXzZ; u=uXuZ; d=dX or dZ; s=sXsZ props = "d" pz = self.arg.properties if "z" in pz: props += "o" if "u" in pz: props += "u" + if "s" in pz: + props += "s" return props diff --git a/src/embit/descriptor/taptree.py b/src/embit/descriptor/taptree.py index 7f611e5e..5a688cb7 100644 --- a/src/embit/descriptor/taptree.py +++ b/src/embit/descriptor/taptree.py @@ -1,12 +1,30 @@ -from .errors import MiniscriptError +from .errors import DescriptorError, MiniscriptError from .base import DescriptorBase -from .miniscript import Miniscript +from .miniscript import Miniscript, Multi from ..hashes import tagged_hash from ..script import Script +def _key_id(key): + # Bitcoin Core compares keys at index 0 of their first branch + if key.can_derive: + key = key.derive(0) + pub = key.get_public_key() + # pkh() also takes a bare hash + return pub if isinstance(pub, str) else pub.sec() + + class TapLeaf(DescriptorBase): def __init__(self, miniscript=None, version=0xC0): + if miniscript is not None: + if not miniscript.taproot: + raise DescriptorError("Tapscript leaf should use taproot miniscript") + # will raise if can't verify + miniscript.verify() + if miniscript.type != "B": + raise DescriptorError("Top level miniscript should be 'B'") + if "s" not in miniscript.properties: + raise DescriptorError("Tapscript leaf is spendable without a signature") self.miniscript = miniscript self.version = version @@ -16,7 +34,15 @@ def __str__(self): @classmethod def read_from(cls, s): ms = Miniscript.read_from(s, taproot=True) - return cls(ms) + leaf = cls(ms) + # Only when parsing, as in Core: keys that differ at index 0 can be + # equal at another index. Core parses a whole-leaf multi_a() apart, + # without this check. + if not isinstance(ms, Multi): + ids = [_key_id(k) for k in ms.keys] + if len(set(ids)) != len(ids): + raise DescriptorError("Tapscript leaf has duplicate keys") + return leaf def serialize(self): if self.miniscript is None: diff --git a/tests/tests/test_taptree.py b/tests/tests/test_taptree.py index 56645db7..d3412dd0 100644 --- a/tests/tests/test_taptree.py +++ b/tests/tests/test_taptree.py @@ -1,7 +1,9 @@ from unittest import TestCase from embit.descriptor import Descriptor from embit.networks import NETWORKS -from embit.descriptor.errors import MiniscriptError +from embit.descriptor.errors import DescriptorError, MiniscriptError +from embit.descriptor.miniscript import Miniscript +from embit.descriptor.taptree import TapLeaf NETWORK = NETWORKS["test"] @@ -144,3 +146,96 @@ def test_multi_variants(self): Descriptor.from_string("wsh(sortedmulti(1,%s,%s,%s))" % keys) Descriptor.from_string("tr(%s,multi_a(1,%s,%s))" % keys) Descriptor.from_string("tr(%s,sortedmulti_a(1,%s,%s))" % keys) + + def test_leaf_miniscript_is_type_checked(self): + """Tapscript leaves go through the same type rules as wsh scripts""" + root, a, b = PUBKEYS[:3] + invalid = [ + # and_v needs a V as its first argument + "and_v(pk(%s),1)" % a, + # a leaf must be a B + "v:pk(%s)" % a, + ] + for leaf in invalid: + for tree in (leaf, "{%s,pk(%s)}" % (leaf, b), "{pk(%s),%s}" % (b, leaf)): + with self.assertRaises(DescriptorError): + Descriptor.from_string("tr(%s,%s)" % (root, tree)) + # a leaf that is not a B raises the same error as a wsh script + for desc in ("wsh(v:pk(%s))" % a, "tr(%s,v:pk(%s))" % (root, a)): + with self.assertRaises(DescriptorError) as exc: + Descriptor.from_string(desc) + self.assertIs(type(exc.exception), DescriptorError) + # a leaf built in code is checked too + with self.assertRaises(MiniscriptError): + TapLeaf(Miniscript.from_string("and_v(pk(%s),1)" % a, taproot=True)) + TapLeaf(None) + valid = [ + "pk(%s)" % a, + "multi_a(2,%s,%s)" % (a, b), + "and_v(v:pk(%s),older(10))" % a, + # d: is u in tapscript, so dv:older(10) is allowed as a condition + "andor(dv:older(10),pk(%s),pk(%s))" % (a, b), + "and_n(pk(%s),pk(%s))" % (a, b), + ] + for leaf in valid: + desc = Descriptor.from_string("tr(%s,%s)" % (root, leaf)) + self.assertEqual(str(desc), "tr(%s,%s)" % (root, leaf)) + + def test_leaf_needs_signature(self): + """A leaf some witness satisfies without a signature is rejected, as in Core""" + root, a, b = PUBKEYS[:3] + h = "00" * 32 + invalid = [ + "1", + "older(10)", + "sha256(%s)" % h, + "or_d(pk(%s),older(10))" % a, + "or_i(pk(%s),sha256(%s))" % (a, h), + "andor(pk(%s),older(10),sha256(%s))" % (a, h), + "thresh(1,pk(%s),sln:older(10))" % a, + ] + for leaf in invalid: + for tree in (leaf, "{%s,pk(%s)}" % (leaf, b)): + with self.assertRaises(DescriptorError): + Descriptor.from_string("tr(%s,%s)" % (root, tree)) + valid = [ + "and_v(v:pk(%s),older(10))" % a, + "andor(pk(%s),older(10),pk(%s))" % (a, b), + "or_d(pk(%s),and_v(v:pk(%s),older(10)))" % (a, b), + "thresh(2,pk(%s),s:pk(%s),sln:older(10))" % (a, b), + ] + for leaf in valid: + Descriptor.from_string("tr(%s,%s)" % (root, leaf)) + + def test_leaf_keys_are_distinct(self): + """A leaf that repeats a key is rejected, as in Core""" + root, a, b = PUBKEYS[:3] + xpub = TPUBS[0] + invalid = [ + "and_v(v:pk(%s),pk(%s))" % (a, a), + "and_v(v:pk(%s),multi_a(1,%s,%s))" % (a, b, a), + # Core compares keys at index 0 of their first branch + "and_v(v:pk(%s/<0;1>/*),pk(%s/0/*))" % (xpub, xpub), + ] + for leaf in invalid: + with self.assertRaises(DescriptorError): + Descriptor.from_string("tr(%s,%s)" % (root, leaf)) + valid = [ + "and_v(v:pk(%s/0/*),pk(%s/1/*))" % (xpub, xpub), + # a key may repeat across leaves and in the internal key + "{pk(%s),pk(%s)}" % (a, a), + "pk(%s)" % root, + # Core parses a whole-leaf multi_a() apart and does not check it + "multi_a(1,%s,%s)" % (a, a), + ] + for leaf in valid: + Descriptor.from_string("tr(%s,%s)" % (root, leaf)) + + def test_leaf_needs_taproot_miniscript(self): + """A leaf built in code must use tapscript rules""" + a, b = PUBKEYS[:2] + for ms in ("multi(1,%s,%s)" % (a, b), "pk(%s)" % a): + with self.assertRaises(DescriptorError): + TapLeaf(Miniscript.from_string(ms)) + TapLeaf(Miniscript.from_string("pk(%s)" % a, taproot=True)) + self.assertTrue(Miniscript.from_string("1", taproot=True).taproot)