Skip to content

[SDK] Handle sponsored gas on TransactionWidget #7437

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

Merged
merged 1 commit into from
Jun 25, 2025

Conversation

joaquim-verges
Copy link
Member

@joaquim-verges joaquim-verges commented Jun 25, 2025


PR-Codex overview

This PR focuses on enhancing the TransactionWidget to handle sponsored gas transactions, improving the user experience in payment processing.

Detailed summary

  • Added paymentMethod prop to TransactionOverViewCompact.
  • Integrated wallet from paymentMethod in useTransactionDetails.
  • Imported useActiveWallet in TransactionPayment.
  • Updated UseTransactionDetailsOptions to include wallet.
  • Adjusted gas cost calculation based on sponsored transactions in useTransactionDetails.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

  • New Features

    • Improved handling of sponsored transactions by displaying zero gas cost when sponsorship is enabled in the TransactionWidget and related views.
  • Bug Fixes

    • Ensured accurate gas cost display based on the user's wallet sponsorship status in transaction details and payment overviews.

Copy link

vercel bot commented Jun 25, 2025

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

Name Status Preview Comments Updated (UTC)
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 25, 2025 1:12am
nebula ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 25, 2025 1:12am
thirdweb_playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 25, 2025 1:12am
thirdweb-www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 25, 2025 1:12am
wallet-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 25, 2025 1:12am

@joaquim-verges joaquim-verges marked this pull request as ready for review June 25, 2025 00:56
@github-actions github-actions bot added Playground Changes involving the Playground codebase. packages SDK Involves changes to the thirdweb SDK labels Jun 25, 2025
Copy link
Contributor

coderabbitai bot commented Jun 25, 2025

Walkthrough

This update introduces wallet-aware sponsored gas handling in the transaction details logic. The useTransactionDetails hook now accepts a wallet parameter to determine if gas sponsorship applies, affecting gas cost calculation and cache keys. Related UI components are updated to provide the wallet context, and a changeset records the patch.

Changes

File(s) Change Summary
.changeset/rude-bags-say.md Added changeset documenting patch for handling sponsored gas in TransactionWidget.
packages/thirdweb/src/react/core/hooks/useTransactionDetails.ts Modified hook to accept wallet parameter, conditionally set gas cost to zero for sponsored transactions, and updated cache key logic.
packages/thirdweb/src/react/web/ui/Bridge/TransactionPayment.tsx Added useActiveWallet hook and passed wallet to useTransactionDetails.
packages/thirdweb/src/react/web/ui/Bridge/payment-details/PaymentOverview.tsx Updated component props to include paymentMethod, passed payerWallet to useTransactionDetails, and adjusted prop signatures.

Sequence Diagram(s)

sequenceDiagram
    participant UI_Component as UI Component (e.g., TransactionPayment, PaymentOverview)
    participant Wallet as Wallet
    participant useTransactionDetails as useTransactionDetails Hook
    participant GasLogic as Gas Cost Logic

    UI_Component->>Wallet: Retrieve active wallet (useActiveWallet or from paymentMethod)
    UI_Component->>useTransactionDetails: Call with transaction + wallet
    useTransactionDetails->>Wallet: Check if sponsored transactions are enabled
    alt Sponsored Transactions Enabled
        useTransactionDetails->>GasLogic: Set gas cost to 0
    else Not Sponsored
        useTransactionDetails->>GasLogic: Fetch actual gas cost
    end
    useTransactionDetails-->>UI_Component: Return transaction details (with correct gas cost)
Loading

Possibly related PRs

  • thirdweb-dev/js#7360: Modifies the useTransactionDetails hook, but focuses on cache key changes for erc20Value rather than wallet-based sponsorship logic.
  • thirdweb-dev/js#7241: Refactors and reintroduces the hasSponsoredTransactionsEnabled function, which is now used in the updated sponsorship logic within useTransactionDetails.

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • TEAM-0000: Entity not found: Issue - Could not find referenced Issue.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6cb6656 and 9a6164e.

