acp-plugin-gamesdk 0.1.6__py3-none-any.whl → 0.1.8__py3-none-any.whl

acp_plugin_gamesdk/acp_client.py

@@ -1,12 +1,16 @@
-from datetime import datetime, timedelta
-from typing import List, Optional
-from web3 import Web3
+import json
 import requests
-from acp_plugin_gamesdk.interface import AcpAgent, AcpJobPhases, AcpOffering, AcpState
-from acp_plugin_gamesdk.acp_token import AcpToken, MemoType
 import time
 import traceback
 
+from datetime import datetime, timedelta, timezone
+from typing import List, Optional
+from web3 import Web3
+
+from acp_plugin_gamesdk.interface import AcpAgent, AcpJobPhases, AcpOffering, AcpState, AcpJobPhasesDesc
+from acp_plugin_gamesdk.acp_token import AcpToken, MemoType
+from dacite import from_dict, Config
+
 
 class AcpClient:
     def __init__(self, api_key: str, acp_token: AcpToken, acp_base_url: Optional[str] = None):
@@ -25,21 +29,29 @@ class AcpClient:
             f"{self.base_url}/states/{self.agent_wallet_address}",
             headers={"x-api-key": self.api_key}
         )
-        return response.json()
+        payload = response.json()
+        result = from_dict(data_class=AcpState, data=payload, config=Config(type_hooks={AcpJobPhasesDesc: AcpJobPhasesDesc}))
+        return result
 
-    def browse_agents(self, cluster: Optional[str] = None, query: Optional[str] = None) -> List[AcpAgent]:
-        url = f"{self.acp_base_url}/agents"
+    def browse_agents(
+        self,
+        cluster: Optional[str] = None,
+        query: Optional[str] = None,
+        rerank: Optional[bool] = True,
+        top_k: Optional[int] = 1,
+    ) -> List[AcpAgent]:
         
-        if query:
-            url += f"?search={requests.utils.quote(query)}"
-            
-        if cluster:
-            # Add & if there's already a parameter, otherwise add ?
-            separator = "&" if query else "?"
-            url += f"{separator}filters[cluster]={requests.utils.quote(cluster)}"
+        url = f"{self.acp_base_url}/agents"
+
+        params = {
+            "search": query,
+            "filters[cluster]": cluster,
+            "filters[walletAddress][$notIn]": self.agent_wallet_address,
+            "rerank": "true" if rerank else "false",
+            "top_k": top_k,
+        }
+        response = requests.get(url, params=params)
 
-        response = requests.get(url)
-        
         if response.status_code != 200:
             raise Exception(
                     f"Error occured in browse_agents function. Failed to browse agents.\n" 
@@ -64,19 +76,26 @@ class AcpClient:
                     name=agent["name"],
                     description=agent["description"],
                     wallet_address=agent["walletAddress"],
-                    offerings=offerings
+                    offerings=offerings,
+                    score=agent["score"],
+                    explanation=agent["explanation"]
                 )
             )
             
         return result
 
-    def create_job(self, provider_address: str, price: float, job_description: str, evaluator_address: str) -> int:
-        expire_at = datetime.now() + timedelta(days=1)
-        
-        tx_result =  self.acp_token.create_job(
-            provider_address=provider_address,
-            evaluator_address=evaluator_address,
-            expire_at=expire_at
+    def create_job(
+            self,
+            provider_address: str,
+            price: float,
+            job_description: str,
+            evaluator_address: str,
+            expired_at: datetime,
+    ) -> int:
+        tx_result = self.acp_token.create_job(
+            provider_address = provider_address,
+            evaluator_address = evaluator_address,
+            expire_at = expired_at
         )
         
         job_id = None
@@ -128,7 +147,7 @@ class AcpClient:
             "providerAddress": provider_address,
             "description": job_description,
             "price": price,
-            "expiredAt": expire_at.isoformat(),
+            "expiredAt": expired_at.astimezone(timezone.utc).isoformat(),
             "evaluatorAddress": evaluator_address
         }
 
@@ -230,7 +249,6 @@ class AcpClient:
                 f"Response status code: {response.status_code}\n"
                 f"Response description: {response.text}\n"
             )
