Merge pull request #97 from api3dao/dcroote/94-lint

Fixes, lints, prettier, and upgrades

Author: aquarat

.eslintrc.json

@@ -1,3 +1,31 @@
 {
-  "extends": "next/core-web-vitals"
+  "extends": [
+    "plugin:@api3/eslint-plugin-commons/universal",
+    "next/core-web-vitals"
+  ],
+  "parserOptions": {
+    "project": ["./tsconfig.json"]
+  },
+  "rules": {
+    // Some of these can be removed with effort (not addressed by --fix)
+    "@typescript-eslint/ban-ts-comment": "off",
+    "@typescript-eslint/no-unsafe-function-type": "off",
+    "@typescript-eslint/prefer-namespace-keyword": "off",
+    "@typescript-eslint/prefer-nullish-coalescing": "off",
+    "eqeqeq": "off",
+    "functional/no-classes": "off",
+    "import/no-default-export": "off",
+    "no-console": "off",
+    "prefer-named-capture-group": "off",
+    "prefer-template": "off",
+    "radix": "off",
+    "unicorn/filename-case": "off",
+    "unicorn/no-array-callback-reference": "off",
+    "unicorn/no-array-push-push": "off",
+    "unicorn/no-await-expression-member": "off",
+    "unicorn/number-literal-case": "off",
+    "unicorn/prefer-code-point": "off",
+    "unicorn/prefer-string-slice": "off",
+    "unicorn/prefer-switch": "off"
+  }
 }

.github/ISSUE_TEMPLATE/community-bug-bounty.md

@@ -1,10 +1,9 @@
 ---
 name: Community bug bounty
 about: Submissions for the community bug bounty
-title: ''
+title: ""
 labels: cbb
-assignees: ''
-
+assignees: ""
 ---
 
 ## Steps to reproduce

.github/workflows/docker-image.yml

@@ -0,0 +1,54 @@
+name: Continuous Build
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: "yarn"
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Lint
+        run: yarn lint
+
+  only_build:
+    runs-on: ubuntu-latest
+    if: github.ref != 'refs/heads/main'
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build the Docker image
+        run: docker build . --file Dockerfile --tag api3tracker:latest
+
+  build_deploy:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    env:
+      SSH_HOST: ${{ secrets.SSH_HOST }}
+      SSH_REMOTE_PATH: /home/ubuntu/src/github.com/api3dao/api3-tracker/terraform/workspaces/api3tracker-prod
+    steps:
+      - name: Install SSH Key
+        uses: shimataro/ssh-key-action@v2
+        with:
+          key: ${{ secrets.SSH_PRIVATE_KEY }}
+          known_hosts: /dev/null
+      - uses: actions/checkout@v4
+      - name: Build the Docker image
+        run: docker build . --file Dockerfile --tag api3tracker:latest
+      - name: Push main Docker image
+        run: docker save api3tracker:latest | bzip2 | ssh -o StrictHostKeyChecking=accept-new -o UserKnownHostsFile=/dev/null $SSH_HOST 'bunzip2 -d | docker load'
+      - name: Apply Terraform plan
+        run: |
+          echo "::add-mask::$TF_VAR_API3TRACKER_ENDPOINT"
+          echo "::add-mask::$TF_VAR_API3TRACKER_ARCHIVE_ENDPOINT"
+          export REMOTE_CMD="cd $SSH_REMOTE_PATH && terraform init && terraform apply -auto-approve && docker system prune -af"
+          ssh -o StrictHostKeyChecking=accept-new -o UserKnownHostsFile=/dev/null $SSH_HOST bash -c '"'$REMOTE_CMD'"'

.github/workflows/main.yml

@@ -1,17 +1,17 @@
-FROM node:16.16-alpine3.15 AS dependencies
+FROM node:20.18-alpine3.19 AS dependencies
 WORKDIR /app
 COPY package.json yarn.lock ./
 RUN yarn install --frozen-lockfile
 
-FROM node:16.16-alpine3.15 AS builder
+FROM node:20.18-alpine3.19 AS builder
 WORKDIR /app
 COPY . .
 COPY --from=dependencies /app/node_modules ./node_modules
 RUN yarn prisma generate
 RUN yarn build
 RUN yarn next telemetry disable
 
-FROM node:16.16-alpine3.15
+FROM node:20.18-alpine3.19
 WORKDIR /app
 ENV NODE_ENV=production
 

