naeural-client 2.5.25__tar.gz → 2.5.27__tar.gz

{naeural_client-2.5.25 → naeural_client-2.5.27}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: naeural_client
-Version: 2.5.25
+Version: 2.5.27
 Summary: `naeural_client` is the Python SDK required for client app development for the Naeural Edge Protocol Edge Protocol framework
 Project-URL: Homepage, https://github.com/NaeuralEdgeProtocol/naeural_client
 Project-URL: Bug Tracker, https://github.com/NaeuralEdgeProtocol/naeural_client/issues

{naeural_client-2.5.25 → naeural_client-2.5.27}/naeural_client/_ver.py

@@ -1,4 +1,4 @@
-__VER__ = "2.5.25"
+__VER__ = "2.5.27"
 
 if __name__ == "__main__":
   with open("pyproject.toml", "rt") as fd:

{naeural_client-2.5.25 → naeural_client-2.5.27}/naeural_client/base/generic_session.py

@@ -179,7 +179,7 @@ class GenericSession(BaseDecentrAIObject):
     self._dct_online_nodes_pipelines: dict[str, Pipeline] = {}
     self._dct_online_nodes_last_heartbeat: dict[str, dict] = {}
     self._dct_can_send_to_node: dict[str, bool] = {}
-    self._dct_node_last_seen_time = {}
+    self._dct_node_last_seen_time = {} # key is node address
     self._dct_node_addr_name = {}
     self.online_timeout = 60
     self.filter_workers = filter_workers
@@ -209,9 +209,14 @@ class GenericSession(BaseDecentrAIObject):
     self.sdk_main_loop_thread = Thread(target=self.__main_loop, daemon=True)
     self.__formatter_plugins_locations = formatter_plugins_locations
 
-    self.__bc_engine = bc_engine
     self.__blockchain_config = blockchain_config
 
+    # TODO: needs refactoring - suboptimal design
+    self.__bc_engine : DefaultBlockEngine = bc_engine
+    self.bc_engine : DefaultBlockEngine = None 
+    # END TODO
+    
+
     self.__open_transactions: list[Transaction] = []
     self.__open_transactions_lock = Lock()
 
@@ -746,7 +751,7 @@ class GenericSession(BaseDecentrAIObject):
       """
       raise NotImplementedError
 
-    def close(self, close_pipelines=False, wait_close=False, **kwargs):
+    def close(self, close_pipelines=False, wait_close=True, **kwargs):
       """
       Close the session, releasing all resources and closing all threads
       Resources are released in the main loop thread, so this method will block until the main loop thread exits.
@@ -757,7 +762,7 @@ class GenericSession(BaseDecentrAIObject):
       close_pipelines : bool, optional
           close all the pipelines created by or attached to this session (basically calling `.close_own_pipelines()` for you), by default False
       wait_close : bool, optional
-          If `True`, will wait for the main loop thread to exit. Defaults to `False`
+          If `True`, will wait for the main loop thread to exit. Defaults to `True`
       """
 
       if close_pipelines:
@@ -1033,10 +1038,19 @@ class GenericSession(BaseDecentrAIObject):
         self._config[comm_ct.SECURED] = secured
         
       return
+    
+    def __aliases_to_addresses(self):
+      """
+      Convert the aliases to addresses.
+      """
+      dct_aliases = {v: k for k, v in self._dct_node_addr_name.items()}
+      return dct_aliases
 
     def __get_node_address(self, node):
       """
       Get the address of a node. If node is an address, return it. Else, return the address of the node.
+      This method is used to convert the alias of a node to its address if needed however it is 
+      not recommended to use it as it was created for backward compatibility reasons.
 
       Parameters
       ----------
