@uniswap/token-list-bridge-utils 2.0.0 → 2.2.0

package/dist/constants/chainId.d.ts

@@ -9,5 +9,7 @@ export declare enum ChainId {
     POLYGON_MUMBAI = 80001,
     CELO = 42220,
     BNB = 56,
-    AVALANCHE = 43114
+    AVALANCHE = 43114,
+    BASE = 8453,
+    BASE_GOERLI = 84531
 }

package/dist/constants/tokens.d.ts

@@ -1,9 +1,16 @@
 import { Token } from '@uniswap/sdk-core';
+export declare const COINBASE_WRAPPED_STAKED_ETH: Token;
+export declare const COINBASE_WRAPPED_STAKED_ETH_BASE_GOERLI: Token;
+export declare const COINBASE_WRAPPED_STAKED_ETH_BASE: Token;
+export declare const COINBASE_WRAPPED_STAKED_ETH_ARBITRUM_ONE: Token;
+export declare const COINBASE_WRAPPED_STAKED_ETH_OPTIMISM: Token;
 export declare const DAI: Token;
 export declare const DAI_ARBITRUM_ONE: Token;
 export declare const DAI_OPTIMISM: Token;
 export declare const DAI_POLYGON: Token;
 export declare const DAI_BNB: Token;
 export declare const DAI_AVALANCHE: Token;
+export declare const DAI_BASE: Token;
+export declare const DAI_BASE_GOERLI: Token;
 export declare const USDT: Token;
 export declare const USDT_BNB: Token;

package/dist/fixtures/index.d.ts

@@ -3,6 +3,7 @@ import { ChainId } from '../constants/chainId';
 export declare const Tokens: Partial<Record<ChainId, Record<string, TokenInfo>>>;
 export declare const sampleL1TokenList: TokenList;
 export declare const sampleL1TokenList_2: TokenList;
