Master

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Polygon (previously Matic)
+Copyright (c) 2023 PT Services DMCC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,22 +1,18 @@
-# polygon-token-list
+# Tokenlists
 
-This repo contains the token lists to be used in Polygon products' interfaces.
+This repo contains lists of tokens mapped to the Polygon chains that may be used in certain interfaces.
 
 ## Different Token Lists in JSON
 
 The JSON schema for the tokens includes: chainId, name, address, decimals, symbol, logoURI (optional), tags (optional), and custom extensions metadata.
 
-There are two token lists that we are maintaining currently on mainet and another one on testnet:
+1. [Mapped Tokens List](https://api-polygon-tokens.polygon.technology/tokenlists/polygon.tokenlist.json) Contains tokens that are mapped to Polygon PoS and Polygon zkEVM. Anyone can propose updates to this list.
 
-1. [Polygon Tokens List](https://api-polygon-tokens.polygon.technology/tokenlists/polygon.tokenlist.json) contains all the valid tokens that are mapped on the Polygon PoS chain. The community can raise token addition and updation issues to help us keep the token list up-to-date.
-
-2. [Popular Tokens List](https://api-polygon-tokens.polygon.technology/tokenlists/polygonPopular.tokenlist.json) is a subset of the allTokens list. It contains the mostly used tokens on Polygon products.
+2. [Popular Tokens List](https://api-polygon-tokens.polygon.technology/tokenlists/polygonPopular.tokenlist.json) Contains the top 100 most used tokens on the Polygon chains.
 
 3. [Testnet Tokens List](https://api-polygon-tokens.polygon.technology/tokenlists/polygonTestnet.tokenlist.json) contains the tokens mapped on the Mumbai chain.
 
-Apart from these 3 token list there is one blacklisted token list:
-
-1. [Blacklist Tokens List](https://api-polygon-tokens.polygon.technology/tokenlists/blacklist.tokenlist.json) contains all the blacklisted tokens which should be filtered out from the UI.
+4. [Blacklist Tokens List](https://api-polygon-tokens.polygon.technology/tokenlists/blacklist.tokenlist.json) Contains tokens that have been flagged for issues.
 
 ## Adding or Updating a token
 

src/build.js

@@ -6,6 +6,7 @@ const zkevmPopularTokens = require("./tokens/zkevmPopularTokens.json");
 const allPolygonTokens = require("./tokens/polygon.json");
 const allPolygonTestnetTokens = require("./tokens/polygonTestnet.json");
 const allPolygonPopularTokens = require("./tokens/polygonPopular.json");
+const allPolygonTestnetPopularTokens = require("./tokens/polygonTestnetPopular.json");
 const polygonTokensTokenList = require("./metadata/polygonTokens.json");
 const popularTokenList = require("./metadata/popularTokens.json");
 const testnetTokenList = require("./metadata/testnetTokens.json");
@@ -14,6 +15,7 @@ const zkevmPopularTokenList = require("./metadata/zkevmPopularTokens.json");
 const allPolygonTokenList = require("./metadata/polygon.json");
 const allPolygonTestnetTokenList = require("./metadata/polygonTestnet.json");
 const allPolygonPopularTokenList = require("./metadata/polygonPopular.json");
+const allPolygonTestnetPopularTokenList = require("./metadata/polygonTestnetPopular.json");
 
 // Cross-chain lists
 const ccTokenList = require("./metadata/crossChain.json");
@@ -63,6 +65,10 @@ module.exports = function buildList() {
         timestamp,
         tokens: allPolygonTestnetTokens,
     }); // Aggregated Polygon Testnet Tokens List
+    Object.assign(allPolygonTestnetPopularTokenList, {
+        timestamp,
+        tokens: allPolygonTestnetPopularTokens,
+    }); // Aggregated Polygon Testnet Popular Tokens List
     Object.assign(polygonTokensTokenList, { timestamp, tokens: polygonTokens }); // PolygonTokens tokenlist
     Object.assign(popularTokenList, { timestamp, tokens: popularTokens }); // popular tokenlist
     Object.assign(zkevmPopularTokenList, {
@@ -91,6 +97,7 @@ module.exports = function buildList() {
         allPolygonTokenList,
         allPolygonPopularTokenList,
         allPolygonTestnetTokenList,
+        allPolygonTestnetPopularTokenList,
         polygonTokensTokenList,
         popularTokenList,
         zkevmPopularTokenList,

src/metadata/polygon.json

@@ -1,5 +1,5 @@
 {
-    "name": "Polygon Tokens",
+    "name": "Mapped Tokens",
     "version": {
         "major": 1,
         "minor": 0,

src/metadata/polygonTestnet.json

@@ -1,5 +1,5 @@
 {
-    "name": "Polygon Testnet",
+    "name": "Mapped Testnet",
     "version": {
         "major": 1,
         "minor": 0,

src/metadata/polygonTestnetPopular.json

@@ -0,0 +1,68 @@
+{
+    "name": "Testnet Popular",
+    "version": {
+        "major": 1,
+        "minor": 0,
+        "patch": 0
+    },
+    "logoURI": "https://assets.polygon.technology/tokenAssets/matic.svg",
+    "keywords": ["polygon", "default", "tokens", "PoS", "zkEVM"],
+    "tags": {
+        "stablecoin": {
+            "name": "Stablecoin",
+            "description": "Tokens that are fixed to an external asset, e.g. the US dollar"
+        },
+        "swapable": {
+            "name": "Swapable",
+            "description": "Tokens are eligible for swaps"
+        },
+        "native": {
+            "name": "Native",
+            "description": "Tokens are native tokens of the chain"
+        },
+        "erc20": {
+            "name": "ERC20",
+            "description": "Tokens are of ERC20 token type"
+        },
+        "pos": {
+            "name": "PoS",
+            "description": "PoS tokens"
+        },
+        "fx": {
+            "name": "Fx",
+            "description": "fx tokens"
+        },
+        "plasma": {
+            "name": "Plasma",
+            "description": "Plasma tokens"
+        },
+        "lxly": {
+            "name": "LxLy",
+            "description": "LxLy tokens"
+        },
+        "metaTx": {
+            "name": "MetaTx",
+            "description": "Tokens are eligible for meta transactions"
+        },
+        "customSig": {
+            "name": "Custom Withdraw Sig",
+            "description": "The token has a custom withdraw event signature"
+        },
+        "noDeposit": {
+            "name": "Deposit Disabled",
+            "description": "Tokens are not eligible for deposits"
+        },
+        "noWithdraw": {
+            "name": "Withdraw Disabled",
+            "description": "Tokens are not eligible for withdraws"
+        },
+        "customZkevmBridge": {
+            "name": "Custom Zkevm Bridge",
+            "description": "Tokens that are bridged using zkEVM messaging layer"
+        },
+        "legacy": {
+            "name": "Legacy Token",
+            "description": "Tokens that are legacy"
+        }
+    }
+}

src/metadata/polygonTokens.json

@@ -1,5 +1,5 @@
 {
-    "name": "Polygon Tokens",
+    "name": "Mapped Tokens",
     "version": {
         "major": 3,
         "minor": 2,

src/metadata/testnetTokens.json

@@ -1,5 +1,5 @@
 {
-    "name": "Polygon Testnet",
+    "name": "Mapped Testnet",
     "version": {
         "major": 1,
         "minor": 1,