@pioneer-platform/uniswap-client 0.0.22 → 0.0.25

package/lib/constants/tokenLogoLookup.js

@@ -0,0 +1,48 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var state_1 = __importDefault(require("state"));
+var lists_1 = require("./lists");
+var TokenLogoLookupTable = /** @class */ (function () {
+    function TokenLogoLookupTable() {
+        this.dict = {};
+        this.initialized = false;
+    }
+    TokenLogoLookupTable.prototype.initialize = function () {
+        var dict = {};
+        lists_1.DEFAULT_LIST_OF_LISTS.forEach(function (list) {
+            var _a;
+            var listData = state_1.default.getState().lists.byUrl[list];
+            if (!listData) {
+                return;
+            }
+            (_a = listData.current) === null || _a === void 0 ? void 0 : _a.tokens.forEach(function (token) {
+                if (token.logoURI) {
+                    var lowercaseAddress = token.address.toLowerCase();
+                    var currentEntry = dict[lowercaseAddress + ':' + token.chainId];
+                    if (currentEntry) {
+                        currentEntry.push(token.logoURI);
+                    }
+                    else {
+                        dict[lowercaseAddress + ':' + token.chainId] = [token.logoURI];
+                    }
+                }
+            });
+        });
+        this.dict = dict;
+        this.initialized = true;
+    };
+    TokenLogoLookupTable.prototype.getIcons = function (address, chainId) {
+        if (chainId === void 0) { chainId = 1; }
+        if (!address)
+            return undefined;
+        if (!this.initialized) {
+            this.initialize();
+        }
+        return this.dict[address.toLowerCase() + ':' + chainId];
+    };
+    return TokenLogoLookupTable;
+}());
+exports.default = new TokenLogoLookupTable();

package/lib/constants/tokenSafety.js

