@imtbl/sdk 0.36.4 → 0.37.0

package/dist/checkout.d.ts

@@ -10916,15 +10916,15 @@ type NativeBuyToken = {
  * Represents a ERC20 buy token
  * @property {ItemType} type
  * @property {string} amount
- * @property {string} contractAddress
+ * @property {string} tokenAddress
  */
 type ERC20BuyToken = {
     /** The type indicate this is a ERC20 token. */
     type: ItemType.ERC20;
     /** The amount of native token. */
     amount: string;
-    /** The contract address of the ERC20. */
-    contractAddress: string;
+    /** The token address of the ERC20. */
+    tokenAddress: string;
 };
 /**
  * The SellToken type
@@ -10965,16 +10965,16 @@ type NativeItemRequirement = {
 /**
  * Represents an ERC20 item requirement for a transaction.
  * @property {ItemType.ERC20} type
+ * @property {string} tokenAddress
  * @property {string} amount
- * @property {string} contractAddress
  * @property {string} spenderAddress
  */
 type ERC20ItemRequirement = {
     /** The type to indicate this is a ERC20 item requirement. */
     type: ItemType.ERC20;
+    /** The token address of the ERC20. */
+    tokenAddress: string;
     /** The amount of the item. */
-    contractAddress: string;
-    /** The contract address of the ERC20. */
     amount: string;
     /** The contract address of the approver. */
     spenderAddress: string;
@@ -11068,14 +11068,14 @@ type NativeGas = {
 /**
  * Represents an ERC20 gas token.
  * @property {GasTokenType} type
- * @property {string} contractAddress
+ * @property {string} tokenAddress
  * @property {BigNumber} limit
  */
 type ERC20Gas = {
     /** The type to indicate this is an ERC20 gas token. */
     type: GasTokenType.ERC20;
-    /** The contract address of the ERC20. */
-    contractAddress: string;
+    /** The token address of the ERC20. */
+    tokenAddress: string;
     /** The gas limit. */
     limit: BigNumber;
 };
@@ -11183,6 +11183,8 @@ type FundingRoute = {
  * @property {TokenInfo | undefined} token
  */
 type Fee = {
+    /** The type of fee */
+    type: FeeType;
     /** The amount of the fee */
     amount: BigNumber;
     /** The formatted amount of the fee */
@@ -11190,6 +11192,20 @@ type Fee = {
     /** The token info for the fee */
     token?: TokenInfo;
 };
+/**
+ * An enum representing the funding step types
+ * @enum {string}
+ * @property {string} GAS - If the fee is a gas fee.
+ * @property {string} BRIDGE_FEE - If the fee is a bridge fee.
+ * @property {string} SWAP_FEE - If the fee is a swap fee.
+ * @property {string} IMMUTABLE_FEE - If the fee is an immutable fee.
+ */
+declare enum FeeType {
+    GAS = "GAS",
+    BRIDGE_FEE = "BRIDGE_FEE",
+    SWAP_FEE = "SWAP_FEE",
+    IMMUTABLE_FEE = "IMMUTABLE_FEE"
+}
 type FundingStep = BridgeFundingStep | SwapFundingStep | OnRampFundingStep;
 /**
  * Represents a bridge funding route
@@ -11210,15 +11226,15 @@ type BridgeFundingStep = {
 };
 /**
  * Represents the fees for a bridge funding step
- * @property {Fee} approvalGasFees
- * @property {Fee} bridgeGasFees
+ * @property {Fee} approvalGasFee
+ * @property {Fee} bridgeGasFee
  * @property {Fee[]} bridgeFees
  */
 type BridgeFees = {
-    /** The approval gas fees for the bridge */
-    approvalGasFees: Fee;
-    /** The bridge gas fees for the bridge */
-    bridgeGasFees: Fee;
+    /** The approval gas fee for the bridge */
+    approvalGasFee: Fee;
+    /** The bridge gas fee for the bridge */
+    bridgeGasFee: Fee;
     /** Additional bridge fees for the bridge */
     bridgeFees: Fee[];
 };
@@ -11241,15 +11257,15 @@ type SwapFundingStep = {
 };
 /**
  * Represents the fees for a swap funding step
- * @property {Fee} approvalGasFees
- * @property {Fee} swapGasFees
+ * @property {Fee} approvalGasFee
+ * @property {Fee} swapGasFee
  * @property {Fee[]} swapFees
  */
 type SwapFees = {
-    /** The approval gas fees for the swap */
-    approvalGasFees: Fee;
-    /** The swap gas fees for the swap */
-    swapGasFees: Fee;
+    /** The approval gas fee for the swap */
+    approvalGasFee: Fee;
+    /** The swap gas fee for the swap */
+    swapGasFee: Fee;
     /** Additional swap fees for the swap */
     swapFees: Fee[];
 };
@@ -11618,10 +11634,10 @@ type ImxAddressConfig = {
 };
 /**
  * A type representing the telemetry configurations.
- * @property {string} publishableApiKey
+ * @property {string} segmentPublishableKey
  */
 type TelemetryConfig = {
-    publishableApiKey: string;
+    segmentPublishableKey: string;
 };
 /**
  * A type representing the required information to estimate gas for a transaction.
@@ -13028,4 +13044,4 @@ type ErrorType = {
     };
 };
 
-export { AllowedNetworkConfig, AvailableRoutingOptions, BalanceDelta, BridgeEventType, BridgeFailed, BridgeFundingStep, BridgeTransactionSent, BridgeWidgetConfiguration, BridgeWidgetParams, BuyOrder, BuyParams, BuyResult, BuyResultFailed, BuyResultInsufficientFunds, BuyResultSuccess, BuyToken, CancelParams, CancelResult, CancelResultFailed, CancelResultSuccess, ChainId, ChainName, ChainSlug, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutBridgeConfiguration, CheckoutConfiguration, CheckoutErrorType, CheckoutModuleConfiguration, CheckoutOnRampConfiguration, CheckoutStatus, CheckoutSwapConfiguration, CheckoutWidgetsConfig, ConnectEventType, ConnectParams, ConnectResult, ConnectTargetLayer, ConnectWidgetConfiguration, ConnectWidgetParams, ConnectionFailed, ConnectionSuccess, CreateProviderParams, CreateProviderResult, DexConfig, ERC20ItemRequirement, ERC721Balance, ERC721ItemRequirement, ErrorType, ExchangeType, Fee, FeePercentage, FeeToken, FiatRampParams, FulfillmentTransaction, FundingItem, FundingRoute, FundingStep, FundingStepType, GasAmount, GasEstimateBridgeToL2Result, GasEstimateParams, GasEstimateSwapResult, GasEstimateTokenConfig, GasEstimateType, GasToken, GasTokenType, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetTokenInfoParams, GetWalletAllowListParams, GetWalletAllowListResult, IMMUTABLE_API_BASE_URL, IMTBLWidgetEvents, IWidgetsFactory, ItemBalance, ItemType, NativeItemRequirement, NetworkFilter, NetworkFilterTypes, NetworkInfo, NoRouteOptions, NoRoutesFound, OnRampEventType, OnRampFailed, OnRampFundingStep, OnRampProviderFees, OnRampSuccess, OnRampWidgetParams, OnrampWidgetConfiguration, OrchestrationEvent, OrchestrationEventData, OrchestrationEventType, OrderFee, ProviderEvent, ProviderEventType, ProviderUpdated, RemoteConfiguration, RequestBridgeEvent, RequestConnectEvent, RequestOnrampEvent, RequestSwapEvent, RequestWalletEvent, RoutesFound, RoutingOutcome, RoutingOutcomeType, SaleEventType, SaleFailed, SaleItem, SaleSuccess, SaleTransactionSuccess, SaleWidgetConfiguration, SaleWidgetParams, SellOrder, SellParams, SellResult, SellResultFailed, SellResultInsufficientFunds, SellResultSuccess, SellToken, SemanticVersion, SendTransactionParams, SendTransactionResult, SmartCheckoutInsufficient, SmartCheckoutParams, SmartCheckoutResult, SmartCheckoutRouter, SmartCheckoutSufficient, SwapEventType, SwapFailed, SwapFundingStep, SwapRejected, SwapSuccess, SwapWidgetConfiguration, SwapWidgetParams, SwitchNetworkParams, SwitchNetworkResult, TokenAmountEstimate, TokenBalance, TokenFilter, TokenFilterTypes, TokenInfo, TransactionOrGasType, TransactionRequirement, WalletDisconnect, WalletEventType, WalletFilter, WalletFilterTypes, WalletInfo, WalletNetworkSwitch, WalletProviderName, WalletWidgetConfiguration, WalletWidgetParams, Widget, WidgetConfiguration, WidgetConfigurations, WidgetEvent, WidgetEventData, WidgetEventTypes, WidgetParameters, WidgetProperties, WidgetTheme, WidgetType };
+export { AllowedNetworkConfig, AvailableRoutingOptions, BalanceDelta, BridgeEventType, BridgeFailed, BridgeFundingStep, BridgeTransactionSent, BridgeWidgetConfiguration, BridgeWidgetParams, BuyOrder, BuyParams, BuyResult, BuyResultFailed, BuyResultInsufficientFunds, BuyResultSuccess, BuyToken, CancelParams, CancelResult, CancelResultFailed, CancelResultSuccess, ChainId, ChainName, ChainSlug, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutBridgeConfiguration, CheckoutConfiguration, CheckoutErrorType, CheckoutModuleConfiguration, CheckoutOnRampConfiguration, CheckoutStatus, CheckoutSwapConfiguration, CheckoutWidgetsConfig, ConnectEventType, ConnectParams, ConnectResult, ConnectTargetLayer, ConnectWidgetConfiguration, ConnectWidgetParams, ConnectionFailed, ConnectionSuccess, CreateProviderParams, CreateProviderResult, DexConfig, ERC20ItemRequirement, ERC721Balance, ERC721ItemRequirement, ErrorType, ExchangeType, Fee, FeePercentage, FeeToken, FeeType, FiatRampParams, FulfillmentTransaction, FundingItem, FundingRoute, FundingStep, FundingStepType, GasAmount, GasEstimateBridgeToL2Result, GasEstimateParams, GasEstimateSwapResult, GasEstimateTokenConfig, GasEstimateType, GasToken, GasTokenType, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetTokenInfoParams, GetWalletAllowListParams, GetWalletAllowListResult, IMMUTABLE_API_BASE_URL, IMTBLWidgetEvents, IWidgetsFactory, ItemBalance, ItemType, NativeItemRequirement, NetworkFilter, NetworkFilterTypes, NetworkInfo, NoRouteOptions, NoRoutesFound, OnRampEventType, OnRampFailed, OnRampFundingStep, OnRampProviderFees, OnRampSuccess, OnRampWidgetParams, OnrampWidgetConfiguration, OrchestrationEvent, OrchestrationEventData, OrchestrationEventType, OrderFee, ProviderEvent, ProviderEventType, ProviderUpdated, RemoteConfiguration, RequestBridgeEvent, RequestConnectEvent, RequestOnrampEvent, RequestSwapEvent, RequestWalletEvent, RoutesFound, RoutingOutcome, RoutingOutcomeType, SaleEventType, SaleFailed, SaleItem, SaleSuccess, SaleTransactionSuccess, SaleWidgetConfiguration, SaleWidgetParams, SellOrder, SellParams, SellResult, SellResultFailed, SellResultInsufficientFunds, SellResultSuccess, SellToken, SemanticVersion, SendTransactionParams, SendTransactionResult, SmartCheckoutInsufficient, SmartCheckoutParams, SmartCheckoutResult, SmartCheckoutRouter, SmartCheckoutSufficient, SwapEventType, SwapFailed, SwapFundingStep, SwapRejected, SwapSuccess, SwapWidgetConfiguration, SwapWidgetParams, SwitchNetworkParams, SwitchNetworkResult, TokenAmountEstimate, TokenBalance, TokenFilter, TokenFilterTypes, TokenInfo, TransactionOrGasType, TransactionRequirement, WalletDisconnect, WalletEventType, WalletFilter, WalletFilterTypes, WalletInfo, WalletNetworkSwitch, WalletProviderName, WalletWidgetConfiguration, WalletWidgetParams, Widget, WidgetConfiguration, WidgetConfigurations, WidgetEvent, WidgetEventData, WidgetEventTypes, WidgetParameters, WidgetProperties, WidgetTheme, WidgetType };