[MNY-236] Portal: Update BridgeWidget script docs to reflect new typescript type #8200

MananTank · 2025-10-06T18:48:27Z

PR-Codex overview

This PR focuses on updating the buy configuration in the Buy tab of the widget, making the amount and chainId properties optional and refining related documentation.

Detailed summary

Changed amount and chainId in the buy object to optional properties.
Updated the Buy type to reflect the optional nature of amount and chainId.
Revised documentation for amount and chainId to remove "Required" tags and clarify their usage.

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

Summary by CodeRabbit

New Features
- Buy configuration in the bridge widget is now optional; amount and chain selection can be omitted and defaults will apply.
- Removed enforced preset buy values, allowing more flexible widget initialization and runtime behavior.
Documentation
- Updated docs and examples to show Buy fields as optional and to explain default behaviors when omitted.

linear · 2025-10-06T18:48:31Z

MNY-236 Portal : Update BridgeWidget docs to reflect new types

vercel · 2025-10-06T18:48:31Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
docs-v2	Ready	Preview	Comment	Oct 6, 2025 7:08pm

4 Skipped Deployments

Project	Deployment	Updated (UTC)
nebula	Skipped	Oct 6, 2025 7:08pm
thirdweb_playground	Skipped	Oct 6, 2025 7:08pm
thirdweb-www	Skipped	Oct 6, 2025 7:08pm
wallet-ui	Skipped	Oct 6, 2025 7:08pm

changeset-bot · 2025-10-06T18:48:32Z

⚠️ No Changeset found

Latest commit: d9a138a

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

MananTank · 2025-10-06T18:48: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.}

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

coderabbitai · 2025-10-06T18:48:47Z

Walkthrough

Updated BridgeWidget documentation: the buy configuration on Options is now optional, and Buy's amount and chainId fields are optional. The example no longer includes a default buy config and field descriptions note default behavior when omitted.

Changes

Cohort / File(s)	Summary
Docs: BridgeWidget types and examples `apps/portal/src/app/bridge/bridge-widget-script/page.mdx`	Made `Options.buy` optional; changed `Buy.amount` and `Buy.chainId` to optional; removed default `buy` from the `BridgeWidget.render` example; updated field descriptions to reflect optionality and defaults.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The pull request description still contains the unfilled template comments and lacks the required “## Notes for the reviewer” and “## How to test” sections, so it does not adhere to the repository’s description template.	Please remove the commented template placeholders and add completed “## Notes for the reviewer” and “## How to test” sections with relevant reviewer guidance and testing instructions.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title clearly references the Portal subsystem and the linked issue and succinctly describes updating the BridgeWidget documentation to reflect new TypeScript type changes, matching the main focus of the changeset.
Linked Issues Check	✅ Passed	The changes update the BridgeWidget buy configuration to make amount and chainId optional and revise the documentation accordingly, which directly satisfies the objectives of linked issue MNY-236.
Out of Scope Changes Check	✅ Passed	All modifications are confined to the BridgeWidget script’s buy configuration types and related documentation, and there are no unrelated or extraneous code changes present.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch mny-236

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 0bf802f and d9a138a.

📒 Files selected for processing (1)

apps/portal/src/app/bridge/bridge-widget-script/page.mdx (3 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

GitHub Check: Size
GitHub Check: E2E Tests (pnpm, webpack)
GitHub Check: Lint Packages
GitHub Check: Analyze (javascript)

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.

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

codecov · 2025-10-06T18:50:36Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 55.03%. Comparing base (777aed1) to head (d9a138a).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #8200   +/-   ##
=======================================
  Coverage   55.03%   55.03%           
=======================================
  Files         919      919           
  Lines       60562    60562           
  Branches     4122     4122           
=======================================
  Hits        33332    33332           
  Misses      27126    27126           
  Partials      104      104

Flag	Coverage Δ
packages	`55.03% <ø> (ø)`

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

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

apps/portal/src/app/bridge/bridge-widget-script/page.mdx (1)

326-335: Clarify the new defaults for optional buy fields.

Now that buy.amount and buy.chainId are optional, please spell out what values the widget falls back to when each is omitted. Without that detail, it’s unclear to integrators what chain/amount their users will see by default. A short note here (and/or in the Options table) would keep the docs actionable.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 777aed1 and 0bf802f.

📒 Files selected for processing (1)

apps/portal/src/app/bridge/bridge-widget-script/page.mdx (3 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (7)

GitHub Check: Unit Tests
GitHub Check: E2E Tests (pnpm, webpack)
GitHub Check: Size
GitHub Check: E2E Tests (pnpm, vite)
GitHub Check: E2E Tests (pnpm, esbuild)
GitHub Check: Lint Packages
GitHub Check: Analyze (javascript)

github-actions · 2025-10-06T18:53:47Z

size-limit report 📦

Path	Size	Loading time (3g)	Running time (snapdragon)	Total time
thirdweb (esm)	64.6 KB (0%)	1.3 s (0%)	258 ms (+65.7% 🔺)	1.6 s
thirdweb (cjs)	365.75 KB (0%)	7.4 s (0%)	1.6 s (+2.91% 🔺)	8.9 s
thirdweb (minimal + tree-shaking)	5.73 KB (0%)	115 ms (0%)	57 ms (+636.89% 🔺)	172 ms
thirdweb/chains (tree-shaking)	526 B (0%)	11 ms (0%)	64 ms (+463.88% 🔺)	74 ms
thirdweb/react (minimal + tree-shaking)	19.13 KB (0%)	383 ms (0%)	61 ms (+644.01% 🔺)	444 ms

graphite-app · 2025-10-06T19:06:07Z

Merge activity

Oct 6, 7:06 PM UTC: MananTank added this pull request to the Graphite merge queue.
Oct 6, 7:11 PM UTC: Merged by the Graphite merge queue.

…script type (#8200)   --- ## PR-Codex overview This PR focuses on making the `buy` properties optional in the configuration for the "Buy" tab UI, enhancing flexibility by allowing users to omit certain parameters. It also updates the documentation to reflect these changes. ### Detailed summary - Changed `buy` properties (`amount`, `chainId`) from required to optional in type definitions. - Updated documentation to remove "Required" tags for `amount` and `chainId`. - Clarified descriptions for `amount`, `chainId`, and `tokenAddress` in the documentation. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`   ## Summary by CodeRabbit * **New Features** * Buy configuration is now optional in the bridge widget; amount and chain selection can be omitted and will use defaults. * Removed forced preset buy values, enabling more flexible initialization. * **Documentation** * Updated docs to reflect optional Buy fields and default behaviors. * Revised examples and type descriptions to indicate optional amount and chain settings.

vercel bot temporarily deployed to Preview – wallet-ui October 6, 2025 18:48 Inactive

vercel bot temporarily deployed to Preview – thirdweb_playground October 6, 2025 18:48 Inactive

vercel bot temporarily deployed to Preview – thirdweb-www October 6, 2025 18:48 Inactive

vercel bot temporarily deployed to Preview – nebula October 6, 2025 18:48 Inactive

MananTank marked this pull request as ready for review October 6, 2025 18:48

MananTank requested review from a team as code owners October 6, 2025 18:48

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

github-actions bot assigned MananTank Oct 6, 2025

coderabbitai bot reviewed Oct 6, 2025

View reviewed changes

vercel bot deployed to Preview – docs-v2 October 6, 2025 18:59 View deployment

jakeloo approved these changes Oct 6, 2025

View reviewed changes

graphite-app bot force-pushed the mny-236 branch from 0bf802f to d9a138a Compare October 6, 2025 19:06

vercel bot temporarily deployed to Preview – nebula October 6, 2025 19:06 Inactive

vercel bot temporarily deployed to Preview – wallet-ui October 6, 2025 19:06 Inactive

vercel bot temporarily deployed to Preview – thirdweb_playground October 6, 2025 19:06 Inactive

vercel bot temporarily deployed to Preview – thirdweb-www October 6, 2025 19:06 Inactive

vercel bot deployed to Preview – docs-v2 October 6, 2025 19:08 View deployment

graphite-app bot merged commit d9a138a into main Oct 6, 2025
24 checks passed

graphite-app bot deleted the mny-236 branch October 6, 2025 19:11

vercel bot temporarily deployed to Production – wallet-ui October 6, 2025 19:11 Inactive

vercel bot temporarily deployed to Production – thirdweb_playground October 6, 2025 19:11 Inactive

vercel bot temporarily deployed to Production – nebula October 6, 2025 19:11 Inactive

vercel bot temporarily deployed to Production – thirdweb-www October 6, 2025 19:11 Inactive

vercel bot deployed to Production – docs-v2 October 6, 2025 19:27 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[MNY-236] Portal: Update BridgeWidget script docs to reflect new typescript type #8200

[MNY-236] Portal: Update BridgeWidget script docs to reflect new typescript type #8200

Uh oh!

MananTank commented Oct 6, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

linear bot commented Oct 6, 2025

Uh oh!

vercel bot commented Oct 6, 2025 •

edited

Loading

Uh oh!

changeset-bot bot commented Oct 6, 2025 •

edited

Loading

Uh oh!

MananTank commented Oct 6, 2025

Uh oh!

coderabbitai bot commented Oct 6, 2025 •

edited

Loading

Review ran into problems

Uh oh!

codecov bot commented Oct 6, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

github-actions bot commented Oct 6, 2025 •

edited

Loading

Uh oh!

graphite-app bot commented Oct 6, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

[MNY-236] Portal: Update BridgeWidget script docs to reflect new typescript type #8200

[MNY-236] Portal: Update BridgeWidget script docs to reflect new typescript type #8200

Uh oh!

Conversation

MananTank commented Oct 6, 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!

linear bot commented Oct 6, 2025

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

⚠️ No Changeset found

Uh oh!

MananTank commented Oct 6, 2025

How to use the Graphite Merge Queue

Uh oh!

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

Uh oh!

Walkthrough

Changes

Estimated code review effort

Pre-merge checks and finishing touches

Review ran into problems

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

graphite-app bot commented Oct 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge activity

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

MananTank commented Oct 6, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Oct 6, 2025 •

edited

Loading

changeset-bot bot commented Oct 6, 2025 •

edited

Loading

coderabbitai bot commented Oct 6, 2025 •

edited

Loading

codecov bot commented Oct 6, 2025 •

edited

Loading

github-actions bot commented Oct 6, 2025 •

edited

Loading

graphite-app bot commented Oct 6, 2025 •

edited

Loading