@@ -0,0 +1,129 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.displayWarningLabel = exports.checkSearchTokenWarning = exports.checkWarning = exports.NotFoundWarning = exports.BlockedWarning = exports.StrongWarning = exports.MediumWarning = exports.getWarningCopy = exports.getPriorityWarning = exports.WARNING_LEVEL = exports.TOKEN_SAFETY_ARTICLE = void 0;
+var i18n_1 = require("i18n");
+var types_and_hooks_1 = require("uniswap/src/data/graphql/uniswap-data-api/__generated__/types-and-hooks");
+var misc_1 = require("./misc");
+var tokenSafetyLookup_1 = __importStar(require("./tokenSafetyLookup"));
+var tokens_1 = require("./tokens");
+exports.TOKEN_SAFETY_ARTICLE = 'https://support.uniswap.org/hc/en-us/articles/8723118437133';
+var WARNING_LEVEL;
+(function (WARNING_LEVEL) {
+    WARNING_LEVEL[WARNING_LEVEL["MEDIUM"] = 0] = "MEDIUM";
+    WARNING_LEVEL[WARNING_LEVEL["UNKNOWN"] = 1] = "UNKNOWN";
+    WARNING_LEVEL[WARNING_LEVEL["BLOCKED"] = 2] = "BLOCKED";
+})(WARNING_LEVEL || (exports.WARNING_LEVEL = WARNING_LEVEL = {}));
+/**
+ * Determine which warning to display based on the priority of the warnings. Prioritize blocked, than unknown, followed by the rest. Accepts two warnings passed in.
+ */
+function getPriorityWarning(token0Warning, token1Warning) {
+    if (token0Warning && token1Warning) {
+        if ((token1Warning === null || token1Warning === void 0 ? void 0 : token1Warning.level) === WARNING_LEVEL.BLOCKED ||
+            ((token1Warning === null || token1Warning === void 0 ? void 0 : token1Warning.level) === WARNING_LEVEL.UNKNOWN && (token0Warning === null || token0Warning === void 0 ? void 0 : token0Warning.level) !== WARNING_LEVEL.BLOCKED)) {
+            return token1Warning;
+        }
+        return token0Warning;
+    }
+    return token0Warning !== null && token0Warning !== void 0 ? token0Warning : token1Warning;
+}
+exports.getPriorityWarning = getPriorityWarning;
+function getWarningCopy(warning, plural, tokenSymbol) {
+    if (plural === void 0) { plural = false; }
+    var heading = null, description = null;
+    if (warning) {
+        switch (warning.level) {
+            case WARNING_LEVEL.MEDIUM:
+                heading = (<i18n_1.Plural value={plural ? 2 : 1} one={(0, i18n_1.t)("{{name}} isn't traded on leading U.S. centralized exchanges.", {
+                        name: tokenSymbol !== null && tokenSymbol !== void 0 ? tokenSymbol : 'This token',
+                    })} other="These tokens aren't traded on leading U.S. centralized exchanges."/>);
+                description = <i18n_1.Trans>Always conduct your own research before trading.</i18n_1.Trans>;
+                break;
+            case WARNING_LEVEL.UNKNOWN:
+                heading = (<i18n_1.Plural value={plural ? 2 : 1} one={(0, i18n_1.t)("{{name}} isn't traded on leading U.S. centralized exchanges or frequently swapped on Uniswap.", {
+                        name: tokenSymbol !== null && tokenSymbol !== void 0 ? tokenSymbol : 'This token',
+                    })} other="These tokens aren't traded on leading U.S. centralized exchanges or frequently swapped on Uniswap."/>);
+                description = <i18n_1.Trans>Always conduct your own research before trading.</i18n_1.Trans>;
+                break;
+            case WARNING_LEVEL.BLOCKED:
+                description = (<i18n_1.Plural value={plural ? 2 : 1} one={(0, i18n_1.t)("You can't trade {{name}} using the Uniswap App.", {
+                        name: tokenSymbol !== null && tokenSymbol !== void 0 ? tokenSymbol : 'this token',
+                    })} other="You can't trade these tokens using the Uniswap App."/>);
+                break;
+        }
+    }
+    return { heading: heading, description: description };
+}
+exports.getWarningCopy = getWarningCopy;
+exports.MediumWarning = {
+    level: WARNING_LEVEL.MEDIUM,
+    message: <i18n_1.Trans>Caution</i18n_1.Trans>,
+    canProceed: true,
+};
+exports.StrongWarning = {
+    level: WARNING_LEVEL.UNKNOWN,
+    message: <i18n_1.Trans>Warning</i18n_1.Trans>,
+    canProceed: true,
+};
+exports.BlockedWarning = {
+    level: WARNING_LEVEL.BLOCKED,
+    message: <i18n_1.Trans>Not available</i18n_1.Trans>,
+    canProceed: false,
+};
+exports.NotFoundWarning = {
+    level: WARNING_LEVEL.UNKNOWN,
+    message: <i18n_1.Trans>Token not found</i18n_1.Trans>,
+    canProceed: false,
+};
+function checkWarning(tokenAddress, chainId) {
+    if (tokenAddress === tokens_1.NATIVE_CHAIN_ID || tokenAddress === misc_1.ZERO_ADDRESS) {
+        return undefined;
+    }
+    switch (tokenSafetyLookup_1.default.checkToken(tokenAddress.toLowerCase(), chainId)) {
+        case tokenSafetyLookup_1.TOKEN_LIST_TYPES.UNI_DEFAULT:
+            return undefined;
+        case tokenSafetyLookup_1.TOKEN_LIST_TYPES.UNI_EXTENDED:
+            return exports.MediumWarning;
+        case tokenSafetyLookup_1.TOKEN_LIST_TYPES.UNKNOWN:
+            return exports.StrongWarning;
+        case tokenSafetyLookup_1.TOKEN_LIST_TYPES.BLOCKED:
+            return exports.BlockedWarning;
+        case tokenSafetyLookup_1.TOKEN_LIST_TYPES.BROKEN:
+            return exports.BlockedWarning;
+    }
+}
+exports.checkWarning = checkWarning;
+// TODO(cartcrom): Replace all usage of WARNING_LEVEL with SafetyLevel
+function checkSearchTokenWarning(token) {
+    if (!token.address) {
+        return token.standard === types_and_hooks_1.TokenStandard.Native ? undefined : exports.StrongWarning;
+    }
+    return checkWarning(token.address);
+}
+exports.checkSearchTokenWarning = checkSearchTokenWarning;
+function displayWarningLabel(warning) {
+    return warning && warning.level !== WARNING_LEVEL.MEDIUM;
+}
+exports.displayWarningLabel = displayWarningLabel;

