@imtbl/sdk 0.17.2 → 0.17.4

package/dist/checkout_widgets.d.ts

@@ -25344,7 +25344,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)
@@ -25372,6 +25373,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")
  */
@@ -25379,6 +25381,7 @@ type CheckoutWidgetsConfig = {
     theme?: WidgetTheme;
     environment?: Environment;
     version?: SemanticVersion;
+    isOnRampEnabled?: boolean;
     isSwapEnabled?: boolean;
     isBridgeEnabled?: boolean;
 };
@@ -25444,6 +25447,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.
  */
@@ -25561,16 +25588,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;
 };
 /**
@@ -25586,7 +25614,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;
@@ -25597,6 +25626,7 @@ declare global {
             'imtbl-wallet': ImtblWalletProps;
             'imtbl-swap': ImtblSwapProps;
             'imtbl-bridge': ImtblBridgeProps;
+            'imtbl-onramp': ImtblOnRampProps;
         }
     }
     interface ImmutableWebComponent {
@@ -25661,6 +25691,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
@@ -25738,5 +25784,27 @@ 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;
 
-export { BridgeEventType, BridgeFailed, BridgeReact, BridgeReactProps, BridgeSuccess, CheckoutWidgetTagNames, CheckoutWidgets, CheckoutWidgetsConfig, ConnectEventType, ConnectReact, ConnectReactProps, ConnectionFailed, ConnectionSuccess, IMTBLWidgetEvents, ImtblBridgeProps, ImtblConnectProps, ImtblSwapProps, ImtblWalletProps, OrchestrationEventType, RequestBridgeEvent, RequestConnectEvent, RequestOnrampEvent, RequestSwapEvent, RequestWalletEvent, SemanticVersion, SwapEventType, SwapFailed, SwapReact, SwapReactProps, SwapRejected, SwapSuccess, UpdateConfig, WalletDisconnectWalletEvent, WalletEventType, WalletNetworkSwitchEvent, WalletReact, WalletReactProps, WidgetEvent, WidgetTheme };
+export { BridgeEventType, BridgeFailed, BridgeReact, BridgeReactProps, BridgeSuccess, CheckoutWidgetTagNames, CheckoutWidgets, CheckoutWidgetsConfig, ConnectEventType, ConnectReact, ConnectReactProps, ConnectionFailed, ConnectionSuccess, IMTBLWidgetEvents, ImtblBridgeProps, ImtblConnectProps, ImtblOnRampProps, ImtblSwapProps, ImtblWalletProps, OnRampEventType, OnRampFailed, OnRampReact, OnRampReactProps, OnRampSuccess, OrchestrationEventType, RequestBridgeEvent, RequestConnectEvent, RequestOnrampEvent, RequestSwapEvent, RequestWalletEvent, SemanticVersion, SwapEventType, SwapFailed, SwapReact, SwapReactProps, SwapRejected, SwapSuccess, UpdateConfig, WalletDisconnectWalletEvent, WalletEventType, WalletNetworkSwitchEvent, WalletReact, WalletReactProps, WidgetEvent, WidgetTheme };

package/dist/checkout_widgets.js

@@ -4,7 +4,7 @@ import { useEffect } from 'react';
 function $parcel$export(e, n, v, s) {
   Object.defineProperty(e, n, {get: v, set: s, enumerable: true, configurable: true});
 }
-const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.17.2";
+const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.17.4";
 const $d663162fd5a0853f$export$83bf90b30cdfd29f = ()=>false;
 const $d663162fd5a0853f$export$1169f5475725171b = ()=>$d663162fd5a0853f$export$38a083d9fb5551ca;
 
@@ -69,6 +69,7 @@ var $207ed853f11d19d5$export$5a0ace85cae72d45;
     IMTBLWidgetEvents["IMTBL_WALLET_WIDGET_EVENT"] = "imtbl-wallet-widget";
     IMTBLWidgetEvents["IMTBL_SWAP_WIDGET_EVENT"] = "imtbl-swap-widget";
     IMTBLWidgetEvents["IMTBL_BRIDGE_WIDGET_EVENT"] = "imtbl-bridge-widget";
+    IMTBLWidgetEvents["IMTBL_ONRAMP_WIDGET_EVENT"] = "imtbl-onramp-widget";
 })($207ed853f11d19d5$export$5a0ace85cae72d45 || ($207ed853f11d19d5$export$5a0ace85cae72d45 = {}));
 
 
@@ -134,6 +135,19 @@ $parcel$export($ad06b030b1a3ba34$exports, "OrchestrationEventType", () => $ad06b
     OrchestrationEventType["REQUEST_BRIDGE"] = "request-bridge";
     OrchestrationEventType["REQUEST_ONRAMP"] = "request-onramp";
 })($ad06b030b1a3ba34$export$b80d2daf830437b9 || ($ad06b030b1a3ba34$export$b80d2daf830437b9 = {}));
+
+
+var $d882ddc5600b1284$exports = {};
+
+$parcel$export($d882ddc5600b1284$exports, "OnRampEventType", () => $d882ddc5600b1284$export$66ec39c0924078d8);
+/**
+ * Enum of possible OnRamp Widget event types.
+ */ var $d882ddc5600b1284$export$66ec39c0924078d8;
+(function(OnRampEventType) {
+    OnRampEventType["CLOSE_WIDGET"] = "close-widget";
+    OnRampEventType["SUCCESS"] = "success";
+    OnRampEventType["FAILURE"] = "failure";
+})($d882ddc5600b1284$export$66ec39c0924078d8 || ($d882ddc5600b1284$export$66ec39c0924078d8 = {}));
 /* eslint-disable @typescript-eslint/naming-convention */ 
 
 var $045213b18e9f1f94$exports = {};