@@ -1048,11 +1062,19 @@ class GenericSession(BaseDecentrAIObject):
       str
           The address of the node.
       """
-      if node not in self.get_active_nodes():
-        node = next((key for key, value in self._dct_node_addr_name.items() if value == node), node)
-      return node
+      # if node not in self.get_active_nodes():
+      #   node = next((key for key, value in self._dct_node_addr_name.items() if value == node), node)
+      result = None
+      if node in self.get_active_nodes():
+        # node seems to be already an address
+        result = node
+      else:
+        # maybe node is a name
+        aliases = self.__aliases_to_addresses()
+        result = aliases.get(node, None)
+      return result
 
-    def _send_command_to_box(self, command, worker, payload, show_command=False, session_id=None, **kwargs):
+    def _send_command_to_box(self, command, worker, payload, show_command=True, session_id=None, **kwargs):
       """
       Send a command to a node.
 
@@ -1062,10 +1084,16 @@ class GenericSession(BaseDecentrAIObject):
           The command to send.
       worker : str
           The name of the Naeural Edge Protocol edge node that will receive the command.
+          
+          Observation: this approach will be deprecated soon in favor of the direct use of the address that
+          will not require the node to be already "seend" by the session.
+          
       payload : dict
           The payload to send.
       show_command : bool, optional
           If True, will print the complete command that is being sent, by default False
+      
+          
       """
 
       show_command = show_command or self.__show_commands
@@ -1080,10 +1108,17 @@ class GenericSession(BaseDecentrAIObject):
 
       # This part is duplicated with the creation of payloads
       encrypt_payload = self.encrypt_comms
-      if encrypt_payload and worker is not None:
-        # TODO: use safe_json_dumps
+      if encrypt_payload and worker is not None:        
         str_data = json.dumps(critical_data)
-        str_enc_data = self.bc_engine.encrypt(str_data, worker)
+        
+        # Initial code `str_enc_data = self.bc_engine.encrypt(str_data, worker)` could not work under any
+        # circumstances due to the fact that encrypt requires the public key of the receiver not the alias
+        # of the receiver. The code below is a workaround to encrypt the message
+        # TODO: furthermore the code will be migrated to the use of the address of the worker
+        worker_addr = self.get_addr_by_name(worker)
+        assert worker_addr is not None, f"Unknown worker address: {worker} - {worker_addr}"
+        
+        str_enc_data = self.bc_engine.encrypt(str_data, worker_addr)
         critical_data = {
           comm_ct.COMM_SEND_MESSAGE.K_EE_IS_ENCRYPTED: True,
           comm_ct.COMM_SEND_MESSAGE.K_EE_ENCRYPTED_DATA: str_enc_data,
@@ -1104,10 +1139,11 @@ class GenericSession(BaseDecentrAIObject):
       }
       self.bc_engine.sign(msg_to_send, use_digest=True)
       if show_command:
-        self.P("Sending command '{}' to '{}':\n{}".format(command, worker, json.dumps(msg_to_send, indent=2)),
-               color='y',
-               verbosity=1
-               )
+        self.P(
+          "Sending command '{}' to '{}':\n{}".format(command, worker, json.dumps(msg_to_send, indent=2)),
+          color='y',
+          verbosity=1
+        )
       self._send_payload(worker, msg_to_send)
       return
 
@@ -1357,6 +1393,25 @@ class GenericSession(BaseDecentrAIObject):
       )
       self.own_pipelines.append(pipeline)
       return pipeline
+    
+    def get_addr_by_name(self, name):
+      """
+      Get the address of a node by its name.
+      This function should be used with caution and it was created for backward compatibility reasons.
+      
+      Parameters
+      ----------
+      
+      name : str
+          The name of the node.
+          
+      Returns
+      -------
+      str
+          The address of the node.      
+      """
+      return self.__get_node_address(name)      
+      
 
     def get_node_name(self, node_addr):
       """
@@ -1376,12 +1431,13 @@ class GenericSession(BaseDecentrAIObject):
 
     def get_active_nodes(self):
       """
-      Get the list of all Naeural Edge Protocol edge nodes that sent a message since this session was created, and that are considered online
+      Get the list of all Naeural Edge Protocol edge nodes addresses that sent a message since this 
+      session was created, and that are considered online.
 
       Returns
       -------
       list
-          List of names of all the Naeural Edge Protocol edge nodes that are considered online
+          List of addresses of all the Naeural Edge Protocol edge nodes that are considered online
 
       """
       return [k for k, v in self._dct_node_last_seen_time.items() if tm() - v < self.online_timeout]

