@imtbl/sdk 1.19.2-alpha → 1.19.2-alpha.2

package/dist/checkout.d.ts

@@ -546,573 +546,6 @@ declare class Web3Provider extends JsonRpcProvider {
     send(method: string, params: Array<any>): Promise<any>;
 }
 
-/**
- * An ERC20 token
- */
-interface ERC20Token$1 {
-    type: 'ERC20';
-    tokenAddress: string;
-}
-/**
- * An ERC721 token
- */
-interface ERC721Token {
-    type: 'ERC721';
-    tokenId: string;
-    tokenAddress: string;
-}
-/**
- * An ETH token
- */
-interface ETHToken$1 {
-    type: 'ETH';
-}
-/**
- * An amount of ETH token of unit Wei
- */
-interface ETHAmount$1 extends ETHToken$1 {
-    /**
-     * An amount in unit Wei
-     */
-    amount: string;
-}
-/**
- * The token details and amount of ERC20 token units
- */
-interface ERC20Amount$1 extends ERC20Token$1 {
-    /**
-     * An amount in units for the given ERC20 token
-     */
-    amount: string;
-}
-/**
- * Union type that represents all token types
- */
-declare type AnyToken = ETHToken$1 | ERC721Token | ERC20Token$1;
-/**
- * Union type that represents all token type amounts
- */
-declare type TokenAmount = ETHAmount$1 | ERC20Amount$1 | ERC721Token;
-/**
- * Union type that represents exchange token type amounts
- */
-declare type ExchangeTokenAmount$1 = ETHAmount$1 | ERC20Amount$1;
-
-/**
- * Immutable X API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 3.0
- * Contact: support@immutable.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- *
- * @export
- * @interface CancelOrderResponse
- */
-interface CancelOrderResponse$1 {
-    /**
-     * ID of the cancelled order
-     * @type {number}
-     * @memberof CancelOrderResponse
-     */
-    'order_id': number;
-    /**
-     * New status of the order
-     * @type {string}
-     * @memberof CancelOrderResponse
-     */
-    'status': string;
-}
-
-/**
- * Immutable X API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 3.0
- * Contact: support@immutable.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- *
- * @export
- * @interface FeeEntry
- */
-interface FeeEntry$1 {
-    /**
-     *
-     * @type {string}
-     * @memberof FeeEntry
-     */
-    'address'?: string;
-    /**
-     *
-     * @type {number}
-     * @memberof FeeEntry
-     */
-    'fee_percentage'?: number;
-}
-
-/**
- * Immutable X API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 3.0
- * Contact: support@immutable.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- *
- * @export
- * @interface CreateOrderResponse
- */
-interface CreateOrderResponse$1 {
-    /**
-     * ID of the created order
-     * @type {number}
-     * @memberof CreateOrderResponse
-     */
-    'order_id': number;
-    /**
-     * Request ID as a reference for an asynchronous order creation request
-     * @type {string}
-     * @memberof CreateOrderResponse
-     */
-    'request_id'?: string;
-    /**
-     * Status of the created order
-     * @type {string}
-     * @memberof CreateOrderResponse
-     */
-    'status': string;
-    /**
-     * Timestamp of the created order
-     * @type {number}
-     * @memberof CreateOrderResponse
-     */
-    'time': number;
-}
-
-/**
- * Immutable X API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 3.0
- * Contact: support@immutable.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- *
- * @export
- * @interface CreateTradeResponse
- */
-interface CreateTradeResponse$1 {
-    /**
-     * Request ID as a reference for an asynchronous trade creation request
-     * @type {string}
-     * @memberof CreateTradeResponse
-     */
-    'request_id'?: string;
-    /**
-     * Current status of trade
-     * @type {string}
-     * @memberof CreateTradeResponse
-     */
-    'status': string;
-    /**
-     * ID of trade within Immutable X
-     * @type {number}
-     * @memberof CreateTradeResponse
-     */
-    'trade_id': number;
-}
-
-/**
- * Immutable X API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 3.0
- * Contact: support@immutable.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- *
- * @export
- * @interface CreateTransferResponse
- */
-interface CreateTransferResponse {
-    /**
-     * List of transfer IDs
-     * @type {Array<number>}
-     * @memberof CreateTransferResponse
-     */
-    'transfer_ids': Array<number>;
-}
-
-/**
- * Immutable X API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 3.0
- * Contact: support@immutable.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- *
- * @export
- * @interface CreateTransferResponseV1
- */
-interface CreateTransferResponseV1$2 {
-    /**
-     * [deprecated] Sent signature
-     * @type {string}
-     * @memberof CreateTransferResponseV1
-     */
-    'sent_signature': string;
-    /**
-     * [deprecated] The status of transfer
-     * @type {string}
-     * @memberof CreateTransferResponseV1
-     */
-    'status': string;
-    /**
-     * [deprecated] Time of the transfer
-     * @type {number}
-     * @memberof CreateTransferResponseV1
-     */
-    'time': number;
-    /**
-     * ID of the transfer
-     * @type {number}
-     * @memberof CreateTransferResponseV1
-     */
-    'transfer_id': number;
-}
-
-/**
- * Immutable X API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 3.0
- * Contact: support@immutable.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- *
- * @export
- * @interface CreateWithdrawalResponse
- */
-interface CreateWithdrawalResponse$1 {
-    /**
-     * Status of the withdrawal
-     * @type {string}
-     * @memberof CreateWithdrawalResponse
-     */
-    'status': string;
-    /**
-     * Time of the withdrawal
-     * @type {number}
-     * @memberof CreateWithdrawalResponse
-     */
-    'time': number;
-    /**
-     * ID of the withdrawal
-     * @type {number}
-     * @memberof CreateWithdrawalResponse
-     */
-    'withdrawal_id': number;
-}
-
-/**
- * Immutable X API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 3.0
- * Contact: support@immutable.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- *
- * @export
- * @interface GetSignableCancelOrderRequest
- */
-interface GetSignableCancelOrderRequest$1 {
-    /**
-     * ID of the order to be cancelled
-     * @type {number}
-     * @memberof GetSignableCancelOrderRequest
-     */
-    'order_id': number;
-}
-
-/**
- * Immutable X API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 3.0
- * Contact: support@immutable.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-/**
- *
- * @export
- * @interface GetSignableTradeRequest
- */
-interface GetSignableTradeRequest$1 {
-    /**
-     * ExpirationTimestamp in Unix time in hours. Note: will be rounded down to the nearest hour
-     * @type {number}
-     * @memberof GetSignableTradeRequest
-     */
-    'expiration_timestamp'?: number;
-    /**
-     * Inclusion of either maker or taker fees
-     * @type {Array<FeeEntry>}
-     * @memberof GetSignableTradeRequest
-     */
-    'fees'?: Array<FeeEntry$1>;
-    /**
-     * The ID of the maker order involved
-     * @type {number}
-     * @memberof GetSignableTradeRequest
-     */
-    'order_id': number;
-    /**
-     * Ethereum address of the submitting user
-     * @type {string}
-     * @memberof GetSignableTradeRequest
-     */
-    'user': string;
-}
-
-/**
- * Immutable X API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 3.0
- * Contact: support@immutable.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- *
- * @export
- * @interface RegisterUserResponse
- */
-interface RegisterUserResponse$1 {
-    /**
-     * Immutable signature authorising registration
-     * @type {string}
-     * @memberof RegisterUserResponse
-     */
-    'tx_hash': string;
-}
-
-/**
- * Parameter required to create an Order
- */
-interface UnsignedOrderRequest {
-    /**
-     * The amount of tokens that will be bought for this order
-     */
-    buy: TokenAmount;
-    /**
-     * The amount of tokens that will be sold for this order
-     */
-    sell: TokenAmount;
-    /**
-     * ExpirationTimestamp in Unix time. Note: will be rounded down to the nearest hour
-     */
-    expiration_timestamp?: number;
-    /**
-     * Inclusion of either maker or taker fees
-     */
-    fees?: Array<FeeEntry$1>;
-}
-/**
- * Parameter required to create a Transfer
- */
-declare type UnsignedTransferRequest = TokenAmount & {
-    /**
-     * Ethereum address of the receiving user
-     */
-    receiver: string;
-};
-/**
- * Parameter required to create a Transfer
- */
-declare type UnsignedExchangeTransferRequest$1 = ExchangeTokenAmount$1 & {
-    /**
-     * Ethereum address of the receiving user
-     */
-    receiver: string;
-    /**
-     * Exchange transaction ID
-     */
-    transactionID: string;
-};
-
-/**
- * Parameter required to create a batchNftTransfer
- */
-interface NftTransferDetails {
-    /**
-     * Ethereum address of the receiving user
-     */
-    receiver: string;
-    /**
-     * The token ID
-     */
-    tokenId: string;
-    /**
-     * The token contract address
-     */
-    tokenAddress: string;
-}
-
-interface IMXProvider {
-    /**
-     * Get the Signer address
-     *
-     * @return {Promise<string>} Returns a promise that resolves with the signer's address
-     */
-    getAddress(): Promise<string>;
-    /**
-     * Register a User to Immutable X if they are not already registered
-     *
-     * @return {Promise<RegisterUserResponse>} Returns a promise that resolves with the user registration response
-     */
-    registerOffchain(): Promise<RegisterUserResponse$1>;
-    /**
-     *  Checks if a User is registered off-chain
-     *
-     *  @return {Promise<boolean>} Returns a promise that resolves with true if the User is registered with IMX, false otherwise
-     */
-    isRegisteredOffchain(): Promise<boolean>;
-    /**
-     * Checks if a User is registered on-chain
-     *
-     * @return {Promise<boolean>} Returns a promise that resolves with true if the User is registered, false otherwise
-     */
-    isRegisteredOnchain(): Promise<boolean>;
-    /**
-     * Create an Order
-     *
-     * @param {UnsignedOrderRequest} request The unsigned order request to create an order
-     * @return {Promise<CreateOrderResponse>} Returns a promise that resolves with the created Order
-     */
-    createOrder(request: UnsignedOrderRequest): Promise<CreateOrderResponse$1>;
-    /**
-     * Cancel an Order
-     *
-     * @param {GetSignableCancelOrderRequest} request The signable cancel order request
-     * @return {Promise<CancelOrderResponse>} Returns a promise that resolves with the cancelled Order
-     */
-    cancelOrder(request: GetSignableCancelOrderRequest$1): Promise<CancelOrderResponse$1>;
-    /**
-     * Create a Trade
-     *
-     * @param {GetSignableTradeRequest} request The signable trade request
-     * @return {Promise<CreateTradeResponse>} Returns a promise that resolves with the created Trade
-     */
-    createTrade(request: GetSignableTradeRequest$1): Promise<CreateTradeResponse$1>;
-    /**
-     * Create a new Transfer request
-     *
-     * @param {UnsignedTransferRequest} request The unsigned transfer request
-     * @return {Promise<CreateTransferResponseV1>} Returns a promise that resolves with the created Transfer
-     */
-    transfer(request: UnsignedTransferRequest): Promise<CreateTransferResponseV1$2>;
-    /**
-     * Create a batch of NFT transfer requests
-     *
-     * @param {Array<NftTransferDetails>} request An array of NFT transfer details
-     * @return {Promise<CreateTransferResponse>} Resolves a promise that resolves with the list of Transfer IDs
-     */
-    batchNftTransfer(request: Array<NftTransferDetails>): Promise<CreateTransferResponse>;
-    /**
-     * Create a new Exchange transaction
-     *
-     * @param {UnsignedExchangeTransferRequest} request The unsigned exchange transfer request
-     * @return {Promise<CreateTransferResponseV1>} Returns a promise that resolves with the created Exchange Transaction
-     */
-    exchangeTransfer(request: UnsignedExchangeTransferRequest$1): Promise<CreateTransferResponseV1$2>;
-    /**
-     * Deposit either ETH, ERC20 or ERC721 tokens
-     *
-     * @param {TokenAmount} request The token type amount in its corresponding unit
-     * @return {Promise<TransactionResponse>} Returns a promise that resolves with the transaction
-     */
-    deposit(deposit: TokenAmount): Promise<TransactionResponse>;
-    /**
-     * Create a Withdrawal
-     *
-     * @param {TokenAmount} request The token type amount in its corresponding unit
-     * @return {Promise<CreateWithdrawalResponse>} Returns a promise that resolves with the created Withdrawal
-     */
-    prepareWithdrawal(request: TokenAmount): Promise<CreateWithdrawalResponse$1>;
-    /**
-     * Completes a Withdrawal
-     *
-     * @param {string} starkPublicKey The stark public key
-     * @param {AnyToken} token The token to withdraw
-     * @return {Promise<TransactionResponse>} Returns a promise that resolves with the transaction
-     */
-    completeWithdrawal(starkPublicKey: string, token: AnyToken): Promise<TransactionResponse>;
-}
-
-declare enum Environment {
-    PRODUCTION = "production",
-    SANDBOX = "sandbox"
-}
-declare class ImmutableConfiguration {
-    readonly environment: Environment;
-    readonly rateLimitingKey?: string;
-    readonly apiKey?: string;
-    readonly publishableKey?: string;
-    constructor(options: {
-        environment: Environment;
-        rateLimitingKey?: string;
-        apiKey?: string;
-        publishableKey?: string;
-    });
-}
-interface ModuleConfiguration<T> {
-    baseConfig: ImmutableConfiguration;
-    overrides?: T;
-}
-
 // TypeScript Version: 4.7
 type AxiosHeaderValue = AxiosHeaders | string | string[] | number | boolean | null;
 
@@ -4614,7 +4047,7 @@ interface FeeInfo {
  * @export
  * @interface CreateTradeResponse
  */
-interface CreateTradeResponse {
+interface CreateTradeResponse$1 {
     /**
      * Request ID as a reference for an asynchronous trade creation request
      * @type {string}
@@ -4807,6 +4240,31 @@ interface CreateTransferRequestV1 {
     'stark_signature': string;
 }
 
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CreateTransferResponse
+ */
+interface CreateTransferResponse {
+    /**
+     * List of transfer IDs
+     * @type {Array<number>}
+     * @memberof CreateTransferResponse
+     */
+    'transfer_ids': Array<number>;
+}
+
 /**
  * Immutable X API
  * Immutable X API
@@ -6111,7 +5569,7 @@ interface Project {
  * @export
  * @interface GetSignableCancelOrderRequest
  */
-interface GetSignableCancelOrderRequest {
+interface GetSignableCancelOrderRequest$1 {
     /**
      * ID of the order to be cancelled
      * @type {number}
@@ -6669,7 +6127,7 @@ interface GetSignableRegistrationResponse {
  * @export
  * @interface GetSignableTradeRequest
  */
-interface GetSignableTradeRequest {
+interface GetSignableTradeRequest$1 {
     /**
      * ExpirationTimestamp in Unix time in hours. Note: will be rounded down to the nearest hour
      * @type {number}
@@ -12042,7 +11500,7 @@ interface OrdersApiGetSignableCancelOrderV3Request {
      * @type {GetSignableCancelOrderRequest}
      * @memberof OrdersApiGetSignableCancelOrderV3
      */
-    readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
+    readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest$1;
 }
 /**
  * Request parameters for getSignableOrder operation in OrdersApi.
@@ -12632,7 +12090,7 @@ interface TradesApiGetSignableTradeRequest {
      * @type {GetSignableTradeRequest}
      * @memberof TradesApiGetSignableTrade
      */
-    readonly getSignableTradeRequest: GetSignableTradeRequest;
+    readonly getSignableTradeRequest: GetSignableTradeRequest$1;
 }
 /**
  * Request parameters for getTradeV3 operation in TradesApi.
@@ -12735,7 +12193,7 @@ declare class TradesApi$1 extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TradesApi
      */
-    createTradeV3(requestParameters: TradesApiCreateTradeV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse, any>>;
+    createTradeV3(requestParameters: TradesApiCreateTradeV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse$1, any>>;
     /**
      * Generate a signable trade message (V3)
      * @summary Generate a signable trade message (V3)
@@ -13486,6 +12944,27 @@ declare class ImxApiClients {
     constructor(config: ImmutableAPIConfiguration);
 }
 
+declare enum Environment {
+    PRODUCTION = "production",
+    SANDBOX = "sandbox"
+}
+declare class ImmutableConfiguration {
+    readonly environment: Environment;
+    readonly rateLimitingKey?: string;
+    readonly apiKey?: string;
+    readonly publishableKey?: string;
+    constructor(options: {
+        environment: Environment;
+        rateLimitingKey?: string;
+        apiKey?: string;
+        publishableKey?: string;
+    });
+}
+interface ModuleConfiguration<T> {
+    baseConfig: ImmutableConfiguration;
+    overrides?: T;
+}
+
 declare class ApiConfiguration extends Configuration {
 }
 interface EthConfiguration {
@@ -13552,6 +13031,14 @@ interface ERC20Token {
     type: 'ERC20';
     tokenAddress: string;
 }
+/**
+ * An ERC721 token
+ */
+interface ERC721Token {
+    type: 'ERC721';
+    tokenId: string;
+    tokenAddress: string;
+}
 /**
  * An ETH token
  */
@@ -13576,11 +13063,49 @@ interface ERC20Amount extends ERC20Token {
      */
     amount: string;
 }
+/**
+ * Union type that represents all token types
+ */
+type AnyToken = ETHToken | ERC721Token | ERC20Token;
+/**
+ * Union type that represents all token type amounts
+ */
+type TokenAmount = ETHAmount | ERC20Amount | ERC721Token;
 /**
  * Union type that represents exchange token type amounts
  */
 type ExchangeTokenAmount = ETHAmount | ERC20Amount;
 
+/**
+ * Parameter required to create an Order
+ */
+interface UnsignedOrderRequest {
+    /**
+     * The amount of tokens that will be bought for this order
+     */
+    buy: TokenAmount;
+    /**
+     * The amount of tokens that will be sold for this order
+     */
+    sell: TokenAmount;
+    /**
+     * ExpirationTimestamp in Unix time. Note: will be rounded down to the nearest hour
+     */
+    expiration_timestamp?: number;
+    /**
+     * Inclusion of either maker or taker fees
+     */
+    fees?: Array<FeeEntry>;
+}
+/**
+ * Parameter required to create a Transfer
+ */
+type UnsignedTransferRequest = TokenAmount & {
+    /**
+     * Ethereum address of the receiving user
+     */
+    receiver: string;
+};
 /**
  * Parameter required to Mint tokens
  */
@@ -13599,6 +13124,24 @@ type UnsignedExchangeTransferRequest = ExchangeTokenAmount & {
     transactionID: string;
 };
 
+/**
+ * Parameter required to create a batchNftTransfer
+ */
+interface NftTransferDetails {
+    /**
+     * Ethereum address of the receiving user
+     */
+    receiver: string;
+    /**
+     * The token ID
+     */
+    tokenId: string;
+    /**
+     * The token contract address
+     */
+    tokenAddress: string;
+}
+
 /**
  * Need to specifically export the classes and interfaces from the generated
  * clients imx object for rollup to bundle them correctly.
@@ -13679,6 +13222,8 @@ interface CreatePrimarySaleNotFoundBody extends CreatePrimarySaleNotFoundBody$1
 }
 interface CreatePrimarySaleUnauthorizedBody extends CreatePrimarySaleUnauthorizedBody$1 {
 }
+interface CreateTradeResponse extends CreateTradeResponse$1 {
+}
 interface CreateTransferResponseV1 extends CreateTransferResponseV1$1 {
 }
 interface DepositsApiGetDepositRequest extends DepositsApiGetDepositRequest$1 {
@@ -13691,6 +13236,10 @@ interface ExchangesApiGetExchangeRequest extends ExchangesApiGetExchangeRequest$
 }
 interface ExchangesApiGetExchangesRequest extends ExchangesApiGetExchangesRequest$1 {
 }
+interface GetSignableCancelOrderRequest extends GetSignableCancelOrderRequest$1 {
+}
+interface GetSignableTradeRequest extends GetSignableTradeRequest$1 {
+}
 interface MetadataApiGetMetadataSchemaRequest extends MetadataApiGetMetadataSchemaRequest$1 {
 }
 interface MetadataSchemaRequest extends MetadataSchemaRequest$1 {
@@ -14128,6 +13677,97 @@ declare class IMXClient {
     rejectPrimarySale(ethSigner: Signer, primarySaleId: number): Promise<RejectPrimarySaleBadRequestBody | RejectPrimarySaleForbiddenBody | RejectPrimarySaleNotFoundBody | RejectPrimarySaleOKBody | RejectPrimarySaleUnauthorizedBody>;
 }
 
+interface IMXProvider {
+    /**
+     * Get the Signer address
+     *
+     * @return {Promise<string>} Returns a promise that resolves with the signer's address
+     */
+    getAddress(): Promise<string>;
+    /**
+     * Register a User to Immutable X if they are not already registered
+     *
+     * @return {Promise<imx.RegisterUserResponse>} Returns a promise that resolves with the user registration response
+     */
+    registerOffchain(): Promise<RegisterUserResponse>;
+    /**
+     *  Checks if a User is registered off-chain
+     *
+     *  @return {Promise<boolean>} Returns a promise that resolves with true if the User is registered with IMX, false otherwise
+     */
+    isRegisteredOffchain(): Promise<boolean>;
+    /**
+     * Checks if a User is registered on-chain
+     *
+     * @return {Promise<boolean>} Returns a promise that resolves with true if the User is registered, false otherwise
+     */
+    isRegisteredOnchain(): Promise<boolean>;
+    /**
+     * Create an Order
+     *
+     * @param {UnsignedOrderRequest} request The unsigned order request to create an order
+     * @return {Promise<CreateOrderResponse>} Returns a promise that resolves with the created Order
+     */
+    createOrder(request: UnsignedOrderRequest): Promise<CreateOrderResponse>;
+    /**
+     * Cancel an Order
+     *
+     * @param {GetSignableCancelOrderRequest} request The signable cancel order request
+     * @return {Promise<CancelOrderResponse>} Returns a promise that resolves with the cancelled Order
+     */
+    cancelOrder(request: GetSignableCancelOrderRequest): Promise<CancelOrderResponse>;
+    /**
+     * Create a Trade
+     *
+     * @param {GetSignableTradeRequest} request The signable trade request
+     * @return {Promise<CreateTradeResponse>} Returns a promise that resolves with the created Trade
+     */
+    createTrade(request: GetSignableTradeRequest): Promise<CreateTradeResponse>;
+    /**
+     * Create a new Transfer request
+     *
+     * @param {UnsignedTransferRequest} request The unsigned transfer request
+     * @return {Promise<imx.CreateTransferResponseV1>} Returns a promise that resolves with the created Transfer
+     */
+    transfer(request: UnsignedTransferRequest): Promise<CreateTransferResponseV1$1>;
+    /**
+     * Create a batch of NFT transfer requests
+     *
+     * @param {Array<NftTransferDetails>} request An array of NFT transfer details
+     * @return {Promise<CreateTransferResponse>} Resolves a promise that resolves with the list of Transfer IDs
+     */
+    batchNftTransfer(request: Array<NftTransferDetails>): Promise<CreateTransferResponse>;
+    /**
+     * Create a new Exchange transaction
+     *
+     * @param {UnsignedExchangeTransferRequest} request The unsigned exchange transfer request
+     * @return {Promise<imx.CreateTransferResponseV1>} Returns a promise that resolves with the created Exchange Transaction
+     */
+    exchangeTransfer(request: UnsignedExchangeTransferRequest): Promise<CreateTransferResponseV1$1>;
+    /**
+     * Deposit either ETH, ERC20 or ERC721 tokens
+     *
+     * @param {TokenAmount} request The token type amount in its corresponding unit
+     * @return {Promise<TransactionResponse>} Returns a promise that resolves with the transaction
+     */
+    deposit(deposit: TokenAmount): Promise<TransactionResponse>;
+    /**
+     * Create a Withdrawal
+     *
+     * @param {TokenAmount} request The token type amount in its corresponding unit
+     * @return {Promise<CreateWithdrawalResponse>} Returns a promise that resolves with the created Withdrawal
+     */
+    prepareWithdrawal(request: TokenAmount): Promise<CreateWithdrawalResponse>;
+    /**
+     * Completes a Withdrawal
+     *
+     * @param {string} starkPublicKey The stark public key
+     * @param {AnyToken} token The token to withdraw
+     * @return {Promise<TransactionResponse>} Returns a promise that resolves with the transaction
+     */
+    completeWithdrawal(starkPublicKey: string, token: AnyToken): Promise<TransactionResponse>;
+}
+
 type UserProfile = {
     email?: string;
     nickname?: string;