@imtbl/sdk 0.4.0-alpha.2 → 0.4.1-alpha

package/dist/checkout_sdk.d.ts

@@ -565,6 +565,16 @@ interface ModuleConfiguration<T> {
     overrides?: T;
 }
 
+/**
+ * Interface representing the secondary fees for a swap
+ * @property {string} feeRecipient - The fee recipient address
+ * @property {number} feeBasisPoints - The fee percentage in basis points
+ * @example 100 basis points = 1%
+ */
+type SecondaryFee = {
+    feeRecipient: string;
+    feeBasisPoints: number;
+};
 /**
  * Interface representing a token
  * @property {number} chainId - The chain ID
@@ -585,6 +595,7 @@ interface ExchangeOverrides {
     exchangeContracts: ExchangeContracts;
     commonRoutingTokens: TokenInfo$1[];
     nativeToken: TokenInfo$1;
+    secondaryFees?: SecondaryFee[];
 }
 
 /**
@@ -607,8 +618,8 @@ type FungibleToken = Address | 'NATIVE';
  */
 declare enum ChainId {
     IMTBL_ZKEVM_MAINNET = 13371,
-    IMTBL_ZKEVM_TESTNET = 13392,
-    IMTBL_ZKEVM_DEVNET = 13403,
+    IMTBL_ZKEVM_TESTNET = 13372,
+    IMTBL_ZKEVM_DEVNET = 13423,
     ETHEREUM = 1,
     SEPOLIA = 11155111
 }
