hiero-sdk-python 0.0.1.dev0__py3-none-any.whl

hiero_sdk_python/consensus/topic_create_transaction.py

@@ -0,0 +1,83 @@
+from hiero_sdk_python.response_code import ResponseCode
+from hiero_sdk_python.transaction.transaction import Transaction
+from hiero_sdk_python.hapi.services import consensus_create_topic_pb2, duration_pb2
+
+class TopicCreateTransaction(Transaction):
+    def __init__(self, memo=None, admin_key=None, submit_key=None, auto_renew_period=None, auto_renew_account=None):
+        super().__init__()
+        self.memo = memo or ""
+        self.admin_key = admin_key
+        self.submit_key = submit_key
+        self.auto_renew_period = auto_renew_period or 7890000 
+        self.auto_renew_account = auto_renew_account
+        self.transaction_fee = 10_000_000
+
+    def set_memo(self, memo):
+        self._require_not_frozen()
+        self.memo = memo
+        return self
+
+    def set_admin_key(self, key):
+        self._require_not_frozen()
+        self.admin_key = key
+        return self
+
+    def set_submit_key(self, key):
+        self._require_not_frozen()
+        self.submit_key = key
+        return self
+
+    def set_auto_renew_period(self, seconds):
+        self._require_not_frozen()
+        self.auto_renew_period = seconds
+        return self
+
+    def set_auto_renew_account(self, account_id):
+        self._require_not_frozen()
+        self.auto_renew_account = account_id
+        return self
+
+    def build_transaction_body(self):
+        """
+        Builds and returns the protobuf transaction body for topic creation.
+
+        Returns:
+            TransactionBody: The protobuf transaction body containing the topic creation details.
+
+        Raises:
+            ValueError: If required fields are missing.
+        """
+        transaction_body = self.build_base_transaction_body()
+        transaction_body.consensusCreateTopic.CopyFrom(consensus_create_topic_pb2.ConsensusCreateTopicTransactionBody(
+            adminKey=self.admin_key.to_proto() if self.admin_key is not None else None,
+            submitKey=self.submit_key.to_proto() if self.submit_key is not None else None,
+            autoRenewPeriod=duration_pb2.Duration(seconds=self.auto_renew_period),
+            autoRenewAccount=self.auto_renew_account.to_proto() if self.auto_renew_account is not None else None,
+            memo=self.memo
+        ))
+
+        return transaction_body
+
+    def _execute_transaction(self, client, transaction_proto):
+        """
+        Executes the topic creation transaction using the provided client.
+
+        Args:
+            client (Client): The client instance to use for execution.
+            transaction_proto (Transaction): The protobuf Transaction message.
+
+        Returns:
+            TransactionReceipt: The receipt from the network after transaction execution.
+
+        Raises:
+            Exception: If the transaction submission fails or receives an error response.
+        """
+        response = client.topic_stub.createTopic(transaction_proto)
+
+        if response.nodeTransactionPrecheckCode != ResponseCode.OK:
+            error_code = response.nodeTransactionPrecheckCode
+            error_message = ResponseCode.get_name(error_code)
+            raise Exception(f"Error during transaction submission: {error_code} ({error_message})")
+
+        receipt = self.get_receipt(client)
+        return receipt

hiero_sdk_python/consensus/topic_delete_transaction.py

