Chore: Update UB jsdocs to include types #7629

gregfromstl · 2025-07-15T18:18:25Z

PR-Codex overview

This PR focuses on enhancing the thirdweb bridge functionality by adding detailed TypeScript definitions and documentation for various namespaces related to chains, status, transfer, routes, onramp, sell, and buy operations.

Detailed summary

Updated AuthMethodsTabs.tsx to change flex-shrink-0 to shrink-0.
Added TypeScript namespaces and interfaces for chains, status, prepare (transfer, onramp, sell, buy), and routes.
Included options and result types for each operation, enhancing documentation and type safety.

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

Summary by CodeRabbit

Documentation
- Enhanced inline documentation and added detailed descriptions for various functions and types related to bridging, buying, selling, onramping, transferring, and checking status of assets.
- Improved clarity and structure of type definitions and namespaces, making it easier for developers to understand available options and results when using these features.
- No changes to app behavior or user interface.

changeset-bot · 2025-07-15T18:18:29Z

⚠️ No Changeset found

Latest commit: bb2c722

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

vercel · 2025-07-15T18:18:29Z

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	Jul 15, 2025 6:38pm
nebula	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 15, 2025 6:38pm
thirdweb_playground	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 15, 2025 6:38pm
thirdweb-www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 15, 2025 6:38pm
wallet-ui	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 15, 2025 6:38pm

coderabbitai · 2025-07-15T18:18:31Z

Walkthrough

The changes introduce comprehensive JSDoc comments and TypeScript namespaces for various bridge-related modules, documenting input and output types for key functions such as quote, prepare, routes, status, and chains. These additions provide explicit structure and inline documentation for function parameters and results, without modifying any runtime logic or control flow.

Changes

File(s)	Change Summary
.../src/bridge/Buy.ts .../src/bridge/Sell.ts	Added `quote` and `prepare` namespaces with detailed interfaces for input options and result types.
.../src/bridge/Onramp.ts	Added `prepare` namespace with documented `Options` and `Result` types for the `prepare` function.
.../src/bridge/Routes.ts	Introduced `routes` namespace with documented `Options` and `Result` interfaces for the function.
.../src/bridge/Status.ts	Added JSDoc comments and namespace documentation for `status.Options` and `status.Result` types.
.../src/bridge/Chains.ts	Added JSDoc comments to `chains` namespace and its `Options` and `Result` types.
.../src/bridge/Transfer.ts	Added JSDoc comments to `prepare` namespace and its `Options` and `Result` types.
apps/portal/src/components/Document/AuthMethodsTabs.tsx	Replaced CSS class `flex-shrink-0` with `shrink-0` on social icon image element.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant BridgeModule

    Caller->>BridgeModule: call quote(options)
    BridgeModule-->>Caller: return Result (with intent and quote details)

    Caller->>BridgeModule: call prepare(options)
    BridgeModule-->>Caller: return Result (with intent and prepared quote)

sequenceDiagram
    participant Caller
    participant OnrampModule

    Caller->>OnrampModule: call prepare(options)
    OnrampModule-->>Caller: return Result (onramp link, quote, routing steps)

sequenceDiagram
    participant Caller
    participant RoutesModule

    Caller->>RoutesModule: call routes(options)
    RoutesModule-->>Caller: return Result (array of Route objects)

sequenceDiagram
    participant Caller
    participant StatusModule

    Caller->>StatusModule: call status(options)
    StatusModule-->>Caller: return Result (transaction status and details)

sequenceDiagram
    participant Caller
    participant ChainsModule

    Caller->>ChainsModule: call chains(options)
    ChainsModule-->>Caller: return Result (array of supported chains)

sequenceDiagram
    participant Caller
    participant TransferModule

    Caller->>TransferModule: call prepare(options)
    TransferModule-->>Caller: return Result (prepared quote and intent)

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 4de168f and bb2c722.

📒 Files selected for processing (8)

apps/portal/src/components/Document/AuthMethodsTabs.tsx (1 hunks)
packages/thirdweb/src/bridge/Buy.ts (2 hunks)
packages/thirdweb/src/bridge/Chains.ts (1 hunks)
packages/thirdweb/src/bridge/Onramp.ts (1 hunks)
packages/thirdweb/src/bridge/Routes.ts (1 hunks)
packages/thirdweb/src/bridge/Sell.ts (2 hunks)
packages/thirdweb/src/bridge/Status.ts (1 hunks)
packages/thirdweb/src/bridge/Transfer.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

apps/portal/src/components/Document/AuthMethodsTabs.tsx

🚧 Files skipped from review as they are similar to previous changes (7)

packages/thirdweb/src/bridge/Transfer.ts
packages/thirdweb/src/bridge/Status.ts
packages/thirdweb/src/bridge/Routes.ts
packages/thirdweb/src/bridge/Onramp.ts
packages/thirdweb/src/bridge/Buy.ts
packages/thirdweb/src/bridge/Chains.ts
packages/thirdweb/src/bridge/Sell.ts

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