package/lib/constants/tokenSafetyLookup.d.ts

@@ -0,0 +1,18 @@
+import { ListsState } from 'state/lists/types';
+export declare enum TOKEN_LIST_TYPES {
+    UNI_DEFAULT = 1,
+    UNI_EXTENDED = 2,
+    UNKNOWN = 3,
+    BLOCKED = 4,
+    BROKEN = 5
+}
+declare class TokenSafetyLookupTable {
+    initialized: boolean;
+    dict: {
+        [key: string]: TOKEN_LIST_TYPES;
+    };
+    update(lists: ListsState): void;
+    checkToken(address: string, chainId?: number | null): TOKEN_LIST_TYPES;
+}
+declare const _default: TokenSafetyLookupTable;
+export default _default;

package/lib/constants/tokenSafetyLookup.js

@@ -0,0 +1,66 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TOKEN_LIST_TYPES = void 0;
+var state_1 = __importDefault(require("../state"));
+var lists_1 = require("./lists");
+var routing_1 = require("./routing");
+var broken_tokenlist_json_1 = __importDefault(require("./tokenLists/broken.tokenlist.json"));
+var tokens_1 = require("./tokens");
+var TOKEN_LIST_TYPES;
+(function (TOKEN_LIST_TYPES) {
+    TOKEN_LIST_TYPES[TOKEN_LIST_TYPES["UNI_DEFAULT"] = 1] = "UNI_DEFAULT";
+    TOKEN_LIST_TYPES[TOKEN_LIST_TYPES["UNI_EXTENDED"] = 2] = "UNI_EXTENDED";
+    TOKEN_LIST_TYPES[TOKEN_LIST_TYPES["UNKNOWN"] = 3] = "UNKNOWN";
+    TOKEN_LIST_TYPES[TOKEN_LIST_TYPES["BLOCKED"] = 4] = "BLOCKED";
+    TOKEN_LIST_TYPES[TOKEN_LIST_TYPES["BROKEN"] = 5] = "BROKEN";
+})(TOKEN_LIST_TYPES || (exports.TOKEN_LIST_TYPES = TOKEN_LIST_TYPES = {}));
+var TokenSafetyLookupTable = /** @class */ (function () {
+    function TokenSafetyLookupTable() {
+        this.initialized = false;
+        this.dict = {};
+    }
+    // TODO(WEB-2488): Index lookups by chainId
+    TokenSafetyLookupTable.prototype.update = function (lists) {
+        var _this = this;
+        var _a, _b, _c, _d;
+        this.initialized = true;
+        // Initialize extended tokens first
+        (_b = (_a = lists.byUrl[lists_1.UNI_EXTENDED_LIST]) === null || _a === void 0 ? void 0 : _a.current) === null || _b === void 0 ? void 0 : _b.tokens.forEach(function (token) {
+            _this.dict[token.address.toLowerCase()] = TOKEN_LIST_TYPES.UNI_EXTENDED;
+        });
+        // Initialize default tokens second, so that any tokens on both default and extended will display as default (no warning)
+        (_d = (_c = lists.byUrl[lists_1.UNI_LIST]) === null || _c === void 0 ? void 0 : _c.current) === null || _d === void 0 ? void 0 : _d.tokens.forEach(function (token) {
+            _this.dict[token.address.toLowerCase()] = TOKEN_LIST_TYPES.UNI_DEFAULT;
+        });
+        // TODO: Figure out if this list is still relevant
+        broken_tokenlist_json_1.default.tokens.forEach(function (token) {
+            _this.dict[token.address.toLowerCase()] = TOKEN_LIST_TYPES.BROKEN;
+        });
+        // Initialize blocked tokens from all urls included
+        lists_1.UNSUPPORTED_LIST_URLS.map(function (url) { var _a, _b; return (_b = (_a = lists.byUrl[url]) === null || _a === void 0 ? void 0 : _a.current) === null || _b === void 0 ? void 0 : _b.tokens; })
+            .filter(function (x) { return !!x; })
+            .flat(1)
+            .forEach(function (token) {
+            _this.dict[token.address.toLowerCase()] = TOKEN_LIST_TYPES.BLOCKED;
+        });
+    };
+    TokenSafetyLookupTable.prototype.checkToken = function (address, chainId) {
+        var _a, _b;
+        if (!this.initialized)
+            this.update(state_1.default.getState().lists);
+        if (address === tokens_1.NATIVE_CHAIN_ID.toLowerCase()) {
+            return TOKEN_LIST_TYPES.UNI_DEFAULT;
+        }
+        else if (chainId && ((_a = routing_1.COMMON_BASES[chainId]) === null || _a === void 0 ? void 0 : _a.some(function (base) { return address === base.wrapped.address.toLowerCase(); }))) {
+            return TOKEN_LIST_TYPES.UNI_DEFAULT;
+        }
+        else {
+            return (_b = this.dict[address]) !== null && _b !== void 0 ? _b : TOKEN_LIST_TYPES.UNKNOWN;
+        }
+    };
+    return TokenSafetyLookupTable;
+}());
+exports.default = new TokenSafetyLookupTable();

