Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
73 changes: 51 additions & 22 deletions src/embit/descriptor/miniscript.py
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down Expand Up @@ -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()
Expand Down Expand Up @@ -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
Expand All @@ -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"
Expand Down Expand Up @@ -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:
Expand All @@ -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):
Expand Down Expand Up @@ -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:
Expand All @@ -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


Expand All @@ -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:
Expand All @@ -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


Expand Down Expand Up @@ -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 (
Expand All @@ -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


Expand Down Expand Up @@ -475,14 +484,16 @@ 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:
props += "z"
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


Expand Down Expand Up @@ -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


Expand Down Expand Up @@ -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:
Expand All @@ -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


Expand Down Expand Up @@ -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:
Expand All @@ -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


Expand Down Expand Up @@ -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]
Expand All @@ -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


Expand All @@ -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):
Expand Down Expand Up @@ -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"
Expand All @@ -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"
Expand Down Expand Up @@ -835,6 +854,8 @@ def properties(self):
props += "d"
if "u" in px:
props += "u"
if "s" in px:
props += "s"
return props


Expand Down Expand Up @@ -863,6 +884,8 @@ def properties(self):
props += "d"
if "u" in px:
props += "u"
if "s" in px:
props += "s"
return props


Expand All @@ -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


Expand Down Expand Up @@ -921,6 +944,8 @@ def properties(self):
props += "n"
if "u" in py:
props += "u"
if "s" in px:
props += "s"
return props


Expand Down Expand Up @@ -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


Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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


Expand Down
32 changes: 29 additions & 3 deletions src/embit/descriptor/taptree.py
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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:
Expand Down
Loading
Loading