Merge pull request #93 from api3dao/fix-delegate-badge

fix: incorrect assignment of delegate badge

Author: aquarat

.gitignore

@@ -19,6 +19,7 @@
 .DS_Store
 *.pem
 .idea
+.vscode
 
 # debug
 npm-debug.log*

README.md

@@ -8,7 +8,89 @@ on-chain details of the API3 DAO, including:
 - All events from the smart contracts of the API3 DAO
 - DAO Treasuries status
 
-## Local Installation
+## Architecture
+
+The app relies on Terraform to configure a generic Linux EC2 instance.
+The EC2 instance in-turn hosts Docker, and app-services are orchestrated by Docker directly (eg. `restart=always`).
+
+The services are:
+
+```
+(end user) -> Cloudflare -> EC2 IP -> traefik (load balancer) -> api3-tracker (container)
+```
+
+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
+0 * * * * root cd /home/ubuntu/src/github.com/api3dao/api3-tracker/terraform/workspaces/api3tracker-prod && ./bin/job_treasuries_download.sh >> /var/log/api3-treasuries-download.log 2>&1
+2,12,22,32,42,52 * * * * root cd /home/ubuntu/src/github.com/api3dao/api3-tracker/terraform/workspaces/api3tracker-prod && ./bin/job_state_update.sh >> /var/log/api3-state-update.log 2>&1
+10 0 * * * root cd /home/ubuntu/src/github.com/api3dao/api3-tracker/terraform/workspaces/api3tracker-prod && ./bin/job_shares_download.sh --tag . > /var/log/api3-shares-download.log 2>&1
+24 4 * * */3 root cd /home/ubuntu/src/github.com/api3dao/api3-tracker/terraform/workspaces/api3tracker-prod && bash ./bin/postgres-backup.sh >> /var/log/postgres-backups.log 2>&1
+```
+
+## 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
+docker service ps tracker-stack_postgres --no-trunc # show status of postgres
+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
+DATABASE_URL="postgres://postgres:[email protected]:5432/postgres?sslmode=disable" TS_NODE_PROJECT=./tsconfig.cli.json yarn ts-node cli.ts treasuries download
+DATABASE_URL="postgres://postgres:[email protected]:5432/postgres?sslmode=disable" TS_NODE_PROJECT=./tsconfig.cli.json yarn ts-node cli.ts shares download
+DATABASE_URL="postgres://postgres:[email protected]:5432/postgres?sslmode=disable" API3TRACKER_ENDPOINT="ARCHIVE RPC URL" TS_NODE_PROJECT=./tsconfig.cli.json yarn ts-node cli.ts state update --rps-limit
+```
+
+Keep in mind that the Postgres DB in the docker-compose file is not configured with a volume by default, so changes will be lost on service restart.
+
+## Local Installation and Deployment (Terraform only)
 
 The only requirements for installation are [Docker](https://docs.docker.com/get-docker/)
 and [Terraform](https://learn.hashicorp.com/tutorials/terraform/install-cli).

dev-tools/docker-compose.yml

@@ -0,0 +1,29 @@
+version: '3.5'
+
+services:
+  postgres:
+    image: postgres:15
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+    ports:
+      - "5432:5432"
+    networks:
+      - postgres
+#    volumes:
+#      - /custom/mount:/var/lib/postgresql/data
+
+  api3tracker:
+    image: api3dao/api3-tracker:latest
+    environment:
+      API3TRACKER_ENDPOINT: "https://ethereum-rpc.publicnode.com"
+      API3TRACKER_COINGECKO_HOST: api.coingecko.com
+      API3TRACKER_COINGECKO_API_KEY: ""
+      DATABASE_URL: "postgres://postgres:[email protected]:5432/postgres?sslmode=disable"
+    ports:
+      - "3000:3000"
+    networks:
+      - postgres
+
+networks:
+  postgres:

scripts/fix-delegate-badges.ts

@@ -0,0 +1,74 @@
+import prisma from "../services/db";
+import { Batch } from "../services/members";
+import { Prisma } from "@prisma/client";
+import { Wordlist } from "../services/members";
+
+async function fixDelegateBadges() {
+  // Get all members with delegate badge
+  const members = await prisma.member.findMany({
+    where: {
+      badges: {
+        contains: "delegate",
+      },
+    },
+  });
+
+  console.log(`Found ${members.length} members with delegate badge`);
+  let fixCount = 0;
+
+  for (const member of members) {
+    const addr = Buffer.from(member.address);
+    const addrHex = addr.toString("hex");
+
+    // Calculate total delegated amount for this member
+    const delegated = await Batch.readMemberDelegatedTotal(addr, false);
+
+    // console.log(`\nChecking member ${addrHex}:`);
+    // console.log(`Current delegated amount: ${delegated}`);
+    // console.log(`Current badges: ${member.badges}`);
+
+    // If no delegation, remove the badge
+    if (delegated.equals(new Prisma.Decimal(0))) {
+      fixCount++;
+      // console.log(`Removing delegate badge for ${addrHex}`);
+
+      // Remove badges directly
+      const updatedBadges = Wordlist.remove(member.badges, "delegate");
+      const updatedTags = Wordlist.remove(member.tags || "", "delegate");
+
+      // Update database directly
+      try {
+        await prisma.member.update({
+          where: { address: addr },
+          data: {
+            badges: updatedBadges,
+            tags: updatedTags,
+            userIsDelegated: new Prisma.Decimal(0),
+          },
+        });
+        // console.log(`Successfully updated database for ${addrHex}`);
+        // console.log(`New badges: ${updatedBadges}`);
+      } catch (error) {
+        console.error(`Failed to update database for ${addrHex}:`, error);
+      }
+    }
+  }
+
+  console.log(`\nAttempted to fix delegate badges for ${fixCount} members`);
+
+  // Verify changes
+  const remainingDelegates = await prisma.member.count({
+    where: {
+      badges: {
+        contains: "delegate",
+      },
+    },
+  });
+
+  console.log(`Members still with delegate badge: ${remainingDelegates}`);
+}
+
+// Run the fix
+fixDelegateBadges()
+  .catch(console.error)
+  .finally(() => prisma.$disconnect());

services/members.ts

@@ -17,7 +17,7 @@ export type Badge =
   | "proposer"
   | "vested";
 
-const Wordlist = {
+export const Wordlist = {
   has: (wordlist: string, word: string): boolean => {
     if (!wordlist) return false;
     const parts = wordlist.split(",");
@@ -255,7 +255,7 @@ export const Batch = {
       } else {
         const existing: IWallet = Wallets.from(members[0]);
         // only badge can be new in our case
-        // nothing else is changing currenly
+        // nothing else is changing currently
         if (badge) {
           if (!Wordlist.has(existing.badges, badge)) {
             existing.badges = Wordlist.add(existing.badges, badge);
@@ -456,7 +456,6 @@ export const Batch = {
         delegation ? delegation.userShares : 0
       );
       if (delegation) {
-        // delegates badge should be received
         const badge = "delegator";
         member.badges = Wordlist.add(member.badges, badge);
         if (member.tags) {
@@ -467,14 +466,13 @@ export const Batch = {
       }
       // find what are the delegations TO the member
       member.userIsDelegated = delegated;
-      if (delegated) {
-        const badge = "delegate";
+      const badge = "delegate";
+      if (delegated > new Prisma.Decimal(0.0)) {
         member.badges = Wordlist.add(member.badges, badge);
-        if (member.tags) {
-          member.tags = Wordlist.add(member.tags, badge);
-        } else {
-          member.tags = badge;
-        }
+        member.tags = Wordlist.add(member.tags || "", badge);
+      } else {
+        member.badges = Wordlist.remove(member.badges, badge);
+        member.tags = Wordlist.remove(member.tags || "", badge);
       }
       member.userVotingPower = new Prisma.Decimal(member.userShare).add(
         member.userIsDelegated