package/lib/constants/tokenSaftey.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/constants/tokenSaftey.test.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tokenSafety_1 = require("./tokenSafety");
+describe('getPriorityWarning', function () {
+    it('returns token1Warning when both warnings exist and token1Warning is BLOCKED', function () {
+        var token0Warning = tokenSafety_1.StrongWarning;
+        var token1Warning = tokenSafety_1.BlockedWarning;
+        expect((0, tokenSafety_1.getPriorityWarning)(token0Warning, token1Warning)).toBe(token1Warning);
+    });
+    it('returns token1Warning when both warnings exist, token1Warning is UNKNOWN, and token0Warning is not BLOCKED', function () {
+        var token0Warning = tokenSafety_1.StrongWarning;
+        var token1Warning = tokenSafety_1.StrongWarning;
+        expect((0, tokenSafety_1.getPriorityWarning)(token0Warning, token1Warning)).toBe(token1Warning);
+    });
+    it('returns token0Warning when both warnings exist and token1Warning is not BLOCKED or UNKNOWN', function () {
+        var token0Warning = tokenSafety_1.StrongWarning;
+        var token1Warning = tokenSafety_1.MediumWarning;
+        expect((0, tokenSafety_1.getPriorityWarning)(token0Warning, token1Warning)).toBe(token0Warning);
+    });
+    it('returns token0Warning when only token0Warning exists', function () {
+        var token0Warning = tokenSafety_1.StrongWarning;
+        expect((0, tokenSafety_1.getPriorityWarning)(token0Warning, undefined)).toBe(token0Warning);
+    });
+    it('returns token1Warning when only token1Warning exists', function () {
+        var token1Warning = tokenSafety_1.BlockedWarning;
+        expect((0, tokenSafety_1.getPriorityWarning)(undefined, token1Warning)).toBe(token1Warning);
+    });
+    it('returns undefined when both warnings are undefined', function () {
+        expect((0, tokenSafety_1.getPriorityWarning)(undefined, undefined)).toBeUndefined();
+    });
+});

package/lib/constants/tokens.d.ts

@@ -1,26 +1,21 @@
-import { Ether, NativeCurrency, Token } from '@uniswap/sdk-core';
-import { SupportedChainId } from './chains';
+import { ChainId, Currency, NativeCurrency, Token } from '@uniswap/sdk-core';
+export declare const NATIVE_CHAIN_ID = "NATIVE";
 export declare const USDC_MAINNET: Token;
-export declare const USDC_ROPSTEN: Token;
-export declare const USDC_RINKEBY: Token;
 export declare const USDC_GOERLI: Token;
-export declare const USDC_KOVAN: Token;
+export declare const USDC_SEPOLIA: Token;
 export declare const USDC_OPTIMISM: Token;
+export declare const USDC_OPTIMISM_GOERLI: Token;
 export declare const USDC_ARBITRUM: Token;
-export declare const USDC_ARBITRUM_RINKEBY: Token;
+export declare const USDC_ARBITRUM_GOERLI: Token;
 export declare const USDC_POLYGON: Token;
 export declare const USDC_POLYGON_MUMBAI: Token;
-export declare const PORTAL_USDC_CELO: Token;
-export declare const USDC_CELO_ALFAJORES: Token;
-export declare const AMPL: Token;
+export declare const USDC_CELO: Token;
+export declare const USDC_BASE: Token;
 export declare const DAI: Token;
 export declare const DAI_ARBITRUM_ONE: Token;
 export declare const DAI_OPTIMISM: Token;