{naeural_client-2.5.25 → naeural_client-2.5.27}/naeural_client/bc/base.py

@@ -14,42 +14,7 @@ from cryptography.hazmat.primitives import serialization
 
 from ..utils.config import get_user_folder
 
-class BCctbase: 
-  SIGN      = 'EE_SIGN'
-  SENDER    = 'EE_SENDER'
-  HASH      = 'EE_HASH'
-  
-  ETH_SIGN  = 'EE_ETH_SIGN'
-  ETH_SENDER= 'EE_ETH_SENDER'
-    
-
-class BCct:
-  SIGN        = BCctbase.SIGN
-  SENDER      = BCctbase.SENDER
-  HASH        = BCctbase.HASH
-  ETH_SIGN    = BCctbase.ETH_SIGN
-  ETH_SENDER  = BCctbase.ETH_SENDER
-  
-  ADDR_PREFIX_OLD = "aixp_"
-  ADDR_PREFIX   = "0xai_"
-  
-  K_USER_CONFIG_PEM_FILE = 'NAEURAL_PEM_FILE'
-  K_PEM_FILE = 'PEM_FILE'
-  K_PASSWORD = 'PASSWORD'
-  K_PEM_LOCATION = 'PEM_LOCATION'
-  
-  ERR_UNAVL_MSG = "Missing signature/sender data"
-  ERR_UNAVL = 1
-
-  ERR_SIGN_MSG = "Bad hash"
-  ERR_UNAVL = 1000
-
-  ERR_SIGN_MSG = "Bad signature"
-  ERR_UNAVL = 1001
-  
-  AUTHORISED_ADDRS = 'authorized_addrs'
-  
-  DEFAULT_INFO = '0xai handshake data'
+from ..const.base import BCctbase, BCct
     
   
   
@@ -342,10 +307,10 @@ class BaseBlockEngine:
     
     if user_config:
       user_folder = get_user_folder()
-      pem_fn = str(user_folder / '_naeural.pem')
+      pem_fn = str(user_folder / BCct.USER_PEM_FILE)
     else:
-      pem_name = config.get(BCct.K_PEM_FILE, '_pk.pem')
-      pem_folder = config.get(BCct.K_PEM_LOCATION, 'data')
+      pem_name = config.get(BCct.K_PEM_FILE, BCct.DEFAULT_PEM_FILE)
+      pem_folder = config.get(BCct.K_PEM_LOCATION, BCct.DEFAULT_PEM_LOCATION)
       pem_fn = os.path.join(log.get_target_folder(pem_folder), pem_name)
     #endif pem is defined in ~/.naeural/ or in the data folder of the _local_cache
     self.__pem_file = pem_fn

{naeural_client-2.5.25 → naeural_client-2.5.27}/naeural_client/cli/nodes.py

@@ -1,6 +1,6 @@
 from time import time
 from naeural_client.utils.config import log_with_color
