@uniswap/token-list-bridge-utils 0.1.1-beta.1 → 1.0.1

package/src/utils.ts

@@ -1,5 +1,6 @@
 import { TokenInfo, TokenList } from '@uniswap/token-lists'
-import { getTokenListObj } from './arb-token-lists/src/lib/utils'
+import { readFileSync, existsSync } from 'fs'
+import axios from 'axios'
 
 export type TokenListOrFetchableTokenList = TokenList | string
 
@@ -10,6 +11,8 @@ export function compareTokenInfos(t1: TokenInfo, t2: TokenInfo) {
   return t1.chainId < t2.chainId ? -1 : 1
 }
 
+// ref: https://github.com/OffchainLabs/arb-token-lists/blob/master/src/lib/utils.ts
+
 export async function getTokenList(
   l1TokenListOrPathOrUrl: TokenListOrFetchableTokenList
 ): Promise<TokenList> {
@@ -19,3 +22,70 @@ export async function getTokenList(
     return l1TokenListOrPathOrUrl
   }
 }
+
+export const getTokenListObjFromUrl = async (url: string) => {
+  return (await axios.get(url)).data as TokenList
+}
+
+export const getTokenListObjFromLocalPath = async (path: string) => {
+  return JSON.parse(readFileSync(path).toString()) as TokenList
+}
+
+export const getTokenListObj = async (pathOrUrl: string) => {
+  const tokenList: TokenList = await (async (pathOrUrl: string) => {
+    const localFileExists = existsSync(pathOrUrl)
+    const looksLikeUrl = isValidHttpUrl(pathOrUrl)
+    if (localFileExists) {
+      return getTokenListObjFromLocalPath(pathOrUrl)
+    } else if (looksLikeUrl) {
+      return await getTokenListObjFromUrl(pathOrUrl)
+    } else {
+      throw new Error('Could not find token list')
+    }
+  })(pathOrUrl)
+  isTokenList(tokenList)
+  return tokenList
+}
+
+// https://stackoverflow.com/questions/5717093/check-if-a-javascript-string-is-a-url
+
+function isValidHttpUrl(urlString: string) {
+  let url
+
+  try {
+    url = new URL(urlString)
+  } catch (_) {
+    return false
+  }
+
+  return url.protocol === 'http:' || url.protocol === 'https:'
+}
+
+// typeguard:
+export const isTokenList = (obj: any) => {
+  const expectedListKeys = ['name', 'timestamp', 'version', 'tokens']
+  const actualListKeys = new Set(Object.keys(obj))
+  if (!expectedListKeys.every((key) => actualListKeys.has(key))) {
+    throw new Error('tokenlist typeguard error: required list key not included')
+  }
+  const { version, tokens } = obj
+  if (
+    !['major', 'minor', 'patch'].every((key) => {
+      return typeof version[key] === 'number'
+    })
+  ) {
+    throw new Error('tokenlist typeguard error: invalid version')
+  }
+  if (
+    !tokens.every((token: any) => {
+      const tokenKeys = new Set(Object.keys(token))
+      return ['chainId', 'address', 'name', 'decimals', 'symbol'].every(
+        (key) => {
+          return tokenKeys.has(key)
+        }
+      )
+    })
+  ) {
+    throw new Error('tokenlist typeguard error: token missing required key')
+  }
+}

package/dist/arb-token-lists/server/app.d.ts

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

package/dist/arb-token-lists/src/lib/getClargs.d.ts

@@ -1,8 +0,0 @@
-declare const argv: {
-    [x: string]: unknown;
-    l2NetworkID: number | undefined;
-    tokenList: string | undefined;
-    _: (string | number)[];
-    $0: string;
-};
-export default argv;

package/dist/arb-token-lists/src/lib/graph.d.ts

@@ -1,2 +0,0 @@
-export declare const getTokens: (l1TokenAddresses: string[], networkID: string) => Promise<import("./types").GraphTokenResult[]>;
-export declare const getAllTokens: (networkID: string) => Promise<import("./types").GraphTokenResult[]>;

package/dist/arb-token-lists/src/lib/token_list_gen.d.ts

@@ -1,23 +0,0 @@
-import { TokenList } from '@uniswap/token-lists';
-import { ArbTokenList, EtherscanList } from './types';
-export interface ArbificationOptions {
-    overwriteCurrentList: boolean;
-}
-export interface L2ToL1GatewayAddresses {
-    [contractAddress: string]: string;
-}
-export declare const generateTokenList: (l1TokenList: TokenList, prevArbTokenList?: ArbTokenList | undefined, options?: {
-    /**
-     * Append all tokens from the original l1TokenList to the output list.
-     */
-    includeAllL1Tokens?: boolean | undefined;
-    /**
-     * Append all unbridged tokens from original l1TokenList to the output list.
-     */
-    includeUnbridgedL1Tokens?: boolean | undefined;
-    getAllTokensInNetwork?: boolean | undefined;
-} | undefined) => Promise<ArbTokenList>;
-export declare const arbifyL1List: (pathOrUrl: string) => Promise<void>;
-export declare const updateArbifiedList: (pathOrUrl: string) => Promise<void>;
-export declare const updateLogoURIs: (path: string) => Promise<void>;
-export declare const arbListtoEtherscanList: (arbList: ArbTokenList) => EtherscanList;

package/dist/arb-token-lists/src/lib/types.d.ts

@@ -1,36 +0,0 @@
-import { TokenInfo, TokenList } from '@uniswap/token-lists';
-export interface ArbTokenInfo extends Omit<TokenInfo, 'extensions'> {
-    extensions?: {
-        bridgeInfo: {
-            [destinationChainID: string]: {
-                tokenAddress: string;
-                originBridgeAddress: string;
-                destBridgeAddress: string;
-            };
-        };
-    };
-}
-export interface ArbTokenList extends Omit<TokenList, 'tokens'> {
-    tokens: ArbTokenInfo[];
-}
-export interface EtherscanToken {
-    l1Address: string | null;
-    l2Address: string;
-    l1GatewayAddress: string | null;
-    l2GatewayAddress: string | null;
-}
-export declare type EtherscanList = EtherscanToken[];
-export interface GraphTokenResult {
-    l2Address: string | null;
-    joinTableEntry: [
-        {
-            gateway: {
-                gatewayAddr: string;
-            };
-        }
-    ];
-    l1TokenAddr: string;
-}
-export interface GraphTokensResult {
-    tokens: GraphTokenResult[];
-}

package/dist/arb-token-lists/src/lib/utils.d.ts

@@ -1,18 +0,0 @@
-import { TokenList } from '@uniswap/token-lists';
-import { MultiCaller } from 'arb-ts';
-import { ArbTokenList } from './types';
-export declare const listNameToFileName: (name: string) => string;
-export declare const listNameToArbifiedListName: (name: string) => string;
-export declare const getL2TokenAddressesFromL1: (l1TokenAddresses: string[], multiCaller: MultiCaller, l1GatewayRouterAddress: string) => Promise<(string | undefined)[]>;
-export declare const getL2TokenAddressesFromL2: (l1TokenAddresses: string[], multiCaller: MultiCaller, l2GatewayRouterAddress: string) => Promise<(string | undefined)[]>;
-export declare const getLogoUri: (l1TokenAddress: string) => Promise<string | undefined>;
-export declare const getTokenListObjFromUrl: (url: string) => Promise<TokenList>;
-export declare const getTokenListObjFromLocalPath: (path: string) => Promise<TokenList>;
-export declare const tokenListIsValid: (tokenList: ArbTokenList | TokenList) => boolean;
-export declare const validateTokenListWithErrorThrowing: (tokenList: ArbTokenList | TokenList) => boolean;
-export declare const removeInvalidTokensFromList: (tokenList: ArbTokenList | TokenList) => ArbTokenList | TokenList;
-export declare const getTokenListObj: (pathOrUrl: string) => Promise<TokenList>;
-export declare const isArbTokenList: (obj: any) => void;
-export declare const isTokenList: (obj: any) => void;
-export declare const sanitizeString: (str: string) => string;
-export declare const excludeList: string[];

package/dist/arb-token-lists/src/main.d.ts

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

package/src/arb-token-lists/.env.sample

@@ -1,4 +0,0 @@
-MAINNET_RPC="https://mainnet.infura.io/v3/<infura key>"
-ARB_ONE_RPC="https://arb1.arbitrum.io/rpc"
-l2NetworkID=42161
-PORT=3000

package/src/arb-token-lists/.eslintrc.js

