Version 0.1.7

Author: traderben

.gitignore

@@ -618,4 +618,4 @@ MigrationBackup/
 testing.py
 
 # End of https://www.gitignore.io/api/osx,python,pycharm,windows,visualstudio,visualstudiocode
-examples/config.json
+examples/config.json

README.md

@@ -8,8 +8,8 @@
 [![Security: bandit](https://img.shields.io/badge/security-bandit-green.svg)](https://github.com/PyCQA/bandit)
 [![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/hyperliquid-dex/hyperliquid-python-sdk/blob/master/.pre-commit-config.yaml)
 [![Semantic Versions](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--versions-e10079.svg)](https://github.com/hyperliquid-dex/hyperliquid-python-sdk/releases)
-[![License](https://img.shields.io/pypi/l/hyperliquid-python-sdk)](LICENSE.md)
-![Coverage Report](assets/images/coverage.svg)
+[![License](https://img.shields.io/pypi/l/hyperliquid-python-sdk)](https://github.com/hyperliquid-dex/hyperliquid-python-sdk/blob/master/LICENSE.md)
+![Coverage Report](https://github.com/hyperliquid-dex/hyperliquid-python-sdk/blob/master/assets/images/coverage.svg)
 
 SDK for Hyperliquid API trading with Python.
 

api/components.yaml

@@ -0,0 +1,12 @@
+components:
+  schemas:
+    FloatString:
+      type: string
+      pattern: "^\\d+\\.?\\d*$"
+    Address:
+      type: string
+      pattern: "^0x[a-fA-F0-9]{40}$"
+    AssetPosition:
+      type: object
+    MarginSummary:
+      type: object

api/info/allmids.yaml

@@ -0,0 +1,44 @@
+openapi: 3.0.1
+info:
+  title: Hyperliquid
+  description: API for interacting with the Hyperliquid DEX
+  version: '0.1'
+servers:
+  - url: https://api.hyperliquid.xyz
+    description: Mainnet
+  - url: https://api.hyperliquid-testnet.xyz
+    description: Testnet
+  - url: http://localhost:3001
+    description: Local
+paths:
+  /info:
+    post:
+      summary: Retrieve all mids for all actively traded coins
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                type:
+                  type: string
+                  enum: [allMids]
+              required:
+                - type
+            example:
+              type: allMids
+      responses:
+        '200':
+          description: A successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                additionalProperties:
+                  $ref: "../components.yaml#/components/schemas/FloatString"
+              example:
+                APE: "4.36255"
+                ARB: "1.22965"
+                ATOM: "11.2585"
+                AVAX: "18.3695"

api/info/userstate.yaml

@@ -0,0 +1,79 @@
+openapi: 3.0.1
+info:
+  title: Hyperliquid
+  description: API for interacting with the Hyperliquid DEX
+  version: '0.1'
+servers:
+  - url: https://api.hyperliquid.xyz
+    description: Mainnet
+  - url: https://api.hyperliquid-testnet.xyz
+    description: Testnet
+  - url: http://localhost:3001
+    description: Local
+paths:
+  /info:
+    post:
+      summary: Retrieve a user's state
+      description: See a user's open positions and margin summary
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                type:
+                  type: string
+                  enum: [clearinghouseState]
+                user:
+                  $ref: "../components.yaml#/components/schemas/Address"
+              required:
+                - type
+                - user
+            example:
+                type: "clearinghouseState"
+                user: "0x0000000000000000000000000000000000000000"
+      responses:
+        '200':
+          description: A successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  assetPositions:
+                    type: array
+                    items:
+                      $ref: "../components.yaml#/components/schemas/AssetPosition"
+                  marginSummary:
+                    $ref: "../components.yaml#/components/schemas/MarginSummary"
+                  crossMarginSummary:
+                    $ref: "../components.yaml#/components/schemas/MarginSummary"
+              example:
+                assetPositions:
+                  - position:
+                      coin: "BTC"
+                      entryPx: null
+                      leverage:
+                        type: "cross"
+                        value: 20
+                      liquidationPx: "NaN"
+                      marginUsed: "0.0"
+                      maxTradeSzs: ["0.0", "0.0"]
+                      positionValue: "0.0"
+                      returnOnEquity: "0.0"
+                      szi: "0.0"
+                      unrealizedPnl: "0.0"
+                    type: "oneWay"
+                marginSummary:
+                  accountValue: "0.0"
+                  totalMarginUsed: "0.0"
+                  totalNtlPos: "0.0"
+                  totalRawUsd: "0.0"
+                  withdrawable: "0.0"
+                crossMarginSummary:
+                  accountValue: "0.0"
+                  totalMarginUsed: "0.0"
+                  totalNtlPos: "0.0"
+                  totalRawUsd: "0.0"
+                  withdrawable: "0.0"

examples/basic_vault.py

@@ -0,0 +1,46 @@
+from eth_account.signers.local import LocalAccount
+import eth_account
+import json
+import utils
+
+from hyperliquid.info import Info
+from hyperliquid.exchange import Exchange
+from hyperliquid.utils import constants
+
+
+def main():
+    config = utils.get_config()
+    account: LocalAccount = eth_account.Account.from_key(config["secret_key"])
+    # Change this address to a vault that you lead
+    vault = "0x1719884eb866cb12b2287399b15f7db5e7d775ea"
+    print("Running with account address:", account.address)
+    info = Info(constants.TESTNET_API_URL, skip_ws=True)
+
+    # Get the user state and print out position information
+    user_state = info.user_state(account.address)
+    positions = []
+    for position in user_state["assetPositions"]:
+        if float(position["position"]["szi"]) != 0:
+            positions.append(position["position"])
+    if len(positions) > 0:
+        print("positions:")
+        for position in positions:
+            print(json.dumps(position, indent=2))
+    else:
+        print("no open positions")
+
+    # Place an order that should rest by setting the price very low
+    exchange = Exchange(account, constants.TESTNET_API_URL, vault_address=vault)
+    order_result = exchange.order("ETH", True, 0.2, 100, {"limit": {"tif": "Gtc"}})
+    print(order_result)
+
+    # Cancel the order
+    if order_result["status"] == "ok":
+        status = order_result["response"]["data"]["statuses"][0]
+        if "resting" in status:
+            cancel_result = exchange.cancel("ETH", status["resting"]["oid"])
+            print(cancel_result)
+
+
+if __name__ == "__main__":
+    main()

hyperliquid/exchange.py

@@ -18,9 +18,16 @@
 
 
 class Exchange(API):
-    def __init__(self, wallet: LocalAccount, base_url: Optional[str] = None, meta: Optional[Meta] = None):
+    def __init__(
+        self,
+        wallet: LocalAccount,
+        base_url: Optional[str] = None,
+        meta: Optional[Meta] = None,
+        vault_address: Optional[str] = None,
+    ):
         super().__init__(base_url)
         self.wallet = wallet
+        self.vault_address = vault_address
         if meta is None:
             info = Info(base_url, skip_ws=True)
             self.meta = info.meta()
@@ -48,39 +55,32 @@ def order(
             self.wallet,
             ["(uint32,bool,uint64,uint64,bool,uint8,uint64)[]", "uint8"],
             [[order_spec_preprocessing(order_spec)], order_grouping_to_number(grouping)],
-            ZERO_ADDRESS,
+            ZERO_ADDRESS if self.vault_address is None else self.vault_address,
             timestamp,
         )
-        logging.debug(
-            {
-                "action": {
-                    "type": "order",
-                    "grouping": grouping,
-                    "orders": [order_spec_to_order_wire(order_spec)],
-                },
-                "nonce": timestamp,
-                "signature": signature,
-                "vaultAddress": None,
-            }
-        )
-        return self.post(
-            "/exchange",
-            {
-                "action": {
-                    "type": "order",
-                    "grouping": grouping,
-                    "orders": [order_spec_to_order_wire(order_spec)],
-                },
-                "nonce": timestamp,
-                "signature": signature,
-                "vaultAddress": None,
+        payload = {
+            "action": {
+                "type": "order",
+                "grouping": grouping,
+                "orders": [order_spec_to_order_wire(order_spec)],
             },
-        )
+            "nonce": timestamp,
+            "signature": signature,
+            "vaultAddress": self.vault_address,
+        }
+        logging.debug(payload)
+        return self.post("/exchange", payload)
 
     def cancel(self, coin: str, oid: int) -> Any:
         timestamp = get_timestamp_ms()
         asset = self.coin_to_asset[coin]
-        signature = sign_l1_action(self.wallet, ["(uint32,uint64)[]"], [[(asset, oid)]], ZERO_ADDRESS, timestamp)
+        signature = sign_l1_action(
+            self.wallet,
+            ["(uint32,uint64)[]"],
+            [[(asset, oid)]],
+            ZERO_ADDRESS if self.vault_address is None else self.vault_address,
+            timestamp,
+        )
         return self.post(
             "/exchange",
             {
@@ -95,6 +95,6 @@ def cancel(self, coin: str, oid: int) -> Any:
                 },
                 "nonce": timestamp,
                 "signature": signature,
-                "vaultAddress": None,
+                "vaultAddress": self.vault_address,
             },
         )

pyproject.toml

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

tests/signing_test.py

@@ -44,6 +44,16 @@ def test_l1_action_signing_matches():
     assert signature["v"] == 27
 
 
+def test_l1_action_signing_matches_with_vault():
+    wallet = eth_account.Account.from_key("0x0123456789012345678901234567890123456789012345678901234567890123")
+    signature = sign_l1_action(
+        wallet, ["uint64"], [float_to_int_for_hashing(1000)], "0x1719884eb866cb12b2287399b15f7db5e7d775ea", 0
+    )
+    assert signature["r"] == "0x9358ee731732877d9a6d1a761fb6db43f93cb7c69ca74ecb382bd0773ac9b093"
+    assert signature["s"] == "0x2879b3d8384b80664346c4286c34f947fc970c3a84c2f3995555f68493adf60b"
+    assert signature["v"] == 27
+
+
 def test_float_to_int_for_hashing():
     assert float_to_int_for_hashing(123123123123) == 12312312312300000000
     assert float_to_int_for_hashing(0.00001231) == 1231