🐰 Add revenue share reminder notification

schema/auth.graphql

@@ -184,6 +184,7 @@ type AccountNotificationPreferences {
   crtRevenueShareStarted: NotificationPreference!
   crtRevenueSharePlanned: NotificationPreference!
   crtRevenueShareEnded: NotificationPreference!
+  crtRevenueShareEndedReminder: NotificationPreference!
 }
 
 type NotificationPreference {

schema/notifications.graphql

@@ -124,6 +124,7 @@ union NotificationType =
   | CreatorTokenRevenueShareStarted
   | CreatorTokenRevenueSharePlanned
   | CreatorTokenRevenueShareEnded
+  | CreatorTokenRevenueShareEndedReminder
 
 type ChannelSuspended @variant {
   phantom: Int
@@ -587,3 +588,20 @@ type CreatorTokenRevenueShareEnded @variant {
   "id of token"
   tokenId: String!
 }
+
+type CreatorTokenRevenueShareEndedReminder @variant {
+  "channel title for notification text"
+  channelTitle: String!
+
+  "channel title for notification avatar"
+  channelId: String!
+
+  "symbol of the token"
+  tokenSymbol: String!
+
+  "id of created revenue share to verify its' viability in future"
+  revenueShareId: String!
+
+  "id of token"
+  tokenId: String!
+}

src/mappings/token/index.ts

@@ -20,6 +20,7 @@
   CreatorTokenMarketStarted,
   CreatorTokenMarketStartedEventData,
   CreatorTokenRevenueShareEnded,
+  CreatorTokenRevenueShareEndedReminder,
   CreatorTokenRevenueSharePlanned,
   CreatorTokenRevenueShareStarted,
   CreatorTokenRevenueSplitIssuedEventData,
@@ -41,10 +42,12 @@
   VestedSale,
   VestingSchedule,
 } from '../../model'
+import { BLOCKS_PER_DAY } from '../../server-extension/resolvers/CreatorToken'
 import { getCurrentBlockHeight } from '../../utils/blockHeight'
 import { EventHandlerContext } from '../../utils/events'
 import { criticalError } from '../../utils/misc'
 import { addNotification } from '../../utils/notification'
+import { removeFutureNotification } from '../../utils/notification/helpers'
 import { getChannelOwnerAccount, notifyChannelFollowers, parseChannelTitle } from '../content/utils'
 import { deserializeMetadata, genericEventFields } from '../utils'
 import {
@@ -78,7 +81,7 @@
   },
 }: EventHandlerContext<'ProjectToken.TokenIssued'>) {
   // create token
   const totalSupply = initialAllocation.reduce((acc, [_, allocation]) => {
     return acc + allocation.amount
   }, BigInt(0))
 
@@ -398,7 +401,7 @@
     buyerAccount.totalAmount += crtMinted
   }
 
   const activeAmm = await overlay.getRepository(AmmCurve).getByIdOrFail(token.currentAmmSaleId!)
 
   activeAmm.mintedByAmm += crtMinted
   const tx = overlay.getRepository(AmmTransaction).new({
@@ -458,7 +461,7 @@
     .getOneByRelationOrFail('tokenId', tokenId.toString())
   const channel = await overlay.getRepository(Channel).getByIdOrFail(tokenChannel.channelId)
   token.totalSupply -= crtBurned
   const activeAmm = await overlay.getRepository(AmmCurve).getByIdOrFail(token.currentAmmSaleId!)
   const ammId = activeAmm.id
 
   const sellerAccount = await getTokenAccountByMemberByTokenOrFail(overlay, memberId, tokenId)
@@ -531,7 +534,7 @@
   }
 
   const token = await overlay.getRepository(CreatorToken).getByIdOrFail(tokenId.toString())
   const sale = await overlay.getRepository(Sale).getByIdOrFail(token.currentSaleId!)
   sale.tokensSold += amountPurchased
 
   const tx = overlay.getRepository(SaleTransaction).new({
@@ -591,7 +594,7 @@
   },
 }: EventHandlerContext<'ProjectToken.UpcomingTokenSaleUpdated'>) {
   const token = await overlay.getRepository(CreatorToken).getByIdOrFail(tokenId.toString())
   const sale = await overlay.getRepository(Sale).getByIdOrFail(token.currentSaleId!)
 
   if (newStart) {
     sale.startBlock = newStart
@@ -695,6 +698,26 @@
     event,
     endsAt // schedule for end block
   )
+
+  // This event should have dispatch block of ending block plus about 3 days
+  // If user closes the share before its execution, this notification will be removing during share closing mapping
+  const revenueSharedEndedReminderNotification = new CreatorTokenRevenueShareEndedReminder({
+    revenueShareId: revenueShare.id,
+    channelTitle: parseChannelTitle(channel),
+    channelId: channel.id,
+    tokenSymbol: parseCreatorTokenSymbol(token),
+    tokenId: tokenId.toString(),
+  })
+
+  const channelOwnerAccount = await getChannelOwnerAccount(overlay, channel)
+  await addNotification(
+    overlay,
+    channelOwnerAccount,
+    new ChannelRecipient({ channel: channel.id }),
+    revenueSharedEndedReminderNotification,
+    undefined,
+    endsAt + BLOCKS_PER_DAY * 3 // schedule for end block
+  )
 }
 
 export async function processMemberJoinedWhitelistEvent({
@@ -710,13 +733,13 @@
 export async function processAmmDeactivatedEvent({
   overlay,
   event: {
     asV2002: [tokenId, , burnedAmount],
   },
 }: EventHandlerContext<'ProjectToken.AmmDeactivated'>) {
   const token = await overlay.getRepository(CreatorToken).getByIdOrFail(tokenId.toString())
   token.status = TokenStatus.IDLE
 
   const activeAmm = await overlay.getRepository(AmmCurve).getByIdOrFail(token.currentAmmSaleId!)
   activeAmm.finalized = true
 
   token.currentAmmSaleId = null
@@ -755,12 +778,12 @@
   },
 }: EventHandlerContext<'ProjectToken.TokenSaleFinalized'>) {
   const token = await overlay.getRepository(CreatorToken).getByIdOrFail(tokenId.toString())
   const sale = await overlay.getRepository(Sale).getByIdOrFail(token.currentSaleId!)
   sale.finalized = true
 
   const sourceAccount = await overlay
     .getRepository(TokenAccount)
     .getByIdOrFail(sale.fundsSourceAccountId!)
   sourceAccount.totalAmount += quantityLeft
 
   token.status = TokenStatus.IDLE
@@ -796,9 +819,13 @@
   const token = await overlay.getRepository(CreatorToken).getByIdOrFail(tokenId.toString())
   const revenueShare = await overlay
     .getRepository(RevenueShare)
     .getByIdOrFail(token.currentRevenueShareId!)
   revenueShare.finalized = true
   token.currentRevenueShareId = null
+
+  await removeFutureNotification(overlay.getEm(), 'CreatorTokenRevenueShareEndedReminder', 1, {
+    tokenId: token.id,
+  })
 }
 
 export async function processUserParticipatedInSplitEvent({

src/utils/notification/helpers.ts

@@ -1,5 +1,5 @@
 import { Flat } from 'lodash'
-import { EntityManager } from 'typeorm'
+import { EntityManager, FindOptionsWhere } from 'typeorm'
 import {
   Account,
   AccountNotificationPreferences,
@@ -72,6 +72,7 @@ export function defaultNotificationPreferences(): AccountNotificationPreferences
     crtRevenueShareStarted: notificationPrefAllTrue(),
     crtRevenueSharePlanned: notificationPrefAllTrue(),
     crtRevenueShareEnded: notificationPrefAllTrue(),
+    crtRevenueShareEndedReminder: notificationPrefAllTrue(),
   })
 }
 
