@eth-optimism/tokenlist 4.3.1

package/.dockerignore

@@ -0,0 +1 @@
+node_modules

package/.env.example

@@ -0,0 +1,2 @@
+TOKEN_LIST_BOT__SECRET=
+TOKEN_LIST_BOT__PAT=

package/.eslintrc.js

@@ -0,0 +1,188 @@
+module.exports = {
+  root: true,
+  env: {
+    browser: true,
+    es6: true,
+  },
+  ignorePatterns: ['dist', 'coverage', 'packages/contracts/hardhat'],
+  extends: ['plugin:prettier/recommended'],
+  parser: '@babel/eslint-parser',
+  parserOptions: {
+    es6: true,
+    ecmaVersion: 6,
+    sourceType: 'module',
+    requireConfigFile: false,
+  },
+  plugins: [
+    'eslint-plugin-import',
+    'eslint-plugin-unicorn',
+    'eslint-plugin-jsdoc',
+    'eslint-plugin-prefer-arrow',
+    'eslint-plugin-react',
+    '@typescript-eslint',
+  ],
+  overrides: [
+    {
+      files: ['**/*.ts'],
+      parser: '@typescript-eslint/parser',
+      parserOptions: {
+        project: './packages/**/tsconfig.json',
+        sourceType: 'module',
+        allowAutomaticSingleRunInference: true,
+      },
+      rules: {
+        '@typescript-eslint/adjacent-overload-signatures': 'error',
+        '@typescript-eslint/array-type': 'off',
+        '@typescript-eslint/ban-types': 'off',
+        '@typescript-eslint/consistent-type-assertions': 'error',
+        '@typescript-eslint/dot-notation': 'off',
+        '@typescript-eslint/indent': 'off',
+        '@typescript-eslint/member-delimiter-style': [
+          'off',
+          {
+            multiline: {
+              delimiter: 'none',
+              requireLast: true,
+            },
+            singleline: {
+              delimiter: 'semi',
+              requireLast: false,
+            },
+          },
+        ],
+        '@typescript-eslint/member-ordering': 'off',
+        '@typescript-eslint/naming-convention': 'off',
+        '@typescript-eslint/no-empty-function': 'error',
+        '@typescript-eslint/no-empty-interface': 'off',
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/no-misused-new': 'error',
+        '@typescript-eslint/no-namespace': 'error',
+        '@typescript-eslint/no-parameter-properties': 'off',
+        '@typescript-eslint/no-shadow': [
+          'error',
+          {
+            hoist: 'all',
+          },
+        ],
+        '@typescript-eslint/no-this-alias': 'error',
+        '@typescript-eslint/no-unused-expressions': 'off',
+        '@typescript-eslint/no-use-before-define': 'off',
+        '@typescript-eslint/no-var-requires': 'error',
+        '@typescript-eslint/prefer-for-of': 'error',
+        '@typescript-eslint/prefer-function-type': 'error',
+        '@typescript-eslint/prefer-namespace-keyword': 'error',
+        '@typescript-eslint/quotes': 'off',
+        '@typescript-eslint/semi': ['off', null],
+        '@typescript-eslint/triple-slash-reference': [
+          'error',
+          {
+            path: 'always',
+            types: 'prefer-import',
+            lib: 'always',
+          },
+        ],
+        '@typescript-eslint/type-annotation-spacing': 'off',
+        '@typescript-eslint/unified-signatures': 'error',
+        '@typescript-eslint/no-unused-vars': 'error',
+      },
+    },
+  ],
+  rules: {
+    'prettier/prettier': 'warn',
+    'arrow-parens': ['off', 'always'],
+    'brace-style': ['off', 'off'],
+    'comma-dangle': 'off',
+    complexity: 'off',
+    'constructor-super': 'error',
+    curly: 'error',
+    'dot-notation': 'off',
+    'eol-last': 'off',
+    eqeqeq: ['error', 'smart'],
+    'guard-for-in': 'error',
+    'id-blacklist': 'off',
+    'id-match': 'off',
+    'import/no-extraneous-dependencies': ['error'],
+    'import/no-internal-modules': 'off',
+    'import/order': [
+      'error',
+      {
+        groups: ['builtin', 'external', 'internal'],
+        'newlines-between': 'always',
+      },
+    ],
+    indent: 'off',
+    'jsdoc/check-alignment': 'error',
+    'jsdoc/check-indentation': 'error',
+    'jsdoc/newline-after-description': 'error',
+    'linebreak-style': 'off',
+    'max-classes-per-file': 'off',
+    'max-len': 'off',
+    'new-parens': 'off',
+    'newline-per-chained-call': 'off',
+    'no-bitwise': 'off',
+    'no-caller': 'error',
+    'no-cond-assign': 'error',
+    'no-console': 'off',
+    'no-debugger': 'error',
+    'no-duplicate-case': 'error',
+    'no-duplicate-imports': 'error',
+    'no-empty': 'error',
+    'no-eval': 'error',
+    'no-extra-bind': 'error',
+    'no-extra-semi': 'off',
+    'no-fallthrough': 'off',
+    'no-invalid-this': 'off',
+    'no-irregular-whitespace': 'off',
+    'no-multiple-empty-lines': 'off',
+    'no-new-func': 'error',
+    'no-new-wrappers': 'error',
+    'no-redeclare': 'error',
+    'no-return-await': 'error',
+    'no-sequences': 'error',
+    'no-sparse-arrays': 'error',
+    'no-template-curly-in-string': 'error',
+    'no-throw-literal': 'error',
+    'no-trailing-spaces': 'off',
+    'no-undef-init': 'error',
+    'no-underscore-dangle': 'off',
+    'no-unsafe-finally': 'error',
+    'no-unused-expressions': 'off',
+    'no-unused-labels': 'error',
+    'no-use-before-define': 'off',
+    'no-var': 'error',
+    'object-shorthand': 'error',
+    'one-var': ['error', 'never'],
+    'padded-blocks': [
+      'off',
+      {
+        blocks: 'never',
+      },
+      {
+        allowSingleLineBlocks: true,
+      },
+    ],
+    'prefer-arrow/prefer-arrow-functions': 'error',
+    'prefer-const': 'error',
+    'prefer-object-spread': 'error',
+    'quote-props': 'off',
+    quotes: 'off',
+    radix: 'error',
+    'react/jsx-curly-spacing': 'off',
+    'react/jsx-equals-spacing': 'off',
+    'react/jsx-tag-spacing': [
+      'off',
+      {
+        afterOpening: 'allow',
+        closingSlash: 'allow',
+      },
+    ],
+    'react/jsx-wrap-multilines': 'off',
+    semi: 'off',
+    'space-before-blocks': 'error',
+    'space-before-function-paren': 'off',
+    'space-in-parens': ['off', 'never'],
+    'unicorn/prefer-ternary': 'off',
+    'use-isnan': 'error',
+    'valid-typeof': 'off',
+  },
+}

