docs(sdk): fix executeSwapQuote step name and getSwapQuote route example - #274
Open
devtechedge wants to merge 1 commit into
Open
docs(sdk): fix executeSwapQuote step name and getSwapQuote route example#274devtechedge wants to merge 1 commit into
devtechedge wants to merge 1 commit into
Conversation
devtechedge
requested review from
amateima,
ashwinrava,
dohaki,
gsteenkamp89,
melisaguevara,
mrice32 and
nicholaspai
as code owners
September 9, 2026 21:33
|
@devtechedge is attempting to deploy a commit to the UMA Team on Vercel. A member of the Team first needs to authorize it. |
|
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
Fixes two copy-paste errors in the SDK docs that lead integrators to write code that does not type-check or never matches progress callbacks.
1.
executeSwapQuoteREADME used the wrong progress stepIn
packages/sdk/README.md, theonProgressexample checked forprogress.step === "deposit". That step exists on the non-swapexecuteQuotepath, butSwapTransactionProgressonly defines"approve","swap", and"fill".This PR updates the example to use
"swap"(and adjusts the nearby comment so it matches).2.
getSwapQuoteJSDoc example omitted therouteobjectIn
packages/sdk/src/client.ts, theexecuteSwapQuoteJSDoc example calledgetSwapQuotewithoriginChainId,destinationChainId,inputToken, andoutputTokenat the top level.GetSwapQuoteParamsrequires those fields under arouteobject.This PR nests those fields under
routeso the documented call matches the real API.Generated Typedoc output (if present) can be refreshed on the next docs build from the updated JSDoc.
Test plan
executeSwapQuoteexample usesstep === "swap"client.tsJSDocgetSwapQuoteexample nests chain/token fields underrouteSwapTransactionProgressandGetSwapQuoteParamstypesFixes #267