Dockerfile

@@ -20,13 +20,15 @@ The services are:
 ```
 
 Containers:
+
 - api3tracker: The FE and BE-service
 - postgres: The database the FE and BE rely on
 - traefik: A load balancer that encrypts HTTP responses (using the CF origin server key pair)
 - postgres-exporter: a service that exports the database as a backup on an interval
 
 Host services:
 The host OS also runs some cron services, these are:
+
 ```bash
 */10 * * * * root cd /home/ubuntu/src/github.com/api3dao/api3-tracker/terraform/workspaces/api3tracker-prod && ./bin/job_logs_download.sh >> /var/log/api3-logs-download.log 2>&1
 15,45 * * * * root cd /home/ubuntu/src/github.com/api3dao/api3-tracker/terraform/workspaces/api3tracker-prod && ./bin/job_supply_download.sh >> /var/log/api3-supply-download.log 2>&1
@@ -37,36 +39,45 @@ The host OS also runs some cron services, these are:
 ```
 
 ## Local developement using Docker
+
 Developers can run some or all services locally using Docker Swarm, or even bare-bones, without containerisation.
 
 One combination is running just postgres locally using Docker, eg:
+
 ```bash
 docker run --rm -ti -p 5432:5432 postgres:15
 ```
+
 and then running the FE and BE services directly (refer to Cron jobs below and `yarn next dev` in `package.json`).
 
 Alternatively, one can run services using Docker Swarm, but this lacks hot-reloading.
 
 ### Local development using Docker Swarm
+
 If you haven't already enabled Swarm mode on your Docker instance, do so now (only has to be done once):
+
 ```bash
 docker swarm init
 ```
+
 The result of the above command can be ignored.
 
 Build the FE/BE image:
+
 ```bash
 docker build -t api3dao/api3-tracker:latest .
 ```
 
 Run the stack:
+
 ```bash
 docker stack deploy -c dev-tools/docker-compose.yml tracker-stack
 ```
 
 If all goes well the application will be served at http://localhost:3000
 
 Some commands for visualising the services:
+
 ```bash
 docker ps # all docker containers
 docker service ls # all swarm services
@@ -75,11 +86,13 @@ docker stack rm tracker-stack # tear down the stack
 ```
 
 Initialise the DB:
+
 ```bash
 DATABASE_URL="postgres://postgres:[email protected]:5432/postgres?sslmode=disable" yarn prisma migrate deploy
 ```
 
 Cron jobs (unwrapped versions of cronjobs):
+
 ```bash
 DATABASE_URL="postgres://postgres:[email protected]:5432/postgres?sslmode=disable" TS_NODE_PROJECT=./tsconfig.cli.json yarn ts-node cli.ts logs download
 DATABASE_URL="postgres://postgres:[email protected]:5432/postgres?sslmode=disable" TS_NODE_PROJECT=./tsconfig.cli.json yarn ts-node cli.ts supply download

README.md

@@ -1,11 +1,12 @@
-import yargs from "yargs/yargs";
 import { hideBin } from "yargs/helpers";
+import yargs from "yargs/yargs";
+
+import { ENS } from "./services/ens";
 import { EthereumPrice } from "./services/price";
+import { Shares } from "./services/shares";
+import { Supply } from "./services/supply";
 import { Events } from "./services/sync";
 import { Treasuries } from "./services/treasuries";
-import { Supply } from "./services/supply";
-import { Shares } from "./services/shares";
-import { ENS } from "./services/ens";
 
 yargs(hideBin(process.argv))
   .env("API3TRACKER")
@@ -26,13 +27,13 @@ yargs(hideBin(process.argv))
       });
     },
     handler: async ({ endpoint, sub }) => {
-      if (sub == "reset") {
+      if (sub === "reset") {
         await ENS.resetAll();
         console.log("ENS cache was deleted");
-      } else if (sub == "import") {
+      } else if (sub === "import") {
         const total = await ENS.importLocal("./.cache");
         console.log(`saved ${total} new ENS records`);
-      } else if (sub == "download") {
+      } else if (sub === "download") {
         const total = await ENS.download(endpoint);
         console.log(`saved ${total} new ENS records`);
       } else {
@@ -52,7 +53,8 @@ yargs(hideBin(process.argv))
           describe: `logs subcommand - reset or download new`,
         })
         .option("coingecko_host", {
-          default: process.env.API3TRACKER_COINGECKO_HOST || "api.coingecko.com",
+          default:
+            process.env.API3TRACKER_COINGECKO_HOST || "api.coingecko.com",
           type: "string",
           description: "Host to use for CoinGecko API",
         })
@@ -62,11 +64,12 @@ yargs(hideBin(process.argv))
           description: "API KEY to be used for CoinGecko-compatible API",
         });
     },
