feat: change transaction storage to fit protocol

Author: r4mmer

hathor/builder/builder.py

@@ -39,7 +39,6 @@
 from hathor.nanocontracts.nc_exec_logs import NCLogConfig, NCLogStorage
 from hathor.nanocontracts.runner.runner import RunnerFactory
 from hathor.nanocontracts.sorter.types import NCSorterCallable
-from hathor.nanocontracts.tx_storage_proxy import TransactionStorageProxy
 from hathor.p2p.manager import ConnectionsManager
 from hathor.p2p.peer import PrivatePeer
 from hathor.pubsub import PubSubManager
@@ -437,7 +436,7 @@ def _get_or_create_runner_factory(self) -> RunnerFactory:
             self._runner_factory = RunnerFactory(
                 reactor=self._get_reactor(),
                 settings=self._get_or_create_settings(),
-                tx_storage_proxy=TransactionStorageProxy(self._get_or_create_tx_storage()),
+                tx_storage=self._get_or_create_tx_storage(),
                 nc_storage_factory=self._get_or_create_nc_storage_factory(),
             )
         return self._runner_factory

hathor/nanocontracts/runner/runner.py

@@ -122,18 +122,20 @@ class Runner:
     MAX_RECURSION_DEPTH: int = 100
     MAX_CALL_COUNTER: int = 250
 
+    _runtime_version: NanoRuntimeVersion
+
     def __init__(
         self,
         *,
         reactor: ReactorProtocol,
         settings: HathorSettings,
         runtime_version: NanoRuntimeVersion,
-        tx_storage_proxy: NCTransactionStorageProxy,
+        tx_storage: NCTransactionStorageProxy,
         storage_factory: NCStorageFactory,
         block_storage: NCBlockStorage,
         seed: bytes | None,
     ) -> None:
-        self.tx_storage_proxy = tx_storage_proxy
+        self.tx_storage = tx_storage
         self.storage_factory = storage_factory
         self.block_storage = block_storage
         self._storages: dict[ContractId, NCContractStorage] = {}
@@ -1143,7 +1145,7 @@ def _create_blueprint_instance(self, blueprint_id: BlueprintId, changes_tracker:
         """Create a new blueprint instance."""
         assert self._call_info is not None
         env = BlueprintEnvironment(self, self._call_info.nc_logger, changes_tracker)
-        blueprint_class = self.tx_storage_proxy.get_blueprint_class(blueprint_id)
+        blueprint_class = self.tx_storage.get_blueprint_class(blueprint_id)
         return blueprint_class(env)
 
     @_forbid_syscall_from_view('create_deposit_token')
@@ -1270,7 +1272,7 @@ def syscall_change_blueprint(self, blueprint_id: BlueprintId) -> None:
 
         # The blueprint must exist. If an unknown blueprint is provided, it will raise an BlueprintDoesNotExist
         # exception.
-        self.tx_storage_proxy.get_blueprint_class(blueprint_id)
+        self.tx_storage.get_blueprint_class(blueprint_id)
 
         nc_storage = self.get_current_changes_tracker()
         nc_storage.set_blueprint_id(blueprint_id)
@@ -1315,7 +1317,7 @@ def _get_token(self, token_uid: TokenUid) -> TokenDescription:
             )
 
         try:
