Version 0.5.0

Fixes issue with incorrect coin to asset mapping for spot

Author: traderben

assets/images/coverage.svg

@@ -4,7 +4,8 @@
 import example_utils
 
 
-COIN = "PURR/USDC"
+PURR = "PURR/USDC"
+OTHER_COIN = "@8"
 
 
 def main():
@@ -20,7 +21,7 @@ def main():
         print("no available token balances")
 
     # Place an order that should rest by setting the price very low
-    order_result = exchange.order(COIN, True, 1200, 0.01, {"limit": {"tif": "Gtc"}})
+    order_result = exchange.order(PURR, True, 24, 0.5, {"limit": {"tif": "Gtc"}})
     print(order_result)
 
     # Query the order status by oid
@@ -34,7 +35,16 @@ def main():
     if order_result["status"] == "ok":
         status = order_result["response"]["data"]["statuses"][0]
         if "resting" in status:
-            cancel_result = exchange.cancel(COIN, status["resting"]["oid"])
+            cancel_result = exchange.cancel(PURR, status["resting"]["oid"])
+            print(cancel_result)
+
+    # For other spot assets other than PURR/USDC use @{index} e.g. on testnet @8 is KORILA/USDC
+    order_result = exchange.order(OTHER_COIN, True, 1, 12, {"limit": {"tif": "Gtc"}})
+    print(order_result)
+    if order_result["status"] == "ok":
+        status = order_result["response"]["data"]["statuses"][0]
+        if "resting" in status:
+            cancel_result = exchange.cancel(OTHER_COIN, status["resting"]["oid"])
             print(cancel_result)
 
 

examples/basic_spot_order.py

@@ -59,8 +59,8 @@ def __init__(
         self.coin_to_asset = {asset_info["name"]: asset for (asset, asset_info) in enumerate(self.meta["universe"])}
 
         # spot assets start at 10000
-        for i, spot_pair in enumerate(self.spot_meta["universe"]):
-            self.coin_to_asset[spot_pair["name"]] = i + 10000
+        for spot_info in self.spot_meta["universe"]:
+            self.coin_to_asset[spot_info["name"]] = spot_info["index"] + 10000
 
     def _post_action(self, action, signature, nonce):
         payload = {
@@ -82,9 +82,9 @@ def _slippage_price(
         if not px:
             # Get midprice
             px = float(self.info.all_mids()[coin])
-        
+
         # spot assets start at 10000
-        is_spot = self.coin_to_asset.get(coin) >= 10_000
+        is_spot = self.coin_to_asset[coin] >= 10_000
 
         # Calculate Slippage
         px *= (1 + slippage) if is_buy else (1 - slippage)

hyperliquid/exchange.py

@@ -1,5 +1,15 @@
 from hyperliquid.api import API
-from hyperliquid.utils.types import Any, Callable, Meta, SpotMeta, SpotMetaAndAssetCtxs, Optional, Subscription, cast, Cloid
+from hyperliquid.utils.types import (
+    Any,
+    Callable,
+    Meta,
+    SpotMeta,
+    SpotMetaAndAssetCtxs,
+    Optional,
+    Subscription,
+    cast,
+    Cloid,
+)
 from hyperliquid.websocket_manager import WebsocketManager
 
 
@@ -171,36 +181,36 @@ def meta(self) -> Meta:
             }
         """
         return cast(Meta, self.post("/info", {"type": "meta"}))
-    
-    def metaAndAssetCtxs(self) -> Any:
+
+    def meta_and_asset_ctxs(self) -> Any:
         """Retrieve exchange MetaAndAssetCtxs
-        
+
         POST /info
-        
+
         Returns:
             [
                 {
                     universe: [
                         {
-                            'maxLeverage': int,
                             'name': str,
-                            'onlyIsolated': bool,
                             'szDecimals': int
+                            'maxLeverage': int,
+                            'onlyIsolated': bool,
                         },
                         ...
                     ]
                 },
             [
                 {
-                    "dayNtlVlm": str,
-                    "funding": str,
-                    "impactPxs": [str, str],
-                    "markPx": str,
-                    "midPx": str,
-                    "openInterest": str,
-                    "oraclePx": str,
-                    "premium": str,
-                    "prevDayPx": str
+                    "dayNtlVlm": float string,
+                    "funding": float string,
+                    "impactPxs": Optional([float string, float string]),
+                    "markPx": Optional(float string),
+                    "midPx": Optional(float string),
+                    "openInterest": float string,
+                    "oraclePx": float string,
+                    "premium": Optional(float string),
+                    "prevDayPx": float string
                 },
                 ...
             ]
@@ -216,13 +226,13 @@ def spot_meta(self) -> SpotMeta:
             {
                 universe: [
                     {
-                        tokens: [int, int],
+                        tokens: [int, int]
                         name: str,
                         index: int,
                         isCanonical: bool
                     },
                     ...
-                ]
+                ],
                 tokens: [
                     {
                         name: str,
@@ -233,42 +243,45 @@ def spot_meta(self) -> SpotMeta:
                         isCanonical: bool
                     },
                     ...
-                ],
+                ]
             }
         """
         return cast(SpotMeta, self.post("/info", {"type": "spotMeta"}))
-    
+
     def spot_meta_and_asset_ctxs(self) -> SpotMetaAndAssetCtxs:
         """Retrieve exchange spot asset contexts
-
         POST /info
-
         Returns:
             [
                 {
                     universe: [
                         {
-                            name: str,
                             tokens: [int, int]
-                        }
+                            name: str,
+                            index: int,
+                            isCanonical: bool
+                        },
                         ...
                     ],
                     tokens: [
                         {
                             name: str,
                             szDecimals: int,
-                            weiDecimals int
+                            weiDecimals: int,
+                            index: int,
+                            tokenId: str,
+                            isCanonical: bool
                         },
                         ...
                     ]
                 },
                 [
                     {
-                        dayNtlVlm: float,
-                        markPx: float,
-                        midPx: float,
-                        prevDayPx: float,
-                        circulatingSupply: float,
+                        dayNtlVlm: float string,
+                        markPx: float string,
+                        midPx: Optional(float string),
+                        prevDayPx: float string,
+                        circulatingSupply: float string,
                         coin: str
                     }
                     ...

hyperliquid/info.py

@@ -28,8 +28,10 @@
     {"name": str, "szDecimals": int, "weiDecimals": int, "index": int, "tokenId": str, "isCanonical": bool},
 )
 SpotMeta = TypedDict("SpotMeta", {"universe": List[SpotAssetInfo], "tokens": List[SpotTokenInfo]})
-
-SpotAssetCtx = TypedDict("SpotAssetCtx", {"dayNtlVlm": str, "markPx": str, "midPx": Optional[str], "prevDayPx": str, "circulatingSupply": str, "coin": str})
+SpotAssetCtx = TypedDict(
+    "SpotAssetCtx",
+    {"dayNtlVlm": str, "markPx": str, "midPx": Optional[str], "prevDayPx": str, "circulatingSupply": str, "coin": str},
+)
 SpotMetaAndAssetCtxs = Tuple[SpotMeta, List[SpotAssetCtx]]
 
 AllMidsSubscription = TypedDict("AllMidsSubscription", {"type": Literal["allMids"]})

hyperliquid/utils/types.py

@@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "hyperliquid-python-sdk"
-version = "0.4.0"
+version = "0.5.0"
 description = "SDK for Hyperliquid API trading with Python."
 readme = "README.md"
 authors = ["Hyperliquid <hello@hyperliquid.xyz>"]