@imtbl/sdk 0.44.1 → 0.44.3

package/dist/index.d.ts

@@ -16861,6 +16861,8 @@ type orderbook_d_OrderStatusName = OrderStatusName;
 declare const orderbook_d_OrderStatusName: typeof OrderStatusName;
 type orderbook_d_Orderbook = Orderbook;
 declare const orderbook_d_Orderbook: typeof Orderbook;
+type orderbook_d_OrderbookModuleConfiguration = OrderbookModuleConfiguration;
+type orderbook_d_OrderbookOverrides = OrderbookOverrides;
 type orderbook_d_Page = Page;
 type orderbook_d_PrepareCancelOrdersResponse = PrepareCancelOrdersResponse;
 type orderbook_d_PrepareListingParams = PrepareListingParams;
@@ -16902,6 +16904,8 @@ declare namespace orderbook_d {
     orderbook_d_Order as Order,
     orderbook_d_OrderStatusName as OrderStatusName,
     orderbook_d_Orderbook as Orderbook,
+    orderbook_d_OrderbookModuleConfiguration as OrderbookModuleConfiguration,
+    orderbook_d_OrderbookOverrides as OrderbookOverrides,
     orderbook_d_Page as Page,
     orderbook_d_PrepareCancelOrdersResponse as PrepareCancelOrdersResponse,
     orderbook_d_PrepareListingParams as PrepareListingParams,
@@ -17062,7 +17066,7 @@ interface FeePercentage {
     percentageDecimal: number;
 }
 
-type BuyResult = BuyResultSuccess | BuyResultFailed | BuyResultInsufficientFunds;
+type BuyResult = BuyResultSuccess | BuyResultFailed | BuyResultFulfillmentsUnsettled | BuyResultInsufficientFunds;
 /**
  * Represents the result of {@link Checkout.buy}
  * @property {CheckoutStatus.SUCCESS} status
@@ -17091,6 +17095,20 @@ type BuyResultFailed = {
     /** The sufficient result of smart checkout */
     smartCheckoutResult: SmartCheckoutSufficient;
 };
+/**
+ * Represents the result of {@link Checkout.buy}
+ * @property {CheckoutStatus.FULFILLMENTS_UNSETTLED} status
+ * @property {SmartCheckoutSufficient} smartCheckoutResult
+ * @property {SendTransactionResult[]} transactions
+ */
+type BuyResultFulfillmentsUnsettled = {
+    /** The status to indicate success */
+    status: CheckoutStatus.FULFILLMENTS_UNSETTLED;
+    /** The sufficient result of smart checkout */
+    smartCheckoutResult: SmartCheckoutSufficient;
+    /** Array of transaction results */
+    transactions: TransactionResponse[];
+};
 /**
  * Represents the result of {@link Checkout.buy}
  * @property {CheckoutStatus.INSUFFICIENT_FUNDS} status
@@ -17102,6 +17120,14 @@ type BuyResultInsufficientFunds = {
     /** The insufficient result of smart checkout */
     smartCheckoutResult: SmartCheckoutInsufficient;
 };
+/**
+ * Represents the overrides available for {@link Checkout.buy}
+ * @property {boolean} waitFulfillmentSettlements
+ */
+type BuyOverrides = {
+    /** If the buy should wait for the fulfillment transactions to settle */
+    waitFulfillmentSettlements?: boolean;
+};
 type SellResult = SellResultSuccess | SellResultFailed | SellResultInsufficientFunds;
 /**
  * Represents the result of {@link Checkout.sell}
@@ -17174,11 +17200,13 @@ type CancelResultFailed = {
  * @property {string} SUCCESS - If checkout succeeded as the transactions were able to be processed
  * @property {string} FAILED - If checkout failed due to transactions not settling on chain
  * @property {string} INSUFFICIENT_FUNDS - If checkout failed due to insufficient funds
+ * @property {string} FULFILLMENTS_UNSETTLED - If checkout succeeded but the fulfillment transactions are not yet settled
  */
 declare enum CheckoutStatus {
     SUCCESS = "SUCCESS",
     FAILED = "FAILED",
-    INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS"
+    INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
+    FULFILLMENTS_UNSETTLED = "FULFILLMENTS_UNSETTLED"
 }
 /**
  * The type representing the order to buy
@@ -17737,11 +17765,13 @@ type AvailableRoutingOptions = {
  * Interface representing the parameters for {@link Checkout.buy}
  * @property {Web3Provider} provider - The provider to use for the buy.
  * @property {Array<BuyOrder>} orders - The orders to buy
+ * @property {BuyOverrides} overrides - The overrides to use for the buy.
  * Currently only processes the first order in the array until batch processing is supported.
  */
 interface BuyParams {
     provider: Web3Provider;
     orders: Array<BuyOrder>;
+    overrides?: BuyOverrides;
 }
 
 /**
@@ -18055,17 +18085,20 @@ interface CheckConnectionResult {
  * @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} approvalFee - Gas cost to approve bridge contract to spend tokens 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.
+ * sourceChainGas + approvalFee + bridgeFee + imtblFee.
  * - priced in the source chain's native token.
  */
 interface BridgeFeeResponse {
     sourceChainGas: BigNumber;
+    approvalFee: BigNumber;
     bridgeFee: BigNumber;
     imtblFee: BigNumber;
     totalFees: BigNumber;
@@ -19470,6 +19503,7 @@ type checkout_d_BridgeTransactionSent = BridgeTransactionSent;
 type checkout_d_BridgeWidgetConfiguration = BridgeWidgetConfiguration;
 type checkout_d_BridgeWidgetParams = BridgeWidgetParams;
 type checkout_d_BuyOrder = BuyOrder;
+type checkout_d_BuyOverrides = BuyOverrides;
 type checkout_d_BuyParams = BuyParams;
 type checkout_d_BuyResult = BuyResult;
 type checkout_d_BuyResultFailed = BuyResultFailed;
@@ -19679,6 +19713,7 @@ declare namespace checkout_d {
     checkout_d_BridgeWidgetConfiguration as BridgeWidgetConfiguration,
     checkout_d_BridgeWidgetParams as BridgeWidgetParams,
     checkout_d_BuyOrder as BuyOrder,
+    checkout_d_BuyOverrides as BuyOverrides,
     checkout_d_BuyParams as BuyParams,
     checkout_d_BuyResult as BuyResult,
     checkout_d_BuyResultFailed as BuyResultFailed,