@metamask/ramps-controller 5.1.0 → 7.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +20 -12
- package/dist/RampsController.cjs +362 -181
- package/dist/RampsController.cjs.map +1 -1
- package/dist/RampsController.d.cts +82 -101
- package/dist/RampsController.d.cts.map +1 -1
- package/dist/RampsController.d.mts +82 -101
- package/dist/RampsController.d.mts.map +1 -1
- package/dist/RampsController.mjs +361 -180
- package/dist/RampsController.mjs.map +1 -1
- package/dist/RampsService.cjs +1 -1
- package/dist/RampsService.cjs.map +1 -1
- package/dist/RampsService.d.cts +2 -2
- package/dist/RampsService.d.cts.map +1 -1
- package/dist/RampsService.d.mts +2 -2
- package/dist/RampsService.d.mts.map +1 -1
- package/dist/RampsService.mjs +1 -1
- package/dist/RampsService.mjs.map +1 -1
- package/dist/RequestCache.cjs.map +1 -1
- package/dist/RequestCache.d.cts +11 -0
- package/dist/RequestCache.d.cts.map +1 -1
- package/dist/RequestCache.d.mts +11 -0
- package/dist/RequestCache.d.mts.map +1 -1
- package/dist/RequestCache.mjs.map +1 -1
- package/dist/index.cjs +2 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +4 -4
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.mts +4 -4
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RampsController.d.cts","sourceRoot":"","sources":["../src/RampsController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAGrD,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,QAAQ,EACR,KAAK,EACL,UAAU,EACV,aAAa,EACb,sBAAsB,EACtB,cAAc,EACd,KAAK,EAEL,UAAU,
|
|
1
|
+
{"version":3,"file":"RampsController.d.cts","sourceRoot":"","sources":["../src/RampsController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAGrD,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,QAAQ,EACR,KAAK,EACL,UAAU,EACV,aAAa,EACb,sBAAsB,EACtB,cAAc,EACd,KAAK,EAEL,UAAU,EACV,mBAAmB,EACpB,2BAAuB;AACxB,OAAO,KAAK,EACV,gCAAgC,EAChC,8BAA8B,EAC9B,2BAA2B,EAC3B,8BAA8B,EAC9B,mCAAmC,EACnC,2BAA2B,EAC5B,+CAA2C;AAC5C,OAAO,KAAK,EACV,YAAY,IAAI,gBAAgB,EAChC,YAAY,EACZ,qBAAqB,EAGtB,2BAAuB;AAcxB;;;;GAIG;AACH,eAAO,MAAM,cAAc,oBAAoB,CAAC;AAEhD;;;;GAIG;AACH,eAAO,MAAM,yCAAyC,EAAE,SAAS,mBAAmB,CAAC,MAAM,CAAC,EAQzF,CAAC;AAUJ;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,IAAI;IACnD;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IACZ;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;IACpB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;OAGG;IACH,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;IAC9B;;;OAGG;IACH,SAAS,EAAE,aAAa,CAAC,OAAO,EAAE,CAAC,CAAC;IACpC;;;OAGG;IACH,SAAS,EAAE,aAAa,CAAC,QAAQ,EAAE,EAAE,QAAQ,GAAG,IAAI,CAAC,CAAC;IACtD;;;OAGG;IACH,MAAM,EAAE,aAAa,CAAC,cAAc,GAAG,IAAI,EAAE,UAAU,GAAG,IAAI,CAAC,CAAC;IAChE;;;OAGG;IACH,cAAc,EAAE,aAAa,CAAC,aAAa,EAAE,EAAE,aAAa,GAAG,IAAI,CAAC,CAAC;IACrE;;;;OAIG;IACH,MAAM,EAAE,aAAa,CAAC,cAAc,GAAG,IAAI,EAAE,KAAK,GAAG,IAAI,CAAC,CAAC;IAC3D;;;OAGG;IACH,QAAQ,EAAE,gBAAgB,CAAC;CAC5B,CAAC;AAuEF;;;;;;;GAOG;AACH,wBAAgB,8BAA8B,IAAI,oBAAoB,CAsBrE;AAqCD;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,wBAAwB,CAClE,OAAO,cAAc,EACrB,oBAAoB,CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,6BAA6B,CAAC;AAEnE;;GAEG;AACH,KAAK,cAAc,GACf,gCAAgC,GAChC,8BAA8B,GAC9B,2BAA2B,GAC3B,8BAA8B,GAC9B,mCAAmC,GACnC,2BAA2B,CAAC;AAEhC;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG,0BAA0B,CACtE,OAAO,cAAc,EACrB,oBAAoB,CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,+BAA+B,CAAC;AAEpE;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,SAAS,CAC9C,OAAO,cAAc,EACrB,sBAAsB,GAAG,cAAc,EACvC,qBAAqB,GAAG,aAAa,CACtC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,gDAAgD;IAChD,SAAS,EAAE,wBAAwB,CAAC;IACpC,kEAAkE;IAClE,KAAK,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACtC,gFAAgF;IAChF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,uEAAuE;IACvE,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC;AAoEF;;GAEG;AACH,qBAAa,eAAgB,SAAQ,cAAc,CACjD,OAAO,cAAc,EACrB,oBAAoB,EACpB,wBAAwB,CACzB;;IAuCC;;;;;OAKG;IACH,gCAAgC,IAAI,IAAI;IAgBxC;;;;;;;;;OASG;gBACS,EACV,SAAS,EACT,KAAU,EACV,eAA2C,EAC3C,mBAAoD,GACrD,EAAE,sBAAsB;IAiBzB;;;;;;;;;;;OAWG;IACG,cAAc,CAAC,OAAO,EAC1B,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,OAAO,CAAC,EAClD,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,OAAO,CAAC;IA8GnB;;;;;OAKG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IA0GvC;;;;;OAKG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAyD3D;;;;;;;OAOG;IACG,aAAa,CACjB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,UAAU,CAAC;IAkEtB;;;;;;;OAOG;IACH,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAgDpD;;;;;;;;;OASG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAe1D,YAAY,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI;IAYnD;;;;;;;OAOG;IACG,YAAY,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAkBvE;;;;;;;;;OASG;IACG,SAAS,CACb,MAAM,CAAC,EAAE,MAAM,EACf,MAAM,GAAE,UAAkB,EAC1B,OAAO,CAAC,EAAE,qBAAqB,GAAG;QAChC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;KAC9B,GACA,OAAO,CAAC,cAAc,CAAC;IAgD1B;;;;;;;OAOG;IACH,gBAAgB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;IAqDxC;;;;;;;;;;;OAWG;IACG,YAAY,CAChB,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,qBAAqB,GAAG;QAChC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QAC7B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QAC3B,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;KAC9B,GACA,OAAO,CAAC;QAAE,SAAS,EAAE,QAAQ,EAAE,CAAA;KAAE,CAAC;IAoDrC;;;;;;;;;;OAUG;IACG,iBAAiB,CACrB,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,qBAAqB,GAAG;QAChC,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,GACA,OAAO,CAAC,sBAAsB,CAAC;IAkFlC;;;;;;OAMG;IACH,wBAAwB,CAAC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI;IAgCxD;;;;;;;;;;;;;;;;;OAiBG;IACG,SAAS,CAAC,OAAO,EAAE;QACvB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,aAAa,EAAE,MAAM,CAAC;QACtB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;QAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,CAAC,EAAE,UAAU,CAAC;QACpB,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB,GAAG,CAAC,EAAE,MAAM,CAAC;KACd,GAAG,OAAO,CAAC,cAAc,CAAC;IA6F3B;;;;;;;;;;;OAWG;IACH,iBAAiB,CAAC,OAAO,EAAE;QACzB,aAAa,EAAE,MAAM,CAAC;QACtB,MAAM,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,GAAG,IAAI;IAgFR;;;OAGG;IACH,gBAAgB,IAAI,IAAI;IAQxB;;;;OAIG;IACH,gBAAgB,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,GAAG,IAAI;IAM3C;;;;OAIG;IACM,OAAO,IAAI,IAAI;IAKxB;;;;;;OAMG;IACH,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI;CAG1C"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
|
|
2
2
|
import { BaseController } from "@metamask/base-controller";
|
|
3
3
|
import type { Messenger } from "@metamask/messenger";
|
|
4
|
-
import type { Country, TokensResponse, Provider, State, RampAction, PaymentMethod, PaymentMethodsResponse, QuotesResponse, Quote, RampsToken } from "./RampsService.mjs";
|
|
4
|
+
import type { Country, TokensResponse, Provider, State, RampAction, PaymentMethod, PaymentMethodsResponse, QuotesResponse, Quote, RampsToken, RampsServiceActions } from "./RampsService.mjs";
|
|
5
5
|
import type { RampsServiceGetGeolocationAction, RampsServiceGetCountriesAction, RampsServiceGetTokensAction, RampsServiceGetProvidersAction, RampsServiceGetPaymentMethodsAction, RampsServiceGetQuotesAction } from "./RampsService-method-action-types.mjs";
|
|
6
6
|
import type { RequestCache as RequestCacheType, RequestState, ExecuteRequestOptions } from "./RequestCache.mjs";
|
|
7
7
|
/**
|
|
@@ -10,6 +10,12 @@ import type { RequestCache as RequestCacheType, RequestState, ExecuteRequestOpti
|
|
|
10
10
|
* when composed with other controllers.
|
|
11
11
|
*/
|
|
12
12
|
export declare const controllerName = "RampsController";
|
|
13
|
+
/**
|
|
14
|
+
* RampsService action types that RampsController calls via the messenger.
|
|
15
|
+
* Any host (e.g. mobile) that creates a RampsController messenger must delegate
|
|
16
|
+
* these actions from the root messenger so the controller can function.
|
|
17
|
+
*/
|
|
18
|
+
export declare const RAMPS_CONTROLLER_REQUIRED_SERVICE_ACTIONS: readonly RampsServiceActions['type'][];
|
|
13
19
|
/**
|
|
14
20
|
* Represents the user's selected region with full country and state objects.
|
|
15
21
|
*/
|
|
@@ -28,54 +34,64 @@ export type UserRegion = {
|
|
|
28
34
|
regionCode: string;
|
|
29
35
|
};
|
|
30
36
|
/**
|
|
31
|
-
*
|
|
37
|
+
* Generic type for resource state that bundles data with loading/error states.
|
|
38
|
+
*
|
|
39
|
+
* @template TData - The type of the resource data
|
|
40
|
+
* @template TSelected - The type of the selected item (defaults to null for resources without selection)
|
|
32
41
|
*/
|
|
33
|
-
export type
|
|
42
|
+
export type ResourceState<TData, TSelected = null> = {
|
|
34
43
|
/**
|
|
35
|
-
* The
|
|
36
|
-
* Initially set via geolocation fetch, but can be manually changed by the user.
|
|
37
|
-
* Once set (either via geolocation or manual selection), it will not be overwritten
|
|
38
|
-
* by subsequent geolocation fetches.
|
|
44
|
+
* The resource data.
|
|
39
45
|
*/
|
|
40
|
-
|
|
46
|
+
data: TData;
|
|
47
|
+
/**
|
|
48
|
+
* The currently selected item, or null if none selected.
|
|
49
|
+
*/
|
|
50
|
+
selected: TSelected;
|
|
41
51
|
/**
|
|
42
|
-
*
|
|
43
|
-
* Can be manually set by the user.
|
|
52
|
+
* Whether the resource is currently being fetched.
|
|
44
53
|
*/
|
|
45
|
-
|
|
54
|
+
isLoading: boolean;
|
|
46
55
|
/**
|
|
47
|
-
*
|
|
56
|
+
* Error message if the fetch failed, or null.
|
|
48
57
|
*/
|
|
49
|
-
|
|
58
|
+
error: string | null;
|
|
59
|
+
};
|
|
60
|
+
/**
|
|
61
|
+
* Describes the shape of the state object for {@link RampsController}.
|
|
62
|
+
*/
|
|
63
|
+
export type RampsControllerState = {
|
|
50
64
|
/**
|
|
51
|
-
*
|
|
65
|
+
* The user's region (full country and state objects).
|
|
66
|
+
* Initially set via geolocation fetch, but can be manually changed by the user.
|
|
52
67
|
*/
|
|
53
|
-
|
|
68
|
+
userRegion: UserRegion | null;
|
|
54
69
|
/**
|
|
55
|
-
*
|
|
56
|
-
*
|
|
70
|
+
* Countries resource state with data, loading, and error.
|
|
71
|
+
* Data contains the list of countries available for ramp actions.
|
|
57
72
|
*/
|
|
58
|
-
|
|
73
|
+
countries: ResourceState<Country[]>;
|
|
59
74
|
/**
|
|
60
|
-
*
|
|
61
|
-
*
|
|
75
|
+
* Providers resource state with data, selected, loading, and error.
|
|
76
|
+
* Data contains the list of providers available for the current region.
|
|
62
77
|
*/
|
|
63
|
-
|
|
78
|
+
providers: ResourceState<Provider[], Provider | null>;
|
|
64
79
|
/**
|
|
65
|
-
*
|
|
66
|
-
*
|
|
80
|
+
* Tokens resource state with data, selected, loading, and error.
|
|
81
|
+
* Data contains topTokens and allTokens arrays.
|
|
67
82
|
*/
|
|
68
|
-
|
|
83
|
+
tokens: ResourceState<TokensResponse | null, RampsToken | null>;
|
|
69
84
|
/**
|
|
70
|
-
*
|
|
71
|
-
*
|
|
85
|
+
* Payment methods resource state with data, selected, loading, and error.
|
|
86
|
+
* Data contains payment methods filtered by region, fiat, asset, and provider.
|
|
72
87
|
*/
|
|
73
|
-
|
|
88
|
+
paymentMethods: ResourceState<PaymentMethod[], PaymentMethod | null>;
|
|
74
89
|
/**
|
|
75
|
-
* Quotes
|
|
76
|
-
*
|
|
90
|
+
* Quotes resource state with data, selected, loading, and error.
|
|
91
|
+
* Data contains quotes from multiple providers for the given parameters.
|
|
92
|
+
* Selected contains the currently selected quote for the user.
|
|
77
93
|
*/
|
|
78
|
-
quotes: QuotesResponse | null
|
|
94
|
+
quotes: ResourceState<QuotesResponse | null, Quote | null>;
|
|
79
95
|
/**
|
|
80
96
|
* Cache of request states, keyed by cache key.
|
|
81
97
|
* This stores loading, success, and error states for API requests.
|
|
@@ -138,6 +154,13 @@ export type RampsControllerOptions = {
|
|
|
138
154
|
*/
|
|
139
155
|
export declare class RampsController extends BaseController<typeof controllerName, RampsControllerState, RampsControllerMessenger> {
|
|
140
156
|
#private;
|
|
157
|
+
/**
|
|
158
|
+
* Clears the pending resource count map. Used only in tests to exercise the
|
|
159
|
+
* defensive path when get() returns undefined in the finally block.
|
|
160
|
+
*
|
|
161
|
+
* @internal
|
|
162
|
+
*/
|
|
163
|
+
clearPendingResourceCountForTest(): void;
|
|
141
164
|
/**
|
|
142
165
|
* Constructs a new {@link RampsController}.
|
|
143
166
|
*
|
|
@@ -313,89 +336,47 @@ export declare class RampsController extends BaseController<typeof controllerNam
|
|
|
313
336
|
ttl?: number;
|
|
314
337
|
}): Promise<QuotesResponse>;
|
|
315
338
|
/**
|
|
316
|
-
*
|
|
317
|
-
*
|
|
339
|
+
* Starts automatic quote polling with a 15-second refresh interval.
|
|
340
|
+
* Fetches quotes immediately and then every 15 seconds.
|
|
341
|
+
* If the response contains exactly one quote, it is auto-selected.
|
|
342
|
+
* If multiple quotes are returned, the existing selection is preserved if still valid.
|
|
318
343
|
*
|
|
319
|
-
* @param
|
|
320
|
-
* @
|
|
344
|
+
* @param options - Parameters for fetching quotes.
|
|
345
|
+
* @param options.walletAddress - The destination wallet address.
|
|
346
|
+
* @param options.amount - The amount (in fiat for buy, crypto for sell).
|
|
347
|
+
* @param options.redirectUrl - Optional redirect URL after order completion.
|
|
348
|
+
* @throws If required dependencies (region, token, provider, payment method) are not set.
|
|
321
349
|
*/
|
|
322
|
-
|
|
350
|
+
startQuotePolling(options: {
|
|
351
|
+
walletAddress: string;
|
|
352
|
+
amount: number;
|
|
353
|
+
redirectUrl?: string;
|
|
354
|
+
}): void;
|
|
323
355
|
/**
|
|
324
|
-
*
|
|
325
|
-
*
|
|
326
|
-
* @param region - The region code to set (e.g., "US-CA").
|
|
327
|
-
* @param options - Options for cache behavior.
|
|
356
|
+
* Stops automatic quote polling.
|
|
357
|
+
* Does not clear quotes data or selection, only stops the interval.
|
|
328
358
|
*/
|
|
329
|
-
|
|
359
|
+
stopQuotePolling(): void;
|
|
330
360
|
/**
|
|
331
|
-
*
|
|
361
|
+
* Manually sets the selected quote.
|
|
332
362
|
*
|
|
333
|
-
* @param
|
|
363
|
+
* @param quote - The quote to select, or null to clear the selection.
|
|
334
364
|
*/
|
|
335
|
-
|
|
365
|
+
setSelectedQuote(quote: Quote | null): void;
|
|
336
366
|
/**
|
|
337
|
-
*
|
|
338
|
-
*
|
|
339
|
-
*
|
|
340
|
-
* @param action - The ramp action type ('buy' or 'sell').
|
|
341
|
-
* @param options - Options for cache behavior.
|
|
367
|
+
* Cleans up controller resources.
|
|
368
|
+
* Stops any active quote polling to prevent memory leaks.
|
|
369
|
+
* Should be called when the controller is no longer needed.
|
|
342
370
|
*/
|
|
343
|
-
|
|
371
|
+
destroy(): void;
|
|
344
372
|
/**
|
|
345
|
-
*
|
|
346
|
-
*
|
|
347
|
-
* @param region - The region code. If not provided, uses userRegion from state.
|
|
348
|
-
* @param options - Options for cache behavior and query filters.
|
|
349
|
-
*/
|
|
350
|
-
triggerGetProviders(region?: string, options?: ExecuteRequestOptions & {
|
|
351
|
-
provider?: string | string[];
|
|
352
|
-
crypto?: string | string[];
|
|
353
|
-
fiat?: string | string[];
|
|
354
|
-
payments?: string | string[];
|
|
355
|
-
}): void;
|
|
356
|
-
/**
|
|
357
|
-
* Triggers fetching payment methods without throwing.
|
|
358
|
-
*
|
|
359
|
-
* @param region - User's region code (e.g., "us", "fr", "us-ny").
|
|
360
|
-
* @param options - Query parameters for filtering payment methods.
|
|
361
|
-
* @param options.fiat - Fiat currency code. If not provided, uses userRegion currency.
|
|
362
|
-
* @param options.assetId - CAIP-19 cryptocurrency identifier.
|
|
363
|
-
* @param options.provider - Provider ID path.
|
|
364
|
-
*/
|
|
365
|
-
triggerGetPaymentMethods(region?: string, options?: ExecuteRequestOptions & {
|
|
366
|
-
fiat?: string;
|
|
367
|
-
assetId?: string;
|
|
368
|
-
provider?: string;
|
|
369
|
-
}): void;
|
|
370
|
-
/**
|
|
371
|
-
* Triggers fetching quotes without throwing.
|
|
373
|
+
* Extracts the widget URL from a quote for redirect providers.
|
|
374
|
+
* Returns the widget URL if available, or null if the quote doesn't have one.
|
|
372
375
|
*
|
|
373
|
-
* @param
|
|
374
|
-
* @
|
|
375
|
-
* @param options.fiat - Fiat currency code. If not provided, uses userRegion currency.
|
|
376
|
-
* @param options.assetId - CAIP-19 cryptocurrency identifier.
|
|
377
|
-
* @param options.amount - The amount (in fiat for buy, crypto for sell).
|
|
378
|
-
* @param options.walletAddress - The destination wallet address.
|
|
379
|
-
* @param options.paymentMethods - Array of payment method IDs. If not provided, uses paymentMethods from state.
|
|
380
|
-
* @param options.provider - Optional provider ID to filter quotes.
|
|
381
|
-
* @param options.redirectUrl - Optional redirect URL after order completion.
|
|
382
|
-
* @param options.action - The ramp action type. Defaults to 'buy'.
|
|
383
|
-
* @param options.forceRefresh - Whether to bypass cache.
|
|
384
|
-
* @param options.ttl - Custom TTL for this request.
|
|
376
|
+
* @param quote - The quote to extract the widget URL from.
|
|
377
|
+
* @returns The widget URL string, or null if not available.
|
|
385
378
|
*/
|
|
386
|
-
|
|
387
|
-
region?: string;
|
|
388
|
-
fiat?: string;
|
|
389
|
-
assetId: string;
|
|
390
|
-
amount: number;
|
|
391
|
-
walletAddress: string;
|
|
392
|
-
paymentMethods?: string[];
|
|
393
|
-
provider?: string;
|
|
394
|
-
redirectUrl?: string;
|
|
395
|
-
action?: RampAction;
|
|
396
|
-
forceRefresh?: boolean;
|
|
397
|
-
ttl?: number;
|
|
398
|
-
}): void;
|
|
379
|
+
getWidgetUrl(quote: Quote): string | null;
|
|
399
380
|
}
|
|
400
381
|
export {};
|
|
401
382
|
//# sourceMappingURL=RampsController.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RampsController.d.mts","sourceRoot":"","sources":["../src/RampsController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAGrD,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,QAAQ,EACR,KAAK,EACL,UAAU,EACV,aAAa,EACb,sBAAsB,EACtB,cAAc,EACd,KAAK,EAEL,UAAU,
|
|
1
|
+
{"version":3,"file":"RampsController.d.mts","sourceRoot":"","sources":["../src/RampsController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAGrD,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,QAAQ,EACR,KAAK,EACL,UAAU,EACV,aAAa,EACb,sBAAsB,EACtB,cAAc,EACd,KAAK,EAEL,UAAU,EACV,mBAAmB,EACpB,2BAAuB;AACxB,OAAO,KAAK,EACV,gCAAgC,EAChC,8BAA8B,EAC9B,2BAA2B,EAC3B,8BAA8B,EAC9B,mCAAmC,EACnC,2BAA2B,EAC5B,+CAA2C;AAC5C,OAAO,KAAK,EACV,YAAY,IAAI,gBAAgB,EAChC,YAAY,EACZ,qBAAqB,EAGtB,2BAAuB;AAcxB;;;;GAIG;AACH,eAAO,MAAM,cAAc,oBAAoB,CAAC;AAEhD;;;;GAIG;AACH,eAAO,MAAM,yCAAyC,EAAE,SAAS,mBAAmB,CAAC,MAAM,CAAC,EAQzF,CAAC;AAUJ;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,IAAI;IACnD;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IACZ;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;IACpB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;OAGG;IACH,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;IAC9B;;;OAGG;IACH,SAAS,EAAE,aAAa,CAAC,OAAO,EAAE,CAAC,CAAC;IACpC;;;OAGG;IACH,SAAS,EAAE,aAAa,CAAC,QAAQ,EAAE,EAAE,QAAQ,GAAG,IAAI,CAAC,CAAC;IACtD;;;OAGG;IACH,MAAM,EAAE,aAAa,CAAC,cAAc,GAAG,IAAI,EAAE,UAAU,GAAG,IAAI,CAAC,CAAC;IAChE;;;OAGG;IACH,cAAc,EAAE,aAAa,CAAC,aAAa,EAAE,EAAE,aAAa,GAAG,IAAI,CAAC,CAAC;IACrE;;;;OAIG;IACH,MAAM,EAAE,aAAa,CAAC,cAAc,GAAG,IAAI,EAAE,KAAK,GAAG,IAAI,CAAC,CAAC;IAC3D;;;OAGG;IACH,QAAQ,EAAE,gBAAgB,CAAC;CAC5B,CAAC;AAuEF;;;;;;;GAOG;AACH,wBAAgB,8BAA8B,IAAI,oBAAoB,CAsBrE;AAqCD;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,wBAAwB,CAClE,OAAO,cAAc,EACrB,oBAAoB,CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,6BAA6B,CAAC;AAEnE;;GAEG;AACH,KAAK,cAAc,GACf,gCAAgC,GAChC,8BAA8B,GAC9B,2BAA2B,GAC3B,8BAA8B,GAC9B,mCAAmC,GACnC,2BAA2B,CAAC;AAEhC;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG,0BAA0B,CACtE,OAAO,cAAc,EACrB,oBAAoB,CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,+BAA+B,CAAC;AAEpE;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,SAAS,CAC9C,OAAO,cAAc,EACrB,sBAAsB,GAAG,cAAc,EACvC,qBAAqB,GAAG,aAAa,CACtC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,gDAAgD;IAChD,SAAS,EAAE,wBAAwB,CAAC;IACpC,kEAAkE;IAClE,KAAK,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACtC,gFAAgF;IAChF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,uEAAuE;IACvE,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC;AAoEF;;GAEG;AACH,qBAAa,eAAgB,SAAQ,cAAc,CACjD,OAAO,cAAc,EACrB,oBAAoB,EACpB,wBAAwB,CACzB;;IAuCC;;;;;OAKG;IACH,gCAAgC,IAAI,IAAI;IAgBxC;;;;;;;;;OASG;gBACS,EACV,SAAS,EACT,KAAU,EACV,eAA2C,EAC3C,mBAAoD,GACrD,EAAE,sBAAsB;IAiBzB;;;;;;;;;;;OAWG;IACG,cAAc,CAAC,OAAO,EAC1B,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,OAAO,CAAC,EAClD,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,OAAO,CAAC;IA8GnB;;;;;OAKG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IA0GvC;;;;;OAKG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAyD3D;;;;;;;OAOG;IACG,aAAa,CACjB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,UAAU,CAAC;IAkEtB;;;;;;;OAOG;IACH,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAgDpD;;;;;;;;;OASG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAe1D,YAAY,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI;IAYnD;;;;;;;OAOG;IACG,YAAY,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAkBvE;;;;;;;;;OASG;IACG,SAAS,CACb,MAAM,CAAC,EAAE,MAAM,EACf,MAAM,GAAE,UAAkB,EAC1B,OAAO,CAAC,EAAE,qBAAqB,GAAG;QAChC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;KAC9B,GACA,OAAO,CAAC,cAAc,CAAC;IAgD1B;;;;;;;OAOG;IACH,gBAAgB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;IAqDxC;;;;;;;;;;;OAWG;IACG,YAAY,CAChB,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,qBAAqB,GAAG;QAChC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QAC7B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QAC3B,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;KAC9B,GACA,OAAO,CAAC;QAAE,SAAS,EAAE,QAAQ,EAAE,CAAA;KAAE,CAAC;IAoDrC;;;;;;;;;;OAUG;IACG,iBAAiB,CACrB,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,qBAAqB,GAAG;QAChC,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,GACA,OAAO,CAAC,sBAAsB,CAAC;IAkFlC;;;;;;OAMG;IACH,wBAAwB,CAAC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI;IAgCxD;;;;;;;;;;;;;;;;;OAiBG;IACG,SAAS,CAAC,OAAO,EAAE;QACvB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,aAAa,EAAE,MAAM,CAAC;QACtB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;QAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,CAAC,EAAE,UAAU,CAAC;QACpB,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB,GAAG,CAAC,EAAE,MAAM,CAAC;KACd,GAAG,OAAO,CAAC,cAAc,CAAC;IA6F3B;;;;;;;;;;;OAWG;IACH,iBAAiB,CAAC,OAAO,EAAE;QACzB,aAAa,EAAE,MAAM,CAAC;QACtB,MAAM,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,GAAG,IAAI;IAgFR;;;OAGG;IACH,gBAAgB,IAAI,IAAI;IAQxB;;;;OAIG;IACH,gBAAgB,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,GAAG,IAAI;IAM3C;;;;OAIG;IACM,OAAO,IAAI,IAAI;IAKxB;;;;;;OAMG;IACH,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI;CAG1C"}
|