@@ -154,6 +168,7 @@ var $045213b18e9f1f94$export$75be0f6af9650f2c;
     CheckoutWidgetTagNames["WALLET"] = "imtbl-wallet";
     CheckoutWidgetTagNames["SWAP"] = "imtbl-swap";
     CheckoutWidgetTagNames["BRIDGE"] = "imtbl-bridge";
+    CheckoutWidgetTagNames["ONRAMP"] = "imtbl-onramp";
 })($045213b18e9f1f94$export$75be0f6af9650f2c || ($045213b18e9f1f94$export$75be0f6af9650f2c = {}));
 
 
@@ -322,4 +337,31 @@ function $89d55ace0f8f1c07$export$ceaac94f34dba154(props) {
     });
 }
 
-export { $15cc9e120aa6f3bf$export$d1bfa21f7c76447a as BridgeEventType, $1f969328e5988c99$export$30f61ebf204c69f6 as BridgeReact, $045213b18e9f1f94$export$75be0f6af9650f2c as CheckoutWidgetTagNames, $430e3eda76fa4d5f$export$af210a0808087845 as CheckoutWidgets, $a85ecdbd885c58ad$export$e72e7f9969a47dd3 as ConnectEventType, $f2083cd30e2f5c56$export$49d62957f420a1e2 as ConnectReact, $207ed853f11d19d5$export$5a0ace85cae72d45 as IMTBLWidgetEvents, $ad06b030b1a3ba34$export$b80d2daf830437b9 as OrchestrationEventType, $53d219e7f6bf0cd6$export$140a49745ab55563 as SwapEventType, $a4fbb8e3a6aeff58$export$971e031379577f4 as SwapReact, $430e3eda76fa4d5f$export$bf1548ba7e61c17f as UpdateConfig, $77b6aac5c353d4a9$export$d9be06b70b28c742 as WalletEventType, $89d55ace0f8f1c07$export$ceaac94f34dba154 as WalletReact, $045213b18e9f1f94$export$c88931fdc51854eb as WidgetTheme };
+
+var $f94f63f2c041a04c$exports = {};
+
+$parcel$export($f94f63f2c041a04c$exports, "OnRampReact", () => $f94f63f2c041a04c$export$9e363c61ea99bbb4);
+
+
+
+
+
+function $f94f63f2c041a04c$export$9e363c61ea99bbb4(props) {
+    const { walletProvider: walletProvider, amount: amount, provider: provider, passport: passport, contractAddress: contractAddress } = props;
+    (useEffect)(()=>{
+        if (provider) ($77ec335383336bdd$export$931068bc678f0d73)(($045213b18e9f1f94$export$75be0f6af9650f2c).ONRAMP, provider);
+        if (passport) ($b222a8f062090058$export$fae4199086a966a3)(($045213b18e9f1f94$export$75be0f6af9650f2c).ONRAMP, passport);
+    }, [
+        provider,
+        passport
+    ]);
+    const config = window.ImtblCheckoutWidgetConfig;
+    return /*#__PURE__*/ (jsx)("imtbl-onramp", {
+        widgetConfig: config,
+        walletProvider: walletProvider,
+        amount: amount ?? "",
+        contractAddress: contractAddress ?? ""
+    });
+}
+
+export { $15cc9e120aa6f3bf$export$d1bfa21f7c76447a as BridgeEventType, $1f969328e5988c99$export$30f61ebf204c69f6 as BridgeReact, $045213b18e9f1f94$export$75be0f6af9650f2c as CheckoutWidgetTagNames, $430e3eda76fa4d5f$export$af210a0808087845 as CheckoutWidgets, $a85ecdbd885c58ad$export$e72e7f9969a47dd3 as ConnectEventType, $f2083cd30e2f5c56$export$49d62957f420a1e2 as ConnectReact, $207ed853f11d19d5$export$5a0ace85cae72d45 as IMTBLWidgetEvents, $d882ddc5600b1284$export$66ec39c0924078d8 as OnRampEventType, $f94f63f2c041a04c$export$9e363c61ea99bbb4 as OnRampReact, $ad06b030b1a3ba34$export$b80d2daf830437b9 as OrchestrationEventType, $53d219e7f6bf0cd6$export$140a49745ab55563 as SwapEventType, $a4fbb8e3a6aeff58$export$971e031379577f4 as SwapReact, $430e3eda76fa4d5f$export$bf1548ba7e61c17f as UpdateConfig, $77b6aac5c353d4a9$export$d9be06b70b28c742 as WalletEventType, $89d55ace0f8f1c07$export$ceaac94f34dba154 as WalletReact, $045213b18e9f1f94$export$c88931fdc51854eb as WidgetTheme };

package/dist/immutablex_client.js

@@ -16,7 +16,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.17.2',
+    sdkVersion: 'ts-immutable-sdk-0.17.4',
 });
 /**
  * Sets `sdkVersion` at the time of build