Repository navigation
docs(sdk): fix executeSwapQuote step name and getSwapQuote route example - #274
devtechedge wants to merge 1 commit into
Conversation
|
@devtechedge is attempting to deploy a commit to the UMA Team on Vercel. A member of the Team first needs to authorize it. |
|
|
Hi - gentle check-in on this docs-only SDK fix whenever you get a chance. Two copy-paste errors were sending integrators down the wrong path: the This updates the README example to use It is an 8-line docs change with no runtime behavior shift, aimed at saving people from silent mismatches in progress callbacks. Happy to expand the examples or retarget if needed - no rush from my side. |
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