📒 Files selected for processing (4)
  • .changeset/rude-bags-say.md (1 hunks)
  • packages/thirdweb/src/react/core/hooks/useTransactionDetails.ts (5 hunks)
  • packages/thirdweb/src/react/web/ui/Bridge/TransactionPayment.tsx (3 hunks)
  • packages/thirdweb/src/react/web/ui/Bridge/payment-details/PaymentOverview.tsx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (4)
  • .changeset/rude-bags-say.md
  • packages/thirdweb/src/react/web/ui/Bridge/TransactionPayment.tsx
  • packages/thirdweb/src/react/core/hooks/useTransactionDetails.ts
  • packages/thirdweb/src/react/web/ui/Bridge/payment-details/PaymentOverview.tsx
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Size
  • GitHub Check: Lint Packages
  • GitHub Check: Unit Tests
  • GitHub Check: Analyze (javascript)
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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 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.

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.

@joaquim-verges joaquim-verges requested review from a team as code owners June 25, 2025 00:56
Copy link
Member Author

joaquim-verges commented Jun 25, 2025


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • merge-queue - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@joaquim-verges joaquim-verges force-pushed the Handle_sponsored_gas_on_TransactionWidget branch from 6cb6656 to 9a6164e Compare June 25, 2025 01:00
Copy link

changeset-bot bot commented Jun 25, 2025

🦋 Changeset detected

Latest commit: 9a6164e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
thirdweb Patch
@thirdweb-dev/nebula Patch
@thirdweb-dev/wagmi-adapter Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 62.56 KB (0%) 1.3 s (0%) 712 ms (+86.38% 🔺) 2 s
thirdweb (cjs) 350.74 KB (0%) 7.1 s (0%) 3.1 s (+1.69% 🔺) 10.1 s
thirdweb (minimal + tree-shaking) 5.72 KB (0%) 115 ms (0%) 262 ms (+724.32% 🔺) 376 ms
thirdweb/chains (tree-shaking) 530 B (0%) 11 ms (0%) 240 ms (+2945.34% 🔺) 250 ms
thirdweb/react (minimal + tree-shaking) 19.61 KB (0%) 393 ms (0%) 253 ms (+404.2% 🔺) 645 ms

Copy link

codecov bot commented Jun 25, 2025

Codecov Report

Attention: Patch coverage is 16.66667% with 10 lines in your changes missing coverage. Please review.

Project coverage is 51.96%. Comparing base (d85ee5f) to head (9a6164e).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...dweb/src/react/core/hooks/useTransactionDetails.ts 14.28% 6 Missing ⚠️
...web/src/react/web/ui/Bridge/TransactionPayment.tsx 33.33% 2 Missing ⚠️
.../web/ui/Bridge/payment-details/PaymentOverview.tsx 0.00% 2 Missing ⚠️

❌ Your patch status has failed because the patch coverage (16.66%) is below the target coverage (80.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7437      +/-   ##
==========================================
- Coverage   51.96%   51.96%   -0.01%     
==========================================
  Files         947      947              
  Lines       63809    63820      +11     
  Branches     4216     4214       -2     
==========================================
+ Hits        33161    33163       +2     
- Misses      30542    30551       +9     
  Partials      106      106              
Flag Coverage Δ
packages 51.96% <16.66%> (-0.01%) ⬇️
Files with missing lines Coverage Δ
...web/src/react/web/ui/Bridge/TransactionPayment.tsx 6.46% <33.33%> (+0.27%) ⬆️
.../web/ui/Bridge/payment-details/PaymentOverview.tsx 5.13% <0.00%> (-0.05%) ⬇️
...dweb/src/react/core/hooks/useTransactionDetails.ts 11.45% <14.28%> (+0.25%) ⬆️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@joaquim-verges joaquim-verges merged commit af89836 into main Jun 25, 2025
31 of 33 checks passed
@joaquim-verges joaquim-verges deleted the Handle_sponsored_gas_on_TransactionWidget branch June 25, 2025 02:10
@joaquim-verges joaquim-verges mentioned this pull request Jun 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
packages Playground Changes involving the Playground codebase. SDK Involves changes to the thirdweb SDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant