docs: add SwapDK swidge community module#205
Open
Vali0x wants to merge 2 commits into
Open
Conversation
Adds documentation for @swapdk/wdk-protocol-swidge-swapdk under
content/docs/sdk/swidge-modules/swidge-swapdk/ following the same
structure as swidge-rhinofi/ and swidge-orchestra/ (index /
configuration / usage / api-reference).
Also adds one row to content/docs/sdk/community-modules/index.mdx
pointing at the swidge-swapdk docs. Type = "Swidge Module", author =
SwapDK.
Content highlights:
- Multi-family source coverage: the swidge module ships a single
class covering Bitcoin, EVM (Ethereum / Arbitrum / Base / BSC /
Avalanche), Cosmos (THORChain / MAYAChain), Solana, and TRON as
sources — larger scope than the existing rhinofi (EVM-only) and
orchestra (BTC + stablecoins via Spark) community swidge modules.
- Server-side provider selection across THORChain / MAYAChain /
Chainflip; live halt-filtered discovery via /chains and
/tokens?shape=swidge.
- Legacy compatibility for free — because the base SwidgeProtocol
class delegates bridge/quoteBridge/swap/quoteSwap to
swidge/quoteSwidge, consumers still on the older IBridgeProtocol /
ISwapProtocol API get compatibility without code changes.
- Peer pin: @tetherto/wdk-wallet=1.0.0-beta.11 exact (matches the
rhinofi module's pin; upstream beta.12+ regressed the
SwidgeProtocol re-export from /protocols/index.js).
- Known limits in v1.0.0-alpha (SwidgeProtocolConfig fee caps no-op,
minAmountOut not forwarded, Solana SPL unsupported, getSupportedTokens
fromToken filter passed through) documented in every page that
mentions those APIs — no silent surprises for adopters.
- Community disclaimer callout matches swidge-orchestra/index.mdx
wording ("developed and maintained independently by a third-party
contributor").
Content sourced from the module's README + CHANGELOG in the
Swap-DK/wdk-protocol-bridges-swapdk repo (packages/swidge/); references
throughout link back to the source on GitHub and to related WDK
wallet-module pages for peer-wallet setup.
The @swapdk/wdk-protocol-swidge-swapdk package is now on 1.0.0 (was
1.0.0-alpha.0 when these docs were written). Same code — the alpha
window is closed and downstream can pin against the stable version.
Touched:
- index.mdx: "Currently on 1.0.0-alpha.0. … breaking changes are still
possible before 1.0.0" callout reworded to signal stable ("Currently
on 1.0.0 — stable API surface"). "Known Limits (v1.0.0-alpha)"
heading loses the version qualifier — the limits remain but they're
the current-release scope-of-first-release notes now, not alpha-
window caveats.
- api-reference.mdx: `#known-limits-v100-alpha` anchor updated to
`#known-limits` to match the renamed heading.
Vali0x
marked this pull request as ready for review
July 14, 2026 13:50
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
1 participant
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 documentation for @swapdk/wdk-protocol-swidge-swapdk under content/docs/sdk/swidge-modules/swidge-swapdk.
Also adds one row to content/docs/sdk/community-modules/index.mdx pointing at the swidge-swapdk docs. Type = "Swidge Module", author = SwapDK.
Content highlights:
Multi-family source coverage: the swidge module ships a single class covering Bitcoin, EVM (Ethereum / Arbitrum / Base / BSC / Avalanche), Cosmos (THORChain / MAYAChain), Solana, and TRON as sources.
Server-side provider selection across THORChain / MAYAChain / Chainflip; live halt-filtered discovery via /chains and /tokens?shape=swidge.
Peer pin: @tetherto/wdk-wallet=1.0.0-beta.11 exact (upstream beta.12+ regressed the SwidgeProtocol re-export from /protocols/index.js).
Known limits in v1.0.0 (SwidgeProtocolConfig fee caps no-op, minAmountOut not forwarded, Solana SPL unsupported, getSupportedTokens fromToken filter passed through) documented in every page that mentions those APIs — no silent surprises for adopters.
Community disclaimer callout matches other swidge modules wording ("developed and maintained independently by a third-party contributor").
Content sourced from the module's README + CHANGELOG in the Swap-DK/wdk-protocol-bridges-swapdk repo (packages/swidge/); references throughout link back to the source on GitHub and to related WDK wallet-module pages for peer-wallet setup.