@covalenthq/client-sdk 0.6.4 → 0.6.5

package/README.md

@@ -107,6 +107,16 @@ const resp = await client.BalanceService.getTokenBalancesForWalletAddress("eth-m
 const prettyBalance = calculatePrettyBalance(resp.data.items[0].balance, resp.data.items[0].contract_decimals);
 ```
 
+The `prettifyCurrency` function refines the presentation of a monetary value, accepting a numerical amount and a fiat currency code as parameters (with USD as the default currency). It simplifies currency formatting for developers, ensuring visually polished representations of financial information in user interfaces for an enhanced user experience.
+
+```ts
+import { CovalentClient, prettifyCurrency } from "@covalenthq/client-sdk";
+
+const client = new CovalentClient("YOUR_API_KEY"); // Replace with your Covalent API key.
+const resp = await client.BalanceService.getTokenBalancesForWalletAddress("eth-mainnet", "WALLET_ADDRESS");
+const prettyCurrency = prettifyCurrency(resp.data.items[0].quote_rate);
+```
+
 ### BaseService
 
 The `BaseService` class refers to the [address activity, log events, chain status and block retrieval API endpoints](https://www.covalenthq.com/docs/api/base/get-address-activity/):

package/dist/cjs/index.d.ts

@@ -8,3 +8,4 @@ export * from "./util/types/XykServiceTypes";
 export * from "./util/types/GenericTypes";
 export * from "./util/types/TransactionServiceTypes";
 export { calculatePrettyBalance } from "./util/CalculatePrettyBalance";
+export { prettifyCurrency } from "./util/prettifyCurrency";

package/dist/cjs/index.js

@@ -6248,7 +6248,7 @@ class XykService {
     }
 }
 
-const userAgent = "com.covalenthq.sdk.typescript/0.6.4";
+const userAgent = "com.covalenthq.sdk.typescript/0.6.5";
 /**
  * CovalentClient Class
  */
@@ -6311,7 +6311,77 @@ const calculatePrettyBalance = (value, decimals = 18, roundOff = true, precision
     return _calculated.toFixed(_decimalFixed);
 };
 
+const LESS_THAN_ZERO = "0.01";
+const ZERO = "0.00";
+const currencyMap = new Map([
+    ["USD", "$"],
+    ["CAD", "CA$"],
+    ["EUR", "€"],
+    ["SGD", "S$"],
+    ["INR", "₹"],
+    ["JPY", "¥"],
+    ["VND", "₫"],
+    ["CNY", "CN¥"],
+    ["KRW", "₩"],
+    ["RUB", "₽"],
+    ["TRY", "₺"],
+    ["NGN", "₦"],
+    ["ARS", "ARS"],
+    ["AUD", "A$"],
+    ["CHF", "CHF"],
+    ["GBP", "£"],
+]);
+const prettifyCurrency = (value, decimals = 2, currency = "USD", ignoreSmallValue = false, ignoreMinus = true, ignoreZero = false) => {
+    if (typeof value === "string") {
+        value = Number(value);
+    }
+    let minus = "";
+    let currencySuffix = "";
+    // pass ignoreMinus false to get the negative number for currency formatter
+    if (!ignoreMinus && value < 0) {
+        value = Math.abs(value);
+        minus = "-";
+    }
+    if (value === 0 || !value) {
+        // if value is 0, pass ignoreZero true to get this string "<$0.01"
+        if (ignoreZero) {
+            return "<" + currencyMap.get(currency) + LESS_THAN_ZERO;
+        }
+        else {
+            return currencyMap.get(currency) + ZERO;
+        }
+    }
+    else if (value < 0 || value < 1) {
+        if (value < 0.01 && ignoreSmallValue) {
+            return "<" + currencyMap.get(currency) + LESS_THAN_ZERO;
+        }
+    }
+    else if (value > 999999999) {
+        value = value / 1000000000;
+        currencySuffix = "B";
+    }
+    else if (value > 999999) {
+        value = value / 1000000; // convert to M for number from > 1 million
+        currencySuffix = "M";
+    }
+    // Added to round down the number
+    const expo = Math.pow(10, decimals);
+    value = Math.floor(value * expo) / expo;
+    // generates the value with the inputted currency
+    const formatter = new Intl.NumberFormat('en-US', {
+        style: 'currency',
+        currency: currency,
+        maximumFractionDigits: decimals,
+        currencyDisplay: "symbol"
+    });
+    //replace the occasional incorrect currency symbol from the formatter and replace with correct symbol from currencyMap
+    const regex = new RegExp(`${currency}\\s?`);
+    const _val = formatter.format(value).replace(regex, currencyMap.get(currency) ?? "$");
+    return minus + _val + currencySuffix;
+};
+
 exports.Client = Client;
 exports.CovalentClient = CovalentClient;
 exports.calculatePrettyBalance = calculatePrettyBalance;
+exports.prettifyCurrency = prettifyCurrency;
 //# sourceMappingURL=index.js.map