@imtbl/sdk 0.17.2 → 0.17.3

package/dist/index.d.ts

@@ -14513,14 +14513,45 @@ interface CheckoutModuleConfiguration extends ModuleConfiguration<CheckoutOverri
  * A type representing various remotely defined configurations which are
  * accessible via the Checkout config and configured based on the Environment.
  * @property {DexConfig} dex - The config used for the DEX.
+ * @property {OnRampConfig} onramp - The config used for the OnRamp
  * @property {AllowedNetworkConfig[]} allowedNetworks - An array representing the allowed networks.
  * @property {GasEstimateTokenConfig | undefined} gasEstimateTokens - The config for the tokens used to estimate gas.
  */
 type RemoteConfiguration = {
     dex: DexConfig;
+    onramp: OnRampConfig;
     allowedNetworks: AllowedNetworkConfig[];
     gasEstimateTokens?: GasEstimateTokenConfig;
 };
+/**
+ * A type representing the fee structure for an OnRamp provider
+ * @property {string | undefined} minPercentage - minimum percentage fee shown if a fee range is provided
+ * @property {string | undefined} maxPercentage - maximum percentage fee shown if a fee range is provided
+ * @property {string | undefined} feePercentage - specific fee percentage shown if there is no range provided
+ */
+type OnRampProviderFees = {
+    minPercentage?: string;
+    maxPercentage?: string;
+    feePercentage?: string;
+};
+/**
+ * A type representing the configuration for the OnRamp for a specific provider.
+ * @property {string} publishableApiKey - on ramp provider publishable api-key
+ * @property {TokenInfo[]} tokens - allowed tokens for the OnRamp provider
+ * @property {OnRampProviderFees} fees - on ramp provider transaction fees
+ */
+type OnRampProviderConfig = {
+    publishableApiKey: string;
+    tokens: TokenInfo[];
+    fees: OnRampProviderFees;
+};
+/**
+ * A type representing the configuration for the OnRamp.
+ * @property {OnRampProviderConfig} transak - OnRamp config for Transak provider
+ */
+type OnRampConfig = {
+    [key: string]: OnRampProviderConfig;
+};
 /**
  * A type representing the configuration for the DEX.
  * @property {ExchangeOverrides | undefined} overrides - The DEX overrides.
@@ -14851,7 +14882,8 @@ interface GetTokenAllowListResult {
 declare enum TokenFilterTypes {
     ALL = "all",
     SWAP = "swap",
-    BRIDGE = "bridge"
+    BRIDGE = "bridge",
+    ONRAMP = "onramp"
 }
 /**
  * Interface representing a token filter that can be used to exclude certain tokens.
@@ -14964,6 +14996,29 @@ type NetworkDetails = {
     blockExplorerUrls?: string[];
 };
 type NetworkMap = Map<ChainId, NetworkDetails>;
+/**
+ * An enum representing the type of exchange.
+ * @enum {string}
+ * @property {string} ONRAMP - The exchange type for transacting.
+ */
+declare enum ExchangeType {
+    ONRAMP = "onramp"
+}
+/**
+ * Interface representing the result of {@link Checkout.createFiatRampUrl}.
+ * @property {ExchangeType} exchangeType - The ExchangeType specified.
+ * @property {Web3Provider} web3Provider - The Web3Provider used to exchange.
+ * @property {string | undefined} tokenAmount - The token amount specified as input.
+ * @property {string | undefined} tokenAddress - The token address specified as input.
+ * @property {Passport | undefined} passport - The Passport instance specified as input.
+ */
+interface FiatRampParams {
+    exchangeType: ExchangeType;
+    web3Provider: Web3Provider;
+    tokenAmount?: string;
+    tokenAddress?: string;
+    passport?: Passport;
+}
 /**
  * Enum representing different types of errors that can occur during the checkout process.
  */
@@ -15032,8 +15087,27 @@ declare class CheckoutConfiguration {
     readonly networkMap: NetworkMap;
     constructor(config: CheckoutModuleConfiguration);
 }
