Master

.github/workflows/deploy_gcp.yaml

@@ -0,0 +1,28 @@
+name: Polygon Tokenlist api GCP docker publish image
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Tag to build and push'
+        required: true
+        type: string
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  generate-version:
+    uses: 0xPolygon/pipelines/.github/workflows/generate_version.yaml@main
+
+  docker-release:
+    needs:
+        - generate-version  
+    uses: 0xPolygon/pipelines/.github/workflows/gcp_pipeline_release_image.yaml@main    
+    with:
+        image_name: "api-polygon-tokens"
+        image_tag: ${{ inputs.tag || needs.generate-version.outputs.version }}
+        checkout_ref: ${{ github.ref_name }}

.github/workflows/ecs_prod.yml

@@ -23,13 +23,6 @@ jobs:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - uses: actions/checkout@v2
 
-      # Runs a set of commands using the runners shell
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Build tokenlists
-        run: npm run build
-
       - name: Configure AWS credentials
         uses: aws-actions/configure-aws-credentials@v2
         with:

Dockerfile

@@ -1,12 +1,26 @@
-#Serve the app with NGINX
+########################
+# 1️⃣ Build the project
+########################
+FROM node:24-alpine AS builder
+
+# Create app directory
+WORKDIR /app
+
+COPY package*.json ./
+RUN npm ci --ignore-scripts
+
+# Copy the rest of the source and build
+COPY . .
+RUN npm run build
+
+########################
+# 2️⃣ Serve with NGINX
+########################
 FROM nginx:alpine
 
-# Copy the build files from the dist folder to /usr/share/nginx/html
-COPY build /usr/share/nginx/html
+# Copy the compiled static bundle
+COPY --from=builder /app/build /usr/share/nginx/html
 COPY nginx.conf /etc/nginx/conf.d/default.conf
 
-# Expose the desired port (default is 80 for NGINX)
 EXPOSE 3000
-
-# Start NGINX
 CMD ["nginx", "-g", "daemon off;"]

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,75 +1,54 @@
-# 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.
+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](https://api-polygon-tokens.polygon.technology/tokenlists/mapped.tokenlist.json) Contains tokens that are mapped to Polygon bridges. Anyone can propose updates to this list.
 
-1. [Polygon Tokens List](https://api-polygon-tokens.polygon.technology/tokenlists/polygonTokens.tokenlist.json) contains all the tokens added by the community 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](https://api-polygon-tokens.polygon.technology/tokenlists/popular.tokenlist.json) Contains the top 100 most used tokens on the mainnet chains.
 
-2. [Popular Tokens List](https://api-polygon-tokens.polygon.technology/tokenlists/popularTokens.tokenlist.json) is a subset of the allTokens list. It contains the mostly used tokens on Polygon Wallet Web.
+3. [Mapped Tokens Testnet](https://api-polygon-tokens.polygon.technology/tokenlists/mappedTestnet.tokenlist.json) ontains tokens that are mapped to Polygon bridges on testnet chains. Anyone can propose updates to this list.
 
-3. [Testnet Tokens List](https://api-polygon-tokens.polygon.technology/tokenlists/testnet.tokenlist.json) contains the tokens mapped on the Mumbai chain.
+4. [Popular Tokens Testnet](https://api-polygon-tokens.polygon.technology/tokenlists/popularTestnet.tokenlist.json) Contains the most used tokens on the testnet chains.
 
-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.
-
-## Adding or Updating a token
+## Updating a token
 
 1. Fork the repository
 
-2. Add the new token at the end of the token array in `src/tokens/polygonTokens.json`
-
-    Please make sure that the new token follows this schema.
-
-    ```json
-    {
-        "chainId": 137, // Should always be 137
-        "name": "token_name",
-        "symbol": "token_symbol",
-        "decimals": <token_decimals>,
-        "address": "token_address on Polygon",
-        "logoURI": "token_icon_uri",
-        "tags": ["<bridge>", "<token_type>", "<optional_tag>", "<optional_tag>", ...], // For all acceptable tags, check below
-        "extensions": {
-            "rootAddress": "token_address on Ethereum", // If not deployed on ethereum, use "0x0000000000000000000000000000000000000000" and add noDeposit and noWithdraw tags
-            "project": {
-                "name": "Project_Name",
-                "summary": "Short_Project_Description",
-                "contact": "Project_Support",
-                "website": "Project_Website"
-            }
-        }
-    }
-    ```
+2. Update the token in the token array of `src/tokens/mapped.json` for mainnet or `src/tokens/mappedTestnet.json` for testnet
+
+    Please make sure that the updated token do not disturb the schema.
 
     ### Tags
 
-    1. `stablecoin`: Tokens that are pegged to a fiat asset, e.g. USDC, USDT
+    1. `lxly`: Tokens that are bridged using the LxLy bridge (Agg Layer v1)
+
+    2. `pos`: Tokens that are bridged using the PoS bridge
+
+    3. `plasma`: Tokens that are bridged using the PLASMA bridge
+
+    4. `fx`: Tokens that are bridged using the FX
+
+    5. `customBridge`: Token mapped through custom bridges
 
-    2. `swapable`: Tokens are eligible for swapping through the 0x contracts
+    6. `zkevmMessageBridge`: Token mapped through zkevmMessageBridge bridge
 
-    3. `erc20`: Tokens are of ERC20 token type
+    7. `customFx`: Token mapped through customFx bridge
 
-    4. `pos`: Tokens can be bridged from Ethereum using the PoS bridge
-       Note: Also use this tag if the tokens cannot be bridged.
+    8. `erc20`: Token of ERC20 token type
 
-    5. `plasma`: Tokens can be bridged from Ethereum using the PLASMA bridge
+    9. `governanceToken`: Governance token of the chain
 
-    6. `metaTx`: Tokens are eligible for meta transactions
-       Note: Use this tag if the tokens support meta transactions and can be used for a gasless swaps.
+    10. `nativeToken`: Native token of the chain
 
-    7. `customWithdrawEventSig`: The token has its custom withdraw event signature and does not depend on the transfer event signature while verifing withdrawals
+    11. `customWithdrawEventSig`: The token has its custom withdraw event signature and does not depend on the transfer event signature while verifing withdrawals
 
-    8. `noDeposit`: Tokens are not eligible for deposits from Ethereum
-       Note: Also use this tag if the tokens cannot be bridged.
+    12. `noDeposit`: Token not eligible for deposits
 
-    9. `noWithdraw`: Tokens are not eligible for withdrawals back to Ethereum
-       Note: Also use this tag if the tokens cannot be bridged.
+    13. `noWithdraw`: Token not eligible for withdrawals on PoS bridges
 
 3. Run linter and fix the issues if any
 
@@ -91,7 +70,7 @@ Apart from these 3 token list there is one blacklisted token list:
     npm run build
     ```
 
-5. Commit the changes and raise a Pull request to our repo's dev branch
+5. Commit the changes and raise a Pull request to our repo
 
 ### Disclaimer