Various small updates

Fix type errors in basic_adding
Updates to multi-sig examples
Updates to License
Fixes to Readme and dev dependencies

Author: traderben

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 Hyperliquid Corp.
+Copyright (c) 2024 Hyperliquid Labs Pte. Ltd.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -46,10 +46,12 @@ python examples/basic_order.py
 
 ## Getting started with contributing to this repo
 
-1. Download `Poetry`: https://python-poetry.org/. Note that in the install script you might have to set `symlinks=True` in `venv.EnvBuilder`.
+1. Download `Poetry`: https://python-poetry.org/. 
+   - Note that in the install script you might have to set `symlinks=True` in `venv.EnvBuilder`.
+   - Note that Poetry v2 is not supported, so you'll need to specify a specific version e.g. curl -sSL https://install.python-poetry.org | POETRY_VERSION=1.4.1 python3 - 
 
 2. Point poetry to correct version of python. For development we require python 3.10 exactly. Some dependencies have issues on 3.11, while older versions don't have correct typing support.
-`brew install [email protected] && poetry env use /opt/homebrew/Cellar/[email protected]/3.10.10_1/bin/python3.10`
+`brew install [email protected] && poetry env use /opt/homebrew/Cellar/[email protected]/3.10.16/bin/python3.10`
 
 3. Install dependencies:
 
