node-kraken-api - npm Package Compare versions

Comparing version 2.1.0 to 2.2.0

index.d.ts

@@ -5,3 +5,3 @@ /// <reference types="node" />
 import WebSocket from "ws";
-export declare const _USER_AGENT = "node-kraken-api/2.1.0";
+export declare const _USER_AGENT = "node-kraken-api/2.2.0";
 export declare const _REST_HOSTNAME = "api.kraken.com";
@@ -1290,2 +1290,3 @@ export declare const _WS_PUB_HOSTNAME = "ws.kraken.com";
         "API-Sign": string;
+        "Content-Type": "application/x-www-form-urlencoded";
     };
@@ -1292,0 +1293,0 @@ signedQuery: (input: Readonly<NodeJS.Dict<any>>) => NodeJS.Dict<any> & {

index.js

 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
@@ -41,3 +45,3 @@ if (k2 === undefined) k2 = k;
 const ws_1 = __importDefault(require("ws"));
-exports._USER_AGENT = "node-kraken-api/2.1.0";
+exports._USER_AGENT = "node-kraken-api/2.2.0";
 exports._REST_HOSTNAME = "api.kraken.com";
@@ -864,2 +868,3 @@ exports._WS_PUB_HOSTNAME = "ws.kraken.com";
                     .digest("base64"),
+                "Content-Type": "application/x-www-form-urlencoded",
             };
@@ -1172,3 +1177,2 @@ };
                     "ExportStatus",
-                    "RetrieveExport",
                     "RemoveExport",
@@ -1175,0 +1179,0 @@ "AddOrder",

package.json

 {
   "name": "node-kraken-api",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "a typed REST/WS Node.JS client for the Kraken cryptocurrency exchange",
@@ -39,3 +39,3 @@ "license": "MIT",
     "codegen": "npm run clean && tsc --pretty -p codegen && sh codegen/codegen.sh",
-    "prepare": "npm run build"
+    "prepare": "npm run clean && npm run build"
   },
@@ -46,5 +46,5 @@ "engines": {
   "dependencies": {
-    "crc": "^3.8.0",
-    "ts-ev": "^0.3.0",
-    "ws": "^8.2.2"
+    "crc": "^4.1.0",
+    "ts-ev": "^0.4.0",
+    "ws": "^8.5.0"
   },
@@ -54,10 +54,10 @@ "devDependencies": {
     "@types/crc": "^3.4.0",
-    "@types/node": "^16.9.1",
-    "@types/ws": "^7.4.7",
-    "typescript": "^4.4.3"
+    "@types/node": "^17.0.21",
+    "@types/ws": "^8.5.3",
+    "typescript": "^4.6.2"
   },
   "optionalDependencies": {
-    "bufferutil": "^4.0.3",
-    "utf-8-validate": "^5.0.5"
+    "bufferutil": "^4.0.6",
+    "utf-8-validate": "^5.0.9"
   }
 }

README.md

