ccxt 4.4.29 → 4.4.31

package/dist/cjs/src/lykke.js

@@ -186,15 +186,15 @@ class lykke extends lykke$1 {
             'commonCurrencies': {},
         });
     }
+    /**
+     * @method
+     * @name lykke#fetchCurrencies
+     * @description fetches all available currencies on an exchange
+     * @see https://lykkecity.github.io/Trading-API/#get-all-assets
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} an associative dictionary of currencies
+     */
     async fetchCurrencies(params = {}) {
-        /**
-         * @method
-         * @name lykke#fetchCurrencies
-         * @description fetches all available currencies on an exchange
-         * @see https://lykkecity.github.io/Trading-API/#get-all-assets
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object} an associative dictionary of currencies
-         */
         const response = await this.publicGetAssets(params);
         const currencies = this.safeValue(response, 'payload', []);
         //
@@ -265,15 +265,15 @@ class lykke extends lykke$1 {
         }
         return result;
     }
+    /**
+     * @method
+     * @name lykke#fetchMarkets
+     * @description retrieves data on all markets for lykke
+     * @see https://lykkecity.github.io/Trading-API/#get-asset-by-id
+     * @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 lykke#fetchMarkets
-         * @description retrieves data on all markets for lykke
-         * @see https://lykkecity.github.io/Trading-API/#get-asset-by-id
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object[]} an array of objects representing market data
-         */
         const response = await this.publicGetAssetpairs(params);
         const markets = this.safeValue(response, 'payload', []);
         //
@@ -425,17 +425,17 @@ class lykke extends lykke$1 {
             'info': ticker,
         }, market);
     }
+    /**
+     * @method
+     * @name lykke#fetchTicker
+     * @description fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
+     * @see https://lykkecity.github.io/Trading-API/#get-current-prices
+     * @see https://lykkecity.github.io/Trading-API/#24hr-ticker-price-change-statistics
+     * @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 lykke#fetchTicker
-         * @description fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
-         * @see https://lykkecity.github.io/Trading-API/#get-current-prices
-         * @see https://lykkecity.github.io/Trading-API/#24hr-ticker-price-change-statistics
-         * @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 = {
@@ -486,16 +486,16 @@ class lykke extends lykke$1 {
         //
         return this.parseTicker(this.safeValue(ticker, 0, {}), market);
     }
+    /**
+     * @method
+     * @name lykke#fetchTickers
+     * @description fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
+     * @see https://lykkecity.github.io/Trading-API/#24hr-ticker-price-change-statistics
+     * @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 lykke#fetchTickers
-         * @description fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
-         * @see https://lykkecity.github.io/Trading-API/#24hr-ticker-price-change-statistics
-         * @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 response = await this.publicGetTickers(params);
         const tickers = this.safeValue(response, 'payload', []);
@@ -518,17 +518,17 @@ class lykke extends lykke$1 {
         //
         return this.parseTickers(tickers, symbols);
     }
+    /**
+     * @method
+     * @name lykke#fetchOrderBook
+     * @description fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
+     * @see https://lykkecity.github.io/Trading-API/#asset-pair-order-book-ticker
+     * @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 lykke#fetchOrderBook
-         * @description fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
-         * @see https://lykkecity.github.io/Trading-API/#asset-pair-order-book-ticker
-         * @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 = {
@@ -623,18 +623,18 @@ class lykke extends lykke$1 {
             'fee': undefined,
         }, market);
     }
+    /**
+     * @method
+     * @name lykke#fetchTrades
+     * @description get the list of most recent trades for a particular symbol
+     * @see https://lykkecity.github.io/Trading-API/#get-public-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}
+     */
     async fetchTrades(symbol, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name lykke#fetchTrades
-         * @description get the list of most recent trades for a particular symbol
-         * @see https://lykkecity.github.io/Trading-API/#get-public-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}
-         */
         await this.loadMarkets();
         const market = this.market(symbol);
         const request = {
@@ -688,15 +688,15 @@ class lykke extends lykke$1 {
         }
         return this.safeBalance(result);
     }
+    /**
+     * @method
+     * @name lykke#fetchBalance
+     * @description query for balance and get the amount of funds available for trading or funds locked in orders
+     * @see https://lykkecity.github.io/Trading-API/#get-the-current-balance
+     * @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 lykke#fetchBalance
-         * @description query for balance and get the amount of funds available for trading or funds locked in orders
-         * @see https://lykkecity.github.io/Trading-API/#get-the-current-balance
-         * @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.privateGetBalance(params);
         const payload = this.safeValue(response, 'payload', []);
@@ -784,21 +784,21 @@ class lykke extends lykke$1 {
             'trades': undefined,
         }, market);
     }
+    /**
+     * @method
+     * @name lykke#createOrder
+     * @description create a trade order
+     * @see https://lykkecity.github.io/Trading-API/#place-a-limit-order
+     * @see https://lykkecity.github.io/Trading-API/#place-a-market-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 lykke#createOrder
-         * @description create a trade order
-         * @see https://lykkecity.github.io/Trading-API/#place-a-limit-order
-         * @see https://lykkecity.github.io/Trading-API/#place-a-market-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}
-         */
         await this.loadMarkets();
         const market = this.market(symbol);
         const query = {
@@ -862,17 +862,17 @@ class lykke extends lykke$1 {
             'trades': undefined,
         }, market);
     }
