refactor: rename methods

Author: Insmael

lib/client.ts

@@ -210,7 +210,7 @@ export class Client {
    *
    * @returns An object/dict of quotation prices of currencies, indexed by source currency code.
    */
-  getPricesHistory(params?: {
+  getPriceHistory(params?: {
     from?: string;
     to?: string;
     until?: string;
@@ -246,7 +246,7 @@ export class Client {
    * @param {string} symbol A symbol id.
    * @returns The ticker's last price of a symbol.
    */
-  getTickerLastPriceOfSymbol(symbol: string): Promise<Ticker> {
+  getTickerLastPrice(symbol: string): Promise<Ticker> {
     return this.get(`public/price/ticker/${symbol}`);
   }
 
@@ -300,7 +300,7 @@ export class Client {
    *
    * @return A list of trades of the symbol
    */
-  getTradesOfSymbol(
+  getTradesBySymbol(
     symbol: string,
     params?: {
       sort?: SORT;
@@ -350,7 +350,7 @@ export class Client {
    *
    * @return The order book of the symbol
    */
-  getOrderBookOfSymbol(symbol: string, depth?: number): Promise<OrderBook> {
+  getOrderBook(symbol: string, depth?: number): Promise<OrderBook> {
     return this.get(`public/orderbook/${symbol}`, { depth });
   }
 
@@ -433,7 +433,7 @@ export class Client {
    *
    * @return A list of candles of a symbol
    */
-  getCandlesOfSymbol(
+  getCandlesBySymbol(
     symbol: string,
     params?: {
       period?: PERIOD;
@@ -479,7 +479,7 @@ export class Client {
    *
    * @return the spot trading balance of a currency.
    */
-  async getSpotTradingBalanceOfCurrency(currency: string): Promise<Balance> {
+  async getSpotTradingBalance(currency: string): Promise<Balance> {
     const balance = await this.get(`spot/balance/${currency}`);
     balance.currency = currency;
     return balance;
@@ -774,7 +774,7 @@ export class Client {
    *
    * @return A list of wallet balances
    */
-  getWalletBalance(): Promise<Balance[]> {
+  getWalletBalances(): Promise<Balance[]> {
     return this.get("wallet/balance");
   }
 
@@ -789,7 +789,7 @@ export class Client {
    *
    * @return The wallet balance of the currency
    */
-  async getWalletBalanceOfCurrency(currency: string): Promise<Balance> {
+  async getWalletBalance(currency: string): Promise<Balance> {
     let balance = await this.get(`wallet/balance/${currency}`);
     balance.currency = currency;
     return balance;
@@ -977,7 +977,7 @@ Accepted values: never, optionally, required
   }
 
   /**
-   * Get an estimate of the withdrawal fee
+   * Get an estimate of a withdrawal fee
    *
    * Requires the "Payment information" API key Access Right.
    *

test/rest/market_data.test.ts

@@ -108,7 +108,7 @@ describe("Rest client test", () => {
   describe("Get Prices History", () => {
     it("for all currencies as origin", async function () {
       this.timeout(0);
-      let pricesHistory = await client.getPricesHistory({
+      let pricesHistory = await client.getPriceHistory({
         to: "ETH",
         period: PERIOD._15_MINUTES,
       });
@@ -120,7 +120,7 @@ describe("Rest client test", () => {
     });
     it("for one currency pair", async function () {
       this.timeout(0);
-      let pricesHistory = await client.getPricesHistory({
+      let pricesHistory = await client.getPriceHistory({
         to: "ETH",
         from: "BTC",
         period: PERIOD._15_MINUTES,
@@ -149,7 +149,7 @@ describe("Rest client test", () => {
   describe("Get Ticker Price Of Symbol", () => {
     it("", async function () {
       this.timeout(0);
-      let price = await client.getTickerLastPriceOfSymbol("EOSETH");
+      let price = await client.getTickerLastPrice("EOSETH");
       assert(goodTickerPrice(price), "not a good ticker price");
     });
   });
@@ -179,7 +179,7 @@ describe("Rest client test", () => {
   describe("Get Trades of symbol", () => {
     it("", async function () {
       this.timeout(0);
-      let trades = await client.getTradesOfSymbol("EOSETH");
+      let trades = await client.getTradesBySymbol("EOSETH");
       assert(!emptyList(trades), "empty dict of trades");
       assert(goodList(goodPublicTrade, trades), "not good trades");
     });
@@ -202,7 +202,7 @@ describe("Rest client test", () => {
   describe("Get Order book of symbol", () => {
     it("", async function () {
       this.timeout(0);
-      let orderBook = await client.getOrderBookOfSymbol("EOSETH");
+      let orderBook = await client.getOrderBook("EOSETH");
       assert(goodOrderbook(orderBook), "not good orderbook");
     });
   });
@@ -243,7 +243,7 @@ describe("Rest client test", () => {
   describe("Get candles Of Symbol", () => {
     it("with period and limit", async function () {
       this.timeout(0);
-      let candles = await client.getCandlesOfSymbol("ADAETH", {
+      let candles = await client.getCandlesBySymbol("ADAETH", {
         period: PERIOD._30_MINUTES,
         limit: 2,
       });

test/rest/spot_trading.test.ts

@@ -34,7 +34,7 @@ describe("spot trading", () => {
   describe("get spot trading balance of currency", () => {
     it("", async function () {
       this.timeout(0);
-      let balance = await client.getSpotTradingBalanceOfCurrency("ADA");
+      let balance = await client.getSpotTradingBalance("ADA");
       assert(goodBalance(balance), "not good balance");
     });
   });

test/rest/wallet_management.test.ts

@@ -11,6 +11,7 @@ import {
   goodList,
   goodTransaction,
 } from "../test_helpers";
+import { Address } from "../../lib/models";
 const keys = require("/home/ismael/cryptomarket/keys.json");
 
 describe("wallet management", () => {
@@ -25,14 +26,14 @@ describe("wallet management", () => {
   describe("Get wallet balance", () => {
     it("", async function () {
       this.timeout(0);
-      let balances = await client.getWalletBalance();
+      let balances = await client.getWalletBalances();
       assert(goodList(goodBalance, balances), "not good balance");
     });
   });
   describe("get wallet balance of currency", () => {
     it("", async function () {
       this.timeout(0);
-      let balance = await client.getWalletBalanceOfCurrency("ADA");
+      let balance = await client.getWalletBalance("ADA");
       assert(goodBalance(balance), "not good balance");
     });
   });
@@ -55,7 +56,7 @@ describe("wallet management", () => {
       this.timeout(0);
       let oldAddress = await client.getDepositCryptoAddress("EOS");
       let newAddres = await client.createDepositCryptoAddress("EOS");
-      assert(oldAddress.address !== newAddres.address, "not a new address");
+      assert(!sameAddress(oldAddress, newAddres), "not a new address");
       assert(goodAddress(newAddres), "not good address");
     });
   });
@@ -178,7 +179,7 @@ describe("wallet management", () => {
     it("", async function () {
       this.timeout(0);
       // original wallet amount
-      let startingADAInWallet = await client.getWalletBalanceOfCurrency("ADA");
+      let startingADAInWallet = await client.getWalletBalance("ADA");
       // transfer to spot
       let transactionID = await client.transferBetweenWalletAndExchange({
         source: ACCOUNT.WALLET,
@@ -198,7 +199,7 @@ describe("wallet management", () => {
       assert(transactionID !== "", "not good identifier of transfer to wallet");
 
       // end wallet amount
-      let endADAInWallet = await client.getWalletBalanceOfCurrency("ADA");
+      let endADAInWallet = await client.getWalletBalance("ADA");
       assert(
         startingADAInWallet.available === endADAInWallet.available,
         "not good tranfer"
@@ -238,3 +239,8 @@ describe("wallet management", () => {
     });
   });
 });
+function sameAddress(oldAddress: Address, newAddres: Address) {
+  return oldAddress.address === newAddres.address && oldAddress.currency && newAddres.currency
+    && oldAddress.payment_id === newAddres.payment_id && oldAddress.public_key === oldAddress.public_key
+}
+