@metamask/ramps-controller 20.3.0 → 21.0.0

package/dist/RampsService-method-action-types.d.mts

@@ -1,171 +0,0 @@
-/**
- * This file is auto generated.
- * Do not edit manually.
- */
-import type { RampsService } from "./RampsService.mjs";
-/**
- * Returns the default redirect ("fake callback") URL for this service's
- * environment.
- *
- * The quotes API only embeds a `buyURL`/`buyWidget` (the WebView page a
- * non-native provider needs) when a `redirectUrl` is present, so callers
- * that omit one (MM Pay's widened Headless Buy fetch) use this value.
- * Exposing it here makes the service's environment the single runtime source
- * of truth, so the callback can never point at a different environment than
- * the one the quotes themselves came from.
- *
- * `baseUrlOverride` deliberately does not apply. That option overrides the
- * ramps API base URL for local development. In production and staging the
- * callback lives on a different host (`on-ramp-content` versus
- * `on-ramp{-cache}`), so an API override says nothing about where
- * `/regions/fake-callback` lives. In development the callback already shares
- * the API host family (`on-ramp.dev-api`). The redirect URL is also handed
- * to the provider and matched by client UI to detect flow completion, so
- * returning an unrelated local API origin here would break completion
- * detection rather than help it. Point `environment` at
- * {@link RampsEnvironment.Local} for a localhost callback, noting that URL
- * is pinned to `http://localhost:3000` and does not follow a non-3000
- * `baseUrlOverride`.
- *
- * @returns The default redirect callback URL for the configured environment.
- */
-export type RampsServiceGetDefaultRedirectCallbackUrlAction = {
-    type: `RampsService:getDefaultRedirectCallbackUrl`;
-    handler: RampsService['getDefaultRedirectCallbackUrl'];
-};
-/**
- * Makes a request to the API in order to retrieve the user's geolocation
- * based on their IP address.
- *
- * @returns The user's country/region code (e.g., "US-UT" for Utah, USA).
- */
-export type RampsServiceGetGeolocationAction = {
-    type: `RampsService:getGeolocation`;
-    handler: RampsService['getGeolocation'];
-};
-/**
- * Makes a request to the cached API to retrieve the list of supported countries.
- * The API returns countries with support information for both buy and sell actions.
- * Filters countries based on aggregator support (preserves OnRampSDK logic).
- *
- * @returns An array of countries filtered by aggregator support.
- */
-export type RampsServiceGetCountriesAction = {
-    type: `RampsService:getCountries`;
-    handler: RampsService['getCountries'];
-};
-/**
- * Fetches the list of available tokens for a given region and action.
- * Supports optional provider filter.
- *
- * @param region - The region code (e.g., "us", "fr", "us-ny").
- * @param action - The ramp action type ('buy' or 'sell').
- * @param options - Optional query parameters for filtering tokens.
- * @param options.provider - Provider ID(s) to filter by.
- * @returns The tokens response containing topTokens and allTokens.
- */
-export type RampsServiceGetTokensAction = {
-    type: `RampsService:getTokens`;
-    handler: RampsService['getTokens'];
-};
-/**
- * Fetches the list of providers for a given region.
- * Supports optional query filters: provider, crypto, payments.
- * Region local fiat filtering is applied server-side when `fiat` is omitted.
- *
- * @param regionCode - The region code (e.g., "us", "fr", "us-ny").
- * @param options - Optional query parameters for filtering providers.
- * @param options.provider - Provider ID(s) to filter by.
- * @param options.crypto - Crypto currency ID(s) to filter by.
- * @param options.payments - Payment method ID(s) to filter by.
- * @returns The providers response containing providers array.
- */
-export type RampsServiceGetProvidersAction = {
-    type: `RampsService:getProviders`;
-    handler: RampsService['getProviders'];
-};
-/**
- * Fetches the list of payment methods for a given region, asset, and provider.
- *
- * Region local fiat filtering is applied server-side when `fiat` is omitted.
- *
- * @param options - Query parameters for filtering payment methods.
- * @param options.region - User's region code (e.g., "us-al").
- * @param options.assetId - CAIP-19 cryptocurrency identifier.
- * @param options.provider - Provider ID path.
- * @returns The payment methods response containing payments array.
- */
-export type RampsServiceGetPaymentMethodsAction = {
-    type: `RampsService:getPaymentMethods`;
-    handler: RampsService['getPaymentMethods'];
-};
-/**
- * Fetches quotes from all providers for a given set of parameters.
- * Uses the V2 orders API to get quotes for multiple payment methods at once.
- *
- * @param params - The parameters for fetching quotes.
- * @param params.region - User's region code (e.g., "us", "us-ca").
- * @param params.paymentMethods - Array of payment method IDs.
- * @param params.assetId - CAIP-19 cryptocurrency identifier.
- * @param params.fiat - Fiat currency code (e.g., "usd").
- * @param params.amount - The amount (in fiat for buy, crypto for sell).
- * @param params.walletAddress - The destination wallet address.
- * @param params.redirectUrl - Optional redirect URL after order completion.
- * @param params.providers - Optional provider IDs to filter quotes.
- * @param params.action - The ramp action type. Defaults to 'buy'.
- * @returns The quotes response containing success, sorted, error, and customActions.
- */
-export type RampsServiceGetQuotesAction = {
-    type: `RampsService:getQuotes`;
-    handler: RampsService['getQuotes'];
-};
-/**
- * Fetches the buy widget data from a buy URL endpoint.
- * Makes a request to the buyURL (as provided in a quote) to get the actual
- * provider widget URL, browser type, and order ID.
- *
- * @param buyUrl - The full buy URL endpoint to fetch from.
- * @returns The buy widget data containing the provider widget URL.
- */
-export type RampsServiceGetBuyWidgetUrlAction = {
-    type: `RampsService:getBuyWidgetUrl`;
-    handler: RampsService['getBuyWidgetUrl'];
-};
-/**
- * Fetches an order from the unified V2 API endpoint.
- * This endpoint returns a normalized `RampsOrder` (DepositOrder shape)
- * for all provider types, including both aggregator and native providers.
- *
- * @param providerCode - The provider code (e.g., "transak", "transak-native", "moonpay"),
- * with or without the `/providers/` prefix.
- * @param orderCode - The order identifier.
- * @param wallet - The wallet address associated with the order.
- * @returns The unified order data.
- */
-export type RampsServiceGetOrderAction = {
-    type: `RampsService:getOrder`;
-    handler: RampsService['getOrder'];
-};
-/**
- * Extracts an order from a provider callback URL.
- * Sends the callback URL to the V2 API backend, which knows how to parse
- * each provider's callback format and extract the order ID. Then fetches
- * the full order using that ID.
- *
- * This is the V2 equivalent of the aggregator SDK's `getOrderFromCallback`.
- *
- * @param providerCode - The provider code (e.g., "transak", "moonpay"),
- * with or without the `/providers/` prefix.
- * @param callbackUrl - The full callback URL the provider redirected to.
- * @param wallet - The wallet address associated with the order.
- * @returns The unified order data.
- */
-export type RampsServiceGetOrderFromCallbackAction = {
-    type: `RampsService:getOrderFromCallback`;
-    handler: RampsService['getOrderFromCallback'];
-};
-/**
- * Union of all RampsService action types.
- */
-export type RampsServiceMethodActions = RampsServiceGetDefaultRedirectCallbackUrlAction | RampsServiceGetGeolocationAction | RampsServiceGetCountriesAction | RampsServiceGetTokensAction | RampsServiceGetProvidersAction | RampsServiceGetPaymentMethodsAction | RampsServiceGetQuotesAction | RampsServiceGetBuyWidgetUrlAction | RampsServiceGetOrderAction | RampsServiceGetOrderFromCallbackAction;
-//# sourceMappingURL=RampsService-method-action-types.d.mts.map

