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

package/README.md

@@ -0,0 +1,17 @@
+# DTS User Guide
+
+## Commands
+
+DTS scaffolds your new library inside `/src`.
+
+To run DTS, use:
+
+```bash
+npm start # or yarn start
+```
+
+This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.
+
+To do a one-off build, use `npm run build` or `yarn build`.
+
+To run tests, use `npm test` or `yarn test`.

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

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

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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,2 @@
+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/instantiate_bridge.d.ts

@@ -0,0 +1,15 @@
+import { providers } from 'ethers';
+import { MultiCaller, TokenBridger } from "arb-ts";
+export declare const getNetworkConfig: () => Promise<{
+    l1: {
+        network: import("arb-ts").L1Network;
+        provider: providers.JsonRpcProvider;
+        multiCaller: MultiCaller;
+    };
+    l2: {
+        network: import("arb-ts").L2Network;
+        provider: providers.JsonRpcProvider;
+        multiCaller: MultiCaller;
+    };
+    tokenBridger: TokenBridger;
+}>;

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

@@ -0,0 +1,23 @@
+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

@@ -0,0 +1,36 @@
+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

@@ -0,0 +1,18 @@
+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

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

package/dist/constants/chainId.d.ts

@@ -0,0 +1,10 @@
+export declare enum ChainId {
+    MAINNET = 1,
+    RINKEBY = 4,
+    ARBITRUM_ONE = 42161,
+    ARBITRUM_RINKEBY = 421611,
+    OPTIMISM = 10,
+    OPTIMISTIC_KOVAN = 69,
+    POLYGON = 137,
+    POLYGON_MUMBAI = 80001
+}

package/dist/constants/tokens.d.ts

@@ -0,0 +1,5 @@
+import { Token } from '@uniswap/sdk-core';
+export declare const DAI: Token;
+export declare const DAI_ARBITRUM_ONE: Token;
+export declare const DAI_OPTIMISM: Token;
+export declare const DAI_POLYGON: Token;

package/dist/fixtures/index.d.ts

@@ -0,0 +1,24 @@
+import { TokenInfo, TokenList } from '@uniswap/token-lists';
+import { ChainId } from '../constants/chainId';
+export declare const Tokens: Partial<Record<ChainId, Record<string, TokenInfo>>>;
+export declare const sampleL1TokenList: TokenList;
+export declare const arbBridgeL2Address = "0x467194771dae2967aef3ecbedd3bf9a310c76c65";
+export declare const arbBridgeL1Address = "0xd3b5b60020504bc3489d6949d545893982ba3011";
+export declare const arbedSampleTokenList: {
+    name: string;
+    tokens: TokenInfo[];
+    timestamp: string;
+    version: import("@uniswap/token-lists").Version;
+    keywords?: string[] | undefined;
+    tags?: import("@uniswap/token-lists").Tags | undefined;
+    logoURI?: string | undefined;
+};
+export declare const polygonedSampleTokenList: {
+    name: string;
+    tokens: TokenInfo[];
+    timestamp: string;
+    version: import("@uniswap/token-lists").Version;
+    keywords?: string[] | undefined;
+    tags?: import("@uniswap/token-lists").Tags | undefined;
+    logoURI?: string | undefined;
+};

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import { TokenList } from '@uniswap/token-lists';
+import { ChainId } from './constants/chainId';
+import { TokenListOrFetchableTokenList } from './utils';
+/**
+ * Adds bridgeInfo to the given token list for Optimism, Polygon and Arbitrum.
+ * @param l1TokenListOrPathOrUrl
+ * @returns TokenList with l2 bridgeInfo filled
+ */
+export declare function chainify(l1TokenListOrPathOrUrl: TokenListOrFetchableTokenList): Promise<TokenList>;
+/**
+ * Given a network and a TokenList, returns the TokenList with `extensions` filled.
+ * @param chainId chainId to operate on
+ * @param l1TokenListOrPathOrUrl either an L1 TokenList object or a path/url to a TokenList
+ * @returns L1 TokenList with `extensions` filled for the given network
+ */
+export declare function chainifyTokenList(chainId: ChainId, l1TokenListOrPathOrUrl: TokenListOrFetchableTokenList): Promise<TokenList>;
+/** Merges two token lists, resolving conflicts to primary list. */
+export declare function mergeTokenLists(primary: TokenList, secondary: TokenList): TokenList;

package/dist/index.js

@@ -0,0 +1,8 @@
+
+'use strict'
+
+if (process.env.NODE_ENV === 'production') {
+  module.exports = require('./token-list-bridge-utils.cjs.production.min.js')
+} else {
+  module.exports = require('./token-list-bridge-utils.cjs.development.js')
+}

package/dist/providers/ArbitrumMappingProvider.d.ts

@@ -0,0 +1,11 @@
+import { TokenList } from '@uniswap/token-lists';
+import { MappingProvider } from './MappingProvider';
+/**
+ * The Arbitrum team maintains an (unpublished) package to `arbify` an L1
+ * token list.
+ *
+ * The provider simply invokes this package which we host as a submodule.
+ */
+export declare class ArbitrumMappingProvider implements MappingProvider {
+    provide(l1TokenList: TokenList): Promise<TokenList>;
+}

package/dist/providers/MappingProvider.d.ts

@@ -0,0 +1,4 @@
+import { TokenList } from '@uniswap/token-lists';
+export interface MappingProvider {
+    provide(l1TokenList: TokenList): Promise<TokenList>;
+}

package/dist/providers/OptimismMappingProvider.d.ts

@@ -0,0 +1,10 @@
+import { TokenList } from '@uniswap/token-lists';
+import { MappingProvider } from './MappingProvider';
+/**
+ * The Optimism L2 mapping is manually maintained by the Optimism team.
+ *
+ * This provider mostly no-ops, i.e. grabs the list and returns it.
+ */
+export declare class OptimismMappingProvider implements MappingProvider {
+    provide(l1TokenList: TokenList): Promise<TokenList>;
+}

package/dist/providers/PolygonMappingProvider.d.ts

@@ -0,0 +1,9 @@
+import { TokenList } from '@uniswap/token-lists';
+import { MappingProvider } from './MappingProvider';
+/**
+ * The Polygon team manually maintains the mapping via user submissions at
+ * https://mapper.polygon.technology.
+ */
+export declare class PolygonMappingProvider implements MappingProvider {
+    provide(l1TokenList: TokenList): Promise<TokenList>;
+}

package/dist/providers/index.d.ts

@@ -0,0 +1,5 @@
+import { ChainId } from '../constants/chainId';
+import { ArbitrumMappingProvider } from './ArbitrumMappingProvider';
+import { OptimismMappingProvider } from './OptimismMappingProvider';
+import { PolygonMappingProvider } from './PolygonMappingProvider';
+export declare function getMappingProvider(chainId: ChainId): ArbitrumMappingProvider | OptimismMappingProvider | PolygonMappingProvider;