Skip to content

Conversation

@shoom3301
Copy link
Contributor

@shoom3301 shoom3301 commented Dec 22, 2025

Description

Since we are enabling cross-chain swaps for Safe, they would disable the feature for awhile to adopt it on their side

Summary by CodeRabbit

  • New Features

    • Added configuration option to disable cross-chain swaps and bridge functionality in the widget.
  • Documentation

    • Updated widget documentation with new configuration parameter.

✏️ Tip: You can customize this high-level summary in your review settings.

@shoom3301 shoom3301 self-assigned this Dec 22, 2025
@shoom3301 shoom3301 requested a review from a team as a code owner December 22, 2025 10:45
@vercel
Copy link

vercel bot commented Dec 22, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
docs Ready Ready Preview Dec 22, 2025 10:45am

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 22, 2025

Walkthrough

A new optional boolean parameter disableCrossChainSwap was added to the CowSwapWidgetParams interface, allowing the cross-chain swaps feature to be disabled. The change is reflected in both the widget library interface and the corresponding documentation.

Changes

Cohort / File(s) Change Summary
Widget Parameter Addition
docs/cow-protocol/tutorials/widget/widget.md, @cowprotocol/widget-lib interface
Added optional parameter disableCrossChainSwap?: boolean to CowSwapWidgetParams interface to control cross-chain swap functionality

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Simple parameter addition with no logic changes
  • Single interface modification
  • Documentation update only

Poem

🐰 A flag was born, so small and neat,
To toggle swaps across the street,
Cross-chain flows now bend to will,
With one boolean, disableCrossChainSwap still!
Configuration magic, clean and sweet. ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The description is incomplete. While it provides context for why the change is needed, it lacks the required 'Changes' section with detailed implementation steps, and the description text itself is quite brief. Add a 'Changes' section that lists the specific modifications made (e.g., adding the disableCrossChainSwap parameter to CowSwapWidgetParams interface). Expand the description with more implementation details.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding a parameter to disable cross-chain swaps in the widget, which is the core modification shown in the file diff.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/widget-disable-bridge

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8853522 and babc995.

📒 Files selected for processing (1)
  • docs/cow-protocol/tutorials/widget/widget.md
🔇 Additional comments (1)
docs/cow-protocol/tutorials/widget/widget.md (1)

346-346: Documentation addition looks good.

The new disableCrossChainSwap parameter follows the established naming pattern, type conventions, and documentation style. The default value (false) appropriately enables the feature by default, and the description clearly conveys the purpose.

Verify that the implementation in the @cowprotocol/widget-lib package includes this parameter and that it correctly disables the cross-chain swap feature when set to true.

Also applies to: 366-366


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

3 participants