-            raise Exception(f"Failed to reset state: {response.status_code} {response.text}")
         
     def delete_completed_job(self, job_id: int) -> None:
         response = requests.delete(

acp_plugin_gamesdk/acp_plugin.py

@@ -3,8 +3,9 @@ import signal
 import sys
 from typing import List, Dict, Any, Optional,Tuple
 import json
-from dataclasses import dataclass
-from datetime import datetime
+from dataclasses import dataclass, asdict
+from datetime import datetime, timezone, timedelta
+import traceback
 
 import socketio
 import socketio.client
@@ -26,6 +27,7 @@ class AcpPluginOptions:
     evaluator_cluster: Optional[str] = None
     on_evaluate: Optional[Callable[[IDeliverable], Tuple[bool, str]]] = None
     on_phase_change: Optional[Callable[[AcpJob], None]] = None
+    job_expiry_duration_mins: Optional[int] = None
     
 
 SocketEvents = {
@@ -74,6 +76,7 @@ class AcpPlugin:
             if options.on_phase_change is not None:
                 self.on_phase_change = options.on_phase_change
             self.initializeSocket()
+        self.job_expiry_duration_mins = options.job_expiry_duration_mins if options.job_expiry_duration_mins is not None else 1440
         
         
         
@@ -152,8 +155,9 @@ class AcpPlugin:
         
     def get_acp_state(self) -> Dict:
         server_state = self.acp_client.get_state()
-        server_state["inventory"]["produced"] = self.produced_inventory
-        return server_state
+        server_state.inventory.produced = self.produced_inventory
+        state = asdict(server_state)
+        return state
 
     def get_worker(self, data: Optional[Dict] = None) -> WorkerConfig:
         functions = data.get("functions") if data else [
@@ -201,18 +205,42 @@ class AcpPlugin:
     def _search_agents_executable(self,reasoning: str, keyword: str) -> Tuple[FunctionResultStatus, str, dict]:
         if not reasoning:
             return FunctionResultStatus.FAILED, "Reasoning for the search must be provided. This helps track your decision-making process for future reference.", {}
-            
-        agents = self.acp_client.browse_agents(self.cluster, keyword)
-        
+
+        agents = self.acp_client.browse_agents(self.cluster, keyword, rerank=True, top_k=1)
+
         if not agents:
             return FunctionResultStatus.FAILED, "No other trading agents found in the system. Please try again later when more agents are available.", {}
-        
-        return FunctionResultStatus.DONE, json.dumps({
-            "availableAgents": [{"id": agent.id, "name": agent.name, "description": agent.description, "wallet_address": agent.wallet_address, "offerings": [{"name": offering.name, "price": offering.price} for offering in agent.offerings] if agent.offerings else []} for agent in agents],
-            "totalAgentsFound": len(agents),
-            "timestamp": datetime.now().timestamp(),
-            "note": "Use the walletAddress when initiating a job with your chosen trading partner."
-        }), {}
+
+        return (
+            FunctionResultStatus.DONE,
+            json.dumps(
+                {
+                    "availableAgents": [
+                        {
+                            "id": agent.id,
+                            "name": agent.name,
+                            "description": agent.description,
+                            "wallet_address": agent.wallet_address,
+                            "offerings": (
+                                [
+                                    {"name": offering.name, "price": offering.price}
+                                    for offering in agent.offerings
+                                ]
+                                if agent.offerings
+                                else []
+                            ),
+                            "score": agent.score,
+                            "explanation": agent.explanation
+                        }
+                        for agent in agents
+                    ],
+                    "totalAgentsFound": len(agents),
+                    "timestamp": datetime.now().timestamp(),
+                    "note": "Use the walletAddress when initiating a job with your chosen trading partner.",
+                }
+            ),
+            {},
+        )
 
     @property
     def search_agents_functions(self) -> Function:
@@ -290,7 +318,14 @@ class AcpPlugin:
             executable=self._initiate_job_executable
         )
 
-    def _initiate_job_executable(self, sellerWalletAddress: str, price: str, reasoning: str, serviceRequirements: str, requireEvaluation: bool, evaluatorKeyword: str, tweetContent: Optional[str] = None) -> Tuple[FunctionResultStatus, str, dict]:
+    def _initiate_job_executable(self, sellerWalletAddress: str, price: str, reasoning: str, serviceRequirements: str, requireEvaluation: str, evaluatorKeyword: str, tweetContent: Optional[str] = None) -> Tuple[FunctionResultStatus, str, dict]:
+        if isinstance(requireEvaluation, str):
+            require_evaluation = requireEvaluation.lower() == 'true'
+        elif isinstance(requireEvaluation, bool):
+            require_evaluation = requireEvaluation
+        else:
+            require_evaluation = False
+
         if not price:
             return FunctionResultStatus.FAILED, "Missing price - specify how much you're offering per unit", {}
         
@@ -306,13 +341,13 @@ class AcpPlugin:
             if not sellerWalletAddress:
                 return FunctionResultStatus.FAILED, "Missing seller wallet address - specify the agent you want to buy from", {}
             
-            if bool(requireEvaluation) and not evaluatorKeyword:
+            if require_evaluation and not evaluatorKeyword:
                 return FunctionResultStatus.FAILED, "Missing validator keyword - provide a keyword to search for a validator", {}
             
             evaluatorAddress = self.acp_token_client.get_agent_wallet_address()
             
-            if bool(requireEvaluation):
-                validators = self.acp_client.browse_agents(self.evaluator_cluster, evaluatorKeyword)
+            if require_evaluation:
+                validators = self.acp_client.browse_agents(self.evaluator_cluster, evaluatorKeyword, rerank=True, top_k=1)
                 
                 if len(validators) == 0:
                     return FunctionResultStatus.FAILED, "No evaluator found - try a different keyword", {}
@@ -320,11 +355,13 @@ class AcpPlugin:
                 evaluatorAddress = validators[0].wallet_address
             
             # ... Rest of validation logic ...
+            expired_at = datetime.now(timezone.utc) + timedelta(minutes=self.job_expiry_duration_mins)
             job_id = self.acp_client.create_job(
                 sellerWalletAddress,
                 float(price),
                 serviceRequirements,
-                evaluatorAddress
+                evaluatorAddress,
+                expired_at
             )
             
             if (hasattr(self, 'twitter_plugin') and self.twitter_plugin is not None and tweetContent is not None):
@@ -342,6 +379,7 @@ class AcpPlugin:
                 "timestamp": datetime.now().timestamp(),
             }), {}
         except Exception as e:
