Skip to content

feat(ramps): adds widget url to ramps controller state #7920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
georgeweiler merged 12 commits into from
Feb 13, 2026
+353 −6
Merged

feat(ramps): adds widget url to ramps controller state #7920

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
9d3c08f
feat: adds widget url to ramps controller state
georgeweiler Feb 12, 2026
b6fcca8
feat: adds widget url to ramps controller state
georgeweiler Feb 12, 2026
89c4565
chore: bugbot fixes
georgeweiler Feb 12, 2026
c47f08d
chore: 100 percent test coverage
georgeweiler Feb 12, 2026
784dfc2
feat: removes widget nonce
georgeweiler Feb 12, 2026
deda0e1
chore: bugbot fixes
georgeweiler Feb 12, 2026
c76d657
Merge branch 'main' of github.com:MetaMask/core into ramps-provider-w…
georgeweiler Feb 12, 2026
6fe8971
chore: small fixes
georgeweiler Feb 12, 2026
6d6b0e7
chore: rm unintentional file
georgeweiler Feb 12, 2026
4130395
chore: test lint
georgeweiler Feb 12, 2026
73d4ce4
chore: test lint
georgeweiler Feb 12, 2026
38a9cf6
chore: bugbot
georgeweiler Feb 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/ramps-controller/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Added

- Add `widgetUrl` resource state that automatically fetches and stores the buy widget URL whenever the selected quote changes ([#7920](https://github.com/MetaMask/core/pull/7920))

### Changed

- Refactor: Consolidate reset logic with a shared resetResource helper and fix abort handling for dependent resources ([#7818](https://github.com/MetaMask/core/pull/7818))
Expand Down
260 changes: 257 additions & 3 deletions packages/ramps-controller/src/RampsController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,12 @@ describe('RampsController', () => {
"selected": null,
},
"userRegion": null,
"widgetUrl": {
"data": null,
"error": null,
"isLoading": false,
"selected": null,
},
}
`);
});
Expand Down Expand Up @@ -158,6 +164,12 @@ describe('RampsController', () => {
"selected": null,
},
"userRegion": null,
"widgetUrl": {
"data": null,
"error": null,
"isLoading": false,
"selected": null,
},
}
`);
});
Expand Down Expand Up @@ -573,6 +585,12 @@ describe('RampsController', () => {
"selected": null,
},
"userRegion": null,
"widgetUrl": {
"data": null,
"error": null,
"isLoading": false,
"selected": null,
},
}
`);
});
Expand Down Expand Up @@ -694,6 +712,12 @@ describe('RampsController', () => {
"selected": null,
},
"userRegion": null,
"widgetUrl": {
"data": null,
"error": null,
"isLoading": false,
"selected": null,
},
}
`);
});
Expand Down Expand Up @@ -5812,6 +5836,229 @@ describe('RampsController', () => {
},
);
});

it('fetches widget URL when selecting a quote with buyURL', async () => {
await withController(async ({ controller, rootMessenger }) => {
const buyWidgetResponse = {
url: 'https://global.transak.com/?apiKey=test',
browser: 'APP_BROWSER' as const,
orderId: null,
};

rootMessenger.registerActionHandler(
'RampsService:getBuyWidgetUrl',
async () => buyWidgetResponse,
);

const quote: Quote = {
provider: '/providers/transak-staging',
quote: {
amountIn: 100,
amountOut: '0.05',
paymentMethod: '/payments/debit-credit-card',
buyURL:
'https://on-ramp.uat-api.cx.metamask.io/providers/transak-staging/buy-widget',
},
};

controller.setSelectedQuote(quote);

expect(controller.state.widgetUrl.isLoading).toBe(true);
expect(controller.state.widgetUrl.data).toBeNull();

await flushPromises();

expect(controller.state.widgetUrl.isLoading).toBe(false);
expect(controller.state.widgetUrl.data).toStrictEqual(
buyWidgetResponse,
);
expect(controller.state.widgetUrl.error).toBeNull();
});
});

it('resets widget URL when selecting a quote without buyURL', async () => {
await withController(({ controller }) => {
const quote: Quote = {
provider: '/providers/moonpay',
quote: {
amountIn: 100,
amountOut: '0.05',
paymentMethod: '/payments/debit-credit-card',
},
};

controller.setSelectedQuote(quote);

expect(controller.state.widgetUrl.isLoading).toBe(false);
expect(controller.state.widgetUrl.data).toBeNull();
expect(controller.state.widgetUrl.error).toBeNull();
});
});

it('resets widget URL when clearing the selected quote', async () => {
await withController(({ controller }) => {
controller.setSelectedQuote(null);

expect(controller.state.widgetUrl.isLoading).toBe(false);
expect(controller.state.widgetUrl.data).toBeNull();
expect(controller.state.widgetUrl.error).toBeNull();
});
});

