mech-client 0.14.1__py3-none-any.whl → 0.15.1__py3-none-any.whl

mech_client/helpers/acn/custom_types.py

@@ -1,224 +0,0 @@
-# -*- coding: utf-8 -*-
-# ------------------------------------------------------------------------------
-#
-#   Copyright 2022 Valory AG
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-#
-# ------------------------------------------------------------------------------
-
-"""This module contains class representations corresponding to every custom type in the protocol specification."""
-# pylint: disable-all
-from enum import Enum
-from typing import Any, List
-
-from aea.helpers.base import SimpleId, SimpleIdOrStr
-
-
-class AgentRecord:
-    """
-    This class represents an instance of AgentRecord.
-
-    Eventually needs to be unified with `aea.helpers.acn.agent_record`.
-    """
-
-    __slots__ = (
-        "_address",
-        "_public_key",
-        "_peer_public_key",
-        "_signature",
-        "_service_id",
-        "_ledger_id",
-        "_message_format",
-        "_message",
-    )
-
-    def __init__(
-        self,
-        address: str,
-        public_key: str,
-        peer_public_key: str,
-        signature: str,
-        service_id: SimpleIdOrStr,
-        ledger_id: SimpleIdOrStr,
-    ) -> None:
-        """Initialise an instance of AgentRecord."""
-        self._address = address
-        self._public_key = public_key
-        self._peer_public_key = peer_public_key
-        self._signature = signature
-        self._service_id = str(SimpleId(service_id))
-        self._ledger_id = str(SimpleId(ledger_id))
-
-    @property
-    def address(self) -> str:
-        """Get agent address"""
-        return self._address
-
-    @property
-    def public_key(self) -> str:
-        """Get agent public key"""
-        return self._public_key
-
-    @property
-    def peer_public_key(self) -> str:
-        """Get agent representative's public key"""
-        return self._peer_public_key
-
-    @property
-    def signature(self) -> str:
-        """Get record signature"""
-        return self._signature
-
-    @property
-    def service_id(self) -> SimpleIdOrStr:
-        """Get the identifier."""
-        return self._service_id
-
-    @property
-    def ledger_id(self) -> SimpleIdOrStr:
-        """Get ledger id."""
-        return self._ledger_id
-
-    @staticmethod
-    def encode(
-        agent_record_protobuf_object: Any, agent_record_object: "AgentRecord"
-    ) -> None:
-        """
-        Encode an instance of this class into the protocol buffer object.
-
-        The protocol buffer object in the agent_record_protobuf_object argument is matched with the instance of this class in the 'agent_record_object' argument.
-
-        :param agent_record_protobuf_object: the protocol buffer object whose type corresponds with this class.
-        :param agent_record_object: an instance of this class to be encoded in the protocol buffer object.
-        """
-        agent_record_protobuf_object.address = agent_record_object.address
-        agent_record_protobuf_object.public_key = agent_record_object.public_key
-        agent_record_protobuf_object.peer_public_key = (
-            agent_record_object.peer_public_key
-        )
-        agent_record_protobuf_object.signature = agent_record_object.signature
-        agent_record_protobuf_object.service_id = agent_record_object.service_id
-        agent_record_protobuf_object.ledger_id = agent_record_object.ledger_id
-
-    @classmethod
-    def decode(cls, agent_record_protobuf_object: Any) -> "AgentRecord":
-        """
-        Decode a protocol buffer object that corresponds with this class into an instance of this class.
-
-        A new instance of this class is created that matches the protocol buffer object in the 'agent_record_protobuf_object' argument.
-
-        :param agent_record_protobuf_object: the protocol buffer object whose type corresponds with this class.
-        :return: A new instance of this class that matches the protocol buffer object in the 'agent_record_protobuf_object' argument.
-        """
-        record = cls(
-            address=agent_record_protobuf_object.address,
-            public_key=agent_record_protobuf_object.public_key,
-            peer_public_key=agent_record_protobuf_object.peer_public_key,
-            signature=agent_record_protobuf_object.signature,
-            service_id=agent_record_protobuf_object.service_id,
-            ledger_id=agent_record_protobuf_object.ledger_id,
-        )
-        return record
-
-    def __eq__(self, other: Any) -> bool:
-        """Compare to objects of this class."""
-        return (
-            isinstance(other, AgentRecord)
-            and self.address == other.address
-            and self.public_key == other.public_key
-        )
-
-
-class StatusBody:
-    """This class represents an instance of StatusBody."""
-
-    __slots__ = (
-        "_status_code",
-        "_msgs",
-    )
-
-    class StatusCode(Enum):
-        """Status code enum."""
-
-        SUCCESS = 0
-        ERROR_UNSUPPORTED_VERSION = 1
-        ERROR_UNEXPECTED_PAYLOAD = 2
-        ERROR_GENERIC = 3
-        ERROR_DECODE = 4
-
-        ERROR_WRONG_AGENT_ADDRESS = 10
-        ERROR_WRONG_PUBLIC_KEY = 11
-        ERROR_INVALID_PROOF = 12
-        ERROR_UNSUPPORTED_LEDGER = 13
-
-        ERROR_UNKNOWN_AGENT_ADDRESS = 20
-        ERROR_AGENT_NOT_READY = 21
-
-        def __int__(self) -> int:
-            """Get string representation."""
-            return self.value
-
-    def __init__(self, status_code: StatusCode, msgs: List[str]) -> None:
-        """Initialise an instance of StatusBody."""
-        self._status_code = status_code
-        self._msgs = msgs
-
-    @property
-    def status_code(self) -> "StatusCode":
-        """Get the status code."""
-        return self._status_code
-
-    @property
-    def msgs(self) -> List[str]:
-        """Get the list of messages."""
-        return self._msgs
-
-    @staticmethod
-    def encode(
-        status_body_protobuf_object: Any, status_body_object: "StatusBody"
-    ) -> None:
-        """
-        Encode an instance of this class into the protocol buffer object.
-
-        The protocol buffer object in the status_body_protobuf_object argument is matched with the instance of this class in the 'status_body_object' argument.
-
-        :param status_body_protobuf_object: the protocol buffer object whose type corresponds with this class.
-        :param status_body_object: an instance of this class to be encoded in the protocol buffer object.
-        """
-        status_body_protobuf_object.code = int(status_body_object.status_code)
-        status_body_protobuf_object.msgs.extend(status_body_object.msgs)
-
-    @classmethod
-    def decode(cls, status_body_protobuf_object: Any) -> "StatusBody":
-        """
-        Decode a protocol buffer object that corresponds with this class into an instance of this class.
-
-        A new instance of this class is created that matches the protocol buffer object in the 'status_body_protobuf_object' argument.
-
-        :param status_body_protobuf_object: the protocol buffer object whose type corresponds with this class.
-        :return: A new instance of this class that matches the protocol buffer object in the 'status_body_protobuf_object' argument.
-        """
-        status_body = cls(
-            status_code=cls.StatusCode(status_body_protobuf_object.code),
-            msgs=status_body_protobuf_object.msgs,
-        )
-        return status_body
-
-    def __eq__(self, other: Any) -> bool:
-        """Compare to objects of this class."""
-        return (
-            isinstance(other, StatusBody)
-            and self.status_code == other.status_code
-            and self.msgs == other.msgs
-        )