@@ -144,6 +145,9 @@ export function preferencesForNotification(
       return preferences.crtRevenueSharePlanned
     case 'CreatorTokenRevenueShareEnded':
       return preferences.crtRevenueShareEnded
+    case 'CreatorTokenRevenueShareEndedReminder':
+      return preferences.crtRevenueShareEnded
+
     default: // all the remaining notifications (v2 scope) are not enabled by default
       return new NotificationPreference({ inAppEnabled: false, emailEnabled: false })
   }
@@ -299,6 +303,45 @@ export const addNotification = async (
   }
 }
 
+export async function removeFutureNotification(
+  em: EntityManager,
+  notificationType: Notification['notificationType']['isTypeOf'],
+  currentBlockHeight: number,
+  filters: Record<string, string | number>
+) {
+  const result: { id: string }[] = await em.query(
+    `
+    SELECT
+        id 
+    FROM 
+        public.notification 
+    WHERE
+        notification_type ->> 'isTypeOf'=$1
+      AND
+        dispatch_block > $2
+        ${Object.keys(filters).map((key, idx) => {
+          return `
+      AND
+        notification_type ->> '${key}'=$${idx + 3}
+        `
+        })}
+         `,
+    [notificationType, currentBlockHeight, ...Object.values(filters)]
+  )
+  const notificationToRemove = result[0]
+
+  if (!notificationToRemove) {
+    return
+  }
+
+  await em.getRepository(Notification).delete({
+    id: notificationToRemove.id,
+  })
+  await em.getRepository(NotificationEmailDelivery).delete({
+    notificationId: notificationToRemove.id,
+  })
+}
+
 async function saveNextNotificationId(
   em: EntityManager,
   nextNotificationId: number,

src/utils/notification/notificationsData.ts

@@ -404,5 +404,15 @@ export const getNotificationData = async (
         subject: `🔓 ${channelTitle} ended revenue share for $${tokenSymbol} token. Unlock your locked tokens!`,
       }
     }
+    case 'CreatorTokenRevenueShareEndedReminder': {
+      const { tokenSymbol, channelId } = notificationType
+      return {
+        icon: await getNotificationIcon(em, 'payout'),
+        link: await getNotificationLink(em, 'portfolio'),
+        avatar: await getNotificationAvatar(em, 'channelId', channelId),
+        text: `🔓 Your $${tokenSymbol} revenue share is waiting to be closed. Unlock locked tokens and open your market!`,
+        subject: `🔓 Your $${tokenSymbol} revenue share is waiting to be closed. Unlock locked tokens and open your market!`,
+      }
+    }
   }
 }