it('sets widget URL error state when service call fails', async () => {
await withController(async ({ controller, rootMessenger }) => {
rootMessenger.registerActionHandler(
'RampsService:getBuyWidgetUrl',
async () => {
throw new Error('Network error');
},
);

const quote: Quote = {
provider: '/providers/transak-staging',
quote: {
amountIn: 100,
amountOut: '0.05',
paymentMethod: '/payments/debit-credit-card',
buyURL:
'https://on-ramp.uat-api.cx.metamask.io/providers/transak-staging/buy-widget',
},
};

controller.setSelectedQuote(quote);

expect(controller.state.widgetUrl.isLoading).toBe(true);

await flushPromises();

expect(controller.state.widgetUrl.isLoading).toBe(false);
expect(controller.state.widgetUrl.data).toBeNull();
expect(controller.state.widgetUrl.error).toBe('Network error');
});
});

it('sets fallback widget URL error when service throws a non-Error', async () => {
await withController(async ({ controller, rootMessenger }) => {
rootMessenger.registerActionHandler(
'RampsService:getBuyWidgetUrl',
async () => {
// eslint-disable-next-line @typescript-eslint/only-throw-error
throw 'unexpected failure';
},
);

const quote: Quote = {
provider: '/providers/transak-staging',
quote: {
amountIn: 100,
amountOut: '0.05',
paymentMethod: '/payments/debit-credit-card',
buyURL:
'https://on-ramp.uat-api.cx.metamask.io/providers/transak-staging/buy-widget',
},
};

controller.setSelectedQuote(quote);

await flushPromises();

expect(controller.state.widgetUrl.isLoading).toBe(false);
expect(controller.state.widgetUrl.data).toBeNull();
expect(controller.state.widgetUrl.error).toBe(
'Failed to fetch widget URL',
);
});
});

it('does not reset widget URL to loading when data already exists', async () => {
await withController(async ({ controller, rootMessenger }) => {
const buyWidgetResponse = {
url: 'https://global.transak.com/?apiKey=test',
browser: 'APP_BROWSER' as const,
orderId: null,
};

rootMessenger.registerActionHandler(
'RampsService:getBuyWidgetUrl',
async () => buyWidgetResponse,
);

const quote: Quote = {
provider: '/providers/transak-staging',
quote: {
amountIn: 100,
amountOut: '0.05',
paymentMethod: '/payments/debit-credit-card',
buyURL:
'https://on-ramp.uat-api.cx.metamask.io/providers/transak-staging/buy-widget',
},
};

controller.setSelectedQuote(quote);
await flushPromises();

expect(controller.state.widgetUrl.data).toStrictEqual(
buyWidgetResponse,
);

controller.setSelectedQuote(quote);

expect(controller.state.widgetUrl.isLoading).toBe(false);
expect(controller.state.widgetUrl.data).toStrictEqual(
buyWidgetResponse,
);
});
});

it('preserves existing widget URL data when a revalidation request fails', async () => {
await withController(async ({ controller, rootMessenger }) => {
const buyWidgetResponse = {
url: 'https://global.transak.com/?apiKey=test',
browser: 'APP_BROWSER' as const,
orderId: null,
};

let shouldFail = false;

rootMessenger.registerActionHandler(
'RampsService:getBuyWidgetUrl',
async () => {
if (shouldFail) {
throw new Error('Network error');
}
return buyWidgetResponse;
},
);

const quote: Quote = {
provider: '/providers/transak-staging',
quote: {
amountIn: 100,
amountOut: '0.05',
paymentMethod: '/payments/debit-credit-card',
buyURL:
'https://on-ramp.uat-api.cx.metamask.io/providers/transak-staging/buy-widget',
},
};

controller.setSelectedQuote(quote);
await flushPromises();

expect(controller.state.widgetUrl.data).toStrictEqual(
buyWidgetResponse,
);

shouldFail = true;
controller.setSelectedQuote(quote);
await flushPromises();

expect(controller.state.widgetUrl.isLoading).toBe(false);
expect(controller.state.widgetUrl.data).toStrictEqual(
buyWidgetResponse,
);
expect(controller.state.widgetUrl.error).toBe('Network error');
});
});
});

describe('polling restart on dependency changes', () => {
Expand Down Expand Up @@ -6043,9 +6290,7 @@ describe('RampsController', () => {

// Advance time - polling should not fire
jest.advanceTimersByTime(30000);
for (let i = 0; i < 10; i++) {
await Promise.resolve();
}
await flushPromises();

// Call count should still be 1
expect(callCount).toBe(1);
Expand Down Expand Up @@ -6364,3 +6609,12 @@ async function withController<ReturnValue>(
});
return await testFunction({ controller, rootMessenger, messenger });
}

/**
* Flushes pending microtasks by yielding to the event loop multiple times.
*/
async function flushPromises(): Promise<void> {
for (let i = 0; i < 10; i++) {
await Promise.resolve();
}
}
Loading
Loading