ccxt 4.4.30 → 4.4.32

package/dist/cjs/src/wazirx.js

@@ -208,15 +208,15 @@ class wazirx extends wazirx$1 {
             },
         });
     }
+    /**
+     * @method
+     * @name wazirx#fetchMarkets
+     * @see https://docs.wazirx.com/#exchange-info
+     * @description retrieves data on all markets for wazirx
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object[]} an array of objects representing market data
+     */
     async fetchMarkets(params = {}) {
-        /**
-         * @method
-         * @name wazirx#fetchMarkets
-         * @see https://docs.wazirx.com/#exchange-info
-         * @description retrieves data on all markets for wazirx
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object[]} an array of objects representing market data
-         */
         const response = await this.publicGetExchangeInfo(params);
         //
         // {
@@ -321,20 +321,20 @@ class wazirx extends wazirx$1 {
             'info': market,
         };
     }
+    /**
+     * @method
+     * @name wazirx#fetchOHLCV
+     * @see https://docs.wazirx.com/#kline-candlestick-data
+     * @description fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
+     * @param {string} symbol unified symbol of the market to fetch OHLCV data for
+     * @param {string} timeframe the length of time each candle represents. Available values [1m,5m,15m,30m,1h,2h,4h,6h,12h,1d,1w]
+     * @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
+     * @param {int} [params.until] timestamp in s of the latest candle to fetch
+     * @returns {int[][]} A list of candles ordered as timestamp, open, high, low, close, volume
+     */
     async fetchOHLCV(symbol, timeframe = '1m', since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name wazirx#fetchOHLCV
-         * @see https://docs.wazirx.com/#kline-candlestick-data
-         * @description fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
-         * @param {string} symbol unified symbol of the market to fetch OHLCV data for
-         * @param {string} timeframe the length of time each candle represents. Available values [1m,5m,15m,30m,1h,2h,4h,6h,12h,1d,1w]
-         * @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
-         * @param {int} [params.until] timestamp in s of the latest candle to fetch
-         * @returns {int[][]} A list of candles ordered as timestamp, open, high, low, close, volume
-         */
         await this.loadMarkets();
         const market = this.market(symbol);
         const request = {
@@ -374,17 +374,17 @@ class wazirx extends wazirx$1 {
             this.safeNumber(ohlcv, 5),
         ];
     }
+    /**
+     * @method
+     * @name wazirx#fetchOrderBook
+     * @see https://docs.wazirx.com/#order-book
+     * @description fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
+     * @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
+     */
     async fetchOrderBook(symbol, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name wazirx#fetchOrderBook
-         * @see https://docs.wazirx.com/#order-book
-         * @description fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
-         * @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
-         */
         await this.loadMarkets();
         const market = this.market(symbol);
         const request = {
@@ -410,16 +410,16 @@ class wazirx extends wazirx$1 {
         const timestamp = this.safeInteger(response, 'timestamp');
         return this.parseOrderBook(response, symbol, timestamp);
     }
+    /**
+     * @method
+     * @name wazirx#fetchTicker
+     * @see https://docs.wazirx.com/#24hr-ticker-price-change-statistics
+     * @description fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
+     * @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}
+     */
     async fetchTicker(symbol, params = {}) {
-        /**
-         * @method
-         * @name wazirx#fetchTicker
-         * @see https://docs.wazirx.com/#24hr-ticker-price-change-statistics
-         * @description fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
-         * @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}
-         */
         await this.loadMarkets();
         const market = this.market(symbol);
         const request = {
@@ -443,16 +443,16 @@ class wazirx extends wazirx$1 {
         //
         return this.parseTicker(ticker, market);
     }
+    /**
+     * @method
+     * @name wazirx#fetchTickers
+     * @see https://docs.wazirx.com/#24hr-tickers-price-change-statistics
+     * @description fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
+     * @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}
+     */
     async fetchTickers(symbols = undefined, params = {}) {
-        /**
-         * @method
-         * @name wazirx#fetchTickers
-         * @see https://docs.wazirx.com/#24hr-tickers-price-change-statistics
-         * @description fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
-         * @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}
-         */
         await this.loadMarkets();
         const tickers = await this.publicGetTickers24hr();
         //
@@ -481,18 +481,18 @@ class wazirx extends wazirx$1 {
         }
         return this.filterByArrayTickers(result, 'symbol', symbols);
     }
+    /**
+     * @method
+     * @name wazirx#fetchTrades
+     * @see https://docs.wazirx.com/#recent-trades-list
+     * @description get the list of most recent trades for a particular symbol
+     * @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}
+     */
     async fetchTrades(symbol, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name wazirx#fetchTrades
-         * @see https://docs.wazirx.com/#recent-trades-list
-         * @description get the list of most recent trades for a particular symbol
-         * @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}
-         */
         await this.loadMarkets();
         const market = this.market(symbol);
         const request = {
@@ -557,15 +557,15 @@ class wazirx extends wazirx$1 {
             'fee': undefined,
         }, market);
     }
+    /**
+     * @method
+     * @name wazirx#fetchStatus
+     * @see https://docs.wazirx.com/#system-status
+     * @description the latest known information on the availability of the exchange API
+     * @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}
+     */
     async fetchStatus(params = {}) {
-        /**
-         * @method
-         * @name wazirx#fetchStatus
-         * @see https://docs.wazirx.com/#system-status
-         * @description the latest known information on the availability of the exchange API
-         * @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}
-         */
         const response = await this.publicGetSystemStatus(params);
         //
         //     {
@@ -582,15 +582,15 @@ class wazirx extends wazirx$1 {
             'info': response,
         };
     }
+    /**
+     * @method
+     * @name wazirx#fetchTime
+     * @see https://docs.wazirx.com/#check-server-time
+     * @description fetches the current integer timestamp in milliseconds from the exchange server
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {int} the current integer timestamp in milliseconds from the exchange server
+     */
     async fetchTime(params = {}) {
-        /**
-         * @method
-         * @name wazirx#fetchTime
-         * @see https://docs.wazirx.com/#check-server-time
-         * @description fetches the current integer timestamp in milliseconds from the exchange server
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {int} the current integer timestamp in milliseconds from the exchange server
-         */
         const response = await this.publicGetTime(params);
         //
         //     {
@@ -662,15 +662,15 @@ class wazirx extends wazirx$1 {
         }
         return this.safeBalance(result);
     }
+    /**
+     * @method
+     * @name wazirx#fetchBalance
+     * @see https://docs.wazirx.com/#fund-details-user_data
+     * @description query for balance and get the amount of funds available for trading or funds locked in orders
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} a [balance structure]{@link https://docs.ccxt.com/#/?id=balance-structure}
+     */
     async fetchBalance(params = {}) {
-        /**
-         * @method
-         * @name wazirx#fetchBalance
-         * @see https://docs.wazirx.com/#fund-details-user_data
-         * @description query for balance and get the amount of funds available for trading or funds locked in orders
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object} a [balance structure]{@link https://docs.ccxt.com/#/?id=balance-structure}
-         */
         await this.loadMarkets();
         const response = await this.privateGetFunds(params);
         //
@@ -684,18 +684,18 @@ class wazirx extends wazirx$1 {
         //
         return this.parseBalance(response);
     }
+    /**
+     * @method
+     * @name wazirx#fetchOrders
+     * @see https://docs.wazirx.com/#all-orders-user_data
+     * @description fetches information on multiple orders made by the user
+     * @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}
+     */
     async fetchOrders(symbol = undefined, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name wazirx#fetchOrders
-         * @see https://docs.wazirx.com/#all-orders-user_data
-         * @description fetches information on multiple orders made by the user
-         * @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}
-         */
         if (symbol === undefined) {
             throw new errors.ArgumentsRequired(this.id + ' fetchOrders() requires a symbol argument');
         }
@@ -744,18 +744,18 @@ class wazirx extends wazirx$1 {
         orders = this.filterBy(orders, 'symbol', symbol);
         return orders;
     }
+    /**
+     * @method
+     * @name wazirx#fetchOpenOrders
+     * @see https://docs.wazirx.com/#current-open-orders-user_data
+     * @description fetch all unfilled currently open 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}
+     */
     async fetchOpenOrders(symbol = undefined, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name wazirx#fetchOpenOrders
-         * @see https://docs.wazirx.com/#current-open-orders-user_data
-         * @description fetch all unfilled currently open 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}
-         */
         await this.loadMarkets();
         const request = {};
         let market = undefined;
@@ -794,16 +794,16 @@ class wazirx extends wazirx$1 {
         const orders = this.parseOrders(response, market, since, limit);
         return orders;
     }
+    /**
+     * @method
+     * @name wazirx#cancelAllOrders
+     * @see https://docs.wazirx.com/#cancel-all-open-orders-on-a-symbol-trade
+     * @description cancel all open orders in a market
+     * @param {string} symbol unified market symbol of the market to cancel orders in
+     * @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}
+     */
     async cancelAllOrders(symbol = undefined, params = {}) {
-        /**
-         * @method
-         * @name wazirx#cancelAllOrders
-         * @see https://docs.wazirx.com/#cancel-all-open-orders-on-a-symbol-trade
-         * @description cancel all open orders in a market
-         * @param {string} symbol unified market symbol of the market to cancel orders in
-         * @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}
-         */
         if (symbol === undefined) {
             throw new errors.ArgumentsRequired(this.id + ' cancelAllOrders() requires a symbol argument');
         }
@@ -833,17 +833,17 @@ class wazirx extends wazirx$1 {
         //
         return this.parseOrders(response);
     }
+    /**
+     * @method
+     * @name wazirx#cancelOrder
+     * @see https://docs.wazirx.com/#cancel-order-trade
+     * @description cancels an open 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}
+     */
     async cancelOrder(id, symbol = undefined, params = {}) {
-        /**
-         * @method
-         * @name wazirx#cancelOrder
-         * @see https://docs.wazirx.com/#cancel-order-trade
-         * @description cancels an open 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}
-         */
         if (symbol === undefined) {
             throw new errors.ArgumentsRequired(this.id + ' cancelOrder() requires a symbol argument');
         }
@@ -856,20 +856,20 @@ class wazirx extends wazirx$1 {
         const response = await this.privateDeleteOrder(this.extend(request, params));
         return this.parseOrder(response);
     }
+    /**
+     * @method
+     * @name wazirx#createOrder
+     * @see https://docs.wazirx.com/#new-order-trade
+     * @description create a trade 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
+     * @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
+     */
     async createOrder(symbol, type, side, amount, price = undefined, params = {}) {
-        /**
-         * @method
-         * @name wazirx#createOrder
-         * @see https://docs.wazirx.com/#new-order-trade
-         * @description create a trade 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
-         * @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
-         */
         type = type.toLowerCase();
         if ((type !== 'limit') && (type !== 'stop_limit')) {
             throw new errors.ExchangeError(this.id + ' createOrder() supports limit and stop_limit orders only');
@@ -965,15 +965,15 @@ class wazirx extends wazirx$1 {
         };
         return this.safeString(statuses, status, status);
     }
+    /**
+     * @method
+     * @name wazirx#fetchCurrencies
+     * @description fetches all available currencies on an exchange
+     * @see https://docs.wazirx.com/#all-coins-39-information-user_data
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} an associative dictionary of currencies
+     */
     async fetchCurrencies(params = {}) {
-        /**
-         * @method
-         * @name wazirx#fetchCurrencies
-         * @description fetches all available currencies on an exchange
-         * @see https://docs.wazirx.com/#all-coins-39-information-user_data
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object} an associative dictionary of currencies
-         */
         if (!this.checkRequiredCredentials(false)) {
             return undefined;
         }
@@ -1115,17 +1115,17 @@ class wazirx extends wazirx$1 {
         }
         return result;
     }
+    /**
+     * @method
+     * @name wazirx#fetchDepositAddress
+     * @description fetch the deposit address for a currency associated with this account
+     * @see https://docs.wazirx.com/#deposit-address-supporting-network-user_data
+     * @param {string} code unified currency code of the currency for the deposit address
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @param {string} [params.network] unified network code, you can get network from fetchCurrencies
+     * @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
+     */
     async fetchDepositAddress(code, params = {}) {
-        /**
-         * @method
-         * @name wazirx#fetchDepositAddress
-         * @description fetch the deposit address for a currency associated with this account
-         * @see https://docs.wazirx.com/#deposit-address-supporting-network-user_data
-         * @param {string} code unified currency code of the currency for the deposit address
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @param {string} [params.network] unified network code, you can get network from fetchCurrencies
-         * @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
-         */
         await this.loadMarkets();
         const currency = this.currency(code);
         const networkCode = this.safeString(params, 'network');
@@ -1153,19 +1153,19 @@ class wazirx extends wazirx$1 {
             'tag': undefined,
         };
     }
+    /**
+     * @method
+     * @name wazirx#fetchWithdrawals
+     * @description fetch all withdrawals made from an account
+     * @see https://docs.wazirx.com/#withdraw-history-supporting-network-user_data
+     * @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
+     * @param {int} [params.until] the latest time in ms to fetch entries for
+     * @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
+     */
     async fetchWithdrawals(code = undefined, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name wazirx#fetchWithdrawals
-         * @description fetch all withdrawals made from an account
-         * @see https://docs.wazirx.com/#withdraw-history-supporting-network-user_data
-         * @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
-         * @param {int} [params.until] the latest time in ms to fetch entries for
-         * @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
-         */
         await this.loadMarkets();
         const request = {};
         let currency = undefined;