@@ -978,9 +989,11 @@ interface CreateProviderParams {
 /**
  * Represents the result of creating a Web3 provider {@link Checkout.createProvider}.
  * @property {Web3Provider} provider - The created Web3 provider.
+ * @property {WalletProviderName} providerName - The name of the wallet provider.
  */
 type CreateProviderResult = {
     provider: Web3Provider;
+    walletProviderName: WalletProviderName;
 };
 /**
  * Interface representing a wallet filter to be used in {@link GetWalletAllowListParams}.
@@ -1088,6 +1101,7 @@ declare class RemoteConfigFetcher {
 }
 declare class CheckoutConfiguration {
     readonly isDevelopment: boolean;
+    readonly isLocal: boolean;
     readonly isProduction: boolean;
     readonly remote: RemoteConfigFetcher;
     readonly environment: Environment;

package/dist/checkout_sdk.js

@@ -10216,7 +10216,7 @@ const ETH_MAINNET_CHAIN_ID = 'eip155:1';
 /**
  * @constant {string} ZKEVM_DEVNET_CHAIN_ID - The chain ID for the zkEVM devnet (EIP-155 compatible format).
  */
-const ZKEVM_DEVNET_CHAIN_ID = 'eip155:13403';
+const ZKEVM_DEVNET_CHAIN_ID = 'eip155:13423';
 /**
 /**
  * @constant {string} ZKEVM_TESTNET_CHAIN_ID - The chain ID for the zkEVM testnet (EIP-155 compatible format).
@@ -10274,14 +10274,14 @@ const SUPPORTED_BRIDGES_FOR_ENVIRONMENT = {
  */
 const CONTRACTS_FOR_BRIDGE = new Map()
     .set(ETH_SEPOLIA_TO_ZKEVM_DEVNET, {
-    rootChainERC20Predicate: '0x15Dd735de418B6d290727aed82cC25F8966dE4A5',
-    rootChainStateSender: '0xb3Bac13799dAca9D9eC9307303a65fA1218b4724',
+    rootChainERC20Predicate: '0xf0b3435411A74F1aeCBD0fd6D53a90D5227fEeba',
+    rootChainStateSender: '0x868097dbAcfD431F441d09D0e4D3B5eD3182E597',
     childChainERC20Predicate: '0x0000000000000000000000000000000000001004',
     childChainStateReceiver: '0x0000000000000000000000000000000000001001',
 })
     .set(ETH_SEPOLIA_TO_ZKEVM_TESTNET, {
-    rootChainERC20Predicate: '0x9A7E4C4337a70C6754a9672F5ba69084463794B8',
-    rootChainStateSender: '0xfBfF6FD165adFA113bE39eE85ef030A996153253',
+    rootChainERC20Predicate: '0x0C15a8359865867CdCC44f98b2F3fd5DF098C7E0',
+    rootChainStateSender: '0x4C80001188db53dbc2eaAb32d5ef825feEedECA5',
     childChainERC20Predicate: '0x0000000000000000000000000000000000001004',
     childChainStateReceiver: '0x0000000000000000000000000000000000001001',
 })
@@ -10873,7 +10873,7 @@ function getQuote(otherCurrency, tradeType, tradeInfo, slippage) {
 }
 
 const IMMUTABLE_TESTNET_RPC_URL = 'https://zkevm-rpc.sandbox.x.immutable.com';
-const IMMUTABLE_TESTNET_CHAIN_ID = 13392;
+const IMMUTABLE_TESTNET_CHAIN_ID = 13372;
 
 const TIMX_IMMUTABLE_TESTNET = {
     chainId: IMMUTABLE_TESTNET_CHAIN_ID,
@@ -12512,16 +12512,28 @@ const SUPPORTED_CHAIN_IDS_FOR_ENVIRONMENT = {
     [Environment$1.PRODUCTION]: SUPPORTED_PRODUCTION_CHAINS,
 };
 function validateOverrides(overrides) {
-    Object.entries(overrides).forEach(([key, value]) => {
-        if (!value) {
+    const keysToCheck = ['rpcURL', 'exchangeContracts', 'commonRoutingTokens', 'nativeToken'];
+    for (const key of keysToCheck) {
+        if (!overrides[key]) {
             throw new InvalidConfigurationError(`Missing override: ${key}`);
         }
-    });
+    }
     Object.entries(overrides.exchangeContracts).forEach(([key, contract]) => {
         if (!isValidNonZeroAddress(contract)) {
             throw new InvalidConfigurationError(`Invalid exchange contract address for ${key}`);
         }
     });
+    if (!overrides.secondaryFees) {
+        return;
+    }
+    for (const secondaryFee of overrides.secondaryFees) {
+        if (!isValidNonZeroAddress(secondaryFee.feeRecipient)) {
+            throw new InvalidConfigurationError(`Invalid secondary fee recipient address: ${secondaryFee.feeRecipient}`);
+        }
+        if (secondaryFee.feeBasisPoints < 0 || secondaryFee.feeBasisPoints > 10000) {
+            throw new InvalidConfigurationError(`Invalid secondary fee percentage: ${secondaryFee.feeBasisPoints}`);
+        }
+    }
 }
 /**
  * {@link ExchangeConfiguration} is used to configure the {@link Exchange} class.
@@ -12531,6 +12543,7 @@ function validateOverrides(overrides) {
 class ExchangeConfiguration {
     baseConfig;
     chain;
+    secondaryFees;
     constructor({ chainId, baseConfig, overrides }) {
         this.baseConfig = baseConfig;
         if (overrides) {
@@ -12542,8 +12555,10 @@ class ExchangeConfiguration {
                 commonRoutingTokens: overrides.commonRoutingTokens,
                 nativeToken: overrides.nativeToken,
             };
+            this.secondaryFees = overrides.secondaryFees ? overrides.secondaryFees : [];
             return;
         }
+        this.secondaryFees = [];
         const chain = SUPPORTED_CHAIN_IDS_FOR_ENVIRONMENT[baseConfig.environment][chainId];
         if (!chain) {
             throw new ChainNotSupportedError(chainId, baseConfig.environment);
@@ -12557,11 +12572,13 @@ class Exchange {
     router;
     chainId;
     nativeToken;
+    secondaryFees;
     constructor(configuration) {
         const config = new ExchangeConfiguration(configuration);
         this.chainId = config.chain.chainId;
         this.nativeToken = config.chain.nativeToken;
         this.provider = new ethers.providers.JsonRpcProvider(config.chain.rpcUrl);
+        this.secondaryFees = config.secondaryFees;
         this.router = new Router(this.provider, config.chain.commonRoutingTokens, {
             multicallAddress: config.chain.contracts.multicall,
             factoryAddress: config.chain.contracts.coreFactory,
@@ -12644,6 +12661,9 @@ class Exchange {
     async getUnsignedSwapTxFromAmountOut(fromAddress, tokenInAddress, tokenOutAddress, amountOut, slippagePercent = DEFAULT_SLIPPAGE, maxHops = DEFAULT_MAX_HOPS, deadline = DEFAULT_DEADLINE) {
         return await this.getUnsignedSwapTx(fromAddress, tokenInAddress, tokenOutAddress, amountOut, slippagePercent, maxHops, deadline, TradeType.EXACT_OUTPUT);
     }
+    thereAreSecondaryFees() {
+        return this.secondaryFees.length > 0;
+    }
 }
 
 /* eslint-disable class-methods-use-this */ 
@@ -12720,8 +12740,8 @@ const $762782b6c862d954$export$db5daa1b5156ccfe = [
  */ var $0472f23319457bfb$export$c06e1e7429de6283;
 (function(ChainId) {
     ChainId[ChainId["IMTBL_ZKEVM_MAINNET"] = 13371] = "IMTBL_ZKEVM_MAINNET";
-    ChainId[ChainId["IMTBL_ZKEVM_TESTNET"] = 13392] = "IMTBL_ZKEVM_TESTNET";
-    ChainId[ChainId["IMTBL_ZKEVM_DEVNET"] = 13403] = "IMTBL_ZKEVM_DEVNET";
+    ChainId[ChainId["IMTBL_ZKEVM_TESTNET"] = 13372] = "IMTBL_ZKEVM_TESTNET";
+    ChainId[ChainId["IMTBL_ZKEVM_DEVNET"] = 13423] = "IMTBL_ZKEVM_DEVNET";
     ChainId[ChainId["ETHEREUM"] = 1] = "ETHEREUM";
     ChainId[ChainId["SEPOLIA"] = 11155111] = "SEPOLIA";
 })($0472f23319457bfb$export$c06e1e7429de6283 || ($0472f23319457bfb$export$c06e1e7429de6283 = {}));
@@ -12806,6 +12826,10 @@ const $d85ad1457a3f1a83$export$161d4a74df65fc08 = {
     [(Environment$1).SANDBOX]: "https://checkout-api.sandbox.immutable.com",
     [(Environment$1).PRODUCTION]: "https://checkout-api.immutable.com"
 };
+const $d85ad1457a3f1a83$export$7b057be2a3f512cc = {
+    [(Environment$1).SANDBOX]: "https://zkevm-rpc.sandbox.x.immutable.com",
+    [(Environment$1).PRODUCTION]: "https://zkevm-rpc.x.immutable.com"
+};
 const $d85ad1457a3f1a83$export$6f24f3cef7d501c4 = new Map([
     [
         ($0472f23319457bfb$export$c06e1e7429de6283).ETHEREUM,
@@ -12831,7 +12855,7 @@ const $d85ad1457a3f1a83$export$6f24f3cef7d501c4 = new Map([
             chainIdHex: `0x${($0472f23319457bfb$export$c06e1e7429de6283).IMTBL_ZKEVM_MAINNET.toString(16)}`,
             chainName: ($0472f23319457bfb$export$b874c6b1dfe85e02).IMTBL_ZKEVM_MAINNET,
             rpcUrls: [
-                "https://zkevm-rpc.x.immutable.com"
+                "https://rpc.immutable.com"
             ],
             nativeCurrency: {
                 name: "IMX",
@@ -12866,7 +12890,7 @@ const $d85ad1457a3f1a83$export$3e81fc0987227f10 = new Map([
             chainIdHex: `0x${($0472f23319457bfb$export$c06e1e7429de6283).IMTBL_ZKEVM_TESTNET.toString(16)}`,
             chainName: ($0472f23319457bfb$export$b874c6b1dfe85e02).IMTBL_ZKEVM_TESTNET,
             rpcUrls: [
-                "https://zkevm-rpc.sandbox.x.immutable.com"
+                "https://rpc.testnet.immutable.com"
             ],
             nativeCurrency: {
                 name: "IMX",
@@ -13242,16 +13266,19 @@ async function $5c763be0b0b81038$var$getMetaMaskProvider() {
     if (!provider || !provider.request) throw new ($a8bc256d81a5e2c1$export$b722478a3cbfa3bc)("No MetaMask provider installed.", ($a8bc256d81a5e2c1$export$e3dc0620abde7f5a).METAMASK_PROVIDER_ERROR);
     return new (Web3Provider)(provider);
 }
-async function $5c763be0b0b81038$export$500fbc0cd14cdbaa(defaultProvider) {
-    let web3Provider = null;
-    switch(defaultProvider){
+async function $5c763be0b0b81038$export$500fbc0cd14cdbaa(walletProviderName) {
+    let provider = null;
+    switch(walletProviderName){
         case ($e768639828688ca3$export$2d7a51a18d87e21d).METAMASK:
-            web3Provider = await $5c763be0b0b81038$var$getMetaMaskProvider();
+            provider = await $5c763be0b0b81038$var$getMetaMaskProvider();
             break;
         default:
             throw new ($a8bc256d81a5e2c1$export$b722478a3cbfa3bc)("Provider not supported", ($a8bc256d81a5e2c1$export$e3dc0620abde7f5a).DEFAULT_PROVIDER_ERROR);
     }
-    return web3Provider;
+    return {
+        provider: provider,
+        walletProviderName: walletProviderName
+    };
 }
 
 
@@ -13260,9 +13287,8 @@ async function $5c763be0b0b81038$export$500fbc0cd14cdbaa(defaultProvider) {
 
 
 
-
 function $bb88265fe45a0393$export$ebe4804963e71f98(web3Provider) {
-    if (web3Provider && web3Provider instanceof (Web3Provider) && web3Provider.provider?.request) return true;
+    if (web3Provider && web3Provider.provider?.request && typeof web3Provider.provider.request === "function") return true;
     return false;
 }
 async function $bb88265fe45a0393$export$9e1fd9cc88c637a0(config, web3Provider, validateProviderOptions) {
@@ -13472,10 +13498,23 @@ class $4013c5c91bb535f6$export$6ad73ea7e1b6f37f extends Error {
         this.message = message;
     }
 }
-const $4013c5c91bb535f6$var$networkMap = (prod, dev)=>{
-    if (dev) return $d85ad1457a3f1a83$export$3a9ebede6a150274;
-    if (prod) return $d85ad1457a3f1a83$export$6f24f3cef7d501c4;
-    return $d85ad1457a3f1a83$export$3e81fc0987227f10;
+const $4013c5c91bb535f6$var$networkMap = (prod, dev, local)=>{
+    let networks;
+    if (dev) networks = ($d85ad1457a3f1a83$export$3a9ebede6a150274);
+    else if (prod) {
+        networks = ($d85ad1457a3f1a83$export$6f24f3cef7d501c4);
+        if (local) {
+            const rpcUrls = networks.get(($0472f23319457bfb$export$c06e1e7429de6283).IMTBL_ZKEVM_MAINNET)?.rpcUrls;
+            rpcUrls?.splice(0, 1, ($d85ad1457a3f1a83$export$7b057be2a3f512cc)[(Environment$1).PRODUCTION]);
+        }
+    } else {
+        networks = ($d85ad1457a3f1a83$export$3e81fc0987227f10);
+        if (local) {
+            const rpcUrls = networks.get(($0472f23319457bfb$export$c06e1e7429de6283).IMTBL_ZKEVM_TESTNET)?.rpcUrls;
+            rpcUrls?.splice(0, 1, ($d85ad1457a3f1a83$export$7b057be2a3f512cc)[(Environment$1).SANDBOX]);
+        }
+    }
+    return networks;
 };
 const $4013c5c91bb535f6$export$9b794d067cdd1af6 = (config)=>{
     // DevMode and Sandbox will both use Sepolia.
@@ -13493,6 +13532,11 @@ class $4013c5c91bb535f6$export$4823433c4a67bbc6 {
     // This will be used to get around the lack of
     // Environment.DEVELOPMENT
     isDevelopment = false;
+    // This is a hidden feature that is only available
+    // when building the project from source code.
+    // This will be used to get around the lack of
+    // Environment.LOCAL_DEVELOPMENT
+    isLocal = false;
     isProduction;
     remote;
     environment;
@@ -13502,7 +13546,7 @@ class $4013c5c91bb535f6$export$4823433c4a67bbc6 {
         this.environment = config.baseConfig.environment;
         // Developer mode will super set any environment configuration
         this.isProduction = !this.isDevelopment && this.environment === (Environment$1).PRODUCTION;
-        this.networkMap = $4013c5c91bb535f6$var$networkMap(this.isProduction, this.isDevelopment);
+        this.networkMap = $4013c5c91bb535f6$var$networkMap(this.isProduction, this.isDevelopment, this.isLocal);
         this.remote = new ($a492ee374ae7b613$export$d902b56530cd5f87)({
             isDevelopment: this.isDevelopment,
             isProduction: this.isProduction
@@ -13648,10 +13692,7 @@ class $a8cb37a3fc8eb863$export$1f60ba4ec72508a0 {
    * @param {CreateProviderParams} params - The parameters for creating the provider.
    * @returns {Promise<CreateProviderResult>} A promise that resolves to the created provider.
    */ async createProvider(params) {
-        const web3Provider = await $5c763be0b0b81038$export$500fbc0cd14cdbaa(params.walletProvider);
-        return {
-            provider: web3Provider
-        };
+        return await $5c763be0b0b81038$export$500fbc0cd14cdbaa(params.walletProvider);
     }
     /**
    * Checks if a wallet is connected to the specified provider.

package/dist/checkout_widgets.d.ts

@@ -14135,6 +14135,9 @@ declare namespace React {
     //   - "string"
     //   - union of string literals
     interface SVGAttributes<T> extends AriaAttributes, DOMAttributes<T> {
+        // React-specific Attributes
+        suppressHydrationWarning?: boolean | undefined;
+
         // Attributes which also defined in HTMLAttributes
         // See comment in SVGDOMPropertyConfig.js
         className?: string | undefined;
@@ -15024,7 +15027,6 @@ type SemanticVersion = {
  * @property {WidgetTheme | undefined} theme - The theme of the Checkout Widget (default: "DARK")
  * @property {Environment | undefined} environment - The environment configuration (default: "SANDBOX")
  * @property {SemanticVersion | undefined} version - The version of the checkout widgets js file to use (default: "0.1.0")
- * @property {boolean | undefined} isOnRampEnabled - Enable on-ramp top-up method (default: "true")
  * @property {boolean | undefined} isSwapEnabled - Enable swap top-up method (default: "true")
  * @property {boolean | undefined} isBridgeEnabled - Enable bridge top-up method (default: "true")
  */
@@ -15032,7 +15034,6 @@ type CheckoutWidgetsConfig = {
     theme?: WidgetTheme;
     environment?: Environment;
     version?: SemanticVersion;
-    isOnRampEnabled?: boolean;
     isSwapEnabled?: boolean;
     isBridgeEnabled?: boolean;
 };

package/dist/checkout_widgets.js

@@ -4,7 +4,7 @@ import { useEffect } from 'react';
 function $parcel$export(e, n, v, s) {
   Object.defineProperty(e, n, {get: v, set: s, enumerable: true, configurable: true});
 }
-const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.4.0-alpha.2";
+const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.4.1-alpha";
 const $d663162fd5a0853f$export$83bf90b30cdfd29f = ()=>false;
 const $d663162fd5a0853f$export$1169f5475725171b = ()=>$d663162fd5a0853f$export$38a083d9fb5551ca;
 

package/dist/immutablex_client.d.ts

@@ -825,7 +825,7 @@ interface TokenData {
      */
     'quantity': string;
     /**
-     * Quantity of this asset with the sum of all fees applied to the asset
+     * [DEPRECATED for v3 endpoints] Quantity of this asset with the sum of all fees applied to the asset. Replaced by quantity_with_fees in maker_fees / taker_fees depending on the type of order. Refer https://docs.x.immutable.com/docs/maker-taker-fees/#new-maker-taker-fields-and-the-deprecation-of-quantity_with_fees-in-buy-and-sell.
      * @type {string}
      * @memberof TokenData
      */
@@ -3688,7 +3688,7 @@ interface GetSignableOrderRequestV3 {
      */
     'amount_sell': string;
     /**
-     * ExpirationTimestamp in Unix time. Note: will be rounded down to the nearest hour
+     * ExpirationTimestamp in Unix time in hours. Note: will be rounded down to the nearest hour
      * @type {number}
      * @memberof GetSignableOrderRequestV3
      */
@@ -3787,7 +3787,7 @@ interface GetSignableOrderResponse {
      */
     'asset_id_sell': string;
     /**
-     * Expiration timestamp for this order
+     * ExpirationTimestamp in Unix time in hours. Note: will be rounded down to the nearest hour
      * @type {number}
      * @memberof GetSignableOrderResponse
      */
@@ -3948,7 +3948,7 @@ interface GetSignableRegistrationResponse {
  */
 interface GetSignableTradeRequest {
     /**
-     * ExpirationTimestamp in Unix time. Note: will be rounded down to the nearest hour
+     * ExpirationTimestamp in Unix time in hours. Note: will be rounded down to the nearest hour
      * @type {number}
      * @memberof GetSignableTradeRequest
      */
@@ -4035,7 +4035,7 @@ interface GetSignableTradeResponse {
      */
     'asset_id_sell': string;
     /**
-     * Expiration timestamp for this order
+     * ExpirationTimestamp in Unix time in hours. Note: will be rounded down to the nearest hour
      * @type {number}
      * @memberof GetSignableTradeResponse
      */
@@ -5122,7 +5122,7 @@ interface OrderV3 {
      */
     'expiration_timestamp': string | null;
     /**
-     * Fee information for the order
+     * [DEPRECATED] Fee information for the order. Replaced by maker_fees / taker_fees depending on the type of order. Refer https://docs.x.immutable.com/docs/maker-taker-fees/#new-maker-taker-fields-and-the-deprecation-of-quantity_with_fees-in-buy-and-sell.
      * @type {Array<OrderFeeInfo>}
      * @memberof OrderV3
      */
@@ -8676,10 +8676,11 @@ interface OrdersApiListOrdersV3Request {
  */
 declare class OrdersApi extends BaseAPI {
     /**
-     * Cancel an order. Use https://docs.x.immutable.com/reference#/operations/getSignableCancelOrder to get request body params.
+     * Cancel an order. Use https://docs.x.immutable.com/reference#/operations/getSignableCancelOrder to get request body params.  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/cancelOrderV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
      * @summary Cancel an order
      * @param {OrdersApiCancelOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof OrdersApi
      */
@@ -8694,10 +8695,11 @@ declare class OrdersApi extends BaseAPI {
      */
     cancelOrderV3(requestParameters: OrdersApiCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
     /**
-     * Create an order. Use https://docs.x.immutable.com/reference#/operations/getSignableOrder to get request body params.
+     * Create an order. Use https://docs.x.immutable.com/reference#/operations/getSignableOrder to get request body params.  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/createOrderV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
      * @summary Create an order
      * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof OrdersApi
      */
@@ -8712,10 +8714,11 @@ declare class OrdersApi extends BaseAPI {
      */
     createOrderV3(requestParameters: OrdersApiCreateOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
     /**
-     * Get an order
+     * Get an order.  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/getOrderV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
      * @summary Get an order
      * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof OrdersApi
      */
@@ -8730,17 +8733,18 @@ declare class OrdersApi extends BaseAPI {
      */
     getOrderV3(requestParameters: OrdersApiGetOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<OrderV3, any>>;
     /**
-     * Get a signable cancel order message
-     * @summary Get a signable cancel order message
+     * Sign cancel order message.  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/getSignableCancelOrderV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
+     * @summary Sign cancel order message
      * @param {OrdersApiGetSignableCancelOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof OrdersApi
      */
     getSignableCancelOrder(requestParameters: OrdersApiGetSignableCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>;
     /**
-     * Get a signable cancel order message (V3)
-     * @summary Get a signable cancel order message (V3)
+     * Generate a signable cancel order message (V3)
+     * @summary Generate a signable cancel order message (V3)
      * @param {OrdersApiGetSignableCancelOrderV3Request} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -8748,8 +8752,8 @@ declare class OrdersApi extends BaseAPI {
      */
     getSignableCancelOrderV3(requestParameters: OrdersApiGetSignableCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>;
     /**
-     * Get a signable order request (V3)
-     * @summary Get a signable order request (V3)
+     * Generate a signable order request (V3)
+     * @summary Generate a signable order request (V3)
      * @param {OrdersApiGetSignableOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -8757,10 +8761,11 @@ declare class OrdersApi extends BaseAPI {
      */
     getSignableOrder(requestParameters: OrdersApiGetSignableOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableOrderResponse, any>>;
     /**
-     * Get a list of orders
-     * @summary Get a list of orders
+     * Get a list of orders  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/listOrdersV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
+     * @summary Get a list of orders.
      * @param {OrdersApiListOrdersRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof OrdersApi
      */
@@ -9123,10 +9128,10 @@ interface TradesApiListTradesRequest {
     readonly cursor?: string;
     /**
      * Property to sort by
-     * @type {'created_at' | 'updated_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity'}
+     * @type {'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity'}
      * @memberof TradesApiListTrades
      */
-    readonly orderBy?: 'created_at' | 'updated_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity';
+    readonly orderBy?: 'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity';
     /**
      * Direction to sort (asc/desc)
      * @type {string}
@@ -9196,10 +9201,10 @@ interface TradesApiListTradesV3Request {
     readonly cursor?: string;
     /**
      * Property to sort by
-     * @type {'created_at' | 'updated_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp'}
+     * @type {'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp'}
      * @memberof TradesApiListTradesV3
      */
-    readonly orderBy?: 'created_at' | 'updated_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp';
+    readonly orderBy?: 'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp';
     /**
      * Direction to sort (asc/desc)
      * @type {string}
@@ -9227,10 +9232,11 @@ interface TradesApiListTradesV3Request {
  */
 declare class TradesApi extends BaseAPI {
     /**
-     * Create a trade. Use https://docs.x.immutable.com/reference#/operations/getSignableTrade to get request body params.
+     * Create a trade. Use https://docs.x.immutable.com/reference#/operations/getSignableTrade to get request body params.  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/createTradeV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
      * @summary Create a Trade between two parties
      * @param {TradesApiCreateTradeRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof TradesApi
      */
@@ -9245,8 +9251,8 @@ declare class TradesApi extends BaseAPI {
      */
     createTradeV3(requestParameters: TradesApiCreateTradeV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse, any>>;
     /**
-     * Get a signable trade V3 message
-     * @summary Get a signable trade V3 message
+     * Generate a signable trade message (V3)
+     * @summary Generate a signable trade message (V3)
      * @param {TradesApiGetSignableTradeRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -9263,10 +9269,11 @@ declare class TradesApi extends BaseAPI {
      */
     getTrade(requestParameters: TradesApiGetTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Trade, any>>;
     /**
-     * Get a list of trades
+     * Get a list of trades.  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/listTradesV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
      * @summary Get a list of trades
      * @param {TradesApiListTradesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof TradesApi
      */
@@ -9499,7 +9506,7 @@ interface TransfersApiListTransfersRequest {
  */
 declare class TransfersApi extends BaseAPI {
     /**
-     * Create a new transfer request.
+     * Create a new transfer request. Use https://docs.x.immutable.com/reference#/operations/getSignableTransfer to get request body params.
      * @summary Creates a transfer of multiple tokens between two parties
      * @param {TransfersApiCreateTransferRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -9508,7 +9515,7 @@ declare class TransfersApi extends BaseAPI {
      */
     createTransfer(requestParameters: TransfersApiCreateTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTransferResponse, any>>;
     /**
-     * Create a new transfer request.
+     * Create a new transfer request. Use https://docs.x.immutable.com/reference#/operations/getSignableTransferV1 to get request body params.
      * @summary Creates a transfer of tokens between two parties
      * @param {TransfersApiCreateTransferV1Request} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -10194,14 +10201,14 @@ declare class ImmutableXClient {
      * @returns a promise that resolves with the requested Order
      * @throws {@link index.IMXError}
      */
-    getOrder(request: OrdersApiGetOrderRequest): Promise<Order>;
+    getOrder(request: OrdersApiGetOrderRequest): Promise<OrderV3>;
     /**
      * Get a list of Orders
      * @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}
      */
-    listOrders(request?: OrdersApiListOrdersRequest): Promise<ListOrdersResponse>;
+    listOrders(request?: OrdersApiListOrdersRequest): Promise<ListOrdersResponseV3>;
     /**
      * Get details of a Trade with the given ID
      * @param request - the request object containing the parameters to be provided in the API request

package/dist/immutablex_client.js

@@ -16,7 +16,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.4.0-alpha.2',
+    sdkVersion: 'ts-immutable-sdk-0.4.1-alpha',
 });
 /**
  * Sets `sdkVersion` at the time of build