Next release July 2024

funding.json

@@ -0,0 +1,5 @@
+{
+  "opRetro": {
+    "projectId": "0xe434930e189c807b137ff0d8e2fa6a95eaa57dde574143a02ca0d7fb31a40bea"
+  }
+}

migrations/1718888344202-seedNotificationTypeForNotifyRewardAmount.ts

@@ -0,0 +1,27 @@
+import { MigrationInterface, QueryRunner } from "typeorm"
+import { NOTIFICATION_CATEGORY, NOTIFICATION_TYPE_NAMES } from '../src/types/general';
+import { MICRO_SERVICES } from '../src/utils/utils';
+import { NotificationType, SCHEMA_VALIDATORS_NAMES } from '../src/entities/notificationType';
+
+const NotifyRewardAmountNotificationType = [
+    {
+        name: NOTIFICATION_TYPE_NAMES.NOTIFY_REWARD_AMOUNT,
+        description: NOTIFICATION_TYPE_NAMES.NOTIFY_REWARD_AMOUNT,
+        microService: MICRO_SERVICES.givethio,
+        category: NOTIFICATION_CATEGORY.NOTIFY_REWARD_AMOUNT,
+        schemaValidator: SCHEMA_VALIDATORS_NAMES.NOTIFY_REWARD_AMOUNT,
+        title: "Notify reward report",
+    }
+]
+
+export class seedNotificationTypeForNotifyRewardAmount1718888344202 implements MigrationInterface {
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.manager.save(NotificationType, NotifyRewardAmountNotificationType);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(
+          `DELETE FROM notification_type WHERE "name" = ${NOTIFICATION_TYPE_NAMES.NOTIFY_REWARD_AMOUNT};`,
+        );
+    }
+}

migrations/1719224595366-seedNotificationTypeForSendEmailConfirmation.ts

@@ -0,0 +1,27 @@
+import { MigrationInterface, QueryRunner } from "typeorm"
+import { NOTIFICATION_CATEGORY } from '../src/types/general';
+import { MICRO_SERVICES } from '../src/utils/utils';
+import { NotificationType, SCHEMA_VALIDATORS_NAMES } from '../src/entities/notificationType';
+import { NOTIFICATIONS_EVENT_NAMES } from '../src/types/notifications';
+
+const EmailConfirmationNotificationType = [
+    {
+        name: NOTIFICATIONS_EVENT_NAMES.SEND_EMAIL_CONFIRMATION,
+        description: NOTIFICATIONS_EVENT_NAMES.SEND_EMAIL_CONFIRMATION,
+        microService: MICRO_SERVICES.givethio,
+        category: NOTIFICATION_CATEGORY.ORTTO,
+        schemaValidator: SCHEMA_VALIDATORS_NAMES.SEND_EMAIL_CONFIRMATION,
+    }
+]
+
+export class seedNotificationTypeForSendEmailConfirmation1719224595366 implements MigrationInterface {
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.manager.save(NotificationType, EmailConfirmationNotificationType);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(
+          `DELETE FROM notification_type WHERE "name" = 'Send email confirmation';`,
+        );
+    }
+}

migrations/1719410008992-seedNotificationTypeForOnboardingGuide.ts

@@ -0,0 +1,26 @@
+import { MigrationInterface, QueryRunner } from "typeorm"
+import { NotificationType, SCHEMA_VALIDATORS_NAMES } from '../src/entities/notificationType';
+import { NOTIFICATION_CATEGORY, NOTIFICATION_TYPE_NAMES } from '../src/types/general';
+import { MICRO_SERVICES } from '../src/utils/utils';
+
+const OnboardingNotificationType = [
+    {
+        name: NOTIFICATION_TYPE_NAMES.SUBSCRIBE_ONBOARDING,
+        description: NOTIFICATION_TYPE_NAMES.SUBSCRIBE_ONBOARDING,
+        microService: MICRO_SERVICES.givethio,
+        category: NOTIFICATION_CATEGORY.ORTTO,
+        schemaValidator: SCHEMA_VALIDATORS_NAMES.SUBSCRIBE_ONBOARDING,
+    }
+]
+
+export class seedNotificationTypeForOnboardingGuide1719410008992 implements MigrationInterface {
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.manager.save(NotificationType, OnboardingNotificationType);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(
+          `DELETE FROM notification_type WHERE "name" = 'Subscribe onboarding';`,
+        );
+    }
+}

