prediction-market-agent-tooling 0.57.7__tar.gz → 0.57.9__tar.gz

{prediction_market_agent_tooling-0.57.7 → prediction_market_agent_tooling-0.57.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: prediction-market-agent-tooling
-Version: 0.57.7
+Version: 0.57.9
 Summary: Tools to benchmark, deploy and monitor prediction market agents.
 Author: Gnosis
 Requires-Python: >=3.10,<3.12

prediction_market_agent_tooling-0.57.9/prediction_market_agent_tooling/abis/agentcommunication.abi.json

@@ -0,0 +1,328 @@
+[
+        {
+            "type": "constructor",
+            "inputs": [
+                {
+                    "name": "_treasury",
+                    "type": "address",
+                    "internalType": "address payable"
+                },
+                {
+                    "name": "_pctToTreasuryInBasisPoints",
+                    "type": "uint256",
+                    "internalType": "uint256"
+                }
+            ],
+            "stateMutability": "nonpayable"
+        },
+        {
+            "type": "function",
+            "name": "adjustMinimumValueForSendingMessage",
+            "inputs": [
+                {
+                    "name": "newValue",
+                    "type": "uint256",
+                    "internalType": "uint256"
+                }
+            ],
+            "outputs": [],
+            "stateMutability": "nonpayable"
+        },
+        {
+            "type": "function",
+            "name": "countMessages",
+            "inputs": [
+                {
+                    "name": "agentAddress",
+                    "type": "address",
+                    "internalType": "address"
+                }
+            ],
+            "outputs": [
+                {
+                    "name": "",
+                    "type": "uint256",
+                    "internalType": "uint256"
+                }
+            ],
+            "stateMutability": "view"
+        },
+        {
+            "type": "function",
+            "name": "getAtIndex",
+            "inputs": [
+                {
+                    "name": "agentAddress",
+                    "type": "address",
+                    "internalType": "address"
+                },
+                {
+                    "name": "idx",
+                    "type": "uint256",
+                    "internalType": "uint256"
+                }
+            ],
+            "outputs": [
+                {
+                    "name": "",
+                    "type": "tuple",
+                    "internalType": "struct DoubleEndedStructQueue.MessageContainer",
+                    "components": [
+                        {
+                            "name": "sender",
+                            "type": "address",
+                            "internalType": "address"
+                        },
+                        {
+                            "name": "recipient",
+                            "type": "address",
+                            "internalType": "address"
+                        },
+                        {
+                            "name": "message",
+                            "type": "bytes",
+                            "internalType": "bytes"
+                        },
+                        {
+                            "name": "value",
+                            "type": "uint256",
+                            "internalType": "uint256"
+                        }
+                    ]
+                }
+            ],
+            "stateMutability": "view"
+        },
+        {
+            "type": "function",
+            "name": "minimumValueForSendingMessageInWei",
+            "inputs": [],
+            "outputs": [
+                {
+                    "name": "",
+                    "type": "uint256",
+                    "internalType": "uint256"
+                }
+            ],
+            "stateMutability": "view"
+        },
+        {
+            "type": "function",
+            "name": "owner",
+            "inputs": [],
+            "outputs": [
+                {
+                    "name": "",
+                    "type": "address",
+                    "internalType": "address"
+                }
+            ],
+            "stateMutability": "view"
+        },
+        {
+            "type": "function",
+            "name": "pctToTreasuryInBasisPoints",
+            "inputs": [],
+            "outputs": [
+                {
+                    "name": "",
+                    "type": "uint256",
+                    "internalType": "uint256"
+                }
+            ],
+            "stateMutability": "view"
+        },
+        {
+            "type": "function",
+            "name": "popNextMessage",
+            "inputs": [
+                {
+                    "name": "agentAddress",
+                    "type": "address",
+                    "internalType": "address"
+                }
+            ],
+            "outputs": [
+                {
+                    "name": "",
+                    "type": "tuple",
+                    "internalType": "struct DoubleEndedStructQueue.MessageContainer",
+                    "components": [
+                        {
+                            "name": "sender",
+                            "type": "address",
+                            "internalType": "address"
+                        },
+                        {
+                            "name": "recipient",
+                            "type": "address",
+                            "internalType": "address"
+                        },
+                        {
+                            "name": "message",
+                            "type": "bytes",
+                            "internalType": "bytes"
+                        },
+                        {
+                            "name": "value",
+                            "type": "uint256",
+                            "internalType": "uint256"
+                        }
+                    ]
+                }
+            ],
+            "stateMutability": "nonpayable"
+        },
+        {
+            "type": "function",
+            "name": "queues",
+            "inputs": [
+                {
+                    "name": "",
+                    "type": "address",
+                    "internalType": "address"
+                }
+            ],
+            "outputs": [
+                {
+                    "name": "_begin",
+                    "type": "uint128",
+                    "internalType": "uint128"
+                },
+                {
+                    "name": "_end",
+                    "type": "uint128",
+                    "internalType": "uint128"
+                }
+            ],
+            "stateMutability": "view"
+        },
+        {
+            "type": "function",
+            "name": "renounceOwnership",
+            "inputs": [],
+            "outputs": [],
+            "stateMutability": "nonpayable"
+        },
+        {
+            "type": "function",
+            "name": "sendMessage",
+            "inputs": [
+                {
+                    "name": "agentAddress",
+                    "type": "address",
+                    "internalType": "address"
+                },
+                {
+                    "name": "message",
+                    "type": "bytes",
+                    "internalType": "bytes"
+                }
+            ],
+            "outputs": [],
+            "stateMutability": "payable"
+        },
+        {
+            "type": "function",
+            "name": "transferOwnership",
+            "inputs": [
+                {
+                    "name": "newOwner",
+                    "type": "address",
+                    "internalType": "address"
+                }
+            ],
+            "outputs": [],
+            "stateMutability": "nonpayable"
+        },
+        {
+            "type": "function",
+            "name": "treasury",
+            "inputs": [],
+            "outputs": [
+                {
+                    "name": "",
+                    "type": "address",
+                    "internalType": "address payable"
+                }
+            ],
+            "stateMutability": "view"
+        },
+        {
+            "type": "event",
+            "name": "LogMessage",
+            "inputs": [
+                {
+                    "name": "sender",
+                    "type": "address",
+                    "indexed": true,
+                    "internalType": "address"
+                },
+                {
+                    "name": "agentAddress",
+                    "type": "address",
+                    "indexed": true,
+                    "internalType": "address"
+                },
+                {
+                    "name": "message",
+                    "type": "bytes",
+                    "indexed": false,
+                    "internalType": "bytes"
+                },
+                {
+                    "name": "value",
+                    "type": "uint256",
+                    "indexed": false,
+                    "internalType": "uint256"
+                }
+            ],
+            "anonymous": false
+        },
+        {
+            "type": "event",
+            "name": "OwnershipTransferred",
+            "inputs": [
+                {
+                    "name": "previousOwner",
+                    "type": "address",
+                    "indexed": true,
+                    "internalType": "address"
+                },
+                {
+                    "name": "newOwner",
+                    "type": "address",
+                    "indexed": true,
+                    "internalType": "address"
+                }
+            ],
+            "anonymous": false
+        },
+        {
+            "type": "error",
+            "name": "MessageNotSentByAgent",
+            "inputs": []
+        },
+        {
+            "type": "error",
+            "name": "OwnableInvalidOwner",
+            "inputs": [
+                {
+                    "name": "owner",
+                    "type": "address",
+                    "internalType": "address"
+                }
+            ]
+        },
+        {
+            "type": "error",
+            "name": "OwnableUnauthorizedAccount",
+            "inputs": [
+                {
+                    "name": "account",
+                    "type": "address",
+                    "internalType": "address"
+                }
+            ]
+        }
+    ]

{prediction_market_agent_tooling-0.57.7 → prediction_market_agent_tooling-0.57.9}/prediction_market_agent_tooling/markets/seer/data_models.py

@@ -3,13 +3,17 @@ from pydantic import BaseModel, ConfigDict, Field
 from prediction_market_agent_tooling.gtypes import HexBytes
 
 
+class SeerParentMarket(BaseModel):
+    id: HexBytes
+
+
 class SeerMarket(BaseModel):
     model_config = ConfigDict(populate_by_name=True)
 
     id: HexBytes
     title: str = Field(alias="marketName")
     outcomes: list[str]
-    parent_market: HexBytes = Field(alias="parentMarket")
+    parent_market: SeerParentMarket | None = Field(alias="parentMarket")
     wrapped_tokens: list[HexBytes] = Field(alias="wrappedTokens")
 
 

{prediction_market_agent_tooling-0.57.7 → prediction_market_agent_tooling-0.57.9}/prediction_market_agent_tooling/markets/seer/seer_subgraph_handler.py

@@ -47,7 +47,7 @@ class SeerSubgraphHandler(BaseSubgraphHandler):
             markets_field.creator,
             markets_field.marketName,
             markets_field.outcomes,
-            markets_field.parentMarket,
+            markets_field.parentMarket.id,
             markets_field.finalizeTs,
             markets_field.wrappedTokens,
         ]

