fix: hbar test coverage issue

Signed-off-by: prajeeta pal <[email protected]>

Author: prajeeta15

CHANGELOG.md

@@ -9,6 +9,7 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
 
 
 ### Added
+- Added Hbar object support for TransferTransaction HBAR transfers: methods now accept Union[int, Hbar] for amount parameters, with immediate normalization to tinybars. Includes comprehensive unit tests covering various Hbar units (HBAR, MICROBAR, MILLIBAR, TINYBAR) and accumulation behavior with mixed int and Hbar inputs.
 - examples/mypy.ini for stricter type checking in example scripts
 - Added a GitHub Actions workflow that reminds contributors to link pull requests to issues.
 - Added `__str__` and `__repr__` methods to `AccountInfo` class for improved logging and debugging experience (#1098)

src/hiero_sdk_python/transaction/transfer_transaction.py

@@ -2,11 +2,12 @@
 Defines TransferTransaction for transferring HBAR or tokens between accounts.
 """
 
-from typing import Dict, List, Optional, Tuple
+from typing import Dict, List, Optional, Tuple, Union
 
 from hiero_sdk_python.account.account_id import AccountId
 from hiero_sdk_python.channels import _Channel
 from hiero_sdk_python.executable import _Method
+from hiero_sdk_python.hbar import Hbar
 from hiero_sdk_python.hapi.services import basic_types_pb2, crypto_transfer_pb2, transaction_pb2
 from hiero_sdk_python.hapi.services.schedulable_transaction_body_pb2 import (
     SchedulableTransactionBody,
@@ -59,14 +60,14 @@ def _init_hbar_transfers(self, hbar_transfers: Dict[AccountId, int]) -> None:
             self.add_hbar_transfer(account_id, amount)
 
     def _add_hbar_transfer(
-        self, account_id: AccountId, amount: int, is_approved: bool = False
+        self, account_id: AccountId, amount: Union[int, Hbar], is_approved: bool = False
     ) -> "TransferTransaction":
         """
         Internal method to add a HBAR transfer to the transaction.
 
         Args:
             account_id (AccountId): The account ID of the sender or receiver.
-            amount (int): The amount of the HBAR to transfer.
+            amount (Union[int, Hbar]): The amount of the HBAR to transfer.
             is_approved (bool, optional): Whether the transfer is approved. Defaults to False.
 
         Returns:
@@ -75,8 +76,12 @@ def _add_hbar_transfer(
         self._require_not_frozen()
         if not isinstance(account_id, AccountId):
             raise TypeError("account_id must be an AccountId instance.")
-        if not isinstance(amount, int) or amount == 0:
-            raise ValueError("Amount must be a non-zero integer.")
+        if isinstance(amount, Hbar):
+            amount = amount.to_tinybars()
+        elif not isinstance(amount, int):
+            raise TypeError("amount must be an int or Hbar instance.")
+        if amount == 0:
+            raise ValueError("Amount must be a non-zero value.")
         if not isinstance(is_approved, bool):
             raise TypeError("is_approved must be a boolean.")
 
@@ -88,13 +93,13 @@ def _add_hbar_transfer(
         self.hbar_transfers.append(HbarTransfer(account_id, amount, is_approved))
         return self
 
-    def add_hbar_transfer(self, account_id: AccountId, amount: int) -> "TransferTransaction":
+    def add_hbar_transfer(self, account_id: AccountId, amount: Union[int, Hbar]) -> "TransferTransaction":
         """
         Adds a HBAR transfer to the transaction.
 
         Args:
             account_id (AccountId): The account ID of the sender or receiver.
-            amount (int): The amount of the HBAR to transfer.
+            amount (Union[int, Hbar]): The amount of the HBAR to transfer.
 
         Returns:
             TransferTransaction: The current instance of the transaction for chaining.
@@ -103,14 +108,14 @@ def add_hbar_transfer(self, account_id: AccountId, amount: int) -> "TransferTran
         return self
 
     def add_approved_hbar_transfer(
-        self, account_id: AccountId, amount: int
+        self, account_id: AccountId, amount: Union[int, Hbar]
     ) -> "TransferTransaction":
         """
         Adds a HBAR transfer with approval to the transaction.
 
         Args:
             account_id (AccountId): The account ID of the sender or receiver.
-            amount (int): The amount of the HBAR to transfer.
+            amount (Union[int, Hbar]): The amount of the HBAR to transfer.
 
         Returns:
             TransferTransaction: The current instance of the transaction for chaining.

tests/unit/transfer_transaction_test.py

@@ -7,6 +7,8 @@
 from hiero_sdk_python.hapi.services.schedulable_transaction_body_pb2 import (
     SchedulableTransactionBody,
 )
+from hiero_sdk_python.hbar import Hbar
+from hiero_sdk_python.hbar_unit import HbarUnit
 from hiero_sdk_python.tokens.nft_id import NftId
 from hiero_sdk_python.transaction.transfer_transaction import TransferTransaction
 
@@ -283,8 +285,8 @@ def test_zero_amount_validation(mock_account_ids):
     account_id_1, _, _, token_id_1, _ = mock_account_ids
     transfer_tx = TransferTransaction()
 
-    # Test zero HBAR amount should raise ValueError
-    with pytest.raises(ValueError, match="Amount must be a non-zero integer"):
+    # Test zero HBAR amount should raise ValueError with updated message
+    with pytest.raises(ValueError, match="Amount must be a non-zero value"):
         transfer_tx.add_hbar_transfer(account_id_1, 0)
 
     # Test zero token amount should raise ValueError
@@ -510,3 +512,104 @@ def test_approved_token_transfer_validation(mock_account_ids):
     # Test zero amount
     with pytest.raises(ValueError, match="Amount must be a non-zero integer"):
         transfer_tx.add_approved_token_transfer_with_decimals(token_id_1, account_id_1, 0, 6)
+
+
+def test_add_hbar_transfer_with_hbar_object(mock_account_ids):
+    """Test adding HBAR transfers with Hbar objects (covers Hbar normalization)."""
+    account_id_sender, account_id_recipient, _, _, _ = mock_account_ids
+    transfer_tx = TransferTransaction()
+
+    transfer_tx.add_hbar_transfer(account_id_sender, Hbar(-500))
+    transfer_tx.add_hbar_transfer(account_id_recipient, Hbar(500))
+
+    sender_transfer = next(
+        t for t in transfer_tx.hbar_transfers if t.account_id == account_id_sender
+    )
+    recipient_transfer = next(
+        t for t in transfer_tx.hbar_transfers if t.account_id == account_id_recipient
+    )
+
+    assert sender_transfer.amount == -50_000_000_000
+    assert recipient_transfer.amount == 50_000_000_000
+
+
+def test_add_hbar_transfer_with_hbar_tinybars(mock_account_ids):
+    """Test adding HBAR transfers with Hbar objects in TINYBAR units."""
+    account_id_sender, account_id_recipient, _, _, _ = mock_account_ids
+    transfer_tx = TransferTransaction()
+
+    transfer_tx.add_hbar_transfer(account_id_sender, Hbar(-500, HbarUnit.TINYBAR))
+    transfer_tx.add_hbar_transfer(account_id_recipient, Hbar(500, HbarUnit.TINYBAR))
+
+    sender_transfer = next(
+        t for t in transfer_tx.hbar_transfers if t.account_id == account_id_sender
+    )
+    recipient_transfer = next(
+        t for t in transfer_tx.hbar_transfers if t.account_id == account_id_recipient
+    )
+
+    assert sender_transfer.amount == -500
+    assert recipient_transfer.amount == 500
+
+
+def test_add_approved_hbar_transfer_with_hbar_object(mock_account_ids):
+    """Test adding approved HBAR transfers with Hbar objects."""
+    account_id_sender, _, _, _, _ = mock_account_ids
+    transfer_tx = TransferTransaction()
+
+    transfer_tx.add_approved_hbar_transfer(account_id_sender, Hbar(1000))
+
+    transfer = transfer_tx.hbar_transfers[0]
+    assert transfer.account_id == account_id_sender
+    assert transfer.amount == 100_000_000_000
+    assert transfer.is_approved is True
+
+
+def test_hbar_accumulation_with_mixed_int_and_hbar(mock_account_ids):
+    """Test that HBAR transfers accumulate correctly with mixed int and Hbar inputs."""
+    account_id_1, _, _, _, _ = mock_account_ids
+    transfer_tx = TransferTransaction()
+
+    transfer_tx.add_hbar_transfer(account_id_1, 100)
+    transfer_tx.add_hbar_transfer(account_id_1, Hbar(1))
+    transfer_tx.add_hbar_transfer(account_id_1, -50)
+
+    transfer = transfer_tx.hbar_transfers[0]
+    assert transfer.amount == 100 + 100_000_000 - 50
+
+
+def test_zero_hbar_value_validation(mock_account_ids):
+    """Test that zero Hbar amounts are properly rejected."""
+    account_id_1, _, _, _, _ = mock_account_ids
+    transfer_tx = TransferTransaction()
+
+    with pytest.raises(ValueError, match="Amount must be a non-zero value"):
+        transfer_tx.add_hbar_transfer(account_id_1, Hbar(0))
+
+    with pytest.raises(ValueError, match="Amount must be a non-zero value"):
+        transfer_tx.add_hbar_transfer(account_id_1, 0)
+
+
+def test_add_hbar_transfer_with_various_hbar_units(mock_account_ids):
+    """Test adding HBAR transfers with various Hbar units."""
+    account_id_1, _, _, _, _ = mock_account_ids
+    transfer_tx = TransferTransaction()
+
+    transfer_tx.add_hbar_transfer(account_id_1, Hbar(1, HbarUnit.HBAR))
+    transfer_tx.add_hbar_transfer(account_id_1, Hbar(1000, HbarUnit.MICROBAR))
+    transfer_tx.add_hbar_transfer(account_id_1, Hbar(100, HbarUnit.MILLIBAR))
+
+    transfer = transfer_tx.hbar_transfers[0]
+    assert transfer.amount == 100_000_000 + 100_000 + 10_000_000
+
+
+def test_invalid_amount_type_hbar_transfer(mock_account_ids):
+    """Test that invalid amount types raise TypeError (covers type checking)."""
+    account_id_1, _, _, _, _ = mock_account_ids
+    transfer_tx = TransferTransaction()
+
+    with pytest.raises(TypeError, match="amount must be an int or Hbar instance"):
+        transfer_tx.add_hbar_transfer(account_id_1, "invalid")
+
+    with pytest.raises(TypeError, match="amount must be an int or Hbar instance"):
+        transfer_tx.add_hbar_transfer(account_id_1, 123.45)