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

package/dist/passport.d.ts

@@ -20,814 +20,6 @@ declare class PassportError extends Error {
     constructor(message: string, type: PassportErrorType);
 }
 
-declare type Bytes = ArrayLike<number>;
-declare type BytesLike = Bytes | string;
-interface Hexable {
-    toHexString(): string;
-}
-
-declare type BigNumberish = BigNumber | Bytes | bigint | string | number;
-declare class BigNumber implements Hexable {
-    readonly _hex: string;
-    readonly _isBigNumber: boolean;
-    constructor(constructorGuard: any, hex: string);
-    fromTwos(value: number): BigNumber;
-    toTwos(value: number): BigNumber;
-    abs(): BigNumber;
-    add(other: BigNumberish): BigNumber;
-    sub(other: BigNumberish): BigNumber;
-    div(other: BigNumberish): BigNumber;
-    mul(other: BigNumberish): BigNumber;
-    mod(other: BigNumberish): BigNumber;
-    pow(other: BigNumberish): BigNumber;
-    and(other: BigNumberish): BigNumber;
-    or(other: BigNumberish): BigNumber;
-    xor(other: BigNumberish): BigNumber;
-    mask(value: number): BigNumber;
-    shl(value: number): BigNumber;
-    shr(value: number): BigNumber;
-    eq(other: BigNumberish): boolean;
-    lt(other: BigNumberish): boolean;
-    lte(other: BigNumberish): boolean;
-    gt(other: BigNumberish): boolean;
-    gte(other: BigNumberish): boolean;
-    isNegative(): boolean;
-    isZero(): boolean;
-    toNumber(): number;
-    toBigInt(): bigint;
-    toString(): string;
-    toHexString(): string;
-    toJSON(key?: string): any;
-    static from(value: any): BigNumber;
-    static isBigNumber(value: any): value is BigNumber;
-}
-
-declare type Deferrable<T> = {
-    [K in keyof T]: T[K] | Promise<T[K]>;
-};
-declare class Description<T = any> {
-    constructor(info: {
-        [K in keyof T]: T[K];
-    });
-}
-
-declare type Network = {
-    name: string;
-    chainId: number;
-    ensAddress?: string;
-    _defaultProvider?: (providers: any, options?: any) => any;
-};
-
-declare type AccessList = Array<{
-    address: string;
-    storageKeys: Array<string>;
-}>;
-declare type AccessListish = AccessList | Array<[string, Array<string>]> | Record<string, Array<string>>;
-interface Transaction {
-    hash?: string;
-    to?: string;
-    from?: string;
-    nonce: number;
-    gasLimit: BigNumber;
-    gasPrice?: BigNumber;
-    data: string;
-    value: BigNumber;
-    chainId: number;
-    r?: string;
-    s?: string;
-    v?: number;
-    type?: number | null;
-    accessList?: AccessList;
-    maxPriorityFeePerGas?: BigNumber;
-    maxFeePerGas?: BigNumber;
-}
-
-interface OnceBlockable {
-    once(eventName: "block", handler: () => void): void;
-}
-
-declare type TransactionRequest = {
-    to?: string;
-    from?: string;
-    nonce?: BigNumberish;
-    gasLimit?: BigNumberish;
-    gasPrice?: BigNumberish;
-    data?: BytesLike;
-    value?: BigNumberish;
-    chainId?: number;
-    type?: number;
-    accessList?: AccessListish;
-    maxPriorityFeePerGas?: BigNumberish;
-    maxFeePerGas?: BigNumberish;
-    customData?: Record<string, any>;
-    ccipReadEnabled?: boolean;
-};
-interface TransactionResponse extends Transaction {
-    hash: string;
-    blockNumber?: number;
-    blockHash?: string;
-    timestamp?: number;
-    confirmations: number;
-    from: string;
-    raw?: string;
-    wait: (confirmations?: number) => Promise<TransactionReceipt>;
-}
-declare type BlockTag = string | number;
-interface _Block {
-    hash: string;
-    parentHash: string;
-    number: number;
-    timestamp: number;
-    nonce: string;
-    difficulty: number;
-    _difficulty: BigNumber;
-    gasLimit: BigNumber;
-    gasUsed: BigNumber;
-    miner: string;
-    extraData: string;
-    baseFeePerGas?: null | BigNumber;
-}
-interface Block extends _Block {
-    transactions: Array<string>;
-}
-interface BlockWithTransactions extends _Block {
-    transactions: Array<TransactionResponse>;
-}
-interface Log {
-    blockNumber: number;
-    blockHash: string;
-    transactionIndex: number;
-    removed: boolean;
-    address: string;
-    data: string;
-    topics: Array<string>;
-    transactionHash: string;
-    logIndex: number;
-}
-interface TransactionReceipt {
-    to: string;
-    from: string;
-    contractAddress: string;
-    transactionIndex: number;
-    root?: string;
-    gasUsed: BigNumber;
-    logsBloom: string;
-    blockHash: string;
-    transactionHash: string;
-    logs: Array<Log>;
-    blockNumber: number;
-    confirmations: number;
-    cumulativeGasUsed: BigNumber;
-    effectiveGasPrice: BigNumber;
-    byzantium: boolean;
-    type: number;
-    status?: number;
-}
-interface FeeData$1 {
-    lastBaseFeePerGas: null | BigNumber;
-    maxFeePerGas: null | BigNumber;
-    maxPriorityFeePerGas: null | BigNumber;
-    gasPrice: null | BigNumber;
-}
-interface EventFilter {
-    address?: string;
-    topics?: Array<string | Array<string> | null>;
-}
-interface Filter extends EventFilter {
-    fromBlock?: BlockTag;
-    toBlock?: BlockTag;
-}
-declare abstract class ForkEvent extends Description {
-    readonly expiry: number;
-    readonly _isForkEvent?: boolean;
-    static isForkEvent(value: any): value is ForkEvent;
-}
-declare type EventType = string | Array<string | Array<string>> | EventFilter | ForkEvent;
-declare type Listener = (...args: Array<any>) => void;
-declare abstract class Provider$1 implements OnceBlockable {
-    abstract getNetwork(): Promise<Network>;
-    abstract getBlockNumber(): Promise<number>;
-    abstract getGasPrice(): Promise<BigNumber>;
-    getFeeData(): Promise<FeeData$1>;
-    abstract getBalance(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<BigNumber>;
-    abstract getTransactionCount(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<number>;
-    abstract getCode(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<string>;
-    abstract getStorageAt(addressOrName: string | Promise<string>, position: BigNumberish | Promise<BigNumberish>, blockTag?: BlockTag | Promise<BlockTag>): Promise<string>;
-    abstract sendTransaction(signedTransaction: string | Promise<string>): Promise<TransactionResponse>;
-    abstract call(transaction: Deferrable<TransactionRequest>, blockTag?: BlockTag | Promise<BlockTag>): Promise<string>;
-    abstract estimateGas(transaction: Deferrable<TransactionRequest>): Promise<BigNumber>;
-    abstract getBlock(blockHashOrBlockTag: BlockTag | string | Promise<BlockTag | string>): Promise<Block>;
-    abstract getBlockWithTransactions(blockHashOrBlockTag: BlockTag | string | Promise<BlockTag | string>): Promise<BlockWithTransactions>;
-    abstract getTransaction(transactionHash: string): Promise<TransactionResponse>;
-    abstract getTransactionReceipt(transactionHash: string): Promise<TransactionReceipt>;
-    abstract getLogs(filter: Filter): Promise<Array<Log>>;
-    abstract resolveName(name: string | Promise<string>): Promise<null | string>;
-    abstract lookupAddress(address: string | Promise<string>): Promise<null | string>;
-    abstract on(eventName: EventType, listener: Listener): Provider$1;
-    abstract once(eventName: EventType, listener: Listener): Provider$1;
-    abstract emit(eventName: EventType, ...args: Array<any>): boolean;
-    abstract listenerCount(eventName?: EventType): number;
-    abstract listeners(eventName?: EventType): Array<Listener>;
-    abstract off(eventName: EventType, listener?: Listener): Provider$1;
-    abstract removeAllListeners(eventName?: EventType): Provider$1;
-    addListener(eventName: EventType, listener: Listener): Provider$1;
-    removeListener(eventName: EventType, listener: Listener): Provider$1;
-    abstract waitForTransaction(transactionHash: string, confirmations?: number, timeout?: number): Promise<TransactionReceipt>;
-    readonly _isProvider: boolean;
-    constructor();
-    static isProvider(value: any): value is Provider$1;
-}
-
-declare abstract class Signer {
-    readonly provider?: Provider$1;
-    abstract getAddress(): Promise<string>;
-    abstract signMessage(message: Bytes | string): Promise<string>;
-    abstract signTransaction(transaction: Deferrable<TransactionRequest>): Promise<string>;
-    abstract connect(provider: Provider$1): Signer;
-    readonly _isSigner: boolean;
-    constructor();
-    getBalance(blockTag?: BlockTag): Promise<BigNumber>;
-    getTransactionCount(blockTag?: BlockTag): Promise<number>;
-    estimateGas(transaction: Deferrable<TransactionRequest>): Promise<BigNumber>;
-    call(transaction: Deferrable<TransactionRequest>, blockTag?: BlockTag): Promise<string>;
-    sendTransaction(transaction: Deferrable<TransactionRequest>): Promise<TransactionResponse>;
-    getChainId(): Promise<number>;
-    getGasPrice(): Promise<BigNumber>;
-    getFeeData(): Promise<FeeData$1>;
-    resolveName(name: string): Promise<string>;
-    checkTransaction(transaction: Deferrable<TransactionRequest>): Deferrable<TransactionRequest>;
-    populateTransaction(transaction: Deferrable<TransactionRequest>): Promise<TransactionRequest>;
-    _checkProvider(operation?: string): void;
-    static isSigner(value: any): value is Signer;
-}
-
-/**
- * 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;
 
@@ -2213,7 +1405,7 @@ interface Token {
  * @export
  * @interface FeeData
  */
-interface FeeData {
+interface FeeData$1 {
     /**
      * Address of ERC721/ERC20 contract
      * @type {string}
@@ -2245,7 +1437,7 @@ interface FeeData {
  * Fee token data details
  * @export
  */
-type FeeTokenData = FeeData;
+type FeeTokenData = FeeData$1;
 
 /**
  * Immutable X API
@@ -4329,7 +3521,7 @@ interface FeeInfo {
  * @export
  * @interface CreateTradeResponse
  */
-interface CreateTradeResponse {
+interface CreateTradeResponse$1 {
     /**
      * Request ID as a reference for an asynchronous trade creation request
      * @type {string}
@@ -4522,6 +3714,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
@@ -5826,7 +5043,7 @@ interface Project {
  * @export
  * @interface GetSignableCancelOrderRequest
  */
-interface GetSignableCancelOrderRequest {
+interface GetSignableCancelOrderRequest$1 {
     /**
      * ID of the order to be cancelled
      * @type {number}
@@ -6384,7 +5601,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}
@@ -11757,7 +10974,7 @@ interface OrdersApiGetSignableCancelOrderV3Request {
      * @type {GetSignableCancelOrderRequest}
      * @memberof OrdersApiGetSignableCancelOrderV3
      */
-    readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
+    readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest$1;
 }
 /**
  * Request parameters for getSignableOrder operation in OrdersApi.
@@ -12347,7 +11564,7 @@ interface TradesApiGetSignableTradeRequest {
      * @type {GetSignableTradeRequest}
      * @memberof TradesApiGetSignableTrade
      */
-    readonly getSignableTradeRequest: GetSignableTradeRequest;
+    readonly getSignableTradeRequest: GetSignableTradeRequest$1;
 }
 /**
  * Request parameters for getTradeV3 operation in TradesApi.
@@ -12450,7 +11667,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)
@@ -13200,33 +12417,295 @@ declare class ImxApiClients {
     withdrawalsApi: WithdrawalsApi$1;
     constructor(config: ImmutableAPIConfiguration);
 }
-
-declare class ApiConfiguration extends Configuration {
+
+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 {
+    coreContractAddress: string;
+    registrationContractAddress: string;
+    chainID: number;
+}
+interface ImmutableXConfiguration {
+    /**
+     * The configuration for the API client
+     */
+    apiConfiguration: ApiConfiguration;
+    /**
+     * The configuration for the Ethereum network
+     */
+    ethConfiguration: EthConfiguration;
+}
+interface ImxOverrides {
+    immutableXConfig: ImmutableXConfiguration;
+}
+interface ImxModuleConfiguration extends ModuleConfiguration<ImxOverrides> {
+}
+declare class ImxConfiguration {
+    readonly immutableXConfig: ImmutableXConfiguration;
+    readonly baseConfig: ImmutableConfiguration;
+    constructor({ baseConfig, overrides }: ImxModuleConfiguration);
+}
+
+declare type Bytes = ArrayLike<number>;
+declare type BytesLike = Bytes | string;
+interface Hexable {
+    toHexString(): string;
+}
+
+declare type BigNumberish = BigNumber | Bytes | bigint | string | number;
+declare class BigNumber implements Hexable {
+    readonly _hex: string;
+    readonly _isBigNumber: boolean;
+    constructor(constructorGuard: any, hex: string);
+    fromTwos(value: number): BigNumber;
+    toTwos(value: number): BigNumber;
+    abs(): BigNumber;
+    add(other: BigNumberish): BigNumber;
+    sub(other: BigNumberish): BigNumber;
+    div(other: BigNumberish): BigNumber;
+    mul(other: BigNumberish): BigNumber;
+    mod(other: BigNumberish): BigNumber;
+    pow(other: BigNumberish): BigNumber;
+    and(other: BigNumberish): BigNumber;
+    or(other: BigNumberish): BigNumber;
+    xor(other: BigNumberish): BigNumber;
+    mask(value: number): BigNumber;
+    shl(value: number): BigNumber;
+    shr(value: number): BigNumber;
+    eq(other: BigNumberish): boolean;
+    lt(other: BigNumberish): boolean;
+    lte(other: BigNumberish): boolean;
+    gt(other: BigNumberish): boolean;
+    gte(other: BigNumberish): boolean;
+    isNegative(): boolean;
+    isZero(): boolean;
+    toNumber(): number;
+    toBigInt(): bigint;
+    toString(): string;
+    toHexString(): string;
+    toJSON(key?: string): any;
+    static from(value: any): BigNumber;
+    static isBigNumber(value: any): value is BigNumber;
+}
+
+declare type Network = {
+    name: string;
+    chainId: number;
+    ensAddress?: string;
+    _defaultProvider?: (providers: any, options?: any) => any;
+};
+
+declare type Deferrable<T> = {
+    [K in keyof T]: T[K] | Promise<T[K]>;
+};
+declare class Description<T = any> {
+    constructor(info: {
+        [K in keyof T]: T[K];
+    });
+}
+
+declare type AccessList = Array<{
+    address: string;
+    storageKeys: Array<string>;
+}>;
+declare type AccessListish = AccessList | Array<[string, Array<string>]> | Record<string, Array<string>>;
+interface Transaction {
+    hash?: string;
+    to?: string;
+    from?: string;
+    nonce: number;
+    gasLimit: BigNumber;
+    gasPrice?: BigNumber;
+    data: string;
+    value: BigNumber;
+    chainId: number;
+    r?: string;
+    s?: string;
+    v?: number;
+    type?: number | null;
+    accessList?: AccessList;
+    maxPriorityFeePerGas?: BigNumber;
+    maxFeePerGas?: BigNumber;
+}
+
+interface OnceBlockable {
+    once(eventName: "block", handler: () => void): void;
+}
+
+declare type TransactionRequest = {
+    to?: string;
+    from?: string;
+    nonce?: BigNumberish;
+    gasLimit?: BigNumberish;
+    gasPrice?: BigNumberish;
+    data?: BytesLike;
+    value?: BigNumberish;
+    chainId?: number;
+    type?: number;
+    accessList?: AccessListish;
+    maxPriorityFeePerGas?: BigNumberish;
+    maxFeePerGas?: BigNumberish;
+    customData?: Record<string, any>;
+    ccipReadEnabled?: boolean;
+};
+interface TransactionResponse extends Transaction {
+    hash: string;
+    blockNumber?: number;
+    blockHash?: string;
+    timestamp?: number;
+    confirmations: number;
+    from: string;
+    raw?: string;
+    wait: (confirmations?: number) => Promise<TransactionReceipt>;
+}
+declare type BlockTag = string | number;
+interface _Block {
+    hash: string;
+    parentHash: string;
+    number: number;
+    timestamp: number;
+    nonce: string;
+    difficulty: number;
+    _difficulty: BigNumber;
+    gasLimit: BigNumber;
+    gasUsed: BigNumber;
+    miner: string;
+    extraData: string;
+    baseFeePerGas?: null | BigNumber;
+}
+interface Block extends _Block {
+    transactions: Array<string>;
+}
+interface BlockWithTransactions extends _Block {
+    transactions: Array<TransactionResponse>;
+}
+interface Log {
+    blockNumber: number;
+    blockHash: string;
+    transactionIndex: number;
+    removed: boolean;
+    address: string;
+    data: string;
+    topics: Array<string>;
+    transactionHash: string;
+    logIndex: number;
+}
+interface TransactionReceipt {
+    to: string;
+    from: string;
+    contractAddress: string;
+    transactionIndex: number;
+    root?: string;
+    gasUsed: BigNumber;
+    logsBloom: string;
+    blockHash: string;
+    transactionHash: string;
+    logs: Array<Log>;
+    blockNumber: number;
+    confirmations: number;
+    cumulativeGasUsed: BigNumber;
+    effectiveGasPrice: BigNumber;
+    byzantium: boolean;
+    type: number;
+    status?: number;
 }
-interface EthConfiguration {
-    coreContractAddress: string;
-    registrationContractAddress: string;
-    chainID: number;
+interface FeeData {
+    lastBaseFeePerGas: null | BigNumber;
+    maxFeePerGas: null | BigNumber;
+    maxPriorityFeePerGas: null | BigNumber;
+    gasPrice: null | BigNumber;
 }
-interface ImmutableXConfiguration {
-    /**
-     * The configuration for the API client
-     */
-    apiConfiguration: ApiConfiguration;
-    /**
-     * The configuration for the Ethereum network
-     */
-    ethConfiguration: EthConfiguration;
+interface EventFilter {
+    address?: string;
+    topics?: Array<string | Array<string> | null>;
 }
-interface ImxOverrides {
-    immutableXConfig: ImmutableXConfiguration;
+interface Filter extends EventFilter {
+    fromBlock?: BlockTag;
+    toBlock?: BlockTag;
 }
-interface ImxModuleConfiguration extends ModuleConfiguration<ImxOverrides> {
+declare abstract class ForkEvent extends Description {
+    readonly expiry: number;
+    readonly _isForkEvent?: boolean;
+    static isForkEvent(value: any): value is ForkEvent;
 }
-declare class ImxConfiguration {
-    readonly immutableXConfig: ImmutableXConfiguration;
-    readonly baseConfig: ImmutableConfiguration;
-    constructor({ baseConfig, overrides }: ImxModuleConfiguration);
+declare type EventType = string | Array<string | Array<string>> | EventFilter | ForkEvent;
+declare type Listener = (...args: Array<any>) => void;
+declare abstract class Provider$1 implements OnceBlockable {
+    abstract getNetwork(): Promise<Network>;
+    abstract getBlockNumber(): Promise<number>;
+    abstract getGasPrice(): Promise<BigNumber>;
+    getFeeData(): Promise<FeeData>;
+    abstract getBalance(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<BigNumber>;
+    abstract getTransactionCount(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<number>;
+    abstract getCode(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<string>;
+    abstract getStorageAt(addressOrName: string | Promise<string>, position: BigNumberish | Promise<BigNumberish>, blockTag?: BlockTag | Promise<BlockTag>): Promise<string>;
+    abstract sendTransaction(signedTransaction: string | Promise<string>): Promise<TransactionResponse>;
+    abstract call(transaction: Deferrable<TransactionRequest>, blockTag?: BlockTag | Promise<BlockTag>): Promise<string>;
+    abstract estimateGas(transaction: Deferrable<TransactionRequest>): Promise<BigNumber>;
+    abstract getBlock(blockHashOrBlockTag: BlockTag | string | Promise<BlockTag | string>): Promise<Block>;
+    abstract getBlockWithTransactions(blockHashOrBlockTag: BlockTag | string | Promise<BlockTag | string>): Promise<BlockWithTransactions>;
+    abstract getTransaction(transactionHash: string): Promise<TransactionResponse>;
+    abstract getTransactionReceipt(transactionHash: string): Promise<TransactionReceipt>;
+    abstract getLogs(filter: Filter): Promise<Array<Log>>;
+    abstract resolveName(name: string | Promise<string>): Promise<null | string>;
+    abstract lookupAddress(address: string | Promise<string>): Promise<null | string>;
+    abstract on(eventName: EventType, listener: Listener): Provider$1;
+    abstract once(eventName: EventType, listener: Listener): Provider$1;
+    abstract emit(eventName: EventType, ...args: Array<any>): boolean;
+    abstract listenerCount(eventName?: EventType): number;
+    abstract listeners(eventName?: EventType): Array<Listener>;
+    abstract off(eventName: EventType, listener?: Listener): Provider$1;
+    abstract removeAllListeners(eventName?: EventType): Provider$1;
+    addListener(eventName: EventType, listener: Listener): Provider$1;
+    removeListener(eventName: EventType, listener: Listener): Provider$1;
+    abstract waitForTransaction(transactionHash: string, confirmations?: number, timeout?: number): Promise<TransactionReceipt>;
+    readonly _isProvider: boolean;
+    constructor();
+    static isProvider(value: any): value is Provider$1;
+}
+
+declare abstract class Signer {
+    readonly provider?: Provider$1;
+    abstract getAddress(): Promise<string>;
+    abstract signMessage(message: Bytes | string): Promise<string>;
+    abstract signTransaction(transaction: Deferrable<TransactionRequest>): Promise<string>;
+    abstract connect(provider: Provider$1): Signer;
+    readonly _isSigner: boolean;
+    constructor();
+    getBalance(blockTag?: BlockTag): Promise<BigNumber>;
+    getTransactionCount(blockTag?: BlockTag): Promise<number>;
+    estimateGas(transaction: Deferrable<TransactionRequest>): Promise<BigNumber>;
+    call(transaction: Deferrable<TransactionRequest>, blockTag?: BlockTag): Promise<string>;
+    sendTransaction(transaction: Deferrable<TransactionRequest>): Promise<TransactionResponse>;
+    getChainId(): Promise<number>;
+    getGasPrice(): Promise<BigNumber>;
+    getFeeData(): Promise<FeeData>;
+    resolveName(name: string): Promise<string>;
+    checkTransaction(transaction: Deferrable<TransactionRequest>): Deferrable<TransactionRequest>;
+    populateTransaction(transaction: Deferrable<TransactionRequest>): Promise<TransactionRequest>;
+    _checkProvider(operation?: string): void;
+    static isSigner(value: any): value is Signer;
 }
 
 /**
@@ -13267,6 +12746,14 @@ interface ERC20Token {
     type: 'ERC20';
     tokenAddress: string;
 }
+/**
+ * An ERC721 token
+ */
+interface ERC721Token {
+    type: 'ERC721';
+    tokenId: string;
+    tokenAddress: string;
+}
 /**
  * An ETH token
  */
@@ -13291,11 +12778,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
  */
@@ -13314,6 +12839,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.
@@ -13394,6 +12937,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 {
@@ -13406,6 +12951,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 {
@@ -13843,6 +13392,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;