docs(swidge): add BOB Gateway swidge module#208
Draft
nud3l wants to merge 1 commit into
Draft
Conversation
Adds documentation for @gobob/wdk-protocol-swidge-gateway, a community swidge provider for native BTC routes to and from tokens on EVM chains and Tron. BTC is spent and received on Bitcoin L1 — no wrapped-BTC intermediary, no custodian, and keys never leave the WDK account. New pages under /sdk/swidge-modules/swidge-gateway/: - index (overview, supported routes, execution model) - configuration (source chain, slippage, affiliate fees, BTC fee rate, API access, ERC-4337 paymaster) - usage (install, register, discover, quote, onramp, offramp, EVM↔EVM, status, errors) - api-reference (constructor, methods, route options, status mapping, error codes) Also listed in all-modules, swidge-modules, and community-modules, and added to the sidebar tree. The swidge-modules "Released provider modules" table was missing Rhino.fi, so that row is added alongside ours. Verified: check:meta and check:links pass (264 files, 1420 internal links and 739 anchors, 0 broken). `npm run build` could not be run locally — it requires @tetherto/docs-seo-schema from GitHub Packages, which needs authentication. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
nud3l
marked this pull request as draft
July 14, 2026 15:42
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.
Adds documentation for
@gobob/wdk-protocol-swidge-gateway, a community swidge provider for native BTC routes.BTC is spent and received on Bitcoin L1 — no wrapped-BTC intermediary, no custodian, and keys never leave the WDK account. The module implements the full
SwidgeProtocolinterface and registers through WDK core like any other provider.What it covers
swap()/bridge()Pages added
Under
/sdk/swidge-modules/swidge-gateway/, mirroring the structure of the existing Rhino.fi module:Listed in
all-modules,swidge-modules, andcommunity-modules, and added to the sidebar incustom-tree.ts.Two things integrators need, called out explicitly in the docs: the gateway broadcasts the Bitcoin transaction on onramp routes (the module does not), and the Gateway API applies a country blocklist (including the US and UK) that returns
403— which affects CI as well as production.Verified against the published package
Every code sample in the usage guide follows the
registerProtocolwiring, which we confirmed end-to-end against mainnet using the published0.2.0from npm:Note on the "Released provider modules" table
The table in
swidge-modules/index.mdxwas missing Rhino.fi (it lists only Orchestra, though Rhino.fi is documented and appears inall-modules). I added that row alongside ours — happy to drop it if you'd rather keep this PR to a single module.Verification
npm run check:meta— passnpm run check:links— pass (264 files, 1420 internal links, 739 anchors, 0 broken)npm run buildcould not be run locally: it requires@tetherto/docs-seo-schemafrom GitHub Packages, which returns401without Tether org authentication. The new pages resolve as routes under the link checker and the nav entry mirrors the adjacent Rhino.fi folder exactly, but the Next.js build and OG generation are unverified on our side and will need CI.