docs: [swap] add JupiterZ standalone API and port RFQ docs - #946
Open
0xYankee wants to merge 10 commits into
Open
docs: [swap] add JupiterZ standalone API and port RFQ docs#9460xYankee wants to merge 10 commits into
0xYankee wants to merge 10 commits into
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…Metis) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…uting slugs Split the loaded V1 webhook page (16 topics, 177 lines) into a landing plus Webhook API, Quoting and fills, and Settlement and special cases. V2 streaming stays one page. Move the swap/routing/ sub-tree to version-scoped slugs so URLs never need changing again: amm/* for Metis AMM integration, rfq/v1/* and rfq/v2/* for JupiterZ MM integration. Add redirects for the four pre-existing/preview URLs and repoint the three old /routing/* redirects directly to the final URLs to avoid chains. Update all internal cross-links and the moved #order-engine anchor. Refinement of BUILD-812 (same PR #946). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The V1 sub-pages sat flat next to the V2 page, so it was unclear they belonged to V1. Nest the four V1 pages under a "Webhook (V1)" group and the V2 page under "Streaming (V2)", and set both landing pages' sidebarTitle to "Overview" so they don't repeat the group name. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
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.
Summary
Ports the JupiterZ/RFQ documentation from the retired
jup-ag/rfq-docsDocusaurus site (jupiterz.jup.ag) into this repo, which is now the only maintained home for JupiterZ docs. Documents the new standalone JupiterZ API athttps://api.jup.ag/swap/v2/jupiterz(GET /order,GET /global-order,POST /execute) with an OpenAPI spec and API reference pages, and streamlines the market-maker integration docs (docs own process/architecture/operations; code mechanics defer to the publicrfq-webhook-toolkitandrfq-v2-sdkrepos, same split as the Metis AMM integration page).Changes
swap/jupiterz/index.mdxdocs page (auth, lifecycle quickstart in kit + web3.js, indicative quotes, global order, execute states with safe re-polling, errors) +openapi-spec/swap/v2/jupiterz.yaml+ 3api-reference/swap/jupiterz/*pages.swap/routing/rfq/v1/:overview(landing: what it is, V1-vs-V2, integration process, onboarding),webhook-api(endpoints, response codes, timeouts, token advertising, IDs),quoting(fulfillment, expiry, fees, payload),settlement(Order Engine, Squads takers, circuit breaker, testing, FAQ). Full V1 content ported and condensed; the "for latest info see jupiterz.jup.ag" note is gone; Telegram contacts replaced with the support form + Discord.swap/routing/rfq/v2/streaming.mdx"Streaming Integration (V2)": the gRPC streaming model (protocol rules, encoding, last look and maker safety, lifecycle/circuit breaker), mechanics deferred torfq-v2-sdk. Kept as one page.swap/routing/amm/*(Metis AMM integration,integration+market-listing, retitled DEX → AMM) andswap/routing/rfq/v{1,2}/*(JupiterZ MM integration). Chosen so future versions/pages slot in without URL changes. Old slugs (dex-integration,market-listing,rfq-integration,rfq-streaming) redirect to the new URLs; the three old/routing/*redirects were repointed directly to the final URLs to avoid chains.swap/index.mdx(standalone access path + endpoint table) andswap/order-and-execute.mdx;.claude/rules/updated (style guide: JupiterZ + AMM naming, no lite-api rule; product-learning: new JupiterZ section; decisions: IA entry);llms.txtregenerated.Source-verification notes (reviewer)
api.jup.ag/swap/v2/jupiterz:GET /orderreturns a full quote withprovider;GET /global-order(paramoutputMint, singular, comma-separated) returns the best-USD leg and 400s past the 3-mint cap; keyless → 401.feeBpswas removed from the spec (platform-fee concept, not integrator-set);integratorTokenAccountmust be pre-initialised (documented). Publishing/announcement still coordinated with the RFQ team./global-order(singular); the candidate mint cap is 3 in prod (MAX_OUTPUT_MINTS=3, rfq PR Add Trenches and mark Ape as deprecated #612), not 5; quote expiry documented as 55s TTL + 25s fill buffer (both old "35/20" and "20/35" splits were stale);0x11(frozen account) added to error codes.stats/overview.mdis a "docs being rewritten" placeholder andrfq_stats.mddocuments a localhost:8080 RFQ indexer API orphaned from every sidebar. Fresh docs are needed if a public stats API ships.rfq-webhook-toolkit/rfq-v2-sdkREADMEs at developers.jup.ag.Linear Issues
Checklist
node generate-llms-from-docs.jsrunmint broken-linkspassesnode check-redirects.jspasses (no conflicts/chains)title,description,llmsDescriptiondocs.jsonnavigation updateddeveloper-platformrepo (companion PR).claude/rules/updated with learnings and decisions🤖 Generated with Claude Code