ccxt 4.2.21 → 4.2.23

package/js/src/pro/okx.js

@@ -853,13 +853,15 @@ export default class okx extends okxRest {
         /**
          * @method
          * @name okx#watchMyTrades
-         * @see https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-order-channel
          * @description watches information on multiple trades made by the user
+         * @see https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-order-channel
          * @param {string} [symbol] unified market symbol of the market trades were made in
          * @param {int} [since] the earliest time in ms to fetch trades for
          * @param {int} [limit] the maximum number of trade structures to retrieve
          * @param {object} [params] extra parameters specific to the exchange API endpoint
          * @param {bool} [params.stop] true if fetching trigger or conditional trades
+         * @param {string} [params.type] 'spot', 'swap', 'future', 'option', 'ANY', 'SPOT', 'MARGIN', 'SWAP', 'FUTURES' or 'OPTION'
+         * @param {string} [params.marginMode] 'cross' or 'isolated', for automatically setting the type to spot margin
          * @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure
          */
         // By default, receive order updates from any instrument type
@@ -881,7 +883,14 @@ export default class okx extends okxRest {
         if (type === 'future') {
             type = 'futures';
         }
-        const uppercaseType = type.toUpperCase();
+        let uppercaseType = type.toUpperCase();
+        let marginMode = undefined;
+        [marginMode, params] = this.handleMarginModeAndParams('watchMyTrades', params);
+        if (uppercaseType === 'SPOT') {
+            if (marginMode !== undefined) {
+                uppercaseType = 'MARGIN';
+            }
+        }
         const request = {
             'instType': uppercaseType,
         };
@@ -1014,13 +1023,15 @@ export default class okx extends okxRest {
         /**
          * @method
          * @name okx#watchOrders
-         * @see https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-order-channel
          * @description watches information on multiple orders made by the user
-         * @param {string} [symbol] unified market symbol of the market orders were made in
+         * @see https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-order-channel
+         * @param {string} [symbol] unified market symbol of the market the 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
          * @param {bool} [params.stop] true if fetching trigger or conditional orders
+         * @param {string} [params.type] 'spot', 'swap', 'future', 'option', 'ANY', 'SPOT', 'MARGIN', 'SWAP', 'FUTURES' or 'OPTION'
+         * @param {string} [params.marginMode] 'cross' or 'isolated', for automatically setting the type to spot margin
          * @returns {object[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
          */
         let type = undefined;
@@ -1039,7 +1050,14 @@ export default class okx extends okxRest {
         if (type === 'future') {
             type = 'futures';
         }
-        const uppercaseType = type.toUpperCase();
+        let uppercaseType = type.toUpperCase();
+        let marginMode = undefined;
+        [marginMode, params] = this.handleMarginModeAndParams('watchOrders', params);
+        if (uppercaseType === 'SPOT') {
+            if (marginMode !== undefined) {
+                uppercaseType = 'MARGIN';
+            }
+        }
         const request = {
             'instType': uppercaseType,
         };

package/js/src/woo.js

@@ -61,7 +61,7 @@ export default class woo extends Exchange {
                 'fetchClosedOrder': false,
                 'fetchClosedOrders': false,
                 'fetchCurrencies': true,
-                'fetchDepositAddress': false,
+                'fetchDepositAddress': true,
                 'fetchDeposits': true,
                 'fetchDepositsWithdrawals': true,
                 'fetchFundingHistory': true,

package/jsdoc2md.js

@@ -29,9 +29,12 @@ const findByExtensionSync = (dir, ext) => {
 // Get all files to read js docs
 const inputFiles = findByExtensionSync('js/src', 'js')
 const proInputFiles = findByExtensionSync('js/src/pro', 'js');
-const partials = './wiki/partials/'
-const partial = fs.readdirSync (partials).map (file => partials + file)
-const outputFile = './wiki/spec.md'
+const basePartials = './wiki/basePartials/'
+const basePartial = fs.readdirSync (basePartials).map (file => basePartials + file)
+const exchangePartials = './wiki/exchangePartials/'
+const exchangePartial = fs.readdirSync (exchangePartials).map (file => exchangePartials + file)
+const outputFolder = './wiki/'
+const outputFile = './wiki/baseSpec.md'
 const helper = './wiki/helpers.cjs'
 
 console.log ('📰 loading js docs...')
@@ -54,6 +57,7 @@ proTemplateData.forEach((proData) => {
 console.log ('📰 rendering docs for each exchange...')
 const template = fs.readFileSync ('./wiki/spec.hbs', 'utf8')
 
+const outputByExchange = await Promise.all (templateData.map (data => jsdoc2md.render ({ template, data, partial: exchangePartial, helper })))
 // Group docs by method
 const groupedByMethod = templateData.reduce((acc, arr) => {
   arr.filter(obj => obj.kind === 'function' && !obj.ignore).forEach(obj => {
@@ -79,21 +83,39 @@ const groupedByMethod = templateData.reduce((acc, arr) => {
 
 const templateDataGroupedByMethod = Object.values(groupedByMethod).sort((a, b) =>a[0].name < b[0].name ? -1 : 1)
 
-const outputs = await Promise.all (templateDataGroupedByMethod.map (data => jsdoc2md.render ({ template, data, partial, helper})))
+
+const baseOutput = await Promise.all (templateDataGroupedByMethod.map (data => jsdoc2md.render ({ template, data, partial: basePartial, helper})))
 
 console.log ('📰 creating index of exchange functions')
-const functions = Object.keys(groupedByMethod).sort ()
-const alphabet = Array.from ( Array (26)).map((e, i) => String.fromCharCode(i + 97));
-
-const index = {}
-let i = -1
-for (const char of alphabet) {
-    do {
-        index[char] = functions[++i]
-    } while (char > functions[i])
-}
-
-fs.writeFileSync (outputFile, outputs.join ('\n---\n'))
+const exchangeLinks = []
+outputByExchange.forEach ((output, i) => {
+  const name = templateData[i][0].id
+  const fileName = 'exchanges/' + name + '.md'
+  fs.writeFileSync (outputFolder + fileName, output)
+  exchangeLinks.push (`\t- [${name}](${fileName})`)
+})
+
+
+fs.writeFileSync (outputFile, baseOutput.join ('\n---\n'))
+
+const sidebar = 
+`
+- [Install](Install.md)
+- [Examples](Examples.md)
+- [Manual](Manual.md)
+- [CCXT Pro](ccxt.pro.manual.md)
+- [Contributing](CONTRIBUTING.md)
+- [Supported Exchanges](Exchange-Markets.md)
+- [Exchanges By Country](Exchange-Markets-By-Country.md)
+- [API Spec By Method](baseSpec.md)
+- API Spec by Exchange
+${exchangeLinks.join('\n')}
+- [Changelog](CHANGELOG.md)
+- [Awesome](Awesome.md)
+`
+fs.writeFileSync('./wiki/_sidebar.md', sidebar);
+
 console.log ('📰 finished rendering docs! 🙌 😶‍🌫')
 
 })()
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ccxt",
-  "version": "4.2.21",
+  "version": "4.2.23",
   "description": "A JavaScript / TypeScript / Python / C# / PHP cryptocurrency trading library with support for 100+ exchanges",
   "unpkg": "dist/ccxt.browser.js",
   "type": "module",
@@ -22,6 +22,9 @@
   },
   "readme": "README.md",
   "scripts": {
+    "instrument": "nyc instrument js/ jsInstrumented/",
+    "nyc-coverage": "nyc --reporter=html --reporter=lcov --exclude='js/src/pro/**' --exclude='js/src/base/**' --exclude='js/src/test/**' --exclude='js/src/abstract/**' --exclude='js/src/static_dependencies' node jsInstrumented/src/test/test.js --requestTests --responseTests",
+    "coverage-js": "npm run instrument && npm run nyc-coverage && rm -rf jsInstrumented",
     "docker": "docker-compose run --rm ccxt",
     "fixTSBug": "node build/fixTSBug",
     "build-docs": "node jsdoc2md.js && node examples2md.js",

package/skip-tests.json

@@ -1433,6 +1433,10 @@
             },
             "watchOrderBook": {
                 "nonce": "missing https://app.travis-ci.com/github/ccxt/ccxt/builds/267900037#L6909"
+            },
+            "watchTickers": {
+                "quoteVolume": "same",
+                "baseVolume": "same"
             }
         }
     },