transaction.py 25.6 KB
Newer Older
1
import re
2
from typing import TypeVar, List, Any, Type, Optional, Dict, Union
3 4

import pypeg2
5 6

from duniterpy.grammars.output import Condition
7
from .block_uid import BlockUID
inso's avatar
inso committed
8
from .document import Document, MalformedDocumentError
9
from ..constants import PUBKEY_REGEX, TRANSACTION_HASH_REGEX, BLOCK_ID_REGEX, BLOCK_UID_REGEX
inso's avatar
inso committed
10 11 12
from ..grammars import output


13
def reduce_base(amount: int, base: int) -> tuple:
inso's avatar
inso committed
14 15
    """
    Compute the reduced base of the given parameters
16 17 18 19

    :param amount: the amount value
    :param base: current base value

inso's avatar
inso committed
20 21 22 23 24 25 26
    :return: tuple containing computed (amount, base)
    """
    if amount == 0:
        return 0, 0

    next_amount = amount
    next_base = base
27 28
    next_amount_is_integer = True
    while next_amount_is_integer:
inso's avatar
inso committed
29 30
        amount = next_amount
        base = next_base
31 32 33 34 35 36
        if next_amount % 10 == 0:
            next_amount = int(next_amount / 10)
            next_base += 1
        else:
            next_amount_is_integer = False

inso's avatar
inso committed
37 38 39
    return int(amount), int(base)


40 41 42 43 44 45 46 47 48 49 50 51 52
# required to type hint cls in classmethod
InputSourceType = TypeVar('InputSourceType', bound='InputSource')


class InputSource:
    """
    A Transaction INPUT

.. note:: Compact :
    INDEX:SOURCE:FINGERPRINT:AMOUNT

    """
    re_inline = re.compile(
53 54
        "([0-9]+):([0-9]):(?:(?:(D):({pubkey_regex}):({block_id_regex}))|(?:(T):({transaction_hash_regex}):\
([0-9]+)))"
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
        .format(pubkey_regex=PUBKEY_REGEX,
                block_id_regex=BLOCK_ID_REGEX,
                transaction_hash_regex=TRANSACTION_HASH_REGEX))

    def __init__(self, amount: int, base: int, source: str, origin_id: str, index: int) -> None:
        """
        An input source can come from a dividend or a transaction.

        :param amount: amount of the input
        :param base: base of the input
        :param source: D if dividend, T if transaction
        :param origin_id: a Public key if a dividend, a tx hash if a transaction
        :param index: a block id if a dividend, an tx index if a transaction
        :return:
        """
        self.amount = amount
        self.base = base
        self.source = source
        self.origin_id = origin_id
        self.index = index

76 77 78 79 80 81
    def __eq__(self, other: Any) -> bool:
        """
        Check InputSource instances equality
        """
        if not isinstance(other, InputSource):
            return NotImplemented
82 83 84 85 86
        return self.amount == other.amount and \
            self.base == other.base and \
            self.source == other.source and \
            self.origin_id == other.origin_id and \
            self.index == other.index
87 88 89 90

    def __hash__(self) -> int:
        return hash((self.amount, self.base, self.source, self.origin_id, self.index))

91
    @classmethod
92
    def from_inline(cls: Type[InputSourceType], inline: str) -> InputSourceType:
93 94 95 96 97 98
        """
        Return Transaction instance from inline string format

        :param inline: Inline string format
        :return:
        """
99 100 101 102 103 104
        data = InputSource.re_inline.match(inline)
        if data is None:
            raise MalformedDocumentError("Inline input")
        source_offset = 2
        amount = int(data.group(1))
        base = int(data.group(2))
105 106 107 108 109 110 111 112 113 114 115
        if data.group(1 + source_offset):
            source = data.group(1 + source_offset)
            origin_id = data.group(2 + source_offset)
            index = int(data.group(3 + source_offset))
        else:
            source = data.group(4 + source_offset)
            origin_id = data.group(5 + source_offset)
            index = int(data.group(6 + source_offset))

        return cls(amount, base, source, origin_id, index)

116
    def inline(self) -> str:
