1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
|
from binascii import hexlify, unhexlify
from .base import DescriptorBase
from .errors import ArgumentError
from .. import bip32, ec, compact, hashes
from ..bip32 import HARDENED_INDEX
from ..misc import read_until
class KeyOrigin:
def __init__(self, fingerprint: bytes, derivation: list):
self.fingerprint = fingerprint
self.derivation = derivation
@classmethod
def from_string(cls, s: str):
arr = s.split("/")
mfp = unhexlify(arr[0])
assert len(mfp) == 4
arr[0] = "m"
path = "/".join(arr)
derivation = bip32.parse_path(path)
return cls(mfp, derivation)
def __str__(self):
return bip32.path_to_str(self.derivation, fingerprint=self.fingerprint)
class AllowedDerivation(DescriptorBase):
# xpub/<0;1>/* - <0;1> is a set of allowed branches, wildcard * is stored as None
def __init__(self, indexes=[[0, 1], None]):
# check only one wildcard
if (
len(
[i for i in indexes if i is None or (isinstance(i, list) and None in i)]
)
> 1
):
raise ArgumentError("Only one wildcard is allowed")
# check only one set is in the derivation
if len([i for i in indexes if isinstance(i, list)]) > 1:
raise ArgumentError("Only one set of branches is allowed")
self.indexes = indexes
@property
def is_wildcard(self):
return None in self.indexes
def fill(self, idx, branch_index=None):
# None is ok
if idx is not None and (idx < 0 or idx >= HARDENED_INDEX):
raise ArgumentError("Hardened indexes are not allowed in wildcard")
arr = [i for i in self.indexes]
for i, el in enumerate(arr):
if el is None:
arr[i] = idx
if isinstance(el, list):
if branch_index is None:
arr[i] = el[0]
else:
if branch_index < 0 or branch_index >= len(el):
raise ArgumentError("Invalid branch index")
arr[i] = el[branch_index]
return arr
def branch(self, branch_index):
arr = self.fill(None, branch_index)
return type(self)(arr)
def check_derivation(self, derivation: list):
if len(derivation) != len(self.indexes):
return None
branch_idx = 0 # default branch if no branches in descriptor
idx = None
for i, el in enumerate(self.indexes):
der = derivation[i]
if isinstance(el, int):
if el != der:
return None
# branch
elif isinstance(el, list):
if der not in el:
return None
branch_idx = el.index(der)
# wildcard
elif el is None:
idx = der
# shouldn't happen
else:
raise ArgumentError("Strange derivation index...")
if branch_idx is not None and idx is not None:
return idx, branch_idx
@classmethod
def default(cls):
return AllowedDerivation([[0, 1], None])
@property
def branches(self):
for el in self.indexes:
if isinstance(el, list):
return el
return None
@property
def has_hardend(self):
for idx in self.indexes:
if isinstance(idx, int) and idx >= HARDENED_INDEX:
return True
if (
isinstance(idx, list)
and len([i for i in idx if i >= HARDENED_INDEX]) > 0
):
return True
return False
@classmethod
def from_string(cls, der: str, allow_hardened=False, allow_set=True):
if len(der) == 0:
return None
indexes = [
cls.parse_element(d, allow_hardened, allow_set) for d in der.split("/")
]
return cls(indexes)
@classmethod
def parse_element(cls, d: str, allow_hardened=False, allow_set=True):
# wildcard
if d == "*":
return None
# branch set - legacy `{m,n}`
if d[0] == "{" and d[-1] == "}":
if not allow_set:
raise ArgumentError("Set is not allowed in derivation %s" % d)
return [
cls.parse_element(dd, allow_hardened, allow_set=False)
for dd in d[1:-1].split(",")
]
# branch set - multipart `<m;n>`
if d[0] == "<" and d[-1] == ">":
if not allow_set:
raise ArgumentError("Set is not allowed in derivation %s" % d)
return [
cls.parse_element(dd, allow_hardened, allow_set=False)
for dd in d[1:-1].split(";")
]
idx = 0
if d[-1] in ["h", "H", "'"]:
if not allow_hardened:
raise ArgumentError("Hardened derivation is not allowed in %s" % d)
idx = HARDENED_INDEX
d = d[:-1]
i = int(d)
if i < 0 or i >= HARDENED_INDEX:
raise ArgumentError(
"Derivation index can be in a range [0, %d)" % HARDENED_INDEX
)
return idx + i
def __str__(self):
r = ""
for idx in self.indexes:
if idx is None:
r += "/*"
if isinstance(idx, int):
if idx >= HARDENED_INDEX:
r += "/%dh" % (idx - HARDENED_INDEX)
else:
r += "/%d" % idx
if isinstance(idx, list):
r += "/<"
r += ";".join(
[
str(i) if i < HARDENED_INDEX else str(i - HARDENED_INDEX) + "h"
for i in idx
]
)
r += ">"
return r
class Key(DescriptorBase):
def __init__(
self,
key,
origin=None,
derivation=None,
taproot=False,
xonly_repr=False,
):
self.origin = origin
self.key = key
self.taproot = taproot
self.xonly_repr = xonly_repr and taproot
if not hasattr(key, "derive") and derivation:
raise ArgumentError("Key %s doesn't support derivation" % key)
self.allowed_derivation = derivation
def __len__(self):
return 34 - int(self.taproot) # <33:sec> or <32:xonly>
@property
def my_fingerprint(self):
if self.is_extended:
return self.key.my_fingerprint
return None
@property
def fingerprint(self):
if self.origin is not None:
return self.origin.fingerprint
else:
if self.is_extended:
return self.key.my_fingerprint
return None
@property
def derivation(self):
return [] if self.origin is None else self.origin.derivation
@classmethod
def read_from(cls, s, taproot: bool = False):
"""
Reads key argument from stream.
If taproot is set to True - allows both x-only and sec pubkeys.
If taproot is False - will raise when finds xonly pubkey.
"""
first = s.read(1)
origin = None
if first == b"[":
prefix, char = read_until(s, b"]")
if char != b"]":
raise ArgumentError("Invalid key - missing ]")
origin = KeyOrigin.from_string(prefix.decode())
else:
s.seek(-1, 1)
k, char = read_until(s, b",)/")
der = b""
# there is a following derivation
if char == b"/":
der, char = read_until(s, b"<{,)")
# legacy branches: {a,b,c...}
if char == b"{":
der += b"{"
branch, char = read_until(s, b"}")
if char is None:
raise ArgumentError("Failed reading the key, missing }")
der += branch + b"}"
rest, char = read_until(s, b",)")
der += rest
# multipart descriptor: <a;b;c;...>
elif char == b"<":
der += b"<"
branch, char = read_until(s, b">")
if char is None:
raise ArgumentError("Failed reading the key, missing >")
der += branch + b">"
rest, char = read_until(s, b",)")
der += rest
if char is not None:
s.seek(-1, 1)
# parse key
k, xonly_repr = cls.parse_key(k, taproot)
# parse derivation
allow_hardened = isinstance(k, bip32.HDKey) and isinstance(k.key, ec.PrivateKey)
derivation = AllowedDerivation.from_string(
der.decode(), allow_hardened=allow_hardened
)
return cls(k, origin, derivation, taproot, xonly_repr)
@classmethod
def parse_key(cls, key: bytes, taproot: bool = False):
# convert to string
k = key.decode()
if len(k) in [66, 130] and k[:2] in ["02", "03", "04"]:
# bare public key
return ec.PublicKey.parse(unhexlify(k)), False
elif taproot and len(k) == 64:
# x-only pubkey
return ec.PublicKey.parse(b"\x02" + unhexlify(k)), True
elif k[1:4] in ["pub", "prv"]:
# bip32 key
return bip32.HDKey.from_base58(k), False
else:
return ec.PrivateKey.from_wif(k), False
@property
def is_extended(self):
return isinstance(self.key, bip32.HDKey)
def check_derivation(self, derivation_path):
rest = None
# full derivation path
if self.fingerprint == derivation_path.fingerprint:
origin = self.derivation
if origin == derivation_path.derivation[: len(origin)]:
rest = derivation_path.derivation[len(origin) :]
# short derivation path
if self.my_fingerprint == derivation_path.fingerprint:
rest = derivation_path.derivation
if self.allowed_derivation is None or rest is None:
return None
return self.allowed_derivation.check_derivation(rest)
def get_public_key(self):
return (
self.key.get_public_key()
if (self.is_extended or self.is_private)
else self.key
)
def sec(self):
return self.key.sec()
def xonly(self):
return self.key.xonly()
def taproot_tweak(self, h=b""):
assert self.taproot
return self.key.taproot_tweak(h)
def serialize(self):
if self.taproot:
return self.sec()[1:33]
return self.sec()
def compile(self):
d = self.serialize()
return compact.to_bytes(len(d)) + d
@property
def prefix(self):
if self.origin:
return "[%s]" % self.origin
return ""
@property
def suffix(self):
return "" if self.allowed_derivation is None else str(self.allowed_derivation)
@property
def can_derive(self):
return self.allowed_derivation is not None and hasattr(self.key, "derive")
@property
def branches(self):
return self.allowed_derivation.branches if self.allowed_derivation else None
@property
def num_branches(self):
return 1 if self.branches is None else len(self.branches)
def branch(self, branch_index=None):
der = (
self.allowed_derivation.branch(branch_index)
if self.allowed_derivation is not None
else None
)
return type(self)(self.key, self.origin, der, self.taproot)
@property
def is_wildcard(self):
return self.allowed_derivation.is_wildcard if self.allowed_derivation else False
def derive(self, idx, branch_index=None):
# nothing to derive
if self.allowed_derivation is None:
return self
der = self.allowed_derivation.fill(idx, branch_index=branch_index)
k = self.key.derive(der)
if self.origin:
origin = KeyOrigin(self.origin.fingerprint, self.origin.derivation + der)
else:
origin = KeyOrigin(self.key.child(0).fingerprint, der)
# empty derivation
derivation = None
return type(self)(k, origin, derivation, self.taproot)
@property
def is_private(self):
return isinstance(self.key, ec.PrivateKey) or (
self.is_extended and self.key.is_private
)
def to_public(self):
if not self.is_private:
return self
if isinstance(self.key, ec.PrivateKey):
return type(self)(
self.key.get_public_key(),
self.origin,
self.allowed_derivation,
self.taproot,
)
else:
return type(self)(
self.key.to_public(), self.origin, self.allowed_derivation, self.taproot
)
@property
def private_key(self):
if not self.is_private:
raise ArgumentError("Key is not private")
# either HDKey.key or just the key
return self.key.key if self.is_extended else self.key
@property
def secret(self):
return self.private_key.secret
def to_string(self, version=None):
if isinstance(self.key, ec.PublicKey):
k = self.key.sec() if not self.xonly_repr else self.key.xonly()
return self.prefix + hexlify(k).decode()
if isinstance(self.key, bip32.HDKey):
return self.prefix + self.key.to_base58(version) + self.suffix
if isinstance(self.key, ec.PrivateKey):
return self.prefix + self.key.wif()
return self.prefix + self.key
@classmethod
def from_string(cls, s, taproot=False):
return cls.parse(s.encode(), taproot)
class KeyHash(Key):
@classmethod
def parse_key(cls, k: bytes, *args, **kwargs):
# convert to string
kd = k.decode()
# raw 20-byte hash
if len(kd) == 40:
return kd, False
return super().parse_key(k, *args, **kwargs)
def serialize(self, *args, **kwargs):
if isinstance(self.key, str):
return unhexlify(self.key)
# TODO: should it be xonly?
if self.taproot:
return hashes.hash160(self.key.sec()[1:33])
return hashes.hash160(self.key.sec())
def __len__(self):
return 21 # <20:pkh>
def compile(self):
d = self.serialize()
return compact.to_bytes(len(d)) + d
class Number(DescriptorBase):
def __init__(self, num):
self.num = num
@classmethod
def read_from(cls, s, taproot=False):
num = 0
char = s.read(1)
while char in b"0123456789":
num = 10 * num + int(char.decode())
char = s.read(1)
s.seek(-1, 1)
return cls(num)
def compile(self):
if self.num == 0:
return b"\x00"
if self.num <= 16:
return bytes([80 + self.num])
b = self.num.to_bytes(32, "little").rstrip(b"\x00")
if b[-1] >= 128:
b += b"\x00"
return bytes([len(b)]) + b
def __len__(self):
return len(self.compile())
def __str__(self):
return "%d" % self.num
class Raw(DescriptorBase):
LEN = 32
def __init__(self, raw):
if len(raw) != self.LEN * 2:
raise ArgumentError("Invalid raw element length: %d" % len(raw))
self.raw = unhexlify(raw)
@classmethod
def read_from(cls, s, taproot=False):
return cls(s.read(2 * cls.LEN).decode())
def __str__(self):
return hexlify(self.raw).decode()
def compile(self):
return compact.to_bytes(len(self.raw)) + self.raw
def __len__(self):
return len(compact.to_bytes(self.LEN)) + self.LEN
class Raw32(Raw):
LEN = 32
def __len__(self):
return 33
class Raw20(Raw):
LEN = 20
def __len__(self):
return 21
|