Version 0.12.0

Author: traderben

examples/evm_erc20.py

@@ -278,7 +278,7 @@ class FinalizeEvmContractAction(TypedDict):
         },
     }
     nonce = get_timestamp_ms()
-    signature = sign_l1_action(account, action, None, nonce, False)
+    signature = sign_l1_action(account, action, None, nonce, None, False)
     payload = {
         "action": action,
         "nonce": nonce,
@@ -299,7 +299,7 @@ class FinalizeEvmContractAction(TypedDict):
     else:
         finalize_action = {"type": "finalizeEvmContract", "token": TOKEN, "input": "firstStorageSlot"}
     nonce = get_timestamp_ms()
-    signature = sign_l1_action(account, finalize_action, None, nonce, False)
+    signature = sign_l1_action(account, finalize_action, None, nonce, None, False)
     payload = {
         "action": finalize_action,
         "nonce": nonce,

examples/multi_sig_order.py

@@ -38,6 +38,7 @@ def main():
             timestamp,
             multi_sig_user,
             address,
+            exchange.expires_after,
         )
         signatures.append(signature)
 

examples/multi_sig_register_token.py

@@ -41,6 +41,7 @@ def main():
             timestamp,
             multi_sig_user,
             address,
+            exchange.expires_after,
         )
         signatures.append(signature)
 

examples/spot_deploy.py

@@ -11,6 +11,9 @@
 # Set to True to enable freeze functionality for the deployed token
 # See step 2-a below for more details on freezing.
 ENABLE_FREEZE_PRIVILEGE = False
+# Set to True to set the deployer trading fee share
+# See step 6 below for more details on setting the deployer trading fee share.
+SET_DEPLOYER_TRADING_FEE_SHARE = False
 DUMMY_USER = "0x0000000000000000000000000000000000000001"
 
 
@@ -101,6 +104,14 @@ def main():
     register_hyperliquidity_result = exchange.spot_deploy_register_hyperliquidity(spot, 2.0, 4.0, 100, None)
     print(register_hyperliquidity_result)
 
+    if SET_DEPLOYER_TRADING_FEE_SHARE:
+        # Step 6
+        #
+        # Note that the deployer trading fee share cannot increase.
+        # The default is already 100% and the smallest increment is 0.001%.
+        set_deployer_trading_fee_share_result = exchange.spot_deploy_set_deployer_trading_fee_share(token, "100%")
+        print(set_deployer_trading_fee_share_result)
+
 
 if __name__ == "__main__":
     main()

hyperliquid/exchange.py