{prediction_market_agent_tooling-0.57.7 → prediction_market_agent_tooling-0.57.9}/prediction_market_agent_tooling/tools/contract.py

@@ -18,6 +18,8 @@ from prediction_market_agent_tooling.gtypes import (
     TxReceipt,
     Wei,
 )
+from prediction_market_agent_tooling.tools.data_models import MessageContainer
+from prediction_market_agent_tooling.tools.hexbytes_custom import HexBytes
 from prediction_market_agent_tooling.tools.utils import DatetimeUTC, should_not_happen
 from prediction_market_agent_tooling.tools.web3_utils import (
     call_function_on_contract,
@@ -533,6 +535,88 @@ class DebuggingContract(ContractOnGnosisChain):
         )
 
 
+class AgentCommunicationContract(ContractOnGnosisChain):
+    # Contract ABI taken from built https://github.com/gnosis/labs-contracts.
+    abi: ABI = abi_field_validator(
+        os.path.join(
+            os.path.dirname(os.path.realpath(__file__)),
+            "../abis/agentcommunication.abi.json",
+        )
+    )
+
+    address: ChecksumAddress = Web3.to_checksum_address(
+        "0xd422e0059ed819e8d792af936da206878188e34f"
+    )
+
+    def count_unseen_messages(
+        self,
+        agent_address: ChecksumAddress,
+        web3: Web3 | None = None,
+    ) -> int:
+        unseen_message_count: int = self.call(
+            "countMessages", function_params=[agent_address], web3=web3
+        )
+        return unseen_message_count
+
+    def get_at_index(
+        self,
+        agent_address: ChecksumAddress,
+        idx: int,
+        web3: Web3 | None = None,
+    ) -> MessageContainer:
+        message_container_raw: t.Tuple[t.Any] = self.call(
+            "getAtIndex", function_params=[agent_address, idx], web3=web3
+        )
+        return MessageContainer.from_tuple(message_container_raw)
+
+    def pop_message(
+        self,
+        api_keys: APIKeys,
+        agent_address: ChecksumAddress,
+        web3: Web3 | None = None,
+    ) -> MessageContainer:
+        """
+        Retrieves and removes the first message from the agent's message queue.
+
+        This method first retrieves the message at the front of the queue without removing it,
+        allowing us to return the message content directly. The actual removal of the message
+        from the queue is performed by sending a transaction to the contract, which executes
+        the `popNextMessage` function. The transaction receipt is not used to obtain the message
+        content, as it only contains event data, not the returned struct.
+        """
+
+        # Peek first element before popping.
+        message_container = self.get_at_index(
+            agent_address=agent_address, idx=0, web3=web3
+        )
+
+        # Next, pop that element and discard the transaction receipt.
+        self.send(
+            api_keys=api_keys,
+            function_name="popNextMessage",
+            function_params=[agent_address],
+            web3=web3,
+        )
+
+        return message_container
+
+    def send_message(
+        self,
+        api_keys: APIKeys,
+        agent_address: ChecksumAddress,
+        message: HexBytes,
+        amount_wei: Wei,
+        web3: Web3 | None = None,
+    ) -> TxReceipt:
+        return self.send_with_value(
+            api_keys=api_keys,
+            function_name="sendMessage",
+            amount_wei=amount_wei,
+            function_params=[agent_address, message],
+            web3=web3,
+        )
+
+
 def contract_implements_function(
     contract_address: ChecksumAddress,
     function_name: str,

prediction_market_agent_tooling-0.57.9/prediction_market_agent_tooling/tools/data_models.py

@@ -0,0 +1,23 @@
+import typing as t
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from prediction_market_agent_tooling.gtypes import ChecksumAddress, HexBytes, Wei
+
+
+# Taken from https://github.com/gnosis/labs-contracts/blob/main/src/NFT/DoubleEndedStructQueue.sol
+class MessageContainer(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    sender: ChecksumAddress
+    recipient: ChecksumAddress = Field(alias="agentAddress")
+    message: HexBytes
+    value: Wei
+
+    @staticmethod
+    def from_tuple(values: tuple[t.Any, ...]) -> "MessageContainer":
+        return MessageContainer(
+            sender=values[0],
+            recipient=values[1],
+            message=HexBytes(values[2]),
+            value=values[3],
+        )

{prediction_market_agent_tooling-0.57.7 → prediction_market_agent_tooling-0.57.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "prediction-market-agent-tooling"
-version = "0.57.7"
+version = "0.57.9"
 description = "Tools to benchmark, deploy and monitor prediction market agents."
 authors = ["Gnosis"]
 readme = "README.md"