ratio1 3.4.91__tar.gz → 3.4.93__tar.gz

{ratio1-3.4.91 → ratio1-3.4.93}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ratio1
-Version: 3.4.91
+Version: 3.4.93
 Summary: `ratio1` or Ration1 SDK is the Python SDK required for client app development for the Ratio1 ecosystem
 Project-URL: Homepage, https://github.com/Ratio1/ratio1_sdk
 Project-URL: Bug Tracker, https://github.com/Ratio1/ratio1_sdk/issues

{ratio1-3.4.91 → ratio1-3.4.93}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "ratio1"
-version = "3.4.91"
+version = "3.4.93"
 authors = [
   { name="Andrei Ionut Damian", email="andrei.damian@ratio1.ai" },
   { name="Cristan Bleotiu", email="cristian.bleotiu@ratio1.ai" },

{ratio1-3.4.91 → ratio1-3.4.93}/ratio1/_ver.py

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

{ratio1-3.4.91 → ratio1-3.4.93}/ratio1/base/generic_session.py

@@ -3130,6 +3130,186 @@ class GenericSession(BaseDecentrAIObject):
         **kwargs
       )
 
+    def create_worker_web_app(
+      self,
+      *,
+      node,
+      name="Ratio1 Worker Web App",
+      tunnel_engine_enabled=True,
+      tunnel_engine="cloudflare",
+      cloudflare_token=None,
+      ngrok_edge_label=None,
+      extra_debug=False,
+      summary="Ratio1 Worker WebApp created via SDK",
+      description=None,
+      # Worker app specific parameters
+      vcs_data=None,
+      image="node:22",
+      build_and_run_commands=None,
+      cr_data=None,
+      env=None,
+      dynamic_env=None,
+      port=None,
+      endpoint_url=None,
+      endpoint_poll_interval=30,
+      container_resources=None,
+      volumes=None,
+      file_volumes=None,
+      restart_policy="always",
+      image_pull_policy="always",
+      image_poll_interval=300,
+      vcs_poll_interval=60,
+      **kwargs
+    ):
+      """
+      Create a new worker web app on a node.
+
+      Parameters
+      ----------
+
+      node : str
+          Address or Name of the ratio1 Edge Protocol edge node that will handle this web app.
+
+      name : str
+          Name of the worker web app.
+
+      tunnel_engine : str, optional
+          The tunnel engine to use for exposing the web app. Defaults to "cloudflare".
+          It can also be "ngrok" for ngrok tunnel.
+
+      tunnel_engine_enabled : bool, optional
+          If True, will use the specified tunnel engine to expose the web app. Defaults to True.
+
+      ngrok_edge_label : str, optional
+          The label of the edge node that will be used to expose the HTTP server. Defaults to None.
+
+      cloudflare_token : str, optional
+          The Cloudflare token to use for exposing the web app. Defaults to None.
+
+      vcs_data : dict, required
+          Version control system data containing:
+          - PROVIDER: "github" (currently only GitHub is supported)
+          - USERNAME: GitHub username for cloning (if private repo)
+          - TOKEN: GitHub personal access token for cloning (if private repo)
+          - REPO_OWNER: GitHub repository owner (user or org)
+          - REPO_NAME: GitHub repository name
+          - BRANCH: branch to monitor for updates (defaults to "main")
+          - POLL_INTERVAL: seconds between Git commit checks (defaults to 60)
+
+      image : str, optional
+          Docker image to use for the container. Defaults to "node:22".
+
+      build_and_run_commands : list, optional
+          List of commands to run in the container for building and running the app.
+          Defaults to ["npm install", "npm run build", "npm start"].
+
+      cr_data : dict, optional
+          Container registry data containing:
+          - SERVER: container registry URL (defaults to 'docker.io')
+          - USERNAME: registry username
+          - PASSWORD: registry password or token
+
+      env : dict, optional
+          Environment variables for the container.
+
+      dynamic_env : dict, optional
+          Dynamic environment variables for the container.
+
+      port : int, optional
+          Internal container port if it's a web app.
+
+      endpoint_url : str, optional
+          Endpoint to poll for health checks, e.g., "/health" or "/edgenode".
+
+      endpoint_poll_interval : int, optional
+          Seconds between endpoint health checks. Defaults to 30.
+
+      container_resources : dict, optional
+          Container resource limits containing:
+          - cpu: CPU limit (e.g., "0.5" for half a CPU, "1.0" for one CPU core)
+          - gpu: GPU limit (defaults to 0)
+          - memory: Memory limit (e.g., "512m" for 512MB)
+          - ports: List of container ports or dict of host_port: container_port mappings
+
+      volumes : dict, optional
+          Dictionary mapping host paths to container paths for directory volumes.
+          Example: {"/host/data": "/container/data"}
+
+      file_volumes : dict, optional
+          Dictionary mapping logical names to file configurations for creating and mounting
+          files with dynamic content. Each entry should contain:
+          - content: String content to write to the file
+          - mounting_point: Full path where file will be mounted in container
+          Example: {"config": {"content": "port=8080", "mounting_point": "/app/config.txt"}}
+
+      restart_policy : str, optional
+          Container restart policy. Defaults to "always".
+
+      image_pull_policy : str, optional
+          Image pull policy. Defaults to "always".
+
+      image_poll_interval : int, optional
+          Seconds between Docker image checks. Defaults to 300.
+
+      vcs_poll_interval : int, optional
+          Seconds between Git commit checks. Defaults to 60.
+
+      """
+      if vcs_data is None:
+        raise ValueError("vcs_data is required for worker web apps. Please provide repository information.")
+
+      # Set default values
+      if build_and_run_commands is None:
+        build_and_run_commands = ["npm install", "npm run build", "npm start"]
+      
+      if cr_data is None:
+        cr_data = {"SERVER": "docker.io", "USERNAME": None, "PASSWORD": None}
+      
+      if container_resources is None:
+        container_resources = {"cpu": 1, "gpu": 0, "memory": "512m", "ports": []}
+
+      # Prepare worker app specific configuration
+      worker_config = {
+        "VCS_DATA": {**vcs_data, "POLL_INTERVAL": vcs_poll_interval},
+        "IMAGE": image,
+        "BUILD_AND_RUN_COMMANDS": build_and_run_commands,
+        "CR_DATA": cr_data,
+        "ENV": env or {},
+        "DYNAMIC_ENV": dynamic_env or {},
+        "PORT": port,
+        "ENDPOINT_URL": endpoint_url,
+        "ENDPOINT_POLL_INTERVAL": endpoint_poll_interval,
+        "CONTAINER_RESOURCES": container_resources,
+        "VOLUMES": volumes or {},
+        "FILE_VOLUMES": file_volumes or {},
+        "RESTART_POLICY": restart_policy,
+        "IMAGE_PULL_POLICY": image_pull_policy,
+        "IMAGE_POLL_INTERVAL": image_poll_interval,
+        "CAR_VERBOSE": 100,
+      }
+
+      kwargs = self.maybe_clean_kwargs(
+        _kwargs=kwargs,
+        caller_method_name="create_worker_web_app",
+        solver_method_name="create_web_app",
+        parameters_to_remove=["signature"]
+      )
+      
+      return self.create_web_app(
+        node=node,
+        name=name,
+        signature=PLUGIN_SIGNATURES.WORKER_APP_RUNNER,
+        tunnel_engine=tunnel_engine,
+        tunnel_engine_enabled=tunnel_engine_enabled,
+        cloudflare_token=cloudflare_token,
+        ngrok_edge_label=ngrok_edge_label,
+        extra_debug=extra_debug,
+        summary=summary,
+        description=description,
+        **worker_config,
+        **kwargs
+      )
+
     def deeploy_launch_container_app(
         self,
         docker_image: str,

{ratio1-3.4.91 → ratio1-3.4.93}/ratio1/bc/evm.py

@@ -1561,6 +1561,41 @@ class _EVMMixin:
 
       return result
 
+    def web3_get_first_closable_job_id(
+      self,
+      network: str = None
+    ):
+      """
+      Retrieve the ID of the first job that can be closed using getFirstClosableJobId().
+
+      Parameters
+      ----------
+      network : str, optional
+          The network to use. If None, defaults to self.evm_network.
+
+      Returns
+      -------
+      int or None
+          The ID of the first closable job, or None if no such job exists.
+      """
+      w3vars = self._get_web3_vars(network)
+      network = w3vars.network
+
+      contract = w3vars.w3.eth.contract(
+        address=w3vars.poai_manager_address,
+        abi=EVM_ABI_DATA.POAI_MANAGER_ABI
+      )
+
+      self.P(f"`getFirstClosableJobId` on {network} via {w3vars.rpc_url}", verbosity=2)
+
+      # Call the contract function to get the first closable job ID.
+      result = contract.functions.getFirstClosableJobId().call()
+      if result == 0:
+        result = None
+      self.P(f"First closable job ID: {result}", verbosity=2)
+
+      return result
+
     def web3_get_is_last_epoch_allocated(
       self,
       network: str = None

{ratio1-3.4.91 → ratio1-3.4.93}/ratio1/const/apps.py

@@ -14,6 +14,7 @@ class PLUGIN_SIGNATURES:
   TELEGRAM_CONVERSATIONAL_BOT_01 = 'TELEGRAM_CONVERSATIONAL_BOT_01'
   NET_CONFIG_MONITOR = 'NET_CONFIG_MONITOR'
   CONTAINER_APP_RUNNER = 'CONTAINER_APP_RUNNER'
+  WORKER_APP_RUNNER = 'WORKER_APP_RUNNER'
   # INSERT_NEW_PLUGIN_HERE
   
   

{ratio1-3.4.91 → ratio1-3.4.93}/ratio1/const/evm_net.py

@@ -417,6 +417,19 @@ _POAI_MANAGER_ABI = [
     ],
     "stateMutability": "view",
     "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "getFirstClosableJobId",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
   }
 ]
 