@@ -210,16 +212,13 @@ This project is licensed under the terms of the `MIT` license. See [LICENSE](LIC
 @misc{hyperliquid-python-sdk,
   author = {Hyperliquid},
   title = {SDK for Hyperliquid API trading with Python.},
-  year = {2023},
+  year = {2024},
   publisher = {GitHub},
   journal = {GitHub repository},
   howpublished = {\url{https://github.com/hyperliquid-dex/hyperliquid-python-sdk}}
 }
 ```
 
-## Terms
-
-By using this package you agree to the Terms of Use. See [TERMS](TERMS.md) for more details.
 ## Credits
 
 This project was generated with [`python-package-template`](https://github.com/TezRomacH/python-package-template).

TERMS.md

@@ -13,6 +13,7 @@
 from hyperliquid.utils.types import (
     SIDES,
     Dict,
+    L2BookData,
     L2BookMsg,
     L2BookSubscription,
     Literal,
@@ -113,7 +114,7 @@ def on_book_update(self, book_msg: L2BookMsg) -> None:
         for side in SIDES:
             self.handle_order_placement(side, book_data)
 
-    def handle_order_placement(self, side: Side, book_data: Dict) -> None:
+    def handle_order_placement(self, side: Side, book_data: L2BookData) -> None:
         """Handle the placement and cancellation of orders based on the order book update."""
         book_price = float(book_data["levels"][side_to_uint(side)][0]["px"])
         ideal_distance = book_price * DEPTH
@@ -185,19 +186,19 @@ def poll(self) -> None:
             # Fetch open orders
             open_orders = self.info.open_orders(self.exchange.wallet.address)
             print("open_orders", open_orders)
-    
+
             # Collect valid order IDs (from recently cancelled orders and resting orders)
             ok_oids = set(self.recently_cancelled_oid_to_time.keys())
             for provide_state in self.provide_state.values():
                 if provide_state["type"] == "resting":
                     ok_oids.add(provide_state["oid"])
-    
+
             # Cancel any unknown orders
             for open_order in open_orders:
                 if open_order["coin"] == COIN and open_order["oid"] not in ok_oids:
                     print("Cancelling unknown oid", open_order["oid"])
                     self.exchange.cancel(open_order["coin"], open_order["oid"])
-    
+
             # Clean up recently cancelled orders after a timeout
             current_time = get_timestamp_ms()
             self.recently_cancelled_oid_to_time = {
@@ -224,5 +225,6 @@ def main():
     address, info, exchange = example_utils.setup(constants.TESTNET_API_URL)
     BasicAdder(address, info, exchange)
 
+
 if __name__ == "__main__":
     main()

examples/basic_adding.py

@@ -0,0 +1,50 @@
+from hyperliquid.utils import constants
+from hyperliquid.utils.signing import get_timestamp_ms, sign_multi_sig_l1_action_payload
+import example_utils
+
+
+def main():
+    address, info, exchange = example_utils.setup(constants.TESTNET_API_URL, skip_ws=True)
+    multi_sig_wallets = example_utils.setup_multi_sig_wallets()
+
+    # The outer signer is required to be an authorized user or an agent of the authorized user of the multi-sig user.
+
+    # Address of the multi-sig user that the action will be executed for
+    # Executing the action requires at least the specified threshold of signatures
+    # required for that multi-sig user
+    multi_sig_user = "0x0000000000000000000000000000000000000005"
+
+    timestamp = get_timestamp_ms()
+
+    # Define the multi-sig inner action
+    action = {
+        "type": "order",
+        "orders": [{"a": 4, "b": True, "p": "1100", "s": "0.2", "r": False, "t": {"limit": {"tif": "Gtc"}}}],
+        "grouping": "na",
+    }
+
+    timestamp = get_timestamp_ms()
+    signatures = []
+
+    # Collect signatures from each wallet in multi_sig_wallets. Each wallet must belong to a user.
+    for wallet in multi_sig_wallets:
+        # Sign the action with each wallet
+        signature = sign_multi_sig_l1_action_payload(
+            wallet,
+            action,
+            exchange.base_url == constants.MAINNET_API_URL,
+            None,
+            timestamp,
+            multi_sig_user,
+            address,
+        )
+        signatures.append(signature)
+
+    # Execute the multi-sig action with all collected signatures
+    # This will only succeed if enough valid signatures are provided
+    multi_sig_result = exchange.multi_sig(multi_sig_user, action, signatures, timestamp)
+    print(multi_sig_result)
+
+
+if __name__ == "__main__":
+    main()

examples/multi_sig_order.py

@@ -0,0 +1,53 @@
+from hyperliquid.utils import constants
+from hyperliquid.utils.signing import get_timestamp_ms, sign_multi_sig_l1_action_payload
+import example_utils
+
+
+def main():
+    address, info, exchange = example_utils.setup(constants.TESTNET_API_URL, skip_ws=True)
+    multi_sig_wallets = example_utils.setup_multi_sig_wallets()
+
+    # The outer signer is required to be an authorized user or an agent of the authorized user of the multi-sig user.
+
+    # Address of the multi-sig user that the action will be executed for
+    # Executing the action requires at least the specified threshold of signatures
+    # required for that multi-sig user
+    multi_sig_user = "0x0000000000000000000000000000000000000005"
+
+    timestamp = get_timestamp_ms()
+
+    # Define the multi-sig inner action
+    action = {
+        "type": "spotDeploy",
+        "registerToken2": {
+            "spec": {"name": "TESTH", "szDecimals": 2, "weiDecimals": 8},
+            "maxGas": 1000000000000,
+            "fullName": "Example multi-sig spot deploy",
+        },
+    }
+
+    timestamp = get_timestamp_ms()
+    signatures = []
+
+    # Collect signatures from each wallet in multi_sig_wallets. Each wallet must belong to a user.
+    for wallet in multi_sig_wallets:
+        # Sign the action with each wallet
+        signature = sign_multi_sig_l1_action_payload(
+            wallet,
+            action,
+            exchange.base_url == constants.MAINNET_API_URL,
+            None,
+            timestamp,
+            multi_sig_user,
+            address,
+        )
+        signatures.append(signature)
+
+    # Execute the multi-sig action with all collected signatures
+    # This will only succeed if enough valid signatures are provided
+    multi_sig_result = exchange.multi_sig(multi_sig_user, action, signatures, timestamp)
+    print(multi_sig_result)
+
+
+if __name__ == "__main__":
+    main()

examples/multi_sig_register_token.py

@@ -1,6 +1,5 @@
 from hyperliquid.utils import constants
-from hyperliquid.utils.signing import get_timestamp_ms, sign_multi_sig_inner, USD_SEND_SIGN_TYPES
-from hyperliquid.utils.types import Any, List
+from hyperliquid.utils.signing import get_timestamp_ms, sign_multi_sig_user_signed_action_payload, USD_SEND_SIGN_TYPES
 import example_utils
 
 
@@ -26,12 +25,12 @@ def main():
         "amount": "100.0",
         "time": timestamp,
     }
-    signatures: List[Any] = []
+    signatures = []
 
     # Collect signatures from each wallet in multi_sig_wallets. Each wallet must belong to a user.
     for wallet in multi_sig_wallets:
         # Sign the action with each wallet
-        signature = sign_multi_sig_inner(
+        signature = sign_multi_sig_user_signed_action_payload(
             wallet,
             action,
             exchange.base_url == constants.MAINNET_API_URL,

examples/basic_multi_sig.py examples/multi_sig_usd_send.pyexamples/basic_multi_sig.py renamed to examples/multi_sig_usd_send.py

@@ -233,7 +233,9 @@ def add_multi_sig_fields(action, payload_multi_sig_user, outer_signer):
     return action
 
 
-def sign_multi_sig_inner(wallet, action, is_mainnet, sign_types, tx_type, payload_multi_sig_user, outer_signer):
+def sign_multi_sig_user_signed_action_payload(
+    wallet, action, is_mainnet, sign_types, tx_type, payload_multi_sig_user, outer_signer
+):
     envelope = add_multi_sig_fields(action, payload_multi_sig_user, outer_signer)
     sign_types = add_multi_sig_types(sign_types)
     return sign_user_signed_action(
@@ -245,6 +247,19 @@ def sign_multi_sig_inner(wallet, action, is_mainnet, sign_types, tx_type, payloa
     )
 
 
+def sign_multi_sig_l1_action_payload(
+    wallet, action, is_mainnet, vault_address, timestamp, 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,
+        is_mainnet,
+    )
+
+
 def sign_multi_sig_action(wallet, action, is_mainnet, vault_address, nonce):
     action_without_tag = action.copy()
     del action_without_tag["type"]

examples/multi_sig_wallets.json.example

@@ -98,7 +98,11 @@
     "OtherWsMsg",
     {
         "channel": Union[
-            Literal["candle"], Literal["orderUpdates"], Literal["userFundings"], Literal["userNonFundingLedgerUpdates"], Literal["webData2"]
+            Literal["candle"],
+            Literal["orderUpdates"],
+            Literal["userFundings"],
+            Literal["userNonFundingLedgerUpdates"],
+            Literal["webData2"],
         ],
         "data": Any,
     },