uagents-core 0.3.3__tar.gz → 0.3.4__tar.gz

{uagents_core-0.3.3 → uagents_core-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: uagents-core
-Version: 0.3.3
+Version: 0.3.4
 Summary: Core components for agent based systems
 License: Apache 2.0
 Author: Ed FitzGerald

{uagents_core-0.3.3 → uagents_core-0.3.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uagents-core"
-version = "0.3.3"
+version = "0.3.4"
 description = "Core components for agent based systems"
 authors = [
     { name = "Ed FitzGerald", email = "edward.fitzgerald@fetch.ai" },

{uagents_core-0.3.3 → uagents_core-0.3.4}/uagents_core/config.py

@@ -7,6 +7,7 @@ DEFAULT_CHALLENGE_PATH = "/v1/auth/challenge"
 DEFAULT_MAILBOX_PATH = "/v1/submit"
 DEFAULT_PROXY_PATH = "/v1/proxy/submit"
 DEFAULT_STORAGE_PATH = "/v1/storage"
+DEFAULT_PAYMENTS_PATH = "/v1/payments"
 
 DEFAULT_MAX_ENDPOINTS = 10
 
@@ -35,3 +36,7 @@ class AgentverseConfig(BaseModel):
     @property
     def storage_endpoint(self) -> str:
         return f"{self.url}{DEFAULT_STORAGE_PATH}"
+
+    @property
+    def payments_endpoint(self) -> str:
+        return f"{self.url}{DEFAULT_PAYMENTS_PATH}"

{uagents_core-0.3.3 → uagents_core-0.3.4}/uagents_core/storage.py

@@ -2,7 +2,6 @@ import base64
 import struct
 from datetime import datetime
 from secrets import token_bytes
-from typing import Optional
 
 import requests
 
@@ -34,38 +33,57 @@ def compute_attestation(
 class ExternalStorage:
     def __init__(
         self,
-        identity: Optional[Identity] = None,
-        storage_url: Optional[str] = None,
-        api_token: Optional[str] = None,
+        *,
+        identity: Identity | None = None,
+        storage_url: str | None = None,
+        api_token: str | None = None,
     ):
         self.identity = identity
         self.api_token = api_token
+        if not (identity or api_token):
+            raise ValueError(
+                "Either an identity or an API token must be provided for authentication"
+            )
         self.storage_url = storage_url or AgentverseConfig().storage_endpoint
 
     def _make_attestation(self) -> str:
         nonce = token_bytes(32)
         now = datetime.now()
-        return compute_attestation(self.identity, now, 3600, nonce)
+        if not self.identity:
+            raise RuntimeError("No identity available to create attestation")
+        return compute_attestation(
+            identity=self.identity,
+            validity_start=now,
+            validity_secs=3600,
+            nonce=nonce,
+        )
 
     def _get_auth_header(self) -> dict:
         if self.api_token:
             return {"Authorization": f"Bearer {self.api_token}"}
-        elif self.identity:
+        if self.identity:
             return {"Authorization": f"Agent {self._make_attestation()}"}
-        else:
-            raise RuntimeError("No identity or API token available for authentication")
+        raise RuntimeError("No identity or API token available for authentication")
 
     def upload(
-        self, asset_id: str, content: bytes, mime_type: str = "text/plain"
+        self,
+        asset_id: str,
+        asset_content: bytes,
+        mime_type: str = "text/plain",
     ) -> dict:
         url = f"{self.storage_url}/assets/{asset_id}/contents/"
         headers = self._get_auth_header()
         headers["Content-Type"] = "application/json"
         payload = {
-            "contents": base64.b64encode(content).decode(),
+            "contents": base64.b64encode(asset_content).decode(),
             "mime_type": mime_type,
         }
-        response = requests.put(url, json=payload, headers=headers)
+        response = requests.put(
+            url=url,
+            json=payload,
+            headers=headers,
+            timeout=10,
+        )
         if response.status_code != 200:
             raise RuntimeError(
                 f"Upload failed: {response.status_code}, {response.text}"
@@ -76,8 +94,11 @@ class ExternalStorage:
     def download(self, asset_id: str) -> dict:
         url = f"{self.storage_url}/assets/{asset_id}/contents/"
         headers = self._get_auth_header()
-
-        response = requests.get(url, headers=headers)
+        response = requests.get(
+            url=url,
+            headers=headers,
+            timeout=10,
+        )
         if response.status_code != 200:
             raise RuntimeError(
                 f"Download failed: {response.status_code}, {response.text}"
@@ -104,7 +125,12 @@ class ExternalStorage:
             "lifetime_hours": lifetime_hours,
         }
 
-        response = requests.post(url, json=payload, headers=headers)
+        response = requests.post(
+            url=url,
+            json=payload,
+            headers=headers,
+            timeout=10,
+        )
         if response.status_code != 201:
             raise RuntimeError(
                 f"Asset creation failed: {response.status_code}, {response.text}"
@@ -114,7 +140,7 @@ class ExternalStorage:
 
     def set_permissions(
         self, asset_id: str, agent_address: str, read: bool = True, write: bool = True
-    ):
+    ) -> dict:
         if not self.api_token:
             raise RuntimeError("API token required to set permissions")
         url = f"{self.storage_url}/assets/{asset_id}/permissions/"
@@ -126,7 +152,12 @@ class ExternalStorage:
             "write": write,
         }
 
-        response = requests.put(url, json=payload, headers=headers)
+        response = requests.put(
+            url=url,
+            json=payload,
+            headers=headers,
+            timeout=10,
+        )
         if response.status_code != 200:
             raise RuntimeError(
                 f"Set permissions failed: {response.status_code}, {response.text}"

uagents_core-0.3.4/uagents_core/utils/subscriptions.py

@@ -0,0 +1,82 @@
+"""
+This module provides methods related to agent bases subscriptions.
+
+Example usage:
+```
+from uagents_core.contrib.protocols.subscriptions import TierType
+
+@protocol.on_message(ChatMessage)
+async def handle_message(ctx: Context, sender: str, msg: ChatMessage):
+    subscription_tier = get_subscription_tier(
+        identity=ctx.agent.identity,
+        requester_address=sender
+    )
+
+    if subscription_tier == TierType.PLUS:
+        ...
+
+    if subscription_tier == TierType.PRO:
+        ...
+
+    ...
+```
+
+"""
+
+from datetime import datetime
+from secrets import token_bytes
+
+import requests
+
+from uagents_core.config import AgentverseConfig
+from uagents_core.contrib.protocols.subscriptions import TierType
+from uagents_core.identity import Identity
+from uagents_core.logger import get_logger
+from uagents_core.storage import compute_attestation
+
+logger = get_logger("uagents_core.utils.subscriptions")
+
+
+def get_subscription_tier(
+    identity: Identity,
+    requester_address: str,
+    agentverse_config: AgentverseConfig | None = None,
+) -> TierType:
+    """
+    Get the subscription tier of the requester for a specific agent.
+
+    This function is used to verify the type of subscription before processing
+    an incoming message.
+
+    Args:
+        identity (Identity): The identity of the agent that is requested.
+        requester_address (str): The address of the requester to check.
+        agentverse_config (AgentverseConfig | None): The configuration for the Agentverse.
+            If not provided, defaults to a new instance of AgentverseConfig.
+
+    Returns:
+        TierType: The subscription tier type of the requester.
+    """
+    if not agentverse_config:
+        agentverse_config = AgentverseConfig()
+    attestation: str = compute_attestation(
+        identity=identity,
+        validity_start=datetime.now(),
+        validity_secs=60,
+        nonce=token_bytes(nbytes=32),
+    )
+    url: str = (
+        f"{agentverse_config.payments_endpoint}/subscriptions"
+        + f"/{identity.address}/{requester_address}"
+    )
+    headers: dict[str, str] = {"Authorization": f"Agent {attestation}"}
+
+    try:
+        response = requests.get(url=url, headers=headers, timeout=10)
+        response.raise_for_status()
+    except requests.RequestException as e:
+        logger.error(f"Failed to get subscription tier: {e}")
+        return TierType.FREE
+
+    data: dict = response.json()
+    return data.get("tier_type", TierType.FREE)