@@ -52,13 +52,15 @@ def __init__(
         self.vault_address = vault_address
         self.account_address = account_address
         self.info = Info(base_url, True, meta, spot_meta)
+        self.expires_after: Optional[int] = None
 
     def _post_action(self, action, signature, nonce):
         payload = {
             "action": action,
             "nonce": nonce,
             "signature": signature,
             "vaultAddress": self.vault_address if action["type"] != "usdClassTransfer" else None,
+            "expiresAfter": self.expires_after,
         }
         logging.debug(payload)
         return self.post("/exchange", payload)
@@ -84,6 +86,12 @@ def _slippage_price(
         # We round px to 5 significant figures and 6 decimals for perps, 8 decimals for spot
         return round(float(f"{px:.5g}"), (6 if not is_spot else 8) - self.info.asset_to_sz_decimals[asset])
 
+    # expires_after will cause actions to be rejected after that timestamp in milliseconds
+    # expires_after is not supported on user_signed actions (e.g. usd_transfer) and must be None in order for those
+    # actions to work.
+    def set_expires_after(self, expires_after: Optional[int]) -> None:
+        self.expires_after = expires_after
+
     def order(
         self,
         name: str,
@@ -122,6 +130,7 @@ def bulk_orders(self, order_requests: List[OrderRequest], builder: Optional[Buil
             order_action,
             self.vault_address,
             timestamp,
+            self.expires_after,
             self.base_url == MAINNET_API_URL,
         )
 
@@ -176,6 +185,7 @@ def bulk_modify_orders_new(self, modify_requests: List[ModifyRequest]) -> Any:
             modify_action,
             self.vault_address,
             timestamp,
+            self.expires_after,
             self.base_url == MAINNET_API_URL,
         )
 
@@ -262,6 +272,7 @@ def bulk_cancel(self, cancel_requests: List[CancelRequest]) -> Any:
             cancel_action,
             self.vault_address,
             timestamp,
+            self.expires_after,
             self.base_url == MAINNET_API_URL,
         )
 
@@ -289,6 +300,7 @@ def bulk_cancel_by_cloid(self, cancel_requests: List[CancelByCloidRequest]) -> A
             cancel_action,
             self.vault_address,
             timestamp,
+            self.expires_after,
             self.base_url == MAINNET_API_URL,
         )
 
@@ -317,6 +329,7 @@ def schedule_cancel(self, time: Optional[int]) -> Any:
             schedule_cancel_action,
             self.vault_address,
             timestamp,
+            self.expires_after,
             self.base_url == MAINNET_API_URL,
         )
         return self._post_action(
@@ -338,6 +351,7 @@ def update_leverage(self, leverage: int, name: str, is_cross: bool = True) -> An
             update_leverage_action,
             self.vault_address,
             timestamp,
+            self.expires_after,
             self.base_url == MAINNET_API_URL,
         )
         return self._post_action(
@@ -360,6 +374,7 @@ def update_isolated_margin(self, amount: float, name: str) -> Any:
             update_isolated_margin_action,
             self.vault_address,
             timestamp,
+            self.expires_after,
             self.base_url == MAINNET_API_URL,
         )
         return self._post_action(
@@ -379,6 +394,7 @@ def set_referrer(self, code: str) -> Any:
             set_referrer_action,
             None,
             timestamp,
+            self.expires_after,
             self.base_url == MAINNET_API_URL,
         )
         return self._post_action(
@@ -398,6 +414,7 @@ def create_sub_account(self, name: str) -> Any:
             create_sub_account_action,
             None,
             timestamp,
+            self.expires_after,
             self.base_url == MAINNET_API_URL,
         )
         return self._post_action(
@@ -438,6 +455,7 @@ def sub_account_transfer(self, sub_account_user: str, is_deposit: bool, usd: int
             sub_account_transfer_action,
             None,
             timestamp,
+            self.expires_after,
             self.base_url == MAINNET_API_URL,
         )
         return self._post_action(
@@ -460,6 +478,7 @@ def sub_account_spot_transfer(self, sub_account_user: str, is_deposit: bool, tok
             sub_account_transfer_action,
             None,
             timestamp,
+            self.expires_after,
             self.base_url == MAINNET_API_URL,
         )
         return self._post_action(
@@ -477,7 +496,7 @@ def vault_usd_transfer(self, vault_address: str, is_deposit: bool, usd: int) ->
             "usd": usd,
         }
         is_mainnet = self.base_url == MAINNET_API_URL
-        signature = sign_l1_action(self.wallet, vault_transfer_action, None, timestamp, is_mainnet)
+        signature = sign_l1_action(self.wallet, vault_transfer_action, None, timestamp, self.expires_after, is_mainnet)
         return self._post_action(
             vault_transfer_action,
             signature,
@@ -590,6 +609,7 @@ def spot_deploy_register_token(
             action,
             None,
             timestamp,
+            self.expires_after,
             self.base_url == MAINNET_API_URL,
         )
         return self._post_action(
@@ -615,6 +635,7 @@ def spot_deploy_user_genesis(
             action,
             None,
             timestamp,
+            self.expires_after,
             self.base_url == MAINNET_API_URL,
         )
         return self._post_action(
@@ -636,6 +657,7 @@ def spot_deploy_enable_freeze_privilege(self, token: int) -> Any:
             action,
             None,
             timestamp,
+            self.expires_after,
             self.base_url == MAINNET_API_URL,
         )
         return self._post_action(
@@ -659,6 +681,7 @@ def spot_deploy_freeze_user(self, token: int, user: str, freeze: bool) -> Any:
             action,
             None,
             timestamp,
+            self.expires_after,
             self.base_url == MAINNET_API_URL,
         )
         return self._post_action(
@@ -680,6 +703,7 @@ def spot_deploy_revoke_freeze_privilege(self, token: int) -> Any:
             action,
             None,
             timestamp,
+            self.expires_after,
             self.base_url == MAINNET_API_URL,
         )
         return self._post_action(
@@ -705,6 +729,7 @@ def spot_deploy_genesis(self, token: int, max_supply: str, no_hyperliquidity: bo
             action,
             None,
             timestamp,
+            self.expires_after,
             self.base_url == MAINNET_API_URL,
         )
         return self._post_action(
@@ -726,6 +751,7 @@ def spot_deploy_register_spot(self, base_token: int, quote_token: int) -> Any:
             action,
             None,
             timestamp,
+            self.expires_after,
             self.base_url == MAINNET_API_URL,
         )
         return self._post_action(
@@ -755,6 +781,30 @@ def spot_deploy_register_hyperliquidity(
             action,
             None,
             timestamp,
+            self.expires_after,
+            self.base_url == MAINNET_API_URL,
+        )
+        return self._post_action(
+            action,
+            signature,
+            timestamp,
+        )
+
+    def spot_deploy_set_deployer_trading_fee_share(self, token: int, share: str) -> Any:
+        timestamp = get_timestamp_ms()
+        action = {
+            "type": "spotDeploy",
+            "setDeployerTradingFeeShare": {
+                "token": token,
+                "share": share,
+            },
+        }
+        signature = sign_l1_action(
+            self.wallet,
+            action,
+            None,
+            timestamp,
+            self.expires_after,
             self.base_url == MAINNET_API_URL,
         )
         return self._post_action(
@@ -782,6 +832,7 @@ def multi_sig(self, multi_sig_user, inner_action, signatures, nonce, vault_addre
             is_mainnet,
             vault_address,
             nonce,
+            self.expires_after,
         )
         return self._post_action(
             multi_sig_action,
@@ -800,6 +851,7 @@ def use_big_blocks(self, enable: bool) -> Any:
             action,
             None,
             timestamp,
+            self.expires_after,
             self.base_url == MAINNET_API_URL,
         )
         return self._post_action(

hyperliquid/utils/signing.py

@@ -134,23 +134,26 @@ def address_to_bytes(address):
     return bytes.fromhex(address[2:] if address.startswith("0x") else address)
 
 
-def action_hash(action, vault_address, nonce):
+def action_hash(action, vault_address, nonce, expires_after):
     data = msgpack.packb(action)
     data += nonce.to_bytes(8, "big")
     if vault_address is None:
         data += b"\x00"
     else:
         data += b"\x01"
         data += address_to_bytes(vault_address)
+    if expires_after is not None:
+        data += b"\x00"
+        data += expires_after.to_bytes(8, "big")
     return keccak(data)
 
 
 def construct_phantom_agent(hash, is_mainnet):
     return {"source": "a" if is_mainnet else "b", "connectionId": hash}
 
 
-def sign_l1_action(wallet, action, active_pool, nonce, is_mainnet):
-    hash = action_hash(action, active_pool, nonce)
+def sign_l1_action(wallet, action, active_pool, nonce, expires_after, is_mainnet):
+    hash = action_hash(action, active_pool, nonce, expires_after)
     phantom_agent = construct_phantom_agent(hash, is_mainnet)
     data = {
         "domain": {
@@ -248,22 +251,23 @@ def sign_multi_sig_user_signed_action_payload(
 
 
 def sign_multi_sig_l1_action_payload(
-    wallet, action, is_mainnet, vault_address, timestamp, payload_multi_sig_user, outer_signer
+    wallet, action, is_mainnet, vault_address, timestamp, expires_after, payload_multi_sig_user, outer_signer
 ):
     envelope = [payload_multi_sig_user.lower(), outer_signer.lower(), action]
     return sign_l1_action(
         wallet,
         envelope,
         vault_address,
         timestamp,
+        expires_after,
         is_mainnet,
     )
 
 
-def sign_multi_sig_action(wallet, action, is_mainnet, vault_address, nonce):
+def sign_multi_sig_action(wallet, action, is_mainnet, vault_address, nonce, expires_after):
     action_without_tag = action.copy()
     del action_without_tag["type"]
-    multi_sig_action_hash = action_hash(action_without_tag, vault_address, nonce)
+    multi_sig_action_hash = action_hash(action_without_tag, vault_address, nonce, expires_after)
     envelope = {
         "multiSigActionHash": multi_sig_action_hash,
         "nonce": nonce,

pyproject.toml

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

tests/info_test.py

@@ -1,7 +1,7 @@
 import pytest
 
 from hyperliquid.info import Info
-from hyperliquid.utils.types import Meta, SpotMeta
+from hyperliquid.utils.types import L2BookData, Meta, SpotMeta
 
 TEST_META: Meta = {"universe": []}
 TEST_SPOT_META: SpotMeta = {"universe": [], "tokens": []}
@@ -83,7 +83,7 @@ def test_get_funding_history(endTime):
 @pytest.mark.vcr()
 def test_get_l2_snapshot():
     info = Info(skip_ws=True, spot_meta=TEST_SPOT_META)
-    response = info.l2_snapshot(name="DYDX")
+    response: L2BookData = info.l2_snapshot(name="DYDX")
     assert len(response) != 0
     assert len(response["levels"]) == 2
     assert response["coin"] == "DYDX"