@covalenthq/client-sdk 0.6.1 → 0.6.2

package/README.md

@@ -97,6 +97,16 @@ The `BalanceService` class refers to the [balances API endpoints](https://www.co
 - `getTokenHoldersV2ForTokenAddressByPage()`: Get a list of all the token holders for a specified ERC20 or ERC721 token. Returns historic token holders when block-height is set (defaults to latest). Useful for building pie charts of token holders. (Nonpaginated)
 - `getNativeTokenBalance()`: Get the native token balance for an address. This endpoint is required because native tokens are usually not ERC20 tokens and sometimes you want something lightweight.
 
+The `calculatePrettyBalance` function is designed to take up to 4 inputs: the `balance` field obtained from the `tokenBalance` endpoint and the `contract_decimals`. The function also includes two optional fields, `roundOff` and `precision`, to allow developers to round the unscaled balance to a certain decimal precision. The primary purpose of this function is to convert the scaled token balance (the balance parameter) into its unscaled, human-readable form. The scaled balance needs to be divided by 10^(contractDecimals) to remove the scaling factor.
+
+```ts
+import { CovalentClient, calculatePrettyBalance } 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 prettyBalance = calculatePrettyBalance(resp.data.items[0].balance, resp.data.items[0].contract_decimals);
+```
+
 ### 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

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

package/dist/cjs/index.js

@@ -2,6 +2,7 @@
 
 var chalk = require('chalk');
 var dateFns = require('date-fns');
+var Big = require('big.js');
 
 const DEFAULT_BACKOFF_MAX_RETRIES = 5;
 const BASE_DELAY_MS = 1000; // Base delay in milliseconds
@@ -5867,7 +5868,7 @@ class XykService {
     }
 }
 
-const userAgent = "com.covalenthq.sdk.typescript/0.6.1";
+const userAgent = "com.covalenthq.sdk.typescript/0.6.2";
 /**
  * CovalentClient Class
  */
@@ -5902,6 +5903,28 @@ class Client {
     }
 }
 
+const calculatePrettyBalance = (value, decimals = 18, roundOff = true, precision = 0) => {
+    const bigIntValue = BigInt(value);
+    const bigDecimalValue = new Big(bigIntValue.toString());
+    const _decimals = decimals || 18;
+    const _expoValue = BigInt(Math.pow(10, _decimals));
+    const bigDecimalExpo = new Big(_expoValue.toString());
+    const _calculated = bigDecimalValue.div(bigDecimalExpo);
+    // removes the decimal places, true by default so it adds decimals
+    if (!roundOff) {
+        return _calculated.toString();
+    }
+    let _decimalFixed = precision;
+    if (precision === 0) {
+        _decimalFixed = 2;
+        if (_calculated.lt(100)) {
+            _decimalFixed = 6;
+        }
+    }
+    return _calculated.toFixed(_decimalFixed);
+};
+
 exports.Client = Client;
 exports.CovalentClient = CovalentClient;
+exports.calculatePrettyBalance = calculatePrettyBalance;
 //# sourceMappingURL=index.js.map