@@ -0,0 +1,67 @@
+from hiero_sdk_python.response_code import ResponseCode
+from hiero_sdk_python.transaction.transaction import Transaction
+from hiero_sdk_python.hapi.services import consensus_delete_topic_pb2, duration_pb2
+
+class TopicDeleteTransaction(Transaction):
+    def __init__(self, topic_id=None):
+        super().__init__()
+        self.topic_id = topic_id
+        self.transaction_fee = 10_000_000
+
+    def set_topic_id(self, topic_id):
+        """
+        Sets the topic ID for the transaction.
+        
+        Args:
+            topic_id: The topic ID to delete.
+
+        Returns:
+            TopicDeleteTransaction: Returns the instance for method chaining.
+        """
+        self._require_not_frozen()
+        self.topic_id = topic_id
+        return self
+
+    def build_transaction_body(self):
+        """
+        Builds and returns the protobuf transaction body for topic delete.
+
+        Returns:
+            TransactionBody: The protobuf transaction body containing the topic delete details.
+
+        Raises:
+            ValueError: If required fields are missing.
+        """
+        if self.topic_id is None:
+            raise ValueError("Missing required fields: topic_id")
+    
+        transaction_body = self.build_base_transaction_body()
+        transaction_body.consensusDeleteTopic.CopyFrom(consensus_delete_topic_pb2.ConsensusDeleteTopicTransactionBody(
+            topicID=self.topic_id.to_proto()
+        ))
+
+        return transaction_body
+
+    def _execute_transaction(self, client, transaction_proto):
+        """
+        Executes the topic delete transaction using the provided client.
+
+        Args:
+            client (Client): The client instance to use for execution.
+            transaction_proto (Transaction): The protobuf Transaction message.
+
+        Returns:
+            TransactionReceipt: The receipt from the network after transaction execution.
+
+        Raises:
+            Exception: If the transaction submission fails or receives an error response.
+        """
+        response = client.topic_stub.deleteTopic(transaction_proto)
+
+        if response.nodeTransactionPrecheckCode != ResponseCode.OK:
+            error_code = response.nodeTransactionPrecheckCode
+            error_message = ResponseCode.get_name(error_code)
+            raise Exception(f"Error during transaction submission: {error_code} ({error_message})")
+
+        receipt = self.get_receipt(client)
+        return receipt

hiero_sdk_python/consensus/topic_id.py

@@ -0,0 +1,44 @@
+from hiero_sdk_python.hapi.services import basic_types_pb2
+
+class TopicId:
+    def __init__(self, shard=0, realm=0, num=0):
+        self.shard = shard
+        self.realm = realm
+        self.num = num
+
+    @classmethod
+    def from_proto(cls, topic_id_proto: basic_types_pb2.TopicID):
+        """
+        Creates a TopicId instance from a protobuf TopicID object.
+        """
+        return cls(
+            shard=topic_id_proto.shardNum,
+            realm=topic_id_proto.realmNum,
+            num=topic_id_proto.topicNum
+        )
+
+    def to_proto(self):
+        """
+        Converts the TopicId instance to a protobuf TopicID object.
+        """
+        topic_id_proto = basic_types_pb2.TopicID()
+        topic_id_proto.shardNum = self.shard
+        topic_id_proto.realmNum = self.realm
+        topic_id_proto.topicNum = self.num
+        return topic_id_proto
+
+    def __str__(self):
+        """
+        Returns the string representation of the TopicId in the format 'shard.realm.num'.
+        """
+        return f"{self.shard}.{self.realm}.{self.num}"
+
+    @classmethod
+    def from_string(cls, topic_id_str):
+        """
+        Parses a string in the format 'shard.realm.num' to create a TopicId instance.
+        """
+        parts = topic_id_str.strip().split('.')
+        if len(parts) != 3:
+            raise ValueError("Invalid TopicId format. Expected 'shard.realm.num'")
+        return cls(shard=int(parts[0]), realm=int(parts[1]), num=int(parts[2]))

hiero_sdk_python/consensus/topic_info.py