117 118 119 120 121
        """
        Return an inline string format of the document

        :return:
        """
122
        return "{0}:{1}:{2}:{3}:{4}".format(self.amount,
123 124 125 126 127 128 129 130 131 132 133 134 135 136
                                                self.base,
                                                self.source,
                                                self.origin_id,
                                                self.index)


# required to type hint cls in classmethod
OutputSourceType = TypeVar('OutputSourceType', bound='OutputSource')


class OutputSource:
    """
    A Transaction OUTPUT
    """
137
    re_inline = re.compile("([0-9]+):([0-9]):(.*)")
138

139
    def __init__(self, amount: int, base: int, condition: str) -> None:
140 141 142 143 144
        """
        Init OutputSource instance

        :param amount: Amount of the output
        :param base: Base number
145
        :param condition: Condition expression
146 147 148
        """
        self.amount = amount
        self.base = base
149
        self.condition = self.condition_from_text(condition)
150

151 152 153 154 155 156
    def __eq__(self, other: Any) -> bool:
        """
        Check OutputSource instances equality
        """
        if not isinstance(other, OutputSource):
            return NotImplemented
157 158 159
        return self.amount == other.amount and \
            self.base == other.base and \
            self.condition == other.condition
160 161 162 163

    def __hash__(self) -> int:
        return hash((self.amount, self.base, self.condition))

164 165 166 167 168 169 170 171 172 173 174 175 176
    @classmethod
    def from_inline(cls: Type[OutputSourceType], inline: str) -> OutputSourceType:
        """
        Return OutputSource instance from inline string format

        :param inline: Inline string format
        :return:
        """
        data = OutputSource.re_inline.match(inline)
        if data is None:
            raise MalformedDocumentError("Inline output")
        amount = int(data.group(1))
        base = int(data.group(2))
177 178 179
        condition_text = data.group(3)

        return cls(amount, base, condition_text)
180 181 182

    def inline(self) -> str:
        """
183
        Return an inline string format of the output source
184 185 186

        :return:
        """
187 188 189
        return "{0}:{1}:{2}".format(self.amount, self.base,
                                    pypeg2.compose(self.condition, output.Condition))

190 191 192 193 194 195 196 197
    def inline_condition(self) -> str:
        """
        Return an inline string format of the output source’s condition

        :return:
        """
        return pypeg2.compose(self.condition, output.Condition)

198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
    @staticmethod
    def condition_from_text(text) -> Condition:
        """
        Return a Condition instance with PEG grammar from text

        :param text: PEG parsable string
        :return:
        """
        try:
            condition = pypeg2.parse(text, output.Condition)
        except SyntaxError:
            # Invalid conditions are possible, see https://github.com/duniter/duniter/issues/1156
            # In such a case, they are store as empty PEG grammar object and considered unlockable
            condition = Condition(text)
        return condition
213 214 215 216 217 218 219 220 221 222


# required to type hint cls in classmethod
SIGParameterType = TypeVar('SIGParameterType', bound='SIGParameter')


class SIGParameter:
    """
    A Transaction UNLOCK SIG parameter
    """
223
    re_sig = re.compile("SIG\\(([0-9]+)\\)")
224 225 226 227 228 229 230 231 232

    def __init__(self, index: int) -> None:
        """
        Init SIGParameter instance

        :param index: Index in list
        """
        self.index = index

233 234 235 236 237 238 239 240 241 242 243 244 245

    def __eq__(self, other: Any) -> bool:
        """
        Check SIGParameter instances equality
        """
        if not isinstance(other, SIGParameter):
            return NotImplemented
        return self.index == other.index

    def __hash__(self) -> int:
        return hash((self.index))


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
    @classmethod
    def from_parameter(cls: Type[SIGParameterType], parameter: str) -> Optional[SIGParameterType]:
        """
        Return a SIGParameter instance from an index parameter

        :param parameter: Index parameter

        :return:
        """
        sig = SIGParameter.re_sig.match(parameter)
        if sig:
            return cls(int(sig.group(1)))

        return None

    def __str__(self):
        """
        Return a string representation of the SIGParameter instance

        :return:
        """
        return "SIG({0})".format(self.index)


