feat: add `orderDetails` to `OnrampOrderResponse` #682

nakul1010 · 2025-07-14T05:03:50Z

Summary by CodeRabbit

New Features
- Added an optional order details field to onramp order responses, enabling display of more detailed order information where available.

vercel · 2025-07-14T05:03:57Z

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

Name	Status	Preview	Comments	Updated (UTC)
bob-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 14, 2025 9:00am

coderabbitai · 2025-07-14T05:03:59Z

Walkthrough

The changes update the handling of order details in the onramp order response. An optional orderDetails property is added to the OnrampOrderResponse type, and the getOnrampOrders method is modified to process and include this property using a conversion function if present.

Changes

File(s)	Change Summary
sdk/src/gateway/types.ts	Added optional `orderDetails?: OrderDetails` property to `OnrampOrderResponse` interface.
sdk/src/gateway/client.ts	Updated `getOnrampOrders` to process and attach `orderDetails` using a conversion function if present; updated import.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant GatewaySDK

    Client->>GatewaySDK: getOnrampOrders()
    GatewaySDK->>GatewaySDK: Fetch orders
    GatewaySDK->>GatewaySDK: For each order, check orderDetails
    alt orderDetails present
        GatewaySDK->>GatewaySDK: Convert orderDetails
    else orderDetails absent
        GatewaySDK->>GatewaySDK: Set orderDetails to null
    end
    GatewaySDK-->>Client: Return orders with processed orderDetails

Possibly related PRs

bob-collective/bob#680: Introduced and handled orderDetails in the gateway SDK v4, including conversion functions and type extensions.
bob-collective/bob#616: Modified getOnrampOrders and related types in the same files, indicating direct overlap in method and type changes.

Suggested reviewers

slavastartsev

Poem

In the warren of code, a detail appears,
Order details now handled—no more fears!
With a hop and a jump, types grow anew,
Conversion in place for a data-filled view.
🐇✨ Orders are richer, the SDK’s bright—
A bunny’s delight in the digital night!

📜 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 d2bdfcf and bce4b0e.

📒 Files selected for processing (1)

sdk/src/gateway/client.ts (3 hunks)

🧰 Additional context used

🧠 Learnings (1)

sdk/src/gateway/client.ts (1)

Learnt from: slavastartsev
PR: bob-collective/bob#634
File: sdk/src/gateway/client.ts:136-140
Timestamp: 2025-06-17T11:18:53.195Z
Learning: The codebase has a requirement not to introduce discriminated unions in the Gateway SDK client methods, including the getQuote method return types in sdk/src/gateway/client.ts.

🧬 Code Graph Analysis (1)

sdk/src/gateway/client.ts (1)

sdk/src/gateway/utils.ts (1)

convertOrderDetailsRawToOrderDetails (67-82)

🪛 GitHub Check: Tests

sdk/src/gateway/client.ts

[warning] 49-49:
'OrderDetails' is defined but never used

⏰ 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). (1)

GitHub Check: test

🔇 Additional comments (4)

sdk/src/gateway/client.ts (4)

49-49: Static analysis warning is a false positive.

The OrderDetails type is used in the return type of convertOrderDetailsRawToOrderDetails function called on line 828, so the static analysis warning about it being unused is incorrect.

800-800: LGTM! Dynamic type inference is appropriate here.

Removing the explicit typing allows for better type inference while maintaining type safety through the return type of the method.

827-829: Excellent implementation following past review guidance.

The conditional conversion logic correctly:

Uses truthiness check instead of explicit null comparison

Returns undefined instead of null when orderDetails is absent

Applies the conversion function when orderDetails is present

This implementation addresses the previous review feedback perfectly.

833-834: Successfully integrates orderDetails into the response object.

The orderDetails property is correctly positioned and integrated into the returned order object, fulfilling the PR objective of adding order details to the OnrampOrderResponse.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch fix/add-order-details

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 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 auto-generate unit tests to generate unit tests for 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.

slavastartsev · 2025-07-14T07:53:22Z

sdk/src/gateway/client.ts

            };
+
+            const orderDetails: OrderDetails | null =
+                order.orderDetails != null ? convertOrderDetailsRawToOrderDetails(order.orderDetails) : null;


order.orderDetails != null will always evaluate to true because json can not hold null value. (orders is a parsed json structure)

Is this the right way to go then:

const orderDetails: OrderDetails | null = order.orderDetails != null && order.orderDetails !== "" ? convertOrderDetailsRawToOrderDetails(order.orderDetails) : null;

Is this the right way to go then:

const orderDetails: OrderDetails | null = order.orderDetails != null && order.orderDetails !== "" ? convertOrderDetailsRawToOrderDetails(order.orderDetails) : null;

I believe it must be undefined not null
so more like

const orderDetails = order.orderDetails ? convertOrderDetailsRawToOrderDetails(order.orderDetails) : undefined;

because order.orderDetails is of type OrderDetails | undefined

fix: add orderDetails to OnrampOrderResponse

d2bdfcf

nakul1010 requested a review from slavastartsev July 14, 2025 05:03

nakul1010 self-assigned this Jul 14, 2025

slavastartsev reviewed Jul 14, 2025

View reviewed changes

slavastartsev approved these changes Jul 14, 2025

View reviewed changes

fix: changed from null to undefined

bce4b0e

vercel bot deployed to Preview July 14, 2025 09:00 View deployment

gregdhill approved these changes Jul 14, 2025

View reviewed changes

gregdhill merged commit 98f430c into master Jul 14, 2025
7 of 8 checks passed

gregdhill deleted the fix/add-order-details branch July 14, 2025 16:55

coderabbitai bot mentioned this pull request Aug 18, 2025

feat(gateway): list orders's output tokens #711

Open

This was referenced Sep 18, 2025

chore: check fromChain ID in L0 client #767

Merged

feat(gateway-v4): expose layerzero #770

Merged

feat(gateway-v4): expose output tokens #781

Merged

coderabbitai bot mentioned this pull request Oct 7, 2025

fix(onramp): simplify getStatus logic by removing outputTokenAddress check #783

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add `orderDetails` to `OnrampOrderResponse` #682

feat: add `orderDetails` to `OnrampOrderResponse` #682

Uh oh!

nakul1010 commented Jul 14, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Jul 14, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jul 14, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

slavastartsev Jul 14, 2025 •

edited

Loading

Uh oh!

nakul1010 Jul 14, 2025

Uh oh!

slavastartsev Jul 14, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

feat: add orderDetails to OnrampOrderResponse #682

feat: add orderDetails to OnrampOrderResponse #682

Uh oh!

Conversation

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

Uh oh!

Summary by CodeRabbit

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested reviewers

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

slavastartsev Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nakul1010 Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

slavastartsev Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

feat: add `orderDetails` to `OnrampOrderResponse` #682

feat: add `orderDetails` to `OnrampOrderResponse` #682

nakul1010 commented Jul 14, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Jul 14, 2025 •

edited

Loading

coderabbitai bot commented Jul 14, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

slavastartsev Jul 14, 2025 •

edited

Loading

slavastartsev Jul 14, 2025 •

edited

Loading