package/dist/RampsService-method-action-types.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"RampsService-method-action-types.d.mts","sourceRoot":"","sources":["../src/RampsService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,2BAA0B;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,YAAY,CAAC,+BAA+B,CAAC,CAAC;CACxD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,EAAE,6BAA6B,CAAC;IACpC,OAAO,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAAC;CACzC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,YAAY,CAAC,cAAc,CAAC,CAAC;CACvC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;CACpC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,YAAY,CAAC,cAAc,CAAC,CAAC;CACvC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,gCAAgC,CAAC;IACvC,OAAO,EAAE,YAAY,CAAC,mBAAmB,CAAC,CAAC;CAC5C,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;CACpC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,YAAY,CAAC,iBAAiB,CAAC,CAAC;CAC1C,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,uBAAuB,CAAC;IAC9B,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC;CACnC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,YAAY,CAAC,sBAAsB,CAAC,CAAC;CAC/C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GACjC,+CAA+C,GAC/C,gCAAgC,GAChC,8BAA8B,GAC9B,2BAA2B,GAC3B,8BAA8B,GAC9B,mCAAmC,GACnC,2BAA2B,GAC3B,iCAAiC,GACjC,0BAA0B,GAC1B,sCAAsC,CAAC"}

package/dist/RampsService-method-action-types.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"RampsService-method-action-types.mjs","sourceRoot":"","sources":["../src/RampsService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { RampsService } from './RampsService.js';\n\n/**\n * Returns the default redirect (\"fake callback\") URL for this service's\n * environment.\n *\n * The quotes API only embeds a `buyURL`/`buyWidget` (the WebView page a\n * non-native provider needs) when a `redirectUrl` is present, so callers\n * that omit one (MM Pay's widened Headless Buy fetch) use this value.\n * Exposing it here makes the service's environment the single runtime source\n * of truth, so the callback can never point at a different environment than\n * the one the quotes themselves came from.\n *\n * `baseUrlOverride` deliberately does not apply. That option overrides the\n * ramps API base URL for local development. In production and staging the\n * callback lives on a different host (`on-ramp-content` versus\n * `on-ramp{-cache}`), so an API override says nothing about where\n * `/regions/fake-callback` lives. In development the callback already shares\n * the API host family (`on-ramp.dev-api`). The redirect URL is also handed\n * to the provider and matched by client UI to detect flow completion, so\n * returning an unrelated local API origin here would break completion\n * detection rather than help it. Point `environment` at\n * {@link RampsEnvironment.Local} for a localhost callback, noting that URL\n * is pinned to `http://localhost:3000` and does not follow a non-3000\n * `baseUrlOverride`.\n *\n * @returns The default redirect callback URL for the configured environment.\n */\nexport type RampsServiceGetDefaultRedirectCallbackUrlAction = {\n  type: `RampsService:getDefaultRedirectCallbackUrl`;\n  handler: RampsService['getDefaultRedirectCallbackUrl'];\n};\n\n/**\n * Makes a request to the API in order to retrieve the user's geolocation\n * based on their IP address.\n *\n * @returns The user's country/region code (e.g., \"US-UT\" for Utah, USA).\n */\nexport type RampsServiceGetGeolocationAction = {\n  type: `RampsService:getGeolocation`;\n  handler: RampsService['getGeolocation'];\n};\n\n/**\n * Makes a request to the cached API to retrieve the list of supported countries.\n * The API returns countries with support information for both buy and sell actions.\n * Filters countries based on aggregator support (preserves OnRampSDK logic).\n *\n * @returns An array of countries filtered by aggregator support.\n */\nexport type RampsServiceGetCountriesAction = {\n  type: `RampsService:getCountries`;\n  handler: RampsService['getCountries'];\n};\n\n/**\n * Fetches the list of available tokens for a given region and action.\n * Supports optional provider filter.\n *\n * @param region - The region code (e.g., \"us\", \"fr\", \"us-ny\").\n * @param action - The ramp action type ('buy' or 'sell').\n * @param options - Optional query parameters for filtering tokens.\n * @param options.provider - Provider ID(s) to filter by.\n * @returns The tokens response containing topTokens and allTokens.\n */\nexport type RampsServiceGetTokensAction = {\n  type: `RampsService:getTokens`;\n  handler: RampsService['getTokens'];\n};\n\n/**\n * Fetches the list of providers for a given region.\n * Supports optional query filters: provider, crypto, payments.\n * Region local fiat filtering is applied server-side when `fiat` is omitted.\n *\n * @param regionCode - The region code (e.g., \"us\", \"fr\", \"us-ny\").\n * @param options - Optional query parameters for filtering providers.\n * @param options.provider - Provider ID(s) to filter by.\n * @param options.crypto - Crypto currency ID(s) to filter by.\n * @param options.payments - Payment method ID(s) to filter by.\n * @returns The providers response containing providers array.\n */\nexport type RampsServiceGetProvidersAction = {\n  type: `RampsService:getProviders`;\n  handler: RampsService['getProviders'];\n};\n\n/**\n * Fetches the list of payment methods for a given region, asset, and provider.\n *\n * Region local fiat filtering is applied server-side when `fiat` is omitted.\n *\n * @param options - Query parameters for filtering payment methods.\n * @param options.region - User's region code (e.g., \"us-al\").\n * @param options.assetId - CAIP-19 cryptocurrency identifier.\n * @param options.provider - Provider ID path.\n * @returns The payment methods response containing payments array.\n */\nexport type RampsServiceGetPaymentMethodsAction = {\n  type: `RampsService:getPaymentMethods`;\n  handler: RampsService['getPaymentMethods'];\n};\n\n/**\n * Fetches quotes from all providers for a given set of parameters.\n * Uses the V2 orders API to get quotes for multiple payment methods at once.\n *\n * @param params - The parameters for fetching quotes.\n * @param params.region - User's region code (e.g., \"us\", \"us-ca\").\n * @param params.paymentMethods - Array of payment method IDs.\n * @param params.assetId - CAIP-19 cryptocurrency identifier.\n * @param params.fiat - Fiat currency code (e.g., \"usd\").\n * @param params.amount - The amount (in fiat for buy, crypto for sell).\n * @param params.walletAddress - The destination wallet address.\n * @param params.redirectUrl - Optional redirect URL after order completion.\n * @param params.providers - Optional provider IDs to filter quotes.\n * @param params.action - The ramp action type. Defaults to 'buy'.\n * @returns The quotes response containing success, sorted, error, and customActions.\n */\nexport type RampsServiceGetQuotesAction = {\n  type: `RampsService:getQuotes`;\n  handler: RampsService['getQuotes'];\n};\n\n/**\n * Fetches the buy widget data from a buy URL endpoint.\n * Makes a request to the buyURL (as provided in a quote) to get the actual\n * provider widget URL, browser type, and order ID.\n *\n * @param buyUrl - The full buy URL endpoint to fetch from.\n * @returns The buy widget data containing the provider widget URL.\n */\nexport type RampsServiceGetBuyWidgetUrlAction = {\n  type: `RampsService:getBuyWidgetUrl`;\n  handler: RampsService['getBuyWidgetUrl'];\n};\n\n/**\n * Fetches an order from the unified V2 API endpoint.\n * This endpoint returns a normalized `RampsOrder` (DepositOrder shape)\n * for all provider types, including both aggregator and native providers.\n *\n * @param providerCode - The provider code (e.g., \"transak\", \"transak-native\", \"moonpay\"),\n * with or without the `/providers/` prefix.\n * @param orderCode - The order identifier.\n * @param wallet - The wallet address associated with the order.\n * @returns The unified order data.\n */\nexport type RampsServiceGetOrderAction = {\n  type: `RampsService:getOrder`;\n  handler: RampsService['getOrder'];\n};\n\n/**\n * Extracts an order from a provider callback URL.\n * Sends the callback URL to the V2 API backend, which knows how to parse\n * each provider's callback format and extract the order ID. Then fetches\n * the full order using that ID.\n *\n * This is the V2 equivalent of the aggregator SDK's `getOrderFromCallback`.\n *\n * @param providerCode - The provider code (e.g., \"transak\", \"moonpay\"),\n * with or without the `/providers/` prefix.\n * @param callbackUrl - The full callback URL the provider redirected to.\n * @param wallet - The wallet address associated with the order.\n * @returns The unified order data.\n */\nexport type RampsServiceGetOrderFromCallbackAction = {\n  type: `RampsService:getOrderFromCallback`;\n  handler: RampsService['getOrderFromCallback'];\n};\n\n/**\n * Union of all RampsService action types.\n */\nexport type RampsServiceMethodActions =\n  | RampsServiceGetDefaultRedirectCallbackUrlAction\n  | RampsServiceGetGeolocationAction\n  | RampsServiceGetCountriesAction\n  | RampsServiceGetTokensAction\n  | RampsServiceGetProvidersAction\n  | RampsServiceGetPaymentMethodsAction\n  | RampsServiceGetQuotesAction\n  | RampsServiceGetBuyWidgetUrlAction\n  | RampsServiceGetOrderAction\n  | RampsServiceGetOrderFromCallbackAction;\n"]}