# required to type hint cls in classmethod
XHXParameterType = TypeVar('XHXParameterType', bound='XHXParameter')


class XHXParameter:
    """
    A Transaction UNLOCK XHX parameter
    """
278
    re_xhx = re.compile("XHX\\(([0-9]+)\\)")
279 280 281 282 283 284 285 286 287

    def __init__(self, integer: int) -> None:
        """
        Init XHXParameter instance

        :param integer: XHX number
        """
        self.integer = integer

288 289 290 291 292 293 294 295 296 297 298 299 300

    def __eq__(self, other: Any) -> bool:
        """
        Check XHXParameter instances equality
        """
        if not isinstance(other, XHXParameter):
            return NotImplemented
        return self.integer == other.integer

    def __hash__(self) -> int:
        return hash((self.integer))


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
    @classmethod
    def from_parameter(cls: Type[XHXParameterType], parameter: str) -> Optional[XHXParameterType]:
        """
        Return a XHXParameter instance from an index parameter

        :param parameter: Index parameter

        :return:
        """
        xhx = XHXParameter.re_xhx.match(parameter)
        if xhx:
            return cls(int(xhx.group(1)))

        return None

    def compute(self):
        pass

    def __str__(self):
        """
        Return a string representation of the XHXParameter instance

        :return:
        """
        return "XHX({0})".format(self.integer)


# required to type hint cls in classmethod
UnlockParameterType = TypeVar('UnlockParameterType', bound='UnlockParameter')


class UnlockParameter:

    @classmethod
    def from_parameter(cls: Type[UnlockParameterType], parameter: str) -> Optional[Union[SIGParameter, XHXParameter]]:
        """
        Return UnlockParameter instance from parameter string

        :param parameter: Parameter string
        :return:
        """

        sig_param = SIGParameter.from_parameter(parameter)
        if sig_param:
            return sig_param
        else:
            xhx_param = XHXParameter.from_parameter(parameter)
            if xhx_param:
                return xhx_param

        return None

    def compute(self):
        pass


# required to type hint cls in classmethod
UnlockType = TypeVar('UnlockType', bound='Unlock')


class Unlock:
    """
    A Transaction UNLOCK
    """
365
    re_inline = re.compile("([0-9]+):((?:SIG\\([0-9]+\\)|XHX\\([0-9]+\\)|\\s)+)\n")
366 367 368 369 370 371 372 373 374 375 376

    def __init__(self, index: int, parameters: List[Union[SIGParameter, XHXParameter]]) -> None:
        """
        Init Unlock instance

        :param index: Index number
        :param parameters: List of UnlockParameter instances
        """
        self.index = index
        self.parameters = parameters

377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394

    def __eq__(self, other: Any) -> bool:
        """
        Check Unlock instances equality
        """
        if not isinstance(other, Unlock):
            return NotImplemented

        params_equals = True
        for spar, opar in zip(self.parameters, other.parameters):
            if spar != opar:
                params_equals = False
        return self.index == other.index and params_equals

    def __hash__(self) -> int:
        return hash((self.index, self.parameters))


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
    @classmethod
    def from_inline(cls: Type[UnlockType], inline: str) -> UnlockType:
        """
        Return an Unlock instance from inline string format

        :param inline: Inline string format

        :return:
        """
        data = Unlock.re_inline.match(inline)
        if data is None:
            raise MalformedDocumentError("Inline input")
        index = int(data.group(1))
        parameters_str = data.group(2).split(' ')
        parameters = []
        for p in parameters_str:
            param = UnlockParameter.from_parameter(p)
            if param:
                parameters.append(param)
        return cls(index, parameters)

    def inline(self) -> str:
        """
        Return inline string format of the instance

        :return:
        """
        return "{0}:{1}".format(self.index, ' '.join([str(p) for p in self.parameters]))


# required to type hint cls in classmethod
TransactionType = TypeVar('TransactionType', bound='Transaction')


