Refactor AccountInfo class to use the `staking_info`

[manishdait]

Problem

The current AccountInfo implementation in the SDK partially represents staking data by flattening selected fields from the protobuf StakingInfo message directly into the AccountInfo:

• staked_account_id
• staked_node_id
• decline_staking_reward

However, the protobuf StakingInfo message contains additional fields (e.g. pending_reward, staked_to_me, stake_period_start) that are not represented.

This results in:

• Loss of staking-related data
• Inconsistency with other SDKs

Proposed Solution

• Remove the following fields from AccountInfo:
  • staked_account_id
  • staked_node_id
  • decline_staking_reward
• Add a single unified field:

  staking_info: Optional[StakingInfo] = None

• In from_proto Replace manual field extraction with:

   def _from_proto(cls, proto: CryptoGetInfoResponse.AccountInfo) -> "AccountInfo":
        ...
        
        account_info: "AccountInfo" = cls(
          ...,
          staking_info=(
             StakingInfo.from_proto(proto.staking_info)
             if proto.HasField("staking_info")
             else None
           )
        )

• Updated the to_proto to do same:

  def _to_proto(self) -> CryptoGetInfoResponse.AccountInfo:
        ...
        return CryptoGetInfoResponse.AccountInfo(
            ...,
            staking_info=(
              self.staking_info.to_proto()
              if self.staking_info is not None
              else None
            )
        )

• Update str/repr to print staking data via the StakingInfo object instead of individual fields
• Update unit/integration test to verify the changes

[github-actions]

@coderabbitai plan

[coderabbitai]

Coding Plan

Approach

Refactor AccountInfo to replace three flattened staking fields (staked_account_id, staked_node_id, decline_staking_reward) with a single staking_info field that wraps a complete StakingInfo object, exposing all six staking-related fields from the protobuf message.

Observations

The Hiero Python SDK follows a consistent pattern of wrapping protobuf messages in Python dataclasses located in domain-specific modules (account, contract, token). The AccountInfo class currently lives in src/hiero_sdk_python/account/account_info.py and uses dataclass structure with _from_proto(), _to_proto(), __str__(), and __repr__() methods. Protobuf messages are imported from hiero_sdk_python.hapi.services.*_pb2 modules. The StakingInfo protobuf message is already imported from basic_types_pb2 but not yet wrapped in a Python class.

Implementation Steps

Phase 1: Create StakingInfo Wrapper Class

Create a new Python wrapper class for the protobuf StakingInfo message, following the established pattern used by other Info classes in the SDK.

Task 1: Define StakingInfo dataclass

Create the StakingInfo Python wrapper class with all six fields from the protobuf message.

• Create StakingInfo class in src/hiero_sdk_python/account/staking_info.py as a new module
• Use @dataclass decorator following the pattern in AccountInfo and TokenInfo
• Define six optional fields with appropriate types:
  • pending_reward: Optional[Hbar] - use Hbar wrapper for int64 tinybar amount
  • staked_to_me: Optional[Hbar] - use Hbar wrapper for int64 tinybar amount
  • stake_period_start: Optional[datetime] - convert from protobuf Timestamp
  • staked_account_id: Optional[AccountId] - existing field, AccountId wrapper
  • staked_node_id: Optional[int] - existing field, direct int64
  • decline_staking_reward: Optional[bool] - existing field (note: protobuf uses decline_reward)

Task 2: Implement StakingInfo protobuf conversion methods

Implement bidirectional conversion between the Python StakingInfo wrapper and protobuf StakingInfo message.

• Create _from_proto() classmethod in StakingInfo that accepts protobuf StakingInfo
• Use HasField() checks for optional fields following the pattern in AccountInfo._from_proto()
• Convert pending_reward and staked_to_me from int64 tinybars to Hbar objects
• Convert stake_period_start from protobuf Timestamp to Python datetime
• Handle the oneof staked_id field (either staked_account_id or staked_node_id will be set)
• Create _to_proto() method that returns protobuf StakingInfo message
• Use CopyFrom() pattern with None checks for optional nested objects
• Convert Hbar objects back to int64 tinybars
• Convert datetime back to protobuf Timestamp

