Add StakingInfo class to SDK

[manishdait]

Introduce a dedicated StakingInfo SDK to represent the protobuf StakingInfo message in a structured way.
This new class should fully mirror the protobuf representation and provide consistent serialization/deserialization utilities, just like other entities in the SDK.

Protobuf Refrence

message StakingInfo {
    bool decline_reward = 1;
    Timestamp stake_period_start = 2;
    int64 pending_reward = 3;
    int64 staked_to_me = 4;
    oneof staked_id {
        AccountID staked_account_id = 5;
        int64 staked_node_id = 6;
    }
}

The class must have following characteristics:

• Implemented it as a @dataclass

• Fully represents all protobuf fields

   # Required Fields
  
   decline_reward: Optional[bool]
   stake_period_start: Optional[Timestamp]
   pending_reward: Optional[Hbar]
   staked_to_me: Optional[Hbar]
   staked_account_id: Optional[AccountId]
   staked_node_id: Optional[int]

• The class should provide below mwthods:

   @classmethod
   from_proto(cls, proto: basic_types_pb2.StakingInfo) -> StakingInfo
  
   to_proto(self) -> basic_types_pb2.StakingInfo
  
   @classmethod
   from_bytes(cls, data: bytes) -> StakingInfo
  
   to_bytes(self) -> bytes

Proposed Solution

• Create a class (@dataclass) call StackingInfo located at src/hiero_sdk_python/staking_info.py
• Add the required fields to the class while preserving oneof semantics for staked_account_id vs staked_node_id.
• Add the required methods to the class
• Ensure proper validation while creating the protobuff representation from class and vice versa
• Ensure proper deserailize and serialize using from/to bytes method

   # eg.
   from_bytes(cls, data: bytes) -> StackingInfo:
      proto = basic_types_pb2.StakingInfo.FromString(data)
      return cls.from_proto(proto)
   
   to_bytes(self) -> bytes:
      return self.to_proto().SerializeToString()

• Add comprehensive unit tests to validate.

[github-actions]

@coderabbitai plan

[coderabbitai]

🧩 Analysis chain

🏁 Script executed:

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

Length of output: 3130

---

🏁 Script executed:

#!/bin/bash
# Find similar classes that implement from_proto/to_proto pattern
echo "=== Finding similar dataclass implementations ==="
fd -e py | xargs grep -l "from_proto\|to_proto" | head -10

echo -e "\n=== Check if AccountId class exists ==="
fd -e py -x grep -l "class AccountId" {} | head -5

echo -e "\n=== Check if Hbar class exists ==="
fd -e py -x grep -l "class Hbar" {} | head -5

echo -e "\n=== Check if Timestamp is used ==="
fd -e py -x grep -l "Timestamp" {} | head -5

echo -e "\n=== Look for basic_types_pb2 imports ==="
rg "basic_types_pb2" -n | head -10

echo -e "\n=== Check test directory structure ==="
fd -t d -d 2 test

echo -e "\n=== Find an example of a similar entity class ==="
fd "account_info.py"

Length of output: 2335

---

🏁 Script executed:

#!/bin/bash
# Examine AccountInfo class as a reference
echo "=== AccountInfo class implementation ==="
cat src/hiero_sdk_python/account/account_info.py

echo -e "\n\n=== Hbar class implementation ==="
cat src/hiero_sdk_python/hbar.py | head -80

echo -e "\n\n=== Check if Timestamp class exists ==="
fd "timestamp.py" -e py
cat src/hiero_sdk_python/timestamp.py 2>/dev/null || echo "Checking for Timestamp usage..."

echo -e "\n\n=== Check unit test for AccountInfo ==="
fd "account_info" -e py tests/
cat tests/unit/account_info_test.py 2>/dev/null | head -100

Length of output: 21940

---

🏁 Script executed:

#!/bin/bash
# Check if any class implements from_bytes/to_bytes pattern
echo "=== Finding from_bytes/to_bytes implementations ==="
rg "def from_bytes" -A 2 -B 2 | head -30

echo -e "\n=== Finding to_bytes implementations ==="
rg "def to_bytes" -A 2 -B 2 | head -30

echo -e "\n=== Check the protobuf file location ==="
fd "basic_types_pb2.py" 

echo -e "\n=== Check existing imports in the SDK ==="
rg "from hiero_sdk_python" src/hiero_sdk_python/account/account_info.py

echo -e "\n=== Check structure of src directory ==="
ls -la src/hiero_sdk_python/ | head -20

Length of output: 5428

---

🏁 Script executed:

#!/bin/bash
# Check if there are simpler entity classes with from_bytes/to_bytes
echo "=== Check Duration class (seems simpler) ==="
cat src/hiero_sdk_python/Duration.py

echo -e "\n=== Check for protobuf location ==="
find . -name "basic_types_pb2.py" -o -name "basic_types.proto" 2>/dev/null | head -5

echo -e "\n=== See how other tests are structured ==="
ls tests/unit/ | head -20

echo -e "\n=== Check __init__.py for exports ==="
rg "AccountInfo|TokenRelationship" src/hiero_sdk_python/__init__.py

Length of output: 2109

---

Task: Implement StakingInfo SDK Class

I'll help create a dedicated StakingInfo class that mirrors the protobuf representation. Based on the issue requirements and existing SDK patterns, here's the plan:

Implementation Structure:

1. Create new StakingInfo class in src/hiero_sdk_python/staking_info.py
2. Add comprehensive unit tests in tests/unit/staking_info_test.py
3. Export the class from __init__.py
4. Consider updating AccountInfo to use the new StakingInfo class (optional enhancement)

---

🏁 Script executed:

#!/bin/bash
# Check the current structure of __init__.py to understand export pattern
echo "=== Checking current __init__.py structure ==="
grep -A 5 "from .account.account_info import AccountInfo" src/hiero_sdk_python/__init__.py

echo -e "\n=== Checking __all__ exports ==="
grep -A 50 '__all__ = \[' src/hiero_sdk_python/__init__.py | head -60

Length of output: 1633

---

@github-actions[bot], I'll plan the implementation of the StakingInfo class for you. Another agent will handle the actual code changes.

Task: Implement StakingInfo SDK Class

I'll create a dedicated StakingInfo class that mirrors the protobuf representation with all required fields and methods. Here's the complete implementation plan:

Implementation Overview:

1. Create StakingInfo class in src/hiero_sdk_python/staking_info.py
2. Add comprehensive unit tests in tests/unit/staking_info_test.py
3. Export the class from src/hiero_sdk_python/__init__.py

---

---

⏳ Preparing changes...