+interface FiatRampWidgetParams {
+    exchangeType: ExchangeType;
+    isPassport: boolean;
+    walletAddress?: string;
+    tokenAmount?: string;
+    tokenSymbol?: string;
+    email?: string;
+}
+declare class FiatRampService {
+    readonly config: CheckoutConfiguration;
+    /**
+     * Constructs a new instance of the FiatRampService class.
+     * @param {CheckoutConfiguration} config - The config required for the FiatRampService.
+     */
+    constructor(config: CheckoutConfiguration);
+    feeEstimate(): Promise<OnRampProviderFees>;
+    createWidgetUrl(params: FiatRampWidgetParams): Promise<string>;
+}
 declare class Checkout {
     readonly config: CheckoutConfiguration;
+    readonly fiatRampService: FiatRampService;
     /**
      * Constructs a new instance of the CheckoutModule class.
      * @param {CheckoutModuleConfiguration} [config=SANDBOX_CONFIGURATION] - The configuration object for the CheckoutModule.
@@ -15138,6 +15212,17 @@ declare class Checkout {
      * @returns {Promise<GasEstimateSwapResult | GasEstimateBridgeToL2Result>} - A promise that resolves to the gas estimation result.
      */
     gasEstimate(params: GasEstimateParams): Promise<GasEstimateSwapResult | GasEstimateBridgeToL2Result>;
+    /**
+     * Creates and returns a URL for the fiat ramp widget.
+     * @param {FiatRampParams} params - The parameters for creating the url.
+     * @returns {Promise<string>} - A promise that resolves to a string url.
+     */
+    createFiatRampUrl(params: FiatRampParams): Promise<string>;
+    /**
+     * Fetches fiat ramp fee estimations.
+     * @returns {Promise<OnRampProviderFees>} - A promise that resolves to OnRampProviderFees.
+     */
+    getExchangeFeeEstimate(): Promise<OnRampProviderFees>;
 }
 
 type checkout_sdk_d_AllowedNetworkConfig = AllowedNetworkConfig;
@@ -15160,6 +15245,9 @@ type checkout_sdk_d_ConnectParams = ConnectParams;
 type checkout_sdk_d_ConnectResult = ConnectResult;
 type checkout_sdk_d_DexConfig = DexConfig;
 type checkout_sdk_d_ErrorType = ErrorType;
+type checkout_sdk_d_ExchangeType = ExchangeType;
+declare const checkout_sdk_d_ExchangeType: typeof ExchangeType;
+type checkout_sdk_d_FiatRampParams = FiatRampParams;
 type checkout_sdk_d_GasEstimateBridgeToL2Result = GasEstimateBridgeToL2Result;
 type checkout_sdk_d_GasEstimateParams = GasEstimateParams;
 type checkout_sdk_d_GasEstimateSwapResult = GasEstimateSwapResult;