package/.github/CODEOWNERS

@@ -0,0 +1 @@
+@elenadimitrova

package/.github/mergify.yml

@@ -0,0 +1,57 @@
+queue_rules:
+  - name: default
+    conditions: []
+
+pull_request_rules:
+  - name: Ask to resolve conflict
+    conditions:
+      - conflict
+    actions:
+      comment:
+        message: Hey @{{author}}! This PR has merge conflicts. Please fix them before continuing review.
+      label:
+        add:
+          - conflict
+
+  - name: Remove conflicts label when conflicts gone
+    conditions:
+      - -conflict
+    actions:
+      label:
+        remove:
+          - conflict
+
+  - name: Notify author when merge queue failed
+    conditions:
+      - 'check-failure=Queue: Embarked in merge train'
+    actions:
+      comment:
+        message: |
+          Merge failed. Please see automated check logs for more details.
+
+  - name: automatic update prs
+    conditions:
+      - -conflict
+      - -draft
+      - label!="do-not-merge"
+      - 'base=master'
+    actions:
+      update:
+
+  - name: Say hi to contributors if they are not part of the regularcontributors team
+    conditions:
+      - author!=@regularcontributors
+    actions:
+      comment:
+        message: |
+          Thanks for creating the PR! We're stoked to see you building on Optimism.
+          Please give our team about a week to review your PR :)
+
+  - name: Say thanks
+    conditions:
+      - author!=@regularcontributors
+      - merged
+    actions:
+      comment:
+        message: |
+          Congrats! Your token has been merged.  Consider joining our Discord to stay up to date with other builders in the ecosystem. Make sure to drink plenty of water.

package/.github/workflows/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+  - package-ecosystem: 'npm'
+    directory: '/'
+    schedule:
+      interval: 'monthly'
+    open-pull-requests-limit: 2
+
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'monthly'
+    open-pull-requests-limit: 2

package/.github/workflows/generate.yml