@@ -0,0 +1,91 @@
+from datetime import datetime
+from hiero_sdk_python.hapi.services.basic_types_pb2 import Key, AccountID
+from hiero_sdk_python.hapi.services.timestamp_pb2 import Timestamp
+from hiero_sdk_python.hapi.services.duration_pb2 import Duration
+from hiero_sdk_python.utils.key_format import format_key
+
+class TopicInfo:
+    def __init__(
+        self,
+        memo: str,
+        running_hash: bytes,
+        sequence_number: int,
+        expiration_time: Timestamp,
+        admin_key: Key,
+        submit_key: Key,
+        auto_renew_period: Duration,
+        auto_renew_account: AccountID,
+        ledger_id: bytes,
+    ):
+        self.memo = memo
+        self.running_hash = running_hash
+        self.sequence_number = sequence_number
+        self.expiration_time = expiration_time
+        self.admin_key = admin_key
+        self.submit_key = submit_key
+        self.auto_renew_period = auto_renew_period
+        self.auto_renew_account = auto_renew_account
+        self.ledger_id = ledger_id
+
+    @classmethod
+    def from_proto(cls, topic_info_proto):
+        """
+        Constructs a TopicInfo object from a protobuf ConsensusTopicInfo message.
+        """
+        return cls(
+            memo=topic_info_proto.memo,
+            running_hash=topic_info_proto.runningHash,
+            sequence_number=topic_info_proto.sequenceNumber,
+            expiration_time=(
+                topic_info_proto.expirationTime 
+                if topic_info_proto.HasField("expirationTime") else None
+            ),
+            admin_key=(
+                topic_info_proto.adminKey 
+                if topic_info_proto.HasField("adminKey") else None
+            ),
+            submit_key=(
+                topic_info_proto.submitKey 
+                if topic_info_proto.HasField("submitKey") else None
+            ),
+            auto_renew_period=(
+                topic_info_proto.autoRenewPeriod 
+                if topic_info_proto.HasField("autoRenewPeriod") else None
+            ),
+            auto_renew_account=(
+                topic_info_proto.autoRenewAccount 
+                if topic_info_proto.HasField("autoRenewAccount") else None
+            ),
+            ledger_id=getattr(topic_info_proto, "ledger_id", None),  # fallback if the field doesn't exist
+        )
+
+    def __repr__(self):
+        """
+        If you print the object with `repr(topic_info)`, you'll see this output.
+        """
+        return self.__str__()
+
+    def __str__(self):
+        """
+        Pretty-print the TopicInfo in a multi-line, user-friendly style.
+        """
+
+        exp_dt = None
+        if self.expiration_time and hasattr(self.expiration_time, "seconds"):
+            exp_dt = datetime.fromtimestamp(self.expiration_time.seconds)
+            
+        running_hash_hex = self.running_hash.hex() if self.running_hash else None
+
+        return (
+            "TopicInfo(\n"
+            f"  memo='{self.memo}',\n"
+            f"  running_hash=0x{running_hash_hex},\n"
+            f"  sequence_number={self.sequence_number},\n"
+            f"  expiration_time={exp_dt},\n"
+            f"  admin_key={format_key(self.admin_key)},\n"
+            f"  submit_key={format_key(self.submit_key)},\n"
+            f"  auto_renew_period={self.auto_renew_period},\n"
+            f"  auto_renew_account={self.auto_renew_account},\n"
+            f"  ledger_id={self.ledger_id}\n"
+            ")"
+        )

hiero_sdk_python/consensus/topic_message.py

@@ -0,0 +1,61 @@
+from hiero_sdk_python.hapi.mirror import consensus_service_pb2 as mirror_proto
+from datetime import datetime
+
+class TopicMessage:
+    """
+    Represents a single message returned from a Hedera Mirror Node subscription.
+    """
+
+    def __init__(self, consensus_timestamp, message, running_hash, sequence_number, 
+                 running_hash_version=None, chunk_info=None, chunks=None, transaction_id=None):
+        self.consensus_timestamp = consensus_timestamp
+        self.message = message or b""
+        self.running_hash = running_hash or b""
+        self.sequence_number = sequence_number or 0
+        self.running_hash_version = running_hash_version
+        self.chunk_info = chunk_info
+        self.chunks = chunks
+        self.transaction_id = transaction_id
+
+    @classmethod
+    def from_proto(cls, response: mirror_proto.ConsensusTopicResponse) -> "TopicMessage":
+        """
+        Parse a Mirror Node response into a simpler object.
+        """
+        transaction_id = (
+            response.chunkInfo.initialTransactionID
+            if response.HasField("chunkInfo") and response.chunkInfo.HasField("initialTransactionID")
+            else None
+        )
+        return cls(
+            consensus_timestamp=response.consensusTimestamp,
+            message=response.message,
+            running_hash=response.runningHash,
+            sequence_number=response.sequenceNumber,
+            running_hash_version=response.runningHashVersion if response.runningHashVersion != 0 else None,
+            chunk_info=response.chunkInfo if response.HasField("chunkInfo") else None,
+            transaction_id=transaction_id,
+        )
+
+    def __str__(self):
+        """
+        Returns a nicely formatted string representation of the topic message.
+        """
+        timestamp = datetime.utcfromtimestamp(self.consensus_timestamp.seconds).strftime('%Y-%m-%d %H:%M:%S UTC')
+        message = self.message.decode('utf-8', errors='ignore')
+        running_hash = self.running_hash.hex()
+
+        formatted_message = (
+            f"Received Topic Message:\n"
+            f"  - Timestamp: {timestamp}\n"
+            f"  - Sequence Number: {self.sequence_number}\n"
+            f"  - Message: {message}\n"
+            f"  - Running Hash: {running_hash}\n"
+        )
+        if self.running_hash_version:
+            formatted_message += f"  - Running Hash Version: {self.running_hash_version}\n"
+        if self.chunk_info:
+            formatted_message += f"  - Chunk Info: {self.chunk_info}\n"
+        if self.transaction_id:
+            formatted_message += f"  - Transaction ID: {self.transaction_id}\n"
+        return formatted_message

