@strkfarm/sdk 2.0.0-dev.9 → 2.0.0-staging.2

package/src/global.ts

@@ -4,212 +4,200 @@ import { ContractAddr } from "./dataTypes";
 import { logger } from "@/utils/logger";
 
 export class FatalError extends Error {
-  constructor(message: string, err?: Error) {
-    super(message);
-    logger.error(message);
-    if (err) logger.error(err.message);
-    this.name = "FatalError";
-  }
+    constructor(message: string, err?: Error) {
+        super(message);
+        logger.error(message);
+        if (err) logger.error(err.message);
+        this.name = "FatalError";
+    }
 }
 
 const defaultTokens: TokenInfo[] = [
-  {
-    name: "Starknet",
-    symbol: "STRK",
-    logo: "https://assets.troves.fi/integrations/tokens/strk.svg",
-    address: ContractAddr.from(
-      "0x4718f5a0fc34cc1af16a1cdee98ffb20c31f5cd61d6ab07201858f4287c938d"
-    ),
-    decimals: 18,
-    coingeckId: "starknet",
-    displayDecimals: 2,
-    priceCheckAmount: 1000,
-  },
-  {
-    name: "xSTRK",
-    symbol: "xSTRK",
-    logo: "https://assets.troves.fi/integrations/tokens/xstrk.svg",
-    address: ContractAddr.from(
-      "0x028d709c875c0ceac3dce7065bec5328186dc89fe254527084d1689910954b0a"
-    ),
-    decimals: 18,
-    coingeckId: undefined,
-    priceCheckAmount: 1000,
-    displayDecimals: 2,
-  },
-  {
-    name: "ETH",
-    symbol: "ETH",
-    logo: "https://assets.troves.fi/integrations/tokens/eth.svg",
-    address: ContractAddr.from(
-      "0x49d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7"
-    ),
-    decimals: 18,
-    coingeckId: undefined,
-    priceCheckAmount: 0.1,
-    displayDecimals: 6,
-  },
-  {
-    name: "USDCe",
-    symbol: "USDCe",
-    logo: "https://assets.troves.fi/integrations/tokens/usdc.svg",
-    address: ContractAddr.from(
-      "0x53c91253bc9682c04929ca02ed00b3e423f6710d2ee7e0d5ebb06f3ecf368a8"
-    ),
-    decimals: 6,
-    coingeckId: undefined,
-    displayDecimals: 2,
-    priceCheckAmount: 1000,
-  },
-  {
-    name: "USDT",
-    symbol: "USDT",
-    logo: "https://assets.troves.fi/integrations/tokens/usdt.svg",
-    address: ContractAddr.from(
-      "0x68f5c6a61780768455de69077e07e89787839bf8166decfbf92b645209c0fb8"
-    ),
-    decimals: 6,
-    coingeckId: undefined,
-    priceCheckAmount: 1000,
-    displayDecimals: 2,
-  },
-  {
-    name: "WBTC",
-    symbol: "WBTC",
-    logo: "https://assets.troves.fi/integrations/tokens/wbtc.svg",
-    address: ContractAddr.from(
-      "0x03fe2b97c1fd336e750087d68b9b867997fd64a2661ff3ca5a7c771641e8e7ac"
-    ),
-    decimals: 8,
-    coingeckId: undefined,
-    displayDecimals: 6,
-    priceCheckAmount: 0.001, // 112000 * 0.0001 = $110.2
-  },
-  {
-    name: "tBTC",
-    symbol: "tBTC",
-    logo: "https://assets.strkfarm.com/integrations/tokens/tbtc.svg",
-    address: ContractAddr.from(
-      "0x4daa17763b286d1e59b97c283c0b8c949994c361e426a28f743c67bdfe9a32f"
-    ),
-    decimals: 18,
-    coingeckId: undefined,
-    displayDecimals: 6,
-    priceCheckAmount: 0.001, // 112000 * 0.0001 = $110.2
-  },
-  {
-    name: "solvBTC",
-    symbol: "solvBTC",
-    logo: "https://assets.strkfarm.com/integrations/tokens/solvbtc.svg",
-    address: ContractAddr.from(
-      "0x0593e034dda23eea82d2ba9a30960ed42cf4a01502cc2351dc9b9881f9931a68"
-    ),
-    decimals: 18,
-    coingeckId: undefined,
-    priceProxySymbol: "WBTC",
-    displayDecimals: 6,
-    priceCheckAmount: 0.0001, // 112000 * 0.0001 = $11.2
-  },
-  {
-    name: "LBTC",
-    symbol: "LBTC",
-    logo: "https://assets.strkfarm.com/integrations/tokens/lbtc.svg",
-    address: ContractAddr.from(
-      "0x036834a40984312f7f7de8d31e3f6305b325389eaeea5b1c0664b2fb936461a4"
-    ),
-    decimals: 8,
-    coingeckId: undefined,
-    displayDecimals: 6,
-    priceProxySymbol: "WBTC",
-    priceCheckAmount: 0.0001, // 112000 * 0.0001 = $11.2
-  },
-  {
-    name: "xWBTC",
-    symbol: "xWBTC",
-    logo: "https://assets.strkfarm.com/integrations/tokens/xwbtc.svg",
-    address: ContractAddr.from(
-      "0x6a567e68c805323525fe1649adb80b03cddf92c23d2629a6779f54192dffc13"
-    ),
-    decimals: 8,
-    coingeckId: undefined,
-    displayDecimals: 6,
-    priceCheckAmount: 0.001, // 112000 * 0.0001 = $110.2
-  },
-  {
-    name: "xsBTC",
-    symbol: "xsBTC",
-    logo: "https://assets.strkfarm.com/integrations/tokens/xsbtc_solv.svg",
-    address: ContractAddr.from(
-      "0x580f3dc564a7b82f21d40d404b3842d490ae7205e6ac07b1b7af2b4a5183dc9"
-    ),
-    decimals: 18,
-    coingeckId: undefined,
-    displayDecimals: 6,
-    priceProxySymbol: "WBTC",
-    priceCheckAmount: 0.0001, // 112000 * 0.0001 = $11.2
-  },
-  {
-    // todo upgrade proxy tokens once feeds are available
-    name: "xtBTC",
-    symbol: "xtBTC",
-    logo: "https://assets.strkfarm.com/integrations/tokens/xtbtc.svg",
-    address: ContractAddr.from(
-      "0x43a35c1425a0125ef8c171f1a75c6f31ef8648edcc8324b55ce1917db3f9b91"
-    ),
-    decimals: 18,
-    coingeckId: undefined,
-    displayDecimals: 6,
-    priceCheckAmount: 0.001, // 112000 * 0.0001 = $110.2
-  },
-  {
-    name: "xLBTC",
-    symbol: "xLBTC",
-    logo: "https://assets.strkfarm.com/integrations/tokens/xlbtc.svg",
-    address: ContractAddr.from(
-      "0x07dd3c80de9fcc5545f0cb83678826819c79619ed7992cc06ff81fc67cd2efe0"
-    ),
-    decimals: 8,
-    coingeckId: undefined,
-    displayDecimals: 6,
-    priceProxySymbol: "WBTC",
-    priceCheckAmount: 0.0001, // 112000 * 0.0001 = $11.2
-  },
-  {
-    name: "mRe7BTC",
-    symbol: "mRe7BTC",
-    logo: "https://imagedelivery.net/0xPAQaDtnQhBs8IzYRIlNg/3a62ecee-1e58-45d3-9862-3ce90dff1900/logo",
-    address: ContractAddr.from(
-      "0x4e4fb1a9ca7e84bae609b9dc0078ad7719e49187ae7e425bb47d131710eddac"
-    ),
-    decimals: 18,
-    coingeckId: undefined,
-    displayDecimals: 6,
-    priceCheckAmount: 0.0001, // 112000 * 0.0001 = $11.2
-  },
-  {
-    name: "mRe7YIELD",
-    symbol: "mRe7YIELD",
-    logo: "https://midas.app/assets/mre7-BcOOHm7i.svg",
-    address: ContractAddr.from(
-      "0x4be8945e61dc3e19ebadd1579a6bd53b262f51ba89e6f8b0c4bc9a7e3c633fc"
-    ),
-    decimals: 18,
-    coingeckId: undefined,
-    displayDecimals: 2,
-    priceCheckAmount: 100,
-  },
-  {
-    name: "USDC",
-    symbol: "USDC",
-    logo: "https://assets.troves.fi/integrations/tokens/usdc.svg",
-    address: ContractAddr.from(
-      "0x033068f6539f8e6e6b131e6b2b814e6c34a5224bc66947c47dab9dfee93b35fb"
-    ),
-    decimals: 6,
-    coingeckId: undefined,
-    displayDecimals: 2,
-    priceCheckAmount: 100,
-  },
+    {
+        name: "Starknet",
+        symbol: "STRK",
+        logo: "https://assets.troves.fi/integrations/tokens/strk.svg",
+        address: ContractAddr.from(
+            "0x4718f5a0fc34cc1af16a1cdee98ffb20c31f5cd61d6ab07201858f4287c938d"
+        ),
+        decimals: 18,
+        coingeckId: "starknet",
+        displayDecimals: 2,
+        priceCheckAmount: 1000
+    },
+    {
+        name: "xSTRK",
+        symbol: "xSTRK",
+        logo: "https://assets.troves.fi/integrations/tokens/xstrk.svg",
+        address: ContractAddr.from(
+            "0x028d709c875c0ceac3dce7065bec5328186dc89fe254527084d1689910954b0a"
+        ),
+        decimals: 18,
+        coingeckId: undefined,
+        priceCheckAmount: 1000,
+        displayDecimals: 2
+    },
+    {
+        name: "ETH",
+        symbol: "ETH",
+        logo: "https://assets.troves.fi/integrations/tokens/eth.svg",
+        address: ContractAddr.from(
+            "0x49d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7"
+        ),
+        decimals: 18,
+        coingeckId: undefined,
+        priceCheckAmount: 0.1,
+        displayDecimals: 6
+    },
+    {
+        name: "USDC",
+        symbol: "USDC",
+        logo: "https://assets.troves.fi/integrations/tokens/usdc.svg",
+        address: ContractAddr.from(
+            "0x53c91253bc9682c04929ca02ed00b3e423f6710d2ee7e0d5ebb06f3ecf368a8"
+        ),
+        decimals: 6,
+        coingeckId: undefined,
+        displayDecimals: 2,
+        priceCheckAmount: 1000
+    },
+    {
+        name: "USDT",
+        symbol: "USDT",
+        logo: "https://assets.troves.fi/integrations/tokens/usdt.svg",
+        address: ContractAddr.from(
+            "0x68f5c6a61780768455de69077e07e89787839bf8166decfbf92b645209c0fb8"
+        ),
+        decimals: 6,
+        coingeckId: undefined,
+        priceCheckAmount: 1000,
+        displayDecimals: 2
+    },
+    {
+        name: "WBTC",
+        symbol: "WBTC",
+        logo: "https://assets.troves.fi/integrations/tokens/wbtc.svg",
+        address: ContractAddr.from(
+            "0x03fe2b97c1fd336e750087d68b9b867997fd64a2661ff3ca5a7c771641e8e7ac"
+        ),
+        decimals: 8,
+        coingeckId: undefined,
+        displayDecimals: 6,
+        priceCheckAmount: 0.001 // 112000 * 0.0001 = $110.2
+    },
+    {
+        name: "tBTC",
+        symbol: "tBTC",
+        logo: "https://assets.strkfarm.com/integrations/tokens/tbtc.svg",
+        address: ContractAddr.from(
+            "0x4daa17763b286d1e59b97c283c0b8c949994c361e426a28f743c67bdfe9a32f"
+        ),
+        decimals: 18,
+        coingeckId: undefined,
+        displayDecimals: 6,
+        priceCheckAmount: 0.001 // 112000 * 0.0001 = $110.2
+    },
+    {
+        name: "solvBTC",
+        symbol: "solvBTC",
+        logo: "https://assets.strkfarm.com/integrations/tokens/solvbtc.svg",
+        address: ContractAddr.from(
+            "0x0593e034dda23eea82d2ba9a30960ed42cf4a01502cc2351dc9b9881f9931a68"
+        ),
+        decimals: 18,
+        coingeckId: undefined,
+        priceProxySymbol: "WBTC",
+        displayDecimals: 6,
+        priceCheckAmount: 0.0001 // 112000 * 0.0001 = $11.2
+    },
+    {
+        name: "LBTC",
+        symbol: "LBTC",
+        logo: "https://assets.strkfarm.com/integrations/tokens/lbtc.svg",
+        address: ContractAddr.from(
+            "0x036834a40984312f7f7de8d31e3f6305b325389eaeea5b1c0664b2fb936461a4"
+        ),
+        decimals: 8,
+        coingeckId: undefined,
+        displayDecimals: 6,
+        priceProxySymbol: "WBTC",
+        priceCheckAmount: 0.0001 // 112000 * 0.0001 = $11.2
+    },
+    {
+        name: "xWBTC",
+        symbol: "xWBTC",
+        logo: "https://assets.strkfarm.com/integrations/tokens/xwbtc.svg",
+        address: ContractAddr.from(
+            "0x6a567e68c805323525fe1649adb80b03cddf92c23d2629a6779f54192dffc13"
+        ),
+        decimals: 8,
+        coingeckId: undefined,
+        displayDecimals: 6,
+        priceCheckAmount: 0.001 // 112000 * 0.0001 = $110.2
+    },
+    {
+        name: "xsBTC",
+        symbol: "xsBTC",
+        logo: "https://assets.strkfarm.com/integrations/tokens/xsbtc_solv.svg",
+        address: ContractAddr.from(
+            "0x580f3dc564a7b82f21d40d404b3842d490ae7205e6ac07b1b7af2b4a5183dc9"
+        ),
+        decimals: 18,
+        coingeckId: undefined,
+        displayDecimals: 6,
+        priceProxySymbol: "WBTC",
+        priceCheckAmount: 0.0001 // 112000 * 0.0001 = $11.2
+    },
+    {
+        // todo upgrade proxy tokens once feeds are available
+        name: "xtBTC",
+        symbol: "xtBTC",
+        logo: "https://assets.strkfarm.com/integrations/tokens/xtbtc.svg",
+        address: ContractAddr.from(
+            "0x43a35c1425a0125ef8c171f1a75c6f31ef8648edcc8324b55ce1917db3f9b91"
+        ),
+        decimals: 18,
+        coingeckId: undefined,
+        displayDecimals: 6,
+        priceCheckAmount: 0.001 // 112000 * 0.0001 = $110.2
+    },
+    {
+        name: "xLBTC",
+        symbol: "xLBTC",
+        logo: "https://assets.strkfarm.com/integrations/tokens/xlbtc.svg",
+        address: ContractAddr.from(
+            "0x07dd3c80de9fcc5545f0cb83678826819c79619ed7992cc06ff81fc67cd2efe0"
+        ),
+        decimals: 8,
+        coingeckId: undefined,
+        displayDecimals: 6,
+        priceProxySymbol: "WBTC",
+        priceCheckAmount: 0.0001 // 112000 * 0.0001 = $11.2
+    },
+    {
+        name: "mRe7BTC",
+        symbol: "mRe7BTC",
+        logo: "https://imagedelivery.net/0xPAQaDtnQhBs8IzYRIlNg/3a62ecee-1e58-45d3-9862-3ce90dff1900/logo",
+        address: ContractAddr.from(
+            "0x4e4fb1a9ca7e84bae609b9dc0078ad7719e49187ae7e425bb47d131710eddac"
+        ),
+        decimals: 18,
+        coingeckId: undefined,
+        displayDecimals: 6,
+        priceCheckAmount: 0.0001 // 112000 * 0.0001 = $11.2
+    },
+    {
+        name: "mRe7YIELD",
+        symbol: "mRe7YIELD",
+        logo: "https://midas.app/assets/mre7-BcOOHm7i.svg",
+        address: ContractAddr.from(
+            "0x4be8945e61dc3e19ebadd1579a6bd53b262f51ba89e6f8b0c4bc9a7e3c633fc"
+        ),
+        decimals: 18,
+        coingeckId: undefined,
+        displayDecimals: 2,
+        priceCheckAmount: 100
+    }
 ];
 const tokens: TokenInfo[] = defaultTokens;
 