inso's avatar
inso committed
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
class Transaction(Document):
    """
.. note:: A transaction document is specified by the following format :

    | Document format :
    | Version: VERSION
    | Type: Transaction
    | Currency: CURRENCY_NAME
    | Issuers:
    | PUBLIC_KEY
    | ...
    | Inputs:
    | INDEX:SOURCE:NUMBER:FINGERPRINT:AMOUNT
    | ...
    | Outputs:
    | PUBLIC_KEY:AMOUNT
    | ...
    | Comment: COMMENT
    | ...
    |
    |
    | Compact format :
    | TX:VERSION:NB_ISSUERS:NB_INPUTS:NB_OUTPUTS:HAS_COMMENT
    | PUBLIC_KEY:INDEX
    | ...
    | INDEX:SOURCE:FINGERPRINT:AMOUNT
    | ...
    | PUBLIC_KEY:AMOUNT
    | ...
    | COMMENT
    | SIGNATURE
    | ...

    """

    re_type = re.compile("Type: (Transaction)\n")
465
    re_header = re.compile("TX:([0-9]+):([0-9]+):([0-9]+):([0-9]+):([0-9]+):([01]):([0-9]+)\n")
466 467
    re_compact_blockstamp = re.compile("({block_uid_regex})\n".format(block_uid_regex=BLOCK_UID_REGEX))
    re_blockstamp = re.compile("Blockstamp: ({block_uid_regex})\n".format(block_uid_regex=BLOCK_UID_REGEX))
inso's avatar
inso committed
468 469 470 471 472 473 474
    re_locktime = re.compile("Locktime: ([0-9]+)\n")
    re_issuers = re.compile("Issuers:\n")
    re_inputs = re.compile("Inputs:\n")
    re_unlocks = re.compile("Unlocks:\n")
    re_outputs = re.compile("Outputs:\n")
    re_compact_comment = re.compile("([^\n]+)\n")
    re_comment = re.compile("Comment: ([^\n]*)\n")
475
    re_pubkey = re.compile("({pubkey_regex})\n".format(pubkey_regex=PUBKEY_REGEX))
inso's avatar
inso committed
476 477

    fields_parsers = {**Document.fields_parsers, **{
478 479 480 481 482 483 484 485 486 487 488 489
        "Type": re_type,
        "Blockstamp": re_blockstamp,
        "CompactBlockstamp": re_compact_blockstamp,
        "Locktime": re_locktime,
        "TX": re_header,
        "Issuers": re_issuers,
        "Inputs": re_inputs,
        "Unlocks": re_unlocks,
        "Outputs": re_outputs,
        "Comment": re_comment,
        "Compact comment": re_compact_comment,
        "Pubkey": re_pubkey
inso's avatar
inso committed
490
    }
491
                      }
inso's avatar
inso committed
492

493 494
    def __init__(self, version: int, currency: str, blockstamp: Optional[BlockUID], locktime: int, issuers: List[str],
                 inputs: List[InputSource], unlocks: List[Unlock], outputs: List[OutputSource],
495
                 comment: str, time: int, signatures: List[str]) -> None:
inso's avatar
inso committed
496
        """
497 498 499 500 501 502 503 504 505 506 507
        Init Transaction instance

        :param version: Version number of the document
        :param currency: Name of the currency
        :param blockstamp: BlockUID timestamp of the block
        :param locktime: Lock time in seconds
        :param issuers: List of issuers public key
        :param inputs: List of InputSource instances
        :param unlocks: List of Unlock instances
        :param outputs: List of OutputSource instances
        :param comment: Comment field
508
        :param time: time when the transaction enters the blockchain
509
        :param signatures: List of signatures
inso's avatar
inso committed
510 511
        """
        super().__init__(version, currency, signatures)
inso's avatar
inso committed
512
        self.blockstamp = blockstamp
inso's avatar
inso committed
513 514 515 516 517 518
        self.locktime = locktime
        self.issuers = issuers
        self.inputs = inputs
        self.unlocks = unlocks
        self.outputs = outputs
        self.comment = comment
519 520
        self.time = time

inso's avatar
inso committed
521