@@ -15223,6 +15311,8 @@ declare namespace checkout_sdk_d {
     checkout_sdk_d_ConnectResult as ConnectResult,
     checkout_sdk_d_DexConfig as DexConfig,
     checkout_sdk_d_ErrorType as ErrorType,
+    checkout_sdk_d_ExchangeType as ExchangeType,
+    checkout_sdk_d_FiatRampParams as FiatRampParams,
     checkout_sdk_d_GasEstimateBridgeToL2Result as GasEstimateBridgeToL2Result,
     checkout_sdk_d_GasEstimateParams as GasEstimateParams,
     checkout_sdk_d_GasEstimateSwapResult as GasEstimateSwapResult,
@@ -29703,7 +29793,8 @@ declare enum CheckoutWidgetTagNames {
     CONNECT = "imtbl-connect",
     WALLET = "imtbl-wallet",
     SWAP = "imtbl-swap",
-    BRIDGE = "imtbl-bridge"
+    BRIDGE = "imtbl-bridge",
+    ONRAMP = "imtbl-onramp"
 }
 /**
  * Represents the version of the Checkout Widgets to use defaults to (0.1.9-alpha)
@@ -29731,6 +29822,7 @@ type SemanticVersion = {
  * @property {WidgetTheme | undefined} theme - The theme of the Checkout Widget (default: "DARK")
  * @property {Environment | undefined} environment - The environment configuration (default: "SANDBOX")
  * @property {SemanticVersion | undefined} version - The version of the checkout widgets js file to use (default: "0.1.0")
+ * @property {boolean | undefined} isOnRampEnabled - Enable on-ramp top-up method (default: "true")
  * @property {boolean | undefined} isSwapEnabled - Enable swap top-up method (default: "true")
  * @property {boolean | undefined} isBridgeEnabled - Enable bridge top-up method (default: "true")
  */
@@ -29738,6 +29830,7 @@ type CheckoutWidgetsConfig = {
     theme?: WidgetTheme;
     environment?: Environment;
     version?: SemanticVersion;
+    isOnRampEnabled?: boolean;
     isSwapEnabled?: boolean;
     isBridgeEnabled?: boolean;
 };
@@ -29803,6 +29896,30 @@ type ConnectionSuccess = {
 type ConnectionFailed = {
     reason: string;
 };
+/**
+ * Enum of possible OnRamp Widget event types.
+ */
+declare enum OnRampEventType {
+    CLOSE_WIDGET = "close-widget",
+    SUCCESS = "success",
+    FAILURE = "failure"
+}
+/**
+ * Represents a successful on-ramp transaction.
+ * @property {string} transactionHash - The transaction hash of the successful transaction.
+ */
+type OnRampSuccess = {
+    transactionHash: string;
+};
+/**
+ * Type representing a On-ramp Widget with type FAILURE.
+ * @property {string} reason - The reason why the on-ramp failed.
+ * @property {number} timestamp - The timestamp of the failed transaction.
+ */
+type OnRampFailed = {
+    reason: string;
+    timestamp: number;
+};
 /**
  * Enum representing different types of orchestration events.
  */
@@ -29920,16 +30037,17 @@ declare enum IMTBLWidgetEvents {
     IMTBL_CONNECT_WIDGET_EVENT = "imtbl-connect-widget",
     IMTBL_WALLET_WIDGET_EVENT = "imtbl-wallet-widget",
     IMTBL_SWAP_WIDGET_EVENT = "imtbl-swap-widget",
-    IMTBL_BRIDGE_WIDGET_EVENT = "imtbl-bridge-widget"
+    IMTBL_BRIDGE_WIDGET_EVENT = "imtbl-bridge-widget",
+    IMTBL_ONRAMP_WIDGET_EVENT = "imtbl-onramp-widget"
 }
 /**
  * Represents an event emitted by a widget.
  * @template T - The type of data associated with the event.
- * @property {OrchestrationEventType | ConnectEventType | WalletEventType | SwapEventType | BridgeEventType} type - The type of the event.
+ * @property {OrchestrationEventType | ConnectEventType | WalletEventType | SwapEventType | BridgeEventType | OnRampEventType} type - The type of the event.
  * @property {T} data - The data associated with the event.
  */
 type WidgetEvent<T> = {
-    type: OrchestrationEventType | ConnectEventType | WalletEventType | SwapEventType | BridgeEventType;
+    type: OrchestrationEventType | ConnectEventType | WalletEventType | SwapEventType | BridgeEventType | OnRampEventType;
     data: T;
 };
 /**
@@ -29945,7 +30063,8 @@ type WidgetEvent<T> = {
  * @property {ImtblWalletProps} 'imtbl-wallet' - Props for the 'imtbl-wallet' component.
  * @property {ImtblSwapProps} 'imtbl-swap' - Props for the 'imtbl-swap' component.
  * @property {ImtblBridgeProps} 'imtbl-bridge' - Props for the 'imtbl-bridge' component.
- */
+ * @property {ImtblOnRampProps} 'imtbl-onramp' - Props for the 'imtbl-onramp' component.
+ * */
 declare global {
     interface Window {
         ImtblCheckoutWidgetConfig: any;
@@ -29956,6 +30075,7 @@ declare global {
             'imtbl-wallet': ImtblWalletProps;
             'imtbl-swap': ImtblSwapProps;
             'imtbl-bridge': ImtblBridgeProps;
+            'imtbl-onramp': ImtblOnRampProps;
         }
     }
     interface ImmutableWebComponent {
@@ -30020,6 +30140,22 @@ interface ImtblBridgeProps extends React.DetailedHTMLProps<React.HTMLAttributes<
     fromContractAddress?: string;
     amount?: string;
 }
+/**
+ * Interface for the properties of a bridge web component.
+ * Extends the React.DetailedHTMLProps interface to inherit HTML attributes for the component's root element.
+ * @interface ImtblOnRampProps
+ * @extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement>
+ * @property {string | undefined} walletProvider - The preferred wallet provider to connect to.
+ * @property {string | undefined} widgetConfig - The configuration for the bridge widget.
+ * @property {string | undefined} amount - The amount to onramp.
+ * @property {string | undefined} contractAddress - The contract address of the token to on ramp.
+ */
+interface ImtblOnRampProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
+    walletProvider?: string;
+    widgetConfig?: string;
+    amount?: string;
+    contractAddress?: string;
+}
 /**
  * Interface representing the props for the Bridge Widget component.
  * @interface BridgeReactProps
@@ -30097,6 +30233,28 @@ interface WalletReactProps {
  * @returns {JSX.Element} - The rendered Wallet Widget component.
  */
 declare function WalletReact(props: WalletReactProps): JSX.Element;
+/**
+ * Interface representing the props for the on-ramp Widget component.
+ * @interface OnRampReactProps
+ * @property {WalletProviderName | undefined} walletProvider - The name of the wallet provider.
+ * @property {Web3Provider | undefined} provider - The Web3 provider.
+ * @property {Passport | undefined} passport - The Passport instance to create a Web3Provider.
+ * @property {string | undefined} amount - The amount.
+ * @property {string | undefined} contractAddress - The contract address of the token to on ramp
+ */
+interface OnRampReactProps {
+    walletProvider?: WalletProviderName;
+    provider?: Web3Provider;
+    passport?: Passport;
+    amount?: string;
+    contractAddress?: string;
+}
+/**
+ * A React functional component that renders the Checkout on-ramp Widget.
+ * @param {OnRampReactProps} props - The props for the On-ramp Widget component.
+ * @returns {JSX.Element} - The rendered Bridge Widget component.
+ */
+declare function OnRampReact(props: OnRampReactProps): JSX.Element;
 
 type checkout_widgets_d_BridgeEventType = BridgeEventType;
 declare const checkout_widgets_d_BridgeEventType: typeof BridgeEventType;
@@ -30118,8 +30276,15 @@ type checkout_widgets_d_IMTBLWidgetEvents = IMTBLWidgetEvents;
 declare const checkout_widgets_d_IMTBLWidgetEvents: typeof IMTBLWidgetEvents;
 type checkout_widgets_d_ImtblBridgeProps = ImtblBridgeProps;
 type checkout_widgets_d_ImtblConnectProps = ImtblConnectProps;
+type checkout_widgets_d_ImtblOnRampProps = ImtblOnRampProps;
 type checkout_widgets_d_ImtblSwapProps = ImtblSwapProps;
 type checkout_widgets_d_ImtblWalletProps = ImtblWalletProps;
+type checkout_widgets_d_OnRampEventType = OnRampEventType;
+declare const checkout_widgets_d_OnRampEventType: typeof OnRampEventType;
+type checkout_widgets_d_OnRampFailed = OnRampFailed;
+declare const checkout_widgets_d_OnRampReact: typeof OnRampReact;
+type checkout_widgets_d_OnRampReactProps = OnRampReactProps;
+type checkout_widgets_d_OnRampSuccess = OnRampSuccess;
 type checkout_widgets_d_OrchestrationEventType = OrchestrationEventType;
 declare const checkout_widgets_d_OrchestrationEventType: typeof OrchestrationEventType;
 type checkout_widgets_d_RequestBridgeEvent = RequestBridgeEvent;
@@ -30163,8 +30328,14 @@ declare namespace checkout_widgets_d {
     checkout_widgets_d_IMTBLWidgetEvents as IMTBLWidgetEvents,
     checkout_widgets_d_ImtblBridgeProps as ImtblBridgeProps,
     checkout_widgets_d_ImtblConnectProps as ImtblConnectProps,
+    checkout_widgets_d_ImtblOnRampProps as ImtblOnRampProps,
     checkout_widgets_d_ImtblSwapProps as ImtblSwapProps,
     checkout_widgets_d_ImtblWalletProps as ImtblWalletProps,
+    checkout_widgets_d_OnRampEventType as OnRampEventType,
+    checkout_widgets_d_OnRampFailed as OnRampFailed,
+    checkout_widgets_d_OnRampReact as OnRampReact,
+    checkout_widgets_d_OnRampReactProps as OnRampReactProps,
+    checkout_widgets_d_OnRampSuccess as OnRampSuccess,
     checkout_widgets_d_OrchestrationEventType as OrchestrationEventType,
     checkout_widgets_d_RequestBridgeEvent as RequestBridgeEvent,
     checkout_widgets_d_RequestConnectEvent as RequestConnectEvent,