-export declare const USDC_BNB_CHAIN: Token;
-export declare const USDC_BASE: Token;
-export declare const USDC: {
-    [chainId in SupportedChainId]: Token;
-};
+export declare const MATIC_MAINNET: Token;
+export declare const MATIC_POLYGON: Token;
 export declare const DAI_POLYGON: Token;
 export declare const USDT_POLYGON: Token;
 export declare const WBTC_POLYGON: Token;
@@ -30,49 +25,46 @@ export declare const USDT_OPTIMISM: Token;
 export declare const WBTC: Token;
 export declare const WBTC_ARBITRUM_ONE: Token;
 export declare const WBTC_OPTIMISM: Token;
-export declare const FEI: Token;
-export declare const TRIBE: Token;
-export declare const FRAX: Token;
-export declare const FXS: Token;
-export declare const renBTC: Token;
-export declare const ETH2X_FLI: Token;
-export declare const sETH2: Token;
-export declare const rETH2: Token;
-export declare const SWISE: Token;
 export declare const WETH_POLYGON_MUMBAI: Token;
 export declare const WETH_POLYGON: Token;
-export declare const CELO_CELO: Token;
 export declare const CUSD_CELO: Token;
 export declare const CEUR_CELO: Token;
 export declare const PORTAL_ETH_CELO: Token;
-export declare const CMC02_CELO: Token;
-export declare const CELO_CELO_ALFAJORES: Token;
+export declare const WBTC_CELO: Token;
 export declare const CUSD_CELO_ALFAJORES: Token;
 export declare const CEUR_CELO_ALFAJORES: Token;
-export declare const USDT_BNB_CHAIN: Token;
-export declare const ETH_BNB_CHAIN: Token;
-export declare const MATIC_BNB_CHAIN: Token;
-export declare const FRAX_BNB_CHAIN: Token;
-export declare const BTC_BNB_CHAIN: Token;
-export declare const CAKE_BNB_CHAIN: Token;
-export declare const BUSD_BNB_CHAIN: Token;
-export declare const DAI_BNB_CHAIN: Token;
-export declare const DAI_BASE: Token;
+export declare const USDC_BSC: Token;
+export declare const USDT_BSC: Token;
+export declare const ETH_BSC: Token;
+export declare const BTC_BSC: Token;
+export declare const BUSD_BSC: Token;
+export declare const DAI_BSC: Token;
+export declare const USDB_BLAST: Token;
+export declare const USDC_AVALANCHE: Token;
+export declare const USDT_AVALANCHE: Token;
+export declare const WETH_AVALANCHE: Token;
+export declare const DAI_AVALANCHE: Token;
 export declare const UNI: {
     [chainId: number]: Token;
 };
+export declare const ARB: Token;
+export declare const OP: Token;
+export declare const LDO: Token;
+export declare const NMR: Token;
+export declare const MNW: Token;
 export declare const WRAPPED_NATIVE_CURRENCY: {
     [chainId: number]: Token | undefined;
 };
-export declare function isCelo(chainId: number): chainId is SupportedChainId.CELO | SupportedChainId.CELO_ALFAJORES;
-export declare class ExtendedEther extends Ether {
-    get wrapped(): Token;
-    private static _cachedExtendedEther;
-    static onChain(chainId: number): ExtendedEther;
-}
+export declare function isCelo(chainId: number): chainId is ChainId.CELO | ChainId.CELO_ALFAJORES;
+export declare function isPolygon(chainId: number): chainId is ChainId.POLYGON | ChainId.POLYGON_MUMBAI;
+export declare function isBsc(chainId: number): chainId is ChainId.BNB;
+export declare function isAvalanche(chainId: number): chainId is ChainId.AVALANCHE;
 export declare function nativeOnChain(chainId: number): NativeCurrency | Token;
 export declare const TOKEN_SHORTHANDS: {
     [shorthand: string]: {
-        [chainId in SupportedChainId]?: string;
+        [chainId in ChainId]?: string;
     };
 };
+export declare function isStablecoin(currency?: Currency): boolean;
+export declare const UNKNOWN_TOKEN_SYMBOL = "UNKNOWN";
+export declare const UNKNOWN_TOKEN_NAME = "Unknown Token";