8000 fix(sdk-router): add nativeFee to IntentStep by ChiTimesChi · Pull Request #3691 · synapsecns/sanguine · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fix(sdk-router): add nativeFee to IntentStep #3691

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
May 21, 2025
Merged

fix(sdk-router): add nativeFee to IntentStep #3691

merged 1 commit into from
May 21, 2025

Conversation

ChiTimesChi
Copy link
Collaborator
@ChiTimesChi ChiTimesChi commented May 21, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • New Features
    • Added a new field displaying native fee information for each intent step, including both same-chain and cross-chain operations. This allows users to view the native fee required for each step in the process.

@vercel Vercel
Copy link
vercel bot commented May 21, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sanguine ❌ Failed (Inspect) May 21, 2025 10:29am

@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented May 21, 2025 •
edited
Loading

Walkthrough

The changes introduce a new string property, nativeFee, to the IntentStep type and ensure it is set in both same-chain and cross-chain intent quote generation functions. The property is now required and included in all relevant intent step objects, reflecting any native fee associated with the operation.

Changes

File(s) Change Summary
packages/sdk-router/src/types/intent.ts Added a required nativeFee: string property to the IntentStep type and updated documentation.
packages/sdk-router/src/operations/intent.ts Updated intent quote generation to include the nativeFee property in all constructed steps.

Poem

A hop and a skip, a fee in the mix,
Now every intent step has native fee tricks.
From chain to chain, or staying the same,
The cost is revealed in the fee’s new name.
Rabbits rejoice, for clarity’s here—
Transparent steps, with nothing to fear! 🐇✨

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between aedca47 and a58058d.

📒 Files selected for processing (2)
  • packages/sdk-router/src/operations/intent.ts (2 hunks)
  • packages/sdk-router/src/types/intent.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: lint
  • GitHub Check: test
  • GitHub Check: changesets-integrity-checker
  • GitHub Check: lint
  • GitHub Check: test
  • GitHub Check: Cloudflare Pages
🔇 Additional comments (4)
packages/sdk-router/src/operations/intent.ts (2)

63-63: The addition of nativeFee property looks good.

The default value of '0' for the nativeFee property in same-chain intent quotes is appropriate, as it properly represents the absence of native fees in this operation type.

128-128: Correctly retrieving nativeFee from bridgeQuote.

The implementation correctly retrieves the nativeFee value from the bridgeQuote object for cross-chain operations, ensuring fee information is properly passed through the system.

packages/sdk-router/src/types/intent.ts (2)

73-73: JSDoc comment is clear and descriptive.

The documentation clearly explains the purpose of the nativeFee property, matching the implementation in the operations file.

90-90: Type declaration is consistent with implementation.

The nativeFee property is appropriately typed as a string, which is consistent with other amount properties in this type definition and matches the implementation in the operations file.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Commit Unit Tests in branch fix/intent-step-native-fee
  • Post Copyable Unit Tests in Comment

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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this PR.
  • @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 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.

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.

@ChiTimesChi ChiTimesChi merged commit dd416a6 into master May 21, 2025
33 of 37 checks passed
@ChiTimesChi ChiTimesChi deleted the fix/intent-step-native-fee branch May 21, 2025 10:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aureliusbtc aureliusbtc Awaiting requested review from aureliusbtc aureliusbtc is a code owner

@trajan0x trajan0x Awaiting requested review from trajan0x trajan0x is a code owner

Assignees
No one assigned
Labels
size/xs Sol Typescript
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@ChiTimesChi
0