Add support for `include_children` to the TransactionRecordQuery class

[manishdait]

Problem

Currently, the Python SDK implementation of TransactionRecordQuery supports only the following fields:

self.transaction_id: Optional[TransactionId] = transaction_id

However, it does not expose support for requesting child transaction record, which are already supported at the Protobuff level and in other SDKs (e.g., JavaScript).

Expected Behavior:

The query should allow user to optionally request for child transaction record executed as part of a parent transaction.
Eg:

query = (
    TransactionRecordQuery()
    .set_transaction_id(tx_id)
    .set_include_child(True) #True/False
)

Solution

• Add support for an include_children field to TransactionRecordQuery class

class TransactionRecordQuery(Query):
    def __init__(
        ...
        include_children: bool = False,
    ):
        ...
        self.include_children = include_children

• Create a setter method set_include_children(bool).
• Update TransactionRecord class to include the childrens field

@dataclass
class TransactionRecord:
    ....
    childrens: List[TransactionRecord] = []

• Add a function to process the child records form the TransactionRecordQuery response

# Example func that convert the child_transaction_records to TransactionRecord list and then return

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

• Update _make_request() function of TransactionRecordQuery to include include_child_records field while creating the proto.
• Update the _from_proto() method of TransactionRecord and _execute() method of TransactionRecordQuery class:

# TransactionReceipt
@classmethod
    def _from_proto(cls, proto: transaction_record_pb2.TransactionRecord, transaction_id: Optional[TransactionId] = None, childrens: Optional[List[TransactionRecord]] = []) -> 'TransactionRecord':
        ....
        return cls(
            ........,
            childrens=childrens
        )


# TransactionGetReceiptQuery
def execute(self, client: Client) -> TransactionRecord:
        ...
        childrens = self._map_record_list(response.child_transaction_records)
        return TransactionRecord._from_proto(response.transactionGetRecord.transactionRecord, self.transaction_id, childrens=childrens)

• Create a example for demonstrating and using these new field
• Update/Add unit and integration test for the changes

[github-actions]

@coderabbitai plan

[coderabbitai]

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Fetch the GitHub issue details
gh issue view 1512 --json title,body,labels,assignees,comments --repo hiero-ledger/hiero-sdk-python

Length of output: 3931

---

🏁 Script executed:

#!/bin/bash
# Find the TransactionRecordQuery class file
fd -t f -e py | xargs grep -l "class TransactionRecordQuery"

# Find the TransactionRecord class file
fd -t f -e py | xargs grep -l "class TransactionRecord"

# Find example files directory structure
fd -t d "example" | head -10

# Find test files related to TransactionRecord
fd -t f -e py "test.*transaction.*record" -i

Length of output: 192

---

🏁 Script executed:

#!/bin/bash
# Read the TransactionRecordQuery class
cat src/hiero_sdk_python/query/transaction_record_query.py

# Read the TransactionRecord class
cat src/hiero_sdk_python/transaction/transaction_record.py

# Find test files for these classes
find . -path "*/test*" -name "*transaction*record*" -type f 2>/dev/null | head -10

# Check the examples directory structure
ls -la examples/ | head -20

Length of output: 21309

---

🏁 Script executed:

#!/bin/bash
# Check the proto file to understand the structure
find . -name "transaction_get_record*" -type f | grep -E "\.(proto|py)$" | head -5

# Read the test files to understand current testing patterns
cat tests/unit/transaction_record_query_test.py

# Check if there's a proto file we can examine
fd -t f "transaction_get_record" | head -10

Length of output: 4761

---

🏁 Script executed:

#!/bin/bash
# Check the integration test structure
cat tests/integration/transaction_record_query_e2e_test.py | head -100

# Look at example patterns to understand the structure
ls -la examples/query/ 2>/dev/null || ls -la examples/ | grep -i query

# Check the proto imports to understand the structure better
grep -n "include.*child" src/hiero_sdk_python/ -r 2>/dev/null || echo "No existing child field usage found"

Length of output: 6790

---

🏁 Script executed:

#!/bin/bash
# Check the existing TransactionRecordQuery example
cat examples/query/transaction_record_query.py

# Check TransactionGetReceiptQuery to see how include_children is implemented there
cat src/hiero_sdk_python/query/transaction_get_receipt_query.py | head -200

Length of output: 14485

---

@github-actions[bot], I'll create a comprehensive plan to add support for include_children to the TransactionRecordQuery class.

Task: Add support for include_children to TransactionRecordQuery

Overview:
Implement child transaction record support in TransactionRecordQuery, allowing users to optionally request child transaction records executed as part of a parent transaction. This follows the existing pattern from TransactionGetReceiptQuery and aligns with protobuf definitions.

Files to modify:

1. src/hiero_sdk_python/query/transaction_record_query.py - Add include_children parameter and setter
2. src/hiero_sdk_python/transaction/transaction_record.py - Add children field to store child records
3. tests/unit/transaction_record_query_test.py - Add unit tests for new functionality
4. tests/integration/transaction_record_query_e2e_test.py - Add integration tests
5. examples/query/transaction_record_query.py - Add example demonstrating the feature

---

---

Summary:
This plan implements full support for querying child transaction records, following the existing patterns in the codebase. The implementation includes:

• Parameter and setter method for include_children in TransactionRecordQuery
• children field in TransactionRecord dataclass to store child records
• Protobuf request field configuration
• Response processing to extract and map child records
• Comprehensive unit tests covering all new functionality
• Integration tests to verify end-to-end behavior
• Updated example demonstrating the new feature

The implementation follows the same pattern as TransactionGetReceiptQuery for consistency and maintainability.

---

💡 Use @coderabbitai plan to create a plan for code changes

[mukundkumarjha]

@manishdait I can try this