chore: update tsdoc for execute quote

[slavastartsev]

Summary by CodeRabbit

• Refactor
  • Simplified the interface for executing quotes by consolidating multiple parameters into a single options object, making the method easier to use.

[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	Jun 18, 2025 8:39am

[coderabbitai]

Walkthrough

The changes consolidate the executeQuote method interface in the GatewayApiClient class by removing overloads for onramp and offramp parameters, and instead using a single options object for client parameters. The JSDoc is updated to reflect this unified approach, simplifying the method's parameter structure.

Changes

File(s)	Change Summary
sdk/src/gateway/client.ts	Removed OfframpExecuteQuoteParams import, deleted two method overloads, updated JSDoc, and consolidated client parameters into a single options object for executeQuote.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant GatewayApiClient

    Caller->>GatewayApiClient: executeQuote(params, {walletClient, publicClient, btcSigner?})
    GatewayApiClient-->>Caller: Promise<string>

Loading

Possibly related PRs

• bob-collective/bob#616: Introduced and overloaded the executeQuote method in GatewayApiClient, which is directly modified and consolidated in this PR.

Poem

A rabbit hopped in code today,
To tidy up the client way.
No more overloads—just one clear call,
With options bundled, that’s all!
Simpler paths for quotes to run,
Now coding’s easier, and more fun.
🐇✨

---

📜 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 22d50a0 and a457bc6.

📒 Files selected for processing (1)

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

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: Tests
• GitHub Check: test
• GitHub Check: Tests
• GitHub Check: Bindings

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch fix/tsdoc-execute-quote

---

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