@uniswap/token-list-bridge-utils 2.10.0 → 2.11.0

package/dist/constants/excludedTokens.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Tokens to exclude from being added to the token list.
+ * Key: chainId, Value: Set of lowercase token addresses to exclude on that chain
+ */
+export declare const EXCLUDED_TOKENS: {
+    [chainId: number]: Set<string>;
+};
+/**
+ * Check if a token address should be excluded on a given chain
+ */
+export declare function isTokenExcluded(chainId: number, tokenAddress: string): boolean;

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { TokenList } from '@uniswap/token-lists';
 import { ChainId } from './constants/chainId';
 import { TokenListOrFetchableTokenList } from './utils';
+export { EXCLUDED_TOKENS, isTokenExcluded } from './constants/excludedTokens';
 /**
  * Adds bridgeInfo to the given token list for Optimism, Polygon and Arbitrum.
  * @param l1TokenListOrPathOrUrl

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

@@ -7130,6 +7130,23 @@ var SoneiumMappingProvider = /*#__PURE__*/function () {
   return SoneiumMappingProvider;
 }();
 
+var _EXCLUDED_TOKENS;
+/**
+ * Tokens to exclude from being added to the token list.
+ * Key: chainId, Value: Set of lowercase token addresses to exclude on that chain
+ */
+
+var EXCLUDED_TOKENS = (_EXCLUDED_TOKENS = {}, _EXCLUDED_TOKENS[ChainId.ARBITRUM_ONE] = /*#__PURE__*/new Set(['0xfeb4dfc8c4cf7ed305bb08065d08ec6ee6728429']), _EXCLUDED_TOKENS[ChainId.POLYGON] = /*#__PURE__*/new Set(['0x553d3d295e0f695b9228246232edf400ed3560b5']), _EXCLUDED_TOKENS[ChainId.UNICHAIN] = /*#__PURE__*/new Set(['0x89f7c0870794103744c8042630cc1c846a858e57']), _EXCLUDED_TOKENS);
+/**
+ * Check if a token address should be excluded on a given chain
+ */
+
+function isTokenExcluded(chainId, tokenAddress) {
+  var excludedSet = EXCLUDED_TOKENS[chainId];
+  if (!excludedSet) return false;
+  return excludedSet.has(tokenAddress.toLowerCase());
+}
+
 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, ChainId.CELO, ChainId.BASE, ChainId.UNICHAIN, ChainId.SONEIUM];
@@ -7174,6 +7191,7 @@ function _buildList() {
                       _context2.next = 6;
                       return Promise.all(l2ChainIds.map( /*#__PURE__*/function () {
                         var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(chainId) {
+                          var childTokenAddress;
                           return _regeneratorRuntime.wrap(function _callee$(_context) {
                             while (1) {
                               switch (_context.prev = _context.next) {
@@ -7183,14 +7201,16 @@ function _buildList() {
 
                                 case 2:
                                   chainIdToChildTokenDetailsMap[chainId] = _context.sent;
+                                  childTokenAddress = chainIdToChildTokenDetailsMap[chainId].childTokenAddress; // Only add bridgeInfo if child token is valid and not excluded
 
-                                  if (chainIdToChildTokenDetailsMap[chainId].childTokenValid) {
+                                  // Only add bridgeInfo if child token is valid and not excluded
+                                  if (chainIdToChildTokenDetailsMap[chainId].childTokenValid && childTokenAddress && !isTokenExcluded(chainId, childTokenAddress)) {
                                     l2MappingExtension.extensions.bridgeInfo[chainId] = {
-                                      tokenAddress: chainIdToChildTokenDetailsMap[chainId].childTokenAddress
+                                      tokenAddress: childTokenAddress
                                     };
                                   }
 
-                                case 4:
+                                case 5:
                                 case "end":
                                   return _context.stop();
                               }
@@ -7206,15 +7226,23 @@ function _buildList() {
                     case 6:
                       // build the TokenInfo objects with bridgeInfo extension
                       l2ChainIds.concat([ChainId.MAINNET]).forEach(function (chainId) {
+                        var _chainIdToChildTokenD;
+
+                        var tokenAddress = chainId === ChainId.MAINNET ? l1Token.address : (_chainIdToChildTokenD = chainIdToChildTokenDetailsMap[chainId]) == null ? void 0 : _chainIdToChildTokenD.childTokenAddress; // Skip if token is excluded on this chain
+
+                        if (tokenAddress && isTokenExcluded(chainId, tokenAddress)) {
+                          return;
+                        }
+
                         if (chainId === ChainId.MAINNET || chainIdToChildTokenDetailsMap[chainId].childTokenValid) {
-                          var _chainIdToChildTokenD, _bridgeInfo;
+                          var _chainIdToChildTokenD2, _bridgeInfo;
 
                           var tokenInfo = chainId === ChainId.MAINNET ? _extends({}, l1Token, {
                             extensions: Object.keys(l2MappingExtension.extensions.bridgeInfo).length > 0 ? {
                               bridgeInfo: l2MappingExtension.extensions.bridgeInfo
                             } : undefined
                           }) : _extends({}, l1Token, {
-                            decimals: (_chainIdToChildTokenD = chainIdToChildTokenDetailsMap[chainId].decimals) != null ? _chainIdToChildTokenD : l1Token.decimals,
+                            decimals: (_chainIdToChildTokenD2 = chainIdToChildTokenDetailsMap[chainId].decimals) != null ? _chainIdToChildTokenD2 : l1Token.decimals,
                             chainId: chainId,
                             address: chainIdToChildTokenDetailsMap[chainId].childTokenAddress,
                             extensions: {
@@ -7656,7 +7684,9 @@ function mergeTokenLists(primary, secondary) {
   }));
 }
 
+exports.EXCLUDED_TOKENS = EXCLUDED_TOKENS;
 exports.chainify = chainify;
 exports.chainifyTokenList = chainifyTokenList;
+exports.isTokenExcluded = isTokenExcluded;
 exports.mergeTokenLists = mergeTokenLists;
 //# sourceMappingURL=token-list-bridge-utils.cjs.development.js.map