@gearbox-protocol/sdk 2.1.35 → 2.1.37

package/lib/tokens/tokens.spec.js

@@ -1,151 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable max-nested-callbacks */
-const ethers_1 = require("ethers");
-const chains_1 = require("../core/chains");
-const types_1 = require("../types");
-const multicall_1 = require("../utils/multicall");
-const token_1 = require("./token");
-const erc20 = types_1.IERC20Metadata__factory.createInterface();
-// Some contracts return something other than string for symbol
-const NON_ERC20_SYMBOLS = {
-    [token_1.tokenDataByNetwork.Mainnet.MKR]: {
-        interface: new ethers_1.ethers.utils.Interface([
-            "function symbol() view returns (bytes32)",
-        ]),
-        // convert bytes32 to string
-        stringifySymbol: (result) => ethers_1.ethers.utils
-            .toUtf8String(ethers_1.ethers.utils.arrayify(result))
-            .replaceAll(String.fromCharCode(0), ""), // trim tail of zeroes
-    },
-};
-function identity(value) {
-    return value;
-}
-const EXCEPTIONS_IN_SYMBOLS = {
-    Mainnet: {
-        // Our Symbol <-> On-chain Symbol
-        [token_1.tokenDataByNetwork.Mainnet.STETH]: "stETH",
-    },
-    Arbitrum: {
-        // Our Symbol <-> On-chain Symbol
-        [token_1.tokenDataByNetwork.Arbitrum.crvUSDTWBTCWETH]: "crv3crypto",
-        [token_1.tokenDataByNetwork.Arbitrum["50OHM_50WETH"]]: "50WETH_50OHM",
-        [token_1.tokenDataByNetwork.Arbitrum.aDAI]: "aArbDAI",
-        [token_1.tokenDataByNetwork.Arbitrum.aUSDC]: "aArbUSDCn",
-        [token_1.tokenDataByNetwork.Arbitrum.aUSDT]: "aArbUSDT",
-        [token_1.tokenDataByNetwork.Arbitrum.aWETH]: "aArbWETH",
-    },
-};
-class TokenSuite {
-    provider;
-    network;
-    calls;
-    responses = {};
-    constructor(network) {
-        this.network = network;
-        const url = process.env[`${network.toUpperCase()}_TESTS_FORK`];
-        if (!url) {
-            throw new Error(`${network} provder not found in env`);
-        }
-        this.provider = new ethers_1.ethers.providers.StaticJsonRpcProvider(url, chains_1.CHAINS[network]);
-        // Omit NOT DEPLOYED
-        const entries = Object.entries(token_1.tokenDataByNetwork[network]).filter(([_, addr]) => addr?.startsWith("0x"));
-        this.calls = entries.map(([symbol, address]) => ({
-            address,
-            interface: NON_ERC20_SYMBOLS[address]?.interface ?? erc20,
-            method: "symbol()",
-            key: symbol,
-        }));
-    }
-    async fetchSymbols() {
-        // even safe multicall fails when one of addresses is an EOA and not contract address
-        if (this.network === "Arbitrum") {
-            // if (true) {
-            for (const call of this.calls) {
-                const c = types_1.IERC20Metadata__factory.connect(call.address, this.provider);
-                try {
-                    const s = await c.symbol();
-                    this.responses[call.key] = {
-                        address: call.address,
-                        symbol: this.sanitize(s),
-                    };
-                }
-                catch (e) {
-                    this.responses[call.key] = {
-                        address: call.address,
-                        error: e,
-                    };
-                }
-            }
-        }
-        else {
-            const resps = await (0, multicall_1.safeMulticall)(this.calls, this.provider);
-            for (let i = 0; i < resps.length; i++) {
-                const call = this.calls[i];
-                const resp = resps[i];
-                // most symbols are ok, but some return non-string value for symbol.
-                // stringifySymbol makes sure that we get symbol as string
-                const stringifySymbol = NON_ERC20_SYMBOLS[call.address]?.stringifySymbol ?? identity;
-                this.responses[call.key] = {
-                    address: call.address,
-                    symbol: resp.error
-                        ? undefined
-                        : this.sanitize(stringifySymbol(resp.value ?? "")),
-                    error: resp.error,
-                };
-            }
-        }
-    }
-    /**
-     * Given <symbol, address> token map on our sdk, asserts that symbol found on chain for this address is the same
-     * Takes into account some exceptions
-     * @param sdkSymbol Symbol of token in SDK
-     */
-    assertSymbol(sdkSymbol) {
-        const r = this.responses[sdkSymbol];
-        if (r.error) {
-            throw new Error(`failed to verify ${sdkSymbol} on address ${r.address}: ${r.error}`);
-        }
-        const expectedSymbol = EXCEPTIONS_IN_SYMBOLS[this.network][r.address] ?? sdkSymbol;
-        if (r.symbol !== expectedSymbol) {
-            throw new Error(`Expected ${expectedSymbol} but found ${r.symbol} at ${r.address}`);
-        }
-    }
-    assertChecksum(sdkSymbol) {
-        const sdkAddress = token_1.tokenDataByNetwork[this.network][sdkSymbol];
-        let err;
-        try {
-            const addr = ethers_1.ethers.utils.getAddress(sdkAddress);
-            if (addr !== sdkAddress) {
-                err = new Error(`sdk address for token ${sdkSymbol} is not checksummed: expected ${addr}, got ${sdkAddress}`);
-            }
-        }
-        catch (e) {
-            err = new Error(`sdk address ${sdkAddress} for token ${sdkSymbol} has bad checksum: ${e}`);
-        }
-        if (err) {
-            throw err;
-        }
-    }
-    sanitize(symbol) {
-        return symbol.replace(/\-f$/, "").replaceAll("-", "_");
-    }
-}
-describe("Tokens", () => {
-    const suites = chains_1.supportedChains.map(n => new TokenSuite(n));
-    before(async function () {
-        this.timeout(120000);
-        await Promise.all(suites.map(s => s.fetchSymbols()));
-    });
-    suites.forEach(suite => {
-        suite.calls.forEach(call => {
-            it(`symbol for ${call.key} on ${suite.network}`, () => {
-                suite.assertSymbol(call.key);
-            });
-            it(`address checksum for ${call.key} on ${suite.network}`, () => {
-                suite.assertChecksum(call.key);
-            });
-        });
-    });
-});