@@ -0,0 +1,57 @@
+name: Generate Token List
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [master]
+
+jobs:
+  generate:
+    name: generate
+    if: |
+      github.event.head_commit.committer.username != 'github-actions[bot]'
+        && github.repository == 'ethereum-optimism/ethereum-optimism.github.io'
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.PAT }}
+          fetch-depth: 0
+
+      - name: Use Node.js 16.x
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16.x
+
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+
+      - uses: actions/cache@v2
+        id: yarn-cache
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
+      - name: Install dependencies
+        run: yarn --frozen-lockfile
+
+      - name: Patch token list version
+        run: |
+          git config --global user.email "will@oplabs.co"
+          git config --global user.name "Github action bot"
+          npm version patch
+
+      - name: Generate token list
+        run: |
+          yarn generate:ci
+
+      - name: Commit token list
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: 'bot(ci): generate token list'
+          file_pattern: optimism.tokenlist.json

package/.github/workflows/publish.yml

@@ -0,0 +1,50 @@
+name: Publish Packages
+
+on:
+  push:
+    branches: [master]
+
+jobs:
+  publish-bot:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Get changed files
+        id: changed-files
+        uses: tj-actions/changed-files@v29
+        with:
+          files: |
+            bin/**
+            src/bot.ts
+            package.json
+            yarn.lock
+            Dockerfile.bot
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v3
+        with:
+          push: true
+          tags: ethereumoptimism/tokenlist-bot:latest
+
+      - name: Install dependencies to prepare for release 🔧
+        run: yarn
+
+      - name: Build and publish package on NPM 📦
+        run: yarn release
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/stale.yml

@@ -0,0 +1,19 @@
+name: 'Close stale issues and PRs'
+on:
+  schedule:
+    - cron: '30 1 * * *'
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/stale@v6
+        with:
+          stale-issue-message: 'This issue has been automatically marked as stale and will be closed in 7 days if no updates'
+          stale-pr-message: 'This pr has been automatically marked as stale and will be closed in 7 days if no updates'
+          close-issue-message: 'This issue was closed as stale.  Please reopen if this is a mistake'
+          close-pr-message: 'This PR was closed as stale.  Please reopen if this is a mistake'
+          days-before-issue-stale: 7
+          days-before-pr-stale: 7
+          days-before-issue-close: 7
+          days-before-pr-close: 7

package/.github/workflows/test.yml

@@ -0,0 +1,43 @@
+name: Test Scripts
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    name: test
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Use Node.js 16.x
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16.x
+
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+
+      - uses: actions/cache@v2
+        id: yarn-cache
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
+      - name: Install dependencies
+        run: yarn --frozen-lockfile
+
+      - name: Run Test
+        run: |
+          npm run test

package/.github/workflows/validate.yml

@@ -0,0 +1,67 @@
+name: Validate PR
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  validate:
+    name: validate
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Use Node.js 16.x
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16.x
+
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+
+      - uses: actions/cache@v2
+        id: yarn-cache
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
+      - name: Install dependencies
+        run: yarn --frozen-lockfile
+
+      - name: Save PR number
+        run: echo ${{ github.event.number }} > pr.txt
+
+      - name: Get changed files
+        id: changed-files
+        uses: tj-actions/changed-files@v29
+        with:
+          files: |
+            data/**
+
+      - name: Validate token list
+        run: |
+          CHANGED=$(echo ${{ steps.changed-files.outputs.all_changed_files }} | sed -nr "s/data\/(.*?)\/.*/\1/p" | paste -sd "," -)
+          yarn validate --datadir ./data --tokens "${CHANGED}" 2> err.txt 1> std.txt
+
+      - name: Print output
+        if: ${{ always() }}
+        run: |
+          cat std.txt; cat err.txt
+
+      - name: Upload artifacts
+        if: ${{ always() }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: logs-artifact
+          path: |
+            pr.txt
+            err.txt
+            std.txt

package/.prettierrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+  $schema: 'http://json.schemastore.org/prettierrc',
+  trailingComma: 'es5',
+  tabWidth: 2,
+  semi: false,
+  singleQuote: true,
+  arrowParens: 'always',
+}

package/.vscode/extensions.json

@@ -0,0 +1,10 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+  // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+
+  // List of extensions which should be recommended for users of this workspace.
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "editorconfig.editorconfig",
+  ],
+}

package/.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+  "[typescript]": {
+    "editor.defaultFormatter": "vscode.typescript-language-features",
+    "editor.formatOnSave": true
+  },
+  "eslint.nodePath": "./node_modules/eslint/bin/",
+  "eslint.format.enable": true,
+  "editorconfig.generateAuto": false,
+  "files.trimTrailingWhitespace": true
+}

package/CNAME

@@ -0,0 +1 @@
+static.optimism.io

package/Dockerfile.bot

@@ -0,0 +1,14 @@
+FROM node:16-alpine3.14
+
+WORKDIR /app
+
+COPY package*.json /app
+COPY yarn.lock /app
+
+RUN yarn install
+
+COPY . /app
+
+CMD [ "yarn", "start-bot" ]
+
+EXPOSE 7300