@@ -217,106 +205,126 @@ const tokens: TokenInfo[] = defaultTokens;
  * - fatalError: Things to do when a fatal error occurs
  */
 export class Global {
-  static cache: Record<string, { value: any; ttl: number; timestamp: number }> =
-    {};
+    static cache: Record<
+        string,
+        { value: any; ttl: number; timestamp: number }
+    > = {};
 
-  static fatalError(message: string, err?: Error) {
-    logger.error(message);
-    console.error(message, err);
-    if (err) console.error(err);
-    process.exit(1);
-  }
+    static fatalError(message: string, err?: Error) {
+        logger.error(message);
+        console.error(message, err);
+        if (err) console.error(err);
+        process.exit(1);
+    }
 
-  static httpError(url: string, err: Error, message?: string) {
-    logger.error(`${url}: ${message}`);
-    console.error(err);
-  }
+    static httpError(url: string, err: Error, message?: string) {
+        logger.error(`${url}: ${message}`);
+        console.error(err);
+    }
 
-  static getDefaultTokens() {
-    return tokens;
-  }
+    static getDefaultTokens() {
+        return tokens;
+    }
 
-  static async getTokens(): Promise<TokenInfo[]> {
-    if (tokens.length) return tokens;
+    static async getTokens(): Promise<TokenInfo[]> {
+        if (tokens.length) return tokens;
 
-    // fetch from avnu API
-    const data = await axios.get(
-      "https://assets.troves.fi/integrations/tokens.json"
-    );
-    const tokensData = data.data.content;
+        // fetch from avnu API
+        const data = await axios.get(
+            "https://assets.troves.fi/integrations/tokens.json"
+        );
+        const tokensData = data.data.content;
 
-    // Array of the following is returned
-    // {
-    //     "name": "USD Coin",
-    //     "address": "0x53c91253bc9682c04929ca02ed00b3e423f6710d2ee7e0d5ebb06f3ecf368a8",
-    //     "symbol": "USDC",
-    //     "decimals": 6,
-    //     "logoUri": "https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/ethereum/assets/0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48/logo.png",
-    //     "lastDailyVolumeUsd": 2964287916.82621,
-    //     "extensions": {
-    //       "coingeckoId": "usd-coin"
-    //     },
-    //     "tags": [
-    //       "AVNU",
-    //       "Verified"
-    //     ]
-    // }
+        // Array of the following is returned
+        // {
+        //     "name": "USD Coin",
+        //     "address": "0x53c91253bc9682c04929ca02ed00b3e423f6710d2ee7e0d5ebb06f3ecf368a8",
+        //     "symbol": "USDC",
+        //     "decimals": 6,
+        //     "logoUri": "https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/ethereum/assets/0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48/logo.png",
+        //     "lastDailyVolumeUsd": 2964287916.82621,
+        //     "extensions": {
+        //       "coingeckoId": "usd-coin"
+        //     },
+        //     "tags": [
+        //       "AVNU",
+        //       "Verified"
+        //     ]
+        // }
 
-    tokensData.forEach((token: any) => {
-      // if tags do not contain Avnu and verified, ignore
-      // This would exclude meme coins for now
-      if (!token.tags.includes("AVNU") || !token.tags.includes("Verified")) {
-        return;
-      }
+        tokensData.forEach((token: any) => {
+            // if tags do not contain Avnu and verified, ignore
+            // This would exclude meme coins for now
+            if (
+                !token.tags.includes("AVNU") ||
+                !token.tags.includes("Verified")
+            ) {
+                return;
+            }
 
-      tokens.push({
-        name: token.name,
-        symbol: token.symbol,
-        address: ContractAddr.from(token.address),
-        decimals: token.decimals,
-        logo: token.logoUri,
-        coingeckId: token.extensions.coingeckoId,
-        displayDecimals: 2,
-      });
-    });
-    console.log(tokens);
-    return tokens;
-  }
+            tokens.push({
+                name: token.name,
+                symbol: token.symbol,
+                address: ContractAddr.from(token.address),
+                decimals: token.decimals,
+                logo: token.logoUri,
+                coingeckId: token.extensions.coingeckoId,
+                displayDecimals: 2
+            });
+        });
+        console.log(tokens);
+        return tokens;
+    }
 
-  static assert(condition: any, message: string) {
-    if (!condition) {
-      throw new FatalError(message);
+    static assert(condition: any, message: string) {
+        if (!condition) {
+            throw new FatalError(message);
+        }
     }
-  }
 
-  static async getTokenInfoFromAddr(addr: ContractAddr) {
-    // if tokens are not loaded, load them
-    if (tokens.length == defaultTokens.length) {
-      await Global.getTokens();
+    static async getTokenInfoFromAddr(addr: ContractAddr) {
+        // if tokens are not loaded, load them
+        if (tokens.length == defaultTokens.length) {
+            await Global.getTokens();
+        }
+
+        const token = tokens.find((token) => addr.eq(token.address));
+        if (!token) {
+            throw new FatalError(`Token not found: ${addr.address}`);
+        }
+        return token;
     }
 
-    const token = tokens.find((token) => addr.eq(token.address));
-    if (!token) {
-      throw new FatalError(`Token not found: ${addr.address}`);
+    static async getTokenInfoFromName(tokenName: string) {
+        // if tokens are not loaded, load them
+        if (tokens.length == defaultTokens.length) {
+            await Global.getTokens();
+        }
+
+        const token = tokens.find(
+            (token) => token.name.toLowerCase() === tokenName.toLowerCase()
+        );
+        if (!token) {
+            throw new FatalError(`Token not found: ${tokenName}`);
+        }
+        return token;
     }
-    return token;
-  }
 
-  static setGlobalCache(key: string, data: any, ttl: number = 60000) {
-    Global.cache[key] = {
-      value: data,
-      ttl,
-      timestamp: Date.now(),
-    };
-  }
+    static setGlobalCache(key: string, data: any, ttl: number = 60000) {
+        Global.cache[key] = {
+            value: data,
+            ttl,
+            timestamp: Date.now()
+        };
+    }
 
-  static getGlobalCache<T>(key: string): T | null {
-    const cached = Global.cache[key];
-    if (!cached) return null;
-    if (Date.now() - cached.timestamp > cached.ttl) {
-      delete Global.cache[key];
-      return null;
+    static getGlobalCache<T>(key: string): T | null {
+        const cached = Global.cache[key];
+        if (!cached) return null;
+        if (Date.now() - cached.timestamp > cached.ttl) {
+            delete Global.cache[key];
+            return null;
+        }
+        return cached.value;
     }
-    return cached.value;
-  }
 }

package/src/index.browser.ts

@@ -1,6 +1,7 @@
 // contains only browser supported modules
-export * from './modules';
-export * from './interfaces';
-export * from './dataTypes';
-export * from './global';
-export * from './strategies';
+export * from "./modules";
+export * from "./interfaces";
+export * from "./dataTypes";
+export * from "./global";
+export * from "./strategies";
+export * from "./utils";