@imtbl/sdk 0.23.0-alpha → 0.23.1

package/dist/index.cjs

@@ -3009,7 +3009,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.23.0-alpha' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.23.1' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -3069,7 +3069,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.23.0-alpha',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.23.1',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -3355,7 +3355,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.23.0-alpha',
+    sdkVersion: 'ts-immutable-sdk-0.23.1',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -32095,10 +32095,12 @@ var checkout_sdk = /*#__PURE__*/Object.freeze({
     get CheckoutErrorType () { return $a8bc256d81a5e2c1$export$e3dc0620abde7f5a; },
     get CheckoutStatus () { return $4b58188d47aafe8d$export$de7bcda3c490bf18; },
     get ExchangeType () { return $e055e79256bbc1dd$export$80f4da0d409a629d; },
+    get FundingStepType () { return $4b58188d47aafe8d$export$6fbaa98ee06d03e8; },
     get GasEstimateType () { return $de275b98d2b651c3$export$788b1fd17f3dad84; },
     get GasTokenType () { return $4b58188d47aafe8d$export$537fa3efd10ed435; },
     get ItemType () { return $4b58188d47aafe8d$export$1fc8f52ad1810e52; },
     get NetworkFilterTypes () { return $a47e48dd2c04791b$export$1f05a55fe0680cc7; },
+    get RoutingOutcomeType () { return $4b58188d47aafe8d$export$d0616bd3e995b8be; },
     get TokenFilterTypes () { return $08d5ddc39acd6833$export$fd9b17d87f4121d2; },
     get TransactionOrGasType () { return $4b58188d47aafe8d$export$65c64e46348ee3c1; },
     get WalletFilterTypes () { return $4f91c5f280efe242$export$a75605c67ea83a5a; },
@@ -32129,7 +32131,7 @@ var $045213b18e9f1f94$export$75be0f6af9650f2c;
 })($045213b18e9f1f94$export$75be0f6af9650f2c || ($045213b18e9f1f94$export$75be0f6af9650f2c = {}));
 
 
-const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.23.0-alpha";
+const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.23.1";
 const $d663162fd5a0853f$export$83bf90b30cdfd29f = ()=>false;
 const $d663162fd5a0853f$export$1169f5475725171b = ()=>$d663162fd5a0853f$export$38a083d9fb5551ca;
 

package/dist/index.d.ts

@@ -13414,7 +13414,7 @@ declare namespace Fee$2 {
     }
 }
 
