acp-plugin-gamesdk 0.1.5__tar.gz → 0.1.7__tar.gz

{acp_plugin_gamesdk-0.1.5 → acp_plugin_gamesdk-0.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: acp-plugin-gamesdk
-Version: 0.1.5
+Version: 0.1.7
 Summary: ACP Plugin for Python SDK for GAME by Virtuals
 Author: Steven Lee Soon Fatt
 Author-email: steven@virtuals.io
@@ -164,6 +164,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}")
@@ -288,4 +302,5 @@ To register your agent, please head over to the [agent registry](https://acp-sta
 1. [Agent Commerce Protocol (ACP) research page](https://app.virtuals.io/research/agent-commerce-protocol)
    - This webpage introduces the Agent Commerce Protocol - A Standard for Permissionless AI Agent Commerce, a piece of research done by the Virtuals Protocol team
    - It includes the links to the multi-agent demo dashboard and paper.
+2. [ACP Plugin FAQs](https://virtualsprotocol.notion.site/ACP-Plugin-FAQs-Troubleshooting-Tips-1d62d2a429e980eb9e61de851b6a7d60?pvs=4)
 

{acp_plugin_gamesdk-0.1.5 → acp_plugin_gamesdk-0.1.7}/README.md

@@ -138,6 +138,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}")
@@ -262,3 +276,4 @@ To register your agent, please head over to the [agent registry](https://acp-sta
 1. [Agent Commerce Protocol (ACP) research page](https://app.virtuals.io/research/agent-commerce-protocol)
    - This webpage introduces the Agent Commerce Protocol - A Standard for Permissionless AI Agent Commerce, a piece of research done by the Virtuals Protocol team
    - It includes the links to the multi-agent demo dashboard and paper.
+2. [ACP Plugin FAQs](https://virtualsprotocol.notion.site/ACP-Plugin-FAQs-Troubleshooting-Tips-1d62d2a429e980eb9e61de851b6a7d60?pvs=4)

{acp_plugin_gamesdk-0.1.5 → acp_plugin_gamesdk-0.1.7}/acp_plugin_gamesdk/acp_client.py

@@ -29,14 +29,15 @@ class AcpClient:
 
     def browse_agents(self, cluster: Optional[str] = None, query: Optional[str] = None) -> List[AcpAgent]:
         url = f"{self.acp_base_url}/agents"
-        
+
+        # agent must exclude itself from search result to prevent self-commission
+        url += f"?filters[walletAddress][$notIn]={self.agent_wallet_address}"
+
         if query:
-            url += f"?search={requests.utils.quote(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"&filters[cluster]={requests.utils.quote(cluster)}"
 
         response = requests.get(url)
         
@@ -173,7 +174,15 @@ class AcpClient:
         time.sleep(5)
         self.acp_token.approve_allowance(amount_wei)
         time.sleep(5)
-        return self.acp_token.sign_memo(memo_id, True, reason)
+        self.acp_token.sign_memo(memo_id, True, reason)
+        time.sleep(5)
+        return self.acp_token.create_memo(
+            job_id=job_id,
+            content=f"Payment of {amount} made {reason}",
+            memo_type=MemoType.MESSAGE,
+            is_secured=False,
+            next_phase=AcpJobPhases.EVALUATION
+        )
 
     def deliver_job(self, job_id: int, deliverable: str):
         return self.acp_token.create_memo(
@@ -223,3 +232,16 @@ class AcpClient:
                 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(
+            f"{self.base_url}/{job_id}/wallet/{self.agent_wallet_address}",
+            headers={"x-api-key": self.api_key}
+        )
+        
+        if response.status_code not in [200, 204]:
+            raise Exception(
+                f"Error occurred in delete_completed_job function. Failed to delete job.\n"
+                f"Response status code: {response.status_code}\n"
+                f"Response description: {response.text}\n"
+            )

{acp_plugin_gamesdk-0.1.5 → acp_plugin_gamesdk-0.1.7}/acp_plugin_gamesdk/acp_plugin.py

@@ -15,7 +15,7 @@ from twitter_plugin_gamesdk.twitter_plugin import TwitterPlugin
 from twitter_plugin_gamesdk.game_twitter_plugin import GameTwitterPlugin
 from acp_plugin_gamesdk.acp_client import AcpClient
 from acp_plugin_gamesdk.acp_token import AcpToken
-from acp_plugin_gamesdk.interface import AcpJobPhasesDesc, IDeliverable, IInventory
+from acp_plugin_gamesdk.interface import AcpJobPhasesDesc, IDeliverable, IInventory, AcpJob
 
 @dataclass
 class AcpPluginOptions:
@@ -25,12 +25,15 @@ class AcpPluginOptions:
     cluster: Optional[str] = None
     evaluator_cluster: Optional[str] = None
     on_evaluate: Optional[Callable[[IDeliverable], Tuple[bool, str]]] = None
+    on_phase_change: Optional[Callable[[AcpJob], None]] = None
+    
 
 SocketEvents = {
     "JOIN_EVALUATOR_ROOM": "joinEvaluatorRoom",
     "LEAVE_EVALUATOR_ROOM": "leaveEvaluatorRoom", 
     "ON_EVALUATE": "onEvaluate",
-    "ROOM_JOINED" : "roomJoined"
+    "ROOM_JOINED" : "roomJoined",
+    "ON_PHASE_CHANGE": "onPhaseChange"
 }
 
 class AcpPlugin:
@@ -63,12 +66,17 @@ class AcpPlugin:
             
         self.produced_inventory: List[IInventory] = []
         self.acp_base_url = self.acp_token_client.acp_base_url if self.acp_token_client.acp_base_url is None else "https://acpx-staging.virtuals.io/api"
-        if (options.on_evaluate is not None):
+        if options.on_evaluate is not None or options.on_phase_change is not None:
             print("Initializing socket")
-            self.on_evaluate = options.on_evaluate
             self.socket = None
+            if options.on_evaluate is not None:
+                self.on_evaluate = options.on_evaluate
+            if options.on_phase_change is not None:
+                self.on_phase_change = options.on_phase_change
             self.initializeSocket()
         
+        
+        
     def initializeSocket(self) -> Tuple[bool, str]:
         """
         Initialize socket connection for real-time communication.
@@ -99,15 +107,23 @@ class AcpPlugin:
                     is_approved, reasoning = self.on_evaluate(deliverable)
                     
                     self.acp_token_client.sign_memo(memo_id, is_approved, reasoning)
+                    
+                        # Set up event handler for phase changes
+            @self.socket.on(SocketEvents["ON_PHASE_CHANGE"])
+            def on_phase_change(data):
+                if hasattr(self, 'on_phase_change') and self.on_phase_change:
+                    print(f"on_phase_change: {data}")
+                    self.on_phase_change(data)
             
             # Set up cleanup function for graceful shutdown
             def cleanup():
                 if self.socket:
                     print("Disconnecting socket")
-                    
                     import time
                     time.sleep(1)
                     self.socket.disconnect()
+                    
+                    
             
             def signal_handler(sig, frame):
                 cleanup()
@@ -122,6 +138,8 @@ class AcpPlugin:
             return False, f"Failed to initialize socket: {str(e)}"
     
     
+    def set_on_phase_change(self, on_phase_change: Callable[[AcpJob], None]) -> None:
+        self.on_phase_change = on_phase_change
 
     def add_produce_item(self, item: IInventory) -> None:
         self.produced_inventory.append(item)
@@ -129,6 +147,9 @@ class AcpPlugin:
     def reset_state(self) -> None:
         self.acp_client.reset_state()
         
+    def delete_completed_job(self, job_id: int) -> None:
+        self.acp_client.delete_completed_job(job_id)
+        
     def get_acp_state(self) -> Dict:
         server_state = self.acp_client.get_state()
         server_state["inventory"]["produced"] = self.produced_inventory
@@ -269,7 +290,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", {}
         
@@ -285,12 +313,12 @@ 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):
+            if require_evaluation:
                 validators = self.acp_client.browse_agents(self.evaluator_cluster, evaluatorKeyword)
                 
                 if len(validators) == 0:

{acp_plugin_gamesdk-0.1.5 → acp_plugin_gamesdk-0.1.7}/acp_plugin_gamesdk/acp_token.py

@@ -107,6 +107,7 @@ class AcpToken:
     ) -> dict:
         try:
             provider_address = Web3.to_checksum_address(provider_address)
+            evaluator_address = Web3.to_checksum_address(evaluator_address)
             expire_timestamp = int(expire_at.timestamp())
         
             # Sign the transaction

{acp_plugin_gamesdk-0.1.5 → acp_plugin_gamesdk-0.1.7}/acp_plugin_gamesdk/interface.py

@@ -34,7 +34,13 @@ class AcpJobPhasesDesc(str, Enum):
 class AcpRequestMemo:
     id: int
     created_at: int
-
+    
+@dataclass
+class ITweet:
+    type: Literal["buyer", "seller"]
+    tweet_id: str
+    content: str
+    created_at: int
 @dataclass
 class AcpJob:
     job_id: int
@@ -42,6 +48,7 @@ class AcpJob:
     price: str
     phase: AcpJobPhasesDesc
     memo: List[AcpRequestMemo]
+    tweet_history : ITweet
     last_updated: int
 
 @dataclass

{acp_plugin_gamesdk-0.1.5 → acp_plugin_gamesdk-0.1.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "acp-plugin-gamesdk"
-version = "0.1.5"
+version = "0.1.7"
 description = "ACP Plugin for Python SDK for GAME by Virtuals"
 authors = ["Steven Lee Soon Fatt <steven@virtuals.io>"]
 readme = "README.md"