+            print(traceback.format_exc())
             return FunctionResultStatus.FAILED, f"System error while initiating job - try again after a short delay. {str(e)}", {}
 
     @property
@@ -515,6 +553,7 @@ class AcpPlugin:
                 "timestamp": datetime.now().timestamp()
             }), {}
         except Exception as e:
+            print(traceback.format_exc())
             return FunctionResultStatus.FAILED, f"System error while processing payment - try again after a short delay. {str(e)}", {}
 
     @property
@@ -585,7 +624,7 @@ class AcpPlugin:
                 return FunctionResultStatus.FAILED, f"Cannot deliver - job is in '{job['phase']}' phase, must be in 'transaction' phase", {}
 
             produced = next(
-                (i for i in self.produced_inventory if i["jobId"] == job["jobId"]),
+                (i for i in self.produced_inventory if i.jobId == job["jobId"]),
                 None
             )
 
@@ -620,4 +659,5 @@ class AcpPlugin:
                 "timestamp": datetime.now().timestamp()
             }), {}
         except Exception as e:
+            print(traceback.format_exc())
             return FunctionResultStatus.FAILED, f"System error while delivering items - try again after a short delay. {str(e)}", {}

acp_plugin_gamesdk/acp_token.py

@@ -8,6 +8,7 @@ from acp_plugin_gamesdk.acp_token_abi import ACP_TOKEN_ABI
 import requests
 from eth_account.messages import encode_defunct
 import json
+import traceback
 
 class MemoType(IntEnum):
     MESSAGE = 0
@@ -97,6 +98,7 @@ class AcpToken:
             response = requests.post(f"{self.acp_base_url}/acp-agent-wallets/trx-result", json={"userOpHash": hash_value})
             return response.json()
         except Exception as error:
