docs: Smart Recipes section [render preview] - #85
Open
jayeshbhole wants to merge 3 commits into
Open
Conversation
Eight pages under Onramp: introduction, quickstart, deposits, vault discovery, bridge and swap, quotes, tracking status, errors. Sidebar group added next to Smart Routing Address.
Landing-style intro, How It Works, Integration Guide, API Reference. Simplified Technical English throughout, short sentences, no em dashes.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
The pages documented a pre-#33/#34 surface: bridgeAndSwap as a live recipe, swapMinOutput and the requiresSrcSwap/requiresDestSwap route flags, and a QuoteExpiredError requote path the server never emits (expiresAt is stamped and never checked). withdrawFromVault was missing entirely. Fold deposits, quotes, vault-discovery and tracking-status into recipes.mdx; api-reference and errors into reference.mdx. Drop integration-guide, which restated the other pages, and bridge-and-swap, whose method always rejects. Fix the error table: VAULT_CAP_EXCEEDED is 400 not 409, ASSET_MISMATCH 500 not 400, plus five missing codes including SLIPPAGE_TOO_LOW.
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
2 participants
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.
Adds a Smart Recipes section under the Onramp pillar, next to Smart Routing Address.
Pages: introduction, quickstart, recipes, how it works, reference.
Written against the SDK on
master(types verified in the smart-recipes repo), which matters because the first draft of this branch documented a surface that no longer exists:bridgeAndSwaprejects unconditionally withFEATURE_DISABLED; it was documented as a live recipe on its own page.swapMinOutputand therequiresSrcSwap/requiresDestSwaproute flags are gone fromQuote.withdrawFromVaultexists and was documented nowhere.QUOTE_EXPIREDis never emitted;expiresAtis stamped and never checked, so the "catchQuoteExpiredErrorand re-quote" advice was wrong. Expiry is now described as advisory.VAULT_CAP_EXCEEDEDis 400 not 409,ASSET_MISMATCH500 not 400) and was missing five live codes, includingSLIPPAGE_TOO_LOWand itsdetails.minSlippageBpsretry value.Also consolidated: the integration guide restated the other pages nearly verbatim, and params were duplicated between the guides and the API reference. Net 793 deletions, 11 pages to 5.
Code examples now omit
serverUrl, which defaults to the hosted server, so there is no placeholder left to fill in.Preview: /onramp/smart-recipes