Implementing logic

README.md

@@ -30,25 +30,27 @@ The goal of this project is to implement a distributed and decentralized system
    - Validators can request the connection information of miners from the subtensor network. This information is validated and
      decrypted locally using the validator's private key.
 
-## Communication Flow
+## Basic Communication Flow
 
 <!--
 @startuml ./assets/diagrams/CommunicationFlow
 participant Validator
 participant Miner
 participant GitHub
+participant AddressManager
 participant Storage
 participant Bittensor
 Validator -> Validator: Generate Validator key-pair
 Validator -> GitHub: Publish public key along with HotKey
-GitHub -> Miner: Fetch Validator info
-Miner -> Miner: Encrypt Miner IP/Domain with Validator public key
-Miner -> Storage: Add/update file with encrypted IPs/Domains for Validators
+GitHub -> Miner: Fetch new Validator info
+Miner -> AddressManager: Generate new address
+Miner -> Miner: Encrypt generated address with Validator public key
+Miner -> Storage: Update file with encrypted addresses for Validators
 Miner -> Bittensor: Publish file location
 Bittensor -> Validator: Fetch file location
 Storage -> Validator: Fetch Miner file
 Validator -> Validator: Decrypt Miner file entry encrypted for given Validator
-Validator -> Miner: Send request using decrypted Miner IP/Domain
+Validator -> Miner: Send request using decrypted Miner address
 @enduml
 -->
 

bt_ddos_shield/address.py

@@ -29,24 +29,27 @@ def __init__(self, address_id, address_type: AddressType, address: str, port: in
         self.address = address
         self.port = port
 
+    def __repr__(self):
+        return f"Address(id={self.address_id}, type={self.address_type}, address={self.address}:{self.port})"
+
     @abstractmethod
-    def encrypt(self) -> bytes:
+    def serialize(self) -> bytes:
         """
-        Encrypts address data.
+        Serialize address data.
 
         Returns:
-            bytes: Encrypted address data.
+            bytes: Serialized address data.
         """
         pass
 
     @classmethod
     @abstractmethod
-    def decrypt(cls, encrypted_data: bytes) -> Address:
+    def deserialize(cls, serialized_data: bytes) -> 'Address':
         """
-        Create address from encrypted address data.
+        Deserialize address data.
 
         Args:
-            encrypted_data: Encrypted address data.
+            serialized_data: Data serialized before by serialize method.
 
         Returns:
             Address: Created address.

bt_ddos_shield/blockchain_manager.py

@@ -1,17 +1,33 @@
 from abc import ABC, abstractmethod
 
+from bt_ddos_shield.utils import Hotkey
+
 
 class AbstractBlockchainManager(ABC):
     """
     Abstract base class for manager handling publishing blocks to blockchain.
     """
 
     @abstractmethod
-    def publish(self, data: bytes):
+    def put(self, hotkey: Hotkey, data: bytes):
         """
         Puts data to blockchain.
 
         Args:
+            hotkey: Hotkey of user for whom we are putting data.
             data: Data.
         """
         pass
+
+    @abstractmethod
+    def get(self, hotkey: Hotkey) -> bytes:
+        """
+        Gets data from blockchain.
+
+        Args:
+            hotkey: Hotkey of user to get data from.
+
+        Returns:
+            data: Last block of data put by user.
+        """
+        pass

bt_ddos_shield/event_processor.py

@@ -1,9 +1,10 @@
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
+import traceback
 
 
 @dataclass
-class Event:
+class MinerShieldEvent:
     """
     Class describing event, which happened in the shield.
     """
@@ -12,17 +13,30 @@ class Event:
     exception: Exception = None  # Exception which caused the event.
 
 
-class AbstractEventProcessor(ABC):
+class AbstractMinerShieldEventProcessor(ABC):
     """
     Abstract base class for processor handling events generated by shield.
     """
 
     @abstractmethod
-    def add_event(self, event: Event):
+    def add_event(self, event: MinerShieldEvent):
         """
         Add new event to be handled by processor.
 
         Args:
             event: Event to add.
         """
         pass
+
+
+class PrintingMinerShieldEventProcessor(AbstractMinerShieldEventProcessor):
+    """
+    Event processor which logs events to console.
+    """
+
+    def add_event(self, event: MinerShieldEvent):
+        if event.exception is not None:
+            print(f"MinerShieldEvent: {event.event_description}\nException happened:")
+            print(traceback.format_exc())
+        else:
+            print(f"MinerShieldEvent: {event.event_description}")

bt_ddos_shield/manifest_manager.py

@@ -1,7 +1,7 @@
 from abc import ABC, abstractmethod
 
 from bt_ddos_shield.address import Address
-from bt_ddos_shield.miner_shield import Hotkey
+from bt_ddos_shield.utils import Hotkey
 
 
 class AbstractManifestManager(ABC):
@@ -31,6 +31,6 @@ def _put_file(self, data: bytes) -> Address:
             data: File contents.
 
         Returns:
-            Address: Address where file is put.
+            Address: Address where file was put.
         """
         pass