refactor(scripts): fix imports and linter issues

Author: glevco

hathor/transaction/base_transaction.py

@@ -1269,8 +1269,8 @@ def can_melt_token(self) -> bool:
     def to_human_readable(self) -> dict[str, Any]:
         """Checks what kind of script this is and returns it in human readable form
         """
-        from hathor.transaction.script.scripts import parse_address_script
         from hathor.transaction.script.nano_contract_match_values import NanoContractMatchValues
+        from hathor.transaction.script.scripts import parse_address_script
 
         script_type = parse_address_script(self.script)
         if script_type:

hathor/transaction/script/__init__.py

@@ -1,13 +0,0 @@
-#  Copyright 2023 Hathor Labs
-#
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#
-#  http://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.

hathor/transaction/script/multi_sig.py

@@ -13,13 +13,13 @@
 #  limitations under the License.
 
 import struct
-from typing import Optional, Any
+from typing import Any, Optional
 
 from hathor.crypto.util import decode_address, get_address_b58_from_redeem_script_hash
 from hathor.transaction.script.base_script import BaseScript
 from hathor.transaction.script.hathor_script import HathorScript
-from hathor.transaction.script.scripts import re_compile, get_script_op, get_pushdata, Stack
 from hathor.transaction.script.opcode import Opcode, op_pushdata, op_pushdata1
+from hathor.transaction.script.scripts import Stack, get_pushdata, get_script_op, re_compile
 
 
 class MultiSig(BaseScript):

hathor/transaction/script/nano_contract_match_values.py

@@ -18,8 +18,8 @@
 
 from hathor.crypto.util import get_address_b58_from_bytes
 from hathor.transaction.script.hathor_script import HathorScript
-from hathor.transaction.script.scripts import re_compile, get_pushdata, binary_to_int
 from hathor.transaction.script.opcode import Opcode
+from hathor.transaction.script.scripts import binary_to_int, get_pushdata, re_compile
 
 
 # XXX: does it make sense to make this BaseScript too?

hathor/transaction/script/opcode.py

@@ -22,13 +22,30 @@
 from cryptography.hazmat.primitives.asymmetric import ec
 
 from hathor.conf.get_settings import get_settings
-from hathor.crypto.util import is_pubkey_compressed, get_public_key_from_bytes_compressed, get_hash160, \
-    get_address_b58_from_bytes
-from hathor.transaction.exceptions import MissingStackItems, TimeLocked, EqualVerifyFailed, ScriptError, \
-    OracleChecksigFailed, VerifyFailed, InvalidStackData, InvalidScriptError
-from hathor.transaction.script.p2pkh import P2PKH
-from hathor.transaction.script.scripts import Stack, get_script_op, ScriptExtras, get_data_value, binary_to_int, \
-    decode_opn
+from hathor.crypto.util import (
+    get_address_b58_from_bytes,
+    get_hash160,
+    get_public_key_from_bytes_compressed,
+    is_pubkey_compressed,
+)
+from hathor.transaction.exceptions import (
+    EqualVerifyFailed,
+    InvalidScriptError,
+    InvalidStackData,
+    MissingStackItems,
+    OracleChecksigFailed,
+    ScriptError,
+    TimeLocked,
+    VerifyFailed,
+)
+from hathor.transaction.script.scripts import (
+    ScriptExtras,
+    Stack,
+    binary_to_int,
+    decode_opn,
+    get_data_value,
+    get_script_op,
+)
 
 
 class Opcode(IntEnum):
@@ -486,6 +503,7 @@ def op_find_p2pkh(stack: Stack, log: list[str], extras: ScriptExtras) -> None:
     if not len(stack):
         raise MissingStackItems('OP_FIND_P2PKH: empty stack')
 
+    from hathor.transaction.script.p2pkh import P2PKH
     spent_tx = extras.spent_tx
     txin = extras.txin
     tx = extras.tx

hathor/transaction/script/p2pkh.py

@@ -13,13 +13,13 @@
 #  limitations under the License.
 
 import struct
-from typing import Optional, Any
+from typing import Any, Optional
 
 from hathor.crypto.util import decode_address, get_address_b58_from_public_key_hash
 from hathor.transaction.script.base_script import BaseScript
 from hathor.transaction.script.hathor_script import HathorScript
-from hathor.transaction.script.scripts import re_compile, get_pushdata
 from hathor.transaction.script.opcode import Opcode
+from hathor.transaction.script.scripts import get_pushdata, re_compile
 
 
 class P2PKH(BaseScript):

hathor/transaction/script/scripts.py

@@ -1,17 +1,3 @@
-#  Copyright 2023 Hathor Labs
-#
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#
-#  http://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-
 # Copyright 2021 Hathor Labs
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -28,24 +14,18 @@
 
 import re
 import struct
