Skip to content

[SDK] Feature: preferred chan id pay embed #7296

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 2 commits into from
Jun 6, 2025

Conversation

gregfromstl
Copy link
Member

@gregfromstl gregfromstl commented Jun 6, 2025


PR-Codex overview

This PR introduces enhancements to the buyWithFiat functionality by allowing the specification of the onramp chain and token address, improving flexibility in payment options.

Detailed summary

  • Added onrampChainId and onrampTokenAddress properties to ConnectButtonProps.
  • Updated FiatScreenContent to utilize onrampChainId and onrampTokenAddress from buyWithFiatOptions.
  • Modified getQuote function to accept onrampChainId and onrampTokenAddress parameters.

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

Summary by CodeRabbit

  • New Features
    • Added the ability to specify a blockchain network and token address when purchasing crypto with fiat, allowing users to select their preferred onramp chain and token during the transaction process.

@gregfromstl gregfromstl requested review from a team as code owners June 6, 2025 16:21
Copy link

changeset-bot bot commented Jun 6, 2025

🦋 Changeset detected

Latest commit: 6592394

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

This PR includes changesets to release 2 packages
Name Type
thirdweb 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

vercel bot commented Jun 6, 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 6, 2025 4:29pm
login ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 6, 2025 4:29pm
thirdweb_playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 6, 2025 4:29pm
thirdweb-www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 6, 2025 4:29pm
wallet-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 6, 2025 4:29pm

Copy link
Contributor

coderabbitai bot commented Jun 6, 2025

Walkthrough

This change introduces support for specifying the onramp blockchain network and token address within the fiat-to-crypto purchase flow of the "thirdweb" component. Optional parameters for onrampChainId and onrampTokenAddress are added to relevant types and passed through the quote-fetching and UI logic, enabling explicit selection of the onramp network and token.

Changes

File(s) Change Summary
.changeset/hungry-lions-boil.md Adds a changeset describing the patch for enabling forced selection of onramp blockchain network in fiat purchase options.
packages/thirdweb/src/pay/buyWithFiat/getQuote.ts Extends GetBuyWithFiatQuoteParams with onrampChainId and onrampTokenAddress; updates logic to pass these to prepareOnramp.
packages/thirdweb/src/react/core/hooks/connection/ConnectButtonProps.ts Adds optional onrampChainId and onrampTokenAddress to the buyWithFiat object in PayUIOptions type.
packages/thirdweb/src/react/web/ui/ConnectWallet/screens/Buy/fiat/FiatScreenContent.tsx Passes onrampChainId and onrampTokenAddress from options into the useBuyWithFiatQuote hook.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI (FiatScreenContent)
    participant useBuyWithFiatQuote
    participant getBuyWithFiatQuote
    participant prepareOnramp

    User->>UI (FiatScreenContent): Initiate fiat-to-crypto purchase
    UI (FiatScreenContent)->>useBuyWithFiatQuote: Pass buyWithFiatOptions (including onrampChainId, onrampTokenAddress)
    useBuyWithFiatQuote->>getBuyWithFiatQuote: Request quote with onrampChainId, onrampTokenAddress
    getBuyWithFiatQuote->>prepareOnramp: Prepare onramp with specified chainId and tokenAddress
    prepareOnramp-->>getBuyWithFiatQuote: Return prepared onramp data
    getBuyWithFiatQuote-->>useBuyWithFiatQuote: Return quote
    useBuyWithFiatQuote-->>UI (FiatScreenContent): Display quote to user
Loading

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 f89c15c and 6592394.

📒 Files selected for processing (4)
  • .changeset/hungry-lions-boil.md (1 hunks)
  • packages/thirdweb/src/pay/buyWithFiat/getQuote.ts (2 hunks)
  • packages/thirdweb/src/react/core/hooks/connection/ConnectButtonProps.ts (1 hunks)
  • packages/thirdweb/src/react/web/ui/ConnectWallet/screens/Buy/fiat/FiatScreenContent.tsx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: Size
  • GitHub Check: E2E Tests (pnpm, esbuild)
  • GitHub Check: E2E Tests (pnpm, webpack)
  • GitHub Check: Unit Tests
  • GitHub Check: E2E Tests (pnpm, vite)
  • GitHub Check: Lint Packages
  • GitHub Check: Build Packages
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (5)
.changeset/hungry-lions-boil.md (1)

