Merge pull request #100 from blockful/refactor/OP-Icon-+-Number-Formatting-for-Notification-System

Refactor/op icon + number formatting for notification system

Author: LeonardoVieira1630

apps/consumers/src/services/dao.service.ts

@@ -16,7 +16,8 @@ export class DAOService {
   // DAO emojis mapping
   private daoEmojis = new Map<string, string>([
     ['UNI', '🦄'],
-    ['ENS', '🔷']
+    ['ENS', '🔷'],
+    ['OP', '🔴'],
   ]);
 
   constructor(

apps/dispatcher/src/lib/number-formatter.test.ts

@@ -0,0 +1,69 @@
+import { formatTokenAmount } from './number-formatter';
+
+describe('formatTokenAmount', () => {
+  describe('with 18 decimals (default)', () => {
+    it('should format zero correctly', () => {
+      expect(formatTokenAmount('0')).toBe('0');
+      expect(formatTokenAmount(0)).toBe('0');
+    });
+
+    it('should format very small amounts as <0.1', () => {
+      expect(formatTokenAmount('1')).toBe('<0.1'); // 1 wei
+      expect(formatTokenAmount('50000000000000000')).toBe('<0.1'); // 0.05 token
+      expect(formatTokenAmount('99999999999999999')).toBe('0.1'); // 0.099... token (rounds to 0.1)
+    });
+
+    it('should format small amounts with 1 decimal', () => {
+      expect(formatTokenAmount('100000000000000000')).toBe('0.1'); // 0.1 token
+      expect(formatTokenAmount('100000000000000001')).toBe('0.1'); // 0.1+ token (rounded)
+      expect(formatTokenAmount('500000000000000000')).toBe('0.5'); // 0.5 token
+      expect(formatTokenAmount('1000000000000000000')).toBe('1.0'); // 1 token
+      expect(formatTokenAmount('1500000000000000000')).toBe('1.5'); // 1.5 tokens
+      expect(formatTokenAmount('999000000000000000000')).toBe('999.0'); // 999 tokens
+    });
+
+    it('should format thousands with K suffix', () => {
+      expect(formatTokenAmount('1000000000000000000000')).toBe('1.0K'); // 1,000 tokens
+      expect(formatTokenAmount('1234000000000000000000')).toBe('1.2K'); // 1,234 tokens
+      expect(formatTokenAmount('12345000000000000000000')).toBe('12.3K'); // 12,345 tokens
+      expect(formatTokenAmount('999999000000000000000000')).toBe('1.0M'); // 999,999 tokens (rounded up to 1M)
+    });
+
+    it('should format millions with M suffix', () => {
+      expect(formatTokenAmount('1000000000000000000000000')).toBe('1.0M'); // 1 million tokens
+      expect(formatTokenAmount('1234567000000000000000000')).toBe('1.2M'); // 1.234567 million tokens
+      expect(formatTokenAmount('999999999000000000000000000')).toBe('1.0B'); // ~1 billion tokens (rounded up to 1B)
+    });
+
+    it('should format billions with B suffix', () => {
+      expect(formatTokenAmount('1000000000000000000000000000')).toBe('1.0B'); // 1 billion tokens
+      expect(formatTokenAmount('1234567890000000000000000000')).toBe('1.2B'); // 1.23... billion tokens
+    });
+
+    it('should use exponential notation for very large numbers', () => {
+      expect(formatTokenAmount('1000000000000000000000000000000')).toBe('1.0e+12'); // trillion (uses exponential)
+    });
+
+    it('should promote units when rounding results in 1000+', () => {
+      // Test promotion from K to M (999.95K rounds to 1000.0K -> 1.0M)
+      expect(formatTokenAmount('999950000000000000000000')).toBe('1.0M');
+      
+      // Test promotion from M to B (999.95M rounds to 1000.0M -> 1.0B)
+      expect(formatTokenAmount('999950000000000000000000000')).toBe('1.0B');
+    });
+  });
+
+  describe('with custom decimals', () => {
+    it('should handle 6 decimals (like USDC)', () => {
+      expect(formatTokenAmount('1000000', 6)).toBe('1.0'); // 1 USDC
+      expect(formatTokenAmount('1500000', 6)).toBe('1.5'); // 1.5 USDC
+      expect(formatTokenAmount('1000000000', 6)).toBe('1.0K'); // 1,000 USDC
+    });
+
+    it('should handle 8 decimals (like WBTC)', () => {
+      expect(formatTokenAmount('100000000', 8)).toBe('1.0'); // 1 WBTC
+      expect(formatTokenAmount('50000000', 8)).toBe('0.5'); // 0.5 WBTC
+      expect(formatTokenAmount('100000000000', 8)).toBe('1.0K'); // 1,000 WBTC
+    });
+  });
+});

apps/dispatcher/src/lib/number-formatter.ts

@@ -0,0 +1,49 @@
+/**
+ * Utility functions for formatting numbers in human-readable notation
+ */
+
+/**
+ * Formats token amounts from wei to human-readable format
+ * @param amount The amount in wei (as string or number)
+ * @param decimals The number of decimals for the token (default: 18)
+ * @returns Formatted string with appropriate suffix (K, M, B, etc)
+ */
+export function formatTokenAmount(amount: string | number, decimals: number = 18): string {
+  // Convert wei string to number, handling 18 decimal places
+  const divisor = Math.pow(10, decimals);
+  const actualAmount = Number(amount) / divisor;
+  
+  // Handle zero
+  if (actualAmount === 0) return '0';
+  
+  // Handle very small amounts (less than 0.1)
+  if (actualAmount < 0.1) return '<0.1';
+  
+  // For amounts less than 1000, show with 1 decimal place
+  if (actualAmount < 1000) {
+    return actualAmount.toFixed(1);
+  }
+  
+  // For larger amounts, use K, M, B notation
+  const units = ['', 'K', 'M', 'B'];
+  let unitIndex = Math.floor(Math.log10(actualAmount) / 3);
+  
+  if (unitIndex >= units.length) {
+    return actualAmount.toExponential(1);
+  }
+  
+  let scaledAmount = actualAmount / Math.pow(1000, unitIndex);
+  let formatted = scaledAmount.toFixed(1);
+  
+  // If rounded result is >= 1000, promote to next unit
+  if (parseFloat(formatted) >= 1000) {
+    unitIndex++;
+    if (unitIndex >= units.length) {
+      return actualAmount.toExponential(1);
+    }
+    scaledAmount = actualAmount / Math.pow(1000, unitIndex);
+    formatted = scaledAmount.toFixed(1);
+  }
+  
+  return formatted + units[unitIndex];
+}

apps/dispatcher/src/services/triggers/voting-power-trigger.service.ts

@@ -2,6 +2,7 @@ import { DispatcherMessage, MessageProcessingResult } from "../../interfaces/dis
 import { ISubscriptionClient, User } from "../../interfaces/subscription-client.interface";
 import { NotificationClientFactory } from "../notification/notification-factory.service";
 import { BaseTriggerHandler } from "./base-trigger.service";
+import { formatTokenAmount } from "../../lib/number-formatter";
 import crypto from 'crypto';
 
 /**
@@ -62,23 +63,24 @@ export class VotingPowerTriggerHandler extends BaseTriggerHandler {
       let notificationMessage = '';
 
       const deltaValue = delta ? parseInt(delta) : 0;
+      const formattedDelta = formatTokenAmount(Math.abs(deltaValue));
 
       if (changeType === 'delegation') {
         if (deltaValue >= 0) {
-          notificationMessage = `🥳 You've received a new delegation in ${daoId}!\n${sourceAccountId} delegated to you, increasing your voting power by ${deltaValue}.`;
+          notificationMessage = `🥳 You've received a new delegation in ${daoId}!\n${sourceAccountId} delegated to you, increasing your voting power by ${formattedDelta}.`;
         } else if (deltaValue < 0) {
-          notificationMessage = `🥺 A delegator just undelegated in ${daoId}!\n${sourceAccountId} removed their delegation, reducing your voting power by ${deltaValue}.`;
+          notificationMessage = `🥺 A delegator just undelegated in ${daoId}!\n${sourceAccountId} removed their delegation, reducing your voting power by ${formattedDelta}.`;
         } 
       } else if (changeType === 'transfer') {
         if (deltaValue >= 0) {
-          notificationMessage = `📈 Your voting power increased in ${daoId}!\nYou gained ${deltaValue} voting power from token transfer activity.`;
+          notificationMessage = `📈 Your voting power increased in ${daoId}!\nYou gained ${formattedDelta} voting power from token transfer activity.`;
         } else if (deltaValue < 0) {
-          notificationMessage = `📉 Your voting power decreased in ${daoId}!\nYou lost ${Math.abs(deltaValue)} voting power from token transfer activity.`;
+          notificationMessage = `📉 Your voting power decreased in ${daoId}!\nYou lost ${formattedDelta} voting power from token transfer activity.`;
         } 
       } else {
         // Generic voting power change
         if (deltaValue !== 0) {
-          notificationMessage = `⚡ Your voting power has changed in ${daoId}!\nVoting power updated by ${deltaValue}.`;
+          notificationMessage = `⚡ Your voting power has changed in ${daoId}!\nVoting power updated by ${formattedDelta}.`;
         } else {
           notificationMessage = `⚡ Your voting power has changed in ${daoId}!\nVoting power activity detected.`;
         }