@imtbl/sdk 0.35.8 → 0.36.0

package/dist/checkout.d.ts

@@ -11668,6 +11668,26 @@ interface CheckConnectionResult {
     walletAddress: string;
 }
 
+/**
+ * @typedef {Object} BridgeFeeResponse
+ * @property {ethers.BigNumber} sourceChainGas - Gas cost to send tokens to the bridge contract on the source chain.
+ * - priced in the source chain's native token.
+ * @property {ethers.BigNumber} bridgeFee - destinationChainGas + validatorFee.
+ * This will be added to the tx.value of the bridge transaction and forwarded to the Axelar Gas Service contract.
+ * - priced in the source chain's native token.
+ * @property {ethers.BigNumber} imtblFee - The fee charged by Immutable to facilitate the bridge.
+ * - priced in the source chain's native token.
+ * @property {ethers.BigNumber} totalFees - The total fees the user will be charged which is;
+ * sourceChainGas + bridgeFee + imtblFee.
+ * - priced in the source chain's native token.
+ */
+interface BridgeFeeResponse {
+    sourceChainGas: BigNumber;
+    bridgeFee: BigNumber;
+    imtblFee: BigNumber;
+    totalFees: BigNumber;
+}
+
 /**
  * An enum representing the type of gas estimate.
  * @enum {string}
@@ -11687,11 +11707,9 @@ type GasEstimateParams = GasEstimateBridgeToL2Params | GasEstimateSwapParams;
 /**
  * An interface representing the parameters for estimating gas for a bridge to L2 transaction {@link Checkout.gasEstimate}.
  * @param {GasEstimateType.BRIDGE_TO_L2} gasEstimateType - The type of gas estimate.
- * @param {boolean} isSpendingCapApprovalRequired - Whether or not spending cap approval is required.
  */
 interface GasEstimateBridgeToL2Params {
     gasEstimateType: GasEstimateType.BRIDGE_TO_L2;
-    isSpendingCapApprovalRequired: boolean;
 }
 /**
  * An interface representing the parameters for a gas estimate swap {@link Checkout.gasEstimate}.
@@ -11705,28 +11723,31 @@ interface GasEstimateSwapParams {
  * An interface representing the result of a gas estimate for a swap transaction {@link Checkout.gasEstimate}.
  * @interface GasEstimateSwapResult
  * @property {GasEstimateType.SWAP} gasEstimateType - The type of gas estimate, which is always "SWAP".
- * @property {TokenAmountEstimate} gasFee - The estimated gas fee for the swap transaction.
+ * @property {TokenAmountEstimate} fees - The estimated gas fee for the swap transaction.
  */
 interface GasEstimateSwapResult {
     gasEstimateType: GasEstimateType.SWAP;
-    gasFee: TokenAmountEstimate;
+    fees: TokenAmountEstimate;
 }
 /**
  * An interface representing the result of a gas estimate for a bridge to L2 transaction {@link Checkout.gasEstimate}.
  * @interface GasEstimateBridgeToL2Result
  * @property {GasEstimateType.BRIDGE_TO_L2} gasEstimateType - The type of gas estimate.
- * @property {TokenAmountEstimate} gasFee - The estimated gas fee for the transaction.
- * @property {TokenAmountEstimate} bridgeFee - The estimated bridge fee for the transaction.
- * @property {boolean} bridgeable - A boolean indicating whether the transaction is bridgeable.
+ * @property {BridgeFeeResponse} fees - The estimated fees for the transaction.
+ * @property {TokenInfo | undefined} token - The gas token information.
  */
 interface GasEstimateBridgeToL2Result {
     gasEstimateType: GasEstimateType.BRIDGE_TO_L2;
-    gasFee: TokenAmountEstimate;
-    bridgeFee: TokenAmountEstimate;
-    bridgeable: boolean;
+    fees: BridgeFeeResponse;
+    token?: TokenInfo;
 }
