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
|
# Copyright 2014-2022 Vincent Texier <vit@free.fr>
#
# DuniterPy is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# DuniterPy is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
from typing import Any, Optional, Type, TypeVar, Union
from pypeg2 import Enum, K, Keyword, attr, contiguous, maybe_some, re, whitespace
from ..constants import HASH_REGEX, PUBKEY_REGEX
class Pubkey(str):
"""
Pubkey in transaction output condition
"""
regex = re.compile(PUBKEY_REGEX)
class Hash(str):
"""
Hash in transaction output condition
"""
regex = re.compile(HASH_REGEX)
class Int(str):
"""
Integer in transaction output condition
"""
regex = re.compile(r"[0-9]+")
# required to type hint cls in classmethod
SIGType = TypeVar("SIGType", bound="SIG")
class SIG:
"""
SIGnature function in transaction output condition
"""
grammar = "SIG(", attr("pubkey", Pubkey), ")"
def __init__(self, value: str = "") -> None:
"""
Init SIG instance
:param value: Content of the string
"""
self.value = value
self.pubkey = ""
def __str__(self) -> str:
return self.value
def __eq__(self, other: Any) -> bool:
"""
Check SIG instances equality
"""
if not isinstance(other, SIG):
return NotImplemented
return self.value == other.value and self.pubkey == other.pubkey
def __hash__(self) -> int:
return hash((self.value, self.pubkey))
@classmethod
def token(cls: Type[SIGType], pubkey: str) -> SIGType:
"""
Return SIG instance from pubkey
:param pubkey: Public key of the signature issuer
:return:
"""
sig = cls()
sig.pubkey = pubkey
return sig
def compose(
self, parser: Any = None, grammar: Any = None, attr_of: Any = None
) -> str:
"""
Return the SIG(pubkey) expression as string format
:param parser: Parser instance
:param grammar: Grammar
:param attr_of: Attribute of...
:return:
"""
return f"SIG({self.pubkey})"
# required to type hint cls in classmethod
CSVType = TypeVar("CSVType", bound="CSV")
class CSV:
"""
CSV function in transaction output condition
"""
grammar = "CSV(", attr("time", Int), ")"
def __init__(self, value: str = "") -> None:
"""
Init CSV instance
:param value: Content of the string
"""
self.value = value
self.time = ""
def __str__(self) -> str:
return self.value
def __eq__(self, other: Any) -> bool:
"""
Check CSV instances equality
"""
if not isinstance(other, CSV):
return NotImplemented
return self.value == other.value and self.time == other.time
def __hash__(self) -> int:
return hash((self.value, self.time))
@classmethod
def token(cls: Type[CSVType], time: int) -> CSVType:
"""
Return CSV instance from time
:param time: Timestamp
:return:
"""
csv = cls()
csv.time = str(time)
return csv
def compose(
self, parser: Any = None, grammar: Any = None, attr_of: str = None
) -> str:
"""
Return the CSV(time) expression as string format
:param parser: Parser instance
:param grammar: Grammar
:param attr_of: Attribute of...
"""
return f"CSV({self.time})"
# required to type hint cls in classmethod
CLTVType = TypeVar("CLTVType", bound="CLTV")
class CLTV:
"""
CLTV function in transaction output condition
"""
grammar = "CLTV(", attr("timestamp", Int), ")"
def __init__(self, value: str = "") -> None:
"""
Init CLTV instance
:param value: Content of the string
"""
self.value = value
self.timestamp = ""
def __str__(self) -> str:
return self.value
def __eq__(self, other: Any) -> bool:
"""
Check CLTV instances equality
"""
if not isinstance(other, CLTV):
return NotImplemented
return self.value == other.value and self.timestamp == other.timestamp
def __hash__(self) -> int:
return hash((self.value, self.timestamp))
@classmethod
def token(cls: Type[CLTVType], timestamp: int) -> CLTVType:
"""
Return CLTV instance from timestamp
:param timestamp: Timestamp
:return:
"""
cltv = cls()
cltv.timestamp = str(timestamp)
return cltv
def compose(
self, parser: Any = None, grammar: Any = None, attr_of: str = None
) -> str:
"""
Return the CLTV(timestamp) expression as string format
:param parser: Parser instance
:param grammar: Grammar
:param attr_of: Attribute of...
"""
return f"CLTV({self.timestamp})"
# required to type hint cls in classmethod
XHXType = TypeVar("XHXType", bound="XHX")
class XHX:
"""
XHX function in transaction output condition
"""
grammar = "XHX(", attr("sha_hash", Hash), ")"
def __init__(self, value: str = "") -> None:
"""
Init XHX instance
:param value: Content of the string
"""
self.value = value
self.sha_hash = ""
def __str__(self) -> str:
return self.value
def __eq__(self, other: Any) -> bool:
"""
Check XHX instances equality
"""
if not isinstance(other, XHX):
return NotImplemented
return self.value == other.value and self.sha_hash == other.sha_hash
def __hash__(self) -> int:
return hash((self.value, self.sha_hash))
@classmethod
def token(cls: Type[XHXType], sha_hash: str) -> XHXType:
"""
Return XHX instance from sha_hash
:param sha_hash: SHA256 hash
:return:
"""
xhx = cls()
xhx.sha_hash = sha_hash
return xhx
def compose(
self, parser: Any = None, grammar: Any = None, attr_of: str = None
) -> str:
"""
Return the XHX(sha_hash) expression as string format
:param parser: Parser instance
:param grammar: Grammar
:param attr_of: Attribute of...
"""
return f"XHX({self.sha_hash})"
# required to type hint cls in classmethod
OperatorType = TypeVar("OperatorType", bound="Operator")
class Operator(Keyword):
"""
Operator in transaction output condition
"""
grammar = Enum(K("&&"), K("||"), K("AND"), K("OR"))
regex = re.compile(r"[&&|\|\||\w]+")
@classmethod
def token(cls: Type[OperatorType], keyword: str) -> OperatorType:
"""
Return Operator instance from keyword
:param keyword: Operator keyword in expression
:return:
"""
op = cls(keyword)
return op
def compose(
self, parser: Any = None, grammar: Any = None, attr_of: str = None
) -> str:
"""
Return the Operator keyword as string format
:param parser: Parser instance
:param grammar: Grammar
:param attr_of: Attribute of...
"""
return f"{self.name}"
# required to type hint cls in classmethod
ConditionType = TypeVar("ConditionType", bound="Condition")
class Condition:
"""
Condition expression in transaction output
"""
grammar = None
def __init__(self, value: str = "") -> None:
"""
Init Condition instance
:param value: Content of the condition as string
"""
self.value = value
self.left = "" # type: Union[str, Condition]
self.right = "" # type: Union[str, Condition]
self.op = "" # type: Union[str, Condition]
def __eq__(self, other: Any) -> bool:
"""
Check Condition instances equality
"""
if not isinstance(other, Condition):
return NotImplemented
return (
self.value == other.value
and self.left == other.left
and self.right == other.right
and self.op == other.op
)
def __hash__(self) -> int:
return hash((self.value, self.left, self.right, self.op))
def __str__(self) -> str:
return self.value
@classmethod
def token(
cls: Type[ConditionType],
left: Any,
op: Optional[Any] = None,
right: Optional[Any] = None,
) -> ConditionType:
"""
Return Condition instance from arguments and Operator
:param left: Left argument
:param op: Operator
:param right: Right argument
:return:
"""
condition = cls()
condition.left = left
if op:
condition.op = op
if right:
condition.right = right
return condition
def compose(self, parser: Any, grammar: Any = None, attr_of: str = None) -> str:
"""
Return the Condition as string format
:param parser: Parser instance
:param grammar: Grammar
:param attr_of: Attribute of...
"""
left = parser.compose(self.left, grammar=grammar, attr_of=attr_of)
if type(self.left) is Condition:
left = f"({left})"
if getattr(self, "op", None):
right = parser.compose(self.right, grammar=grammar, attr_of=attr_of)
if type(self.right) is Condition:
right = f"({right})"
op = parser.compose(self.op, grammar=grammar, attr_of=attr_of)
result = f"{left} {op} {right}"
else:
result = left
return result
Condition.grammar = contiguous(
attr("left", [SIG, XHX, CSV, CLTV, ("(", Condition, ")")]),
maybe_some(
whitespace,
attr("op", Operator),
whitespace,
attr("right", [SIG, XHX, CSV, CLTV, ("(", Condition, ")")]),
),
)
|