[READY] add Alfredpay (USD/MXN/COP) on/off-ramp support to SDK#1173
Open
Sharqiewicz wants to merge 3 commits into
Open
[READY] add Alfredpay (USD/MXN/COP) on/off-ramp support to SDK#1173Sharqiewicz wants to merge 3 commits into
Sharqiewicz wants to merge 3 commits into
Conversation
✅ Deploy Preview for vortexfi ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for vortex-sandbox ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Sharqiewicz
changed the title
ebma
requested changes
Jun 8, 2026
ebma
left a comment
ebma
left a comment
Member
There was a problem hiding this comment.
@Sharqiewicz does this branch already have the latest changes from staging? I can see that it's using stellar ephemerals, from which we want to move away from. Please adjust that in the new files and fix the type issues and merge conflicts.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR extends @vortexfi/sdk beyond BRL-only ramps by adding Alfredpay-based USD/MXN/COP onramp and offramp support, including SDK routing, handler implementation, new quote/additional-data types, typed errors, regression tests, and README examples.
Changes:
- Added
AlfredpayHandlerand wiredVortexSdk.registerRamp()/updateRamp()to route Alfredpay flows viaisAlfredpayToken(...). - Expanded SDK type system to include Alfredpay quotes and (register/update) additional-data mappings.
- Added Alfredpay-specific error types + API error parsing, plus a new regression test suite and README usage examples.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/sdk/test/alfredpayHandler.test.ts | Adds regression tests for Alfredpay handler behavior, routing, and update semantics. |
| packages/sdk/src/VortexSdk.ts | Routes USD/MXN/COP ramps to AlfredpayHandler for register/update flows. |
| packages/sdk/src/types.ts | Introduces Alfredpay quote/additional-data types and updates conditional type mappings. |
| packages/sdk/src/handlers/AlfredpayHandler.ts | Implements Alfredpay onramp/offramp register + offramp update flow (ephemerals + signing + update). |
| packages/sdk/src/errors.ts | Adds Alfredpay-specific error classes and API error parsing hooks. |
| packages/sdk/README.md | Documents Alfredpay onramp/offramp usage patterns for SDK consumers. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
69
to
+73
| export type ExtendedQuoteResponse<T extends CreateQuoteRequest> = T extends { rampType: RampDirection.BUY; from: "pix" } | ||
| ? BrlOnrampQuote | ||
| : T extends { rampType: RampDirection.BUY; from: "sepa" } | ||
| ? EurOnrampQuote | ||
| : T extends { rampType: RampDirection.SELL; to: "pix" } | ||
| ? BrlOfframpQuote | ||
| : T extends { rampType: RampDirection.SELL; to: "sepa" } | ||
| ? EurOfframpQuote | ||
| : AnyQuote; | ||
| : T extends { rampType: RampDirection.BUY; inputCurrency: AlfredpayCurrency } |
Comment on lines
+114
to
+118
| export interface AlfredpayOnrampAdditionalData { | ||
| destinationAddress: string; | ||
| fiatAccountId: string; | ||
| walletAddress?: string; | ||
| sessionId?: string; |
Comment on lines
+58
to
+61
| async registerAlfredpayOnramp(quoteId: string, additionalData: AlfredpayOnrampAdditionalData): Promise<RampProcess> { | ||
| if (!additionalData.destinationAddress || !additionalData.fiatAccountId) { | ||
| throw new MissingAlfredpayOnrampParametersError(); | ||
| } |
Comment on lines
+81
to
+85
| const result = await handler.registerAlfredpayOnramp("quote_1", { | ||
| destinationAddress: WALLET, | ||
| fiatAccountId: FIAT_ACCOUNT, | ||
| walletAddress: WALLET | ||
| }); |
Comment on lines
+148
to
+152
| export class MissingAlfredpayOnrampParametersError extends AlfredpayOnrampError { | ||
| constructor() { | ||
| super("Parameters destinationAddress and fiatAccountId are required for Alfredpay onramp", 400); | ||
| this.name = "MissingAlfredpayOnrampParametersError"; | ||
| } |
Comment on lines
+71
to
+75
| const { rampProcess } = await sdk.registerRamp(quote, { | ||
| destinationAddress: "0x1234567890123456789012345678901234567890", | ||
| fiatAccountId: "<the user's Alfredpay fiat account id>", | ||
| walletAddress: "0x1234567890123456789012345678901234567890" | ||
| }); |
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
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.
Previously the SDK only supported BRL on/off-ramps. This adds MXN and COP (and USD) support in both directions - onramp and offramp - using the BRL integration as the reference pattern.
Closes #1161.
What changed
Core feature (packages/sdk)
discriminated ExtendedQuoteResponse / RegisterRampAdditionalData / UpdateRampAdditionalData mappings.