hiero_sdk_python/consensus/topic_message_submit_transaction.py

@@ -0,0 +1,87 @@
+from hiero_sdk_python.response_code import ResponseCode
+from hiero_sdk_python.transaction.transaction import Transaction
+from hiero_sdk_python.hapi.services import consensus_submit_message_pb2
+
+class TopicMessageSubmitTransaction(Transaction):
+    def __init__(self, topic_id=None, message=None):
+        """
+        Initializes a new TopicMessageSubmitTransaction instance.
+        
+        Args:
+            topic_id (TopicId, optional): The ID of the topic.
+            message (str, optional): The message to submit.
+        """
+        super().__init__()
+        self.topic_id = topic_id
+        self.message = message
+
+    def set_topic_id(self, topic_id):
+        """
+        Sets the topic ID for the message submission.
+
+        Args:
+            topic_id (TopicId): The ID of the topic to which the message is submitted.
+
+        Returns:
+            TopicMessageSubmitTransaction: This transaction instance (for chaining).
+        """
+        self._require_not_frozen()
+        self.topic_id = topic_id
+        return self
+
+    def set_message(self, message):
+        """
+        Sets the message to submit to the topic.
+
+        Args:
+            message (str): The message to submit to the topic.
+
+        Returns:
+            TopicMessageSubmitTransaction: This transaction instance (for chaining).
+        """
+        self._require_not_frozen()
+        self.message = message
+        return self
+
+    def build_transaction_body(self):
+        """
+        Builds and returns the protobuf transaction body for message submission.
+        Raises ValueError if required fields (topic_id, message) are missing.
+        """
+        if self.topic_id is None:
+            raise ValueError("Missing required fields: topic_id.")
+        if self.message is None:
+            raise ValueError("Missing required fields: message.")
+
+        transaction_body = self.build_base_transaction_body()
+        transaction_body.consensusSubmitMessage.CopyFrom(
+            consensus_submit_message_pb2.ConsensusSubmitMessageTransactionBody(
+                topicID=self.topic_id.to_proto(),
+                message=bytes(self.message, 'utf-8')
+            )
+        )
+        return transaction_body
+
+    def _execute_transaction(self, client, transaction_proto):
+        """
+        Executes the message submit transaction using the provided client.
+
+        Args:
+            client (Client): The client instance to use for execution.
+            transaction_proto (Transaction): The protobuf Transaction message.
+
+        Returns:
+            TransactionReceipt: The receipt from the network after transaction execution.
+
+        Raises:
+            Exception: If the transaction submission fails or receives an error response.
+        """
+        response = client.topic_stub.submitMessage(transaction_proto)
+
+        if response.nodeTransactionPrecheckCode != ResponseCode.OK:
+            error_code = response.nodeTransactionPrecheckCode
+            error_message = ResponseCode.get_name(error_code)
+            raise Exception(f"Error during transaction submission: {error_code} ({error_message})")
+
+        receipt = self.get_receipt(client)
+        return receipt

hiero_sdk_python/consensus/topic_update_transaction.py

