Merge pull request #27 from cryptomkt/feat/update-june-2024

Feat/update june 2024

Author: ppbustamante

lib/client.ts

@@ -2,6 +2,7 @@ import {
   ACCOUNT,
   CONTINGENCY,
   IDENTIFY_BY,
+  ORDER_BY,
   ORDER_TYPE,
   PERIOD,
   SIDE,
@@ -52,6 +53,26 @@ export class Client {
     this.httpClient = new HttpClient(this.apiUrl, this.apiVersion, apiKey, apiSecret, window)
   }
 
+  /**
+   * Changes the window used in authenticated calls
+   *
+   * @param {number} window acceptable time between request and server execution in millis
+   */
+  changeWindow(window: number) {
+    this.httpClient.changeWindow(window)
+  }
+
+
+  /**
+   * Changes the user credentials used for authentication in calls
+   *
+   * @param {string} apiKey    the user public key used in new calls
+   * @param {string} apiSecret the user secret key used in new calls
+   */
+  changeCredentials(apiKey: string, apiSecret: string) {
+    this.httpClient.changeCredentials(apiKey, apiSecret)
+  }
+
   async publicGet(endpoint: string, params: any) {
     const parsedParams = fromCamelCaseToSnakeCase(params)
     const response = this.httpClient.publicGet(endpoint, parsedParams);
@@ -1160,6 +1181,22 @@ Accepted values: never, optionally, required
     return this.post("wallet/crypto/fees/estimate", feeRequests);
   }
 
+
+  /**
+   * Get estimates of withdrawal fees
+   *
+   * Requires the "Payment information" API key Access Right.
+   *
+   * https://api.exchange.cryptomkt.com/#bulk-estimate-withdrawal-fee
+   *
+   * @param {FeeRequest[]} feeRequests A list of fee requests
+   *
+   * @return The list of requested fees
+   */
+  async getBulkEstimateWithdrawalFees(feeRequests: FeeRequest[]): Promise<Fee[]> {
+    return this.post("wallet/crypto/fee/estimate/bulk", feeRequests);
+  }
+
   /**
    * Get an estimate of a withdrawal fee
    *
@@ -1183,6 +1220,44 @@ Accepted values: never, optionally, required
     return response["fee"];
   }
 
+//   /**
+//  * Get estimates of deposit fees
+//  *
+//  * Requires the "Payment information" API key Access Right.
+//  *
+//  * https://api.exchange.cryptomkt.com/#bulk-estimate-deposit-fee
+//  *
+//  * @param {FeeRequest[]} feeRequests A list of fee requests
+//  *
+//  * @return The list of requested fees
+//  */
+//   async getBulkEstimateDepositFees(feeRequests: FeeRequest[]): Promise<Fee[]> {
+//     return this.post("wallet/crypto/fee/deposit/estimate/bulk", feeRequests);
+//   }
+
+  // /**
+  //  * Get an estimate of a deposit fee
+  //  *
+  //  * Requires the "Payment information" API key Access Right.
+  //  *
+  //  * https://api.exchange.cryptomkt.com/#estimate-deposit-fee
+  //  *
+  //  * @param {object} params
+  //  * @param {string} params.currency the currency code for deposit
+  //  * @param {string} params.amount the expected deposit amount
+  //  * @param {string} [params.netwrokCode] Optional. Network code
+  //  *
+  //  * @return The expected fee
+  //  */
+  // async getEstimateDepositFee(params: {
+  //   currency: string;
+  //   amount: string;
+  //   networkCode?: string;
+  // }): Promise<string> {
+  //   const response = await this.get("wallet/crypto/fee/deposit/estimate", params);
+  //   return response["fee"];
+  // }
+
   /**
    * Converts between currencies
    *
@@ -1301,9 +1376,9 @@ Accepted values: wallet, spot. Must not be the same as source
    * @param {TRANSACTION_STATUS[]} [params.statuses] Optional. List of statuses to query. valid subtypes are: 'CREATED', 'PENDING', 'FAILED', 'SUCCESS' and 'ROLLED_BACK'
    * @param {string[]} [params.currencies] Optional. List of currencies of the transactions
    * @param {string[]} [params.networks] Optional. List of network codes
-   * @param {SORT_BY} [params.orderBy] Optional. Defines the sorting type.'createdAt' or 'id'. Default is 'createdAt'
-   * @param {string} [params.from] Optional. Interval initial value when ordering by 'createdAt'. As Datetime
-   * @param {string} [params.till] Optional. Interval end value when ordering by 'createdAt'. As Datetime
+   * @param {ORDER_BY} [params.orderBy] Optional. Defines the sorting type.'CREATED_AT', 'UPDATED_AT', 'LAST_ACTIVITY_AT' or 'ID'. Default is 'CREATED_AT'
+   * @param {string} [params.from] Optional. Interval initial value (inclusive). The value type depends on orderBy.
+   * @param {string} [params.till] Optional. Interval end value (inclusive). The value type depends on orderBy.
    * @param {string} [params.idFrom] Optional. Interval initial value when ordering by id. Min is 0
    * @param {string} [params.idTill] Optional. Interval end value when ordering by id. Min is 0
    * @param {string} [params.sort] Optional. Sort direction. 'ASC' or 'DESC'. Default is 'DESC'.
@@ -1320,7 +1395,7 @@ Accepted values: wallet, spot. Must not be the same as source
     statuses?: TRANSACTION_STATUS[];
     currencies?: string[],
     networks?: string[],
-    orderBy?: SORT_BY;
+    orderBy?: ORDER_BY;
     from?: string;
     till?: string;
     idFrom?: string;

lib/constants.ts

@@ -27,7 +27,14 @@ export enum SORT {
 
 export enum SORT_BY {
   TIMESTAMP = "timestamp",
+  ID = "id",
+}
+
+
+export enum ORDER_BY {
   CREATED_AT = "created_at",
+  UPDATED_AT = "updated_at",
+  LAST_ACTIVITY_AT = "last_activity_at",
   ID = "id",
 }
 

lib/hmac.ts

@@ -16,6 +16,15 @@ export class HMAC {
     this.window = window
   }
 
+  changeWindow(window: number) {
+    this.window = window;
+  }
+
+  changeCredentials(apiKey: string, apiSecret: string) {
+    this.apiKey = apiKey;
+    this.apiSecret = apiSecret;
+  }
+
   /**+
    *
    * @param {URL} url

lib/httpClient.ts

@@ -17,6 +17,15 @@ export class HttpClient {
     this.hmac = new HMAC(apiKey, apiSecret, window)
   }
 
+
+  changeWindow(window: number) {
+    this.hmac.changeWindow(window)
+  }
+
+  changeCredentials(apiKey: string, apiSecret: string) {
+    this.hmac.changeCredentials(apiKey, apiSecret)
+  }
+
   async makeRequest(
     method: HTTP_METHOD,
     endpoint: string,

lib/models/Fee.ts

@@ -2,5 +2,5 @@ export interface Fee {
   fee: string;
   currency: string;
   amount: string;
-  networkFee: string;
+  networkFee?: string;
 }

lib/models/Network.ts

@@ -14,4 +14,12 @@ export interface Network {
   lowProcessingTime: string;
   highProcessingTime: string;
   avgProcessingTime: string;
+  code: string;
+  networkName: string;
+  isEnsAvailable: boolean;
+  crypto_paymentIdName: string;
+  cryptoExplorer: string;
+  contractAddress: string;
+  isMultichain: boolean;
+  assetId: Map<string, string>;
 }

lib/models/Transactions.ts

@@ -6,6 +6,7 @@ export interface Transaction {
   subtype: string;
   createdAt: string;
   updatedAt: string;
+  lastActivityAt: string;
   native: NativeTransaction;
   commitRisk: CommitRisk;
 }

lib/websocket/walletClient.ts

@@ -2,6 +2,7 @@ import { AuthClient } from "./authClient";
 import { Balance, Transaction } from "../models";
 import {
   NOTIFICATION_TYPE,
+  ORDER_BY,
   SORT,
   SORT_BY,
   TRANSACTION_STATUS,
@@ -94,11 +95,11 @@ export class WalletClient extends AuthClient {
    * @param {TRANSACTION_TYPE[]} [params.transactionTypes] Optional. List of types to query. valid types are: 'DEPOSIT', 'WITHDRAW', 'TRANSFER' and 'SWAP'
    * @param {TRANSACTION_SUBTYPE[]} [params.transactionSubtyes] Optional. List of subtypes to query. valid subtypes are: 'UNCLASSIFIED', 'BLOCKCHAIN', 'AIRDROP', 'AFFILIATE', 'STAKING', 'BUY_CRYPTO', 'OFFCHAIN', 'FIAT', 'SUB_ACCOUNT', 'WALLET_TO_SPOT', 'SPOT_TO_WALLET', 'WALLET_TO_DERIVATIVES', 'DERIVATIVES_TO_WALLET', 'CHAIN_SWITCH_FROM', 'CHAIN_SWITCH_TO' and 'INSTANT_EXCHANGE'
    * @param {TRANSACTION_STATUS[]} [params.transactionStatuses] Optional. List of statuses to query. valid subtypes are: 'CREATED', 'PENDING', 'FAILED', 'SUCCESS' and 'ROLLED_BACK'
-   * @param {string} [params.from] Optional. Interval initial value when ordering by 'createdAt'. As Datetime
-   * @param {string} [params.till] Optional. Interval end value when ordering by 'createdAt'. As Datetime
+   * @param {string} [params.from] Optional. Interval initial value (inclusive). The value type depends on order_by.
+   * @param {string} [params.till] Optional. Interval end value (inclusive). The value type depends on order_by.
    * @param {string} [params.idFrom] Optional. Interval initial value when ordering by id. Min is 0
    * @param {string} [params.idTill] Optional. Interval end value when ordering by id. Min is 0
-   * @param {SORT_BY} [params.orderBy] Optional. sorting parameter.'createdAt' or 'id'. Default is 'createdAt'
+   * @param {ORDER_BY} [params.orderBy] Optional. Defines the sorting type.'CREATED_AT', 'updatedAt', 'last or 'id'. Default is 'createdAt'
    * @param {SORT} [params.sort] Optional. Sort direction. 'ASC' or 'DESC'. Default is 'DESC'
    * @param {number} [params.limit] Optional. Transactions per query. Defaul is 100. Max is 1000
    * @param {number} [params.offset] Optional. Default is 0. Max is 100000
@@ -115,7 +116,7 @@ export class WalletClient extends AuthClient {
     till?: string;
     idFrom?: number;
     idTill?: number;
-    orderBy?: SORT_BY;
+    orderBy?: ORDER_BY;
     sort?: SORT;
     limit?: number;
     offset?: number;

test/rest/changeCredentials.test.ts

@@ -0,0 +1,46 @@
+import assert from "assert";
+import "mocha";
+import { Client } from "../../lib/client";
+
+import { CONTINGENCY, ORDER_TYPE, SIDE, TIME_IN_FORCE } from "../../lib/constants";
+import {
+  SECOND,
+  timeout,
+  emptyList,
+  goodBalance,
+  goodList,
+  goodOrder,
+  goodTradingCommission,
+  listSize,
+} from "../testHelpers";
+const keys = require("../../../../keys.json");
+
+describe("change credentials test", () => {
+  let client = new Client(keys.apiKey, keys.apiSecret);
+  function sleep(ms: number) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+  }
+  const second = 1000;
+  beforeEach(async function () {
+    await sleep(second / 20);
+  });
+  describe("change credentials", () => {
+    it("spot balance", async function () {
+      this.timeout(0);
+      let balances = client.getWalletBalances();
+      assert((await balances).length > 0, "empty balances");
+      if (!goodList(goodOrder, balances)) assert(false, "not good balances");
+      client.changeCredentials("", "");
+      try {
+        balances = client.getWalletBalances();
+        assert(false, "should not fail");
+      } catch (CryptomarketSDKException) {
+
+      }
+      client.changeCredentials(keys.apiKey, keys.apiSecret);
+      balances = client.getWalletBalances();
+      assert((await balances).length > 0, "empty balances");
+      if (!goodList(goodOrder, balances)) assert(false, "not good balances");
+    });
+  });
+});

test/rest/changeWindow.test.ts

@@ -0,0 +1,46 @@
+import assert from "assert";
+import "mocha";
+import { Client } from "../../lib/client";
+
+import { CONTINGENCY, ORDER_TYPE, SIDE, TIME_IN_FORCE } from "../../lib/constants";
+import {
+  SECOND,
+  timeout,
+  emptyList,
+  goodBalance,
+  goodList,
+  goodOrder,
+  goodTradingCommission,
+  listSize,
+} from "../testHelpers";
+const keys = require("../../../../keys.json");
+
+describe("change window test", () => {
+  let client = new Client(keys.apiKey, keys.apiSecret);
+  function sleep(ms: number) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+  }
+  const second = 1000;
+  beforeEach(async function () {
+    await sleep(second / 20);
+  });
+  describe("change window", () => {
+    it("spot balance", async function () {
+      this.timeout(0);
+      let balances = client.getWalletBalances();
+      assert((await balances).length > 0, "empty balances");
+      if (!goodList(goodOrder, balances)) assert(false, "not good balances");
+      client.changeWindow(100);
+      try {
+        balances = client.getWalletBalances();
+        assert(false, "should not fail");
+      } catch (CryptomarketSDKException) {
+
+      }
+      client.changeWindow(10_000);
+      balances = client.getWalletBalances();
+      assert((await balances).length > 0, "empty balances");
+      if (!goodList(goodOrder, balances)) assert(false, "not good balances");
+    });
+  });
+});