Version 0.6.0

Author: traderben

examples/basic_adding.py

@@ -19,6 +19,7 @@
     TypedDict,
     Union,
     UserEventsMsg,
+    UserEventsSubscription,
 )
 import example_utils
 
@@ -56,9 +57,10 @@ class BasicAdder:
     def __init__(self, address: str, info: Info, exchange: Exchange):
         self.info = info
         self.exchange = exchange
-        subscription: L2BookSubscription = {"type": "l2Book", "coin": COIN}
-        self.info.subscribe(subscription, self.on_book_update)
-        self.info.subscribe({"type": "userEvents", "user": address}, self.on_user_events)
+        l2_book_subscription: L2BookSubscription = {"type": "l2Book", "coin": COIN}
+        self.info.subscribe(l2_book_subscription, self.on_book_update)
+        user_events_subscription: UserEventsSubscription = {"type": "userEvents", "user": address}
+        self.info.subscribe(user_events_subscription, self.on_user_events)
         self.position: Optional[float] = None
         self.provide_state: Dict[Side, ProvideState] = {
             "A": {"type": "cancelled"},

examples/basic_spot_order.py

@@ -6,6 +6,7 @@
 
 PURR = "PURR/USDC"
 OTHER_COIN = "@8"
+OTHER_COIN_NAME = "KORILA/USDC"
 
 
 def main():
@@ -44,7 +45,8 @@ def main():
     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"])
+            # The sdk now also support using spot names, although be careful as they might not always be unique
+            cancel_result = exchange.cancel(OTHER_COIN_NAME, status["resting"]["oid"])
             print(cancel_result)
 
 

examples/basic_ws.py

@@ -0,0 +1,21 @@
+from hyperliquid.utils import constants
+import example_utils
+
+
+def main():
+    address, info, _ = example_utils.setup(constants.TESTNET_API_URL)
+    # An example showing how to subscribe to the different subscription types and prints the returned messages
+    # Some subscriptions do not return snapshots, so you will not receive a message until something happens
+    info.subscribe({"type": "allMids"}, print)
+    info.subscribe({"type": "l2Book", "coin": "ETH"}, print)
+    info.subscribe({"type": "trades", "coin": "PURR/USDC"}, print)
+    info.subscribe({"type": "userEvents", "user": address}, print)
+    info.subscribe({"type": "userFills", "user": address}, print)
+    info.subscribe({"type": "candle", "coin": "ETH", "interval": "1m"}, print)
+    info.subscribe({"type": "orderUpdates", "user": address}, print)
+    info.subscribe({"type": "userFundings", "user": address}, print)
+    info.subscribe({"type": "userNonFundingLedgerUpdates", "user": address}, print)
+
+
+if __name__ == "__main__":
+    main()

hyperliquid/exchange.py

@@ -45,22 +45,7 @@ def __init__(
         self.wallet = wallet
         self.vault_address = vault_address
         self.account_address = account_address
-        self.info = Info(base_url, skip_ws=True)
-        if meta is None:
-            self.meta = self.info.meta()
-        else:
-            self.meta = meta
-
-        if spot_meta is None:
-            self.spot_meta = self.info.spot_meta()
-        else:
-            self.spot_meta = spot_meta
-
-        self.coin_to_asset = {asset_info["name"]: asset for (asset, asset_info) in enumerate(self.meta["universe"])}
-
-        # spot assets start at 10000
-        for spot_info in self.spot_meta["universe"]:
-            self.coin_to_asset[spot_info["name"]] = spot_info["index"] + 10000
+        self.info = Info(base_url, True, meta, spot_meta)
 
     def _post_action(self, action, signature, nonce):
         payload = {
@@ -74,17 +59,18 @@ def _post_action(self, action, signature, nonce):
 
     def _slippage_price(
         self,
-        coin: str,
+        name: str,
         is_buy: bool,
         slippage: float,
         px: Optional[float] = None,
     ) -> float:
+        coin = self.info.name_to_coin[name]
         if not px:
             # Get midprice
             px = float(self.info.all_mids()[coin])
 
         # spot assets start at 10000
-        is_spot = self.coin_to_asset[coin] >= 10_000
+        is_spot = self.info.coin_to_asset[coin] >= 10_000
 
         # Calculate Slippage
         px *= (1 + slippage) if is_buy else (1 - slippage)
@@ -93,7 +79,7 @@ def _slippage_price(
 
     def order(
         self,
-        coin: str,
+        name: str,
         is_buy: bool,
         sz: float,
         limit_px: float,
@@ -102,7 +88,7 @@ def order(
         cloid: Optional[Cloid] = None,
     ) -> Any:
         order: OrderRequest = {
-            "coin": coin,
+            "coin": name,
             "is_buy": is_buy,
             "sz": sz,
             "limit_px": limit_px,
@@ -115,7 +101,7 @@ def order(
 
     def bulk_orders(self, order_requests: List[OrderRequest]) -> Any:
         order_wires: List[OrderWire] = [
-            order_request_to_order_wire(order, self.coin_to_asset[order["coin"]]) for order in order_requests
+            order_request_to_order_wire(order, self.info.name_to_asset(order["coin"])) for order in order_requests
         ]
         timestamp = get_timestamp_ms()
 
@@ -138,7 +124,7 @@ def bulk_orders(self, order_requests: List[OrderRequest]) -> Any:
     def modify_order(
         self,
         oid: OidOrCloid,
-        coin: str,
+        name: str,
         is_buy: bool,
         sz: float,
         limit_px: float,
@@ -149,7 +135,7 @@ def modify_order(
         modify: ModifyRequest = {
             "oid": oid,
             "order": {
-                "coin": coin,
+                "coin": name,
                 "is_buy": is_buy,
                 "sz": sz,
                 "limit_px": limit_px,
@@ -165,7 +151,7 @@ def bulk_modify_orders_new(self, modify_requests: List[ModifyRequest]) -> Any:
         modify_wires = [
             {
                 "oid": modify["oid"].to_raw() if isinstance(modify["oid"], Cloid) else modify["oid"],
-                "order": order_request_to_order_wire(modify["order"], self.coin_to_asset[modify["order"]["coin"]]),
+                "order": order_request_to_order_wire(modify["order"], self.info.name_to_asset(modify["order"]["coin"])),
             }
             for modify in modify_requests
         ]
@@ -191,17 +177,17 @@ def bulk_modify_orders_new(self, modify_requests: List[ModifyRequest]) -> Any:
 
     def market_open(
         self,
-        coin: str,
+        name: str,
         is_buy: bool,
         sz: float,
         px: Optional[float] = None,
         slippage: float = DEFAULT_SLIPPAGE,
         cloid: Optional[Cloid] = None,
     ) -> Any:
         # Get aggressive Market Price
-        px = self._slippage_price(coin, is_buy, slippage, px)
+        px = self._slippage_price(name, is_buy, slippage, px)
         # Market Order is an aggressive Limit Order IoC
-        return self.order(coin, is_buy, sz, px, order_type={"limit": {"tif": "Ioc"}}, reduce_only=False, cloid=cloid)
+        return self.order(name, is_buy, sz, px, order_type={"limit": {"tif": "Ioc"}}, reduce_only=False, cloid=cloid)
 
     def market_close(
         self,
@@ -230,19 +216,19 @@ def market_close(
             # Market Order is an aggressive Limit Order IoC
             return self.order(coin, is_buy, sz, px, order_type={"limit": {"tif": "Ioc"}}, reduce_only=True, cloid=cloid)
 
-    def cancel(self, coin: str, oid: int) -> Any:
-        return self.bulk_cancel([{"coin": coin, "oid": oid}])
+    def cancel(self, name: str, oid: int) -> Any:
+        return self.bulk_cancel([{"coin": name, "oid": oid}])
 
-    def cancel_by_cloid(self, coin: str, cloid: Cloid) -> Any:
-        return self.bulk_cancel_by_cloid([{"coin": coin, "cloid": cloid}])
+    def cancel_by_cloid(self, name: str, cloid: Cloid) -> Any:
+        return self.bulk_cancel_by_cloid([{"coin": name, "cloid": cloid}])
 
     def bulk_cancel(self, cancel_requests: List[CancelRequest]) -> Any:
         timestamp = get_timestamp_ms()
         cancel_action = {
             "type": "cancel",
             "cancels": [
                 {
-                    "a": self.coin_to_asset[cancel["coin"]],
+                    "a": self.info.name_to_asset(cancel["coin"]),
                     "o": cancel["oid"],
                 }
                 for cancel in cancel_requests
@@ -269,7 +255,7 @@ def bulk_cancel_by_cloid(self, cancel_requests: List[CancelByCloidRequest]) -> A
             "type": "cancelByCloid",
             "cancels": [
                 {
-                    "asset": self.coin_to_asset[cancel["coin"]],
+                    "asset": self.info.name_to_asset(cancel["coin"]),
                     "cloid": cancel["cloid"].to_raw(),
                 }
                 for cancel in cancel_requests
@@ -316,12 +302,11 @@ def schedule_cancel(self, time: Optional[int]) -> Any:
             timestamp,
         )
 
-    def update_leverage(self, leverage: int, coin: str, is_cross: bool = True) -> Any:
+    def update_leverage(self, leverage: int, name: str, is_cross: bool = True) -> Any:
         timestamp = get_timestamp_ms()
-        asset = self.coin_to_asset[coin]
         update_leverage_action = {
             "type": "updateLeverage",
-            "asset": asset,
+            "asset": self.info.name_to_asset(name),
             "isCross": is_cross,
             "leverage": leverage,
         }
@@ -338,13 +323,12 @@ def update_leverage(self, leverage: int, coin: str, is_cross: bool = True) -> An
             timestamp,
         )
 
-    def update_isolated_margin(self, amount: float, coin: str) -> Any:
+    def update_isolated_margin(self, amount: float, name: str) -> Any:
         timestamp = get_timestamp_ms()
-        asset = self.coin_to_asset[coin]
         amount = float_to_usd_int(amount)
         update_isolated_margin_action = {
             "type": "updateIsolatedMargin",
-            "asset": asset,
+            "asset": self.info.name_to_asset(name),
             "isBuy": True,
             "ntli": amount,
         }

hyperliquid/info.py

@@ -14,11 +14,34 @@
 
 
 class Info(API):
-    def __init__(self, base_url=None, skip_ws=False):
+    def __init__(
+        self,
+        base_url: Optional[str] = None,
+        skip_ws: Optional[bool] = False,
+        meta: Optional[Meta] = None,
+        spot_meta: Optional[SpotMeta] = None,
+    ):
         super().__init__(base_url)
         if not skip_ws:
             self.ws_manager = WebsocketManager(self.base_url)
             self.ws_manager.start()
+        if meta is None:
+            meta = self.meta()
+
+        if spot_meta is None:
+            spot_meta = self.spot_meta()
+
+        self.coin_to_asset = {asset_info["name"]: asset for (asset, asset_info) in enumerate(meta["universe"])}
+        self.name_to_coin = {asset_info["name"]: asset_info["name"] for asset_info in meta["universe"]}
+
+        # spot assets start at 10000
+        for spot_info in spot_meta["universe"]:
+            self.coin_to_asset[spot_info["name"]] = spot_info["index"] + 10000
+            self.name_to_coin[spot_info["name"]] = spot_info["name"]
+            base, quote = spot_info["tokens"]
+            name = f'{spot_meta["tokens"][base]["name"]}/{spot_meta["tokens"][quote]["name"]}'
+            if name not in self.name_to_coin:
+                self.name_to_coin[name] = spot_info["name"]
 
     def user_state(self, address: str) -> Any:
         """Retrieve trading details about a user.
@@ -290,13 +313,13 @@ def spot_meta_and_asset_ctxs(self) -> SpotMetaAndAssetCtxs:
         """
         return cast(SpotMetaAndAssetCtxs, self.post("/info", {"type": "spotMetaAndAssetCtxs"}))
 
-    def funding_history(self, coin: str, startTime: int, endTime: Optional[int] = None) -> Any:
+    def funding_history(self, name: str, startTime: int, endTime: Optional[int] = None) -> Any:
         """Retrieve funding history for a given coin
 
         POST /info
 
         Args:
-            coin (str): Coin to retrieve funding history for.
+            name (str): Coin to retrieve funding history for.
             startTime (int): Unix timestamp in milliseconds.
             endTime (int): Unix timestamp in milliseconds.
 
@@ -311,6 +334,7 @@ def funding_history(self, coin: str, startTime: int, endTime: Optional[int] = No
                 ...
             ]
         """
+        coin = self.name_to_coin[name]
         if endTime is not None:
             return self.post(
                 "/info", {"type": "fundingHistory", "coin": coin, "startTime": startTime, "endTime": endTime}
@@ -335,13 +359,13 @@ def user_funding_history(self, user: str, startTime: int, endTime: Optional[int]
             return self.post("/info", {"type": "userFunding", "user": user, "startTime": startTime, "endTime": endTime})
         return self.post("/info", {"type": "userFunding", "user": user, "startTime": startTime})
 
-    def l2_snapshot(self, coin: str) -> Any:
+    def l2_snapshot(self, name: str) -> Any:
         """Retrieve L2 snapshot for a given coin
 
         POST /info
 
         Args:
-            coin (str): Coin to retrieve L2 snapshot for.
+            name (str): Coin to retrieve L2 snapshot for.
 
         Returns:
             {
@@ -360,15 +384,15 @@ def l2_snapshot(self, coin: str) -> Any:
                 time: int
             }
         """
-        return self.post("/info", {"type": "l2Book", "coin": coin})
+        return self.post("/info", {"type": "l2Book", "coin": self.name_to_coin[name]})
 
-    def candles_snapshot(self, coin: str, interval: str, startTime: int, endTime: int) -> Any:
+    def candles_snapshot(self, name: str, interval: str, startTime: int, endTime: int) -> Any:
         """Retrieve candles snapshot for a given coin
 
         POST /info
 
         Args:
-            coin (str): Coin to retrieve candles snapshot for.
+            name (str): Coin to retrieve candles snapshot for.
             interval (str): Candlestick interval.
             startTime (int): Unix timestamp in milliseconds.
             endTime (int): Unix timestamp in milliseconds.
@@ -390,7 +414,7 @@ def candles_snapshot(self, coin: str, interval: str, startTime: int, endTime: in
                 ...
             ]
         """
-        req = {"coin": coin, "interval": interval, "startTime": startTime, "endTime": endTime}
+        req = {"coin": self.name_to_coin[name], "interval": interval, "startTime": startTime, "endTime": endTime}
         return self.post("/info", {"type": "candleSnapshot", "req": req})
 
     def user_fees(self, address: str) -> Any:
@@ -449,13 +473,20 @@ def query_sub_accounts(self, user: str) -> Any:
         return self.post("/info", {"type": "subAccounts", "user": user})
 
     def subscribe(self, subscription: Subscription, callback: Callable[[Any], None]) -> int:
+        if subscription["type"] == "l2Book" or subscription["type"] == "trades" or subscription["type"] == "candle":
+            subscription["coin"] = self.name_to_coin[subscription["coin"]]
         if self.ws_manager is None:
             raise RuntimeError("Cannot call subscribe since skip_ws was used")
         else:
             return self.ws_manager.subscribe(subscription, callback)
 
     def unsubscribe(self, subscription: Subscription, subscription_id: int) -> bool:
+        if subscription["type"] == "l2Book" or subscription["type"] == "trades" or subscription["type"] == "candle":
+            subscription["coin"] = self.name_to_coin[subscription["coin"]]
         if self.ws_manager is None:
             raise RuntimeError("Cannot call unsubscribe since skip_ws was used")
         else:
             return self.ws_manager.unsubscribe(subscription, subscription_id)
+
+    def name_to_asset(self, name: str) -> int:
+        return self.coin_to_asset[self.name_to_coin[name]]