1-6: LGTM! Changeset correctly documents the feature.

The changeset appropriately documents this as a patch-level change and clearly describes the new functionality.

packages/thirdweb/src/react/web/ui/ConnectWallet/screens/Buy/fiat/FiatScreenContent.tsx (1)

115-116: LGTM! Correct implementation of the new onramp parameters.

The optional chaining and parameter passing follows the established pattern and safely integrates the new functionality without affecting existing behavior.

packages/thirdweb/src/react/core/hooks/connection/ConnectButtonProps.ts (1)

102-103: LGTM! Type definitions are correctly implemented.

The optional properties use appropriate types and maintain backward compatibility while enabling the new onramp customization functionality.

packages/thirdweb/src/pay/buyWithFiat/getQuote.ts (2)

104-105: LGTM! Type definitions are consistent across the codebase.

The optional properties maintain consistency with the type definitions in ConnectButtonProps.ts.


332-333: LGTM! Correct parameter passing with sensible defaults.

The implementation correctly passes the new parameters to prepareOnramp. The fallback to NATIVE_TOKEN_ADDRESS for onrampTokenAddress is well-reasoned to avoid gas issues, and allowing onrampChainId to be undefined is appropriate for the underlying function to handle default chain logic.

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

Copy link
Contributor

graphite-app bot commented Jun 6, 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.

Copy link
Contributor

github-actions bot commented Jun 6, 2025

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 62.57 KB (0%) 1.3 s (0%) 291 ms (+272.79% 🔺) 1.6 s
thirdweb (cjs) 345.55 KB (0%) 7 s (0%) 672 ms (+13.66% 🔺) 7.6 s
thirdweb (minimal + tree-shaking) 5.7 KB (0%) 114 ms (0%) 89 ms (+2006.97% 🔺) 203 ms
thirdweb/chains (tree-shaking) 531 B (0%) 11 ms (0%) 18 ms (+1183.58% 🔺) 29 ms
thirdweb/react (minimal + tree-shaking) 19.56 KB (0%) 392 ms (0%) 72 ms (+554.48% 🔺) 463 ms

Copy link

codecov bot commented Jun 6, 2025

Codecov Report

Attention: Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.

Project coverage is 55.57%. Comparing base (f89c15c) to head (6592394).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
packages/thirdweb/src/pay/buyWithFiat/getQuote.ts 0.00% 2 Missing ⚠️
...nnectWallet/screens/Buy/fiat/FiatScreenContent.tsx 0.00% 2 Missing ⚠️

❌ Your patch status has failed because the patch coverage (0.00%) 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    #7296      +/-   ##
==========================================
- Coverage   55.58%   55.57%   -0.01%     
==========================================
  Files         909      909              
  Lines       58670    58673       +3     
  Branches     4158     4158              
==========================================
  Hits        32609    32609              
- Misses      25954    25957       +3     
  Partials      107      107              
Flag Coverage Δ
packages 55.57% <0.00%> (-0.01%) ⬇️
Files with missing lines Coverage Δ
packages/thirdweb/src/pay/buyWithFiat/getQuote.ts 3.89% <0.00%> (-0.03%) ⬇️
...nnectWallet/screens/Buy/fiat/FiatScreenContent.tsx 10.00% <0.00%> (-0.11%) ⬇️
🚀 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.

@gregfromstl gregfromstl merged commit 69bf925 into main Jun 6, 2025
24 of 25 checks passed
@gregfromstl gregfromstl deleted the greg/preferred-chan-id-pay-embed branch June 6, 2025 16:54
@joaquim-verges joaquim-verges mentioned this pull request Jun 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
packages SDK Involves changes to the thirdweb SDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant