feat: fetchOfframpLiquidity method and add orderOwner argument in ABI

[nakul1010]

Summary by CodeRabbit

• New Features

  • Added the ability to fetch offramp liquidity details for supported tokens.
  • Introduced support for specifying an order owner when creating offramp orders.

• Tests

  • Added tests to verify fetching offramp liquidity and updated tests to include the order owner field in offramp order creation.

[vercel]

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	Apr 30, 2025 1:32pm

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update introduces a new orderOwner parameter to the offrampOrderArgs tuple in the createOrder function ABI, and propagates this addition throughout the SDK. The createOfframpOrder method in the client now includes the orderOwner field, and the related type definitions are updated accordingly. Additionally, a new method, fetchOfframpLiquidity, is added to the client for retrieving token liquidity information from the Gateway API. Corresponding tests are added to verify the new liquidity-fetching functionality and the correct handling of the orderOwner parameter.

Changes

File(s)	Change Summary
sdk/src/gateway/abi.ts	Added orderOwner: address input to offrampOrderArgs tuple in createOrder ABI.
sdk/src/gateway/client.ts	Added fetchOfframpLiquidity method, and included orderOwner in createOfframpOrder args.
sdk/src/gateway/types.ts	Introduced OfframpLiquidity interface and added orderOwner to OfframpCreateOrderParams.
sdk/test/gateway.test.ts	Added tests for fetchOfframpLiquidity and updated tests to expect the new orderOwner field.
sdk/package.json	Bumped package version from 3.3.0 to 3.3.1

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GatewayApiClient
    participant GatewayAPI

    User->>GatewayApiClient: fetchOfframpLiquidity(token)
    GatewayApiClient->>GatewayAPI: GET /offramp-liquidity/{tokenAddress}
    GatewayAPI-->>GatewayApiClient: { token, maxOrderAmount, totalOfframpLiquidity }
    GatewayApiClient-->>User: OfframpLiquidity object

Loading

sequenceDiagram
    participant User
    participant GatewayApiClient
    participant SmartContract

    User->>GatewayApiClient: createOfframpOrder(params)
    GatewayApiClient->>SmartContract: createOrder(..., orderOwner)
    SmartContract-->>GatewayApiClient: Order confirmation
    GatewayApiClient-->>User: Order result

Loading

Possibly related PRs

• bob-collective/bob#559: Adds a new orderOwner input parameter to the createOrder ABI and updates the client method, directly related to the changes in ABI and client signatures in this PR.
• bob-collective/bob#506: Adds new off-ramp methods and ABI definitions for createOffRampRequest and related features, complementing off-ramp functionality but modifying different ABI functions.

Suggested reviewers

• slavastartsev
• danielsimao

Poem

In the meadow of code where the gateways hop,
A new owner arrives—no reason to stop!
Liquidity pools shimmer, their numbers now clear,
With every new order, the intent is sincere.
So raise up your ears and thump with delight—
The offramp is ready, the future is bright!
🐇✨

---

📜 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 78cae4f and 46430af.

📒 Files selected for processing (1)

• sdk/package.json (1 hunks)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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.