chore: improve offramp types

[slavastartsev]

Summary by CodeRabbit

• Refactor
  • Consolidated contract interaction methods into a unified structure for improved consistency.
  • Enhanced type safety by restricting supported network options for better reliability.
• Style
  • Suppressed TypeScript errors in tests to allow validation of invalid network inputs without disruption.

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
bob-docs	🛑 Canceled (Inspect)			May 5, 2025 11:14am

[coderabbitai]

Walkthrough

This change refactors four separate exported ABI arrays for offramp contract methods into a single exported object offrampCaller with keys for each method. The client module updates imports to use this consolidated object and replaces static ABI references with dynamic lookups by method name. The GatewayApiClient constructor narrows the chainName parameter type to specific allowed strings. The test suite adds a TypeScript @ts-expect-error comment to suppress type errors for an invalid chain name test case. Corresponding type definitions are updated to use the new offrampCaller object structure.

Changes

File(s)	Change Summary
sdk/src/gateway/abi.ts	Replaced four separate exported ABI arrays with a single exported object offrampCaller grouping all offramp ABIs.
sdk/src/gateway/client.ts	Updated imports to use offrampCaller; replaced static ABI references with dynamic property access; narrowed chainName type.
sdk/src/gateway/types.ts	Updated type references from separate ABI callers to properties of the unified offrampCaller object.
sdk/test/gateway.test.ts	Added @ts-expect-error comment to suppress TypeScript error on invalid chain name test case.

Sequence Diagram(s)

sequenceDiagram
    participant Client as GatewayApiClient
    participant ABI as offrampCaller Object
    participant Contract as Offramp Contract

    Client->>ABI: Access method ABI by key (e.g., 'createOrder')
    Client->>Contract: Call contract method using selected ABI
    Contract-->>Client: Return result

Loading

Possibly related PRs

• feat: fetchOfframpLiquidity method and add orderOwner argument in ABI #587: Modifies the createOrder ABI by adding a new input and updates client methods, related to ABI usage consolidated here.
• feat: add offramp sdk methods #559: Introduced the separate ABI caller constants and SDK methods that this PR refactors into a unified structure.

Suggested reviewers

• gregdhill

Poem

In the warren where code does hop,
Four arrays merged into one big crop.
Offramp callers now all together,
Simpler imports—much lighter than a feather!
Chain names checked, errors suppressed,
This bunny’s code is neatly addressed.
🐇✨

---

📜 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 ca15c14 and 44e599d.

📒 Files selected for processing (3)

• sdk/src/gateway/abi.ts (5 hunks)
• sdk/src/gateway/client.ts (6 hunks)
• sdk/src/gateway/types.ts (4 hunks)

🚧 Files skipped from review as they are similar to previous changes (3)

• sdk/src/gateway/types.ts
• sdk/src/gateway/client.ts
• sdk/src/gateway/abi.ts

✨ Finishing Touches

• 📝 Generate Docstrings

---

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.

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