+    /**
+     * @method
+     * @name lykke#cancelOrder
+     * @description cancels an open order
+     * @see https://lykkecity.github.io/Trading-API/#cancel-orders-by-id
+     * @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 lykke#cancelOrder
-         * @description cancels an open order
-         * @see https://lykkecity.github.io/Trading-API/#cancel-orders-by-id
-         * @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}
-         */
         const request = {
             'orderId': id,
         };
@@ -887,16 +887,16 @@ class lykke extends lykke$1 {
             'info': response,
         });
     }
+    /**
+     * @method
+     * @name lykke#cancelAllOrders
+     * @description cancel all open orders
+     * @see https://lykkecity.github.io/Trading-API/#mass-cancel-orders
+     * @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}
+     */
     async cancelAllOrders(symbol = undefined, params = {}) {
-        /**
-         * @method
-         * @name lykke#cancelAllOrders
-         * @description cancel all open orders
-         * @see https://lykkecity.github.io/Trading-API/#mass-cancel-orders
-         * @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}
-         */
         await this.loadMarkets();
         const request = {
         // 'side': 'Buy',
@@ -919,16 +919,17 @@ class lykke extends lykke$1 {
             }),
         ];
     }
+    /**
+     * @method
+     * @name lykke#fetchOrder
+     * @description fetches information on an order made by the user
+     * @see https://lykkecity.github.io/Trading-API/#get-order-by-id
+     * @param {string} id order id
+     * @param {string} symbol not used by lykke fetchOrder
+     * @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 fetchOrder(id, symbol = undefined, params = {}) {
-        /**
-         * @method
-         * @name lykke#fetchOrder
-         * @description fetches information on an order made by the user
-         * @see https://lykkecity.github.io/Trading-API/#get-order-by-id
-         * @param {string} symbol not used by lykke fetchOrder
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
-         */
         await this.loadMarkets();
         const request = {
             'orderId': id,
@@ -956,18 +957,18 @@ class lykke extends lykke$1 {
         //
         return this.parseOrder(payload);
     }
+    /**
+     * @method
+     * @name lykke#fetchOpenOrders
+     * @description fetch all unfilled currently open orders
+     * @see https://lykkecity.github.io/Trading-API/#get-active-or-closed-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 lykke#fetchOpenOrders
-         * @description fetch all unfilled currently open orders
-         * @see https://lykkecity.github.io/Trading-API/#get-active-or-closed-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();
         let market = undefined;
         if (symbol !== undefined) {
@@ -1005,18 +1006,18 @@ class lykke extends lykke$1 {
         //
         return this.parseOrders(payload, market, since, limit);
     }
+    /**
+     * @method
+     * @name lykke#fetchClosedOrders
+     * @description fetches information on multiple closed orders made by the user
+     * @see https://lykkecity.github.io/Trading-API/#get-active-or-closed-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}
+     */
     async fetchClosedOrders(symbol = undefined, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name lykke#fetchClosedOrders
-         * @description fetches information on multiple closed orders made by the user
-         * @see https://lykkecity.github.io/Trading-API/#get-active-or-closed-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}
-         */
         await this.loadMarkets();
         let market = undefined;
         if (symbol !== undefined) {
@@ -1054,18 +1055,18 @@ class lykke extends lykke$1 {
         //
         return this.parseOrders(payload, market, since, limit);
     }
+    /**
+     * @method
+     * @name lykke#fetchMyTrades
+     * @description fetch all trades made by the user
+     * @see https://lykkecity.github.io/Trading-API/#get-trade-history
+     * @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}
+     */
     async fetchMyTrades(symbol = undefined, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name lykke#fetchMyTrades
-         * @description fetch all trades made by the user
-         * @see https://lykkecity.github.io/Trading-API/#get-trade-history
-         * @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}
-         */
         await this.loadMarkets();
         const request = {
         // 'side': 'buy',
@@ -1114,16 +1115,16 @@ class lykke extends lykke$1 {
         const amount = Precise["default"].stringAbs(this.safeString(bidask, amountKey));
         return [this.parseNumber(price), this.parseNumber(amount)];
     }
+    /**
+     * @method
+     * @name lykke#fetchDepositAddress
+     * @description fetch the deposit address for a currency associated with this account
+     * @see https://lykkecity.github.io/Trading-API/#get-deposit-address-for-a-given-asset
+     * @param {string} code unified currency code
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
+     */
     async fetchDepositAddress(code, params = {}) {
-        /**
-         * @method
-         * @name lykke#fetchDepositAddress
-         * @description fetch the deposit address for a currency associated with this account
-         * @see https://lykkecity.github.io/Trading-API/#get-deposit-address-for-a-given-asset
-         * @param {string} code unified currency code
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
-         */
         await this.loadMarkets();
         const currency = this.currency(code);
         const request = {
@@ -1212,18 +1213,18 @@ class lykke extends lykke$1 {
             'fee': fee,
         };
     }
+    /**
+     * @method
+     * @name lykke#fetchDepositsWithdrawals
+     * @description fetch history of deposits and withdrawals
+     * @see https://lykkecity.github.io/Trading-API/#get-the-history-of-withdrawals-and-deposits
+     * @param {string} [code] unified currency code for the currency of the deposit/withdrawals, default is undefined
+     * @param {int} [since] timestamp in ms of the earliest deposit/withdrawal, default is undefined
+     * @param {int} [limit] max number of deposit/withdrawals to return, default is undefined
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} a list of [transaction structure]{@link https://docs.ccxt.com/#/?id=transaction-structure}
+     */
     async fetchDepositsWithdrawals(code = undefined, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name lykke#fetchDepositsWithdrawals
-         * @description fetch history of deposits and withdrawals
-         * @see https://lykkecity.github.io/Trading-API/#get-the-history-of-withdrawals-and-deposits
-         * @param {string} [code] unified currency code for the currency of the deposit/withdrawals, default is undefined
-         * @param {int} [since] timestamp in ms of the earliest deposit/withdrawal, default is undefined
-         * @param {int} [limit] max number of deposit/withdrawals to return, default is undefined
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object} a list of [transaction structure]{@link https://docs.ccxt.com/#/?id=transaction-structure}
-         */
         await this.loadMarkets();
         const request = {
         // 'offset': 0,
@@ -1255,19 +1256,19 @@ class lykke extends lykke$1 {
         }
         return this.parseTransactions(payload, currency, since, limit);
     }
+    /**
+     * @method
+     * @name lykke#withdraw
+     * @description make a withdrawal
+     * @see https://lykkecity.github.io/Trading-API/#withdrawal
+     * @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}
+     */
     async withdraw(code, amount, address, tag = undefined, params = {}) {
-        /**
-         * @method
-         * @name lykke#withdraw
-         * @description make a withdrawal
-         * @see https://lykkecity.github.io/Trading-API/#withdrawal
-         * @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}
-         */
         await this.loadMarkets();
         this.checkAddress(address);
         const currency = this.currency(code);