docs: document the dex HIP-3 parameter in Info docstrings (closes #286) - #320
Open
massimiliano1991 wants to merge 1 commit into
Open
docs: document the dex HIP-3 parameter in Info docstrings (closes #286)#320massimiliano1991 wants to merge 1 commit into
dex HIP-3 parameter in Info docstrings (closes #286)#320massimiliano1991 wants to merge 1 commit into
Conversation
user_state, open_orders, frontend_open_orders, all_mids and meta all accept `dex: str = ""` and forward it to the API, but the Args section never mentions it, so HIP-3 support is only discoverable by reading the source. Add the parameter to each docstring; all_mids and meta had no Args section, so one is introduced with just `dex`. Docstring only, no behaviour change. Closes hyperliquid-dex#286.
This was referenced Sep 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #286.
Info.user_state,open_orders,frontend_open_orders,all_midsandmetaall acceptdex: str = ""and forward it to the API, but none of them mention it in the docstringArgs, so HIP-3 (builder-deployed perp) support is only discoverable by reading the source. As @keitaj noted in #286, a common mistake is callinginfo.open_orders(addr)and wondering why HIP-3 orders are missing.This adds
dexto theArgsof each of the five methods.all_midsandmetahad noArgssection, so a minimal one is introduced with justdex.Scope: docstring only, no behaviour change — the parameter already existed and was already forwarded.
python -m py_compile hyperliquid/info.pypasses; the diff is 12 added lines across the five methods.