mech_client/helpers/acn/dialogues.py

@@ -1,126 +0,0 @@
-# -*- coding: utf-8 -*-
-# ------------------------------------------------------------------------------
-#
-#   Copyright 2024 valory
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-#
-# ------------------------------------------------------------------------------
-
-"""
-This module contains the classes required for acn dialogue management.
-
-- AcnDialogue: The dialogue class maintains state of a dialogue and manages it.
-- AcnDialogues: The dialogues class keeps track of all dialogues.
-"""
-
-from abc import ABC
-from typing import Callable, Dict, FrozenSet, Type, cast
-
-from aea.common import Address
-from aea.protocols.base import Message
-from aea.protocols.dialogue.base import Dialogue, DialogueLabel, Dialogues
-
-from packages.valory.protocols.acn.message import AcnMessage
-
-
-class AcnDialogue(Dialogue):
-    """The acn dialogue class maintains state of a dialogue and manages it."""
-
-    INITIAL_PERFORMATIVES: FrozenSet[Message.Performative] = frozenset(
-        {
-            AcnMessage.Performative.REGISTER,
-            AcnMessage.Performative.LOOKUP_REQUEST,
-            AcnMessage.Performative.AEA_ENVELOPE,
-        }
-    )
-    TERMINAL_PERFORMATIVES: FrozenSet[Message.Performative] = frozenset(
-        {AcnMessage.Performative.STATUS, AcnMessage.Performative.LOOKUP_RESPONSE}
-    )
-    VALID_REPLIES: Dict[Message.Performative, FrozenSet[Message.Performative]] = {
-        AcnMessage.Performative.AEA_ENVELOPE: frozenset(
-            {AcnMessage.Performative.STATUS}
-        ),
-        AcnMessage.Performative.LOOKUP_REQUEST: frozenset(
-            {AcnMessage.Performative.LOOKUP_RESPONSE, AcnMessage.Performative.STATUS}
-        ),
-        AcnMessage.Performative.LOOKUP_RESPONSE: frozenset(),
-        AcnMessage.Performative.REGISTER: frozenset({AcnMessage.Performative.STATUS}),
-        AcnMessage.Performative.STATUS: frozenset(),
-    }
-
-    class Role(Dialogue.Role):
-        """This class defines the agent's role in a acn dialogue."""
-
-        NODE = "node"
-
-    class EndState(Dialogue.EndState):
-        """This class defines the end states of a acn dialogue."""
-
-        SUCCESSFUL = 0
-        FAILED = 1
-
-    def __init__(
-        self,
-        dialogue_label: DialogueLabel,
-        self_address: Address,
-        role: Dialogue.Role,
-        message_class: Type[AcnMessage] = AcnMessage,
-    ) -> None:
-        """
-        Initialize a dialogue.
-
-        :param dialogue_label: the identifier of the dialogue
-        :param self_address: the address of the entity for whom this dialogue is maintained
-        :param role: the role of the agent this dialogue is maintained for
-        :param message_class: the message class used
-        """
-        Dialogue.__init__(
-            self,
-            dialogue_label=dialogue_label,
-            message_class=message_class,
-            self_address=self_address,
-            role=role,
-        )
-
-
-class AcnDialogues(Dialogues, ABC):
-    """This class keeps track of all acn dialogues."""
-
-    END_STATES = frozenset(
-        {AcnDialogue.EndState.SUCCESSFUL, AcnDialogue.EndState.FAILED}
-    )
-
-    _keep_terminal_state_dialogues = False
-
-    def __init__(
-        self,
-        self_address: Address,
-        role_from_first_message: Callable[[Message, Address], Dialogue.Role],
-        dialogue_class: Type[AcnDialogue] = AcnDialogue,
-    ) -> None:
-        """
-        Initialize dialogues.
-
-        :param self_address: the address of the entity for whom dialogues are maintained
-        :param dialogue_class: the dialogue class used
-        :param role_from_first_message: the callable determining role from first message
-        """
-        Dialogues.__init__(
-            self,
-            self_address=self_address,
-            end_states=cast(FrozenSet[Dialogue.EndState], self.END_STATES),
-            message_class=AcnMessage,
-            dialogue_class=dialogue_class,
-            role_from_first_message=role_from_first_message,
-        )

