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

package/README.md

@@ -1,6 +1,105 @@
-# DTS User Guide
+# Token List Bridge Utils
 
-## Commands
+## Description
+This package contains utility functions used for converting an L1 token list into a cross-chain tokenlist by adding cross-chain mapping information for Arbitrum, Optimism, and Polygon to a given L1 list.
+
+Mappings get added in the form of an extensions field, following this [schema](https://github.com/Uniswap/token-lists/issues/51#issuecomment-952268629).
+(Currently does not fill information for origin and destination bridge addresses)
+
+ex:
+
+      "name": "Uniswap",
+      "address": "0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984",
+      "symbol": "UNI",
+      "decimals": 18,
+      "chainId": 1,
+      "logoURI": "ipfs://QmXttGpZrECX5qCyXbBQiqgQNytVGeZW5Anewvh2jc4psg",
+      "extensions": {
+        "bridgeInfo": {
+          "10": {
+            "tokenAddress": "0x6fd9d7AD17242c41f7131d257212c54A0e816691"
+          },
+          "137": {
+            "tokenAddress": "0xb33EaAd8d922B1083446DC23f610c2567fB5180f"
+          },
+          "42161": {
+            "tokenAddress": "0xFa7F8980b0f1E64A2062791cc3b0871572f1F7f0"
+          }
+        }
+      }}
+Also adds a "root-level" token entry for each of the L2's that a token maps to.
+
+ex. for Optimism:
+`
+
+    {
+      "name": "Uniswap",
+      "address": "0x6fd9d7AD17242c41f7131d257212c54A0e816691",
+      "symbol": "UNI",
+      "decimals": 18,
+      "chainId": 10,
+      "logoURI": "ipfs://QmXttGpZrECX5qCyXbBQiqgQNytVGeZW5Anewvh2jc4psg",
+      "extensions": {
+        "bridgeInfo": {
+          "1": {
+            "tokenAddress": "0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984"
+          }
+        }
+      }
+    }
+`
+
+## Functions Overview
+
+chainify
+
+ * Adds bridgeInfo to the given token list for Optimism, Polygon and Arbitrum.
+ * @param l1TokenListOrPathOrUrl
+ * @returns TokenList with l2 bridgeInfo filled
+
+
+chainifyTokenList
+
+ * Given a chain ID (Optimism, Polygon, or Arbitrum) 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
+
+
+mergeTokenLists
+ * Merges two token lists, resolving conflicts to primary list.
+ * @param primary primary token list to resolve conflicts to
+ * @param secondary secondary token list
+ * @returns merged token list
+
+## Usage (from external package):
+### Install Package
+`yarn add @uniswap/token-list-bridge-utils`
+
+or
+
+`npm i @uniswap/token-list-bridge-utils`
+
+### Call Function
+#### CommonJS
+`const bridge_utils  = require('@uniswap/token-list-bridge-utils');`
+
+`let chainifiedList = await bridge_utils.chainify(tokenList);`
+#### ESM
+`import { chainify } from '@uniswap/token-list-bridge-utils';`
+
+`let chainifiedList = await chainify(tokenList);`
+
+## Run Tests
+
+`yarn install`
+
+`yarn build`
+
+`yarn test`
+
+
+## DTS User Guide
 
 DTS scaffolds your new library inside `/src`.
 
@@ -12,6 +111,4 @@ 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`.
+To do a one-off build, use `npm run build` or `yarn build`.

package/dist/arbitrum/gateway.d.ts

@@ -0,0 +1,2 @@
+import { MultiCaller } from '@arbitrum/sdk';
+export declare const getL2TokenAddressesFromL1: (l1TokenAddresses: string[], multiCaller: MultiCaller, l1GatewayRouterAddress: string) => Promise<(string | undefined)[]>;

package/dist/{arb-token-lists/src/lib → arbitrum}/instantiate_bridge.d.ts

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

package/dist/constants/types.d.ts

@@ -0,0 +1,30 @@
+export interface PolygonMappedToken {
+    chainId: number;
+    child_address_passed_by_user: boolean;
+    child_token: string;
+    count: number;
+    created_at: string;
+    decimals: number;
+    deleted: boolean;
+    id: number;
+    map_type: 'POS';
+    mintable: boolean;
+    name: string;
+    new_child_token: string;
+    new_mintable: boolean;
+    owner: string;
+    reason: string;
+    reason_for_remapping: string;
+    remapping_allowed: boolean;
+    remapping_request_submitted: boolean;
+    remapping_verified: boolean;
+    root_token: string;
+    status: number;
+    symbol: string;
+    token_type: string;
+    updated_at: string;
+    uri: string;
+}
+export declare type PolygonMappedTokenData = {
+    [key: string]: PolygonMappedToken;
+};

package/dist/fixtures/index.d.ts

@@ -22,3 +22,12 @@ export declare const polygonedSampleTokenList: {
     tags?: import("@uniswap/token-lists").Tags | undefined;
     logoURI?: string | undefined;
 };
+export declare const optimizedSampleTokenList: {
+    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/providers/ArbitrumMappingProvider.d.ts

@@ -1,11 +1,12 @@
-import { TokenList } from '@uniswap/token-lists';
 import { MappingProvider } from './MappingProvider';
+import { TokenList } from '@uniswap/token-lists';
 /**
- * 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.
+ * This provider provides the l1->l2(Arbitrum) address mappings using the arbitrum SDK.
  */
 export declare class ArbitrumMappingProvider implements MappingProvider {
-    provide(l1TokenList: TokenList): Promise<TokenList>;
+    l1TokenList: TokenList;
+    constructor(l1TokenList: TokenList);
+    provide(): Promise<{
+        [key: string]: string | undefined;
+    }>;
 }

package/dist/providers/MappingProvider.d.ts

@@ -1,4 +1,6 @@
-import { TokenList } from '@uniswap/token-lists';
+import { PolygonMappedTokenData } from '../constants/types';
 export interface MappingProvider {
-    provide(l1TokenList: TokenList): Promise<TokenList>;
+    provide(): Promise<PolygonMappedTokenData | {
+        [key: string]: string | undefined;
+    }>;
 }

package/dist/providers/OptimismMappingProvider.d.ts

@@ -1,10 +1,11 @@
-import { TokenList } from '@uniswap/token-lists';
 import { MappingProvider } from './MappingProvider';
 /**
- * The Optimism L2 mapping is manually maintained by the Optimism team.
+ * The Optimism L2 mapping (linked above) is manually maintained by the Optimism team.
  *
- * This provider mostly no-ops, i.e. grabs the list and returns it.
+ * This provider provides the l1->l2(Optimism) token mappings.
  */
 export declare class OptimismMappingProvider implements MappingProvider {
-    provide(l1TokenList: TokenList): Promise<TokenList>;
+    provide(): Promise<{
+        [key: string]: string | undefined;
+    }>;
 }

package/dist/providers/PolygonMappingProvider.d.ts

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

package/dist/providers/index.d.ts

@@ -1,5 +1,3 @@
 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;
+import { TokenList } from '@uniswap/token-lists';
+export declare function buildList(chainId: ChainId, l1TokenList: TokenList): Promise<TokenList>;