+export declare const sampleL1TokenList_3: TokenList;
 export declare const arbBridgeL2Address = "0x467194771dae2967aef3ecbedd3bf9a310c76c65";
 export declare const arbBridgeL1Address = "0xd3b5b60020504bc3489d6949d545893982ba3011";
 export declare const arbedSampleTokenList: {
@@ -10,6 +11,9 @@ export declare const arbedSampleTokenList: {
     tokens: TokenInfo[];
     timestamp: string;
     version: import("@uniswap/token-lists").Version;
+    tokenMap?: {
+        readonly [key: string]: TokenInfo;
+    } | undefined;
     keywords?: string[] | undefined;
     tags?: import("@uniswap/token-lists").Tags | undefined;
     logoURI?: string | undefined;
@@ -19,6 +23,9 @@ export declare const polygonedSampleTokenList: {
     tokens: TokenInfo[];
     timestamp: string;
     version: import("@uniswap/token-lists").Version;
+    tokenMap?: {
+        readonly [key: string]: TokenInfo;
+    } | undefined;
     keywords?: string[] | undefined;
     tags?: import("@uniswap/token-lists").Tags | undefined;
     logoURI?: string | undefined;
@@ -28,6 +35,9 @@ export declare const avalanchedSampleTokenList: {
     tokens: TokenInfo[];
     timestamp: string;
     version: import("@uniswap/token-lists").Version;
+    tokenMap?: {
+        readonly [key: string]: TokenInfo;
+    } | undefined;
     keywords?: string[] | undefined;
     tags?: import("@uniswap/token-lists").Tags | undefined;
     logoURI?: string | undefined;
@@ -37,6 +47,9 @@ export declare const bnbedSampleTokenList: {
     tokens: TokenInfo[];
     timestamp: string;
     version: import("@uniswap/token-lists").Version;
+    tokenMap?: {
+        readonly [key: string]: TokenInfo;
+    } | undefined;
     keywords?: string[] | undefined;
     tags?: import("@uniswap/token-lists").Tags | undefined;
     logoURI?: string | undefined;
@@ -46,6 +59,33 @@ export declare const bnbedSampleTokenList_2: {
     tokens: TokenInfo[];
     timestamp: string;
     version: import("@uniswap/token-lists").Version;
+    tokenMap?: {
+        readonly [key: string]: TokenInfo;
+    } | undefined;
+    keywords?: string[] | undefined;
+    tags?: import("@uniswap/token-lists").Tags | undefined;
+    logoURI?: string | undefined;
+};
+export declare const baseGoerliSampleTokenList_3: {
+    name: string;
+    tokens: TokenInfo[];
+    timestamp: string;
+    version: import("@uniswap/token-lists").Version;
+    tokenMap?: {
+        readonly [key: string]: TokenInfo;
+    } | undefined;
+    keywords?: string[] | undefined;
+    tags?: import("@uniswap/token-lists").Tags | undefined;
+    logoURI?: string | undefined;
+};
+export declare const baseSampleTokenList_3: {
+    name: string;
+    tokens: TokenInfo[];
+    timestamp: string;
+    version: import("@uniswap/token-lists").Version;
+    tokenMap?: {
+        readonly [key: string]: TokenInfo;
+    } | undefined;
     keywords?: string[] | undefined;
     tags?: import("@uniswap/token-lists").Tags | undefined;
     logoURI?: string | undefined;
@@ -55,6 +95,9 @@ export declare const optimizedSampleTokenList: {
     tokens: TokenInfo[];
     timestamp: string;
     version: import("@uniswap/token-lists").Version;
+    tokenMap?: {
+        readonly [key: string]: TokenInfo;
+    } | undefined;
     keywords?: string[] | undefined;
     tags?: import("@uniswap/token-lists").Tags | undefined;
     logoURI?: string | undefined;

package/dist/providers/BaseGoerliMappingProvider.d.ts

@@ -0,0 +1,9 @@
+import { MappingProvider } from './MappingProvider';
+import { GenericMappedTokenData } from '../constants/types';
+/**
+ * The Base Goerli mapping (linked above) is manually maintained by the Coinbase team
+ * in this repository: https://github.com/ethereum-optimism/ethereum-optimism.github.io.
+ */
+export declare class BaseGoerliMappingProvider implements MappingProvider {
+    provide(): Promise<GenericMappedTokenData>;
+}

package/dist/providers/BaseMappingProvider.d.ts

@@ -0,0 +1,9 @@
+import { MappingProvider } from './MappingProvider';
+import { GenericMappedTokenData } from '../constants/types';
+/**
+ * The Base mapping (linked above) is manually maintained by the Coinbase team
+ * in this repository: https://github.com/ethereum-optimism/ethereum-optimism.github.io.
+ */
+export declare class BaseMappingProvider implements MappingProvider {
+    provide(): Promise<GenericMappedTokenData>;
+}

package/dist/token-list-bridge-utils.cjs.development.js

@@ -899,6 +899,8 @@ var ChainId;
   ChainId[ChainId["CELO"] = 42220] = "CELO";
   ChainId[ChainId["BNB"] = 56] = "BNB";
   ChainId[ChainId["AVALANCHE"] = 43114] = "AVALANCHE";
+  ChainId[ChainId["BASE"] = 8453] = "BASE";
+  ChainId[ChainId["BASE_GOERLI"] = 84531] = "BASE_GOERLI";
 })(ChainId || (ChainId = {}));
 
 function compareTokenInfos(t1, t2) {
@@ -1124,6 +1126,12 @@ function getRpcUrl(chainId) {
 
     case ChainId.AVALANCHE:
       return 'https://api.avax.network/ext/bc/C/rpc';
+
+    case ChainId.BASE:
+      return 'https://mainnet.base.org';
+
+    case ChainId.BASE_GOERLI:
+      return 'https://goerli.base.org';
   }
 
   throw new Error('Unsupported ChainId');
@@ -1161,7 +1169,13 @@ var _process$env, _process$env$MAINNET_;
 dotenv.config();
 (_process$env$MAINNET_ = (_process$env = process.env).MAINNET_RPC) != null ? _process$env$MAINNET_ : _process$env.MAINNET_RPC = /*#__PURE__*/getRpcUrl(ChainId.MAINNET);
 
-var networkID = 42161; // ref: https://github.com/OffchainLabs/arb-token-lists/blob/master/src/lib/instantiate_bridge.ts
+var networkID = 42161;
+
+var l2Rpc = function l2Rpc(chainId) {
+  if (chainId === 42161) return 'https://arb1.arbitrum.io/rpc';else if (chainId === 421611) return 'https://rinkeby.arbitrum.io/rpc';else if (chainId === 42170) return 'https://nova.arbitrum.io/rpc';else if (chainId === 421613) return 'https://goerli-rollup.arbitrum.io/rpc';
+  throw new Error('No L2 RPC detected');
+}; // ref: https://github.com/OffchainLabs/arb-token-lists/blob/master/src/lib/instantiate_bridge.ts
+
 
 var getNetworkConfig = /*#__PURE__*/function () {
   var _ref = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
@@ -1189,8 +1203,8 @@ var getNetworkConfig = /*#__PURE__*/function () {
 
           case 11:
             l1Network = _context.sent;
-            arbProvider = new ethers.providers.JsonRpcProvider(l2Network.rpcURL);
-            ethProvider = new ethers.providers.JsonRpcProvider(l1Network.rpcURL);
+            arbProvider = new ethers.providers.JsonRpcProvider(l2Rpc(l2Network.chainID));
+            ethProvider = new ethers.providers.JsonRpcProvider(process.env.MAINNET_RPC);
             _context.next = 16;
             return MultiCaller.fromProvider(ethProvider);
 
@@ -1325,7 +1339,7 @@ var ArbitrumMappingProvider = /*#__PURE__*/function () {
   return ArbitrumMappingProvider;
 }();
 
-var optimismTokenListURL = 'https://raw.githubusercontent.com/' + 'ethereum-optimism/ethereum-optimism.github.io/2138386277e4156d159615d1840882cecc398437/optimism.tokenlist.json';
+var optimismTokenListURL = 'https://raw.githubusercontent.com/' + 'ethereum-optimism/ethereum-optimism.github.io/master/optimism.tokenlist.json';
 /**
  * The Optimism L2 mapping (linked above) is manually maintained by the Optimism team.
  *
@@ -1339,8 +1353,7 @@ var OptimismMappingProvider = /*#__PURE__*/function () {
 
   _proto.provide = /*#__PURE__*/function () {
     var _provide = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
-      var tokens, optimismTokens, _iterator, _step, token, _token$extensions;
-
+      var tokens, allTokens, opTokenId_baseAddressMap;
       return _regeneratorRuntime.wrap(function _callee$(_context) {
         while (1) {
           switch (_context.prev = _context.next) {
@@ -1350,19 +1363,27 @@ var OptimismMappingProvider = /*#__PURE__*/function () {
               return getTokenList(optimismTokenListURL);
 
             case 3:
-              optimismTokens = _context.sent;
-
-              for (_iterator = _createForOfIteratorHelperLoose(optimismTokens.tokens); !(_step = _iterator()).done;) {
-                token = _step.value;
-
-                if (token.chainId === ChainId.MAINNET) {
-                  tokens[token.address.toLowerCase()] = token == null ? void 0 : (_token$extensions = token.extensions) == null ? void 0 : _token$extensions.bridgeInfo[ChainId.OPTIMISM].tokenAddress;
+              allTokens = _context.sent;
+              opTokenId_baseAddressMap = {};
+              allTokens.tokens.forEach(function (token) {
+                if (token.chainId === ChainId.OPTIMISM) {
+                  var _token$extensions;
+
+                  if (typeof ((_token$extensions = token.extensions) == null ? void 0 : _token$extensions.opTokenId) === 'string') {
+                    opTokenId_baseAddressMap[token.extensions.opTokenId] = token.address;
+                  }
                 }
-              }
+              });
+              allTokens.tokens.forEach(function (token) {
+                var _token$extensions2;
 
+                if (token.chainId === ChainId.MAINNET && typeof ((_token$extensions2 = token.extensions) == null ? void 0 : _token$extensions2.opTokenId) === 'string' && token.extensions.opTokenId in opTokenId_baseAddressMap) {
+                  tokens[token.address.toLowerCase()] = opTokenId_baseAddressMap[token.extensions.opTokenId];
+                }
+              });
               return _context.abrupt("return", tokens);
 
-            case 6:
+            case 8:
             case "end":
               return _context.stop();
           }
@@ -5690,9 +5711,131 @@ var AvalancheMappingProvider = /*#__PURE__*/function () {
   return AvalancheMappingProvider;
 }();
 
+var baseGoerliTokenListURL$1 = 'https://raw.githubusercontent.com/' + 'ethereum-optimism/ethereum-optimism.github.io/master/optimism.tokenlist.json';
+/**
+ * The Base Goerli mapping (linked above) is manually maintained by the Coinbase team
+ * in this repository: https://github.com/ethereum-optimism/ethereum-optimism.github.io.
+ */
+
+var BaseGoerliMappingProvider = /*#__PURE__*/function () {
+  function BaseGoerliMappingProvider() {}
+
+  var _proto = BaseGoerliMappingProvider.prototype;
+
+  _proto.provide = /*#__PURE__*/function () {
+    var _provide = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
+      var tokens, allTokens, opTokenId_baseGoerliAddressMap;
+      return _regeneratorRuntime.wrap(function _callee$(_context) {
+        while (1) {
+          switch (_context.prev = _context.next) {
+            case 0:
+              tokens = {};
+              _context.next = 3;
+              return getTokenList(baseGoerliTokenListURL$1);
+
+            case 3:
+              allTokens = _context.sent;
+              opTokenId_baseGoerliAddressMap = {};
+              allTokens.tokens.forEach(function (token) {
+                if (token.chainId === ChainId.BASE_GOERLI) {
+                  var _token$extensions;
+
+                  if (typeof ((_token$extensions = token.extensions) == null ? void 0 : _token$extensions.opTokenId) === 'string') {
+                    opTokenId_baseGoerliAddressMap[token.extensions.opTokenId] = token.address;
+                  }
+                }
+              });
+              allTokens.tokens.forEach(function (token) {
+                var _token$extensions2;
+
+                if (token.chainId === ChainId.MAINNET && typeof ((_token$extensions2 = token.extensions) == null ? void 0 : _token$extensions2.opTokenId) === 'string' && token.extensions.opTokenId in opTokenId_baseGoerliAddressMap) {
+                  tokens[token.address.toLowerCase()] = opTokenId_baseGoerliAddressMap[token.extensions.opTokenId];
+                }
+              });
+              return _context.abrupt("return", tokens);
+
+            case 8:
+            case "end":
+              return _context.stop();
+          }
+        }
+      }, _callee);
+    }));
+
+    function provide() {
+      return _provide.apply(this, arguments);
+    }
+
+    return provide;
+  }();
+
+  return BaseGoerliMappingProvider;
+}();
+
+var baseGoerliTokenListURL = 'https://raw.githubusercontent.com/' + 'ethereum-optimism/ethereum-optimism.github.io/master/optimism.tokenlist.json';
+/**
+ * The Base mapping (linked above) is manually maintained by the Coinbase team
+ * in this repository: https://github.com/ethereum-optimism/ethereum-optimism.github.io.
+ */
+
+var BaseMappingProvider = /*#__PURE__*/function () {
+  function BaseMappingProvider() {}
+
+  var _proto = BaseMappingProvider.prototype;
+
+  _proto.provide = /*#__PURE__*/function () {
+    var _provide = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
+      var tokens, allTokens, opTokenId_baseAddressMap;
+      return _regeneratorRuntime.wrap(function _callee$(_context) {
+        while (1) {
+          switch (_context.prev = _context.next) {
+            case 0:
+              tokens = {};
+              _context.next = 3;
+              return getTokenList(baseGoerliTokenListURL);
+
+            case 3:
+              allTokens = _context.sent;
+              opTokenId_baseAddressMap = {};
+              allTokens.tokens.forEach(function (token) {
+                if (token.chainId === ChainId.BASE) {
+                  var _token$extensions;
+
+                  if (typeof ((_token$extensions = token.extensions) == null ? void 0 : _token$extensions.opTokenId) === 'string') {
+                    opTokenId_baseAddressMap[token.extensions.opTokenId] = token.address;
+                  }
+                }
+              });
+              allTokens.tokens.forEach(function (token) {
+                var _token$extensions2;
+
+                if (token.chainId === ChainId.MAINNET && typeof ((_token$extensions2 = token.extensions) == null ? void 0 : _token$extensions2.opTokenId) === 'string' && token.extensions.opTokenId in opTokenId_baseAddressMap) {
+                  tokens[token.address.toLowerCase()] = opTokenId_baseAddressMap[token.extensions.opTokenId];
+                }
+              });
+              return _context.abrupt("return", tokens);
+
+            case 8:
+            case "end":
+              return _context.stop();
+          }
+        }
+      }, _callee);
+    }));
+
+    function provide() {
+      return _provide.apply(this, arguments);
+    }
+
+    return provide;
+  }();
+
+  return BaseMappingProvider;
+}();
+
 var web3 = /*#__PURE__*/new Web3__default["default"](); // chains we support fetching mappings for (can be different than the l2ChainIds arg for buildList)
 
-var CHAINS_WITH_MAPPING_PROVIDERS = [ChainId.ARBITRUM_ONE, ChainId.POLYGON, ChainId.OPTIMISM, ChainId.BNB, ChainId.AVALANCHE];
+var CHAINS_WITH_MAPPING_PROVIDERS = [ChainId.ARBITRUM_ONE, ChainId.POLYGON, ChainId.OPTIMISM, ChainId.BNB, ChainId.AVALANCHE, ChainId.BASE, ChainId.BASE_GOERLI];
 function buildList(_x, _x2) {
   return _buildList.apply(this, arguments);
 } // using a symbol lookup contract call to check whether the token exists on the L2
@@ -5884,6 +6027,12 @@ function getMappingProvider(chainId, l1TokenList) {
     case ChainId.AVALANCHE:
       return new AvalancheMappingProvider();
 
+    case ChainId.BASE:
+      return new BaseMappingProvider();
+
+    case ChainId.BASE_GOERLI:
+      return new BaseGoerliMappingProvider();
+
     default:
       throw new Error("Chain " + chainId + " not supported for fetching mappings.");
   }
@@ -5947,18 +6096,27 @@ function getChildTokenDetails(_x7, _x8, _x9) {
 
 function _getChildTokenDetails() {
   _getChildTokenDetails = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee5(l1Token, chainId, chainIdToMappingsMap) {
-    var _l1Token$extensions, _l1Token$extensions$b, _l1Token$extensions$b2;
+    var _l1Token$extensions;
 
-    var existingMapping, childToken, childTokenAddress, childTokenValid, decimals;
+    var bridgeInfo, existingMapping, bridgeInfoForChain, childToken, childTokenAddress, childTokenValid, decimals;
     return _regeneratorRuntime.wrap(function _callee5$(_context6) {
       while (1) {
         switch (_context6.prev = _context6.next) {
           case 0:
-            existingMapping = l1Token == null ? void 0 : (_l1Token$extensions = l1Token.extensions) == null ? void 0 : (_l1Token$extensions$b = _l1Token$extensions.bridgeInfo) == null ? void 0 : (_l1Token$extensions$b2 = _l1Token$extensions$b[chainId]) == null ? void 0 : _l1Token$extensions$b2.tokenAddress; // use the externally fetched mappings if manual entry doesn't exist for the token/chain mapping
+            bridgeInfo = l1Token == null ? void 0 : (_l1Token$extensions = l1Token.extensions) == null ? void 0 : _l1Token$extensions.bridgeInfo;
+
+            if (bridgeInfo && typeof bridgeInfo === 'object') {
+              bridgeInfoForChain = bridgeInfo[chainId];
+
+              if (bridgeInfoForChain && typeof bridgeInfoForChain === 'object') {
+                existingMapping = bridgeInfoForChain.tokenAddress;
+              }
+            } // use the externally fetched mappings if manual entry doesn't exist for the token/chain mapping
             // and the given chain is supported for fetching mappings
 
+
             if (!(CHAINS_WITH_MAPPING_PROVIDERS.includes(chainId) && existingMapping === undefined)) {
-              _context6.next = 14;
+              _context6.next = 15;
               break;
             }
 
@@ -5968,17 +6126,17 @@ function _getChildTokenDetails() {
             _context6.t1 = childTokenAddress;
 
             if (!_context6.t1) {
-              _context6.next = 10;
+              _context6.next = 11;
               break;
             }
 
-            _context6.next = 9;
+            _context6.next = 10;
             return hasExistingTokenContract(childTokenAddress, chainId);
 
-          case 9:
+          case 10:
             _context6.t1 = _context6.sent;
 
-          case 10:
+          case 11:
             _context6.t2 = _context6.t1;
             childTokenValid = (0, _context6.t0)(_context6.t2);
             decimals = childToken && (chainId === ChainId.BNB || chainId === ChainId.AVALANCHE) ? childToken.decimals : undefined;
@@ -5988,13 +6146,13 @@ function _getChildTokenDetails() {
               decimals: decimals
             });
 
-          case 14:
+          case 15:
             return _context6.abrupt("return", {
               childTokenValid: !!existingMapping,
               childTokenAddress: existingMapping
             });
 
-          case 15:
+          case 16:
           case "end":
             return _context6.stop();
         }
@@ -6084,7 +6242,7 @@ function chainify(_x) {
 
 function _chainify() {
   _chainify = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(l1TokenListOrPathOrUrl) {
-    var l1TokenList, l2Chains, chainified;
+    var l1TokenList, l2Chains, chainified, merged;
     return _regeneratorRuntime.wrap(function _callee$(_context) {
       while (1) {
         switch (_context.prev = _context.next) {
@@ -6094,16 +6252,17 @@ function _chainify() {
 
           case 2:
             l1TokenList = _context.sent;
-            l2Chains = [ChainId.POLYGON, ChainId.ARBITRUM_ONE, ChainId.OPTIMISM, ChainId.CELO, ChainId.BNB, ChainId.AVALANCHE];
+            l2Chains = [ChainId.POLYGON, ChainId.ARBITRUM_ONE, ChainId.OPTIMISM, ChainId.CELO, ChainId.BNB, ChainId.AVALANCHE, ChainId.BASE, ChainId.BASE_GOERLI];
             _context.next = 6;
             return chainifyTokenList(l2Chains, l1TokenListOrPathOrUrl);
 
           case 6:
             chainified = _context.sent;
-            return _context.abrupt("return", mergeTokenLists(l1TokenList, // providing l1 first to make sure duplicated tokens resolve to this list
-            chainified));
+            merged = mergeTokenLists(l1TokenList, // providing l1 first to make sure duplicated tokens resolve to this list
+            chainified);
+            return _context.abrupt("return", merged);
 
-          case 8:
+          case 9:
           case "end":
             return _context.stop();
         }
@@ -6168,7 +6327,7 @@ function mergeTokenLists(primary, secondary) {
 
     var merged = lodash.merge(group[0], group[1]);
 
-    if ((_merged$extensions = merged.extensions) != null && _merged$extensions.bridgeInfo) {
+    if ((_merged$extensions = merged.extensions) != null && _merged$extensions.bridgeInfo && typeof merged.extensions.bridgeInfo === 'object') {
       // remove reference to self-chain from merge
       delete merged.extensions.bridgeInfo[merged.chainId];
     }