Addition of Staking Info (#92)

Author: Z-Rubin

examples/basic_staking.py

@@ -0,0 +1,27 @@
+import json
+
+import example_utils
+
+from hyperliquid.utils import constants
+
+
+def main():
+    address, info, exchange = example_utils.setup(base_url=constants.MAINNET_API_URL, skip_ws=True)
+
+    # Get the user staking summary and print information
+    user_staking_summary = info.user_staking_summary(address)
+    print("Staking summary:")
+    print(json.dumps(user_staking_summary, indent=2))
+
+    # Get the user staking delegations and print information
+    user_stakes = info.user_stakes(address)
+    print("Staking breakdown:")
+    print(json.dumps(user_stakes, indent=2))
+
+    # Get the user staking reward history and print information
+    user_staking_rewards= info.user_staking_rewards(address)
+    print("Most recent staking rewards:")
+    print(json.dumps(user_staking_rewards[:5], indent=2))
+
+if __name__ == "__main__":
+    main()

hyperliquid/info.py

@@ -500,6 +500,56 @@ def user_fees(self, address: str) -> Any:
             }
         """
         return self.post("/info", {"type": "userFees", "user": address})
+    
+    def user_staking_summary(self, address: str) -> Any:
+        """Retrieve the staking summary associated with a user.
+        POST /info
+        Args:
+            address (str): Onchain address in 42-character hexadecimal format;
+                            e.g. 0x0000000000000000000000000000000000000000.
+        Returns:
+            {
+                delegated: float string,
+                undelegated: float string,
+                totalPendingWithdrawal: float string,
+                nPendingWithdrawals: int
+            }
+        """
+        return self.post("/info", {"type": "delegatorSummary", "user": address})
+    
+    def user_staking_delegations(self, address: str) -> Any:
+        """Retrieve the user's staking delegations.
+        POST /info
+        Args:
+            address (str): Onchain address in 42-character hexadecimal format;
+                            e.g. 0x0000000000000000000000000000000000000000.
+        Returns:
+            [
+                {
+                    validator: string,
+                    amount: float string,
+                    lockedUntilTimestamp: int
+                },
+            ]
+        """
+        return self.post("/info", {"type": "delegations", "user": address})
+    
+    def user_staking_rewards(self, address: str) -> Any:
+        """Retrieve the historic staking rewards associated with a user.
+        POST /info
+        Args:
+            address (str): Onchain address in 42-character hexadecimal format;
+                            e.g. 0x0000000000000000000000000000000000000000.
+        Returns:
+            [
+                {
+                    time: int,
+                    source: string,
+                    totalAmount: float string
+                },
+            ]
+        """
+        return self.post("/info", {"type": "delegatorRewards", "user": address})
 
     def query_order_by_oid(self, user: str, oid: int) -> Any:
         return self.post("/info", {"type": "orderStatus", "user": user, "oid": oid})