mech_client/helpers/acn/message.py

@@ -1,274 +0,0 @@
-# -*- coding: utf-8 -*-
-# ------------------------------------------------------------------------------
-#
-#   Copyright 2024 valory
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-#
-# ------------------------------------------------------------------------------
-
-"""This module contains acn's message definition."""
-
-# pylint: disable=too-many-statements,too-many-locals,no-member,too-few-public-methods,too-many-branches,not-an-iterable,unidiomatic-typecheck,unsubscriptable-object
-import logging
-from typing import Any, Set, Tuple, cast
-
-from aea.configurations.base import PublicId
-from aea.exceptions import AEAEnforceError, enforce
-from aea.protocols.base import Message  # type: ignore
-
-from packages.valory.protocols.acn.custom_types import AgentRecord as CustomAgentRecord
-from packages.valory.protocols.acn.custom_types import StatusBody as CustomStatusBody
-
-
-_default_logger = logging.getLogger("aea.packages.valory.protocols.acn.message")
-
-DEFAULT_BODY_SIZE = 4
-
-
-class AcnMessage(Message):
-    """The protocol used for envelope delivery on the ACN."""
-
-    protocol_id = PublicId.from_str("valory/acn:1.1.0")
-    protocol_specification_id = PublicId.from_str("aea/acn:1.0.0")
-
-    AgentRecord = CustomAgentRecord
-
-    StatusBody = CustomStatusBody
-
-    class Performative(Message.Performative):
-        """Performatives for the acn protocol."""
-
-        AEA_ENVELOPE = "aea_envelope"
-        LOOKUP_REQUEST = "lookup_request"
-        LOOKUP_RESPONSE = "lookup_response"
-        REGISTER = "register"
-        STATUS = "status"
-
-        def __str__(self) -> str:
-            """Get the string representation."""
-            return str(self.value)
-
-    _performatives = {
-        "aea_envelope",
-        "lookup_request",
-        "lookup_response",
-        "register",
-        "status",
-    }
-    __slots__: Tuple[str, ...] = tuple()
-
-    class _SlotsCls:
-        __slots__ = (
-            "agent_address",
-            "body",
-            "dialogue_reference",
-            "envelope",
-            "message_id",
-            "performative",
-            "record",
-            "target",
-        )
-
-    def __init__(
-        self,
-        performative: Performative,
-        dialogue_reference: Tuple[str, str] = ("", ""),
-        message_id: int = 1,
-        target: int = 0,
-        **kwargs: Any,
-    ):
-        """
-        Initialise an instance of AcnMessage.
-
-        :param message_id: the message id.
-        :param dialogue_reference: the dialogue reference.
-        :param target: the message target.
-        :param performative: the message performative.
-        :param **kwargs: extra options.
-        """
-        super().__init__(
-            dialogue_reference=dialogue_reference,
-            message_id=message_id,
-            target=target,
-            performative=AcnMessage.Performative(performative),
-            **kwargs,
-        )
-
-    @property
-    def valid_performatives(self) -> Set[str]:
-        """Get valid performatives."""
-        return self._performatives
-
-    @property
-    def dialogue_reference(self) -> Tuple[str, str]:
-        """Get the dialogue_reference of the message."""
-        enforce(self.is_set("dialogue_reference"), "dialogue_reference is not set.")
-        return cast(Tuple[str, str], self.get("dialogue_reference"))
-
-    @property
-    def message_id(self) -> int:
-        """Get the message_id of the message."""
-        enforce(self.is_set("message_id"), "message_id is not set.")
-        return cast(int, self.get("message_id"))
-
-    @property
-    def performative(self) -> Performative:  # type: ignore # noqa: F821
-        """Get the performative of the message."""
-        enforce(self.is_set("performative"), "performative is not set.")
-        return cast(AcnMessage.Performative, self.get("performative"))
-
-    @property
-    def target(self) -> int:
-        """Get the target of the message."""
-        enforce(self.is_set("target"), "target is not set.")
-        return cast(int, self.get("target"))
-
-    @property
-    def agent_address(self) -> str:
-        """Get the 'agent_address' content from the message."""
-        enforce(self.is_set("agent_address"), "'agent_address' content is not set.")
-        return cast(str, self.get("agent_address"))
-
-    @property
-    def body(self) -> CustomStatusBody:
-        """Get the 'body' content from the message."""
-        enforce(self.is_set("body"), "'body' content is not set.")
-        return cast(CustomStatusBody, self.get("body"))
-
-    @property
-    def envelope(self) -> bytes:
-        """Get the 'envelope' content from the message."""
-        enforce(self.is_set("envelope"), "'envelope' content is not set.")
-        return cast(bytes, self.get("envelope"))
-
-    @property
-    def record(self) -> CustomAgentRecord:
-        """Get the 'record' content from the message."""
-        enforce(self.is_set("record"), "'record' content is not set.")
-        return cast(CustomAgentRecord, self.get("record"))
-
-    def _is_consistent(self) -> bool:
-        """Check that the message follows the acn protocol."""
-        try:
-            enforce(
-                isinstance(self.dialogue_reference, tuple),
-                "Invalid type for 'dialogue_reference'. Expected 'tuple'. Found '{}'.".format(
-                    type(self.dialogue_reference)
-                ),
-            )
-            enforce(
-                isinstance(self.dialogue_reference[0], str),
-                "Invalid type for 'dialogue_reference[0]'. Expected 'str'. Found '{}'.".format(
-                    type(self.dialogue_reference[0])
-                ),
-            )
-            enforce(
-                isinstance(self.dialogue_reference[1], str),
-                "Invalid type for 'dialogue_reference[1]'. Expected 'str'. Found '{}'.".format(
-                    type(self.dialogue_reference[1])
-                ),
-            )
-            enforce(
-                type(self.message_id) is int,
-                "Invalid type for 'message_id'. Expected 'int'. Found '{}'.".format(
-                    type(self.message_id)
-                ),
-            )
-            enforce(
-                type(self.target) is int,
-                "Invalid type for 'target'. Expected 'int'. Found '{}'.".format(
-                    type(self.target)
-                ),
-            )
-
-            # Light Protocol Rule 2
-            # Check correct performative
-            enforce(
-                isinstance(self.performative, AcnMessage.Performative),
-                "Invalid 'performative'. Expected either of '{}'. Found '{}'.".format(
-                    self.valid_performatives, self.performative
-                ),
-            )
-
-            # Check correct contents
-            actual_nb_of_contents = len(self._body) - DEFAULT_BODY_SIZE
-            expected_nb_of_contents = 0
-            if self.performative == AcnMessage.Performative.REGISTER:
-                expected_nb_of_contents = 1
-                enforce(
-                    isinstance(self.record, CustomAgentRecord),
-                    "Invalid type for content 'record'. Expected 'AgentRecord'. Found '{}'.".format(
-                        type(self.record)
-                    ),
-                )
-            elif self.performative == AcnMessage.Performative.LOOKUP_REQUEST:
-                expected_nb_of_contents = 1
-                enforce(
-                    isinstance(self.agent_address, str),
-                    "Invalid type for content 'agent_address'. Expected 'str'. Found '{}'.".format(
-                        type(self.agent_address)
-                    ),
-                )
-            elif self.performative == AcnMessage.Performative.LOOKUP_RESPONSE:
-                expected_nb_of_contents = 1
-                enforce(
-                    isinstance(self.record, CustomAgentRecord),
-                    "Invalid type for content 'record'. Expected 'AgentRecord'. Found '{}'.".format(
-                        type(self.record)
-                    ),
-                )
-            elif self.performative == AcnMessage.Performative.AEA_ENVELOPE:
-                expected_nb_of_contents = 2
-                enforce(
-                    isinstance(self.envelope, bytes),
-                    "Invalid type for content 'envelope'. Expected 'bytes'. Found '{}'.".format(
-                        type(self.envelope)
-                    ),
-                )
-                enforce(
-                    isinstance(self.record, CustomAgentRecord),
-                    "Invalid type for content 'record'. Expected 'AgentRecord'. Found '{}'.".format(
-                        type(self.record)
-                    ),
-                )
-            elif self.performative == AcnMessage.Performative.STATUS:
-                expected_nb_of_contents = 1
-                enforce(
-                    isinstance(self.body, CustomStatusBody),
-                    "Invalid type for content 'body'. Expected 'StatusBody'. Found '{}'.".format(
-                        type(self.body)
-                    ),
-                )
-
-            # Check correct content count
-            enforce(
-                expected_nb_of_contents == actual_nb_of_contents,
-                "Incorrect number of contents. Expected {}. Found {}".format(
-                    expected_nb_of_contents, actual_nb_of_contents
-                ),
-            )
-
-            # Light Protocol Rule 3
-            if self.message_id == 1:
-                enforce(
-                    self.target == 0,
-                    "Invalid 'target'. Expected 0 (because 'message_id' is 1). Found {}.".format(
-                        self.target
-                    ),
-                )
-        except (AEAEnforceError, ValueError, KeyError) as e:
-            _default_logger.error(str(e))
-            return False
-
-        return True