src/entities/notificationType.ts

@@ -4,19 +4,17 @@ import {
   CreateDateColumn,
   Entity,
   Index,
-  JoinTable,
-  ManyToOne,
   OneToMany,
   PrimaryGeneratedColumn,
-  RelationId,
   UpdateDateColumn,
 } from 'typeorm';
-import { NOTIFICATION_CATEGORY } from '../types/general';
 import { NotificationSetting } from './notificationSetting';
 
 // Export Object with Schemas to N1 lookup
 export const SCHEMA_VALIDATORS_NAMES = {
+  SEND_EMAIL_CONFIRMATION: 'sendEmailConfirmation',
   CREATE_ORTTO_PROFILE: 'createOrttoProfile',
+  SUBSCRIBE_ONBOARDING: 'subscribeOnboarding',
   SUPERFLUID: 'userSuperTokensCritical',
   ADMIN_MESSAGE: 'adminMessage',
   RAW_HTML_BROADCAST: 'rawHtmlBroadcast',
@@ -68,6 +66,8 @@ export const SCHEMA_VALIDATORS_NAMES = {
   PROJECT_HAS_A_NEW_RANK: 'projectHasANewRank',
   PROJECT_HAS_RISEN_IN_THE_RANK: 'projectHasRisenInTheRank',
   YOUR_PROJECT_GOT_A_RANK: 'yourProjectGotARank',
+
+  NOTIFY_REWARD_AMOUNT: 'notifyRewardAmount',
 };
 export type HtmlTemplate = { type: string; content: string; href?: string }[];
 

src/routes/v1/notificationRouter.ts

@@ -5,6 +5,7 @@ import {
 } from '../../middlewares/authentication';
 import { NotificationsController } from '../../controllers/v1/notificationsController';
 import { sendStandardResponse } from '../../utils/responseUtils';
+import { logger } from '../../utils/logger';
 import { createNewUserAddressIfNotExists } from '../../repositories/userAddressRepository';
 
 export const notificationRouter = express.Router();
@@ -22,6 +23,7 @@ notificationRouter.post(
       });
       return sendStandardResponse({ res, result });
     } catch (e) {
+      logger.error('/thirdParty/notifications error', e);
       next(e);
     }
   },
@@ -41,6 +43,7 @@ notificationRouter.post(
       );
       return sendStandardResponse({ res, result });
     } catch (e) {
+      logger.error('/thirdParty/notificationsBulk error', e);
       next(e);
     }
   },
@@ -65,6 +68,7 @@ notificationRouter.get(
       );
       return sendStandardResponse({ res, result });
     } catch (e) {
+      logger.error('/notifications error', e);
       next(e);
     }
   },
@@ -85,6 +89,7 @@ notificationRouter.put(
       );
       return sendStandardResponse({ res, result });
     } catch (e) {
+      logger.error('/notifications/read/:notificationId error', e);
       next(e);
     }
   },
@@ -100,6 +105,7 @@ notificationRouter.get(
       );
       return sendStandardResponse({ res, result });
     } catch (e) {
+      logger.error('/notifications/countUnread/:walletAddress error', e);
       next(e);
     }
   },
@@ -120,6 +126,7 @@ notificationRouter.put(
       );
       return sendStandardResponse({ res, result });
     } catch (e) {
+      logger.error('/notifications/readAll error', e);
       next(e);
     }
   },

src/routes/v1/notificationSettingsRouter.ts