+            print(traceback.format_exc())
             raise Exception(f"Failed to get job_id {error}")
 
     def create_job(
@@ -134,8 +136,8 @@ class AcpToken:
             # Return transaction hash or response ID
             return {"txHash": response.json().get("data", {}).get("userOpHash", "")}
         
-        except Exception as error:
-            raise Exception(f"{error}")
+        except Exception as e:
+            raise
 
     def approve_allowance(self, price_in_wei: int) -> str:
         try:
@@ -158,8 +160,9 @@ class AcpToken:
                 raise Exception(f"Failed to approve allowance {response.json().get('error').get('status')}, Message: {response.json().get('error').get('message')}")
             
             return response.json()
-        except Exception as error:
-            raise Exception(f"{error}")
+        except Exception as e:
+            print(f"An error occurred while approving allowance: {e}")
+            raise
 
     def create_memo(
         self,
@@ -170,6 +173,7 @@ class AcpToken:
         next_phase: int
     ) -> dict:
         retries = 3
+        error = None
         while retries > 0:
             try:
                 trx_data, signature = self._sign_transaction(
@@ -190,12 +194,15 @@ class AcpToken:
                     raise Exception(f"Failed to create memo {response.json().get('error').get('status')}, Message: {response.json().get('error').get('message')}")
                 
                 return { "txHash": response.json().get("txHash", response.json().get("id", "")), "memoId": response.json().get("memoId", "")}
-            except Exception as error:
-                print(f"{error}")
+            except Exception as e:
+                print(f"{e}")
+                print(traceback.format_exc())
+                error = e
                 retries -= 1
                 time.sleep(2 * (3 - retries))
                 
-        raise Exception(f"{error}")
+            if error:
+                raise Exception(f"{error}")
 
     def _sign_transaction(self, method_name: str, args: list, contract_address: Optional[str] = None) -> Tuple[dict, str]:
         if contract_address:
@@ -225,6 +232,7 @@ class AcpToken:
         reason: Optional[str] = ""
     ) -> str:
         retries = 3
+        error = None
         while retries > 0:
             try:
                 trx_data, signature = self._sign_transaction(
@@ -246,8 +254,10 @@ class AcpToken:
                 
                 return response.json()
                 
-            except Exception as error:
+            except Exception as e:
+                error = e
                 print(f"{error}")
+                print(traceback.format_exc())
                 retries -= 1
                 time.sleep(2 * (3 - retries))
                 

acp_plugin_gamesdk/interface.py

@@ -1,11 +1,18 @@
 from dataclasses import dataclass
 from enum import IntEnum, Enum
-from typing import List, Dict, Literal, Optional
+from typing import List, Literal, Optional
 
 @dataclass
 class AcpOffering:
     name: str
     price: float
+
+    def __str__(self) -> str:
+        output = (
+            f"Offering(name={self.name}, price={self.price})"
+        )
+        return output
+    
 @dataclass
 class AcpAgent:
     id: str
@@ -13,6 +20,23 @@ class AcpAgent:
     description: str
     wallet_address: str
     offerings: Optional[List[AcpOffering]]
+    score: Optional[float]
+    explanation: Optional[str]
+
+    def __str__(self) -> str:
+        offer = ""
+        if self.offerings:
+            for index, off in enumerate(self.offerings):
+                offer += f"{index+1}. {str(off)}\n"
+
+        output = (
+            f"😎 Agent ID={self.id}\n"
+            f"Name={self.name}, Description={self.description}, Wallet={self.wallet_address}\n"
+            f"Offerings:\n{offer}"
+            f"Score:\n{self.score}"
+            f"Explanation:\n{self.explanation}"
+        )
+        return output
     
 class AcpJobPhases(IntEnum):
     REQUEST = 0
@@ -33,7 +57,11 @@ class AcpJobPhasesDesc(str, Enum):
 @dataclass
 class AcpRequestMemo:
     id: int
-    created_at: int
+    createdAt: int
+
+    def __repr__(self) -> str:
+        output = f"Memo(ID: {self.id}, created at: {self.createdAt})"
+        return output
     
 @dataclass
 class ITweet:
@@ -41,29 +69,59 @@ class ITweet:
     tweet_id: str
     content: str
     created_at: int
+
 @dataclass
 class AcpJob:
-    job_id: int
+    jobId: Optional[int]
     desc: str
     price: str
     phase: AcpJobPhasesDesc
     memo: List[AcpRequestMemo]
-    tweet_history : ITweet
-    last_updated: int
+    lastUpdated: int
+    tweetHistory : ITweet | List
+    lastUpdated: int
+
+    def __repr__(self) -> str:
+        output =(
+            f"Job ID: {self.jobId}, "
+            f"Description: {self.desc}, "
+            f"Price: {self.price}, "
+            f"Phase: {self.phase.value}, "
+            f"Memo: {self.memo}, "
+            f"Last Updated: {self.lastUpdated})"
+            f"Tweet History: {self.tweetHistory}, "
+            f"Last Updated: {self.lastUpdated})"
+        ) 
+        return output
 
 @dataclass
 class IDeliverable:
-    type: Literal["url", "text"]
+    type: str
     value: str
 
 @dataclass
 class IInventory(IDeliverable):
-    job_id: int
+    jobId: int
 
 @dataclass
 class AcpJobsSection:
-    as_a_buyer: List[AcpJob]
-    as_a_seller: List[AcpJob]
+    asABuyer: List[AcpJob]
+    asASeller: List[AcpJob]
+
+    def __str__(self) -> str:
+        buyer_jobs = ""
+        for index, job in enumerate(self.asABuyer):
+            buyer_jobs += f"#{index+1} {str(job)} \n"
+
+        seller_jobs = ""
+        for index, job in enumerate(self.asASeller):
+            seller_jobs += f"#{index+1} {str(job)} \n"
+
+        output = (
+            f"As Buyer:\n{buyer_jobs}\n"
+            f"As Seller:\n{seller_jobs}\n"
+        )
+        return output
 
 @dataclass
 class AcpJobs:
@@ -71,12 +129,38 @@ class AcpJobs:
     completed: List[AcpJob]
     cancelled: List[AcpJob]
 
+    def __str__(self) -> str:
+        output = (
+            f"💻 Jobs\n"
+            f"🌕 Active Jobs:\n{self.active}\n"
+            f"🟢 Completed:\n{self.completed}\n"
+            f"🔴 Cancelled:\n{self.cancelled}\n"
+        )
+        return output
+    
 @dataclass
 class AcpInventory:
-    aquired: List[IInventory]
-    produced: List[IInventory]
+    acquired: List[IInventory]
+    produced: Optional[List[IInventory]]
+
+    def __str__(self) -> str:
+        output = (
+            f"💼 Inventory\n"
+            f"Acquired: {self.acquired}\n"
+            f"Produced: {self.produced}\n"
+        )
+        return output
 
 @dataclass
 class AcpState:
     inventory: AcpInventory
     jobs: AcpJobs
+
+    def __str__(self) -> str:
+        output = (
+            f"🤖 Agent State".center(50, '=') + "\n" + \
+            f"{str(self.inventory)}\n" + \
+            f"{str(self.jobs)}\n" + \
+            f"State End".center(50, '=') + "\n"
+        )
+        return output

{acp_plugin_gamesdk-0.1.6.dist-info → acp_plugin_gamesdk-0.1.8.dist-info}/METADATA

@@ -1,23 +1,26 @@
 Metadata-Version: 2.3
 Name: acp-plugin-gamesdk
-Version: 0.1.6
+Version: 0.1.8
 Summary: ACP Plugin for Python SDK for GAME by Virtuals
 Author: Steven Lee Soon Fatt
 Author-email: steven@virtuals.io
-Requires-Python: >=3.10,<4
+Requires-Python: >=3.9,<3.13
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: aiohttp (>=3.11.14,<4.0.0)
+Requires-Dist: dacite (>=1.9.2,<2.0.0)
 Requires-Dist: eth-account (>=0.13.6,<0.14.0)
 Requires-Dist: eth-typing (>=5.2.0,<6.0.0)
 Requires-Dist: eth-utils (>=5.2.0,<6.0.0)
 Requires-Dist: game-sdk (>=0.1.5)
 Requires-Dist: pydantic (>=2.10.6,<3.0.0)
+Requires-Dist: python-dotenv (>=1.1.0,<2.0.0)
 Requires-Dist: python-socketio (>=5.11.1,<6.0.0)
 Requires-Dist: requests (>=2.32.3,<3.0.0)
+Requires-Dist: rich (>=14.0.0,<15.0.0)
 Requires-Dist: twitter-plugin-gamesdk (>=0.2.2)
 Requires-Dist: virtuals-sdk (>=0.1.6,<0.2.0)
 Requires-Dist: web3 (>=7.9.0,<8.0.0)
@@ -164,6 +167,20 @@ acp_plugin = AcpPlugin(
 
 5. (Optional) If you want to listen to the `ON_EVALUATE` event, you can implement the `on_evaluate` function.
 
+
+Evaluation refers to the process where buyer agent reviews the result submitted by the seller and decides whether to accept or reject it.
+This is where the `on_evaluate` function comes into play. It allows your agent to programmatically verify deliverables and enforce quality checks.
+
+🔍 **Example implementations can be found in:**
+
+Use Cases:
+- Basic always-accept evaluation
+- URL and file validation examples
+
+Source Files:
+- [examples/agentic/README.md](examples/agentic/README.md)
+- [examples/reactive/README.md](examples/reactive/README.md)
+
 ```python
 def on_evaluate(deliverable: IDeliverable) -> Tuple[bool, str]:
     print(f"Evaluating deliverable: {deliverable}")

acp_plugin_gamesdk-0.1.8.dist-info/RECORD

@@ -0,0 +1,8 @@
+acp_plugin_gamesdk/acp_client.py,sha256=zF-FLFJ2PbS3LeI3cDx63pJyWCAVb8YQn7yZHQQ9wtY,9254
+acp_plugin_gamesdk/acp_plugin.py,sha256=pFQ9QzGvs8EQ8kAkC_VAqc2tSTu9knueOBcK51oy9rk,28262
+acp_plugin_gamesdk/acp_token.py,sha256=E7nkLVfXSzMozFoVcYGzVQyocnKQpohb_YlByZtVY_8,12078
+acp_plugin_gamesdk/acp_token_abi.py,sha256=nllh9xOuDXxFFdhLklTTdtZxWZd2LcUTBoOP2d9xDTA,22319
+acp_plugin_gamesdk/interface.py,sha256=TsNQ74qW80YcUESOmBWX0wWzCTXG7S9eSF1mnfoJj0U,3983
+acp_plugin_gamesdk-0.1.8.dist-info/METADATA,sha256=hh41VpuRlSke7KOjtp3Tbv9rlX29q7VNIIc0_Gh19eU,12223
+acp_plugin_gamesdk-0.1.8.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+acp_plugin_gamesdk-0.1.8.dist-info/RECORD,,

acp_plugin_gamesdk-0.1.6.dist-info/RECORD

@@ -1,8 +0,0 @@
-acp_plugin_gamesdk/acp_client.py,sha256=JRrlfaRDgP2uZpbX8Vea-uHO6yicn488bmi_IXGVvt8,8896
-acp_plugin_gamesdk/acp_plugin.py,sha256=M4pZ6UyTk60CEA_R2tvKVRezd4CZQOFna94jzrM6_ss,26778
-acp_plugin_gamesdk/acp_token.py,sha256=Wx87e2Wd-5QUKoMWX_wf3IBEP-cl1pSyA9IZr1yYIDE,11796
-acp_plugin_gamesdk/acp_token_abi.py,sha256=nllh9xOuDXxFFdhLklTTdtZxWZd2LcUTBoOP2d9xDTA,22319
-acp_plugin_gamesdk/interface.py,sha256=mWZ41SycGrNQbnC_IfBq8K6TgpguCvvbVTqFg8Uxy58,1549
-acp_plugin_gamesdk-0.1.6.dist-info/METADATA,sha256=w_mr3J8GkBN5AY6IU-CVfKpZG-lv4pu4cMSLOHxN7zw,11545
-acp_plugin_gamesdk-0.1.6.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-acp_plugin_gamesdk-0.1.6.dist-info/RECORD,,