Merge branch 'main' of https://github.com/tcoratger/leanSpec

Author: tcoratger

README.md

@@ -6,8 +6,22 @@ The Lean Ethereum protocol specifications and cryptographic subspecifications.
 
 ### Prerequisites
 
-- Python 3.12 or later
-- [uv](https://github.com/astral-sh/uv) package manager
+#### Installing uv
+
+[uv](https://github.com/astral-sh/uv) is a fast Python package manager that handles dependencies and Python versions.
+
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+````
+
+#### Installing Python 3.12+
+
+This project requires Python 3.12 or later and should be installed via `uv`:
+
+```bash
+# Install Python 3.12, or latest stable version
+uv python install 3.12
+```
 
 ### Setup
 

src/lean_spec/subspecs/containers/state.py

@@ -4,7 +4,7 @@
 from typing_extensions import Annotated
 
 from lean_spec.subspecs.chain import DEVNET_CONFIG
-from lean_spec.types import Bytes32, StrictBaseModel, Uint64
+from lean_spec.types import Bytes32, StrictBaseModel, Uint64, ValidatorIndex
 
 from .block import BlockHeader
 from .checkpoint import Checkpoint
@@ -62,3 +62,7 @@ class State(StrictBaseModel):
         ),
     ]
     """A bitlist of validators who participated in justifications."""
+
+    def is_proposer(self, validator_index: ValidatorIndex) -> bool:
+        """Check if a validator is the proposer for the current slot."""
+        return self.slot % self.config.num_validators == validator_index

src/lean_spec/types/__init__.py

@@ -4,10 +4,12 @@
 from .basispt import BasisPoint
 from .hash import Bytes32
 from .uint64 import Uint64
+from .validator import ValidatorIndex
 
 __all__ = [
     "Uint64",
     "BasisPoint",
     "Bytes32",
     "StrictBaseModel",
+    "ValidatorIndex",
 ]

src/lean_spec/types/validator.py

@@ -0,0 +1,6 @@
+"""Validator-related type definitions for the specification."""
+
+from .uint64 import Uint64
+
+ValidatorIndex = Uint64
+"""A type alias for a validator's index in the registry."""

tests/lean_spec/subspecs/containers/test_state.py

@@ -0,0 +1,81 @@
+"""
+Tests for the State container.
+"""
+
+import pytest
+
+from lean_spec.subspecs.containers import (
+    BlockHeader,
+    Checkpoint,
+    Config,
+    State,
+)
+from lean_spec.types import Bytes32, Uint64, ValidatorIndex
+
+
+@pytest.fixture
+def sample_config() -> Config:
+    """A sample configuration with 10 validators."""
+    return Config(num_validators=10, genesis_time=0)
+
+
+@pytest.fixture
+def sample_block_header() -> BlockHeader:
+    """A sample, empty block header."""
+    return BlockHeader(
+        slot=0,
+        proposer_index=0,
+        parent_root=Bytes32(b"\x00" * 32),
+        state_root=Bytes32(b"\x00" * 32),
+        body_root=Bytes32(b"\x00" * 32),
+    )
+
+
+@pytest.fixture
+def sample_checkpoint() -> Checkpoint:
+    """A sample, empty checkpoint."""
+    return Checkpoint(root=Bytes32(b"\x00" * 32), slot=0)
+
+
+def test_is_proposer(
+    sample_config: Config,
+    sample_block_header: BlockHeader,
+    sample_checkpoint: Checkpoint,
+) -> None:
+    """
+    Test the `is_proposer` method with various slots and validator indices.
+    """
+
+    def create_state_at_slot(slot: int) -> State:
+        """Create a state object at a given slot."""
+        return State(
+            config=sample_config,
+            slot=Uint64(slot),
+            latest_block_header=sample_block_header,
+            latest_justified=sample_checkpoint,
+            latest_finalized=sample_checkpoint,
+            historical_block_hashes=[],
+            justified_slots=[],
+            justifications_roots=[],
+            justifications_validators=[],
+        )
+
+    # Slot 0
+    state_slot_0 = create_state_at_slot(0)
+    assert state_slot_0.is_proposer(ValidatorIndex(0)) is True
+    assert state_slot_0.is_proposer(ValidatorIndex(1)) is False
+
+    # Slot 7
+    state_slot_7 = create_state_at_slot(7)
+    assert state_slot_7.is_proposer(ValidatorIndex(7)) is True
+    assert state_slot_7.is_proposer(ValidatorIndex(8)) is False
+
+    # Slot 10 (wraps around)
+    state_slot_10 = create_state_at_slot(10)
+    assert state_slot_10.is_proposer(ValidatorIndex(0)) is True
+    assert state_slot_10.is_proposer(ValidatorIndex(1)) is False
+
+    # Slot 23 (wraps around)
+    state_slot_23 = create_state_at_slot(23)
+    assert state_slot_23.is_proposer(ValidatorIndex(3)) is True
+    assert state_slot_23.is_proposer(ValidatorIndex(2)) is False

tox.ini

@@ -5,7 +5,12 @@ env_list =
     docs
 skip_missing_interpreters = true
 
+[testenv]
+basepython = python3
+uv_python = >=3.12
+
 [testenv:all-checks]
+base_python = python3.12
 description = Run all quality checks (lint, typecheck, spellcheck)
 extras =
     lint