@@ -2,6 +2,7 @@ import express, { Request, Response } from 'express';
 import { validateAuthMicroserviceJwt } from '../../middlewares/authentication';
 import { NotificationSettingsController } from '../../controllers/v1/notificationSettingsController';
 import { sendStandardResponse } from '../../utils/responseUtils';
+import { logger } from '../../utils/logger';
 
 export const notificationSettingsRouter = express.Router();
 
@@ -25,6 +26,7 @@ notificationSettingsRouter.get(
         );
       return sendStandardResponse({ res, result });
     } catch (e) {
+      logger.error('get /notification_settings error', e);
       next(e);
     }
   },
@@ -47,6 +49,7 @@ notificationSettingsRouter.put(
         );
       return sendStandardResponse({ res, result });
     } catch (e) {
+      logger.error('/notification_settings/:id error', e);
       next(e);
     }
   },
@@ -68,6 +71,7 @@ notificationSettingsRouter.put(
         );
       return sendStandardResponse({ res, result });
     } catch (e) {
+      logger.error('put /notification_settings error', e);
       next(e);
     }
   },

src/services/notificationService.ts

@@ -14,14 +14,14 @@ import { getEmailAdapter } from '../adapters/adapterFactory';
 import { NOTIFICATION_CATEGORY } from '../types/general';
 
 const activityCreator = (payload: any, orttoEventName: NOTIFICATIONS_EVENT_NAMES) : any=> {
-  const fields = {
-    "str::email": payload.email,
-  }
-  if (process.env.ENVIRONMENT === 'production') {
-    fields['str:cm:user-id'] = payload.userId?.toString()
-  }
   let attributes;
   switch (orttoEventName) {
+    case NOTIFICATIONS_EVENT_NAMES.SEND_EMAIL_CONFIRMATION:
+      attributes = {
+        "str:cm:email": payload.email,
+        "str:cm:verificationlink": payload.verificationLink,
+      }
+      break;
     case NOTIFICATIONS_EVENT_NAMES.CREATE_ORTTO_PROFILE:
       attributes = {
         "str:cm:email": payload.email,
@@ -126,6 +126,7 @@ const activityCreator = (payload: any, orttoEventName: NOTIFICATIONS_EVENT_NAMES
         "str:cm:email": payload.email,
         "str:cm:projectlink": payload.projectLink,
         "str:cm:verified-status": 'rejected',
+        "txt:cm:reason": payload.verificationRejectedReason,
         "str:cm:userid": payload.userId?.toString(),
       };
       break
@@ -163,6 +164,19 @@ const activityCreator = (payload: any, orttoEventName: NOTIFICATIONS_EVENT_NAMES
         "str:cm:userid": payload.userId?.toString(),
       }
       break
+    case NOTIFICATIONS_EVENT_NAMES.NOTIFY_REWARD_AMOUNT:
+      attributes = {
+        "int:cm:round": payload.round,
+        "str:cm:date": payload.date,
+        "str:cm:amount": payload.amount,
+        "str:cm:contractaddress": payload.contractAddress,
+        "str:cm:farm": payload.farm,
+        "str:cm:message": payload.message,
+        "str:cm:network": payload.network,
+        "str:cm:script": payload.script,
+        "str:cm:transactionhash": payload.transactionHash,
+      }
+      break
     default:
       logger.debug('activityCreator() invalid event name', orttoEventName)
       return;
@@ -171,8 +185,12 @@ const activityCreator = (payload: any, orttoEventName: NOTIFICATIONS_EVENT_NAMES
     logger.debug('activityCreator() invalid ORTTO_EVENT_NAMES', orttoEventName)
     return;
   }
+  const fields = {
+    "str::email": payload.email,
+  }
   const merge_by = [];
-  if (process.env.ENVIRONMENT === 'production') {
+  if (process.env.ENVIRONMENT === 'production' && orttoEventName !== NOTIFICATIONS_EVENT_NAMES.SEND_EMAIL_CONFIRMATION) {
+    fields['str:cm:user-id'] = payload.userId?.toString()
     merge_by.push("str:cm:user-id")
   } else {
     merge_by.push("str::email")
@@ -204,9 +222,7 @@ export const sendNotification = async (
       message: errorMessages.DUPLICATED_TRACK_ID,
     };
   }
-  const userAddress = await createNewUserAddressIfNotExists(
-    userWalletAddress as string,
-  );
+
   const notificationType = await getNotificationTypeByEventNameAndMicroservice({
     eventName: body.eventName,
     microService,
@@ -221,10 +237,14 @@ export const sendNotification = async (
 
   const isOrttoSpecific = notificationType.category === NOTIFICATION_CATEGORY.ORTTO
 
+  const userAddress = isOrttoSpecific ? undefined : await createNewUserAddressIfNotExists(
+    userWalletAddress as string,
+  );
+
   const notificationSetting = isOrttoSpecific ? null :
     await findNotificationSettingByNotificationTypeAndUserAddress({
       notificationTypeId: notificationType.id,
-      userAddressId: userAddress.id,
+      userAddressId: userAddress?.id as number
     });
 
   const shouldSendEmail =

src/types/general.ts

@@ -11,7 +11,8 @@ export enum NOTIFICATION_CATEGORY {
   GIV_ECONOMY = 'givEconomy',
   SUPPORTED_PROJECTS = 'supportedProjects',
   GIV_POWER = 'givPower',
-  ORTTO = 'ortto'
+  ORTTO = 'ortto',
+  NOTIFY_REWARD_AMOUNT = 'notifyRewardAmount',
 }
 
 export enum NOTIFICATION_TYPE_NAMES {
@@ -51,5 +52,8 @@ export enum NOTIFICATION_TYPE_NAMES {
   PROJECT_HAS_A_NEW_RANK = 'Your project has a new rank',
   PROJECT_HAS_RISEN_IN_THE_RANK = 'Your Project has risen in the rank',
   YOUR_PROJECT_GOT_A_RANK = 'Your project got a rank',
+  SUBSCRIBE_ONBOARDING = 'Subscribe onboarding',
   CREATE_ORTTO_PROFILE = 'Create Ortto profile',
+
+  NOTIFY_REWARD_AMOUNT = 'Notify reward amount',
 }

src/types/notifications.ts

@@ -48,6 +48,9 @@ export enum NOTIFICATIONS_EVENT_NAMES {
   SUPER_TOKENS_BALANCE_MONTH = 'One month left in stream balance',
   SUPER_TOKENS_BALANCE_DEPLETED = 'Stream balance depleted',
   CREATE_ORTTO_PROFILE = 'Create Ortto profile',
+  SEND_EMAIL_CONFIRMATION = 'Send email confirmation',
+
+  NOTIFY_REWARD_AMOUNT = 'Notify reward amount',
 }
 
 export const ORTTO_EVENT_NAMES = {
@@ -66,5 +69,7 @@ export const ORTTO_EVENT_NAMES = {
   [NOTIFICATIONS_EVENT_NAMES.VERIFICATION_FORM_REJECTED]: 'project-verification',
   [NOTIFICATIONS_EVENT_NAMES.PROJECT_BADGE_REVOKE_WARNING]: 'first-update-warning',
   [NOTIFICATIONS_EVENT_NAMES.PROJECT_BADGE_REVOKE_LAST_WARNING]: 'second-update-warning',
-  [NOTIFICATIONS_EVENT_NAMES.CREATE_ORTTO_PROFILE]: 'created-profile'
+  [NOTIFICATIONS_EVENT_NAMES.CREATE_ORTTO_PROFILE]: 'created-profile',
+  [NOTIFICATIONS_EVENT_NAMES.SEND_EMAIL_CONFIRMATION]: 'verification-form-email-verification',
+  [NOTIFICATIONS_EVENT_NAMES.NOTIFY_REWARD_AMOUNT]: 'notify-reward-amount'
 }