Skip to content

docs(hyperliquid): add 21 nktkas-verified HL method pages (9 info + 12 exchange)#465

Merged
akegaviar merged 1 commit into
mainfrom
docs/hl-nktkas-methods
Jun 24, 2026
Merged

docs(hyperliquid): add 21 nktkas-verified HL method pages (9 info + 12 exchange)#465
akegaviar merged 1 commit into
mainfrom
docs/hl-nktkas-methods

Conversation

@akegaviar

Copy link
Copy Markdown
Member

Adds reference pages for the 21 nktkas-only candidate methods from the coverage audit — methods present in the @nktkas/hyperliquid SDK and live on the API, but missing from our reference and from the official Hyperliquid docs / Python SDK. Each = page + OpenAPI spec + nav entry, same pattern as the other Hyperliquid pages.

Verification (against both endpoints)

Every method was tested against both the Chainstack endpoint and the public api.hyperliquid.xyz endpoint to set the Case A/B framing:

info (9):

Method Endpoint Verified
gossipPriorityAuctionStatus, subAccounts2 Chainstack-served (Case A) live data via curl + info.post + nktkas
isVip, legalCheck, preTransferCheck, twapHistory, userBorrowLendInterest, userTwapSliceFillsByTime, validatorSummaries public-only (Case B) — Chainstack node rejects them live data on the public API

Case A pages use the Chainstack endpoint in the curl + YOUR_CHAINSTACK_ENDPOINT + the endpoint <Note>; Case B pages use the public endpoint + the "available only on the public API" callout.

exchange (12, all public-only signing actions): borrowLend, createVault, vaultModify, vaultDistribute, subAccountModify, setDisplayName, registerReferrer, finalizeEvmContract, gossipPriorityBid, linkStakingUser, stakingLinkDisableTradingUser, userPortfolioMargin.
Chainstack does not serve /exchange, so all are Case B. Each action type was confirmed recognized by the public API (sent with a dummy signature → "Unable to recover signer", i.e. deserialized and reached signature verification — never executed). Python examples use the correct signing path per action: sign_l1_action (L1 actions), the native gossip_priority_bid helper, or sign_user_signed_action with the EIP-712 types (the 3 user-signed actions); TypeScript uses the native @nktkas/hyperliquid ExchangeClient methods.

Conventions / safety

  • Endpoints/keys follow the established pattern; Case A is the only place code differs from the curl (the YOUR_CHAINSTACK_ENDPOINT placeholder).
  • OpenAPI 3.0 (nullable: true, no type: null); all 21 specs validated; MDX CodeGroups balanced; every page wired into docs.json once.
  • No signing actions were executed (they move funds).

Follows #462 and #463.

Add reference pages for 21 methods that are present in the @nktkas/hyperliquid
SDK and live on the API, but were missing from our reference and from the
official docs / Python SDK (the second tier of the coverage audit). Each was
verified against BOTH the Chainstack and public endpoints to set the framing.

info (9):
- Chainstack-served (Case A): gossipPriorityAuctionStatus, subAccounts2
- public-only (Case B): isVip, legalCheck, preTransferCheck, twapHistory,
  userBorrowLendInterest, userTwapSliceFillsByTime, validatorSummaries

exchange (12, public-only signing actions): borrowLend, createVault,
vaultModify, vaultDistribute, subAccountModify, setDisplayName,
registerReferrer, finalizeEvmContract, gossipPriorityBid, linkStakingUser,
stakingLinkDisableTradingUser, userPortfolioMargin

Each page = mdx + OpenAPI spec + nav entry, same pattern as the other HL
pages. info examples run live (curl + info.post + nktkas InfoClient);
exchange examples are signature-checked against the SDKs (sign_l1_action,
sign_user_signed_action, or native helpers) and never executed.
@infra-bot-atlantis

Copy link
Copy Markdown
Error: This repo is not allowlisted for Atlantis.

@coderabbitai

coderabbitai Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Summary by CodeRabbit

  • New Features
    • Added API reference coverage for several new Hyperliquid info and exchange actions, including vault management, sub-accounts, borrow/lend, portfolio margin, referrer registration, display names, staking links, and auction status checks.
  • Documentation
    • Expanded endpoint pages with request/response details, authentication requirements, and example calls, making the API easier to explore and use.

Walkthrough

