Skip to content

chore: annotate getBuyWithFiatQuote as deprecated #7198

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

Conversation

RobbyUitbeijerse
Copy link
Contributor

@RobbyUitbeijerse RobbyUitbeijerse commented May 29, 2025

Since the param type GetBuyWithFiatQuoteParams and wrapping hook useBuyWithFiatQuote are marked as deprecated, and we were explicitly advised to use the Bridge.Onramp.prepare, I think getBuyWithFiatQuote should be marked as deprecated too. Unless there's very specific purpose for it not being marked as such already, in that case please ignore!


PR-Codex overview

This PR introduces a deprecation notice for the getBuyWithFiatQuote function and adds an annotation for its usage.

Detailed summary

  • Added @deprecated annotation to the getBuyWithFiatQuote function.
  • Included @buyCrypto annotation for further context on the function's purpose.
  • No functional changes were made to the code logic.

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

Summary by CodeRabbit

  • Documentation
    • Marked the buy with fiat quote function as deprecated in the documentation.

@RobbyUitbeijerse RobbyUitbeijerse requested review from a team as code owners May 29, 2025 12:25
Copy link

changeset-bot bot commented May 29, 2025

⚠️ No Changeset found

Latest commit: b535806

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Copy link
Contributor

graphite-app bot commented May 29, 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

coderabbitai bot commented May 29, 2025

Walkthrough

A @deprecated JSDoc annotation was added to the getBuyWithFiatQuote function in the codebase. This change marks the function as deprecated in the documentation, with no modifications to its logic, parameters, or return values.

Changes

File Change Summary
packages/thirdweb/src/pay/buyWithFiat/getQuote.ts Added @deprecated JSDoc annotation to getBuyWithFiatQuote function.

📜 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 16482cf and b535806.

📒 Files selected for processing (1)
  • packages/thirdweb/src/pay/buyWithFiat/getQuote.ts (1 hunks)
🔇 Additional comments (1)
packages/thirdweb/src/pay/buyWithFiat/getQuote.ts (1)

279-279: LGTM! Deprecation annotation added for consistency.

The addition of the @deprecated annotation to getBuyWithFiatQuote is appropriate and maintains consistency with the already deprecated GetBuyWithFiatQuoteParams type (line 12) and BuyWithFiatQuote type (line 114). This change aligns with the PR objectives to mark the function as deprecated since users are advised to use Bridge.Onramp.prepare instead.

The deprecation follows proper JSDoc formatting and doesn't affect the function's logic, making it a clean deprecation that maintains backward compatibility while guiding users toward the preferred API.

✨ 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

vercel bot commented May 29, 2025

@RobbyUitbeijerse is attempting to deploy a commit to the thirdweb Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions bot added packages SDK Involves changes to the thirdweb SDK labels May 29, 2025
@gregfromstl gregfromstl merged commit ff3a79c into thirdweb-dev:main May 29, 2025
5 of 10 checks passed
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.

2 participants