@@ -1,43 +0,0 @@
-module.exports = {
-  env: {
-    commonjs: true,
-    es6: true,
-    node: true,
-  },
-  plugins: ["prettier"],
-  extends: [
-    "eslint:recommended",
-    "plugin:prettier/recommended", // Enables eslint-plugin-prettier and displays prettier errors as ESLint errors. Make sure this is always the last configuration in the extends array.
-  ],
-  parserOptions: {
-    ecmaVersion: 2018, // Allows for the parsing of modern ECMAScript features
-    sourceType: "module", // Allows for the use of imports
-  },
-  rules: {
-    "prettier/prettier": "error",
-    "no-unused-vars": "warn",
-    "prefer-const": [2, { destructuring: "all" }],
-    "object-curly-spacing": ["error", "always"],
-  },
-  overrides: [
-    {
-      files: ["*.ts", "*.tsx"],
-      parser: "@typescript-eslint/parser",
-      extends: [
-        "eslint:recommended",
-        "plugin:@typescript-eslint/recommended",
-        "plugin:prettier/recommended",
-      ],
-      plugins: ["@typescript-eslint", "prettier"],
-      rules: {
-        "no-empty-pattern": "warn",
-        "prettier/prettier": ["error", { singleQuote: true }],
-        "@typescript-eslint/member-delimiter-style": ["off"],
-        "@typescript-eslint/no-explicit-any": ["warn"],
-        "@typescript-eslint/no-use-before-define": ["off"],
-        "@typescript-eslint/no-non-null-assertion": ["off"],
-        "@typescript-eslint/ban-ts-comment": ["warn"],
-      },
-    },
-  ],
-};

package/src/arb-token-lists/.gitignore

@@ -1,4 +0,0 @@
-node_modules
-.env
-ArbTokenLists
-FullList

package/src/arb-token-lists/package.json

@@ -1,40 +0,0 @@
-{
-  "name": "arb-token-lists",
-  "version": "1.0.0",
-  "main": "index.js",
-  "license": "MIT",
-  "scripts": {
-    "main": "ts-node src/main.ts",
-    "lint": "eslint .",
-    "format": "prettier './**/*.{js,json,md,ts,yml}' --write && yarn run lint --fix",
-    "update": "yarn ts-node src/main.ts --action update",
-    "arbify": "yarn ts-node src/main.ts --action arbify",
-    "fullList": "yarn ts-node src/main.ts --action full",
-    "start_server": "yarn ts-node server/app.ts"
-  },
-  "dependencies": {
-    "@uniswap/token-lists": "^1.0.0-beta.27",
-    "ajv": "^8.6.3",
-    "ajv-formats": "^2.1.1",
-    "arb-ts": "2.0.0-beta.10",
-    "axios": "^0.23.0",
-    "better-ajv-errors": "^1.1.2",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "express": "^4.17.1",
-    "graphql": "^15.6.1",
-    "graphql-request": "^3.6.1",
-    "prettier": "^2.4.1",
-    "ts-node": "^10.3.0",
-    "typescript": "^4.4.4",
-    "yargs": "^17.2.1"
-  },
-  "devDependencies": {
-    "@types/express": "^4.17.13",
-    "@types/node": "^16.11.1",
-    "@types/yargs": "^17.0.4",
-    "@typescript-eslint/eslint-plugin": "^5.1.0",
-    "@typescript-eslint/parser": "^5.1.0",
-    "eslint": "^8.0.1"
-  }
-}

package/src/arb-token-lists/readme.md

@@ -1,14 +0,0 @@
-### Setup
-From root:
-
-1. `cp .env.sample .env`
-2. In `.env`, set `MAINNET_RPC` var (i.e., set infura key or use different endpoint)
-3. `yarn install`
-
-### Arbify an L1 Token Lost
-
-yarn arbify --tokenList https://gateway.ipfs.io/ipns/tokens.uniswap.org
-
-### Generate Full List
-
-`yarn fullList`

package/src/arb-token-lists/server/app.ts

@@ -1,21 +0,0 @@
-import express from 'express'
-const app = express();
-import dotenv from 'dotenv';
-import { readFileSync } from 'fs'
-dotenv.config();
-const port = process.env.PORT || 8080 
-
-
-app.get( "/", ( req, res ) => {
-    res.send( "ping" );
-} );
-
-app.get("/all_tokens", (req, res)=>{
-    const tokenData = readFileSync("./src/FullList/all_tokens.json")    
-
-    res.send(JSON.parse(tokenData.toString()))
-})
-
-app.listen( port, () => {
-    console.log( `server started at port ${ port }` );
-} );