Nineteen new Hyperliquid Node API endpoints are documented across three artifact types: OpenAPI 3.0 JSON specification files, MDX reference pages (with cURL/Python/TypeScript examples), and navigation entries in docs.json. Nine are read-only POST /info operations; ten are EIP-712–authenticated POST /exchange operations.

Changes

Hyperliquid Node API endpoint documentation

Layer / File(s) Summary
Navigation registration
docs.json
Inserts 9 new reference/hyperliquid-info-* and 10 new reference/hyperliquid-exchange-* slugs into the Hyperliquid node API navigation tree.
Info endpoint OpenAPI specs
openapi/hyperliquid_node_api/hypercore_info/info_gossip_priority_auction_status.json, info_sub_accounts2.json, info_is_vip.json, info_legal_check.json, info_pre_transfer_check.json, info_twap_history.json, info_user_borrow_lend_interest.json, info_user_twap_slice_fills_by_time.json, info_validator_summaries.json
Adds nine OpenAPI 3.0 spec files defining POST /info operations with request schemas (type enum + optional user/startTime) and typed 200 response schemas (arrays or objects per operation).
Exchange endpoint OpenAPI specs
openapi/hyperliquid_node_api/hypercore_exchange/exchange_borrow_lend.json, exchange_create_vault.json, exchange_finalize_evm_contract.json, exchange_gossip_priority_bid.json, exchange_link_staking_user.json, exchange_register_referrer.json, exchange_set_display_name.json, exchange_staking_link_disable_trading_user.json, exchange_sub_account_modify.json, exchange_user_portfolio_margin.json, exchange_vault_distribute.json, exchange_vault_modify.json
Adds twelve OpenAPI 3.0 spec files defining authenticated POST /exchange operations, each requiring an action object, a millisecond nonce, and an EIP-712 signature (r, s, v), with operation-specific action field constraints.
Info endpoint MDX reference pages
reference/hyperliquid-info-gossip-priority-auction-status.mdx, reference/hyperliquid-info-sub-accounts2.mdx, reference/hyperliquid-info-is-vip.mdx, reference/hyperliquid-info-legal-check.mdx, reference/hyperliquid-info-pre-transfer-check.mdx, reference/hyperliquid-info-twap-history.mdx, reference/hyperliquid-info-user-borrow-lend-interest.mdx, reference/hyperliquid-info-user-twap-slice-fills-by-time.mdx, reference/hyperliquid-info-validator-summaries.mdx
Adds nine MDX pages documenting the new info operations, each covering parameters, response field definitions, availability constraints, cURL/Python/TypeScript examples, and use cases.
Exchange endpoint MDX reference pages
reference/hyperliquid-exchange-borrow-lend.mdx, reference/hyperliquid-exchange-create-vault.mdx, reference/hyperliquid-exchange-finalize-evm-contract.mdx, reference/hyperliquid-exchange-gossip-priority-bid.mdx, reference/hyperliquid-exchange-link-staking-user.mdx, reference/hyperliquid-exchange-register-referrer.mdx, reference/hyperliquid-exchange-set-display-name.mdx, reference/hyperliquid-exchange-staking-link-disable-trading-user.mdx, reference/hyperliquid-exchange-sub-account-modify.mdx, reference/hyperliquid-exchange-user-portfolio-margin.mdx, reference/hyperliquid-exchange-vault-distribute.mdx, reference/hyperliquid-exchange-vault-modify.mdx
Adds twelve MDX pages documenting the new authenticated exchange operations, each covering signed action parameters, EIP-712 authentication notes, availability constraints, cURL/Python/TypeScript examples, and use cases.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Poem

🐇 Hippity-hop, new endpoints abound,
EIP-712 signatures all around!
TWAP fills and vaults, a gossip bid too,
Legal checks, VIP — the docs list grew!
From borrow to lend, sub-accounts renamed,
This bunny is proud: the API's explained! 🌸

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and accurately summarizes the main change: adding 21 Hyperliquid method documentation pages.
Description check ✅ Passed The description matches the changeset and correctly describes the 21 new Hyperliquid reference pages and verification split.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/hl-nktkas-methods

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@mintlify

mintlify Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
chainstack 🔴 Failed Jun 24, 2026, 8:14 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@akegaviar
akegaviar merged commit 9a52c43 into main Jun 24, 2026
0 of 2 checks passed
@akegaviar
akegaviar deleted the docs/hl-nktkas-methods branch June 24, 2026 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant