@mento-protocol/mento-sdk 1.11.0 → 1.13.0

package/dist/esm/utils.d.ts

@@ -26,6 +26,20 @@ export declare function validateSignerOrProvider(signerOrProvider: Signer | prov
  * @returns the symbol of the erc20 token
  */
 export declare function getSymbolFromTokenAddress(tokenAddr: Address, signerOrProvider: Signer | providers.Provider): Promise<string>;
+/**
+ * Returns the name of an erc20 token
+ * @param tokenAddr the address of the erc20 token
+ * @param signerOrProvider an ethers provider or signer
+ * @returns the name of the erc20 token
+ */
+export declare function getNameFromTokenAddress(tokenAddr: Address, signerOrProvider: Signer | providers.Provider): Promise<string>;
+/**
+ * Returns the decimals of an erc20 token
+ * @param tokenAddr the address of the erc20 token
+ * @param signerOrProvider an ethers provider or signer
+ * @returns the decimals of the erc20 token
+ */
+export declare function getDecimalsFromTokenAddress(tokenAddr: Address, signerOrProvider: Signer | providers.Provider): Promise<number>;
 /**
  * Returns a populated tx obj for increasing the allowance of a spender for a given erc20 token by a given amount
  * @param tokenAddr the address of the erc20 token
@@ -41,5 +55,5 @@ export declare function increaseAllowance(tokenAddr: string, spender: string, am
  * @param symbol the token symbol to find (case-insensitive)
  * @returns the token address if found, null otherwise
  */
-export declare function findTokenBySymbol(pairs: readonly TradablePair[], symbol: string): string | null;
+export declare function findTokenBySymbolInTradablePairs(pairs: readonly TradablePair[], symbol: string): string | null;
 export declare function capitalize(str: string): string;

package/dist/esm/utils.js

@@ -62,6 +62,32 @@ export function getSymbolFromTokenAddress(tokenAddr, signerOrProvider) {
         return contract.symbol();
     });
 }
+/**
+ * Returns the name of an erc20 token
+ * @param tokenAddr the address of the erc20 token
+ * @param signerOrProvider an ethers provider or signer
+ * @returns the name of the erc20 token
+ */
+export function getNameFromTokenAddress(tokenAddr, signerOrProvider) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const erc20Abi = ['function name() external view returns (string memory)'];
+        const contract = new Contract(tokenAddr, erc20Abi, signerOrProvider);
+        return contract.name();
+    });
+}
+/**
+ * Returns the decimals of an erc20 token
+ * @param tokenAddr the address of the erc20 token
+ * @param signerOrProvider an ethers provider or signer
+ * @returns the decimals of the erc20 token
+ */
+export function getDecimalsFromTokenAddress(tokenAddr, signerOrProvider) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const erc20Abi = ['function decimals() external view returns (uint8)'];
+        const contract = new Contract(tokenAddr, erc20Abi, signerOrProvider);
+        return contract.decimals();
+    });
+}
 /**
  * Returns a populated tx obj for increasing the allowance of a spender for a given erc20 token by a given amount
  * @param tokenAddr the address of the erc20 token
@@ -87,7 +113,7 @@ export function increaseAllowance(tokenAddr, spender, amount, signerOrProvider)
  * @param symbol the token symbol to find (case-insensitive)
  * @returns the token address if found, null otherwise
  */
-export function findTokenBySymbol(pairs, symbol) {
+export function findTokenBySymbolInTradablePairs(pairs, symbol) {
     for (const pair of pairs) {
         for (const asset of pair.assets) {
             if (asset.symbol.toLowerCase() === symbol.toLowerCase()) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mento-protocol/mento-sdk",
   "description": "Official SDK for interacting with the Mento Protocol",
-  "version": "1.11.0",
+  "version": "1.13.0",
   "license": "MIT",
   "author": "Mento Labs",
   "keywords": [
@@ -33,6 +33,7 @@
     "test": "jest --runInBand --verbose",
     "coverage": "jest --coverage",
     "cacheTradablePairs": "ts-node scripts/cacheTradablePairs.ts",
+    "cacheTokens": "ts-node scripts/cacheTokens/index.ts",
     "printTradablePairs": "ts-node scripts/printTradablePairs.ts",
     "tradingLimits": "ts-node scripts/printTradingLimits.ts",
     "limits": "yarn tradingLimits",
@@ -41,7 +42,8 @@
     "breakerBox": "ts-node scripts/printBreakerBox.ts",
     "breakers": "yarn breakerBox",
     "quote": "ts-node scripts/quotes/index.ts",
-    "getTokenGraph": "ts-node scripts/visualizeTokenGraph.ts"
+    "getTokenGraph": "ts-node scripts/visualizeTokenGraph.ts",
+    "tokens": "ts-node scripts/printTokens.ts"
   },
   "husky": {
     "hooks": {