ccxt 4.4.82 → 4.4.85

package/js/src/idex.d.ts

@@ -1,312 +0,0 @@
-import Exchange from './abstract/idex.js';
-import type { Balances, Currencies, Currency, Dict, Int, Market, Num, OHLCV, Order, OrderBook, OrderSide, OrderType, Str, Strings, Ticker, Tickers, Trade, TradingFees, Transaction, int, DepositAddress } from './base/types.js';
-/**
- * @class idex
- * @augments Exchange
- */
-export default class idex extends Exchange {
-    describe(): any;
-    priceToPrecision(symbol: any, price: any): string;
-    /**
-     * @method
-     * @name idex#fetchMarkets
-     * @description retrieves data on all markets for idex
-     * @see https://api-docs-v3.idex.io/#get-markets
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {object[]} an array of objects representing market data
-     */
-    fetchMarkets(params?: {}): Promise<Market[]>;
-    /**
-     * @method
-     * @name idex#fetchTicker
-     * @description fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
-     * @see https://api-docs-v3.idex.io/#get-tickers
-     * @param {string} symbol unified symbol of the market to fetch the ticker for
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
-     */
-    fetchTicker(symbol: string, params?: {}): Promise<Ticker>;
-    /**
-     * @method
-     * @name idex#fetchTickers
-     * @description fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
-     * @see https://api-docs-v3.idex.io/#get-tickers
-     * @param {string[]|undefined} symbols unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {object} a dictionary of [ticker structures]{@link https://docs.ccxt.com/#/?id=ticker-structure}
-     */
-    fetchTickers(symbols?: Strings, params?: {}): Promise<Tickers>;
-    parseTicker(ticker: Dict, market?: Market): Ticker;
-    /**
-     * @method
-     * @name idex#fetchOHLCV
-     * @description fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
-     * @see https://api-docs-v3.idex.io/#get-candles
-     * @param {string} symbol unified symbol of the market to fetch OHLCV data for
-     * @param {string} timeframe the length of time each candle represents
-     * @param {int} [since] timestamp in ms of the earliest candle to fetch
-     * @param {int} [limit] the maximum amount of candles to fetch
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {int[][]} A list of candles ordered as timestamp, open, high, low, close, volume
-     */
-    fetchOHLCV(symbol: string, timeframe?: string, since?: Int, limit?: Int, params?: {}): Promise<OHLCV[]>;
-    parseOHLCV(ohlcv: any, market?: Market): OHLCV;
-    /**
-     * @method
-     * @name idex#fetchTrades
-     * @description get the list of most recent trades for a particular symbol
-     * @see https://api-docs-v3.idex.io/#get-trades
-     * @param {string} symbol unified symbol of the market to fetch trades for
-     * @param {int} [since] timestamp in ms of the earliest trade to fetch
-     * @param {int} [limit] the maximum amount of trades to fetch
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
-     */
-    fetchTrades(symbol: string, since?: Int, limit?: Int, params?: {}): Promise<Trade[]>;
-    parseTrade(trade: Dict, market?: Market): Trade;
-    /**
-     * @method
-     * @name idex#fetchTradingFees
-     * @description fetch the trading fees for multiple markets
-     * @see https://api-docs-v3.idex.io/#get-api-account
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {object} a dictionary of [fee structures]{@link https://docs.ccxt.com/#/?id=fee-structure} indexed by market symbols
-     */
-    fetchTradingFees(params?: {}): Promise<TradingFees>;
-    /**
-     * @method
-     * @name idex#fetchOrderBook
-     * @description fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
-     * @see https://api-docs-v3.idex.io/#get-order-books
-     * @param {string} symbol unified symbol of the market to fetch the order book for
-     * @param {int} [limit] the maximum amount of order book entries to return
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
-     */
-    fetchOrderBook(symbol: string, limit?: Int, params?: {}): Promise<OrderBook>;
-    parseSide(book: any, side: any): any[];
-    /**
-     * @method
-     * @name idex#fetchCurrencies
-     * @description fetches all available currencies on an exchange
-     * @see https://api-docs-v3.idex.io/#get-assets
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {object} an associative dictionary of currencies
-     */
-    fetchCurrencies(params?: {}): Promise<Currencies>;
-    parseBalance(response: any): Balances;
-    /**
-     * @method
-     * @name idex#fetchBalance
-     * @description query for balance and get the amount of funds available for trading or funds locked in orders
-     * @see https://api-docs-v3.idex.io/#get-balances
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {object} a [balance structure]{@link https://docs.ccxt.com/#/?id=balance-structure}
-     */
-    fetchBalance(params?: {}): Promise<Balances>;
-    /**
-     * @method
-     * @name idex#fetchMyTrades
-     * @description fetch all trades made by the user
-     * @see https://api-docs-v3.idex.io/#get-fills
-     * @param {string} symbol unified market symbol
-     * @param {int} [since] the earliest time in ms to fetch trades for
-     * @param {int} [limit] the maximum number of trades structures to retrieve
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure}
-     */
-    fetchMyTrades(symbol?: Str, since?: Int, limit?: Int, params?: {}): Promise<Trade[]>;
-    /**
-     * @method
-     * @name idex#fetchOrder
-     * @description fetches information on an order made by the user
-     * @see https://api-docs-v3.idex.io/#get-orders
-     * @param {string} id order id
-     * @param {string} symbol unified symbol of the market the order was made in
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
-     */
-    fetchOrder(id: string, symbol?: Str, params?: {}): Promise<Order>;
-    /**
-     * @method
-     * @name idex#fetchOpenOrders
-     * @description fetch all unfilled currently open orders
-     * @see https://api-docs-v3.idex.io/#get-orders
-     * @param {string} symbol unified market symbol
-     * @param {int} [since] the earliest time in ms to fetch open orders for
-     * @param {int} [limit] the maximum number of  open orders structures to retrieve
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
-     */
-    fetchOpenOrders(symbol?: Str, since?: Int, limit?: Int, params?: {}): Promise<Order[]>;
-    /**
-     * @method
-     * @name idex#fetchClosedOrders
-     * @description fetches information on multiple closed orders made by the user
-     * @see https://api-docs-v3.idex.io/#get-orders
-     * @param {string} symbol unified market symbol of the market orders were made in
-     * @param {int} [since] the earliest time in ms to fetch orders for
-     * @param {int} [limit] the maximum number of order structures to retrieve
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
-     */
-    fetchClosedOrders(symbol?: Str, since?: Int, limit?: Int, params?: {}): Promise<Order[]>;
-    fetchOrdersHelper(symbol?: Str, since?: Int, limit?: Int, params?: {}): Promise<any>;
-    parseOrderStatus(status: Str): string;
-    parseOrder(order: Dict, market?: Market): Order;
-    associateWallet(walletAddress: any, params?: {}): Promise<any>;
-    /**
-     * @method
-     * @name idex#createOrder
-     * @description create a trade order, https://docs.idex.io/#create-order
-     * @see https://api-docs-v3.idex.io/#create-order
-     * @param {string} symbol unified symbol of the market to create an order in
-     * @param {string} type 'market' or 'limit'
-     * @param {string} side 'buy' or 'sell'
-     * @param {float} amount how much of currency you want to trade in units of base currency
-     * @param {float} [price] the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @param {bool} [params.test] set to true to test an order, no order will be created but the request will be validated
-     * @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
-     */
-    createOrder(symbol: string, type: OrderType, side: OrderSide, amount: number, price?: Num, params?: {}): Promise<Order>;
-    /**
-     * @method
-     * @name idex#withdraw
-     * @description make a withdrawal
-     * @see https://api-docs-v3.idex.io/#withdraw-funds
-     * @param {string} code unified currency code
-     * @param {float} amount the amount to withdraw
-     * @param {string} address the address to withdraw to
-     * @param {string} tag
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {object} a [transaction structure]{@link https://docs.ccxt.com/#/?id=transaction-structure}
-     */
-    withdraw(code: string, amount: number, address: string, tag?: any, params?: {}): Promise<Transaction>;
-    /**
-     * @method
-     * @name idex#cancelAllOrders
-     * @description cancel all open orders
-     * @see https://api-docs-v3.idex.io/#cancel-order
-     * @param {string} symbol unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {object[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
-     */
-    cancelAllOrders(symbol?: Str, params?: {}): Promise<Order[]>;
-    /**
-     * @method
-     * @name idex#cancelOrder
-     * @description cancels an open order
-     * @see https://api-docs-v3.idex.io/#cancel-order
-     * @param {string} id order id
-     * @param {string} symbol unified symbol of the market the order was made in
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
-     */
-    cancelOrder(id: string, symbol?: Str, params?: {}): Promise<Order>;
-    handleErrors(code: int, reason: string, url: string, method: string, headers: Dict, body: string, response: any, requestHeaders: any, requestBody: any): any;
-    /**
-     * @method
-     * @name idex#fetchDeposit
-     * @description fetch information on a deposit
-     * @see https://api-docs-v3.idex.io/#get-deposits
-     * @param {string} id deposit id
-     * @param {string} code not used by idex fetchDeposit ()
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {object} a [transaction structure]{@link https://docs.ccxt.com/#/?id=transaction-structure}
-     */
-    fetchDeposit(id: string, code?: Str, params?: {}): Promise<Transaction>;
-    /**
-     * @method
-     * @name idex#fetchDeposits
-     * @description fetch all deposits made to an account
-     * @see https://api-docs-v3.idex.io/#get-deposits
-     * @param {string} code unified currency code
-     * @param {int} [since] the earliest time in ms to fetch deposits for
-     * @param {int} [limit] the maximum number of deposits structures to retrieve
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
-     */
-    fetchDeposits(code?: Str, since?: Int, limit?: Int, params?: {}): Promise<Transaction[]>;
-    /**
-     * @method
-     * @name idex#fetchStatus
-     * @description the latest known information on the availability of the exchange API
-     * @see https://api-docs-v3.idex.io/#get-ping
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {object} a [status structure]{@link https://docs.ccxt.com/#/?id=exchange-status-structure}
-     */
-    fetchStatus(params?: {}): Promise<{
-        status: string;
-        updated: any;
-        eta: any;
-        url: any;
-        info: any;
-    }>;
-    /**
-     * @method
-     * @name idex#fetchTime
-     * @description fetches the current integer timestamp in milliseconds from the exchange server
-     * @see https://api-docs-v3.idex.io/#get-time
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {int} the current integer timestamp in milliseconds from the exchange server
-     */
-    fetchTime(params?: {}): Promise<Int>;
-    /**
-     * @method
-     * @name idex#fetchWithdrawal
-     * @description fetch data on a currency withdrawal via the withdrawal id
-     * @see https://api-docs-v3.idex.io/#get-withdrawals
-     * @param {string} id withdrawal id
-     * @param {string} code not used by idex.fetchWithdrawal
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {object} a [transaction structure]{@link https://docs.ccxt.com/#/?id=transaction-structure}
-     */
-    fetchWithdrawal(id: string, code?: Str, params?: {}): Promise<Transaction>;
-    /**
-     * @method
-     * @name idex#fetchWithdrawals
-     * @description fetch all withdrawals made from an account
-     * @see https://api-docs-v3.idex.io/#get-withdrawals
-     * @param {string} code unified currency code
-     * @param {int} [since] the earliest time in ms to fetch withdrawals for
-     * @param {int} [limit] the maximum number of withdrawals structures to retrieve
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
-     */
-    fetchWithdrawals(code?: Str, since?: Int, limit?: Int, params?: {}): Promise<Transaction[]>;
-    fetchTransactionsHelper(code?: Str, since?: Int, limit?: Int, params?: {}): Promise<Transaction[]>;
-    parseTransactionStatus(status: Str): string;
-    parseTransaction(transaction: Dict, currency?: Currency): Transaction;
-    calculateRateLimiterCost(api: any, method: any, path: any, params: any, config?: {}): any;
-    /**
-     * @method
-     * @name idex#fetchDepositAddress
-     * @description fetch the Polygon address of the wallet
-     * @see https://api-docs-v3.idex.io/#get-wallets
-     * @param {string} code not used by idex
-     * @param {object} [params] extra parameters specific to the exchange API endpoint
-     * @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
-     */
-    fetchDepositAddress(code: Str, params?: {}): Promise<DepositAddress>;
-    parseDepositAddress(depositAddress: any, currency?: Currency): DepositAddress;
-    sign(path: any, api?: string, method?: string, params?: {}, headers?: any, body?: any): {
-        url: string;
-        method: string;
-        body: any;
-        headers: any;
-    };
-    remove0xPrefix(hexData: any): any;
-    hashMessage(message: any): string;
-    signHash(hash: any, privateKey: any): {
-        r: string;
-        s: string;
-        v: number;
-    };
-    signMessage(message: any, privateKey: any): {
-        r: string;
-        s: string;
-        v: number;
-    };
-    signMessageString(message: any, privateKey: any): string;
-}