ccxt 4.0.78 → 4.0.79

package/js/src/poloniex.js

@@ -1207,25 +1207,21 @@ export default class poloniex extends Exchange {
         return this.parseOrders(response, market, since, limit, extension);
     }
     async createOrder(symbol, type, side, amount, price = undefined, params = {}) {
-        //
-        // @method
-        // @name poloniex#createOrder
-        // @description create a trade order
-        // @see https://docs.poloniex.com/#authenticated-endpoints-orders-create-order
-        // @see https://docs.poloniex.com/#authenticated-endpoints-smart-orders-create-order  // trigger orders
-        // @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 fullfilled, in units of the quote currency, ignored in market orders
-        // @param {object} [params] extra parameters specific to the poloniex api endpoint
-        // <<<<<<< HEAD
-        // @param {float} [params.triggerPrice] *spot only* The price at which a trigger order is triggered at
-        // @returns {object} an [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
-        // =======
-        // @returns {object} an [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
-        // >>>>>>> 1e1c747220aa06f7c710fc71e9b6658d1260c4d1
-        //
+        /**
+        * @method
+        * @name poloniex#createOrder
+        * @description create a trade order
+        * @see https://docs.poloniex.com/#authenticated-endpoints-orders-create-order
+        * @see https://docs.poloniex.com/#authenticated-endpoints-smart-orders-create-order  // trigger orders
+        * @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 fullfilled, in units of the quote currency, ignored in market orders
+        * @param {object} [params] extra parameters specific to the poloniex api endpoint
+        * @param {float} [params.triggerPrice] *spot only* The price at which a trigger order is triggered at
+        * @returns {object} an [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
+        */
         await this.loadMarkets();
         const market = this.market(symbol);
         if (!market['spot']) {
@@ -1294,26 +1290,22 @@ export default class poloniex extends Exchange {
         return [request, params];
     }
     async editOrder(id, symbol, type, side, amount = undefined, price = undefined, params = {}) {
-        //
-        // @method
-        // @name poloniex#editOrder
-        // @description edit a trade order
-        // @see https://docs.poloniex.com/#authenticated-endpoints-orders-cancel-replace-order
-        // @see https://docs.poloniex.com/#authenticated-endpoints-smart-orders-cancel-replace-order
-        // @param {string} id order id
-        // @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 the currency you want to trade in units of the base currency
-        // @param {float} [price] the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders
-        // @param {object} [params] extra parameters specific to the poloniex api endpoint
-        // <<<<<<< HEAD
-        // @param {float} [params.triggerPrice] The price at which a trigger order is triggered at
-        // @returns {object} an [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
-        // =======
-        // @returns {object} an [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
-        // >>>>>>> 1e1c747220aa06f7c710fc71e9b6658d1260c4d1
-        //
+        /**
+        * @method
+        * @name poloniex#editOrder
+        * @description edit a trade order
+        * @see https://docs.poloniex.com/#authenticated-endpoints-orders-cancel-replace-order
+        * @see https://docs.poloniex.com/#authenticated-endpoints-smart-orders-cancel-replace-order
+        * @param {string} id order id
+        * @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 the currency you want to trade in units of the base currency
+        * @param {float} [price] the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders
+        * @param {object} [params] extra parameters specific to the poloniex api endpoint
+        * @param {float} [params.triggerPrice] The price at which a trigger order is triggered at
+        * @returns {object} an [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
+        */
         await this.loadMarkets();
         const market = this.market(symbol);
         if (!market['spot']) {
@@ -1353,12 +1345,8 @@ export default class poloniex extends Exchange {
         // @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 poloniex api endpoint
-        // <<<<<<< HEAD
         // @param {boolean} [params.trigger] true if canceling a trigger order
         // @returns {object} An [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
-        // =======
-        // @returns {object} An [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
-        // >>>>>>> 1e1c747220aa06f7c710fc71e9b6658d1260c4d1
         //
         await this.loadMarkets();
         const request = {};
@@ -1388,21 +1376,17 @@ export default class poloniex extends Exchange {
         return this.parseOrder(response);
     }
     async cancelAllOrders(symbol = undefined, params = {}) {
-        //
-        // @method
-        // @name poloniex#cancelAllOrders
-        // @description cancel all open orders
-        // @see https://docs.poloniex.com/#authenticated-endpoints-orders-cancel-all-orders
-        // @see https://docs.poloniex.com/#authenticated-endpoints-smart-orders-cancel-all-orders  // trigger 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 poloniex api endpoint
-        // <<<<<<< HEAD
-        // @param {boolean} [params.trigger] true if canceling trigger orders
-        // @returns {object[]} a list of [order structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
-        // =======
-        // @returns {object[]} a list of [order structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
-        // >>>>>>> 1e1c747220aa06f7c710fc71e9b6658d1260c4d1
-        //
+        /**
+        * @method
+        * @name poloniex#cancelAllOrders
+        * @description cancel all open orders
+        * @see https://docs.poloniex.com/#authenticated-endpoints-orders-cancel-all-orders
+        * @see https://docs.poloniex.com/#authenticated-endpoints-smart-orders-cancel-all-orders  // trigger 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 poloniex api endpoint
+        * @param {boolean} [params.trigger] true if canceling trigger orders
+        * @returns {object[]} a list of [order structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
+        */
         await this.loadMarkets();
         const request = {
             // 'accountTypes': 'SPOT',
@@ -1444,22 +1428,18 @@ export default class poloniex extends Exchange {
         return this.parseOrders(response, market);
     }
     async fetchOrder(id, symbol = undefined, params = {}) {
-        //
-        // @method
-        // @name poloniex#fetchOrder
-        // @description fetch an order by it's id
-        // @see https://docs.poloniex.com/#authenticated-endpoints-orders-order-details
-        // @see https://docs.poloniex.com/#authenticated-endpoints-smart-orders-open-orders  // trigger orders
-        // @param {string} id order id
-        // @param {string} symbol unified market symbol, default is undefined
-        // @param {object} [params] extra parameters specific to the poloniex api endpoint
-        // <<<<<<< HEAD
-        // @param {boolean} [params.trigger] true if fetching a trigger order
-        // @returns {object} an [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
-        // =======
-        // @returns {object} an [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
-        // >>>>>>> 1e1c747220aa06f7c710fc71e9b6658d1260c4d1
-        //
+        /**
+        * @method
+        * @name poloniex#fetchOrder
+        * @description fetch an order by it's id
+        * @see https://docs.poloniex.com/#authenticated-endpoints-orders-order-details
+        * @see https://docs.poloniex.com/#authenticated-endpoints-smart-orders-open-orders  // trigger orders
+        * @param {string} id order id
+        * @param {string} symbol unified market symbol, default is undefined
+        * @param {object} [params] extra parameters specific to the poloniex api endpoint
+        * @param {boolean} [params.trigger] true if fetching a trigger order
+        * @returns {object} an [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
+        */
         await this.loadMarkets();
         id = id.toString();
         const request = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ccxt",
-  "version": "4.0.78",
+  "version": "4.0.79",
   "description": "A JavaScript / TypeScript / Python / C# / PHP cryptocurrency trading library with support for 130+ exchanges",
   "unpkg": "dist/ccxt.browser.js",
   "type": "module",