522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
    def __eq__(self, other: Any) -> bool:
        """
        Check Transaction instances equality
        """
        if not isinstance(other, Transaction):
            return NotImplemented
        return self.version == other.version and \
            self.currency == other.currency and \
            self.signatures == other.signatures and \
            self.blockstamp == other.blockstamp and \
            self.locktime == other.locktime and \
            self.issuers == other.issuers and \
            self.inputs == other.inputs and \
            self.unlocks == other.unlocks and \
            self.outputs == other.outputs and \
            self.comment == other.comment and \
            self.time == other.time


    def __hash__(self) -> int:
        return hash((self.version, self.currency, self.signatures, self.blockstamp, self.locktime, self.issuers, self.inputs, self.unlocks, self.outputs, self.comment, self.time))


inso's avatar
inso committed
545
    @classmethod
546
    def from_bma_history(cls: Type[TransactionType], currency: str, tx_data: Dict) -> TransactionType:
inso's avatar
inso committed
547
        """
548 549 550 551 552 553
        Get the transaction instance from json

        :param currency: the currency of the tx
        :param tx_data: json data of the transaction

        :return:
inso's avatar
inso committed
554 555 556 557 558
        """
        tx_data = tx_data.copy()
        tx_data["currency"] = currency
        for data_list in ('issuers', 'outputs', 'inputs', 'unlocks', 'signatures'):
            tx_data['multiline_{0}'.format(data_list)] = '\n'.join(tx_data[data_list])
559
        return cls.from_signed_raw("""Version: {version}
inso's avatar
inso committed
560 561 562 563 564 565 566 567 568 569 570 571 572 573
Type: Transaction
Currency: {currency}
Blockstamp: {blockstamp}
Locktime: {locktime}
Issuers:
{multiline_issuers}
Inputs:
{multiline_inputs}
Unlocks:
{multiline_unlocks}
Outputs:
{multiline_outputs}
Comment: {comment}
{multiline_signatures}
574
""".format(**tx_data), tx_data["time"])
inso's avatar
inso committed
575

inso's avatar
inso committed
576
    @classmethod
577 578 579 580 581 582 583 584
    def from_compact(cls: Type[TransactionType], currency: str, compact: str) -> TransactionType:
        """
        Return Transaction instance from compact string format

        :param currency: Name of the currency
        :param compact: Compact format string
        :return:
        """
inso's avatar
inso committed
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
        lines = compact.splitlines(True)
        n = 0

        header_data = Transaction.re_header.match(lines[n])
        if header_data is None:
            raise MalformedDocumentError("Compact TX header")
        version = int(header_data.group(1))
        issuers_num = int(header_data.group(2))
        inputs_num = int(header_data.group(3))
        unlocks_num = int(header_data.group(4))
        outputs_num = int(header_data.group(5))
        has_comment = int(header_data.group(6))
        locktime = int(header_data.group(7))
        n += 1

600 601
        blockstamp = BlockUID.from_str(Transaction.parse_field("CompactBlockstamp", lines[n]))
        n += 1
inso's avatar
inso committed
602

inso's avatar
inso committed
603 604 605 606 607 608 609 610 611 612 613
        issuers = []
        inputs = []
        unlocks = []
        outputs = []
        signatures = []
        for i in range(0, issuers_num):
            issuer = Transaction.parse_field("Pubkey", lines[n])
            issuers.append(issuer)
            n += 1

        for i in range(0, inputs_num):
614
            input_source = InputSource.from_inline(lines[n])
inso's avatar
inso committed
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
            inputs.append(input_source)
            n += 1

        for i in range(0, unlocks_num):
            unlock = Unlock.from_inline(lines[n])
            unlocks.append(unlock)
            n += 1

        for i in range(0, outputs_num):
            output_source = OutputSource.from_inline(lines[n])
            outputs.append(output_source)
            n += 1

        comment = ""
        if has_comment == 1:
630 631 632
            data = Transaction.re_compact_comment.match(lines[n])
            if data:
                comment = data.group(1)
inso's avatar
inso committed
633 634 635 636 637
                n += 1
            else:
                raise MalformedDocumentError("Compact TX Comment")

        while n < len(lines):
