docs(hyperliquid): add 21 nktkas-verified HL method pages (9 info + 12 exchange)#465
Conversation
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.
|
|
Caution Review failedPull request was closed or merged during review 📝 WalkthroughSummary by CodeRabbit
WalkthroughNineteen 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 ChangesHyperliquid Node API endpoint documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Adds reference pages for the 21 nktkas-only candidate methods from the coverage audit — methods present in the
@nktkas/hyperliquidSDK 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.xyzendpoint to set the Case A/B framing:info (9):
gossipPriorityAuctionStatus,subAccounts2info.post+ nktkasisVip,legalCheck,preTransferCheck,twapHistory,userBorrowLendInterest,userTwapSliceFillsByTime,validatorSummariesCase 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 nativegossip_priority_bidhelper, orsign_user_signed_actionwith the EIP-712 types (the 3 user-signed actions); TypeScript uses the native@nktkas/hyperliquidExchangeClientmethods.Conventions / safety
YOUR_CHAINSTACK_ENDPOINTplaceholder).nullable: true, notype: null); all 21 specs validated; MDX CodeGroups balanced; every page wired intodocs.jsononce.Follows #462 and #463.