graphite-app · 2025-07-15T18:18:41Z

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

github-actions · 2025-07-15T18:28:57Z

size-limit report 📦

Path	Size	Loading time (3g)	Running time (snapdragon)	Total time
thirdweb (esm)	63.25 KB (0%)	1.3 s (0%)	3.8 s (+8.93% 🔺)	5 s
thirdweb (cjs)	353.31 KB (0%)	7.1 s (0%)	23.1 s (-3.95% 🔽)	30.2 s
thirdweb (minimal + tree-shaking)	5.7 KB (0%)	114 ms (0%)	241 ms (+56.7% 🔺)	355 ms
thirdweb/chains (tree-shaking)	526 B (0%)	11 ms (0%)	86 ms (-27.44% 🔽)	96 ms
thirdweb/react (minimal + tree-shaking)	19.59 KB (0%)	392 ms (0%)	427 ms (-8.53% 🔽)	819 ms

codecov · 2025-07-15T18:50:54Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56.42%. Comparing base (761cde6) to head (bb2c722).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #7629      +/-   ##
==========================================
- Coverage   56.42%   56.42%   -0.01%     
==========================================
  Files         906      906              
  Lines       58126    58126              
  Branches     4224     4222       -2     
==========================================
- Hits        32796    32795       -1     
- Misses      25222    25223       +1     
  Partials      108      108

Flag	Coverage Δ
packages	`56.42% <ø> (-0.01%)`	⬇️

Files with missing lines	Coverage Δ
packages/thirdweb/src/bridge/Buy.ts	`92.18% <ø> (ø)`
packages/thirdweb/src/bridge/Chains.ts	`68.96% <ø> (ø)`
packages/thirdweb/src/bridge/Onramp.ts	`60.37% <ø> (ø)`
packages/thirdweb/src/bridge/Routes.ts	`81.03% <ø> (ø)`
packages/thirdweb/src/bridge/Sell.ts	`92.96% <ø> (ø)`
packages/thirdweb/src/bridge/Status.ts	`40.57% <ø> (ø)`
packages/thirdweb/src/bridge/Transfer.ts	`93.15% <ø> (ø)`

... and 1 file with indirect coverage changes

🚀 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 requested review from a team as code owners July 15, 2025 18:18

github-actions bot added packages SDK Involves changes to the thirdweb SDK labels Jul 15, 2025

github-actions bot assigned gregfromstl Jul 15, 2025

vercel bot deployed to Preview – nebula July 15, 2025 18:20 View deployment

vercel bot deployed to Preview – wallet-ui July 15, 2025 18:20 View deployment

vercel bot deployed to Preview – thirdweb_playground July 15, 2025 18:21 View deployment

chore: update UB jsdocs to include types

bb2c722

gregfromstl force-pushed the greg/ub-jsdocs branch from 4de168f to bb2c722 Compare July 15, 2025 18:23

github-actions bot added the Portal Involves changes to the Portal (docs) codebase. label Jul 15, 2025

vercel bot deployed to Preview – nebula July 15, 2025 18:26 View deployment

vercel bot deployed to Preview – thirdweb_playground July 15, 2025 18:27 View deployment

vercel bot deployed to Preview – wallet-ui July 15, 2025 18:27 View deployment

vercel bot deployed to Preview – thirdweb-www July 15, 2025 18:35 View deployment

vercel bot deployed to Preview – docs-v2 July 15, 2025 18:38 View deployment

gregfromstl merged commit 5f74b3c into main Jul 15, 2025
28 of 29 checks passed

gregfromstl deleted the greg/ub-jsdocs branch July 15, 2025 18:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Chore: Update UB jsdocs to include types #7629

Chore: Update UB jsdocs to include types #7629

Uh oh!

gregfromstl commented Jul 15, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Jul 15, 2025 •

edited

Loading

Uh oh!

vercel bot commented Jul 15, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jul 15, 2025 •

edited

Loading

Review ran into problems

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

graphite-app bot commented Jul 15, 2025

Uh oh!

github-actions bot commented Jul 15, 2025

Uh oh!

Uh oh!

codecov bot commented Jul 15, 2025 •

edited

Loading

Uh oh!

Uh oh!

Chore: Update UB jsdocs to include types #7629

Chore: Update UB jsdocs to include types #7629

Uh oh!

Conversation

gregfromstl commented Jul 15, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR-Codex overview

Detailed summary

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

vercel bot commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Review ran into problems

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

graphite-app bot commented Jul 15, 2025

How to use the Graphite Merge Queue

Uh oh!

github-actions bot commented Jul 15, 2025

size-limit report 📦

Uh oh!

Uh oh!

codecov bot commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

gregfromstl commented Jul 15, 2025 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Jul 15, 2025 •

edited

Loading

vercel bot commented Jul 15, 2025 •

edited

Loading

coderabbitai bot commented Jul 15, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Jul 15, 2025 •

edited

Loading