feat: implement child transaction records for #1512

Signed-off-by: mukundkumarjha <[email protected]>

Author: mukundkumarjha

CHANGELOG.md

@@ -23,6 +23,7 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
 - Formatted client_test.py using Black.
 
 ### Added
+- Added support for include_children to the TransactionRecordQuery class
 - Added Windows setup guide for SDK developers (`docs/sdk_developers/training/setup/setup_windows.md`) with PowerShell installation instructions. (#1570)
 - Added a beginner assignment guard that requires completion of a Good First Issue. (#1484)
 - Added `/unassign` command allowing contributors to remove themselves from assigned issues.(#1472)

examples/transaction/transaction_record_with_children.py

@@ -0,0 +1,33 @@
+import os
+from hiero_sdk_python.client import Client
+from hiero_sdk_python.query.transaction_record_query import TransactionRecordQuery
+
+def main():
+    # Setup client
+    client = Client.for_testnet()
+    # ... (add operator credentials) ...
+
+    # 1. Execute a transaction that is likely to have child records
+    # (e.g., a complex Smart Contract call)
+    print("Executing transaction...")
+    
+    # 2. Query the record and explicitly request children
+    tx_id = "..." # your transaction id
+    
+    query = (
+        TransactionRecordQuery()
+        .set_transaction_id(tx_id)
+        .set_include_children(True) # The new feature!
+    )
+    
+    record = query.execute(client)
+    
+    # 3. Demonstrate accessing the children
+    print(f"Parent Transaction ID: {record.transaction_id}")
+    print(f"Number of child records found: {len(record.children)}")
+    
+    for i, child in enumerate(record.children):
+        print(f"Child {i+1} Status: {child.receipt.status}")
+
+if __name__ == "__main__":
+    main()

src/hiero_sdk_python/query/transaction_record_query.py

@@ -1,5 +1,9 @@
 from typing import Optional, Any, Union, List
-from hiero_sdk_python.hapi.services import query_header_pb2, transaction_get_record_pb2, query_pb2
+from hiero_sdk_python.hapi.services import (
+    query_header_pb2,
+    transaction_get_record_pb2,
+    query_pb2,
+)
 from hiero_sdk_python.query.query import Query
 from hiero_sdk_python.response_code import ResponseCode
 from hiero_sdk_python.transaction.transaction_id import TransactionId
@@ -16,34 +20,38 @@ class TransactionRecordQuery(Query):
     Represents a query for a transaction record on the Hedera network.
     """
 
-    def __init__(self, transaction_id: Optional[TransactionId] = None, include_children: bool = False):
+    def __init__(
+        self,
+        transaction_id: Optional[TransactionId] = None,
+        include_children: bool = False,
+    ):
         """
         Initializes the TransactionRecordQuery with the provided transaction ID.
         """
         super().__init__()
-        self.transaction_id : Optional[TransactionId] = transaction_id
+        self.transaction_id: Optional[TransactionId] = transaction_id
         self.include_children = include_children
-        
-        
+
     def set_transaction_id(self, transaction_id: TransactionId):
         """
         Sets the transaction ID for the query.
-        
+
         Args:
             transaction_id (TransactionId): The ID of the transaction to query.
         Returns:
             TransactionRecordQuery: This query instance.
         """
         self.transaction_id = transaction_id
         return self
-    
+
     def set_include_children(self, include_children):
         self.include_children = include_children
+        return self
 
     def _make_request(self):
         """
         Constructs the protobuf request for the transaction record query.
-        
+
         Builds a TransactionGetRecordQuery protobuf message with the
         appropriate header and transaction ID.
 
@@ -57,19 +65,27 @@ def _make_request(self):
         """
         try:
             if not self.transaction_id:
-                raise ValueError("Transaction ID must be set before making the request.")
+                raise ValueError(
+                    "Transaction ID must be set before making the request."
+                )
 
             query_header = self._make_request_header()
-            transaction_get_record = transaction_get_record_pb2.TransactionGetRecordQuery()
+            transaction_get_record = (
+                transaction_get_record_pb2.TransactionGetRecordQuery()
+            )
             transaction_get_record.header.CopyFrom(query_header)
+
+            transaction_get_record.transactionID.CopyFrom(
+                self.transaction_id._to_proto()
+            )
             transaction_get_record.include_child_records = self.include_children
-            transaction_get_record.transactionID.CopyFrom(self.transaction_id._to_proto())
-            
             query = query_pb2.Query()
-            if not hasattr(query, 'transactionGetRecord'):
-                raise AttributeError("Query object has no attribute 'transactionGetRecord'")
+            if not hasattr(query, "transactionGetRecord"):
+                raise AttributeError(
+                    "Query object has no attribute 'transactionGetRecord'"
+                )
             query.transactionGetRecord.CopyFrom(transaction_get_record)
-            
+
             return query
         except Exception as e:
             print(f"Exception in _make_request: {e}")
@@ -78,7 +94,7 @@ def _make_request(self):
     def _get_method(self, channel: _Channel) -> _Method:
         """
         Returns the appropriate gRPC method for the transaction receipt query.
-        
+
         Implements the abstract method from Query to provide the specific
         gRPC method for getting transaction receipts.
 
@@ -89,14 +105,13 @@ def _get_method(self, channel: _Channel) -> _Method:
             _Method: The method wrapper containing the query function
         """
         return _Method(
-            transaction_func=None,
-            query_func=channel.crypto.getTxRecordByTxID
+            transaction_func=None, query_func=channel.crypto.getTxRecordByTxID
         )
 
     def _should_retry(self, response: Any) -> _ExecutionState:
         """
         Determines whether the query should be retried based on the response.
-        
+
         Implements the abstract method from Query to decide whether to retry
         the query based on the response status code. First checks the header status,
         then the receipt status.
@@ -108,37 +123,45 @@ def _should_retry(self, response: Any) -> _ExecutionState:
             _ExecutionState: The execution state indicating what to do next
         """
         status = response.transactionGetRecord.header.nodeTransactionPrecheckCode
-        
+
         retryable_statuses = {
             ResponseCode.UNKNOWN,
             ResponseCode.BUSY,
             ResponseCode.RECEIPT_NOT_FOUND,
             ResponseCode.RECORD_NOT_FOUND,
-            ResponseCode.PLATFORM_NOT_ACTIVE
+            ResponseCode.PLATFORM_NOT_ACTIVE,
         }
-        
+
         if status == ResponseCode.OK:
-            if response.transactionGetRecord.header.responseType == query_header_pb2.ResponseType.COST_ANSWER:
+            if (
+                response.transactionGetRecord.header.responseType
+                == query_header_pb2.ResponseType.COST_ANSWER
+            ):
                 return _ExecutionState.FINISHED
             pass
-        elif status in retryable_statuses or status == ResponseCode.PLATFORM_TRANSACTION_NOT_CREATED:
+        elif (
+            status in retryable_statuses
+            or status == ResponseCode.PLATFORM_TRANSACTION_NOT_CREATED
+        ):
             return _ExecutionState.RETRY
         else:
             return _ExecutionState.ERROR
-    
+
         status = response.transactionGetRecord.transactionRecord.receipt.status
-        
+
         if status in retryable_statuses or status == ResponseCode.OK:
             return _ExecutionState.RETRY
         elif status == ResponseCode.SUCCESS:
             return _ExecutionState.FINISHED
         else:
             return _ExecutionState.ERROR
-        
-    def _map_status_error(self, response: Any) -> Union[PrecheckError,ReceiptStatusError]:
+
+    def _map_status_error(
+        self, response: Any
+    ) -> Union[PrecheckError, ReceiptStatusError]:
         """
         Maps a response status code to an appropriate error object.
-        
+
         Implements the abstract method from Executable to create error objects
         from response status codes. Checks both the header status and receipt status.
 
@@ -156,23 +179,37 @@ def _map_status_error(self, response: Any) -> Union[PrecheckError,ReceiptStatusE
             ResponseCode.UNKNOWN,
             ResponseCode.RECEIPT_NOT_FOUND,
             ResponseCode.RECORD_NOT_FOUND,
-            ResponseCode.OK
+            ResponseCode.OK,
         }
-        
+
         if status not in retryable_statuses:
             return PrecheckError(status)
-        
+
         receipt = response.transactionGetRecord.transactionRecord.receipt
-        
-        return ReceiptStatusError(status, self.transaction_id, TransactionReceipt._from_proto(receipt, self.transaction_id))
-        
+
+        return ReceiptStatusError(
+            status,
+            self.transaction_id,
+            TransactionReceipt._from_proto(receipt, self.transaction_id),
+        )
+
+    def _map_record_list(
+        self,
+        proto_records: List[transaction_get_record_pb2.TransactionGetRecordResponse],
+    ) -> List[TransactionRecord]:
+        records: List[TransactionRecord] = []
+        for record in proto_records:
+            records.append(TransactionRecord._from_proto(record, self.transaction_id))
+
+        return records
+
     def execute(self, client):
         """
         Executes the transaction record query.
-        
+
         Sends the query to the Hedera network and processes the response
         to return a TransactionRecord object.
-        
+
         This function delegates the core logic to `_execute()`, and may propagate exceptions raised by it.
 
         Args:
@@ -188,27 +225,27 @@ def execute(self, client):
         """
         self._before_execute(client)
         response = self._execute(client)
-        #childrens = self._map_record_list(response.child_transaction_records)
-        return TransactionRecord._from_proto(response.transactionGetRecord.transactionRecord, self.transaction_id)
+        if not response.HasField("transactionGetRecord"):
+            raise AttributeError("Response does not contain 'transactionGetRecord'")
+        record_response = response.transactionGetRecord
+        children = self._map_record_list(record_response.child_transaction_records)
+        return TransactionRecord._from_proto(
+            response.transactionGetRecord.transactionRecord,
+            self.transaction_id,
+            children=children,
+        )
 
     def _get_query_response(self, response: Any):
         """
         Extracts the transaction record response from the full response.
-        
+
         Implements the abstract method from Query to extract the
         specific transaction record response object.
-        
+
         Args:
             response: The full response from the network
-            
+
         Returns:
             The transaction get record response object
         """
         return response.transactionGetRecord
-    
-    def _map_record_list(self, proto_records: List[transaction_get_record_pb2.TransactionGetRecordResponse]) -> List[TransactionRecord]:
-        records: List[TransactionRecord] = []
-        for record in proto_records:
-            records.append(TransactionRecord._from_proto(record, self.transaction_id))
-
-        return records