@@ -0,0 +1,173 @@
+from hiero_sdk_python.response_code import ResponseCode
+from hiero_sdk_python.transaction.transaction import Transaction
+from hiero_sdk_python.hapi.services import consensus_update_topic_pb2, duration_pb2
+from google.protobuf import wrappers_pb2 as _wrappers_pb2
+
+class TopicUpdateTransaction(Transaction):
+    def __init__(
+        self,
+        topic_id=None,
+        memo=None,
+        admin_key=None,
+        submit_key=None,
+        auto_renew_period=7890000,
+        auto_renew_account=None,
+        expiration_time=None,
+    ):
+        super().__init__()
+        self.topic_id = topic_id
+        self.memo = memo or ""
+        self.admin_key = admin_key
+        self.submit_key = submit_key
+        self.auto_renew_period = auto_renew_period
+        self.auto_renew_account = auto_renew_account
+        self.expiration_time = expiration_time
+        self.transaction_fee = 10_000_000
+
+    def set_topic_id(self, topic_id):
+        """
+        Sets the topic ID for the transaction.
+
+        Args:
+            topic_id: The topic ID to update.
+
+        Returns:
+            TopicUpdateTransaction: Returns the instance for method chaining.
+        """
+        self._require_not_frozen()
+        self.topic_id = topic_id
+        return self
+
+    def set_memo(self, memo):
+        """
+        Sets the memo for the topic.
+
+        Args:
+            memo: The memo to set.
+
+        Returns:
+            TopicUpdateTransaction: Returns the instance for method chaining.
+        """
+        self._require_not_frozen()
+        self.memo = memo
+        return self
+
+    def set_admin_key(self, key):
+        """
+        Sets the admin key for the topic.
+
+        Args:
+            key: The admin key to set.
+
+        Returns:
+            TopicUpdateTransaction: Returns the instance for method chaining.
+        """
+        self._require_not_frozen()
+        self.admin_key = key
+        return self
+
+    def set_submit_key(self, key):
+        """
+        Sets the submit key for the topic.
+
+        Args:
+            key: The submit key to set.
+
+        Returns:
+            TopicUpdateTransaction: Returns the instance for method chaining.
+        """
+        self._require_not_frozen()
+        self.submit_key = key
+        return self
+
+    def set_auto_renew_period(self, seconds):
+        """
+        Sets the auto-renew period for the topic.
+
+        Args:
+            seconds: The auto-renew period in seconds.
+
+        Returns:
+            TopicUpdateTransaction: Returns the instance for method chaining.
+        """
+        self._require_not_frozen()
+        self.auto_renew_period = seconds
+        return self
+
+    def set_auto_renew_account(self, account_id):
+        """
+        Sets the auto-renew account for the topic.
+
+        Args:
+            account_id: The account ID to set as the auto-renew account.
+
+        Returns:
+            TopicUpdateTransaction: Returns the instance for method chaining.
+        """
+        self._require_not_frozen()
+        self.auto_renew_account = account_id
+        return self
+
+    def set_expiration_time(self, expiration_time):
+        """
+        Sets the expiration time for the topic.
+
+        Args:
+            expiration_time: The expiration time to set.
+
+        Returns:
+            TopicUpdateTransaction: Returns the instance for method chaining.
+        """
+        self._require_not_frozen()
+        self.expiration_time = expiration_time
+        return self
+
+    def build_transaction_body(self):
+        """
+        Builds and returns the protobuf transaction body for topic update.
+
+        Returns:
+            TransactionBody: The protobuf transaction body containing the topic update details.
+
+        Raises:
+            ValueError: If required fields are missing.
+        """
+        if self.topic_id is None:
+            raise ValueError("Missing required fields: topic_id")
+
+        transaction_body = self.build_base_transaction_body()
+        transaction_body.consensusUpdateTopic.CopyFrom(consensus_update_topic_pb2.ConsensusUpdateTopicTransactionBody(
+            topicID=self.topic_id.to_proto(),
+            adminKey=self.admin_key.to_proto() if self.admin_key else None,
+            submitKey=self.submit_key.to_proto() if self.submit_key else None,
+            autoRenewPeriod=duration_pb2.Duration(seconds=self.auto_renew_period) if self.auto_renew_period else None,
+            autoRenewAccount=self.auto_renew_account.to_proto() if self.auto_renew_account else None,
+            expirationTime=self.expiration_time.to_proto() if self.expiration_time else None,
+            memo=_wrappers_pb2.StringValue(value=self.memo) if self.memo else None
+        ))
+
+        return transaction_body
+
+    def _execute_transaction(self, client, transaction_proto):
+        """
+        Executes the topic update transaction using the provided client.
+
+        Args:
+            client (Client): The client instance to use for execution.
+            transaction_proto (Transaction): The protobuf Transaction message.
+
+        Returns:
+            TransactionReceipt: The receipt from the network after transaction execution.
+
+        Raises:
+            Exception: If the transaction submission fails or receives an error response.
+        """
+        response = client.topic_stub.updateTopic(transaction_proto)
+
+        if response.nodeTransactionPrecheckCode != ResponseCode.OK:
+            error_code = response.nodeTransactionPrecheckCode
+            error_message = ResponseCode.get_name(error_code)
+            raise Exception(f"Error during transaction submission: {error_code} ({error_message})")
+
+        receipt = self.get_receipt(client)
+        return receipt