638 639 640
            data = Transaction.re_signature.match(lines[n])
            if data:
                signatures.append(data.group(1))
inso's avatar
inso committed
641 642 643 644
                n += 1
            else:
                raise MalformedDocumentError("Compact TX Signatures")

645
        return cls(version, currency, blockstamp, locktime, issuers, inputs, unlocks, outputs, comment, 0, signatures)
inso's avatar
inso committed
646 647

    @classmethod
648
    def from_signed_raw(cls: Type[TransactionType], raw: str, time: int = 0) -> TransactionType:
649 650 651 652 653 654 655
        """
        Return a Transaction instance from a raw string format

        :param raw: Raw string format

        :return:
        """
inso's avatar
inso committed
656 657 658 659 660 661 662 663 664 665 666 667
        lines = raw.splitlines(True)
        n = 0

        version = int(Transaction.parse_field("Version", lines[n]))
        n += 1

        Transaction.parse_field("Type", lines[n])
        n += 1

        currency = Transaction.parse_field("Currency", lines[n])
        n += 1

668 669
        blockstamp = BlockUID.from_str(Transaction.parse_field("Blockstamp", lines[n]))
        n += 1
inso's avatar
inso committed
670

inso's avatar
inso committed
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
        locktime = Transaction.parse_field("Locktime", lines[n])
        n += 1

        issuers = []
        inputs = []
        unlocks = []
        outputs = []
        signatures = []

        if Transaction.re_issuers.match(lines[n]):
            n += 1
            while Transaction.re_inputs.match(lines[n]) is None:
                issuer = Transaction.parse_field("Pubkey", lines[n])
                issuers.append(issuer)
                n += 1

        if Transaction.re_inputs.match(lines[n]):
            n += 1
            while Transaction.re_unlocks.match(lines[n]) is None:
690
                input_source = InputSource.from_inline(lines[n])
inso's avatar
inso committed
691 692 693 694 695 696 697 698 699 700 701 702 703
                inputs.append(input_source)
                n += 1

        if Transaction.re_unlocks.match(lines[n]):
            n += 1
            while Transaction.re_outputs.match(lines[n]) is None:
                unlock = Unlock.from_inline(lines[n])
                unlocks.append(unlock)
                n += 1

        if Transaction.re_outputs.match(lines[n]) is not None:
            n += 1
            while not Transaction.re_comment.match(lines[n]):
704 705
                _output = OutputSource.from_inline(lines[n])
                outputs.append(_output)
inso's avatar
inso committed
706 707 708 709 710 711 712 713 714 715 716
                n += 1

        comment = Transaction.parse_field("Comment", lines[n])
        n += 1

        if Transaction.re_signature.match(lines[n]) is not None:
            while n < len(lines):
                sign = Transaction.parse_field("Signature", lines[n])
                signatures.append(sign)
                n += 1

inso's avatar
inso committed
717
        return cls(version, currency, blockstamp, locktime, issuers, inputs, unlocks, outputs,
718
                   comment, time, signatures)
inso's avatar
inso committed
719

720 721 722 723 724 725
    def raw(self) -> str:
        """
        Return raw string format from the instance

        :return:
        """
inso's avatar
inso committed
726 727 728 729
        doc = """Version: {0}
Type: Transaction
Currency: {1}
""".format(self.version,
inso's avatar
inso committed
730 731
           self.currency)

732
        doc += "Blockstamp: {0}\n".format(self.blockstamp)
inso's avatar
inso committed
733

inso's avatar
inso committed
734 735 736
        doc += "Locktime: {0}\n".format(self.locktime)

        doc += "Issuers:\n"
inso's avatar
inso committed
737 738 739 740 741
        for p in self.issuers:
            doc += "{0}\n".format(p)

        doc += "Inputs:\n"
        for i in self.inputs:
742
            doc += "{0}\n".format(i.inline())