-            return self.tx_storage_proxy.get_token_description(token_uid)
+            return self.tx_storage.get_token_description(token_uid)
         except TransactionDoesNotExist:
             raise NCInvalidSyscall(
                 f'contract {call_record.contract_id.hex()} could not find {token_uid.hex()} token'
@@ -1445,19 +1447,19 @@ def forbid_call_on_view(self, name: str) -> None:
 
 
 class RunnerFactory:
-    __slots__ = ('reactor', 'settings', 'tx_storage_proxy', 'nc_storage_factory')
+    __slots__ = ('reactor', 'settings', 'tx_storage', 'nc_storage_factory')
 
     def __init__(
         self,
         *,
         reactor: ReactorProtocol,
         settings: HathorSettings,
-        tx_storage_proxy: NCTransactionStorageProxy,
+        tx_storage: NCTransactionStorageProxy,
         nc_storage_factory: NCStorageFactory,
     ) -> None:
         self.reactor = reactor
         self.settings = settings
-        self.tx_storage_proxy = tx_storage_proxy
+        self.tx_storage = tx_storage
         self.nc_storage_factory = nc_storage_factory
 
     def create(
@@ -1471,7 +1473,7 @@ def create(
             reactor=self.reactor,
             settings=self.settings,
             runtime_version=runtime_version,
-            tx_storage_proxy=self.tx_storage_proxy,
+            tx_storage=self.tx_storage,
             storage_factory=self.nc_storage_factory,
             block_storage=block_storage,
             seed=seed,

hathor/nanocontracts/tx_storage_proxy.py

@@ -37,6 +37,7 @@
     TokenCreationTransactionDoesNotExist,
     TransactionDoesNotExist,
     TransactionIsNotABlock,
+    TransactionMetadataDoesNotExist,
     TransactionNotInAllowedScopeError,
 )
 from hathor.transaction.storage.migrations import (
@@ -53,6 +54,7 @@
 from hathor.transaction.transaction_metadata import TransactionMetadata
 from hathor.transaction.vertex_children import VertexChildrenService
 from hathor.types import VertexId
+from hathorlib.token_info import TokenDescription
 
 if TYPE_CHECKING:
     from hathor.conf.settings import HathorSettings
@@ -575,6 +577,30 @@ def get_token_creation_transaction(self, hash_bytes: bytes) -> TokenCreationTran
             raise TokenCreationTransactionDoesNotExist(hash_bytes)
         return tx
 
+    def get_token_description(self, token_uid: bytes) -> TokenDescription:
+        """Get the confirmed token description for `token_uid`.
+
+        :param token_uid: Unique token id to fetch.
+        :raises TransactionDoesNotExist: If the transaction with the given hash does not exist.
+        :raises TokenCreationTransactionDoesNotExist: If the transaction exists but is not a TokenCreationTransaction.
+        :raises TransactionMetadataDoesNotExist: The tx that creates this token has not been confirmed by any block.
+        :return: The TokenCreationTransaction instance.
+        """
+        # Check the transaction storage for existing tokens
+        token_creation_tx = self.get_token_creation_transaction(token_uid)
+
+        if token_creation_tx.get_metadata().first_block is None:
+            raise TransactionMetadataDoesNotExist(
+                f"The {token_uid.hex()} token is not confirmed by any block"
+            )
+
+        return TokenDescription(
+            token_version=token_creation_tx.token_version,
+            token_name=token_creation_tx.token_name,
+            token_symbol=token_creation_tx.token_symbol,
+            token_id=token_creation_tx.hash
+        )
+
     def get_block_by_height(self, height: int) -> Optional[Block]:
         """Return a block in the best blockchain from the height index. This is fast."""
         ancestor_hash = self.indexes.height.get(height)

hathor/transaction/storage/transaction_storage.py

@@ -36,7 +36,6 @@
 from hathor.mining.cpu_mining_service import CpuMiningService
 from hathor.nanocontracts.nc_exec_logs import NCLogStorage
 from hathor.nanocontracts.runner.runner import RunnerFactory
-from hathor.nanocontracts.tx_storage_proxy import TransactionStorageProxy
 from hathor.p2p.manager import ConnectionsManager
 from hathor.p2p.peer import PrivatePeer
 from hathor.p2p.peer_endpoint import PeerEndpoint
@@ -235,7 +234,7 @@ def create_manager(self, reactor: Reactor) -> HathorManager:
         runner_factory = RunnerFactory(
             reactor=reactor,
             settings=settings,
-            tx_storage_proxy=TransactionStorageProxy(tx_storage),
+            tx_storage=tx_storage,
             nc_storage_factory=self.nc_storage_factory,
         )
 

hathor_cli/builder.py

@@ -9,7 +9,6 @@
 from hathor.nanocontracts.nano_runtime_version import NanoRuntimeVersion
 from hathor.nanocontracts.nc_exec_logs import NCLogConfig
 from hathor.nanocontracts.on_chain_blueprint import Code, OnChainBlueprint
-from hathor.nanocontracts.tx_storage_proxy import TransactionStorageProxy
 from hathor.nanocontracts.types import Address, BlueprintId, ContractId, NCAction, TokenUid, VertexId
 from hathor.nanocontracts.vertex_data import BlockData, create_vertex_data_from_vertex
 from hathor.transaction import Transaction, Vertex
@@ -68,7 +67,7 @@ def _get_contract_instance(self, contract_id: ContractId, *, locked: bool) -> Bl
         nc_logger = NCLogger(__reactor__=runner.reactor, __nc_id__=contract_id)
         env = BlueprintEnvironment(runner, nc_logger, contract_storage, disable_cache=True)
         blueprint_id = runner.get_blueprint_id(contract_id)
-        blueprint_class = runner.tx_storage_proxy.get_blueprint_class(blueprint_id)
+        blueprint_class = runner.tx_storage.get_blueprint_class(blueprint_id)
         contract = blueprint_class(env)
         return contract
 
@@ -126,7 +125,7 @@ def _register_blueprint_contents(
     def build_runner(self, runtime_version: NanoRuntimeVersion = NanoRuntimeVersion.V2) -> TestRunner:
         """Create a test runner."""
         return TestRunner(
-            tx_storage_proxy=TransactionStorageProxy(self.manager.tx_storage),
+            tx_storage=self.manager.tx_storage,
             settings=self._settings,
             reactor=self.reactor,
             runtime_version=runtime_version,

hathor_tests/nanocontracts/blueprints/unittest.py

@@ -34,21 +34,21 @@ def __init__(
         self,
         *,
         runtime_version: NanoRuntimeVersion,
-        tx_storage_proxy: NCTransactionStorageProxy,
+        tx_storage: NCTransactionStorageProxy,
         settings: HathorSettings,
         reactor: ReactorProtocol,
         seed: bytes | None = None,
     ) -> None:
         if seed is None:
             seed = b'x' * 32
-        assert isinstance(tx_storage_proxy.storage, TransactionRocksDBStorage)
-        storage_factory = NCRocksDBStorageFactory(tx_storage_proxy.storage._rocksdb_storage)
-        store = RocksDBNodeTrieStore(tx_storage_proxy.storage._rocksdb_storage)
+        assert isinstance(tx_storage, TransactionRocksDBStorage)
+        storage_factory = NCRocksDBStorageFactory(tx_storage._rocksdb_storage)
+        store = RocksDBNodeTrieStore(tx_storage._rocksdb_storage)
         block_trie = PatriciaTrie(store)
         block_storage = NCBlockStorage(block_trie)
         self._runner: Runner = Runner(
             runtime_version=runtime_version,
-            tx_storage_proxy=tx_storage_proxy,
+            tx_storage=tx_storage,
             storage_factory=storage_factory,
             block_storage=block_storage,
             settings=settings,

hathor_tests/nanocontracts/utils.py

@@ -14,14 +14,13 @@
 
 from __future__ import annotations
 
-from typing import Any, Protocol
+from typing import Protocol
 
 from hathorlib.nanocontracts.blueprint import Blueprint
 from hathorlib.nanocontracts.types import BlueprintId, TokenUid
 from hathorlib.token_info import TokenDescription
 
 
 class NCTransactionStorageProxy(Protocol):
-    storage: Any
     def get_blueprint_class(self, blueprint_id: BlueprintId) -> type[Blueprint]: ...
     def get_token_description(self, token_uid: TokenUid) -> TokenDescription: ...