-from typing import Any, Generator, NamedTuple, Optional, Pattern, Union
+from typing import TYPE_CHECKING, Any, Generator, NamedTuple, Optional, Pattern, Union
 
 from hathor.conf.get_settings import get_settings
-from hathor.crypto.util import (
-    decode_address,
-)
+from hathor.crypto.util import decode_address
 from hathor.transaction import BaseTransaction, Transaction, TxInput
-from hathor.transaction.exceptions import (
-    DataIndexError,
-    FinalStackInvalid,
-    InvalidScriptError,
-    OutOfData,
-    ScriptError,
-)
+from hathor.transaction.exceptions import DataIndexError, FinalStackInvalid, InvalidScriptError, OutOfData, ScriptError
 from hathor.transaction.script.base_script import BaseScript
-from hathor.transaction.script.multi_sig import MultiSig
-from hathor.transaction.script.opcode import Opcode, MAP_OPCODE_TO_FN
-from hathor.transaction.script.p2pkh import P2PKH
+
+if TYPE_CHECKING:
+    from hathor.transaction.script.multi_sig import MultiSig
+    from hathor.transaction.script.opcode import Opcode
+    from hathor.transaction.script.p2pkh import P2PKH
 
 # XXX: Because the Stack is a heterogeneous list of bytes and int, and some OPs only work for when the stack has some
 #      or the other type, there are many places that require an assert to prevent the wrong type from being used,
@@ -90,6 +70,7 @@ def re_compile(pattern: str) -> Pattern[bytes]:
     def _to_byte_pattern(m):
         x = m.group().decode('ascii').strip()
         if x.startswith('OP_'):
+            from hathor.transaction.script.opcode import Opcode
             return bytes([Opcode[x]])
         elif x.startswith('DATA_'):
             length = int(m.group()[5:])
@@ -112,6 +93,7 @@ def _re_pushdata(length: int) -> bytes:
     :return: A non-compiled regular expression
     :rtype: bytes
     """
+    from hathor.transaction.script.opcode import Opcode
     ret = [bytes([Opcode.OP_PUSHDATA1]), bytes([length]), b'.{', str(length).encode('ascii'), b'}']
 
     if length <= 75:
@@ -127,8 +109,10 @@ def create_base_script(address: str, timelock: Optional[Any] = None) -> BaseScri
     settings = get_settings()
     baddress = decode_address(address)
     if baddress[0] == binary_to_int(settings.P2PKH_VERSION_BYTE):
+        from hathor.transaction.script.p2pkh import P2PKH
         return P2PKH(address, timelock)
     elif baddress[0] == binary_to_int(settings.MULTISIG_VERSION_BYTE):
+        from hathor.transaction.script.multi_sig import MultiSig
         return MultiSig(address, timelock)
     else:
         raise ScriptError('The address is not valid')
@@ -150,14 +134,16 @@ def create_output_script(address: bytes, timelock: Optional[Any] = None) -> byte
     settings = get_settings()
     # XXX: if the address class can somehow be simplified create_base_script could be used here
     if address[0] == binary_to_int(settings.P2PKH_VERSION_BYTE):
+        from hathor.transaction.script.p2pkh import P2PKH
         return P2PKH.create_output_script(address, timelock)
     elif address[0] == binary_to_int(settings.MULTISIG_VERSION_BYTE):
+        from hathor.transaction.script.multi_sig import MultiSig
         return MultiSig.create_output_script(address, timelock)
     else:
         raise ScriptError('The address is not valid')
 
 
-def parse_address_script(script: bytes) -> Optional[Union[P2PKH, MultiSig]]:
+def parse_address_script(script: bytes) -> Optional[Union['P2PKH', 'MultiSig']]:
     """ Verifies if address is P2PKH or Multisig and calls correct parse_script method
 
         :param script: script to decode
@@ -166,6 +152,8 @@ def parse_address_script(script: bytes) -> Optional[Union[P2PKH, MultiSig]]:
         :return: P2PKH or MultiSig class or None
         :rtype: class or None
     """
+    from hathor.transaction.script.multi_sig import MultiSig
+    from hathor.transaction.script.p2pkh import P2PKH
     script_classes: list[type[Union[P2PKH, MultiSig]]] = [P2PKH, MultiSig]
     # Each class verifies its script
     for script_class in script_classes:
@@ -185,6 +173,7 @@ def decode_opn(opcode: int) -> int:
         :return: int value for opcode param
         :rtype: int
     """
+    from hathor.transaction.script.opcode import Opcode
     int_val = opcode - Opcode.OP_0
     if not (0 <= int_val <= 16):
         raise InvalidScriptError('unknown opcode {}'.format(opcode))
