@metamask/ramps-controller 20.2.0 → 21.0.0

package/dist/RampsController.d.mts

@@ -1,821 +0,0 @@
-import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
-import { BaseController } from "@metamask/base-controller";
-import type { Messenger } from "@metamask/messenger";
-import type { RemoteFeatureFlagControllerGetStateAction } from "@metamask/remote-feature-flag-controller";
-import type { RampsControllerMethodActions } from "./RampsController-method-action-types.mjs";
-import type { RampsErrorCode } from "./rampsErrorCodes.mjs";
-import type { RampsServiceGetDefaultRedirectCallbackUrlAction, RampsServiceGetGeolocationAction, RampsServiceGetCountriesAction, RampsServiceGetTokensAction, RampsServiceGetProvidersAction, RampsServiceGetPaymentMethodsAction, RampsServiceGetQuotesAction, RampsServiceGetBuyWidgetUrlAction, RampsServiceGetOrderAction, RampsServiceGetOrderFromCallbackAction } from "./RampsService-method-action-types.mjs";
-import type { BuyWidget, Country, TokensResponse, Provider, State, RampAction, PaymentMethod, PaymentMethodsResponse, QuotesResponse, Quote, RampsToken, RampsServiceActions, RampsOrder, ProvidersResponse } from "./RampsService.mjs";
-import { RampsOrderStatus } from "./RampsService.mjs";
-import type { RequestCache as RequestCacheType, RequestState, ExecuteRequestOptions } from "./RequestCache.mjs";
-import type { TransakServiceSetApiKeyAction, TransakServiceSetAccessTokenAction, TransakServiceClearAccessTokenAction, TransakServiceSendUserOtpAction, TransakServiceVerifyUserOtpAction, TransakServiceLogoutAction, TransakServiceGetUserDetailsAction, TransakServiceGetBuyQuoteAction, TransakServiceGetKycRequirementAction, TransakServiceGetAdditionalRequirementsAction, TransakServiceCreateOrderAction, TransakServiceGetOrderAction, TransakServiceGetUserLimitsAction, TransakServiceRequestOttAction, TransakServiceGeneratePaymentWidgetUrlAction, TransakServiceCreateWidgetUrlAction, TransakServiceSubmitPurposeOfUsageFormAction, TransakServicePatchUserAction, TransakServiceSubmitSsnDetailsAction, TransakServiceConfirmPaymentAction, TransakServiceGetTranslationAction, TransakServiceGetIdProofStatusAction, TransakServiceCancelOrderAction, TransakServiceCancelAllActiveOrdersAction, TransakServiceGetActiveOrdersAction } from "./TransakService-method-action-types.mjs";
-import type { TransakAccessToken, TransakUserDetails, TransakBuyQuote, TransakKycRequirement, TransakAdditionalRequirementsResponse, TransakDepositOrder, TransakUserLimits, TransakOttResponse, TransakQuoteTranslation, TransakTranslationRequest, TransakIdProofStatus, TransakOrderPaymentMethod, PatchUserRequestBody, TransakOrder } from "./TransakService.mjs";
-import type { TransakServiceActions } from "./TransakService.mjs";
-/**
- * The name of the {@link RampsController}, used to namespace the
- * controller's actions and events and to namespace the controller's state data
- * when composed with other controllers.
- */
-export declare const controllerName = "RampsController";
-/**
- * RampsService action types that RampsController calls via the messenger.
- * Any host (e.g. mobile) that creates a RampsController messenger must delegate
- * these actions from the root messenger so the controller can function.
- */
-export declare const RAMPS_CONTROLLER_REQUIRED_SERVICE_ACTIONS: readonly (RampsServiceActions['type'] | TransakServiceActions['type'])[];
-/**
- * Represents the user's selected region with full country and state objects.
- */
-export type UserRegion = {
-    /**
-     * The country object for the selected region.
-     */
-    country: Country;
-    /**
-     * The state object if a state was selected, null if only country was selected.
-     */
-    state: State | null;
-    /**
-     * The region code string (e.g., "us-ut" or "fr") used for API calls.
-     */
-    regionCode: string;
-};
-/**
- * Generic type for resource state that bundles data with loading/error states.
- *
- * @template TData - The type of the resource data
- * @template TSelected - The type of the selected item (defaults to null for resources without selection)
- */
-export type ResourceState<TData, TSelected = null> = {
-    /**
-     * The resource data.
-     */
-    data: TData;
-    /**
-     * The currently selected item, or null if none selected.
-     */
-    selected: TSelected;
-    /**
-     * Whether the resource is currently being fetched.
-     */
-    isLoading: boolean;
-    /**
-     * Error message if the fetch failed, or null.
-     */
-    error: string | null;
-    /**
-     * Stable error key for client-side localization, if available.
-     */
-    errorKey?: RampsErrorCode | null;
-};
-/**
- * Describes the transak-specific state managed by the RampsController.
- * This state is used by the unified V2 native flow.
- */
-export type TransakState = {
-    isAuthenticated: boolean;
-    userDetails: ResourceState<TransakUserDetails | null>;
-    buyQuote: ResourceState<TransakBuyQuote | null>;
-    kycRequirement: ResourceState<TransakKycRequirement | null>;
-};
-/**
- * Describes the state for all native providers managed by the RampsController.
- * Each native provider has its own nested state object.
- */
-export type NativeProvidersState = {
-    transak: TransakState;
-};
-/**
- * Response from {@link RampsController.getPaymentMethodsForContext}.
- *
- * Methods are request-eligible for the resolved provider set; they are not a
- * guarantee that every amount will produce a quote (provider fiat limits still
- * apply at quote time).
- */
-export type PaymentMethodsForContextResponse = {
-    /**
-     * Deduped payment methods contributed by the resolved provider set.
-     */
-    methods: PaymentMethod[];
-    /**
-     * Suggested selection for this request only. Written to controller state only
-     * when `updateState` was true on the call.
-     */
-    selected: PaymentMethod | null;
-    /**
-     * Provider IDs whose methods were requested (after resolution / allowlist
-     * filtering).
-     */
-    providerIds: string[];
-};
-/**
- * Describes the shape of the state object for {@link RampsController}.
- */
-export type RampsControllerState = {
-    /**
-     * The user's region (full country and state objects).
-     * Initially set via geolocation fetch, but can be manually changed by the user.
-     */
-    userRegion: UserRegion | null;
-    /**
-     * Countries resource state with data, loading, and error.
-     * Data contains the list of countries available for ramp actions.
-     */
-    countries: ResourceState<Country[]>;
-    /**
-     * Providers resource state with data, selected, loading, and error.
-     * Data contains the list of providers available for the current region.
-     */
-    providers: ResourceState<Provider[], Provider | null>;
-    /**
-     * Tokens resource state with data, selected, loading, and error.
-     * Data contains topTokens and allTokens arrays.
-     */
-    tokens: ResourceState<TokensResponse | null, RampsToken | null>;
-    /**
-     * Payment methods resource state with data, selected, loading, and error.
-     * Data contains payment methods filtered by region, fiat, asset, and provider.
-     */
-    paymentMethods: ResourceState<PaymentMethod[], PaymentMethod | null>;
-    /**
-     * Cache of request states, keyed by cache key.
-     * This stores loading, success, and error states for API requests.
-     */
-    requests: RequestCacheType;
-    /**
-     * State for native providers in the unified V2 flow.
-     * Each provider has its own nested state containing authentication,
-     * user details, quote, and KYC data.
-     */
-    nativeProviders: NativeProvidersState;
-    /**
-     * The controller is the authority for V2 orders — it polls, updates,
-     * and persists them.
-     */
-    orders: RampsOrder[];
-    /**
-     * Whether the currently selected provider was auto-selected by the system
-     * (no order history, no Transak) rather than chosen by the user or derived
-     * from order history. When true, the UI should silently switch providers on
-     * token conflict instead of showing the "Token Not Available" modal.
-     */
-    providerAutoSelected: boolean;
-};
-/**
- * Constructs the default {@link RampsController} state. This allows
- * consumers to provide a partial state object when initializing the controller
- * and also helps in constructing complete state objects for this controller in
- * tests.
- *
- * @returns The default {@link RampsController} state.
- */
-export declare function getDefaultRampsControllerState(): RampsControllerState;
-/**
- * Retrieves the state of the {@link RampsController}.
- */
-export type RampsControllerGetStateAction = ControllerGetStateAction<typeof controllerName, RampsControllerState>;
-/**
- * Actions that {@link RampsControllerMessenger} exposes to other consumers.
- */
-export type RampsControllerActions = RampsControllerGetStateAction | RampsControllerMethodActions;
-/**
- * Actions from other messengers that {@link RampsController} calls.
- */
-type AllowedActions = RemoteFeatureFlagControllerGetStateAction | RampsServiceGetDefaultRedirectCallbackUrlAction | RampsServiceGetGeolocationAction | RampsServiceGetCountriesAction | RampsServiceGetTokensAction | RampsServiceGetProvidersAction | RampsServiceGetPaymentMethodsAction | RampsServiceGetQuotesAction | RampsServiceGetBuyWidgetUrlAction | RampsServiceGetOrderAction | RampsServiceGetOrderFromCallbackAction | TransakServiceSetApiKeyAction | TransakServiceSetAccessTokenAction | TransakServiceClearAccessTokenAction | TransakServiceSendUserOtpAction | TransakServiceVerifyUserOtpAction | TransakServiceLogoutAction | TransakServiceGetUserDetailsAction | TransakServiceGetBuyQuoteAction | TransakServiceGetKycRequirementAction | TransakServiceGetAdditionalRequirementsAction | TransakServiceCreateOrderAction | TransakServiceGetOrderAction | TransakServiceGetUserLimitsAction | TransakServiceRequestOttAction | TransakServiceGeneratePaymentWidgetUrlAction | TransakServiceCreateWidgetUrlAction | TransakServiceSubmitPurposeOfUsageFormAction | TransakServicePatchUserAction | TransakServiceSubmitSsnDetailsAction | TransakServiceConfirmPaymentAction | TransakServiceGetTranslationAction | TransakServiceGetIdProofStatusAction | TransakServiceCancelOrderAction | TransakServiceCancelAllActiveOrdersAction | TransakServiceGetActiveOrdersAction;
-/**
- * Published when the state of {@link RampsController} changes.
- */
-export type RampsControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, RampsControllerState>;
-/**
- * Published when a V2 order's status transitions.
- * Consumed by mobile's init layer for notifications and analytics.
- */
-export type RampsControllerOrderStatusChangedEvent = {
-    type: `${typeof controllerName}:orderStatusChanged`;
-    payload: [{
-        order: RampsOrder;
-        previousStatus: RampsOrderStatus;
-    }];
-};
-/**
- * Events that {@link RampsControllerMessenger} exposes to other consumers.
- */
-export type RampsControllerEvents = RampsControllerStateChangeEvent | RampsControllerOrderStatusChangedEvent;
-/**
- * Events from other messengers that {@link RampsController} subscribes to.
- */
-type AllowedEvents = never;
-/**
- * The messenger restricted to actions and events accessed by
- * {@link RampsController}.
- */
-export type RampsControllerMessenger = Messenger<typeof controllerName, RampsControllerActions | AllowedActions, RampsControllerEvents | AllowedEvents>;
-/**
- * Configuration options for the RampsController.
- */
-export type RampsControllerOptions = {
-    /** The messenger suited for this controller. */
-    messenger: RampsControllerMessenger;
-    /** The desired state with which to initialize this controller. */
-    state?: Partial<RampsControllerState>;
-    /** Time to live for cached requests in milliseconds. Defaults to 15 minutes. */
-    requestCacheTTL?: number;
-    /** Maximum number of entries in the request cache. Defaults to 250. */
-    requestCacheMaxSize?: number;
-};
-/**
- * Returns the internal MetaMask order code used for state lookups and polling.
- * Prefers the code embedded in the canonical order `id` path over `providerOrderId`,
- * which may contain the provider's native order identifier.
- *
- * @param orderOrId - Order fields or a full order id / order code string.
- * @returns The internal order code.
- */
-export declare function getInternalOrderCode(orderOrId: Pick<RampsOrder, 'id' | 'providerOrderId'> | string): string;
-export declare class RampsController extends BaseController<typeof controllerName, RampsControllerState, RampsControllerMessenger> {
-    #private;
-    /**
-     * Clears the pending resource count map. Used only in tests to exercise the
-     * defensive path when get() returns undefined in the finally block.
-     *
-     * @internal
-     */
-    clearPendingResourceCountForTest(): void;
-    /**
-     * Constructs a new {@link RampsController}.
-     *
-     * @param args - The constructor arguments.
-     * @param args.messenger - The messenger suited for this controller.
-     * @param args.state - The desired state with which to initialize this
-     * controller. Missing properties will be filled in with defaults.
-     * @param args.requestCacheTTL - Time to live for cached requests in milliseconds.
-     * @param args.requestCacheMaxSize - Maximum number of entries in the request cache.
-     */
-    constructor({ messenger, state, requestCacheTTL, requestCacheMaxSize, }: RampsControllerOptions);
-    /**
-     * Executes a request with caching, deduplication, and at most one in-flight
-     * request per resource type.
-     *
-     * 1. **Same cache key in flight** – If a request with this cache key is
-     *    already pending, returns that promise (deduplication; no second request).
-     *
-     * 2. **Cache hit** – If valid, non-expired data exists in state.requests for
-     *    this key and forceRefresh is not set, returns that data without fetching.
-     *
-     * 3. **New request** – Creates an AbortController and fires the fetcher.
-     *    If options.resourceType is set, tags the pending request with that
-     *    resource type (so #abortDependentRequests can cancel it on region
-     *    change or cleanup) and ref-counts resource-level loading state.
-     *    On success or error, updates request state and resource error;
-     *    in finally, clears resource loading only if this request was not
-     *    aborted.
-     *
-     * @param cacheKey - Unique identifier for this request (e.g. from createCacheKey).
-     * @param fetcher - Async function that performs the fetch. Receives an AbortSignal
-     *   that is aborted when this request is superseded by another for the same resource.
-     * @param options - Optional forceRefresh, ttl, and resourceType for loading/error state.
-     * @returns The result of the request (from cache, joined promise, or fetcher).
-     */
-    executeRequest<TResult>(cacheKey: string, fetcher: (signal: AbortSignal) => Promise<TResult>, options?: ExecuteRequestOptions): Promise<TResult>;
-    /**
-     * Aborts a pending request if one exists.
-     *
-     * @param cacheKey - The cache key of the request to abort.
-     * @returns True if a request was aborted.
-     */
-    abortRequest(cacheKey: string): boolean;
-    /**
-     * Gets the state of a specific cached request.
-     *
-     * @param cacheKey - The cache key to look up.
-     * @returns The request state, or undefined if not cached.
-     */
-    getRequestState(cacheKey: string): RequestState | undefined;
-    /**
-     * Sets the user's region manually (without fetching geolocation).
-     * This allows users to override the detected region.
-     *
-     * @param region - The region code to set (e.g., "US-CA").
-     * @param options - Options for cache behavior.
-     * @returns The user region object.
-     */
-    setUserRegion(region: string, options?: ExecuteRequestOptions): Promise<UserRegion>;
-    /**
-     * Sets the user's selected provider.
-     *
-     * Accepts either a Provider object (stored directly) or a provider ID
-     * string (looked up from state). The object form is preferred when the
-     * caller already has the full data (e.g. from React Query cache).
-     *
-     * @param providerOrId - A Provider object, a provider ID string (e.g., "/providers/moonpay"), or null to clear.
-     * @param options - Optional settings for the selection.
-     * @param options.autoSelected - When true, marks the provider as system-guessed
-     *   (soft selection). The UI will silently auto-switch on token conflict instead
-     *   of showing the "Token Not Available" modal. Defaults to false.
-     */
-    setSelectedProvider(providerOrId: string | Provider | null, options?: {
-        autoSelected?: boolean;
-    }): void;
-    /**
-     * Switches to the first provider in state that serves the given asset,
-     * when the currently selected provider does not.
-     *
-     * This is the controller-level equivalent of UB2's BuildQuote tier-1
-     * silent-switch effect and MMPay's `useEnsureCompatibleProvider` hook: it
-     * keeps provider-asset compatibility logic in one place rather than
-     * duplicating `providerServesAsset` + find-and-switch across multiple UI
-     * layers.
-     *
-     * The compatibility check prefers the current provider's entry in
-     * `providers.data` over the `providers.selected` copy, which can be stale
-     * once a fresh providers list arrives.
-     *
-     * No-op when:
-     * - `providers.data` is empty (providers not yet loaded)
-     * - the currently selected provider already serves the asset
-     * - no provider in the list serves the asset (no safe fallback)
-     *
-     * @param assetId - CAIP-19 asset id of the deposit asset.
-     * @param options - Optional settings forwarded to `setSelectedProvider`.
-     * @param options.autoSelected - When true, marks the new selection as
-     *   system-guessed (soft selection). Defaults to true.
-     * @returns `true` if the selected provider was changed, `false` otherwise.
-     */
-    setSelectedProviderForAsset(assetId: string, options?: {
-        autoSelected?: boolean;
-    }): boolean;
-    /**
-     * Initializes the controller by fetching the user's region from geolocation.
-     * This should be called once at app startup to set up the initial region.
-     *
-     * Idempotent: subsequent calls return the same promise unless forceRefresh is set.
-     * Force-refetches the countries catalog on startup (bypassing the in-session
-     * request cache) so region preset amounts stay current. The catalog is not
-     * persisted, so a cold start always re-fetches it regardless. Skips
-     * geolocation when userRegion already exists.
-     *
-     * @param options - Options for cache behavior. forceRefresh bypasses idempotency and re-runs the full flow.
-     * @returns Promise that resolves when initialization is complete.
-     */
-    init(options?: ExecuteRequestOptions): Promise<void>;
-    /**
-     * Fetches the list of supported countries.
-     * The API returns countries with support information for both buy and sell actions.
-     * The countries are saved in the controller state once fetched.
-     *
-     * @param options - Options for cache behavior.
-     * @returns An array of countries.
-     */
-    getCountries(options?: ExecuteRequestOptions): Promise<Country[]>;
-    /**
-     * Fetches the list of available tokens for a given region and action.
-     * The tokens are saved in the controller state once fetched.
-     *
-     * @param region - The region code (e.g., "us", "fr", "us-ny"). If not provided, uses the user's region from controller state.
-     * @param action - The ramp action type ('buy' or 'sell').
-     * @param options - Options for cache behavior and query filters.
-     * @param options.provider - Provider ID(s) to filter by.
-     * @returns The tokens response containing topTokens and allTokens.
-     */
-    getTokens(region?: string, action?: RampAction, options?: ExecuteRequestOptions & {
-        provider?: string | string[];
-    }): Promise<TokensResponse>;
-    /**
-     * Sets the user's selected token by asset ID.
-     * Looks up the token from the current tokens in state and automatically
-     * fetches payment methods for that token.
-     *
-     * @param assetId - The asset identifier in CAIP-19 format (e.g., "eip155:1/erc20:0x..."), or undefined to clear.
-     * @throws If region is not set, tokens are not loaded, or token is not found.
-     */
-    setSelectedToken(assetId?: string): void;
-    /**
-     * Fetches the list of providers for a given region.
-     * The providers are saved in the controller state once fetched.
-     *
-     * @param region - The region code (e.g., "us", "fr", "us-ny"). If not provided, uses the user's region from controller state.
-     * @param options - Options for cache behavior and query filters.
-     * @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.
-     */
-    getProviders(region?: string, options?: ExecuteRequestOptions & {
-        provider?: string | string[];
-        crypto?: string | string[];
-        payments?: string | string[];
-    }): Promise<ProvidersResponse>;
-    /**
-     * Fetches the list of payment methods for a given context.
-     * The payment methods are saved in the controller state once fetched.
-     *
-     * @param region - User's region code (e.g. "fr", "us-ny").
-     * @param options - Query parameters for filtering payment methods.
-     * @param options.assetId - CAIP-19 cryptocurrency identifier.
-     * @param options.provider - Provider ID path.
-     * @returns The payment methods response containing payments array.
-     */
-    getPaymentMethods(region?: string, options?: ExecuteRequestOptions & {
-        assetId?: string;
-        provider?: string;
-    }): Promise<PaymentMethodsResponse>;
-    /**
-     * Fetches payment methods for a quoting context without coupling callers to
-     * the Buy flow's globally selected provider/token catalog.
-     *
-     * Provider contribution mirrors {@link getQuotes}:
-     * - explicit `providers` (optionally filtered when
-     *   `restrictToKnownOrNativeProviders` is set)
-     * - auto-select / restrict path, including `moneyHeadlessAllProviders`
-     *   widening: flag off uses the restricted/native resolver; flag on uses
-     *   supporting providers, intersected with the flag allowlist when that
-     *   allowlist is non-empty (pick-survivor set for picker methods)
-     * - when those resolution flags and `providers` are omitted, uses only
-     *   `providers.selected` (UB2 selected-provider context)
-     *
-     * By default this is request-only: it does **not** mutate
-     * `paymentMethods.data` or `paymentMethods.selected`. Pass `updateState:
-     * true` only when the caller explicitly wants Buy-catalog write semantics
-     * (UB2). Headless / MM Pay selection stays TPC-owned. `updateState: true`
-     * throws when the resolved provider set holds more than one provider, because
-     * the write guards cannot tell two such requests apart.
-     *
-     * Methods are request-eligible for the resolved provider set; they are not
-     * guaranteed to produce a quote for every amount (provider fiat limits still
-     * apply at quote time).
-     *
-     * @param options - Context for the payment-method fetch.
-     * @param options.region - Region code. Defaults to `userRegion`.
-     * @param options.assetId - Required CAIP-19 quoting asset.
-     * @param options.providers - Explicit provider ids.
-     * @param options.autoSelectProvider - Resolve providers like `getQuotes`.
-     * @param options.preferredProviderIds - Preferred ids for auto-selection.
-     * @param options.restrictToKnownOrNativeProviders - Headless gating.
-     * @param options.updateState - When true, write `paymentMethods` state.
-     * @param options.preferPaymentMethodId - Preserve this id when still present.
-     * @param options.forceRefresh - Bypass request cache for provider fetches.
-     * @param options.ttl - Custom TTL for provider payment-method fetches.
-     * @returns Deduped methods, a request-only suggested selection, and the
-     *   provider ids that contributed.
-     */
-    getPaymentMethodsForContext(options: {
-        region?: string;
-        assetId: string;
-        providers?: string[];
-        autoSelectProvider?: boolean;
-        preferredProviderIds?: string[];
-        restrictToKnownOrNativeProviders?: boolean;
-        updateState?: boolean;
-        preferPaymentMethodId?: string;
-        forceRefresh?: boolean;
-        ttl?: number;
-    }): Promise<PaymentMethodsForContextResponse>;
-    /**
-     * Sets the user's selected payment method.
-     *
-     * Accepts either a payment method ID (looked up from state) or a full
-     * PaymentMethod object (stored directly). The object form is preferred
-     * when the caller already has the full data (e.g. from React Query cache),
-     * as it avoids depending on controller state being populated.
-     *
-     * @param paymentMethodOrId - A PaymentMethod object, a payment method ID string, or undefined/null to clear.
-     */
-    setSelectedPaymentMethod(paymentMethodOrId?: string | PaymentMethod | null): void;
-    /**
-     * Fetches quotes from all providers for a given set of parameters.
-     * Uses the controller's request cache; callers manage the response in local state.
-     *
-     * @param options - The parameters for fetching quotes.
-     * @param options.region - User's region code. If not provided, uses userRegion from state.
-     * @param options.fiat - Fiat currency code. If not provided, uses userRegion currency.
-     * @param options.assetId - CAIP-19 cryptocurrency identifier.
-     * @param options.amount - The amount (in fiat for buy, crypto for sell).
-     * @param options.walletAddress - The destination wallet address.
-     * @param options.paymentMethods - Array of payment method IDs. If not provided, uses paymentMethods from state.
-     * @param options.providers - Optional provider IDs to filter quotes.
-     * @param options.autoSelectProvider - When true and `providers` is omitted,
-     *   resolves a provider that supports `assetId` for this request only (no
-     *   state mutation). Ignored when `providers` is passed.
-     * @param options.preferredProviderIds - Optional provider IDs to prefer
-     *   during auto-selection, in priority order (e.g. derived by the caller
-     *   from completed-order history). Only used when `autoSelectProvider` is
-     *   true and `providers` is omitted.
-     * @param options.restrictToKnownOrNativeProviders - Headless-buy v0 gating. When
-     *   true, auto-selection resolves only a native provider, and an explicitly
-     *   passed `providers` list is filtered to those supporting the region and
-     *   asset. If nothing qualifies, `getQuotes` returns an empty response
-     *   instead of quoting other providers.
-     * @param options.redirectUrl - Optional redirect URL after order completion.
-     * @param options.action - The ramp action type. Defaults to 'buy'.
-     * @param options.forceRefresh - Whether to bypass cache.
-     * @param options.ttl - Custom TTL for this request.
-     * @returns The quotes response containing success, sorted, error, and customActions.
-     */
-    getQuotes(options: {
-        region?: string;
-        fiat?: string;
-        assetId?: string;
-        amount: number;
-        walletAddress: string;
-        paymentMethods?: string[];
-        providers?: string[];
-        autoSelectProvider?: boolean;
-        preferredProviderIds?: string[];
-        restrictToKnownOrNativeProviders?: boolean;
-        redirectUrl?: string;
-        action?: RampAction;
-        forceRefresh?: boolean;
-        ttl?: number;
-    }): Promise<QuotesResponse>;
-    /**
-     * Adds or updates a V2 order in controller state.
-     * If an order with the same internal order code already exists, the incoming
-     * fields are merged on top of the existing order so that fields not present
-     * in the update (e.g. paymentDetails from the Transak API) are preserved.
-     *
-     * @param order - The RampsOrder to add or update.
-     */
-    addOrder(order: RampsOrder): void;
-    /**
-     * Removes a V2 order from controller state by providerOrderId.
-     *
-     * @param providerOrderId - The provider order ID to remove.
-     */
-    removeOrder(providerOrderId: string): void;
-    /**
-     * Starts polling all pending V2 orders at a fixed interval.
-     * Each poll cycle iterates orders with non-terminal statuses,
-     * respects pollingSecondsMinimum and backoff from error count.
-     */
-    startOrderPolling(): void;
-    /**
-     * Stops order polling and clears the interval.
-     */
-    stopOrderPolling(): void;
-    /**
-     * Cleans up controller resources.
-     * Should be called when the controller is no longer needed.
-     */
-    destroy(): void;
-    /**
-     * Fetches the widget data from a quote for redirect providers.
-     * Makes a request to the buyURL endpoint via the RampsService to get the
-     * actual provider widget URL and optional order ID for polling.
-     *
-     * @param quote - The quote to fetch the widget URL from.
-     * @returns Promise resolving to the full BuyWidget (url, browser, orderId), or null if not available (missing buyURL or empty url in response).
-     * @throws Rethrows errors from the RampsService (e.g. HttpError, network failures) so clients can react to fetch failures.
-     */
-    getBuyWidgetData(quote: Quote): Promise<BuyWidget | null>;
-    /**
-     * Registers an order ID for polling until the order is created or resolved.
-     * Adds a minimal stub order to controller state; the existing order polling
-     * will fetch the full order when the provider has created it.
-     *
-     * @param params - Object containing order identifiers and wallet info.
-     * @param params.orderId - Full order ID (e.g. "/providers/paypal/orders/abc123") or order code.
-     * @param params.providerCode - Canonical provider code (e.g. "paypal", "transak").
-     * @param params.walletAddress - Wallet address for the order.
-     * @param params.chainId - Chain ID for the order (decimal, hex, or CAIP-2). Must be non-empty.
-     */
-    addPrecreatedOrder(params: {
-        orderId: string;
-        providerCode: string;
-        walletAddress: string;
-        chainId: string;
-    }): void;
-    /**
-     * Fetches an order from the unified V2 API endpoint.
-     * Returns a normalized RampsOrder for all provider types (aggregator and native).
-     *
-     * @param providerCode - The provider code (e.g., "transak", "transak-native", "moonpay").
-     * @param orderCode - The order identifier.
-     * @param wallet - The wallet address associated with the order.
-     * @returns The unified order data.
-     */
-    getOrder(providerCode: string, orderCode: string, wallet: string): Promise<RampsOrder>;
-    /**
-     * Extracts an order from a provider callback URL.
-     * Sends the callback URL to the V2 backend for provider-specific parsing,
-     * then fetches the full order. This is the V2 equivalent of the aggregator
-     * SDK's `getOrderFromCallback`.
-     *
-     * @param providerCode - The provider code (e.g., "transak", "moonpay").
-     * @param callbackUrl - The full callback URL the provider redirected to.
-     * @param wallet - The wallet address associated with the order.
-     * @returns The unified order data.
-     */
-    getOrderFromCallback(providerCode: string, callbackUrl: string, wallet: string): Promise<RampsOrder>;
-    /**
-     * Sets the Transak API key used for all Transak API requests.
-     *
-     * @param apiKey - The Transak API key.
-     */
-    transakSetApiKey(apiKey: string): void;
-    /**
-     * Sets the Transak access token and marks the user as authenticated.
-     *
-     * @param token - The access token received from Transak auth.
-     */
-    transakSetAccessToken(token: TransakAccessToken): void;
-    /**
-     * Clears the Transak access token and marks the user as unauthenticated.
-     */
-    transakClearAccessToken(): void;
-    /**
-     * Updates the Transak authentication flag in controller state.
-     *
-     * @param isAuthenticated - Whether the user is authenticated with Transak.
-     */
-    transakSetAuthenticated(isAuthenticated: boolean): void;
-    /**
-     * Resets all Transak state back to defaults (unauthenticated, no data).
-     */
-    transakResetState(): void;
-    /**
-     * Sends a one-time password to the user's email for Transak authentication.
-     *
-     * @param email - The user's email address.
-     * @returns The OTP response containing a state token for verification.
-     */
-    transakSendUserOtp(email: string): Promise<{
-        isTncAccepted: boolean;
-        stateToken: string;
-        email: string;
-        expiresIn: number;
-    }>;
-    /**
-     * Verifies a one-time password and authenticates the user with Transak.
-     * Updates the controller's authentication state on success.
-     *
-     * @param email - The user's email address.
-     * @param verificationCode - The OTP code entered by the user.
-     * @param stateToken - The state token from the sendUserOtp response.
-     * @returns The access token for subsequent authenticated requests.
-     */
-    transakVerifyUserOtp(email: string, verificationCode: string, stateToken: string): Promise<TransakAccessToken>;
-    /**
-     * Logs the user out of Transak. Clears authentication state and user details
-     * regardless of whether the API call succeeds or fails.
-     *
-     * @returns A message indicating the logout result.
-     */
-    transakLogout(): Promise<string>;
-    /**
-     * Fetches the authenticated user's details from Transak.
-     * Updates the userDetails resource state with loading/success/error states.
-     *
-     * @returns The user's profile and KYC details.
-     */
-    transakGetUserDetails(): Promise<TransakUserDetails>;
-    /**
-     * Fetches a buy quote from Transak for the given parameters.
-     * Updates the buyQuote resource state with loading/success/error states.
-     *
-     * @param fiatCurrency - The fiat currency code (e.g., "USD").
-     * @param cryptoCurrency - The cryptocurrency identifier.
-     * @param network - The blockchain network identifier.
-     * @param paymentMethod - The payment method identifier.
-     * @param fiatAmount - The fiat amount as a string.
-     * @returns The buy quote with pricing and fee details.
-     */
-    transakGetBuyQuote(fiatCurrency: string, cryptoCurrency: string, network: string, paymentMethod: string, fiatAmount: string): Promise<TransakBuyQuote>;
-    /**
-     * Fetches the KYC requirement for a given quote.
-     * Updates the kycRequirement resource state with loading/success/error states.
-     *
-     * @param quoteId - The quote ID to check KYC requirements for.
-     * @returns The KYC requirement status and whether the user can place an order.
-     */
-    transakGetKycRequirement(quoteId: string): Promise<TransakKycRequirement>;
-    /**
-     * Fetches additional KYC requirements (e.g., ID proof, address proof) for a quote.
-     *
-     * @param quoteId - The quote ID to check additional requirements for.
-     * @returns The list of additional forms required.
-     */
-    transakGetAdditionalRequirements(quoteId: string): Promise<TransakAdditionalRequirementsResponse>;
-    /**
-     * Creates a new order on Transak. If an existing order conflicts (HTTP 409),
-     * active orders are cancelled and the creation is retried.
-     *
-     * @param quoteId - The quote ID to create an order from.
-     * @param walletAddress - The destination wallet address.
-     * @param paymentMethodId - The payment method to use.
-     * @returns The created deposit order.
-     */
-    transakCreateOrder(quoteId: string, walletAddress: string, paymentMethodId: string): Promise<TransakDepositOrder>;
-    /**
-     * Fetches an existing order from Transak by order ID.
-     *
-     * @param orderId - The order ID (deposit format or raw Transak format).
-     * @param wallet - The wallet address associated with the order.
-     * @param paymentDetails - Optional payment details to attach to the order.
-     * @returns The deposit order details.
-     */
-    transakGetOrder(orderId: string, wallet: string, paymentDetails?: TransakOrderPaymentMethod[]): Promise<TransakDepositOrder>;
-    /**
-     * Fetches the user's spending limits for a given currency and payment method.
-     *
-     * @param fiatCurrency - The fiat currency code.
-     * @param paymentMethod - The payment method identifier.
-     * @param kycType - The KYC level type.
-     * @returns The user's limits, spending, and remaining amounts.
-     */
-    transakGetUserLimits(fiatCurrency: string, paymentMethod: string, kycType: string): Promise<TransakUserLimits>;
-    /**
-     * Requests a one-time token (OTT) for the Transak payment widget.
-     *
-     * @returns The OTT response containing the token.
-     */
-    transakRequestOtt(): Promise<TransakOttResponse>;
-    /**
-     * Generates a URL for the Transak payment widget with pre-filled parameters.
-     *
-     * @param ottToken - The one-time token for widget authentication.
-     * @param quote - The buy quote to pre-fill in the widget.
-     * @param walletAddress - The destination wallet address.
-     * @param extraParams - Optional additional URL parameters.
-     * @returns The fully constructed widget URL string.
-     */
-    transakGeneratePaymentWidgetUrl(ottToken: string, quote: TransakBuyQuote, walletAddress: string, extraParams?: Record<string, string>): string;
-    /**
-     * Creates a Transak payment widget URL via the ramps API proxy, which
-     * injects the partner API key server-side. Replaces the OTT flow
-     * ({@link transakRequestOtt} + {@link transakGeneratePaymentWidgetUrl}).
-     *
-     * @param quote - The buy quote to pre-fill in the widget.
-     * @param walletAddress - The destination wallet address.
-     * @param extraParams - Optional additional widget parameters (e.g. theming).
-     * @returns The single-use widget URL.
-     */
-    transakCreateWidgetUrl(quote: TransakBuyQuote, walletAddress: string, extraParams?: Record<string, string>): Promise<string>;
-    /**
-     * Submits the user's purpose of usage form for KYC compliance.
-     *
-     * @param purpose - Array of purpose strings selected by the user.
-     * @returns A promise that resolves when the form is submitted.
-     */
-    transakSubmitPurposeOfUsageForm(purpose: string[]): Promise<void>;
-    /**
-     * Updates the user's personal or address details on Transak.
-     *
-     * @param data - The user data fields to update.
-     * @returns The API response data.
-     */
-    transakPatchUser(data: PatchUserRequestBody): Promise<unknown>;
-    /**
-     * Submits the user's SSN for identity verification.
-     *
-     * @param ssn - The Social Security Number.
-     * @param quoteId - The quote ID associated with the order requiring SSN.
-     * @returns The API response data.
-     */
-    transakSubmitSsnDetails(ssn: string, quoteId: string): Promise<unknown>;
-    /**
-     * Confirms payment for an order after the user has completed payment.
-     *
-     * @param orderId - The order ID to confirm payment for.
-     * @param paymentMethodId - The payment method used.
-     * @returns Whether the payment confirmation was successful.
-     */
-    transakConfirmPayment(orderId: string, paymentMethodId: string): Promise<{
-        success: boolean;
-    }>;
-    /**
-     * Translates generic ramps identifiers to Transak-specific identifiers.
-     *
-     * @param request - The translation request with optional identifiers to translate.
-     * @returns The translated Transak-specific identifiers.
-     */
-    transakGetTranslation(request: TransakTranslationRequest): Promise<TransakQuoteTranslation>;
-    /**
-     * Checks the status of an ID proof submission for KYC.
-     *
-     * @param workFlowRunId - The workflow run ID to check status for.
-     * @returns The current ID proof status.
-     */
-    transakGetIdProofStatus(workFlowRunId: string): Promise<TransakIdProofStatus>;
-    /**
-     * Cancels a specific Transak order.
-     *
-     * @param depositOrderId - The deposit order ID to cancel.
-     * @returns A promise that resolves when the order is cancelled.
-     */
-    transakCancelOrder(depositOrderId: string): Promise<void>;
-    /**
-     * Cancels all active Transak orders. Individual cancellation failures
-     * are collected and returned rather than thrown.
-     *
-     * @returns An array of errors from any failed cancellations (empty if all succeeded).
-     */
-    transakCancelAllActiveOrders(): Promise<Error[]>;
-    /**
-     * Fetches all active Transak orders for the authenticated user.
-     *
-     * @returns The list of active orders.
-     */
-    transakGetActiveOrders(): Promise<TransakOrder[]>;
-}
-export {};
-//# sourceMappingURL=RampsController.d.mts.map