docs(hyperliquid): add 4 missing HL method pages (approvedBuilders, perpConciseAnnotations, settledOutcome, userOutcome)#463
Conversation
Create reference pages (page + OpenAPI spec + nav) for methods present in the official Hyperliquid docs and the @nktkas/hyperliquid SDK but missing from our reference. Examples verified live against the public endpoint. info (Chainstack-served, Case A): - approvedBuilders — builders a user has approved (user param) - perpConciseAnnotations — per-asset category/displayName/keywords - settledOutcome — outcome-market spec + settlement (outcome param) exchange (signing action, public-only): - userOutcome — split/merge/negate outcome-market shares (4 operations) info examples: hyperliquid-python-sdk (info.post) + @nktkas/hyperliquid, both run live and return the documented data. userOutcome: signature-checked against the SDKs (never executed — it moves funds).
|
|
Warning Review limit reached
More reviews will be available in 51 minutes and 10 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (9)
✨ 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. |
1 participant
Adds reference pages for 4 methods that exist in the official Hyperliquid docs and the
@nktkas/hyperliquidSDK but were missing from our reference (found in the coverage audit). Each = page + OpenAPI spec + nav entry, examples verified live.New pages
info — Chainstack-served (Case A: code uses
YOUR_CHAINSTACK_ENDPOINT+ endpoint note)approvedBuildersuser["0x1cc34f…cda1f"]via curl, Python (info.post), and nktkasperpConciseAnnotations[["flx:BTC",{"category":"crypto"}], …]via all threesettledOutcomeoutcome{spec, settleFraction, details}via all threeexchange — public-only signing action (Case B)
userOutcomesplitOutcome/mergeOutcome/mergeQuestion/negateOutcomeExchangeClient.userOutcomepresent); not executed — it moves fundsConventions followed
YOUR_CHAINSTACK_ENDPOINT+ the standard endpoint<Note>). Python usesinfo.post("/info", …)since the SDK has no dedicated helpers; TS uses the native nktkasInfoClientmethods.userOutcomemodels the exchange pattern (HL-public-only<Info>+ signing<Note>; Python viasign_l1_action+_post_actionsince the Python SDK has no helper; TS viaExchangeClient.userOutcome).nullable: true, notype: null); all JSON validated; nav entries added once each.Companion to #462 (the 4 flagged-page fixes).