Task 3: Add StakingInfo string representation methods

Implement readable string representations for debugging and display purposes.

• Create __str__() method in StakingInfo following the pattern in AccountInfo.__str__()
• Include all six fields in formatted output, showing only non-None values
• Create __repr__() method showing the class name and key fields
• Follow the multi-line formatting style used in AccountInfo.__str__()

🤖 Prompt for AI agents

Create a new StakingInfo wrapper class for the protobuf StakingInfo message
following SDK patterns.

Create `src/hiero_sdk_python/account/staking_info.py` with a `@dataclass`
decorated StakingInfo class.

Define six optional fields:
- `pending_reward: Optional[Hbar]`
- `staked_to_me: Optional[Hbar]`
- `stake_period_start: Optional[datetime]`
- `staked_account_id: Optional[AccountId]`
- `staked_node_id: Optional[int]`
- `decline_staking_reward: Optional[bool]`

Implement `_from_proto()` classmethod:
- Accept protobuf StakingInfo parameter
- Use `HasField()` checks for optional fields
- Convert tinybars to Hbar objects for `pending_reward` and `staked_to_me`
- Convert protobuf Timestamp to datetime for `stake_period_start`
- Handle oneof `staked_id` field (either `staked_account_id` or
`staked_node_id`)

Implement `_to_proto()` method:
- Return protobuf StakingInfo message
- Convert Hbar objects to tinybars
- Convert datetime to protobuf Timestamp
- Use `CopyFrom()` pattern with None checks

Implement `__str__()` and `__repr__()` methods:
- Follow AccountInfo string representation patterns
- Show only non-None values
- Use multi-line formatting for readability

Phase 2: Refactor AccountInfo Class

Update AccountInfo to use the new StakingInfo wrapper, removing the three flattened fields and updating all related methods.

Task 1: Replace staking fields in AccountInfo

Remove the three individual staking fields and add the unified staking_info field.

• In src/hiero_sdk_python/account/account_info.py, remove these field declarations:
  • staked_account_id: Optional[AccountId] = None
  • staked_node_id: Optional[int] = None
  • decline_staking_reward: Optional[bool] = None
• Add new field: staking_info: Optional[StakingInfo] = None
• Add import for the new StakingInfo class from the staking_info module

Task 2: Update AccountInfo._from_proto() method

Modify the protobuf deserialization to create StakingInfo wrapper instead of extracting individual fields.

• In src/hiero_sdk_python/account/account_info.py, update _from_proto() method
• Remove the manual extraction of staked_account_id, staked_node_id, and decline_reward from proto.staking_info
• Replace with: check if proto.HasField('staking_info'), then call StakingInfo._from_proto(proto.staking_info)
• Assign result to staking_info parameter in AccountInfo constructor
• This consolidates the staking field extraction into a single wrapper conversion

Task 3: Update AccountInfo._to_proto() method

Modify the protobuf serialization to convert StakingInfo wrapper back to protobuf message.

• In src/hiero_sdk_python/account/account_info.py, update _to_proto() method
• Remove the manual construction of protobuf StakingInfo with three individual fields
• Replace with: check if self.staking_info is not None, then call self.staking_info._to_proto()
• Use .CopyFrom() to set the protobuf staking_info field
• Follow the pattern used for other optional nested objects in AccountInfo

Task 4: Update AccountInfo string representation methods

Modify str and repr to display staking information through the StakingInfo object.

• In src/hiero_sdk_python/account/account_info.py, update __str__() method
• Remove individual staking field references from the simple_fields list and decline_staking_reward check
• Add staking_info to the simple_fields list so it prints using StakingInfo's str() method
• Update __repr__() method to remove individual staked_node_id and staked_account_id references
• Add staking_info to the repr string if not None

🤖 Prompt for AI agents

Refactor AccountInfo to use the new StakingInfo wrapper instead of three
flattened fields.

In `src/hiero_sdk_python/account/account_info.py`:

Remove three field declarations:
- `staked_account_id: Optional[AccountId] = None`
- `staked_node_id: Optional[int] = None`
- `decline_staking_reward: Optional[bool] = None`

Add new field:
- `staking_info: Optional[StakingInfo] = None`

Add import for StakingInfo from staking_info module.

Update `_from_proto()` method:
- Remove manual extraction of individual staking fields
- Check if `proto.HasField('staking_info')`
- Call `StakingInfo._from_proto(proto.staking_info)`
- Assign result to staking_info parameter

Update `_to_proto()` method:
- Remove manual construction of protobuf StakingInfo
- Check if `self.staking_info is not None`
- Call `self.staking_info._to_proto()`
- Use `.CopyFrom()` to set protobuf staking_info field

Update `__str__()` method:
- Remove individual staking field references
- Add staking_info to simple_fields list

Update `__repr__()` method:
- Remove individual staked_node_id and staked_account_id references
- Add staking_info to repr string if not None

Phase 3: Update Tests

Modify tests to access staking fields through the new staking_info object and verify the complete refactoring works correctly.

Task 1: Update AccountInfo unit tests

Modify unit tests to test the new nested StakingInfo structure.

• In tests/unit/account_info_test.py, update proto conversion tests
• In test_from_proto(), add staking_info with all six fields to the mock protobuf object
• Verify account_info.staking_info is properly created with all fields accessible
• In test_to_proto(), create AccountInfo with populated StakingInfo object
• Verify the protobuf staking_info message contains all expected fields
• In test_proto_conversion(), verify roundtrip conversion preserves all staking fields

Task 2: Update AccountInfo integration tests

Modify integration tests to access staking fields through the new staking_info object.

• In tests/integration/account_create_transaction_e2e_test.py, update assertions
• Replace direct field access (e.g., info.staked_account_id) with nested access (e.g., info.staking_info.staked_account_id)
• Update tests: test_create_account_with_staked_account_id, test_create_account_with_staked_node_id, test_create_account_with_decline_reward
• In tests/integration/account_update_transaction_e2e_test.py, update assertions
• Replace direct field access with nested access through staking_info
• Update tests: test_integration_account_update_transaction_with_staking_fields, test_integration_account_update_transaction_with_staked_node_id

Task 3: Verify transaction tests remain unchanged

Confirm that transaction setter/getter tests don't need updates.

• Review tests/unit/account_update_transaction_test.py to confirm these tests only verify transaction protobuf serialization
• These tests don't read from AccountInfo objects, so they should continue passing without modifications
• Transaction classes (AccountCreateTransaction, AccountUpdateTransaction, etc.) have their own staking fields used to SET values on the network
• AccountInfo's refactoring only affects how staking data is READ and displayed after querying

🤖 Prompt for AI agents

Update tests to access staking fields through the new nested staking_info
object.

In `tests/unit/account_info_test.py`:
- Update `test_from_proto()` to add staking_info with all six fields to mock
protobuf
- Verify `account_info.staking_info` is created with all fields accessible
- Update `test_to_proto()` to create AccountInfo with populated StakingInfo
object
- Verify protobuf staking_info message contains all expected fields
- Update `test_proto_conversion()` to verify roundtrip conversion preserves all
staking fields

In `tests/integration/account_create_transaction_e2e_test.py`:
- Replace direct field access with nested access through staking_info
- Update assertions in `test_create_account_with_staked_account_id`,
`test_create_account_with_staked_node_id`,
`test_create_account_with_decline_reward`
- Change `info.staked_account_id` to `info.staking_info.staked_account_id`
pattern

In `tests/integration/account_update_transaction_e2e_test.py`:
- Replace direct field access with nested access through staking_info
- Update assertions in
`test_integration_account_update_transaction_with_staking_fields`,
`test_integration_account_update_transaction_with_staked_node_id`

No changes needed for `tests/unit/account_update_transaction_test.py` - these
tests only verify transaction protobuf serialization, not AccountInfo reading.

---

🚀 Next Steps

🤖 All AI agent prompts combined

Task: 1

Create a new StakingInfo wrapper class for the protobuf StakingInfo message
following SDK patterns.

Create `src/hiero_sdk_python/account/staking_info.py` with a `@dataclass`
decorated StakingInfo class.

Define six optional fields:
- `pending_reward: Optional[Hbar]`
- `staked_to_me: Optional[Hbar]`
- `stake_period_start: Optional[datetime]`
- `staked_account_id: Optional[AccountId]`
- `staked_node_id: Optional[int]`
- `decline_staking_reward: Optional[bool]`

Implement `_from_proto()` classmethod:
- Accept protobuf StakingInfo parameter
- Use `HasField()` checks for optional fields
- Convert tinybars to Hbar objects for `pending_reward` and `staked_to_me`
- Convert protobuf Timestamp to datetime for `stake_period_start`
- Handle oneof `staked_id` field (either `staked_account_id` or
`staked_node_id`)

Implement `_to_proto()` method:
- Return protobuf StakingInfo message
- Convert Hbar objects to tinybars
- Convert datetime to protobuf Timestamp
- Use `CopyFrom()` pattern with None checks

Implement `__str__()` and `__repr__()` methods:
- Follow AccountInfo string representation patterns
- Show only non-None values
- Use multi-line formatting for readability
===============================================================================

Task: 2

Refactor AccountInfo to use the new StakingInfo wrapper instead of three
flattened fields.

In `src/hiero_sdk_python/account/account_info.py`:

Remove three field declarations:
- `staked_account_id: Optional[AccountId] = None`
- `staked_node_id: Optional[int] = None`
- `decline_staking_reward: Optional[bool] = None`

Add new field:
- `staking_info: Optional[StakingInfo] = None`

Add import for StakingInfo from staking_info module.

Update `_from_proto()` method:
- Remove manual extraction of individual staking fields
- Check if `proto.HasField('staking_info')`
- Call `StakingInfo._from_proto(proto.staking_info)`
- Assign result to staking_info parameter

Update `_to_proto()` method:
- Remove manual construction of protobuf StakingInfo
- Check if `self.staking_info is not None`
- Call `self.staking_info._to_proto()`
- Use `.CopyFrom()` to set protobuf staking_info field

Update `__str__()` method:
- Remove individual staking field references
- Add staking_info to simple_fields list

Update `__repr__()` method:
- Remove individual staked_node_id and staked_account_id references
- Add staking_info to repr string if not None
===============================================================================

Task: 3

Update tests to access staking fields through the new nested staking_info
object.

In `tests/unit/account_info_test.py`:
- Update `test_from_proto()` to add staking_info with all six fields to mock
protobuf
- Verify `account_info.staking_info` is created with all fields accessible
- Update `test_to_proto()` to create AccountInfo with populated StakingInfo
object
- Verify protobuf staking_info message contains all expected fields
- Update `test_proto_conversion()` to verify roundtrip conversion preserves all
staking fields

In `tests/integration/account_create_transaction_e2e_test.py`:
- Replace direct field access with nested access through staking_info
- Update assertions in `test_create_account_with_staked_account_id`,
`test_create_account_with_staked_node_id`,
`test_create_account_with_decline_reward`
- Change `info.staked_account_id` to `info.staking_info.staked_account_id`
pattern

In `tests/integration/account_update_transaction_e2e_test.py`:
- Replace direct field access with nested access through staking_info
- Update assertions in
`test_integration_account_update_transaction_with_staking_fields`,
`test_integration_account_update_transaction_with_staked_node_id`

No changes needed for `tests/unit/account_update_transaction_test.py` - these
tests only verify transaction protobuf serialization, not AccountInfo reading.

💡 Iterate on the plan with: @coderabbitai <feedback>

Example Feedback
- @coderabbitai You can skip phase 3. Add a simple unit test case for phase 2.
- @coderabbitai For assumption 1 go ahead with option 3 and replan.

---

💬 Have feedback or questions? Drop into our discord!

[mukundkumarjha]

/assign

[rwalworth]

You are assigned @mukundkumarjha, reach out if you have any questions!