feat(ramps-controller): add unified getOrder to RampsService#7934
Draft
feat(ramps-controller): add unified getOrder to RampsService#7934
Conversation
Add a getOrder method to RampsService that calls the V2 unified order endpoint (GET /v2/providers/:providerCode/orders/:orderCode). This endpoint returns a normalized RampsOrder (DepositOrder shape) for all provider types, enabling mobile to use a single order processor instead of separate aggregator and deposit processors. Changes: - Add RampsOrder type and related types (RampsOrderStatus, etc.) - Add getOrder method to RampsService - Add RampsServiceGetOrderAction type - Wire getOrder into RampsController as a passthrough method - Export new types from index.ts Co-authored-by: Cursor <cursoragent@cursor.com>
- Add getOrderFromCallback method to extract orders from provider callback URLs - Sends callback URL to V2 backend for provider-specific parsing - Backend extracts order ID using provider logic - Returns full RampsOrder (same pattern as aggregator SDK) - Rename getWidgetUrl to getBuyWidget to return full BuyWidget object - Returns url, browser type, and orderId (for custom order tracking) - Mobile needs orderId for pre-order tracking like aggregator flow - Wire new action through messenger and export types This enables the V2 unified checkout to handle provider callbacks the same way the aggregator SDK does, with server-side URL parsing instead of client-side guessing.
The V2 API embeds the widget information directly in quote responses (url, browser type, orderId) instead of requiring a separate getBuyWidgetUrl call. Add buyWidget field to Quote type to match the actual API response.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Explanation
Add a
getOrdermethod toRampsServicethat calls the V2 unified order endpoint (GET /v2/providers/:providerCode/orders/:orderCode). This endpoint returns a normalizedRampsOrder(DepositOrder shape) for all provider types, enabling mobile to use a single order processor instead of separate aggregator and deposit processors.This is the core-side prerequisite for unifying order processing in metamask-mobile and eventually removing both
@consensys/on-ramp-sdkand@consensys/native-ramps-sdkfor order polling.Changes
RampsService.ts: AddRampsOrdertype and related types (RampsOrderStatus,RampsOrderNetwork,RampsOrderCryptoCurrency,RampsOrderPaymentMethod). AddgetOrder(providerCode, orderCode, wallet)method.RampsService-method-action-types.ts: AddRampsServiceGetOrderActiontype.RampsController.ts: AddgetOrderwrapper method. WireRampsService:getOrderinto allowed actions.index.ts: Export all new types.References
GET /v2/providers/:providerCode/orders/:orderCode(already live in onramp-api)Checklist
Made with Cursor