refactor(settings): refactor genesis module

Author: glevco

hathor/builder/cli_builder.py

@@ -31,7 +31,7 @@
 from hathor.manager import HathorManager
 from hathor.p2p.manager import ConnectionsManager
 from hathor.p2p.peer_id import PeerId
-from hathor.p2p.utils import discover_hostname
+from hathor.p2p.utils import discover_hostname, get_genesis_short_hash
 from hathor.pubsub import PubSubManager
 from hathor.stratum import StratumFactory
 from hathor.util import Random, Reactor
@@ -64,7 +64,6 @@ def create_manager(self, reactor: Reactor) -> HathorManager:
         from hathor.p2p.netfilter.utils import add_peer_id_blacklist
         from hathor.p2p.peer_discovery import BootstrapPeerDiscovery, DNSPeerDiscovery
         from hathor.storage import RocksDBStorage
-        from hathor.transaction import genesis
         from hathor.transaction.storage import (
             TransactionCacheStorage,
             TransactionMemoryStorage,
@@ -89,7 +88,7 @@ def create_manager(self, reactor: Reactor) -> HathorManager:
             'hathor-core v{hathor}',
             hathor=hathor.__version__,
             pid=os.getpid(),
-            genesis=genesis.GENESIS_HASH.hex()[:7],
+            genesis=get_genesis_short_hash(),
             my_peer_id=str(peer_id.id),
             python=python,
             platform=platform.platform(),

hathor/indexes/base_index.py

@@ -17,6 +17,7 @@
 
 from structlog import get_logger
 
+from hathor.conf.get_settings import get_settings
 from hathor.indexes.scope import Scope
 from hathor.transaction.base_transaction import BaseTransaction
 
@@ -33,6 +34,7 @@ class BaseIndex(ABC):
     created to generalize how we initialize indexes and keep track of which ones are up-to-date.
     """
     def __init__(self) -> None:
+        self._settings = get_settings()
         self.log = logger.new()
 
     def init_start(self, indexes_manager: 'IndexesManager') -> None:

hathor/indexes/height_index.py

@@ -18,7 +18,6 @@
 from hathor.indexes.base_index import BaseIndex
 from hathor.indexes.scope import Scope
 from hathor.transaction import BaseTransaction, Block
-from hathor.transaction.genesis import BLOCK_GENESIS
 from hathor.types import VertexId
 from hathor.util import not_none
 
@@ -41,9 +40,6 @@ class HeightInfo(NamedTuple):
     id: VertexId
 
 
-BLOCK_GENESIS_ENTRY: IndexEntry = IndexEntry(not_none(BLOCK_GENESIS.hash), BLOCK_GENESIS.timestamp)
-
-
 class _AddToIndexItem(NamedTuple):
     height: int
     hash: bytes
@@ -54,6 +50,13 @@ class HeightIndex(BaseIndex):
     """Store the block hash for each given height
     """
 
+    def get_genesis_block_entry(self) -> IndexEntry:
+        """Return the index entry for the genesis block."""
+        return IndexEntry(
+            self._settings.GENESIS_BLOCK_HASH,
+            self._settings.GENESIS_TIMESTAMP
+        )
+
     def get_scope(self) -> Scope:
         return SCOPE
 

hathor/indexes/memory_height_index.py

@@ -14,7 +14,7 @@
 
 from typing import Optional
 
-from hathor.indexes.height_index import BLOCK_GENESIS_ENTRY, HeightIndex, HeightInfo, IndexEntry
+from hathor.indexes.height_index import HeightIndex, HeightInfo, IndexEntry
 
 
 class MemoryHeightIndex(HeightIndex):
@@ -31,7 +31,7 @@ def get_db_name(self) -> Optional[str]:
         return None
 
     def force_clear(self) -> None:
-        self._index = [BLOCK_GENESIS_ENTRY]
+        self._index = [self.get_genesis_block_entry()]
 
     def _add(self, height: int, block_hash: bytes, timestamp: int, *, can_reorg: bool) -> None:
         if len(self._index) < height:

hathor/indexes/memory_info_index.py

@@ -23,6 +23,7 @@
 
 class MemoryInfoIndex(InfoIndex):
     def __init__(self):
+        super().__init__()
         self._block_count = 0
         self._tx_count = 0
         self._first_timestamp = 0
@@ -35,11 +36,11 @@ def get_db_name(self) -> Optional[str]:
         return None
 
     def force_clear(self) -> None:
-        from hathor.transaction.genesis import BLOCK_GENESIS, TX_GENESIS2
+        from hathor.transaction.genesis import get_genesis_block, get_genesis_tx2
         self._block_count = 1
         self._tx_count = 2
-        self._first_timestamp = BLOCK_GENESIS.timestamp
-        self._latest_timestamp = TX_GENESIS2.timestamp
+        self._first_timestamp = get_genesis_block(self._settings).timestamp
+        self._latest_timestamp = get_genesis_tx2(self._settings).timestamp
 
     def update_timestamps(self, tx: BaseTransaction) -> None:
         if tx.is_genesis:

hathor/indexes/rocksdb_height_index.py

@@ -16,7 +16,7 @@
 
 from structlog import get_logger
 
-from hathor.indexes.height_index import BLOCK_GENESIS_ENTRY, HeightIndex, HeightInfo, IndexEntry
+from hathor.indexes.height_index import HeightIndex, HeightInfo, IndexEntry
 from hathor.indexes.rocksdb_utils import RocksDBIndexUtils
 
 if TYPE_CHECKING:  # pragma: no cover
@@ -44,6 +44,7 @@ class RocksDBHeightIndex(HeightIndex, RocksDBIndexUtils):
 
     def __init__(self, db: 'rocksdb.DB', *, cf_name: Optional[bytes] = None) -> None:
         self.log = logger.new()
+        HeightIndex.__init__(self)
         RocksDBIndexUtils.__init__(self, db, cf_name or _CF_NAME_HEIGHT_INDEX)
 
     def get_db_name(self) -> Optional[str]:
@@ -56,7 +57,7 @@ def force_clear(self) -> None:
     def _init_db(self) -> None:
         """ Initialize the database with the genesis entry."""
         key_genesis = self._to_key(0)
-        value_genesis = self._to_value(BLOCK_GENESIS_ENTRY)
+        value_genesis = self._to_value(self.get_genesis_block_entry())
         self._db.put((self._cf, key_genesis), value_genesis)
 
     def _to_key(self, height: int) -> bytes:

hathor/p2p/utils.py

@@ -31,7 +31,7 @@
 from hathor.conf.get_settings import get_settings
 from hathor.indexes.height_index import HeightInfo
 from hathor.p2p.peer_discovery import DNSPeerDiscovery
-from hathor.transaction.genesis import GENESIS_HASH
+from hathor.transaction.genesis import get_genesis_hash
 
 
 def discover_hostname() -> Optional[str]:
@@ -75,7 +75,8 @@ def description_to_connection_string(description: str) -> tuple[str, Optional[st
 def get_genesis_short_hash() -> str:
     """ Return the first 7 chars of the GENESIS_HASH used for validation that the genesis are the same
     """
-    return GENESIS_HASH.hex()[:7]
+    settings = get_settings()
+    return get_genesis_hash(settings).hex()[:7]
 
 
 def get_settings_hello_dict() -> dict[str, Any]:

hathor/simulator/simulator.py

@@ -28,7 +28,6 @@
 from hathor.simulator.clock import HeapClock, MemoryReactorHeapClock
 from hathor.simulator.miner.geometric_miner import GeometricMiner
 from hathor.simulator.tx_generator import RandomTransactionGenerator
-from hathor.transaction.genesis import _get_genesis_transactions_unsafe
 from hathor.util import Random
 from hathor.wallet import HDWallet
 
@@ -128,7 +127,7 @@ def start(self) -> None:
         assert not self._started
         self._started = True
         self._patches_rc_increment()
-        first_timestamp = min(tx.timestamp for tx in _get_genesis_transactions_unsafe(None))
+        first_timestamp = self.settings.GENESIS_TIMESTAMP
         dt = self.rng.randint(3600, 120 * 24 * 3600)
         self._clock.advance(first_timestamp + dt)
         self.log.debug('randomized step: clock advance start', dt=dt)

hathor/transaction/base_transaction.py

@@ -357,7 +357,7 @@ def is_genesis(self) -> bool:
         if self.hash is None:
             return False
         from hathor.transaction.genesis import is_genesis
-        return is_genesis(self.hash)
+        return is_genesis(self.hash, settings=self._settings)
 
     @abstractmethod
     def get_funds_fields_from_struct(self, buf: bytes, *, verbose: VerboseCallback = None) -> bytes:

hathor/transaction/genesis.py

@@ -12,71 +12,75 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import TYPE_CHECKING, Optional
+from typing import TYPE_CHECKING
 
-from hathor.conf import HathorSettings
+from hathor.conf.settings import HathorSettings
 from hathor.transaction import BaseTransaction, Block, Transaction, TxOutput
 
 if TYPE_CHECKING:
     from hathor.transaction.storage import TransactionStorage  # noqa: F401
 
-settings = HathorSettings()
 
-BLOCK_GENESIS = Block(
-    hash=settings.GENESIS_BLOCK_HASH,
-    nonce=settings.GENESIS_BLOCK_NONCE,
-    timestamp=settings.GENESIS_TIMESTAMP,
-    weight=settings.MIN_BLOCK_WEIGHT,
-    outputs=[
-        TxOutput(settings.GENESIS_TOKENS, settings.GENESIS_OUTPUT_SCRIPT),
-    ],
-)
-
-TX_GENESIS1 = Transaction(
-    hash=settings.GENESIS_TX1_HASH,
-    nonce=settings.GENESIS_TX1_NONCE,
-    timestamp=settings.GENESIS_TIMESTAMP + 1,
-    weight=settings.MIN_TX_WEIGHT,
-)
-
-TX_GENESIS2 = Transaction(
-    hash=settings.GENESIS_TX2_HASH,
-    nonce=settings.GENESIS_TX2_NONCE,
-    timestamp=settings.GENESIS_TIMESTAMP + 2,
-    weight=settings.MIN_TX_WEIGHT,
-)
-
-GENESIS = [BLOCK_GENESIS, TX_GENESIS1, TX_GENESIS2]
-
-GENESIS_HASHES = [settings.GENESIS_BLOCK_HASH, settings.GENESIS_TX1_HASH, settings.GENESIS_TX2_HASH]
-
-
-def _get_genesis_hash() -> bytes:
+def get_genesis_block(settings: HathorSettings) -> Block:
+    """Return the genesis block."""
+    return Block(
+        hash=settings.GENESIS_BLOCK_HASH,
+        nonce=settings.GENESIS_BLOCK_NONCE,
+        timestamp=settings.GENESIS_TIMESTAMP,
+        weight=settings.MIN_BLOCK_WEIGHT,
+        outputs=[
+            TxOutput(settings.GENESIS_TOKENS, settings.GENESIS_OUTPUT_SCRIPT),
+        ],
+    )
+
+
+def get_genesis_tx1(settings: HathorSettings) -> Transaction:
+    """Return the genesis tx1."""
+    return Transaction(
+        hash=settings.GENESIS_TX1_HASH,
+        nonce=settings.GENESIS_TX1_NONCE,
+        timestamp=settings.GENESIS_TIMESTAMP + 1,
+        weight=settings.MIN_TX_WEIGHT,
+    )
+
+
+def get_genesis_tx2(settings: HathorSettings) -> Transaction:
+    """Return the genesis tx2."""
+    return Transaction(
+        hash=settings.GENESIS_TX2_HASH,
+        nonce=settings.GENESIS_TX2_NONCE,
+        timestamp=settings.GENESIS_TIMESTAMP + 2,
+        weight=settings.MIN_TX_WEIGHT,
+    )
+
+
+def get_all_genesis(settings: HathorSettings) -> list[BaseTransaction]:
+    """Return all genesis vertices."""
+    return [
+        get_genesis_block(settings),
+        get_genesis_tx1(settings),
+        get_genesis_tx2(settings)
+    ]
+
+
+def get_all_genesis_hashes(settings: HathorSettings) -> list[bytes]:
+    """Return all genesis hashes."""
+    return [
+        settings.GENESIS_BLOCK_HASH,
+        settings.GENESIS_TX1_HASH,
+        settings.GENESIS_TX2_HASH
+    ]
+
+
+def get_genesis_hash(settings: HathorSettings) -> bytes:
+    """Return a single hash representing all genesis."""
     import hashlib
     h = hashlib.sha256()
-    for tx in GENESIS:
-        tx_hash = tx.hash
-        assert tx_hash is not None
+    for tx_hash in get_all_genesis_hashes(settings):
         h.update(tx_hash)
     return h.digest()
 
 
-GENESIS_HASH = _get_genesis_hash()
-
-
-def _get_genesis_transactions_unsafe(tx_storage: Optional['TransactionStorage']) -> list[BaseTransaction]:
-    """You shouldn't get genesis directly. Please, get it from your storage instead."""
-    genesis = []
-    for tx in GENESIS:
-        tx2 = tx.clone()
-        tx2.storage = tx_storage
-        genesis.append(tx2)
-    return genesis
-
-
-def is_genesis(hash_bytes: bytes) -> bool:
+def is_genesis(hash_bytes: bytes, *, settings: HathorSettings) -> bool:
     """Check whether hash is from a genesis transaction."""
-    for tx in GENESIS:
-        if hash_bytes == tx.hash:
-            return True
-    return False
+    return hash_bytes in get_all_genesis_hashes(settings)

hathor/transaction/storage/transaction_storage.py

@@ -320,8 +320,11 @@ def _save_or_verify_genesis(self) -> None:
 
     def _get_genesis_from_settings(self) -> list[BaseTransaction]:
         """Return all genesis from settings."""
-        from hathor.transaction.genesis import _get_genesis_transactions_unsafe
-        return _get_genesis_transactions_unsafe(self)
+        from hathor.transaction.genesis import get_all_genesis
+        all_genesis = get_all_genesis(self._settings)
+        for tx in all_genesis:
+            tx.storage = self
+        return all_genesis
 
     def _save_to_weakref(self, tx: BaseTransaction) -> None:
         """ Save transaction to weakref.

hathor/transaction/transaction_metadata.py

@@ -15,6 +15,7 @@
 from collections import defaultdict
 from typing import TYPE_CHECKING, Any, Optional
 
+from hathor.conf.get_settings import get_settings
 from hathor.feature_activation.feature import Feature
 from hathor.feature_activation.model.feature_state import FeatureState
 from hathor.transaction.validation_state import ValidationState
@@ -127,8 +128,10 @@ def __init__(
 
         self.feature_activation_bit_counts = feature_activation_bit_counts
 
+        settings = get_settings()
+
         # Genesis specific:
-        if hash is not None and is_genesis(hash):
+        if hash is not None and is_genesis(hash, settings=settings):
             self.validation = ValidationState.FULL
 
     def get_tx(self) -> 'BaseTransaction':
@@ -248,10 +251,8 @@ def to_json_extended(self, tx_storage: 'TransactionStorage') -> dict[str, Any]:
 
     @classmethod
     def create_from_json(cls, data: dict[str, Any]) -> 'TransactionMetadata':
-        from hathor.transaction.genesis import is_genesis
-
-        meta = cls()
-        meta.hash = bytes.fromhex(data['hash']) if data['hash'] else None
+        hash_ = bytes.fromhex(data['hash']) if data['hash'] else None
+        meta = cls(hash=hash_)
         for idx, hashes in data['spent_outputs']:
             for h_hex in hashes:
                 meta.spent_outputs[idx].append(bytes.fromhex(h_hex))
@@ -293,9 +294,6 @@ def create_from_json(cls, data: dict[str, Any]) -> 'TransactionMetadata':
         _val_name = data.get('validation', None)
         meta.validation = ValidationState.from_name(_val_name) if _val_name is not None else ValidationState.INITIAL
 
-        if meta.hash is not None and is_genesis(meta.hash):
-            meta.validation = ValidationState.FULL
-
         return meta
 
     def clone(self) -> 'TransactionMetadata':

tests/p2p/test_split_brain.py

@@ -14,9 +14,8 @@ class BaseHathorSyncMethodsTestCase(unittest.TestCase):
 
     def setUp(self):
         super().setUp()
-        from hathor.transaction.genesis import _get_genesis_transactions_unsafe
 
-        first_timestamp = min(tx.timestamp for tx in _get_genesis_transactions_unsafe(None))
+        first_timestamp = self._settings.GENESIS_TIMESTAMP
         self.clock.advance(first_timestamp + self.rng.randint(3600, 120*24*3600))
 
         self.network = 'testnet'

tests/resources/wallet/test_thin_wallet.py

@@ -275,7 +275,7 @@ def test_error_request(self):
 
         resource = SendTokensResource(self.manager)
         request = TestDummyRequest('POST', 'thin_wallet/send_tokens', {})
-        dummy_tx = genesis.BLOCK_GENESIS
+        dummy_tx = genesis.get_genesis_block(self._settings)
 
         self.assertIsNotNone(request._finishedDeferreds)
         resource._err_tx_resolve('Error', _Context(tx=dummy_tx, request=request), 'error')