+    // eslint-disable-next-line camelcase
     handler: async ({ endpoint, sub, coingecko_host, coingecko_api_key }) => {
-      if (sub == "reset") {
+      if (sub === "reset") {
         await Events.resetAll();
         console.log("events were deleted");
-      } else if (sub == "download") {
+      } else if (sub === "download") {
         const priceReader = EthereumPrice(coingecko_host, coingecko_api_key);
         const total = await Events.download(endpoint, priceReader);
         console.log(`downloaded ${total} new events`);
@@ -103,21 +106,21 @@ yargs(hideBin(process.argv))
         });
     },
     handler: async ({ endpoint, sub, member, tag, rpsLimit }) => {
-      if (sub == "reset") {
+      if (sub === "reset") {
         await Shares.resetAll();
         console.log("shares cache records were deleted");
-      } else if (sub == "votings") {
-        const total = await Shares.downloadVotings(endpoint);
+      } else if (sub === "votings") {
+        const total = await Shares.downloadVotings();
         console.log(`updated ${total} new records`);
-      } else if (sub == "totals") {
+      } else if (sub === "totals") {
         await Shares.recalculateTotals();
-      } else if (sub == "download") {
-        if (!tag) {
-          const total = await Shares.download(endpoint, member, rpsLimit);
-          console.log(`downloaded ${total} new records`);
-        } else {
+      } else if (sub === "download") {
+        if (tag) {
           const total = await Shares.downloadMembers(endpoint, tag, rpsLimit);
           console.log(`scanned ${total} members`);
+        } else {
+          const total = await Shares.download(endpoint, member, rpsLimit);
+          console.log(`downloaded ${total} new records`);
         }
       } else {
         console.error("ERROR: Unknown sub-command");
@@ -176,10 +179,10 @@ yargs(hideBin(process.argv))
       stopBlock,
       useArchive,
     }) => {
-      if (sub == "reset") {
+      if (sub === "reset") {
         await Events.resetState();
         console.log("Events state was reset");
-      } else if (sub == "next") {
+      } else if (sub === "next") {
         const verbose = {
           blocks: verboseBlocks || false,
           epochs: verboseEpochs || false,
@@ -194,10 +197,10 @@ yargs(hideBin(process.argv))
           endpoint,
           verbose,
           termination,
-          useArchive
+          useArchive,
         );
         console.log(`${blocks} blocks were processed`);
-      } else if (sub == "update") {
+      } else if (sub === "update") {
         const verbose = {
           blocks: verboseBlocks || false,
           epochs: verboseEpochs || false,
@@ -212,7 +215,7 @@ yargs(hideBin(process.argv))
           endpoint,
           verbose,
           termination,
-          useArchive
+          useArchive,
         );
         console.log(`${blocks} blocks were processed`);
       } else {
@@ -232,10 +235,10 @@ yargs(hideBin(process.argv))
       });
     },
     handler: async ({ endpoint, sub }) => {
-      if (sub == "reset") {
+      if (sub === "reset") {
         await Supply.resetAll();
         console.log("Supply history was reset");
-      } else if (sub == "download") {
+      } else if (sub === "download") {
         await Supply.download(endpoint);
         console.log("Supply history was updated");
       } else {
@@ -255,10 +258,10 @@ yargs(hideBin(process.argv))
       });
     },
     handler: async ({ endpoint, sub }) => {
-      if (sub == "reset") {
+      if (sub === "reset") {
         await Treasuries.resetAll();
         console.log("Treasuries state was reset");
-      } else if (sub == "download") {
+      } else if (sub === "download") {
         const total = await Treasuries.download(endpoint);
         console.log(`downloaded state of ${total} balances`);
       } else {

cli.ts

@@ -1,5 +1,7 @@
 import React from "react";
-import { IContract } from "../services/types";
+
+import { type IContract } from "../services/types";
+
 import { BorderedPanel } from "./BorderedPanel";
 import { Address } from "./Ethscan";