Skip to content

Commit 0835976

Browse files
committed
docs: document HIP-3 dex parameter on Info query methods
Add the missing `dex` parameter to the Args docstrings of user_state, open_orders, frontend_open_orders, all_mids, and meta -- the five Info methods that already accept and forward a `dex` argument for HIP-3 builder-deployed perpetuals. Improves discoverability of HIP-3 support. Fixes #286.
1 parent 2fdb18f commit 0835976

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

hyperliquid/info.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,8 @@ def user_state(self, address: str, dex: str = "") -> Any:
9191
Args:
9292
address (str): Onchain address in 42-character hexadecimal format;
9393
e.g. 0x0000000000000000000000000000000000000000.
94+
dex (str): Dex name for HIP-3 builder-deployed perpetuals.
95+
Defaults to "" (the original dex).
9496
Returns:
9597
{
9698
assetPositions: [
@@ -138,6 +140,8 @@ def open_orders(self, address: str, dex: str = "") -> Any:
138140
Args:
139141
address (str): Onchain address in 42-character hexadecimal format;
140142
e.g. 0x0000000000000000000000000000000000000000.
143+
dex (str): Dex name for HIP-3 builder-deployed perpetuals.
144+
Defaults to "" (the original dex).
141145
Returns: [
142146
{
143147
coin: str,
@@ -159,6 +163,8 @@ def frontend_open_orders(self, address: str, dex: str = "") -> Any:
159163
Args:
160164
address (str): Onchain address in 42-character hexadecimal format;
161165
e.g. 0x0000000000000000000000000000000000000000.
166+
dex (str): Dex name for HIP-3 builder-deployed perpetuals.
167+
Defaults to "" (the original dex).
162168
Returns: [
163169
{
164170
children:
@@ -189,6 +195,10 @@ def all_mids(self, dex: str = "") -> Any:
189195
190196
POST /info
191197
198+
Args:
199+
dex (str): Dex name for HIP-3 builder-deployed perpetuals.
200+
Defaults to "" (the original dex).
201+
192202
Returns:
193203
{
194204
ATOM: float string,
@@ -275,6 +285,10 @@ def meta(self, dex: str = "") -> Meta:
275285
276286
POST /info
277287
288+
Args:
289+
dex (str): Dex name for HIP-3 builder-deployed perpetuals.
290+
Defaults to "" (the original dex).
291+
278292
Returns:
279293
{
280294
universe: [

0 commit comments

Comments
 (0)