+/**
+ * An interface representing the estimated fees.
+ * @property {BigNumber | undefined} totalFees - The estimated fees for the transaction.
+ * @property {TokenInfo | undefined} token - The gas token information.
+ */
 interface TokenAmountEstimate {
-    estimatedAmount?: BigNumber;
+    totalFees?: BigNumber;
     token?: TokenInfo;
 }
 
@@ -12210,14 +12231,14 @@ type SaleTransactionSuccess = {
  */
 declare enum BridgeEventType {
     CLOSE_WIDGET = "close-widget",
-    SUCCESS = "success",
-    FAILURE = "failure"
+    FAILURE = "failure",
+    TRANSACTION_SENT = "transaction-sent"
 }
 /**
  * Represents a successful bridge transaction.
  * @property {string} transactionHash
  */
-type BridgeSuccess = {
+type BridgeTransactionSent = {
     /** The hash of the successful transaction. */
     transactionHash: string;
 };
@@ -12333,13 +12354,13 @@ type ConnectWidgetParams = {};
 
 /**
  * Bridge Widget parameters
- * @property {string | undefined} fromContractAddress
+ * @property {string | undefined} contractAddress
  * @property {string | undefined} amount
  * @property {WalletProviderName | undefined} walletProviderName
  */
 type BridgeWidgetParams = {
     /** The contract address of the token to bridge from, used to populate the bridge form token field */
-    fromContractAddress?: string;
+    contractAddress?: string;
     /** The formatted amount to bridge, used to populate the bridge form amount field */
     amount?: string;
     /** The wallet provider name to use for the bridge widget */
@@ -12535,7 +12556,7 @@ type WidgetEventData = {
         [SwapEventType.CLOSE_WIDGET]: {};
     } & OrchestrationMapping & ProviderEventMapping;
     [WidgetType.BRIDGE]: {
-        [BridgeEventType.SUCCESS]: BridgeSuccess;
+        [BridgeEventType.TRANSACTION_SENT]: BridgeTransactionSent;
         [BridgeEventType.FAILURE]: BridgeFailed;
         [BridgeEventType.CLOSE_WIDGET]: {};
     } & OrchestrationMapping & ProviderEventMapping;
@@ -12892,6 +12913,18 @@ declare global {
     }
 }
 
+/**
+ * Base URL for the Immutable API based on the environment.
+ * @property {string} DEVELOPMENT - The base URL for the development environment.
+ * @property {string} SANDBOX - The base URL for the sandbox environment.
+ * @property {string} PRODUCTION - The base URL for the production environment.
+ */
+declare const IMMUTABLE_API_BASE_URL: {
+    [x: string]: string;
+    sandbox: string;
+    production: string;
+};
+
 /**
  * Enum representing different types of errors that can occur during the checkout process.
  */
@@ -12951,16 +12984,4 @@ type ErrorType = {
     };
 };
 
-/**
- * Base URL for the checkout API based on the environment.
- * @property {string} DEVELOPMENT - The base URL for the development environment.
- * @property {string} SANDBOX - The base URL for the sandbox environment.
- * @property {string} PRODUCTION - The base URL for the production environment.
- */
-declare const CHECKOUT_API_BASE_URL: {
-    [x: string]: string;
-    sandbox: string;
-    production: string;
-};
-
-export { AllowedNetworkConfig, AvailableRoutingOptions, BalanceDelta, BridgeEventType, BridgeFailed, BridgeFundingStep, BridgeSuccess, BridgeWidgetConfiguration, BridgeWidgetParams, BuyOrder, BuyParams, BuyResult, BuyResultFailed, BuyResultInsufficientFunds, BuyResultSuccess, BuyToken, CHECKOUT_API_BASE_URL, CancelParams, CancelResult, CancelResultFailed, CancelResultSuccess, ChainId, ChainName, 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, GetWalletAllowListParams, GetWalletAllowListResult, 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, 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, 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 };