Fix: return custom error for taproot address in offramp quote

[nakul1010]

Summary by CodeRabbit

• New Features

  • Enhanced Bitcoin address validation, enforcing stricter checks and displaying clear error messages for unsupported address types.
  • Made a utility for converting Bitcoin addresses to hexadecimal format accessible for broader use.

• Tests

  • Introduced test cases to ensure proper conversion of various Bitcoin address formats and robust error handling for unsupported addresses.

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
bob	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 27, 2025 9:10am

[coderabbitai]

Walkthrough

The pull request introduces stricter Bitcoin address validation in the Gateway API client. Specifically, the getOffRampQuoteAndRequest method now checks Bitcoin address types using the bitcoin-address-validation library and throws an error when a Taproot (p2tr) address is provided. Additionally, the toHexScriptPubKey function’s visibility has been changed from private to exported, making it accessible externally. New test cases ensure correct conversion of common Bitcoin address formats and proper error handling for unsupported address types.

Changes

File(s)	Summary
sdk/src/gateway/client.ts	- Added Bitcoin address type validation in getOffRampQuoteAndRequest (throws error for p2tr addresses). - Changed toHexScriptPubKey from private to exported for external use.
sdk/test/gateway.test.ts	- Added tests verifying hexadecimal conversion of P2WPKH, P2SH-P2WPKH, and P2PKH addresses. - Added test to ensure an error is thrown when a Taproot (p2tr) address is used.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API as GatewayApiClient
    participant Val as bitcoin-address-validation
    participant OffRamp as SIGNET_GATEWAY_BASE_URL

    Client->>API: getOffRampQuoteAndRequest(bitcoinAddress)
    API->>Val: getAddressInfo(bitcoinAddress)
    Val-->>API: Returns address type
    alt Address is Taproot (p2tr)
        API-->>Client: Throw error ("unsupported address type")
    else Address is valid (P2PKH, P2WPKH, P2SH, P2WSH)
        API->>OffRamp: Send off-ramp quote request
        OffRamp-->>API: Return quote data
        API-->>Client: Return off-ramp quote and request response
    end

Loading

Possibly related PRs

• feat: sdk offramp method #506: Modifications to the toHexScriptPubKey function and improvements in address validation align with changes in the current pull request.

Suggested reviewers

• slavastartsev

Poem

I'm a rabbit in a code-filled field,
Hopping through bits without ever to yield,
Checking each address with a curious nose,
Pouncing on errors where a taproot shows.
My exported function dances, oh so free—
A whimsical change in our binary spree!
🐇💻

---

📜 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 868218e and 4a44e8c.

📒 Files selected for processing (2)

• sdk/src/gateway/client.ts (3 hunks)
• sdk/test/gateway.test.ts (2 hunks)

🧰 Additional context used

🪛 Gitleaks (8.21.2)

sdk/test/gateway.test.ts

611-611: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

🔇 Additional comments (4)

sdk/test/gateway.test.ts (2)

587-599: Well-implemented test for different Bitcoin address types

This test is valuable for verifying the toHexScriptPubKey function's correct handling of various Bitcoin address formats (P2WPKH, P2SH-P2WPKH, and P2PKH). The expected values match the actual output, providing good test coverage.

---

601-617: Good error handling for unsupported Taproot addresses

The test properly verifies that the system rejects Taproot addresses with an appropriate error message. This ensures backward compatibility while preventing potential issues with unsupported address types.

🧰 Tools

🪛 Gitleaks (8.21.2)

611-611: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

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

238-240: Effective validation for Taproot addresses

This validation properly checks for and rejects P2TR (Taproot) addresses with a clear error message. This is a good defensive measure to prevent issues with unsupported address types.

---

674-678: Appropriate visibility change for toHexScriptPubKey function

Making this function exported is a good change that facilitates testing and potentially enables reuse in other parts of the codebase.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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 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.