async-hyperliquid 0.4.1__tar.gz → 0.4.3__tar.gz

{async_hyperliquid-0.4.1 → async_hyperliquid-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: async-hyperliquid
-Version: 0.4.1
+Version: 0.4.3
 Summary: Async Hyperliquid client using aiohttp
 Keywords: dex,hyperliquid,async,aiohttp,trading,cryptocurrency,defi
 Author: Yuki

{async_hyperliquid-0.4.1 → async_hyperliquid-0.4.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "async-hyperliquid"
-version = "0.4.1"
+version = "0.4.3"
 description = "Async Hyperliquid client using aiohttp"
 authors = [{ name = "Yuki", email = "yuqi.lyle@gmail.com" }]
 readme = "README.md"
@@ -35,7 +35,7 @@ classifiers = [
 ]
 requires-python = ">=3.10,<4"
 dependencies = [
-    "aiohttp (>=3.11.12,<4.0.0)",
+    "aiohttp>=3.11.12,<4.0.0",
     "msgpack (>=1.1.0,<2.0.0)",
     "eth-account (>=0.13.5,<0.14.0)",
     "eth-utils (>=5.2.0,<6.0.0)",
@@ -57,6 +57,7 @@ dev = [
     "pre-commit>=4.1.0",
     "python-dotenv>=1.0.1",
     "hyperliquid-python-sdk>=0.19.0",
+    "ty>=0.0.22",
 ]
 
 [project.urls]

async_hyperliquid-0.4.3/src/async_hyperliquid/_async_hyperliquid/__init__.py

@@ -0,0 +1,3 @@
+from .actions import AsyncHyperliquidActionsClient
+
+__all__ = ["AsyncHyperliquidActionsClient"]

async_hyperliquid-0.4.3/src/async_hyperliquid/_async_hyperliquid/actions.py

@@ -0,0 +1,283 @@
+import math
+import re
+import warnings
+
+from async_hyperliquid.utils.constants import (
+    HYPE_FACTOR,
+    MAINNET_API_URL,
+    USD_FACTOR,
+)
+from async_hyperliquid.utils.decorators import private_key_required
+from async_hyperliquid.utils.miscs import get_timestamp_ms, round_token_amount
+from async_hyperliquid.utils.signing import (
+    sign_approve_agent_action,
+    sign_approve_builder_fee_action,
+    sign_convert_to_multi_sig_user_action,
+    sign_send_asset_action,
+    sign_spot_transfer_action,
+    sign_staking_deposit_action,
+    sign_staking_withdraw_action,
+    sign_token_delegate_action,
+    sign_usd_class_transfer_action,
+    sign_usd_transfer_action,
+    sign_user_dex_abstraction_action,
+    sign_user_set_abstraction_action,
+    sign_withdraw_action,
+)
+from async_hyperliquid.utils.types import AgentAbstraction, UserSetAbstraction
+
+from .orders import AsyncHyperliquidOrdersClient
+
+
+class AsyncHyperliquidActionsClient(AsyncHyperliquidOrdersClient):
+    async def set_referrer_code(self, code: str):
+        action = {"type": "setReferrer", "code": code}
+        return await self.exchange.post_action(action)
+
+    @private_key_required
+    async def create_sub_account(self, name: str):
+        action = {"type": "createSubAccount", "name": name}
+        return await self.exchange.post_action(action)
+
+    @private_key_required
+    async def usd_transfer(self, amount: float, dest: str):
+        nonce = get_timestamp_ms()
+        action = {
+            "type": "usdSend",
+            "amount": round_token_amount(amount, 2),
+            "destination": dest,
+            "time": nonce,
+        }
+        is_mainnet = self.base_url == MAINNET_API_URL
+        sig = sign_usd_transfer_action(self.account, action, is_mainnet)
+        return await self.exchange.post_action_with_sig(action, sig, nonce)
+
+    @private_key_required
+    async def spot_transfer(self, coin: str, amount: float, dest: str):
+        token_info = await self.get_token_info(coin)
+        token_name = token_info["name"]
+        token_id = token_info["tokenId"]
+        wei_decimals = token_info["weiDecimals"]
+        token = f"{token_name}:{token_id}"
+        nonce = get_timestamp_ms()
+        action = {
+            "type": "spotSend",
+            "destination": dest,
+            "token": token,
+            "amount": round_token_amount(amount, wei_decimals),
+            "time": nonce,
+        }
+        sig = sign_spot_transfer_action(self.account, action, self.is_mainnet)
+        return await self.exchange.post_action_with_sig(action, sig, nonce)
+
+    @private_key_required
+    async def initiate_withdrawal(self, amount: float):
+        nonce = get_timestamp_ms()
+        action = {
+            "type": "withdraw3",
+            "amount": round_token_amount(amount, 2),
+            "time": nonce,
+            "destination": self.address,
+        }
+        sig = sign_withdraw_action(self.account, action, self.is_mainnet)
+        return await self.exchange.post_action_with_sig(action, sig, nonce)
+
+    @private_key_required
+    async def usd_class_transfer(self, amount: float, to_perp: bool = False):
+        nonce = get_timestamp_ms()
+        action = {
+            "type": "usdClassTransfer",
+            "amount": round_token_amount(amount, 2),
+            "toPerp": to_perp,
+            "nonce": nonce,
+        }
+        sig = sign_usd_class_transfer_action(
+            self.account, action, self.base_url == MAINNET_API_URL
+        )
+        return await self.exchange.post_action_with_sig(action, sig, nonce)
+
+    @private_key_required
+    async def send_asset(
+        self,
+        coin: str,
+        amount: float,
+        dest: str,
+        source_dex: str,
+        dest_dex: str,
+        sub_account: str = "",
+    ):
+        token_info = await self.get_token_info(coin)
+        token_name = token_info["name"]
+        token_id = token_info["tokenId"]
+        wei_decimals = token_info["weiDecimals"]
+        token = f"{token_name}:{token_id}"
+        nonce = get_timestamp_ms()
+        action = {
+            "type": "sendAsset",
+            "token": token,
+            "amount": round_token_amount(amount, wei_decimals),
+            "destination": dest,
+            "sourceDex": source_dex,
+            "destinationDex": dest_dex,
+            "fromSubAccount": sub_account,
+            "nonce": nonce,
+        }
+        sig = sign_send_asset_action(self.account, action, self.is_mainnet)
+        return await self.exchange.post_action_with_sig(action, sig, nonce)
+
+    @private_key_required
+    async def staking_deposit(self, amount: float):
+        amount_in_wei = int(math.floor(amount * HYPE_FACTOR))
+        nonce = get_timestamp_ms()
+        action = {"type": "cDeposit", "wei": amount_in_wei, "nonce": nonce}
+        sig = sign_staking_deposit_action(self.account, action, self.is_mainnet)
+        return await self.exchange.post_action_with_sig(action, sig, nonce)
+
+    @private_key_required
+    async def staking_withdraw(self, amount: float):
+        amount_in_wei = int(math.floor(amount * HYPE_FACTOR))
+        nonce = get_timestamp_ms()
+        action = {"type": "cWithdraw", "wei": amount_in_wei, "nonce": nonce}
+        sig = sign_staking_withdraw_action(
+            self.account, action, self.is_mainnet
+        )
+        return await self.exchange.post_action_with_sig(action, sig, nonce)
+
+    @private_key_required
+    async def token_delegate(
+        self, validator: str, amount: float, is_undelegate: bool = False
+    ):
+        amount_in_wei = int(math.floor(amount * HYPE_FACTOR))
+        nonce = get_timestamp_ms()
+        action = {
+            "type": "tokenDelegate",
+            "validator": validator,
+            "wei": amount_in_wei,
+            "isUndelegate": is_undelegate,
+            "nonce": nonce,
+        }
+        sig = sign_token_delegate_action(self.account, action, self.is_mainnet)
+        return await self.exchange.post_action_with_sig(action, sig, nonce)
+
+    @private_key_required
+    async def vault_transfer(
+        self, vault: str, amount: float, is_deposit: bool = True
+    ):
+        usd_amount = int(math.floor(amount * USD_FACTOR))
+        action = {
+            "type": "vaultTransfer",
+            "vaultAddress": vault,
+            "isDeposit": is_deposit,
+            "usd": usd_amount,
+        }
+        return await self.exchange.post_action(action)
+
+    async def approve_agent(self, agent: str, name: str | None = None):
+        nonce = get_timestamp_ms()
+        action = {
+            "type": "approveAgent",
+            "agentAddress": agent,
+            "agentName": name or "",
+            "nonce": nonce,
+        }
+        sig = sign_approve_agent_action(self.account, action, self.is_mainnet)
+        if name is None:
+            del action["agentName"]
+
+        return await self.exchange.post_action_with_sig(action, sig, nonce)
+
+    async def approve_builder_fee(self, max_fee_rate: float, builder: str):
+        nonce = get_timestamp_ms()
+        action = {
+            "type": "approveBuilderFee",
+            "maxFeeRate": f"{max_fee_rate:.3%}",
+            "builder": builder,
+            "nonce": nonce,
+        }
+        sig = sign_approve_builder_fee_action(
+            self.account, action, self.is_mainnet
+        )
+        return await self.exchange.post_action_with_sig(action, sig, nonce)
+
+    async def convert_to_multi_sig_user(self, users: list[str], threshold: int):
+        nonce = get_timestamp_ms()
+        signers = {"authorizedUsers": sorted(users), "threshold": threshold}
+        action = {
+            "type": "convertToMultiSigUser",
+            "signers": signers,
+            "nonce": nonce,
+        }
+        sig = sign_convert_to_multi_sig_user_action(
+            self.account, action, self.is_mainnet
+        )
+        return await self.exchange.post_action_with_sig(action, sig, nonce)
+
+    async def reserve_request_weight(self, weight: int):
+        action = {"type": "reserveRequestWeight", "weight": weight}
+        return await self.exchange.post_action(action, expires=self.expires)
+
+    async def use_big_block(self, enable: bool):
+        action = {"type": "evmUserModify", "usingBigBlocks": enable}
+        return await self.exchange.post_action(action)
+
+    async def user_dex_abstraction(
+        self, user: str | None = None, enabled: bool = True
+    ):
+        warnings.warn(
+            "user_dex_abstraction is deprecated and may be removed in a "
+            "future release.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        nonce = get_timestamp_ms()
+        if user is None:
+            user = self.address
+        action = {
+            "type": "userDexAbstraction",
+            "user": user.lower(),
+            "enabled": enabled,
+            "nonce": nonce,
+        }
+        sig = sign_user_dex_abstraction_action(
+            self.account, action, self.is_mainnet
+        )
+        return await self.exchange.post_action_with_sig(action, sig, nonce)
+
+    async def user_set_abstraction(
+        self, abstraction: UserSetAbstraction, user: str | None = None
+    ):
+        nonce = get_timestamp_ms()
+        if user is None:
+            user = self.address
+        if re.fullmatch(r"0x[a-fA-F0-9]{40}", user) is None:
+            raise ValueError(
+                f"user must be a 42-char hex address, got: {user!r}"
+            )
+        action = {
+            "type": "userSetAbstraction",
+            "user": user.lower(),
+            "abstraction": abstraction,
+            "nonce": nonce,
+        }
+        sig = sign_user_set_abstraction_action(
+            self.account, action, self.is_mainnet
+        )
+        return await self.exchange.post_action_with_sig(action, sig, nonce)
+
+    async def agent_enable_dex_abstraction(self):
+        warnings.warn(
+            "agent_enable_dex_abstraction is deprecated and may be removed "
+            "in a future release.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        action = {"type": "agentEnableDexAbstraction"}
+        return await self.exchange.post_action(
+            action, vault=self.vault, expires=self.expires
+        )
+
+    async def agent_set_abstraction(self, abstraction: AgentAbstraction):
+        action = {"type": "agentSetAbstraction", "abstraction": abstraction}
+        return await self.exchange.post_action(
+            action, vault=self.vault, expires=self.expires
+        )

async_hyperliquid-0.4.3/src/async_hyperliquid/_async_hyperliquid/core.py

@@ -0,0 +1,239 @@
+import asyncio
+
+from aiohttp import ClientSession, ClientTimeout
+from eth_account import Account
+from eth_account.signers.local import LocalAccount
+from hl_web3.exchange import Exchange as EVMExchange
+from hl_web3.info import Info as EVMInfo
+from hl_web3.utils.constants import HL_RPC_URL, HL_TESTNET_RPC_URL
+
+from async_hyperliquid.async_api import AsyncAPI
+from async_hyperliquid.exchange import ExchangeAPI
+from async_hyperliquid.info import InfoAPI
+from async_hyperliquid.utils.constants import (
+    MAINNET_API_URL,
+    PERP_DEX_OFFSET,
+    SPOT_OFFSET,
+    TESTNET_API_URL,
+)
+from async_hyperliquid.utils.types import (
+    Metas,
+    PerpMeta,
+    SpotMeta,
+    SpotTokenMeta,
+)
+
+
+class AsyncHyperliquidCore(AsyncAPI):
+    address: str
+    is_mainnet: bool
+    account: LocalAccount
+    session: ClientSession
+    base_url: str
+    vault: str | None
+
+    coin_assets: dict[str, int]
+    coin_names: dict[str, str]
+    coin_symbols: dict[str, str]
+    asset_sz_decimals: dict[int, int]
+    spot_tokens: dict[str, SpotTokenMeta]
+
+    perp_dexs: list[str]
+
+    enable_evm: bool
+    evm_info: EVMInfo
+    evm_exchange: EVMExchange
+
+    def __init__(
+        self,
+        address: str,
+        api_key: str,
+        is_mainnet: bool = True,
+        enable_evm: bool = False,
+        evm_rpc_url: str | None = None,
+        private_key: str | None = None,
+        vault: str | None = None,
+        perp_dexs: list[str] = [""],
+    ):
+        self.address = address
+        self.is_mainnet = is_mainnet
+        self.account = Account.from_key(api_key)
+        self.session = ClientSession(timeout=ClientTimeout(connect=3))
+        self.base_url = MAINNET_API_URL if is_mainnet else TESTNET_API_URL
+        self.info = InfoAPI(self.base_url, self.session)
+        self.exchange = ExchangeAPI(
+            self.account, self.session, self.base_url, address=self.address
+        )
+
+        self.coin_assets = {}
+        self.coin_names = {}
+        self.coin_symbols = {}
+        self.asset_sz_decimals = {}
+        self.spot_tokens = {}
+
+        self.vault = vault
+        self.expires: int | None = None
+        self.perp_dexs = perp_dexs
+
+        if enable_evm:
+            self._init_evm_client(private_key, evm_rpc_url)
+
+    def set_expires(self, expires: int | None) -> None:
+        self.expires = expires
+
+    def _init_evm_client(
+        self, private_key: str | None, rpc_url: str | None = None
+    ) -> None:
+        if rpc_url is None:
+            rpc_url = HL_RPC_URL if self.is_mainnet else HL_TESTNET_RPC_URL
+
+        self.evm_info = EVMInfo(rpc_url)
+
+        if private_key is None:
+            if self.account.address != self.address:
+                raise ValueError(
+                    "EVM Exchange client can not init without private key"
+                )
+            private_key = self.account.key.hex()
+
+        self.evm_exchange = EVMExchange(rpc_url, private_key)
+
+    def _init_perp_meta(self, meta: PerpMeta, offset: int) -> None:
+        for asset, info in enumerate(meta["universe"]):
+            asset += offset
+            asset_name = info["name"]
+            self.coin_assets[asset_name] = asset
+            self.coin_names[asset_name] = asset_name
+            self.asset_sz_decimals[asset] = info["szDecimals"]
+
+    def _init_spot_meta(self, meta: SpotMeta) -> None:
+        total_tokens = len(meta["tokens"])
+        for info in meta["universe"]:
+            asset = info["index"] + SPOT_OFFSET
+            asset_name = info["name"]
+
+            self.coin_assets[asset_name] = asset
+            self.coin_names[asset_name] = asset_name
+
+            base, quote = info["tokens"]
+            if base >= total_tokens or quote >= total_tokens:
+                print("Unreconized token index for: ", info)
+                continue
+
+            base_info = meta["tokens"][base]
+            base_name = base_info["name"]
+            quote_name = meta["tokens"][quote]["name"]
+            name = f"{base_name}/{quote_name}"
+            if name not in self.coin_names:
+                self.coin_names[name] = asset_name
+
+            self.asset_sz_decimals[asset] = base_info["szDecimals"]
+            self.spot_tokens[asset_name] = meta["tokens"][base]
+
+    def _update_coin_symbols(self) -> None:
+        self.coin_symbols = {
+            v: k for k, v in self.coin_names.items() if not k.startswith("@")
+        }
+
+    async def init_metas(self) -> None:
+        meta_task = self.info.get_perp_meta()
+        spot_meta_task = self.info.get_spot_meta()
+        all_dex_names_task = self.get_all_dex_name()
+
+        meta, spot_meta, all_dex_names = await asyncio.gather(
+            meta_task, spot_meta_task, all_dex_names_task
+        )
+
+        self._init_perp_meta(meta, 0)
+        self._init_spot_meta(spot_meta)
+
+        dex_meta_tasks = []
+        dex_indices = []
+        for dex in self.perp_dexs:
+            if dex == "":
+                continue
+            try:
+                idx = all_dex_names.index(dex)
+            except ValueError:
+                continue
+
+            if idx > 0:
+                dex_meta_tasks.append(self.info.get_perp_meta(dex))
+                dex_indices.append(idx)
+
+        if dex_meta_tasks:
+            dex_metas = await asyncio.gather(*dex_meta_tasks)
+            for idx, dex_meta in zip(dex_indices, dex_metas):
+                dex_asset_offset = PERP_DEX_OFFSET + (idx - 1) * 10000
+                self._init_perp_meta(dex_meta, dex_asset_offset)
+
+        self._update_coin_symbols()
+
+    async def get_metas(self, perp_only: bool = False) -> Metas:
+        metas: Metas = {"perp": {}, "spot": [], "dexs": {}}  # type: ignore
+        perp_meta = await self.info.get_perp_meta()
+        if perp_only:
+            metas["perp"] = perp_meta
+            return metas
+
+        metas["spot"] = await self.info.get_spot_meta()
+        return metas
+
+    async def get_all_metas(self) -> Metas:
+        dexs = await self.get_all_dex_name()
+        dex_metas = {}
+
+        for dex in dexs[1:]:
+            meta = await self.info.get_perp_meta(dex)
+            dex_metas[dex] = meta
+
+        spot_meta = await self.info.get_spot_meta()
+        perp_meta = await self.info.get_perp_meta()
+        return {"perp": perp_meta, "spot": spot_meta, "dexs": dex_metas}
+
+    async def get_all_dex_name(self) -> list[str]:
+        names = []
+        dexs = await self.info.get_perp_dexs()
+        for dex in dexs:
+            if dex is None:
+                names.append("")
+            else:
+                names.append(dex["name"])
+        return names
+
+    async def get_coin_name(self, coin: str) -> str:
+        if not hasattr(self, "coin_names") or coin not in self.coin_names:
+            await self.init_metas()
+
+        if coin not in self.coin_names:
+            raise ValueError(f"Coin {coin} not found")
+
+        return self.coin_names[coin]
+
+    async def get_coin_asset(self, coin: str) -> int:
+        coin_name = await self.get_coin_name(coin)
+
+        if coin_name not in self.coin_assets:
+            raise ValueError(f"Coin {coin}({coin_name}) not found")
+
+        return self.coin_assets[coin_name]
+
+    async def get_coin_symbol(self, coin: str) -> str:
+        coin_name = await self.get_coin_name(coin)
+        return self.coin_symbols[coin_name]
+
+    async def get_coin_sz_decimals(self, coin: str) -> int:
+        coin_name = await self.get_coin_name(coin)
+        asset = await self.get_coin_asset(coin_name)
+        return self.asset_sz_decimals[asset]
+
+    async def get_token_info(self, coin: str) -> SpotTokenMeta:
+        coin_name = await self.get_coin_name(coin)
+        return self.spot_tokens[coin_name]
+
+    async def get_token_id(self, coin: str) -> str:
+        token_info = await self.get_token_info(coin)
+        if not token_info:
+            raise ValueError(f"Token {coin} not found")
+
+        return token_info["tokenId"]