Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: cowSwap some issue ok-34971 ok-34976 ok-34986 #6504

Merged
merged 4 commits into from
Jan 14, 2025
Merged

Conversation

ezailWang
Copy link
Contributor

@ezailWang ezailWang commented Jan 14, 2025

Summary by CodeRabbit

Release Notes

  • New Features

    • Added support for order support URL in swap history
    • Enhanced quote management with new provider-specific batch transfer controls
  • Improvements

    • Improved swap history item cleanup process
    • Added more detailed tracking for swap transactions and approvals
  • Technical Updates

    • Updated swap-related interfaces to include additional metadata
    • Refined batch transfer logic based on provider capabilities

These updates improve the overall swap experience with more granular transaction management and informative history tracking.

Signed-off-by: 王山栋 <[email protected]>
Copy link

codesandbox bot commented Jan 14, 2025

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

Copy link
Contributor

coderabbitai bot commented Jan 14, 2025

Walkthrough

The pull request introduces enhancements to the swap functionality across multiple files. The changes focus on improving swap history management, transaction approval handling, and quote processing. Key modifications include adding new properties to interfaces, updating state management for swap transactions, and introducing more granular control over batch transfers and quote tracking.

Changes

File Change Summary
packages/kit-bg/src/services/ServiceSwap.ts Added cleanHistoryStateIntervals method; updated cleanSwapHistoryItems and cleanOneSwapHistory to manage swap history and state intervals
packages/kit/src/states/jotai/contexts/swap/actions.ts Enhanced approvingStateRunSync to update quote list after transaction approval
packages/kit/src/views/Swap/hooks/useSwapBuiltTx.ts Added quoteId to approval transaction state; modified batch transfer logic
packages/kit/src/views/Swap/hooks/useSwapState.ts Updated useSwapBatchTransfer to accept provider batch transfer settings
packages/kit/src/views/Swap/hooks/useSwapTxHistory.ts Added orderSupportUrl to swap history item
packages/kit/src/views/Swap/pages/components/SwapActionsState.tsx Integrated provider batch transfer settings into component logic
packages/kit/src/views/Swap/pages/modal/SwapHistoryDetailModal.tsx Added URL opening capability for order support
packages/shared/types/swap/types.ts Extended interfaces with new properties like quoteId, orderSupportUrl, and providerDisableBatchTransfer

Sequence Diagram

sequenceDiagram
    participant User
    participant SwapComponent
    participant QuoteService
    participant ApprovalService
    participant TransactionService

    User->>SwapComponent: Initiate Swap
    SwapComponent->>QuoteService: Fetch Quote
    QuoteService-->>SwapComponent: Return Quote Details
    SwapComponent->>ApprovalService: Request Approval
    ApprovalService->>TransactionService: Process Transaction
    TransactionService-->>ApprovalService: Approval Confirmation
    ApprovalService-->>SwapComponent: Update Quote List
    SwapComponent->>User: Display Updated Swap State
Loading

Finishing Touches

  • 📝 Generate Docstrings (Beta)

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary or Summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@ezailWang ezailWang enabled auto-merge (squash) January 14, 2025 05:31
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🔭 Outside diff range comments (1)
packages/kit/src/views/Swap/hooks/useSwapState.ts (1)

Line range hint 126-141: LGTM! Consider adding JSDoc

The new parameter correctly controls batch transfers based on provider capability. Consider adding JSDoc to document the parameters and return value.

+/**
+ * Determines if batch transfer is supported based on network, account, and provider settings.
+ * @param networkId - The network identifier
+ * @param accountId - The account identifier
+ * @param providerDisableBatchTransfer - Flag indicating if provider disables batch transfers
+ * @returns boolean indicating if batch transfer is supported
+ */
 export function useSwapBatchTransfer(
   networkId?: string,
   accountId?: string,
   providerDisableBatchTransfer?: boolean,
 )
📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ab21b37 and 59de36c.

📒 Files selected for processing (8)
  • packages/kit-bg/src/services/ServiceSwap.ts (3 hunks)
  • packages/kit/src/states/jotai/contexts/swap/actions.ts (1 hunks)
  • packages/kit/src/views/Swap/hooks/useSwapBuiltTx.ts (2 hunks)
  • packages/kit/src/views/Swap/hooks/useSwapState.ts (3 hunks)
  • packages/kit/src/views/Swap/hooks/useSwapTxHistory.ts (1 hunks)
  • packages/kit/src/views/Swap/pages/components/SwapActionsState.tsx (1 hunks)
  • packages/kit/src/views/Swap/pages/modal/SwapHistoryDetailModal.tsx (2 hunks)
  • packages/shared/types/swap/types.ts (3 hunks)
🔇 Additional comments (9)
packages/kit/src/views/Swap/hooks/useSwapTxHistory.ts (1)

92-92: LGTM! Clean addition of orderSupportUrl

The new property is correctly mapped from the build response data.

packages/kit/src/views/Swap/pages/components/SwapActionsState.tsx (1)

145-145: LGTM! Clean integration of provider batch transfer control

The provider's batch transfer capability is correctly passed to the hook.

packages/shared/types/swap/types.ts (3)

172-172: LGTM! Required quoteId for tracking approvals

The quoteId field enables better tracking of approval transactions.


277-283: LGTM! Enhanced quote result interface

The new fields improve support for:

  • Order tracking via orderSupportUrl
  • Batch transfer control via providerDisableBatchTransfer

577-577: LGTM! Consistent orderSupportUrl addition

The orderSupportUrl field is consistently added to the history interface.

packages/kit/src/views/Swap/hooks/useSwapBuiltTx.ts (1)

721-721: LGTM! Good addition for transaction tracking.

Adding quoteId to the swap approving transaction state improves the connection between approvals and their corresponding quotes.

packages/kit-bg/src/services/ServiceSwap.ts (2)

Line range hint 1000-1016: LGTM! Good cleanup implementation.

The code properly handles the cleanup of history items and their associated intervals. The implementation correctly identifies items to delete using either order ID or transaction ID.


1026-1035: LGTM! Consistent ID handling.

The code maintains consistency in handling both order-based and transaction-based history items during cleanup.

packages/kit/src/states/jotai/contexts/swap/actions.ts (1)

669-677: LGTM! Good quote list management.

The code properly filters out quotes after successful approval, using both provider and quoteId for accurate identification. The immutable update pattern is correctly implemented.

@ezailWang ezailWang merged commit 4ccc25e into x Jan 14, 2025
8 checks passed
@ezailWang ezailWang deleted the fix/cowSwap-some-issue branch January 14, 2025 06:21
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