feat: add protocol and network info to minimal conditions

Resolves #2 on GitHub

Co-Authored-by: RoseLabs <admin@roselabs.mx>

Author: janezicmatej

configuration/config.py

@@ -42,6 +42,33 @@ def all(cls):
         return [cls.COSTON, cls.SONGBIRD, cls.COSTON2, cls.FLARE]
 
 
+class ProtocolId(int):
+    pass
+
+
+class Protocol:
+    FTSO = ProtocolId(100)
+    FDC = ProtocolId(200)
+    # NOTE:(janezicmatej) FSP only uses 1 byte for protocol id so we can use numbers
+    # larger than 256 without worry
+    FAST_UPDATES = ProtocolId(300)
+    STAKING = ProtocolId(400)
+
+    @classmethod
+    def id_to_name(cls, protocol: ProtocolId):
+        match protocol:
+            case cls.FTSO:
+                return "ftso"
+            case cls.FDC:
+                return "fdc"
+            case cls.FAST_UPDATES:
+                return "fast updates"
+            case cls.STAKING:
+                return "staking"
+            case _:
+                raise ValueError(f"Unknown protocol ({protocol=})")
+
+
 class ConfigError(Exception):
     pass
 

observer/message.py

@@ -6,7 +6,7 @@
 from attrs import define, frozen
 from py_flare_common.fsp.epoch.epoch import VotingEpoch
 
-from configuration.config import ChainId
+from configuration.config import ChainId, Protocol, ProtocolId
 
 
 class MessageLevel(enum.Enum):
@@ -34,7 +34,7 @@ class MessageBuilder:
 
     network: int | None = None
     round: VotingEpoch | None = None
-    protocol: int | None = None
+    protocol: ProtocolId | None = None
 
     def copy(self) -> Self:
         return copy.copy(self)
@@ -53,9 +53,7 @@ def _build(self) -> Message:
             s.write(f"round:{self.round.id} ")
 
         if self.protocol is not None:
-            # TODO:(matej) make an enum like class like ChainId
-            assert self.protocol in [100, 200]
-            protocol = "ftso" if self.protocol == 100 else "fdc"
+            protocol = Protocol.id_to_name(self.protocol)
             s.write(f"protocol:{protocol} ")
 
         s.write(self.message)
@@ -72,7 +70,7 @@ def add(
         level: MessageLevel | None = None,
         network: int | None = None,
         round: VotingEpoch | None = None,
-        protocol: int | None = None,
+        protocol: ProtocolId | None = None,
         message: str | None = None,
     ) -> Self:
         if level is not None:

observer/observer.py

@@ -411,7 +411,11 @@ async def observer_loop(config: Configuration) -> None:
         config.contracts.Submission.functions["submit2"].signature: "submit2",
     }
 
-    minimal_conditions = MinimalConditions().for_reward_epoch(reward_epoch.id)
+    minimal_conditions = (
+        MinimalConditions()
+        .for_network(config.chain_id)
+        .for_reward_epoch(reward_epoch.id)
+    )
     last_minimal_conditions_check = int(time.time())
     last_ping = time.time()
 

observer/validation/minimal_conditions.py

@@ -6,6 +6,7 @@
 from attrs import frozen
 from py_flare_common.ftso.median import FtsoMedian
 
+from configuration.config import Protocol
 from observer.fast_updates_manager import FastUpdatesManager
 from observer.message import Message, MessageLevel
 from observer.reward_epoch_manager import Entity
@@ -30,6 +31,12 @@ class MinimalConditions:
 
     time_period: Interval = Interval.LAST_2_HOURS
 
+    network: int | None = None
+
+    def for_network(self, network: int) -> Self:
+        self.network = network
+        return self
+
     def for_reward_epoch(self, rid: int) -> Self:
         self.reward_epoch_id = rid
         return self
@@ -41,7 +48,7 @@ def set_time_interval(self, interval: Interval) -> Self:
     def calculate_ftso_anchor_feeds(
         self, medians: deque[list[FtsoMedian]], votes: deque[list[int | None]]
     ) -> Sequence[Message]:
-        mb = Message.builder()
+        mb = Message.builder().add(network=self.network, protocol=Protocol.FTSO)
         messages = []
 
         total, total_hit = 0, 0
@@ -86,7 +93,7 @@ def calculate_ftso_anchor_feeds(
     def calculate_ftso_block_latency_feeds(
         self, entity: Entity, spm: SigningPolicyManager, fum: FastUpdatesManager
     ) -> Sequence[Message]:
-        mb = Message.builder()
+        mb = Message.builder().add(network=self.network, protocol=Protocol.FAST_UPDATES)
         messages = []
         previous_total_active_weight = sum(
             [e.normalized_weight for e in spm.previous_policy.entities]
@@ -168,7 +175,7 @@ def calculate_ftso_block_latency_feeds(
     def calculate_staking(
         self, uptime_checks: int, node_connections: dict[str, deque]
     ) -> Sequence[Message]:
-        mb = Message.builder()
+        mb = Message.builder().add(network=self.network, protocol=Protocol.STAKING)
         messages = []
         for node in node_connections:
             if (
@@ -188,7 +195,7 @@ def calculate_staking(
         return messages
 
     def calculate_fdc_participation(self, signatures: deque[bool]) -> Sequence[Message]:
-        mb = Message.builder()
+        mb = Message.builder().add(network=self.network, protocol=Protocol.FDC)
         messages = []
         if (
             len(signatures) > 0

observer/validation/validation.py

@@ -10,6 +10,7 @@
     SubmitSignatures,
 )
 
+from configuration.config import Protocol
 from configuration.types import Configuration
 
 from ..message import Message
@@ -62,7 +63,7 @@ def validate_round(
     mb_ftso = Message.builder().add(
         network=config.chain_id,
         round=round.voting_epoch,
-        protocol=100,
+        protocol=Protocol.FTSO,
     )
     extracted_ftso = extract_round_for_entity(round.ftso, entity, round.voting_epoch)
 
@@ -91,7 +92,7 @@ def validate_round(
     mb_fdc = Message.builder().add(
         network=config.chain_id,
         round=round.voting_epoch,
-        protocol=200,
+        protocol=Protocol.FDC,
     )
     extracted_fdc = extract_round_for_entity(round.fdc, entity, round.voting_epoch)