-from naeural_client.const import SESSION_CT
+from naeural_client.const import SESSION_CT, COMMANDS
 
 
 def _get_netstats(
@@ -9,6 +9,7 @@ def _get_netstats(
   allowed_only=False, 
   supervisor=None,
   supervisors_only=False,
+  return_session=False,
 ):
   t1 = time()
   from naeural_client import Session
@@ -23,8 +24,11 @@ def _get_netstats(
   nr_supers = dct_info[SESSION_CT.NETSTATS_NR_SUPERVISORS]
   _elapsed = dct_info[SESSION_CT.NETSTATS_ELAPSED] # computed on call
   elapsed = time() - t1 # elapsed=_elapsed
+  if return_session:
+    return df, supervisor, super_alias, nr_supers, elapsed, sess  
   return df, supervisor, super_alias, nr_supers, elapsed
 
+
 def get_nodes(args):
   """
   This function is used to get the information about the nodes and it will perform the following:
@@ -76,6 +80,40 @@ def get_supervisors(args):
     log_with_color(f"{df}")
   return
 
+def _send_command_to_node(args, command):
+  node = args.node
+  silent = not args.verbose   
+  
+  t1 = time()
+  df, _, _, _, _, sess = _get_netstats(
+    silent=silent, online_only=True, return_session=True    
+  )
+  peered = None
+  selection = df.Alias == node
+  found = selection.any()
+  node_addr = None
+  df_found =  df[selection]
+  if found:
+    peered = df_found.Peered.values[0]
+    node_addr = df_found.Address.values[0]   
+    log_with_color(f"{df_found}")
+  if not found:
+    log_with_color(f"Node '{node}' <{node_addr}> not found in network.", color='r')
+    return
+  if not peered:
+    log_with_color(f"Node '{node}' <{node_addr}> does not accept commands from this SDK.", color='r')
+    return
+  # TODO: currently this is based on node alias, but we should be based on node address
+  #       and maybe even node alias
+  if command == COMMANDS.RESTART:
+    sess._send_command_restart_node(node)
+  elif command == COMMANDS.SHUTDOWN:
+    sess._send_command_stop_node(node)
+  else:
+    log_with_color(f"Command '{command}' not supported.", color='r')
+    return
+  elapsed = time() - t1  
+  return  
 
 def restart_node(args):
   """
@@ -86,7 +124,9 @@ def restart_node(args):
   args : argparse.Namespace
       Arguments passed to the function.
   """
-  log_with_color(f"Restarting node {args.node} NOT IMPLEMENTED", color='r')
+  node = args.node
+  log_with_color(f"Attempting to restart node <{node}>", color='b')
+  _send_command_to_node(args, COMMANDS.RESTART)
   return
 
 
@@ -99,5 +139,7 @@ def shutdown_node(args):
   args : argparse.Namespace
       Arguments passed to the function.
   """
-  log_with_color(f"Shutting down node {args.node} NOT IMPLEMENTED", color='r')
+  node = args.node
+  log_with_color(f"Attempting to shutdown node <{node}>", color='b')
+  _send_command_to_node(args, COMMANDS.SHUTDOWN)
   return

{naeural_client-2.5.25 → naeural_client-2.5.27}/naeural_client/const/base.py

@@ -1,11 +1,54 @@
 EE_ID = 'EE_ID'
 SB_ID = 'SB_ID'  # change to SB_ID = EE_ID post mod from sb to ee
 
+
+class BCctbase: 
+  SIGN      = 'EE_SIGN'
+  SENDER    = 'EE_SENDER'
+  HASH      = 'EE_HASH'
+  
+  ETH_SIGN  = 'EE_ETH_SIGN'
+  ETH_SENDER= 'EE_ETH_SENDER'
+    
+
+class BCct:
+  SIGN        = BCctbase.SIGN
+  SENDER      = BCctbase.SENDER
+  HASH        = BCctbase.HASH
+  ETH_SIGN    = BCctbase.ETH_SIGN
+  ETH_SENDER  = BCctbase.ETH_SENDER
+  
+  ADDR_PREFIX_OLD = "aixp_"
+  ADDR_PREFIX   = "0xai_"
+  
+  K_USER_CONFIG_PEM_FILE = 'NAEURAL_PEM_FILE'
+  K_PEM_FILE = 'PEM_FILE'
+  K_PASSWORD = 'PASSWORD'
+  K_PEM_LOCATION = 'PEM_LOCATION'
+  
+  ERR_UNAVL_MSG = "Missing signature/sender data"
+  ERR_UNAVL = 1
+
+  ERR_SIGN_MSG = "Bad hash"
+  ERR_UNAVL = 1000
+
+  ERR_SIGN_MSG = "Bad signature"
+  ERR_UNAVL = 1001
+  
+  AUTHORISED_ADDRS = 'authorized_addrs'
+  
+  DEFAULT_INFO = '0xai handshake data'
+  
+  USER_PEM_FILE = '_naeural.pem'
+  DEFAULT_PEM_FILE = '_pk.pem'
+  DEFAULT_PEM_LOCATION = 'data'
+  
 BLOCKCHAIN_CONFIG = {
-    "PEM_FILE": "_pk_sdk.pem",
+    "PEM_FILE": BCct.DEFAULT_PEM_FILE,
     "PASSWORD": None,
-    "PEM_LOCATION": "data"
+    "PEM_LOCATION": BCct.DEFAULT_PEM_LOCATION
 }
+  
 
 class DCT_TYPES:
   VOID_PIPELINE = 'Void'

{naeural_client-2.5.25 → naeural_client-2.5.27}/naeural_client/utils/config.py

@@ -2,6 +2,13 @@ import os
 from pathlib import Path
 import shutil
 
+from naeural_client.const.base import BCct
+
+
+CONFIG_FILE = "config"
+SDK_HOME = ".naeural"
+LOCAL_PEM_PATH = "./_local_cache/_data/" + BCct.DEFAULT_PEM_FILE
+
 ENV_TEMPLATE = """
 
 EE_MQTT_HOST=r9092118.ala.eu-central-1.emqxsl.com
@@ -75,13 +82,13 @@ def get_user_folder():
   """
   Returns the user folder.
   """
-  return Path.home() / ".naeural"
+  return Path.home() / SDK_HOME
 
 def get_user_config_file():
   """
   Returns the user configuration file.
   """
-  return get_user_folder() / "config"
+  return get_user_folder() / CONFIG_FILE
 
 def reset_config(*larg, **kwargs):
   """
@@ -93,6 +100,9 @@ def reset_config(*larg, **kwargs):
   config_dir = get_user_folder()
   config_file = get_user_config_file()
   
+  local_pem = Path(LOCAL_PEM_PATH)
+  target_pem = config_dir / BCct.USER_PEM_FILE
+  
   # Create the ~/.naeural folder if it doesn't exist
   config_dir.mkdir(parents=True, exist_ok=True)
 
@@ -115,6 +125,12 @@ def reset_config(*larg, **kwargs):
       color='y'
     )
     log_with_color(f"Please UPDATE the configuration in the file {config_file}", color='b')
+  
+  if local_pem.exists():
+    log_with_color(f"Copying local PEM file {local_pem} to {target_pem}", color='y')
+    shutil.copy(local_pem, target_pem)
+  else:
+    log_with_color(f"No local PEM file found at {local_pem}. A default private key will be generated.", color='r')
   return
 
 def show_address(args):

{naeural_client-2.5.25 → naeural_client-2.5.27}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "naeural_client"
-version = "2.5.25"
+version = "2.5.27"
 authors = [
   { name="Andrei Ionut Damian", email="andrei.damian@me.com" },
   { name="Cristan Bleotiu", email="cristibleotiu@gmail.com" },

naeural_client-2.5.27/xperimental/check_local_keys/check1.py

@@ -0,0 +1,33 @@
+import os
+
+from naeural_client import Logger, const
+from naeural_client.bc import DefaultBlockEngine
+
+
+if __name__ == '__main__':
+  l = Logger("ENC", base_folder=".", app_folder="_local_cache")
+
+  
+  files = [x for x in os.listdir(l.get_data_folder()) if x.endswith(".pem")]
+  
+  local_addresses = []  
+  results = []
+  
+  if len(files) > 0:
+    l.P("PEM files found: {}".format(files), color='g')
+    for pem in files:
+      eng = DefaultBlockEngine(
+        log=l, name=pem, 
+        config={
+            "PEM_FILE"     : pem,
+            "PASSWORD"     : None,      
+            "PEM_LOCATION" : "data"
+          }
+      )
+      local_addresses.append(eng.address)
+      results.append("{} - {}".format(eng.address, pem))
+    l.P("Local addresses:\n{}".format("\n".join(results)), color='g')
+  else:
+    l.P("No PEM files found.", color='r')
+  
+