ratio1-3.4.93/tutorials/ex23_deploy_worker_app.py

@@ -0,0 +1,114 @@
+"""
+ex23_deploy_worker_app.py
+---------------------
+
+This is a basic example of how to use the ratio1 SDK for deploying a worker web app
+that automatically monitors a Git repository and rebuilds when changes are detected.
+
+The example shows how to deploy a worker app that:
+- Clones a Git repository into a container
+- Builds and runs the application
+- Monitors for new commits and automatically restarts
+- Exposes the app via Cloudflare tunnel
+
+"""
+from ratio1 import Session
+
+if __name__ == '__main__':
+  
+  session = Session(silent=False)
+
+  my_node = "0xai_Avvuy6USRwVfbbxEG2HPiCz85mSJle3zo2MbDh5kBD-g"
+
+  # Get Cloudflare token from user input
+  cloudflare_token = input("Enter your Cloudflare tunnel token (or press Enter to skip): ").strip()
+
+  if not cloudflare_token:
+    session.P("Warning: No Cloudflare token provided. The app will not be accessible via tunnel.")
+    cloudflare_token = None
+
+  # VCS data for the repository to monitor
+  vcs_data = {
+    "PROVIDER": "github",
+    "USERNAME": "vitalii-t12",  # Replace with your GitHub username
+    "TOKEN": None,      # Replace with your GitHub personal access token
+    "REPO_OWNER": "vitalii-t12",  # Replace with repository owner
+    "REPO_NAME": "my-super-react-app",     # Replace with repository name
+    "BRANCH": "main",                   # Branch to monitor for updates
+  }
+
+  # Container registry data (if using private registry)
+  cr_data = {
+    "SERVER": "docker.io",
+    "USERNAME": None,  # Set if using private registry
+    "PASSWORD": None,  # Set if using private registry
+  }
+
+  # Environment variables for the app
+  env = {
+    "NODE_ENV": "production",
+  }
+
+  # Container resource limits
+  container_resources = {
+    "cpu": 1,           # 1 CPU core
+    "gpu": 0,           # No GPU
+    "memory": "512m",    # 512MB memory
+    # "ports": [3000],    # Container port 3000
+  }
+
+  # Build and run commands for the application
+  build_and_run_commands = [
+    "npm install",
+    "npm run build", 
+    "npm run serve"
+  ]
+
+  # (Optional) Regular volumes - mount directories from host to container
+  volumes = {
+    # "/host/data": "/app/data",  # Mount host directory to container
+  }
+
+  # (Optional) File volumes - create files with dynamic content and mount them
+  file_volumes = {}
+
+  app, _ = session.create_worker_web_app(
+    node=my_node,
+    name="ratio1_worker_webapp",
+    tunnel_engine="cloudflare",
+    tunnel_engine_enabled=True,
+    cloudflare_token=cloudflare_token,
+    
+    # Worker app specific parameters
+    vcs_data=vcs_data,
+    image="node:22",
+    build_and_run_commands=build_and_run_commands,
+    cr_data=cr_data,
+    env=env,
+    port=4173,
+    container_resources=container_resources,
+    volumes=volumes,          # Directory volumes (optional)
+    file_volumes=file_volumes, # File volumes with dynamic content (optional)
+    vcs_poll_interval=60,     # Check for Git updates every minute
+  )
+  app.deploy()
+  try:
+    session.P("Worker webapp deployed")
+    session.P("The app will automatically:")
+    session.P("- Clone the repository and build the application")
+    session.P("- Monitor for new commits and restart when changes are detected")
+    session.P("- Expose the app via Cloudflare tunnel")
+  except Exception as e:
+    session.P("Error deploying worker webapp: ", e)
+
+  # Observation:
+  #   next code is not mandatory - it is used to keep the session open and cleanup the resources
+  #   due to the fact that this is a example/tutorial and maybe we dont want to keep the pipeline
+  #   active after the session is closed we use close_pipelines=True
+  #   in production, you would not need this code as the script can close 
+  #   after the pipeline will be sent 
+  session.wait(
+    seconds=300,            # we wait the session for 5 minutes to see the app in action
+    close_pipelines=True,   # we close the pipelines after the session
+    close_session=True,     # we close the session after the session
+  )

ratio1-3.4.93/xperimental/_checks/w3_first_closable_job_check.py

@@ -0,0 +1,22 @@
+from ratio1 import Logger
+from ratio1.bc import DefaultBlockEngine
+
+
+if __name__ == '__main__':
+  logger = Logger("ENC")
+  engine = DefaultBlockEngine(
+    log=logger,
+    name="default",
+    user_config=True,
+  )
+
+  engine.reset_network("devnet")
+
+  network = engine.evm_network
+  logger.P(f"Checking first closable job on {network}", color='b')
+
+  try:
+    job_id = engine.web3_get_first_closable_job_id()
+    logger.P(f"First closable job ID: {job_id}", color='g')
+  except Exception as exc:
+    logger.P(f"Failed to retrieve first closable job ID: {exc}", color='r')