@@ -258,6 +247,7 @@ def get_script_op(pos: int, data: bytes, stack: Optional[Stack] = None) -> Opcod
     opcode = get_data_single_byte(pos, data)
 
     # validate opcode
+    from hathor.transaction.script.opcode import Opcode
     if not Opcode.is_valid_opcode(opcode):
         raise InvalidScriptError('Invalid Opcode ({}) at position {} in {!r}'.format(opcode, pos, data))
 
@@ -293,7 +283,7 @@ def get_script_op(pos: int, data: bytes, stack: Optional[Stack] = None) -> Opcod
 
 
 class _ScriptOperation(NamedTuple):
-    opcode: Union[Opcode, int]
+    opcode: Union['Opcode', int]
     position: int
     data: Union[None, bytes, int, str]
 
@@ -308,6 +298,7 @@ def parse_script_ops(data: bytes) -> Generator[_ScriptOperation, None, None]:
         :return: generator for operations on script
         :rtype: Generator[_ScriptOperation, None, None]
     """
+    from hathor.transaction.script.opcode import Opcode
     op: Union[Opcode, int]
 
     pos = 0
@@ -341,6 +332,7 @@ def count_sigops(data: bytes) -> int:
         :return: number of signature operations the script would do if it was executed
         :rtype: int
     """
+    from hathor.transaction.script.opcode import Opcode
     settings = get_settings()
     n_ops: int = 0
     data_len: int = len(data)
@@ -388,6 +380,7 @@ def get_sigops_count(data: bytes, output_script: Optional[bytes] = None) -> int:
     # If validating an input, should check the spent_tx for MultiSig
     if output_script is not None:
         # If it's multisig we have to validate the redeem_script sigop count
+        from hathor.transaction.script.multi_sig import MultiSig
         if MultiSig.re_match.search(output_script):
             multisig_data = MultiSig.get_multisig_data(data)
             # input_script + redeem_script
@@ -411,6 +404,7 @@ def execute_eval(data: bytes, log: list[str], extras: ScriptExtras) -> None:
         :raises ScriptError: case opcode is not found
         :raises FinalStackInvalid: case the evaluation fails
     """
+    from hathor.transaction.script.opcode import MAP_OPCODE_TO_FN, Opcode
     stack: Stack = []
     data_len = len(data)
     pos = 0
@@ -466,6 +460,7 @@ def script_eval(tx: Transaction, txin: TxInput, spent_tx: BaseTransaction) -> No
     log: list[str] = []
     extras = ScriptExtras(tx=tx, txin=txin, spent_tx=spent_tx)
 
+    from hathor.transaction.script.multi_sig import MultiSig
     if MultiSig.re_match.search(output_script):
         # For MultiSig there are 2 executions:
         # First we need to evaluate that redeem_script matches redeem_script_hash
@@ -551,5 +546,3 @@ def binary_to_int(binary: bytes) -> int:
 
     (value,) = struct.unpack(_format, binary)
     return value
-
-

hathor/wallet/base_wallet.py

@@ -29,8 +29,8 @@
 from hathor.pubsub import EventArguments, HathorEvents, PubSubManager
 from hathor.transaction import BaseTransaction, Block, TxInput, TxOutput
 from hathor.transaction.base_transaction import int_to_bytes
-from hathor.transaction.script.scripts import create_output_script, parse_address_script
 from hathor.transaction.script.p2pkh import P2PKH
+from hathor.transaction.script.scripts import create_output_script, parse_address_script
 from hathor.transaction.storage import TransactionStorage
 from hathor.transaction.transaction import Transaction
 from hathor.types import AddressB58, Amount, TokenUid

hathor/wallet/util.py

@@ -21,8 +21,8 @@
 
 from hathor.conf.get_settings import get_settings
 from hathor.crypto.util import get_hash160, get_private_key_from_bytes
-from hathor.transaction.script.opcode import Opcode
 from hathor.transaction.script.hathor_script import HathorScript
+from hathor.transaction.script.opcode import Opcode
 from hathor.transaction.transaction import Transaction
 
 

tests/resources/transaction/test_create_tx.py

@@ -5,8 +5,8 @@
 from hathor.daa import TestMode, _set_test_mode
 from hathor.transaction import Transaction
 from hathor.transaction.resources import CreateTxResource
-from hathor.transaction.script.scripts import create_base_script
 from hathor.transaction.script.p2pkh import P2PKH
+from hathor.transaction.script.scripts import create_base_script
 from tests import unittest
 from tests.resources.base_resource import StubSite, _BaseResourceTest
 from tests.utils import add_blocks_unlock_reward, add_new_blocks, add_new_tx