Merge pull request #186 from thenewboston-developers/BC-189-pv-notifies-pvs

filter_by_roles()

Author: dmugtasimov

node/blockchain/facade.py

@@ -127,11 +127,11 @@ def has_blocks():
     def get_last_block():
         return get_block_model().objects.get_last_block()
 
-    def get_next_block_number(self) -> int:
+    @staticmethod
+    def get_next_block_number() -> int:
         # TODO(dmu) HIGH: Implement method via write-through cache
         #                 https://thenewboston.atlassian.net/browse/BC-175
-        last_block = self.get_last_block()
-        return last_block._id + 1 if last_block else 0
+        return get_block_model().objects.get_next_block_number()
 
     def get_next_block_identifier(self) -> Optional[BlockIdentifier]:
         # TODO(dmu) HIGH: Implement method via write-through cache
@@ -239,7 +239,7 @@ def get_primary_validator(self) -> Optional[Node]:
         """
         from node.blockchain.models import Schedule
 
-        schedule = Schedule.objects.filter(_id__lte=self.get_next_block_number()).order_by('-_id').first()
+        schedule = Schedule.objects.get_schedule_for_next_block()
         if not schedule:
             logger.warning('Schedule for the next block was not found')
             return None

node/blockchain/models/block.py

@@ -14,6 +14,10 @@ def create(self, *args, **kwargs):
     def get_last_block(self):
         return self.order_by('-_id').first()
 
+    def get_next_block_number(self):
+        last_block = self.get_last_block()
+        return last_block._id + 1 if last_block else 0
+
 
 class Block(CustomModel):
     _id = models.PositiveBigIntegerField('Block number', primary_key=True)

node/blockchain/models/node.py

@@ -1,12 +1,54 @@
+from typing import Collection
+
 from djongo.models.fields import DjongoManager
 
 from node.blockchain.inner_models import Node as PydanticNode
+from node.blockchain.types import NodeRole
 from node.core.managers import CustomQuerySet
 
 from .account_state import AccountState
 
+NODE_ROLES = set(NodeRole)
+
+
+class NodeQuerySet(CustomQuerySet):
+
+    def filter_by_roles(self, roles: Collection[NodeRole]):
+        # self.annotate() does not work with Djongo
+        roles = set(roles or ())
+        if not roles or set(roles) == NODE_ROLES:
+            return self
+
+        from node.blockchain.models import Schedule
+
+        assert {NodeRole.REGULAR_NODE, NodeRole.CONFIRMATION_VALIDATOR, NodeRole.PRIMARY_VALIDATOR} == NODE_ROLES
+
+        next_block_schedule = Schedule.objects.get_schedule_for_next_block()
+        primary_validator_identifier = next_block_schedule.node_identifier if next_block_schedule else None
+        validator_identifiers = {item.node_identifier for item in Schedule.objects.all().order_by('_id')}
+        if NodeRole.REGULAR_NODE in roles:
+            if NodeRole.PRIMARY_VALIDATOR in roles:
+                if NodeRole.CONFIRMATION_VALIDATOR in roles:
+                    raise AssertionError('Should have exited on previous shortcut guard condition')
+                else:  # regular and primary validator
+                    return self.exclude(_id__in=validator_identifiers - {primary_validator_identifier})
+            elif NodeRole.CONFIRMATION_VALIDATOR in roles:  # regular and confirmation
+                return self.exclude(_id=primary_validator_identifier)
+            else:  # only regular
+                return self.exclude(_id__in=validator_identifiers)
+
+        if NodeRole.PRIMARY_VALIDATOR in roles:
+            if NodeRole.CONFIRMATION_VALIDATOR in roles:  # only all validators
+                return self.filter(_id__in=validator_identifiers)
+            else:  # only primary validator
+                return self.filter(_id=primary_validator_identifier)
+        elif NodeRole.CONFIRMATION_VALIDATOR in roles:  # only confirmation validators
+            return self.filter(_id__in=validator_identifiers - {primary_validator_identifier})
+
+        raise AssertionError('Should have exited on previous shortcut guard condition')
+
 
-class NodeManager(DjongoManager.from_queryset(CustomQuerySet)):  # type: ignore
+class NodeManager(DjongoManager.from_queryset(NodeQuerySet)):  # type: ignore
 
     def get_queryset(self):
         return super().get_queryset().filter(node__isnull=False)

node/blockchain/models/schedule.py

@@ -1,9 +1,28 @@
 from djongo import models
+from djongo.models.fields import DjongoManager
 
 from node.blockchain.validators import HexStringValidator
+from node.core.managers import CustomQuerySet
 from node.core.models import CustomModel
 
 
+class ScheduleQuerySet(CustomQuerySet):
+
+    def get_schedule_for_next_block(self):
+        from .block import Block
+        next_block = Block.objects.get_next_block_number()
+        return self.filter(_id__lte=next_block).order_by('-_id').first()
+
+
+class ScheduleManager(DjongoManager.from_queryset(ScheduleQuerySet)):  # type: ignore
+    pass
+
+
 class Schedule(CustomModel):
     _id = models.PositiveBigIntegerField('Block number', primary_key=True)
     node_identifier = models.CharField(max_length=64, validators=(HexStringValidator(64),), blank=False)
+
+    objects = ScheduleManager()
+
+    def __str__(self):
+        return f'{self._id}: {self.node_identifier}'

node/blockchain/tasks/process_pending_blocks.py

@@ -1,8 +1,8 @@
 from celery import shared_task
 
 
-@shared_task(bind=True)
-def process_pending_blocks_task(self):
+@shared_task
+def process_pending_blocks_task():
     # TODO(dmu) CRITICAL: Process pending blocks. To be implemented in
     #                     https://thenewboston.atlassian.net/browse/BC-263
     pass

node/blockchain/tasks/send_new_block.py

@@ -0,0 +1,15 @@
+from celery import shared_task
+
+
+@shared_task
+def send_new_block_to_node_task():
+    raise NotImplementedError
+
+
+@shared_task
+def send_new_block_task(block_number):
+    raise NotImplementedError
+
+
+def start_send_new_block_task():
+    send_new_block_task.delay()

node/blockchain/tests/factories/signed_change_request/pv_schedule_update.py

@@ -0,0 +1,19 @@
+from node.blockchain.inner_models import PVScheduleUpdateSignedChangeRequest
+from node.blockchain.types import AccountNumber, KeyPair
+from node.core.utils.types import non_negative_intstr
+
+from ..signed_change_request_message.pv_schedule_update import make_pv_schedule_update_signed_change_request_message
+
+
+def make_pv_schedule_update_signed_change_request(
+    schedule: dict[non_negative_intstr, AccountNumber], primary_validator_key_pair: KeyPair
+) -> PVScheduleUpdateSignedChangeRequest:
+    signed_change_request = PVScheduleUpdateSignedChangeRequest.create_from_signed_change_request_message(
+        message=make_pv_schedule_update_signed_change_request_message(schedule, primary_validator_key_pair.public),
+        signing_key=primary_validator_key_pair.private,  # only PV can sign such requests
+    )
+    assert signed_change_request.message
+    assert signed_change_request.signer
+    assert signed_change_request.signature
+
+    return signed_change_request

node/blockchain/tests/factories/signed_change_request_message/pv_schedule_update.py

@@ -1,12 +1,12 @@
 from node.blockchain.facade import BlockchainFacade
-from node.blockchain.inner_models import Node
 from node.blockchain.inner_models.signed_change_request_message import PVScheduleUpdateSignedChangeRequestMessage
+from node.blockchain.types import AccountNumber
+from node.core.utils.types import non_negative_intstr
 
 
-def make_pv_schedule_update_signed_change_request_message(node: Node) -> PVScheduleUpdateSignedChangeRequestMessage:
+def make_pv_schedule_update_signed_change_request_message(
+    schedule: dict[non_negative_intstr, AccountNumber], signer
+) -> PVScheduleUpdateSignedChangeRequestMessage:
     return PVScheduleUpdateSignedChangeRequestMessage(
-        schedule={
-            '1': node.identifier,
-        },
-        account_lock=BlockchainFacade.get_instance().get_account_lock(node.identifier),
+        schedule=schedule, account_lock=BlockchainFacade.get_instance().get_account_lock(signer)
     )

node/blockchain/tests/fixtures/account.py

@@ -20,6 +20,14 @@ def primary_validator_key_pair() -> KeyPair:
     )
 
 
+@pytest.fixture
+def confirmation_validator_key_pair() -> KeyPair:
+    return KeyPair(
+        public=AccountNumber('d171de280d593efc740e4854ee2d2bd658cd1deb967eb51a02b89c6e636f46e1'),
+        private=SigningKey('cd4c6388fcf3fe01ca5f2fcd902a6a5ed98a312674b3a330057742dcd95afd80'),
+    )
+
+
 @pytest.fixture
 def regular_node_key_pair() -> KeyPair:
     return KeyPair(

node/blockchain/tests/fixtures/blockchain.py

@@ -5,6 +5,9 @@
 from node.blockchain.tests.factories.signed_change_request.node_declaration import (
     make_node_declaration_signed_change_request
 )
+from node.blockchain.tests.factories.signed_change_request.pv_schedule_update import (
+    make_pv_schedule_update_signed_change_request
+)
 from node.core.utils.cryptography import generate_key_pair
 
 
@@ -21,8 +24,10 @@ def base_blockchain(genesis_block_message, primary_validator_key_pair, db):
 def rich_blockchain(
     base_blockchain,
     primary_validator_key_pair,
+    confirmation_validator_key_pair,
     regular_node_declaration_signed_change_request,
     self_node_declaration_signed_change_request,
+    confirmation_validator_declaration_signed_change_request,
 ):
     blockchain_facade = BlockchainFacade.get_instance()
 
@@ -37,6 +42,22 @@ def rich_blockchain(
         signing_key=primary_validator_key_pair.private,
         validate=False,
     )
+
+    blockchain_facade.add_block_from_signed_change_request(
+        signed_change_request=confirmation_validator_declaration_signed_change_request,
+        signing_key=primary_validator_key_pair.private,
+        validate=False,
+    )
+
+    blockchain_facade.add_block_from_signed_change_request(
+        signed_change_request=make_pv_schedule_update_signed_change_request({
+            '0': primary_validator_key_pair.public,
+            '10000': confirmation_validator_key_pair.public,
+        }, primary_validator_key_pair),
+        signing_key=primary_validator_key_pair.private,
+        validate=False,
+    )
+
     # TODO(dmu) MEDIUM: Add more blocks as new block types are developed