Skip to content

docs(sdk): fix executeSwapQuote step name and getSwapQuote route example - #274

Open
devtechedge wants to merge 1 commit into
across-protocol:masterfrom
devtechedge:docs/fix-swap-quote-examples
Open

docs(sdk): fix executeSwapQuote step name and getSwapQuote route example#274
devtechedge wants to merge 1 commit into
across-protocol:masterfrom
devtechedge:docs/fix-swap-quote-examples

Conversation

@devtechedge

Copy link
Copy Markdown

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. executeSwapQuote README used the wrong progress step

In packages/sdk/README.md, the onProgress example checked for progress.step === "deposit". That step exists on the non-swap executeQuote path, but SwapTransactionProgress only defines "approve", "swap", and "fill".

This PR updates the example to use "swap" (and adjusts the nearby comment so it matches).

2. getSwapQuote JSDoc example omitted the route object

In packages/sdk/src/client.ts, the executeSwapQuote JSDoc example called getSwapQuote with originChainId, destinationChainId, inputToken, and outputToken at the top level. GetSwapQuoteParams requires those fields under a route object.

This PR nests those fields under route so 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

  • Confirm README executeSwapQuote example uses step === "swap"
  • Confirm client.ts JSDoc getSwapQuote example nests chain/token fields under route
  • Spot-check against SwapTransactionProgress and GetSwapQuoteParams types

Fixes #267

@vercel

vercel Bot commented Sep 9, 2026

Copy link
Copy Markdown

@devtechedge is attempting to deploy a commit to the UMA Team on Vercel.

A member of the Team first needs to authorize it.

@changeset-bot

changeset-bot Bot commented Sep 9, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: f5366eb

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: executeSwapQuote README uses step="deposit" (should be "swap"); getSwapQuote example missing route object

1 participant