@@ -1,2 +0,2 @@
-[![](https://github.com/jpcx/node-kraken-api/blob/2.1.0/logo.png)](#)
+[![](https://github.com/jpcx/node-kraken-api/blob/2.2.0/logo.png)](#)
 
@@ -30,3 +30,3 @@ [![](https://img.shields.io/github/issues/jpcx/node-kraken-api)](#)
 
-[CHANGELOG](https://github.com/jpcx/node-kraken-api/blob/2.1.0/CHANGELOG.md) | [Synopsis](#synopsis) | [Usage](#usage) | [Code](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts) |
+[CHANGELOG](https://github.com/jpcx/node-kraken-api/blob/2.2.0/CHANGELOG.md) | [Synopsis](#synopsis) | [Usage](#usage) | [Code](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts) |
 | --- | --- | --- | --- |
@@ -79,3 +79,3 @@
 
-- Errors have changed to named classes. Please review [the synopsis](https://github.com/jpcx/node-kraken-api/blob/2.1.0/README.md#synopsis).
+- Errors have changed to named classes. Please review [the synopsis](https://github.com/jpcx/node-kraken-api/blob/2.2.0/README.md#synopsis).
 
@@ -124,78 +124,78 @@ #### Upgrade Guide
 
-- [`.request()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L195)
-- [`.time()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L249)
-- [`.systemStatus()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L256)
-- [`.assets()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L263)
-- [`.assetPairs()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L285)
-- [`.ticker()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L311)
-- [`.ohlc()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L328)
-- [`.depth()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L356)
-- [`.trades()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L379)
-- [`.spread()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L401)
-- [`.getWebSocketsToken()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L424)
-- [`.balance()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L431)
-- [`.tradeBalance()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L438)
-- [`.openOrders()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L455)
-- [`.closedOrders()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L476)
-- [`.queryOrders()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L513)
-- [`.tradesHistory()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L538)
-- [`.queryTrades()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L571)
-- [`.openPositions()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L591)
-- [`.ledgers()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L615)
-- [`.queryLedgers()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L654)
-- [`.tradeVolume()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L674)
-- [`.addExport()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L694)
-- [`.exportStatus()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L734)
-- [`.retrieveExport()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L750)
-- [`.removeExport()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L766)
-- [`.addOrder()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L787)
-- [`.cancelOrder()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L881)
-- [`.cancelAll()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L897)
-- [`.cancelAllOrdersAfter()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L905)
-- [`.depositMethods()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L921)
-- [`.depositAddresses()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L937)
-- [`.depositStatus()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L961)
-- [`.withdrawInfo()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L981)
-- [`.withdrawStatus()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1029)
-- [`.withdrawCancel()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1049)
-- [`.walletTransfer()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1069)
-- [`.stake()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1098)
-- [`.unstake()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1123)
-- [`.stakingAssets()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1145)
-- [`.stakingPending()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1154)
-- [`.stakingTransactions()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1163)
-- [`.ws.ticker()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1188)
-- [`.ws.ohlc()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1211)
-- [`.ws.trade()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1234)
-- [`.ws.spread()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1253)
-- [`.ws.book()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1272)
-- [`.ws.ownTrades()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1347)
-- [`.ws.openOrders()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1372)
-- [`.ws.addOrder()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1397)
-- [`.ws.cancelOrder()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1451)
-- [`.ws.cancelAll()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1467)
-- [`.ws.cancelAllOrdersAfter()`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1487)
+- [`.request()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L195)
+- [`.time()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L249)
+- [`.systemStatus()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L256)
+- [`.assets()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L263)
+- [`.assetPairs()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L285)
+- [`.ticker()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L311)
+- [`.ohlc()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L328)
+- [`.depth()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L356)
+- [`.trades()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L379)
+- [`.spread()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L401)
+- [`.getWebSocketsToken()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L424)
+- [`.balance()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L431)
+- [`.tradeBalance()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L438)
+- [`.openOrders()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L455)
+- [`.closedOrders()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L476)
+- [`.queryOrders()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L513)
+- [`.tradesHistory()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L538)
+- [`.queryTrades()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L571)
+- [`.openPositions()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L591)
+- [`.ledgers()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L615)
+- [`.queryLedgers()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L654)
+- [`.tradeVolume()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L674)
+- [`.addExport()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L694)
+- [`.exportStatus()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L734)
+- [`.retrieveExport()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L750)
+- [`.removeExport()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L766)
+- [`.addOrder()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L787)
+- [`.cancelOrder()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L881)
+- [`.cancelAll()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L897)
+- [`.cancelAllOrdersAfter()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L905)
+- [`.depositMethods()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L921)
+- [`.depositAddresses()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L937)
+- [`.depositStatus()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L961)
+- [`.withdrawInfo()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L981)
+- [`.withdrawStatus()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1029)
+- [`.withdrawCancel()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1049)
+- [`.walletTransfer()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1069)
+- [`.stake()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1098)
+- [`.unstake()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1123)
+- [`.stakingAssets()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1145)
+- [`.stakingPending()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1154)
+- [`.stakingTransactions()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1163)
+- [`.ws.ticker()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1188)
+- [`.ws.ohlc()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1211)
+- [`.ws.trade()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1234)
+- [`.ws.spread()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1253)
+- [`.ws.book()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1272)
+- [`.ws.ownTrades()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1347)
+- [`.ws.openOrders()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1372)
+- [`.ws.addOrder()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1397)
+- [`.ws.cancelOrder()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1451)
+- [`.ws.cancelAll()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1467)
+- [`.ws.cancelAllOrdersAfter()`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1487)
 
 ### Properties
 
-- [`.ws`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1170)
-- [`.ws.pub`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1174)
-- [`.ws.priv`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1176)
+- [`.ws`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1170)
+- [`.ws.pub`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1174)
+- [`.ws.priv`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1176)
 
 ### Classes
 
-- [`Kraken`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L122)
-- [`Kraken.InternalError`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1510)
-- [`Kraken.UnknownError`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1517)
-- [`Kraken.ArgumentError`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1527)
-- [`Kraken.SettingsError`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1534)
-- [`Kraken.JSONParseError`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1541)
-- [`Kraken.BufferParseError`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1551)
-- [`Kraken.HTTPRequestError`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1561)
-- [`Kraken.RESTAPIError`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1577)
-- [`Kraken.TimeoutError`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1587)
-- [`Kraken.WSAPIError`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L1594)
-- [`Kraken.WS.Connection`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L4390)
-- [`Kraken.WS.Subscriber`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L4691)
-- [`Kraken.WS.Subscription`](https://github.com/jpcx/node-kraken-api/blob/2.1.0/index.ts#L4853)
+- [`Kraken`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L122)
+- [`Kraken.InternalError`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1510)
+- [`Kraken.UnknownError`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1517)
+- [`Kraken.ArgumentError`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1527)
+- [`Kraken.SettingsError`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1534)
+- [`Kraken.JSONParseError`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1541)
+- [`Kraken.BufferParseError`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1551)
+- [`Kraken.HTTPRequestError`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1561)
+- [`Kraken.RESTAPIError`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1577)
+- [`Kraken.TimeoutError`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1587)
+- [`Kraken.WSAPIError`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L1594)
+- [`Kraken.WS.Connection`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L4390)
+- [`Kraken.WS.Subscriber`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L4691)
+- [`Kraken.WS.Subscription`](https://github.com/jpcx/node-kraken-api/blob/2.2.0/index.ts#L4853)
 
@@ -226,3 +226,9 @@ </details>
   genotp?: () => string;
-  /** Nonce generator (the default is ms time with an incrementation guarantee). */
+  /**
+   * Nonce generator (the default is ms time with an incrementation guarantee).
+   * Note: Some other APIs use a spoofed microsecond time. If you are using an
+   *       API key used by one of those APIs then you will need to use a custom
+   *       nonce generator (e.g. () => Date.now() * 1000). See _GENNONCE for the
+   *       default generation logic.
+   */
   gennonce?: () => number;
@@ -348,5 +354,5 @@ /** Connection timeout. */
 ```
-XBT: bc1qnkturlnv4yufkc40k4ysxz4maak5mug7l820my
-LTC: ltc1q9jnvesyffgysel7h4cttg7fscenaje2ka08qvc
-ETH: 0xD03c9c3027C6bBDDad31d183Ba07DA9db34ee641
+msg: node-kraken-api
+btc: bc1q3asl6wjnmarx4r9qcc04gkcld9q2qaqk42dvh6
+sig: J4p7GsyX/2wQLk32Zfi/AmubUzGM66I6ah+mEn8Vpqf4EpfPuWYGaLcu2J8tdcsRGMAsmavbz/SJnw7yr3c0Duw=
 ```
@@ -358,2 +364,2 @@
 
-This project is licensed under the MIT License - see the [LICENSE](https://github.com/jpcx/node-kraken-api/blob/2.1.0/LICENSE) file for details
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/jpcx/node-kraken-api/blob/2.2.0/LICENSE) file for details

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

114105

increased by0.51%

Lines of code

2631

increased by0.19%

Number of lines in readme file

360

increased by1.69%

Dependency changes

• + Addedcrc@4.3.2(transitive)

• + Addedts-ev@0.4.0(transitive)

• - Removedbase64-js@1.5.1(transitive)

• - Removedbuffer@5.7.1(transitive)

• - Removedcrc@3.8.0(transitive)

• - Removedieee754@1.2.1(transitive)

• - Removedts-ev@0.3.0(transitive)

• Updatedcrc@^4.1.0

• Updatedts-ev@^0.4.0

• Updatedws@^8.5.0