uagents-core 0.3.3__py3-none-any.whl → 0.3.5__py3-none-any.whl

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/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/types.py

@@ -1,4 +1,5 @@
 import uuid
+from abc import ABC, abstractmethod
 from enum import Enum
 from typing import Any, Literal
 
@@ -48,3 +49,31 @@ class MsgStatus(BaseModel):
     destination: str
     endpoint: str
     session: uuid.UUID | None = None
+
+
+class Resolver(ABC):
+    @abstractmethod
+    async def resolve(self, destination: str) -> tuple[str | None, list[str]]:
+        """
+        Resolve the destination to an address and endpoint.
+
+        Args:
+            destination (str): The destination name or address to resolve.
+
+        Returns:
+            tuple[str | None, list[str]]: The address (if available) and resolved endpoints.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def sync_resolve(self, destination: str) -> list[str]:
+        """
+        Resolve the destination to a list of endpoints.
+
+        Args:
+            destination (str): The destination name or address to resolve.
+
+        Returns:
+            list[str]: The resolved endpoints.
+        """
+        raise NotImplementedError

uagents_core/utils/messages.py

@@ -14,8 +14,8 @@ from uagents_core.helpers import weighted_random_sample
 from uagents_core.identity import Identity
 from uagents_core.logger import get_logger
 from uagents_core.models import Model
-from uagents_core.types import DeliveryStatus, MsgStatus
-from uagents_core.utils.resolver import lookup_endpoint_for_agent
+from uagents_core.types import DeliveryStatus, MsgStatus, Resolver
+from uagents_core.utils.resolver import AlmanacResolver
 
 logger = get_logger("uagents_core.utils.messages")
 
@@ -89,6 +89,7 @@ def send_message_to_agent(
     session_id: UUID | None = None,
     strategy: Literal["first", "random", "all"] = "first",
     agentverse_config: AgentverseConfig | None = None,
+    resolver: Resolver | None = None,
 ) -> list[MsgStatus]:
     """
     Send a message to an agent with default settings.
@@ -103,9 +104,12 @@ def send_message_to_agent(
         agentverse_config (AgentverseConfig, optional): The configuration for the agentverse.
     """
     agentverse_config = agentverse_config or AgentverseConfig()
-    endpoints = lookup_endpoint_for_agent(
-        agent_identifier=destination, agentverse_config=agentverse_config
-    )
+
+    if not resolver:
+        resolver = AlmanacResolver(
+            agentverse_config=agentverse_config,
+        )
+    endpoints = resolver.sync_resolve(destination)
     if not endpoints:
         logger.error("No endpoints found for agent", extra={"destination": destination})
         return []

uagents_core/utils/resolver.py

@@ -14,6 +14,7 @@ from uagents_core.config import (
 from uagents_core.helpers import weighted_random_sample
 from uagents_core.identity import parse_identifier
 from uagents_core.logger import get_logger
+from uagents_core.types import Resolver
 
 logger = get_logger("uagents_core.utils.resolver")
 
@@ -71,3 +72,20 @@ def lookup_endpoint_for_agent(
         )
 
     return []
+
+
+class AlmanacResolver(Resolver):
+    def __init__(self, agentverse_config: AgentverseConfig | None = None):
+        self.agentverse_config = agentverse_config or AgentverseConfig()
+
+    async def resolve(self, destination: str) -> tuple[str | None, list[str]]:
+        endpoints = lookup_endpoint_for_agent(
+            agent_identifier=destination, agentverse_config=self.agentverse_config
+        )
+        return None, endpoints
+
+    def sync_resolve(self, destination: str) -> list[str]:
+        endpoints = lookup_endpoint_for_agent(
+            agent_identifier=destination, agentverse_config=self.agentverse_config
+        )
+        return endpoints

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)

{uagents_core-0.3.3.dist-info → uagents_core-0.3.5.dist-info}/METADATA

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

{uagents_core-0.3.3.dist-info → uagents_core-0.3.5.dist-info}/RECORD

@@ -1,5 +1,5 @@
 uagents_core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-uagents_core/config.py,sha256=Cz2c2qhS_0uqUPxG7mWiqQSXWI_rPrfC7VoTSwBkdWk,940
+uagents_core/config.py,sha256=dvecXVs_Ej2UqjgrL96QwsEoUpkwJX5rQ09hikCRbDQ,1086
 uagents_core/contrib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 uagents_core/contrib/protocols/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 uagents_core/contrib/protocols/chat/__init__.py,sha256=EAt2uQeaZtrSEdt2SiFyqFcC4nxKtyoJRaHhjKtwngw,3032
@@ -11,12 +11,13 @@ uagents_core/logger.py,sha256=5XLs3-XpKDeoSwtAE5pEM9h6x3pUPNbb0T0J7KvFmG0,877
 uagents_core/models.py,sha256=fxsFjRochkJUdgPltT1HWgBl-9K-HVQWl8sSMVgeJFY,1066
 uagents_core/protocol.py,sha256=T9jasOkltne33E16Y7VrqcB2moWVsv-Qh4XLZotyz8g,5428
 uagents_core/registration.py,sha256=lmDXnsAs2CvpgE1Ik0qja_0RAY7zJruK11_jUrlqlWs,3226
-uagents_core/storage.py,sha256=Nb_vvckp5FV48bcewFmYUoLFHAsWxwaiIv_-idFpGqQ,4480
-uagents_core/types.py,sha256=_W3EN1wEIRFxuhhBxyZxQH_dA_3AtoPPReIzrgcTUHc,1167
+uagents_core/storage.py,sha256=VLqMSFXOspzrlbUNvaqS95ht9oJze1c-p4CD6Ul80h4,5150
+uagents_core/types.py,sha256=nPK2ebRL6S-vLZx2AR3OO2RTEb_N2Yno6PqL8KHkeo4,1993
 uagents_core/utils/__init__.py,sha256=v0MaxDYCTtQlwbblEHCfLtbeTnA2hCmKKJk7mlcE20U,135
-uagents_core/utils/messages.py,sha256=5o3ahVaeGwzWMAxDs0fl2pC1duDq2VS_-czoVtZpkOc,5066
+uagents_core/utils/messages.py,sha256=x_99pLzMjKKuWrpSAAS9mtVUAjFEZco64mMmHJdtxEI,5149
 uagents_core/utils/registration.py,sha256=Lp17tn4knw4qpKx_mZO5gDHD6pGssUhux6SGDhhb7rc,14607
-uagents_core/utils/resolver.py,sha256=X18oe-WPU_6pfTc6x_Oa69kZQYCMidkaSeCs68Poaik,2169
-uagents_core-0.3.3.dist-info/METADATA,sha256=qXEPfhisZj17usBXwFkMcoFYtsd8l39XYGu5FHypvQc,1009
-uagents_core-0.3.3.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-uagents_core-0.3.3.dist-info/RECORD,,
+uagents_core/utils/resolver.py,sha256=zcHKkTWxuIHq1kR89RDocruGs3i1S2baQpg4TK4j8QY,2868
+uagents_core/utils/subscriptions.py,sha256=l29elYqKycgU3s2SN_oh-svfhDkqZce0-EIiv4jjxJw,2450
+uagents_core-0.3.5.dist-info/METADATA,sha256=UbvgotVaLQXTyBJUWwW3dmjs6inQO2J7iPz2ybU2Amw,1009
+uagents_core-0.3.5.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+uagents_core-0.3.5.dist-info/RECORD,,