@imtbl/sdk 0.1.4-alpha → 0.1.5-alpha

package/dist/index.d.ts

@@ -10360,7 +10360,7 @@ declare class ImmutableXClient {
     getDeposit(request: DepositsApiGetDepositRequest): Promise<Deposit>;
     /**
      * Get a list of Deposits
-     * @param request - optional request object containing the parameters to be provided in the API request
+     * @param request - optional object containing the parameters to be provided in the API request
      * @returns a promise that resolves with the requested list of Deposits
      * @throws {@link index.IMXError}
      */
@@ -10381,7 +10381,7 @@ declare class ImmutableXClient {
     getAsset(request: AssetsApiGetAssetRequest): Promise<Asset>;
     /**
      * Get a list of Assets
-     * @param request - optional request object containing the parameters to be provided in the API request
+     * @param request - optional object containing the parameters to be provided in the API request
      * @returns a promise that resolves with the requested list of Assets
      * @throws {@link index.IMXError}
      */
@@ -10410,7 +10410,7 @@ declare class ImmutableXClient {
     listCollectionFilters(request: CollectionsApiListCollectionFiltersRequest): Promise<CollectionFilter>;
     /**
      * Get a list of Collections
-     * @param request - optional request object containing the parameters to be provided in the API request
+     * @param request - optional object containing the parameters to be provided in the API request
      * @returns a promise that resolves with the requested list of Collections
      * @throws {@link index.IMXError}
      */
@@ -10536,7 +10536,7 @@ declare class ImmutableXClient {
     getMint(request: MintsApiGetMintRequest): Promise<Mint[]>;
     /**
      * Get a list of Mints
-     * @param request optional request object containing the parameters to be provided in the API request
+     * @param request optional object containing the parameters to be provided in the API request
      * @returns a promise that resolves with the requested list of Mints
      * @throws {@link index.IMXError}
      */
@@ -10551,7 +10551,7 @@ declare class ImmutableXClient {
     mint(ethSigner: Signer, request: UnsignedMintRequest): Promise<MintTokensResponse>;
     /**
      * Get a list of Withdrawals
-     * @param request - optional request object containing the parameters to be provided in the API request
+     * @param request - optional object containing the parameters to be provided in the API request
      * @returns a promise that resolves with the requested list of Withdrawals
      * @throws {@link index.IMXError}
      */
@@ -10572,7 +10572,7 @@ declare class ImmutableXClient {
     getOrder(request: OrdersApiGetOrderRequest): Promise<Order>;
     /**
      * Get a list of Orders
-     * @param request - optional request object containing the parameters to be provided in the API request
+     * @param request - optional object containing the parameters to be provided in the API request
      * @returns a promise that resolves with the requested list of Orders
      * @throws {@link index.IMXError}
      */
@@ -10586,7 +10586,7 @@ declare class ImmutableXClient {
     getTrade(request: TradesApiGetTradeRequest): Promise<Trade>;
     /**
      * Get a list of Trades
-     * @param request - optional request object containing the parameters to be provided in the API request
+     * @param request - optional object containing the parameters to be provided in the API request
      * @returns a promise that resolves with the requested list of Trades
      * @throws {@link index.IMXError}
      */
@@ -10600,7 +10600,7 @@ declare class ImmutableXClient {
     getToken(request: TokensApiGetTokenRequest): Promise<TokenDetails>;
     /**
      * Get a list of Tokens
-     * @param request - optional request object containing the parameters to be provided in the API request
+     * @param request - optional object containing the parameters to be provided in the API request
      * @returns a promise that resolves with the requested list of Tokens
      * @throws {@link index.IMXError}
      */
@@ -10614,7 +10614,7 @@ declare class ImmutableXClient {
     getTransfer(request: TransfersApiGetTransferRequest): Promise<Transfer>;
     /**
      * Get a list of Transfers
-     * @param request - optional request object containing the parameters to be provided in the API request
+     * @param request - optional object containing the parameters to be provided in the API request
      * @returns a promise that resolves with the requested list of Transfers
      * @throws {@link index.IMXError}
      */
@@ -10888,7 +10888,7 @@ interface TokenInfo {
  */
 interface GetTokenAllowListParams {
     type: TokenFilterTypes;
-    chainId: ChainId;
+    chainId?: ChainId;
     exclude?: TokenFilter[];
 }
 /**
@@ -11146,6 +11146,57 @@ declare enum WalletFilterTypes {
     DESKTOP = "desktop",
     MOBILE = "mobile"
 }
+/**
+ * Enum representing the types of token filters available.
+ */
+declare enum SupportedFiatCurrencies {
+    USD = "USD"
+}
+/**
+ * Interface representing the parameters for {@link Checkout.convertTokenToFiat}.
+ * @property {BigNumber} amount - The the amount of token we are converting.
+ * @property {TokenInfo} token - The token we are converting from.
+ * @property {SupportedFiatCurrencies}  fiatSymbol - The fiat currency we are converting to.
+ */
+interface ConvertTokensToFiatParams {
+    amounts: {
+        [key: string]: {
+            amount: BigNumber;
+            token: TokenInfo;
+        };
+    };
+    fiatSymbol: SupportedFiatCurrencies;
+}
+/**
+ * Interface representing the result of a specific token to fiat conversion.
+ * @property {TokenInfo} token - The token that we converted from.
+ * @property {string} fiatSymbol - The fiat currency we converted to.
+ * @property {number} quotedAt - The unix timestamp for when the quote was generated.
+ * @property {number} quote - The quote at the given timestamp.
+ * @property {BigNumber} amount - The amount we converted.
+ * @property {number} convertedAmount - The converted amount.
+ */
+interface TokenToFiatConversionResult extends FiatConversionQuote {
+    token: TokenInfo;
+    fiatSymbol: string;
+    amount: BigNumber;
+    convertedAmount: number;
+}
+/**
+ * Interface representing the result of {@link Checkout.convertTokenToFiat}.
+ */
+interface ConvertTokensToFiatResult {
+    [key: string]: TokenToFiatConversionResult;
+}
+/**
+ * Interface representing the result of a specific token to fiat conversion.
+ * @property {number} quotedAt - The unix timestamp for when the quote was generated.
+ * @property {number} quote - The quote at the given timestamp.
+ */
+interface FiatConversionQuote {
+    quote: number;
+    quotedAt: number;
+}
 /**
  * The different types of errors that can be returned by the checkout process.
  */
@@ -11160,7 +11211,10 @@ declare enum CheckoutErrorType {
     PROVIDER_REQUEST_MISSING_ERROR = "PROVIDER_REQUEST_MISSING_ERROR",
     PROVIDER_REQUEST_FAILED_ERROR = "PROVIDER_REQUEST_FAILED_ERROR",
     USER_REJECTED_REQUEST_ERROR = "USER_REJECTED_REQUEST_ERROR",
-    TRANSACTION_ERROR = "TRANSACTION_ERROR"
+    TRANSACTION_ERROR = "TRANSACTION_ERROR",
+    FIAT_CONVERSION_ERROR = "FIAT_CONVERSION_ERROR",
+    TOKEN_NOT_SUPPORTED_ERROR = "TOKEN_NOT_SUPPORTED_ERROR",
+    FIAT_CURRENCY_NOT_SUPPORTED_ERROR = "FIAT_CURRENCY_NOT_SUPPORTED_ERROR"
 }
 /**
  * The type signature for an error.
@@ -25696,5 +25750,56 @@ declare enum WidgetTheme {
     DARK = "dark",
     CUSTOM = "custom"
 }
-
-export { BridgeEvent, BridgeEventType, BridgeFailed, BridgeSuccess, BuyClose, BuyEvent, BuyEventType, BuyFailed, BuyNotConnected, BuySuccess, ChainId, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutErrorType, ConnectEvent, ConnectEventType, ConnectParams, ConnectResult, ConnectionFailed, ConnectionProviders, ConnectionSuccess, Environment, ErrorType, GenericIMXProvider, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetWalletAllowListParams, GetWalletAllowListResult, IMTBLWidgetEvents, IMXProvider, ImmutableConfiguration, ImmutableXClient, ImtblBridgeProps, ImtblBuyProps, ImtblConnectProps, ImtblExampleProps, ImtblInnerWidgetExampleProps, ImtblOuterWidgetExampleProps, ImtblSwapProps, ImtblTransitionExampleProps, ImtblWalletProps, ImxModuleConfiguration as ImxClientModuleConfiguration, WalletConnection as ImxClientWalletConnection, MetaMaskIMXProvider, ModuleConfiguration, Network, NetworkFilter, NetworkFilterTypes, NetworkInfo, Passport, PassportError, PassportModuleConfiguration, ProviderConfiguration, SendTransactionParams, SendTransactionResult, SwapEvent, SwapEventType, SwapFailed, SwapSuccess, SwitchNetworkParams, SwitchNetworkResult, TokenFilter, TokenFilterTypes, TokenInfo, Transaction, WalletEvent, WalletEventType, WalletFilter, WalletFilterTypes, WalletInfo, WalletNetworkSwitchEvent, WidgetTheme, createStarkSigner as imxClientCreateStarkSigner, generateLegacyStarkPrivateKey as imxClientGenerateLegacyStarkPrivateKey };
+declare enum WidgetConnectionProviders {
+    METAMASK = "metamask"
+}
+declare enum CheckoutWidgetTagNames {
+    CONNECT = "imtbl-connect",
+    WALLET = "imtbl-wallet",
+    SWAP = "imtbl-swap",
+    BUY = "imtbl-buy",
+    BRIDGE = "imtbl-bridge",
+    EXAMPLe = "imtbl-example"
+}
+type CheckoutWidgetsConfig = {
+    theme?: WidgetTheme;
+};
+interface BridgeReactProps {
+    providerPreference: WidgetConnectionProviders;
+    fromContractAddress?: string;
+    amount?: string;
+    fromNetwork?: Network;
+}
+declare function BridgeReact(props: BridgeReactProps): JSX.Element;
+interface BuyReactProps {
+    providerPreference: WidgetConnectionProviders;
+    orderId: string;
+}
+declare function BuyReact(props: BuyReactProps): JSX.Element;
+declare function CheckoutWidgets(config?: CheckoutWidgetsConfig): void;
+declare function UpdateConfig(config: CheckoutWidgetsConfig): void;
+declare function SetProvider(tagName: CheckoutWidgetTagNames, provider: Web3Provider | null): void;
+interface ConnectReactProps {
+    providerPreference?: WidgetConnectionProviders;
+}
+declare function ConnectReact(props: ConnectReactProps): JSX.Element;
+interface SwapReactProps {
+    providerPreference: WidgetConnectionProviders;
+    fromContractAddress?: string;
+    amount?: string;
+    toContractAddress?: string;
+}
+declare function SwapReact(props: SwapReactProps): JSX.Element;
+interface WalletReactProps {
+    providerPreference?: WidgetConnectionProviders;
+}
+declare function WalletReact(props: WalletReactProps): JSX.Element;
+interface ExampleReactProps {
+    providerPreference: WidgetConnectionProviders;
+    fromContractAddress?: string;
+    amount?: string;
+    fromNetwork?: Network;
+}
+declare function ExampleReact(props: ExampleReactProps): JSX.Element;
+
+export { BridgeEvent, BridgeEventType, BridgeFailed, BridgeReact, BridgeReactProps, BridgeSuccess, BuyClose, BuyEvent, BuyEventType, BuyFailed, BuyNotConnected, BuyReact, BuyReactProps, BuySuccess, ChainId, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutErrorType, CheckoutWidgetTagNames, CheckoutWidgets, CheckoutWidgetsConfig, ConnectEvent, ConnectEventType, ConnectParams, ConnectReact, ConnectReactProps, ConnectResult, ConnectionFailed, ConnectionProviders, ConnectionSuccess, ConvertTokensToFiatParams, ConvertTokensToFiatResult, Environment, ErrorType, ExampleReact, ExampleReactProps, GenericIMXProvider, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetWalletAllowListParams, GetWalletAllowListResult, IMTBLWidgetEvents, IMXProvider, ImmutableConfiguration, ImmutableXClient, ImtblBridgeProps, ImtblBuyProps, ImtblConnectProps, ImtblExampleProps, ImtblInnerWidgetExampleProps, ImtblOuterWidgetExampleProps, ImtblSwapProps, ImtblTransitionExampleProps, ImtblWalletProps, ImxModuleConfiguration as ImxClientModuleConfiguration, WalletConnection as ImxClientWalletConnection, MetaMaskIMXProvider, ModuleConfiguration, Network, NetworkFilter, NetworkFilterTypes, NetworkInfo, Passport, PassportError, PassportModuleConfiguration, ProviderConfiguration, SendTransactionParams, SendTransactionResult, SetProvider, SupportedFiatCurrencies, SwapEvent, SwapEventType, SwapFailed, SwapReact, SwapReactProps, SwapSuccess, SwitchNetworkParams, SwitchNetworkResult, TokenFilter, TokenFilterTypes, TokenInfo, TokenToFiatConversionResult, Transaction, UpdateConfig, WalletEvent, WalletEventType, WalletFilter, WalletFilterTypes, WalletInfo, WalletNetworkSwitchEvent, WalletReact, WalletReactProps, WidgetConnectionProviders, WidgetTheme, createStarkSigner as imxClientCreateStarkSigner, generateLegacyStarkPrivateKey as imxClientGenerateLegacyStarkPrivateKey };