-type ERC20Item$2 = {
+type ERC20Item$1 = {
     /**
      * Token type user is offering, which in this case is ERC20
      */
@@ -13429,7 +13429,7 @@ type ERC20Item$2 = {
     start_amount: string;
 };
 
-type ERC721Item$2 = {
+type ERC721Item$1 = {
     /**
      * Token type user is offering, which in this case is ERC721
      */
@@ -13444,7 +13444,7 @@ type ERC721Item$2 = {
     token_id: string;
 };
 
-type NativeItem$2 = {
+type NativeItem$1 = {
     /**
      * Token type user is offering, which in this case is the native IMX token
      */
@@ -13455,7 +13455,7 @@ type NativeItem$2 = {
     start_amount: string;
 };
 
-type Item = (NativeItem$2 | ERC20Item$2 | ERC721Item$2);
+type Item = (NativeItem$1 | ERC20Item$1 | ERC721Item$1);
 
 type ProtocolData = {
     /**
@@ -13815,17 +13815,17 @@ declare class OrdersService {
     }): CancelablePromise<TradeResult$1>;
 }
 
-interface ERC721Item$1 {
+interface ERC721Item {
     type: 'ERC721';
     contractAddress: string;
     tokenId: string;
 }
-interface ERC20Item$1 {
+interface ERC20Item {
     type: 'ERC20';
     contractAddress: string;
     amount: string;
 }
-interface NativeItem$1 {
+interface NativeItem {
     type: 'NATIVE';
     amount: string;
 }
@@ -13835,8 +13835,8 @@ interface RoyaltyInfo {
 }
 interface PrepareListingParams {
     makerAddress: string;
-    sell: ERC721Item$1;
-    buy: ERC20Item$1 | NativeItem$1;
+    sell: ERC721Item;
+    buy: ERC20Item | NativeItem;
     orderExpiry?: Date;
 }
 interface PrepareListingResponse {
@@ -13907,8 +13907,8 @@ interface CancelOrderResponse {
 interface Order {
     id: string;
     accountAddress: string;
-    buy: (ERC20Item$1 | NativeItem$1)[];
-    sell: ERC721Item$1[];
+    buy: (ERC20Item | NativeItem)[];
+    sell: ERC721Item[];
     fees: Fee$1[];
     chain: {
         id: string;
@@ -13959,8 +13959,8 @@ interface Trade {
         id: string;
         name: string;
     };
-    buy: (ERC20Item$1 | NativeItem$1)[];
-    sell: ERC721Item$1[];
+    buy: (ERC20Item | NativeItem)[];
+    sell: ERC721Item[];
     buyerFees: Fee$1[];
     sellerAddress: string;
     buyerAddress: string;
@@ -14081,6 +14081,8 @@ type orderbook_d_ActionType = ActionType;
 declare const orderbook_d_ActionType: typeof ActionType;
 type orderbook_d_CancelOrderResponse = CancelOrderResponse;
 type orderbook_d_CreateListingParams = CreateListingParams;
+type orderbook_d_ERC20Item = ERC20Item;
+type orderbook_d_ERC721Item = ERC721Item;
 type orderbook_d_FeeType = FeeType;
 declare const orderbook_d_FeeType: typeof FeeType;
 type orderbook_d_FeeValue = FeeValue;
@@ -14090,6 +14092,7 @@ type orderbook_d_ListListingsResult = ListListingsResult;
 type orderbook_d_ListTradesParams = ListTradesParams;
 type orderbook_d_ListTradesResult = ListTradesResult;
 type orderbook_d_ListingResult = ListingResult;
+type orderbook_d_NativeItem = NativeItem;
 type orderbook_d_Order = Order;
 type orderbook_d_OrderStatus = OrderStatus;
 declare const orderbook_d_OrderStatus: typeof OrderStatus;
@@ -14115,8 +14118,8 @@ declare namespace orderbook_d {
     orderbook_d_ActionType as ActionType,
     orderbook_d_CancelOrderResponse as CancelOrderResponse,
     orderbook_d_CreateListingParams as CreateListingParams,
-    ERC20Item$1 as ERC20Item,
-    ERC721Item$1 as ERC721Item,
+    orderbook_d_ERC20Item as ERC20Item,
+    orderbook_d_ERC721Item as ERC721Item,
     Fee$1 as Fee,
     orderbook_d_FeeType as FeeType,
     orderbook_d_FeeValue as FeeValue,
@@ -14126,7 +14129,7 @@ declare namespace orderbook_d {
     orderbook_d_ListTradesParams as ListTradesParams,
     orderbook_d_ListTradesResult as ListTradesResult,
     orderbook_d_ListingResult as ListingResult,
-    NativeItem$1 as NativeItem,
+    orderbook_d_NativeItem as NativeItem,
     orderbook_d_Order as Order,
     orderbook_d_OrderStatus as OrderStatus,
     orderbook_d_Orderbook as Orderbook,
@@ -14486,11 +14489,6 @@ type ERC721ItemRequirement = {
     id: string;
     spenderAddress: string;
 };
-/**
- * Represents the item requirements for a transaction.
- * NativeItem, ERC20Item or ERC721Item {@link Checkout.smartCheckout}.
- */
-type ItemRequirement = NativeItem | ERC20Item | ERC721Item;
 /**
  * An enum representing the item types
  * @enum {string}
@@ -14503,41 +14501,6 @@ declare enum ItemType {
     ERC20 = "ERC20",
     ERC721 = "ERC721"
 }
-/**
- * Represents a native item.
- * @property {ItemType} type - The type indicate this is a native item.
- * @property {BigNumber} amount - The amount of the item.
- */
-type NativeItem = {
-    type: ItemType.NATIVE;
-    amount: BigNumber;
-};
-/**
- * Represents an ERC20 item.
- * @property {ItemType} type - The type to indicate this is an ERC20 item.
- * @property {string} contractAddress - The contract address of the ERC20.
- * @property {BigNumber} amount - The amount of the item.
- * @property {string} spenderAddress - The contract address of the approver.
- */
-type ERC20Item = {
-    type: ItemType.ERC20;
-    contractAddress: string;
-    amount: BigNumber;
-    spenderAddress: string;
-};
-/**
- * Represents an ERC721 item.
- * @property {ItemType} type - The type to indicate this is an ERC721 item.
- * @property {string} contractAddress - The contract address of the ERC721 collection.
- * @property {string} id - The ID of this ERC721 in the collection.
- * @property {string} spenderAddress - The contract address of the approver.
- */
-type ERC721Item = {
-    type: ItemType.ERC721;
-    contractAddress: string;
-    id: string;
-    spenderAddress: string;
-};
 /**
  * An enum representing transaction or gas types
  * @enum {string}
@@ -14874,6 +14837,24 @@ type AvailableRoutingOptions = {
     swap?: boolean;
     bridge?: boolean;
 };
+type FundingRouteFeeEstimate = SwapRouteFeeEstimate | BridgeRouteFeeEstimate;
+type SwapRouteFeeEstimate = {
+    type: FundingStepType.SWAP;
+    estimatedAmount: BigNumber;
+    token: TokenInfo;
+};
+type BridgeRouteFeeEstimate = {
+    type: FundingStepType.BRIDGE;
+    gasFee: {
+        estimatedAmount: BigNumber;
+        token?: TokenInfo;
+    };
+    bridgeFee: {
+        estimatedAmount: BigNumber;
+        token?: TokenInfo;
+    };
+    totalFees: BigNumber;
+};
 /**
  * Interface representing the parameters for {@link Checkout.buy}
  * @property {Web3Provider} provider - The provider to use for the buy.
@@ -15565,6 +15546,8 @@ declare class Checkout {
 }
 
 type checkout_sdk_d_AllowedNetworkConfig = AllowedNetworkConfig;
+type checkout_sdk_d_AvailableRoutingOptions = AvailableRoutingOptions;
+type checkout_sdk_d_BalanceDelta = BalanceDelta;
 type checkout_sdk_d_BuyOrder = BuyOrder;
 type checkout_sdk_d_BuyParams = BuyParams;
 type checkout_sdk_d_BuyResult = BuyResult;
@@ -15597,6 +15580,12 @@ type checkout_sdk_d_FeePercentage = FeePercentage;
 type checkout_sdk_d_FeeToken = FeeToken;
 type checkout_sdk_d_FiatRampParams = FiatRampParams;
 type checkout_sdk_d_FulfillmentTransaction = FulfillmentTransaction;
+type checkout_sdk_d_FundingItem = FundingItem;
+type checkout_sdk_d_FundingRoute = FundingRoute;
+type checkout_sdk_d_FundingRouteFeeEstimate = FundingRouteFeeEstimate;
+type checkout_sdk_d_FundingStep = FundingStep;
+type checkout_sdk_d_FundingStepType = FundingStepType;
+declare const checkout_sdk_d_FundingStepType: typeof FundingStepType;
 type checkout_sdk_d_GasAmount = GasAmount;
 type checkout_sdk_d_GasEstimateBridgeToL2Result = GasEstimateBridgeToL2Result;
 type checkout_sdk_d_GasEstimateParams = GasEstimateParams;
@@ -15618,7 +15607,7 @@ type checkout_sdk_d_GetTokenAllowListParams = GetTokenAllowListParams;
 type checkout_sdk_d_GetTokenAllowListResult = GetTokenAllowListResult;
 type checkout_sdk_d_GetWalletAllowListParams = GetWalletAllowListParams;
 type checkout_sdk_d_GetWalletAllowListResult = GetWalletAllowListResult;
-type checkout_sdk_d_ItemRequirement = ItemRequirement;
+type checkout_sdk_d_ItemBalance = ItemBalance;
 type checkout_sdk_d_ItemType = ItemType;
 declare const checkout_sdk_d_ItemType: typeof ItemType;
 type checkout_sdk_d_NativeItemRequirement = NativeItemRequirement;
@@ -15628,6 +15617,9 @@ declare const checkout_sdk_d_NetworkFilterTypes: typeof NetworkFilterTypes;
 type checkout_sdk_d_NetworkInfo = NetworkInfo;
 type checkout_sdk_d_OrderFee = OrderFee;
 type checkout_sdk_d_RemoteConfiguration = RemoteConfiguration;
+type checkout_sdk_d_RoutingOutcome = RoutingOutcome;
+type checkout_sdk_d_RoutingOutcomeType = RoutingOutcomeType;
+declare const checkout_sdk_d_RoutingOutcomeType: typeof RoutingOutcomeType;
 type checkout_sdk_d_SellOrder = SellOrder;
 type checkout_sdk_d_SellParams = SellParams;
 type checkout_sdk_d_SellResult = SellResult;
@@ -15635,6 +15627,8 @@ type checkout_sdk_d_SellToken = SellToken;
 type checkout_sdk_d_SendTransactionParams = SendTransactionParams;
 type checkout_sdk_d_SendTransactionResult = SendTransactionResult;
 type checkout_sdk_d_SmartCheckoutParams = SmartCheckoutParams;
+type checkout_sdk_d_SmartCheckoutResult = SmartCheckoutResult;
+type checkout_sdk_d_SmartCheckoutRouter = SmartCheckoutRouter;
 type checkout_sdk_d_SwitchNetworkParams = SwitchNetworkParams;
 type checkout_sdk_d_SwitchNetworkResult = SwitchNetworkResult;
 type checkout_sdk_d_TokenFilter = TokenFilter;
@@ -15643,6 +15637,7 @@ declare const checkout_sdk_d_TokenFilterTypes: typeof TokenFilterTypes;
 type checkout_sdk_d_TokenInfo = TokenInfo;
 type checkout_sdk_d_TransactionOrGasType = TransactionOrGasType;
 declare const checkout_sdk_d_TransactionOrGasType: typeof TransactionOrGasType;
+type checkout_sdk_d_TransactionRequirement = TransactionRequirement;
 type checkout_sdk_d_WalletFilter = WalletFilter;
 type checkout_sdk_d_WalletFilterTypes = WalletFilterTypes;
 declare const checkout_sdk_d_WalletFilterTypes: typeof WalletFilterTypes;
@@ -15652,6 +15647,8 @@ declare const checkout_sdk_d_WalletProviderName: typeof WalletProviderName;
 declare namespace checkout_sdk_d {
   export {
     checkout_sdk_d_AllowedNetworkConfig as AllowedNetworkConfig,
+    checkout_sdk_d_AvailableRoutingOptions as AvailableRoutingOptions,
+    checkout_sdk_d_BalanceDelta as BalanceDelta,
     checkout_sdk_d_BuyOrder as BuyOrder,
     checkout_sdk_d_BuyParams as BuyParams,
     checkout_sdk_d_BuyResult as BuyResult,
@@ -15678,6 +15675,11 @@ declare namespace checkout_sdk_d {
     checkout_sdk_d_FeeToken as FeeToken,
     checkout_sdk_d_FiatRampParams as FiatRampParams,
     checkout_sdk_d_FulfillmentTransaction as FulfillmentTransaction,
+    checkout_sdk_d_FundingItem as FundingItem,
+    checkout_sdk_d_FundingRoute as FundingRoute,
+    checkout_sdk_d_FundingRouteFeeEstimate as FundingRouteFeeEstimate,
+    checkout_sdk_d_FundingStep as FundingStep,
+    checkout_sdk_d_FundingStepType as FundingStepType,
     checkout_sdk_d_GasAmount as GasAmount,
     checkout_sdk_d_GasEstimateBridgeToL2Result as GasEstimateBridgeToL2Result,
     checkout_sdk_d_GasEstimateParams as GasEstimateParams,
@@ -15697,7 +15699,7 @@ declare namespace checkout_sdk_d {
     checkout_sdk_d_GetTokenAllowListResult as GetTokenAllowListResult,
     checkout_sdk_d_GetWalletAllowListParams as GetWalletAllowListParams,
     checkout_sdk_d_GetWalletAllowListResult as GetWalletAllowListResult,
-    checkout_sdk_d_ItemRequirement as ItemRequirement,
+    checkout_sdk_d_ItemBalance as ItemBalance,
     checkout_sdk_d_ItemType as ItemType,
     checkout_sdk_d_NativeItemRequirement as NativeItemRequirement,
     checkout_sdk_d_NetworkFilter as NetworkFilter,
@@ -15705,6 +15707,8 @@ declare namespace checkout_sdk_d {
     checkout_sdk_d_NetworkInfo as NetworkInfo,
     checkout_sdk_d_OrderFee as OrderFee,
     checkout_sdk_d_RemoteConfiguration as RemoteConfiguration,
+    checkout_sdk_d_RoutingOutcome as RoutingOutcome,
+    checkout_sdk_d_RoutingOutcomeType as RoutingOutcomeType,
     checkout_sdk_d_SellOrder as SellOrder,
     checkout_sdk_d_SellParams as SellParams,
     checkout_sdk_d_SellResult as SellResult,
@@ -15712,12 +15716,15 @@ declare namespace checkout_sdk_d {
     checkout_sdk_d_SendTransactionParams as SendTransactionParams,
     checkout_sdk_d_SendTransactionResult as SendTransactionResult,
     checkout_sdk_d_SmartCheckoutParams as SmartCheckoutParams,
+    checkout_sdk_d_SmartCheckoutResult as SmartCheckoutResult,
+    checkout_sdk_d_SmartCheckoutRouter as SmartCheckoutRouter,
     checkout_sdk_d_SwitchNetworkParams as SwitchNetworkParams,
     checkout_sdk_d_SwitchNetworkResult as SwitchNetworkResult,
     checkout_sdk_d_TokenFilter as TokenFilter,
     checkout_sdk_d_TokenFilterTypes as TokenFilterTypes,
     checkout_sdk_d_TokenInfo as TokenInfo,
     checkout_sdk_d_TransactionOrGasType as TransactionOrGasType,
+    checkout_sdk_d_TransactionRequirement as TransactionRequirement,
     checkout_sdk_d_WalletFilter as WalletFilter,
     checkout_sdk_d_WalletFilterTypes as WalletFilterTypes,
     checkout_sdk_d_WalletInfo as WalletInfo,

package/dist/index.js

@@ -2987,7 +2987,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.23.0-alpha' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.23.1' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -3047,7 +3047,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.23.0-alpha',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.23.1',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -3333,7 +3333,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.23.0-alpha',
+    sdkVersion: 'ts-immutable-sdk-0.23.1',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -32073,10 +32073,12 @@ var checkout_sdk = /*#__PURE__*/Object.freeze({
     get CheckoutErrorType () { return $a8bc256d81a5e2c1$export$e3dc0620abde7f5a; },
     get CheckoutStatus () { return $4b58188d47aafe8d$export$de7bcda3c490bf18; },
     get ExchangeType () { return $e055e79256bbc1dd$export$80f4da0d409a629d; },
+    get FundingStepType () { return $4b58188d47aafe8d$export$6fbaa98ee06d03e8; },
     get GasEstimateType () { return $de275b98d2b651c3$export$788b1fd17f3dad84; },
     get GasTokenType () { return $4b58188d47aafe8d$export$537fa3efd10ed435; },
     get ItemType () { return $4b58188d47aafe8d$export$1fc8f52ad1810e52; },
     get NetworkFilterTypes () { return $a47e48dd2c04791b$export$1f05a55fe0680cc7; },
+    get RoutingOutcomeType () { return $4b58188d47aafe8d$export$d0616bd3e995b8be; },
     get TokenFilterTypes () { return $08d5ddc39acd6833$export$fd9b17d87f4121d2; },
     get TransactionOrGasType () { return $4b58188d47aafe8d$export$65c64e46348ee3c1; },
     get WalletFilterTypes () { return $4f91c5f280efe242$export$a75605c67ea83a5a; },
@@ -32107,7 +32109,7 @@ var $045213b18e9f1f94$export$75be0f6af9650f2c;
 })($045213b18e9f1f94$export$75be0f6af9650f2c || ($045213b18e9f1f94$export$75be0f6af9650f2c = {}));
 
 
-const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.23.0-alpha";
+const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.23.1";
 const $d663162fd5a0853f$export$83bf90b30cdfd29f = ()=>false;
 const $d663162fd5a0853f$export$1169f5475725171b = ()=>$d663162fd5a0853f$export$38a083d9fb5551ca;
 

package/dist/passport.js

@@ -1785,7 +1785,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.23.0-alpha' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.23.1' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -1841,7 +1841,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.23.0-alpha',
+    sdkVersion: 'ts-immutable-sdk-0.23.1',
 });
 /**
  * Sets `sdkVersion` at the time of build

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imtbl/sdk",
   "description": "Immutable Unified SDK",
-  "version": "0.23.0-alpha",
+  "version": "0.23.1",
   "author": "Immutable",
   "browser": "./dist/index.browser.js",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",