mech_client/helpers/acn/protocol.yaml

@@ -1,24 +0,0 @@
-name: acn
-author: valory
-version: 1.1.0
-protocol_specification_id: aea/acn:1.0.0
-type: protocol
-description: The protocol used for envelope delivery on the ACN.
-license: Apache-2.0
-aea_version: '>=1.0.0, <2.0.0'
-fingerprint:
-  README.md: bafybeie7paijucvzemlfhwfmmhorypwuhzbeimgoitlkokdio5c3ne4pjq
-  __init__.py: bafybeicqlp4gkeeef5osp6zopjztlgat24nxrzq43cy7wbwxk5omf2sc2m
-  acn.proto: bafybeidkun7o75sxpyk2sixt7dsykgty62f6dnixnes2irbunyamilqsh4
-  acn_pb2.py: bafybeialafz3yomunwa3g5xgrdqwodzl7zg5dncvzuetv7xoew4zhw76ni
-  custom_types.py: bafybeigpueuq6mdeyjyayzv3menkmemutfgfiwlozlpl64t67cfnnom24q
-  dialogues.py: bafybeidjpyk7s3getyfegjdrgrt5blf2yutzqclohaktjehwcj3sqx2ole
-  message.py: bafybeiai7kond3rcbtwnr5xgpwzuauf5tusuep6ikopi4cqvp2wa5qfz3e
-  serialization.py: bafybeidu7fzixk6sm3iprhph4shbiq5qgvg56lg4yiryfaf3unuqk34bwi
-  tests/__init__.py: bafybeidteufp2npjd77ekcftk5e4gbaquq3gike5nxtk5xfmnusls56keu
-  tests/test_acn.py: bafybeignjgdtlfdnj25hc5necmg7zl3kvngsmzkjgcwfm5qg36liqa63ki
-  tests/test_acn_dialogues.py: bafybeia2kndutaokjpogo4wlb5pf4gkqacvcbngqromf4g4mzu6wyetz7q
-  tests/test_acn_messages.py: bafybeigriniqu3tfzeok7rjx3widzclyjqgjhkunkgt657lpng23mo7oxa
-fingerprint_ignore_patterns: []
-dependencies:
-  protobuf: {}