inso's avatar
inso committed
743 744 745 746 747 748 749 750 751 752 753 754 755 756

        doc += "Unlocks:\n"
        for u in self.unlocks:
            doc += "{0}\n".format(u.inline())

        doc += "Outputs:\n"
        for o in self.outputs:
            doc += "{0}\n".format(o.inline())

        doc += "Comment: "
        doc += "{0}\n".format(self.comment)

        return doc

757
    def compact(self) -> str:
inso's avatar
inso committed
758
        """
759 760 761
        Return a transaction in its compact format from the instance

        :return:
inso's avatar
inso committed
762 763 764 765 766 767 768 769 770 771 772
        """
        """TX:VERSION:NB_ISSUERS:NB_INPUTS:NB_UNLOCKS:NB_OUTPUTS:HAS_COMMENT:LOCKTIME
PUBLIC_KEY:INDEX
...
INDEX:SOURCE:FINGERPRINT:AMOUNT
...
PUBLIC_KEY:AMOUNT
...
COMMENT
"""
        doc = "TX:{0}:{1}:{2}:{3}:{4}:{5}:{6}\n".format(self.version,
773 774 775 776 777 778
                                                        len(self.issuers),
                                                        len(self.inputs),
                                                        len(self.unlocks),
                                                        len(self.outputs),
                                                        '1' if self.comment != "" else '0',
                                                        self.locktime)
779
        doc += "{0}\n".format(self.blockstamp)
inso's avatar
inso committed
780

inso's avatar
inso committed
781 782 783
        for pubkey in self.issuers:
            doc += "{0}\n".format(pubkey)
        for i in self.inputs:
784
            doc += "{0}\n".format(i.inline())
inso's avatar
inso committed
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
        for u in self.unlocks:
            doc += "{0}\n".format(u.inline())
        for o in self.outputs:
            doc += "{0}\n".format(o.inline())
        if self.comment != "":
            doc += "{0}\n".format(self.comment)
        for s in self.signatures:
            doc += "{0}\n".format(s)

        return doc


class SimpleTransaction(Transaction):
    """
    As transaction class, but for only one issuer.
    ...
    """
802

803 804
    def __init__(self, version: int, currency: str, blockstamp: BlockUID, locktime: int, issuer: str,
                 single_input: InputSource, unlocks: List[Unlock], outputs: List[OutputSource], comment: str,
805
                 time: int, signature: str) -> None:
inso's avatar
inso committed
806
        """
807 808
        Init instance

809 810 811 812 813 814 815 816 817
        :param version: Version number of the document
        :param currency: Name of the currency
        :param blockstamp: BlockUID timestamp
        :param locktime: Lock time in seconds
        :param issuer: Issuer public key
        :param single_input: InputSource instance
        :param unlocks: List of Unlock instances
        :param outputs: List of OutputSource instances
        :param comment: Comment field
818
        :param time: time when the transaction enters the blockchain
819
        :param signature: Signature
inso's avatar
inso committed
820
        """
821
        super().__init__(version, currency, blockstamp, locktime, [issuer], [single_input], unlocks,
822
                         outputs, comment, time ,[signature])
inso's avatar
inso committed
823 824

    @staticmethod
825
    def is_simple(tx: Transaction) -> bool:
inso's avatar
inso committed
826 827 828 829 830 831
        """
        Filter a transaction and checks if it is a basic one
        A simple transaction is a tx which has only one issuer
        and two outputs maximum. The unlocks must be done with
        simple "SIG" functions, and the outputs must be simple
        SIG conditions.
832

833
        :param tx: the transaction to check
834

inso's avatar
inso committed
835 836 837 838 839 840 841 842 843 844 845
        :return: True if a simple transaction
        """
        simple = True
        if len(tx.issuers) != 1:
            simple = False
        for unlock in tx.unlocks:
            if len(unlock.parameters) != 1:
                simple = False
            elif type(unlock.parameters[0]) is not SIGParameter:
                simple = False
        for o in tx.outputs:
846
            # if right condition is not None...
847
            if getattr(o.condition, 'right', None):
inso's avatar
inso committed
848
                simple = False
849 850 851 852
                # if left is not SIG...
            elif type(o.condition.left) is not output.SIG:
                simple = False

inso's avatar
inso committed
853
        return simple