Skip to content

Fix LI.FI swidge release docs metadata - #2

Merged
ihsraham merged 2 commits into
ihsraham:feat/lifi-swidge-release-docsfrom
brucexu-eth:agent/fix-lifi-swidge-docs
Jul 31, 2026
Merged

Fix LI.FI swidge release docs metadata#2
ihsraham merged 2 commits into
ihsraham:feat/lifi-swidge-release-docsfrom
brucexu-eth:agent/fix-lifi-swidge-docs

Conversation

@brucexu-eth

Copy link
Copy Markdown

Summary

  • update LI.FI Swidge docs to use the official @Lifi package name and 0.3.0 release
  • remove the module from community/Kenny listings and keep standalone swap/bridge reference pages in the sidebar
  • document current route filtering behavior: default native-value bridge denylist and allowDestinationCall=false
  • remove refundAddress from LI.FI examples because the module does not currently forward it

Validation

  • git diff --check
  • searched for stale @kenny_io/Kenny/0.2.0 references in the touched docs

npm ci could not complete locally because @tetherto/docs-seo-schema requires GitHub Packages authentication (401 from npm.pkg.github.com).

@vercel

vercel Bot commented Jul 8, 2026

Copy link
Copy Markdown

@brucexu-eth is attempting to deploy a commit to the ihsraham's projects Team on Vercel.

A member of the Team first needs to authorize it.

@brucexu-eth
brucexu-eth force-pushed the agent/fix-lifi-swidge-docs branch 2 times, most recently from d1243ba to 497cd82 Compare July 8, 2026 06:05
@brucexu-eth
brucexu-eth force-pushed the agent/fix-lifi-swidge-docs branch from 497cd82 to caa1d5f Compare July 8, 2026 06:42
@brucexu-eth
brucexu-eth marked this pull request as ready for review July 8, 2026 06:54
The 0.4.0 breaking change made gasless behavior opt-in, reversing the
defaults the docs described. Correct the docs to match shipped v0.5.1:

- denyBridges: omitting sends no filter (LI.FI considers all bridges);
  document NATIVE_VALUE_BRIDGE_DENY_LIST for gasless opt-in
- allowDestinationCall: forwarded only when set; LI.FI default (true)
  applies when omitted (was documented as default false)
- Add allowNativeValue config option (default true) to tables and type
- Rewrite the Route Filtering section around explicit gasless opt-in
- Reword the "Gasless route defaults" feature bullet to opt-in
- Document the minAmountOut execution guard for quote-first flows
- Update changelog entry to v0.5.1 and correct the feature description

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@brucexu-eth

Copy link
Copy Markdown
Author

@ihsraham Pushed a9c41d6 to align these docs with the shipped @lifi/wdk-protocol-swidge-lifi v0.5.1.

Why: the 0.4.0 release (feat!: make gasless behavior opt-in and align defaults with LI.FI) reversed the defaults this PR previously described. The earlier text matched 0.3.0; the corrections below match the published 0.5.1.

Changes

  • denyBridges — omitting it now sends no filter (LI.FI considers all bridges). Documented the exported NATIVE_VALUE_BRIDGE_DENY_LIST for gasless opt-in. (was: "native-value bridges denied by default")
  • allowDestinationCall — forwarded only when set explicitly; LI.FI's server-side default (true) applies when omitted. (was: "Defaults to false")
  • allowNativeValue (new in 0.4.0, default true) — added to the config table and the LifiSwidgeProtocolConfig type; set false for gasless setups.
  • Route Filtering section rewritten around explicit gasless opt-in (denyBridges: NATIVE_VALUE_BRIDGE_DENY_LIST + allowNativeValue: false).
  • minAmountOut quote-first execution guard (new in 0.5.0) — documented in usage + api-reference; it was previously undocumented.
  • Changelog entry bumped v0.3.0v0.5.1 with a corrected feature description.

One nuance for your review: the module's own JSDoc lists quoteSwidge as available in no-account mode, while these docs (unchanged here) state no-account is "chain and token discovery only" — accurate in practice since LI.FI quotes need a source address. Left as-is; flag if you'd rather align to the JSDoc wording instead.

Please double-check and merge when it looks good. 🙏

@ihsraham ihsraham left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the detailed update and for aligning the LI.FI docs with the current package release and behavior. I'm approving and merging this now. We'll take the remaining integration work on the parent WDK docs PR from here. Appreciate the contribution.

@ihsraham
ihsraham merged commit ade854b into ihsraham:feat/lifi-swidge-release-docs Jul 31, 2026
1 check failed
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.

2 participants