Orion Dev Epic: Member and Channel Notifications

[dmtrjsg]

Context

• Dev Epic: User Notifications atlas#4152
• Design Epic: Notification settings atlas#4084

Scope

• Implement email notifications linked to the Orion user accounts, where events are specific to the users, and notifications status (read/ unread) is kept on the server side.
• Support distinct feature of in-app vs email notifications, customisable on the level of individual triggers, linked to on-chain and off-chain events (⚠️ for example YPP related or channel following).
• Separate notification events for channels and members. Channel events need to trigger notifications to email used for the orion account of the ownning member.
• Build the generic API for email distribution, where any email distribution platform can be used. ⚠️ For Gleev, I suggest to use Sendgrid for transactional emails.
• Set up email templates on the server side, so that we are not dependent on the particular tool for email distribution (like sendgrid)

Out of scope ⛔

• CRT related notifications

List of events to cover

Channel events

Content moderation and featuring

• Your channel is excluded from App
• Your video is excluded from App
• Your video was featured on the category page
• Your NFT is featured on the Marketplace

Engagement

• New follower of channel
• New comment posted to video
• New reaction to video

Ypp

• YPP sign up successful
• Channel verified
• Channel suspended

NFTs Auctions

• NFT purchased (for seller)
• NFT bid received (for auction creator)
• NFT timed auction expired (for the auction creator)

Payouts

• Channel received direct payment (via member remark)
• Channel received transfer from WG
• New payout is claimable from Council Payout proposal
• Funds withdrawn from channel account (to member acc)

Member events

Generic:

• Password reset

Engagement

• Someone replied to your comment
• Someone reacted to your comment

Followed channels

• Posted new video
• Put new NFT on sale / auction

NFT

• NFT bid outbid (someone places higher bid than your own)
• NFT timed auction expired (for winner)
• NFT timed auction expired (for loser)
• NFT open auction settled (for the winning bidder)
• NFT open auction settled (for the losing bidders)
• NFT bid becomes withdrawable (for bidder)

Own channel related:

• New Channel created

Payouts:

• Funds received
• Funds sent
• Member received transfer from DAO WG

[drillprop]

List of events to cover

Channel events

Content moderation and featuring

• Your channel is excluded from App
• Your video is excluded from App
• Your video was featured on the category page
• Your NFT is featured on the Marketplace

Should we also support notifications for featuring video hero(the one that was on the homepage in the past)? We removed the video hero some time ago from atlas, but the logic for it is still available(setVideoHero mutation)

NFTs Auctions

• NFT purchased (for seller)
• NFT bid received (for auction creator)
• NFT timed auction expired (for the auction creator)

Payouts

• Channel received direct payment (via member remark)
• Channel received transfer from WG
• New payout is claimable from Council Payout proposal
• Funds withdrawn from channel account (to member ACC)

notification about receiving royalty from NFT that you minted would be nice(the balance goes to the channels, so it's channel related).

Question - should we actually support reactions and follows? I don't think for example youtube notifies users about how many likes or follows they receive. On atlas, currently, there are not a lot of reactions, but in the future, this could be a lot of events if certain video/channel become popular

Besides that looks good.

[dmtrjsg]

1. Featuring video hero is a good idea "Your video is featured as the [category_title] category hero video." ✅
2. Same with Your NFT was featured on the marketplace "Your NFT [NFT_titile] is featured on the Marketplace." ✅
3. Yes, indeed, let's add Royalties "You received royalties for [NFT_title]." ✅
4. Channel followers, reactions to videos -> Probably an overkill you are right, great thinking, let's exclude. ⛔

cc @ignazio-bovo @KubaMikolajczyk

[dmtrjsg]

@ignazio-bovo discussed again and decided to include channel followers and reactions to videos 😇 ✅
cc @drillprop

[ignazio-bovo]

Just to point out that not all notifications listed have already handler/resolver implemented yet, is their implementation part of this scope yet? @dmtrjsg

[dmtrjsg]

is their implementation part of this scope yet

Are you asking if the above is the full scope of events? - I'd say so.

@KubaMikolajczyk is including them to designs so my expectation is that Atlas team will handle them just as designed when backend is ready. cc @attemka

[ignazio-bovo]

what I mean is that for example if there's no markChannelAsVerified mutation in the first place there cannot be any notification deposit.
What I am asking is: in case of any of the above notifications miss handlers/resolvers needed to trigger them should I implement them in the scope of this sprint?

[dmtrjsg]

@ignazio-bovo Yes that makes sense @ignazio-bovo thank you for asking. The only one we are removing is the password updated notification 👍

[dmtrjsg]

MM

Agreed timeline:

User accounts need to be merged to Orion v3

• User accounts #122 to be merged as needed for user accs release.

V0 (dev) - support notification preferences for Atlas
Draft PR is opened and it contains this part >

• User account notifications #156
  @ignazio-bovo to share the part covering the preferences with @thesan

v1. - circa 2 weeks from now

• All notifications where mappings are already created on Orion
• templates

• Manual testing on Atlas

@ignazio-bovo to share the list of notiffs

v1.1 - circa 2 more weeks

• Notifications where runtime event exists but there are no mappings on Orion
• email digest

V1.2 - timeline unclear as this one is tricky

• timed auction ended
• bid can be withdrawn

v1.3

• Auto-tests

---

[ignazio-bovo]

• Channel received transfer from WG
• New payout is claimable from Council Payout proposal

See #155 it contains a section with mappings that are already implemented, and the one that needs to be implemented (in v2)
It contains also a status on the template generation