feat: integrate push notifications sdk

.env.example

@@ -36,6 +36,7 @@ GATSBY_SNAPSHOT_DURATION=600
 GATSBY_SNAPSHOT_DELEGATE_CONTRACT_ADDRESS=0x469788fE6E9E9681C6ebF3bF78e7Fd26Fc015446
 GATSBY_SNAPSHOT_ADDRESS=
 SNAPSHOT_PRIVATE_KEY=
+SNAPSHOT_API_KEY=
 
 # Snapshot Status
 SNAPSHOT_STATUS_ENABLED='false'
@@ -49,9 +50,6 @@ GATSBY_DISCOURSE_API=https://forum.decentraland.org
 GATSBY_DISCOURSE_CONNECT_THREAD=0
 DISCOURSE_API_KEY=
 
-# Decentraland's mailchimp integration
-GATSBY_DECENTRALAND_API=https://subscription.decentraland.org
-
 # Required voting power to pass a proposal by type
 GATSBY_VOTING_POWER_TO_PASS_LINKED_WEARABLES=0
 GATSBY_VOTING_POWER_TO_PASS_CATALYST=0
@@ -63,6 +61,7 @@ GATSBY_VOTING_POWER_TO_PASS_GOVERNANCE=0
 GATSBY_VOTING_POWER_TO_PASS_PITCH=0
 GATSBY_VOTING_POWER_TO_PASS_TENDER=0
 GATSBY_VOTING_POWER_TO_PASS_HIRING=0
+GATSBY_VOTING_POWER_TO_PASS_GRANT=0
 
 # Duration for governance process proposals
 GATSBY_DURATION_POLL=1200
@@ -87,6 +86,7 @@ GATSBY_SUBMISSION_THRESHOLD_HIRING=100
 # Single Sign On
 GATSBY_SSO_URL="https://id.decentraland.zone"
 
+# Bidding & Tendering
 MINIMUM_BIDS_TO_PUBLISH=2
 
 # Segment integration
@@ -110,3 +110,9 @@ DAO_ROLLBAR_TOKEN=""
 # Newsletter
 BEEHIIV_API_KEY=
 BEEHIIV_PUBLICATION_ID=
+
+# Notifications
+NOTIFICATIONS_SERVICE_ENABLED=false
+PUSH_API_URL=https://backend-staging.epns.io
+PUSH_CHANNEL_OWNER_PK=
+GATSBY_PUSH_CHANNEL_ID=

gatsby-node.js

@@ -19,6 +19,8 @@ exports.onCreateWebpackConfig = ({ stage, actions, getConfig }) => {
         os: false,
         stream: false,
         util: false,
+        zlib: false,
+        url: false,
       },
     },
   })

package.json

@@ -56,6 +56,7 @@
     "@dcl/ui-env": "1.2.1",
     "@jparnaudo/react-crypto-icons": "^1.0.5",
     "@otterspace-xyz/contracts": "^2.7.3",
+    "@pushprotocol/restapi": "^1.4.20",
     "@snapshot-labs/snapshot.js": "0.5.5",
     "@tanstack/react-query": "^4.29.7",
     "autoprefixer": "^10.4.4",

src/back/models/UserNotificationConfig.ts

@@ -0,0 +1,12 @@
+import { Model } from 'decentraland-gatsby/dist/entities/Database/model'
+
+export type UserNotificationConfigAttributes = {
+  address: string
+  last_notification_id: number
+}
+
+export default class UserNotificationConfigModel extends Model<UserNotificationConfigAttributes> {
+  static tableName = 'user_notification_config'
+  static withTimestamps = false
+  static primaryKey = 'address'
+}

src/back/routes/notification.ts

@@ -0,0 +1,71 @@
+import { WithAuth, auth } from 'decentraland-gatsby/dist/entities/Auth/middleware'
+import RequestError from 'decentraland-gatsby/dist/entities/Route/error'
+import handleAPI from 'decentraland-gatsby/dist/entities/Route/handle'
+import routes from 'decentraland-gatsby/dist/entities/Route/routes'
+import { Request } from 'express'
+
+import { NotificationCustomType } from '../../shared/types/notifications'
+import { NotificationType } from '../../utils/notifications'
+import UserNotificationConfigModel, { UserNotificationConfigAttributes } from '../models/UserNotificationConfig'
+import { NotificationService } from '../services/notification'
+import { validateDebugAddress } from '../utils/validations'
+
+export default routes((router) => {
+  const withAuth = auth()
+  router.post('/notifications/send', withAuth, handleAPI(sendNotification))
+  router.get('/notifications/user/:address', handleAPI(getUserFeed))
+  router.get('/notifications/last-notification', withAuth, handleAPI(getUserLastNotification))
+  router.post('/notifications/last-notification', withAuth, handleAPI(updateUserLastNotification))
+})
+
+async function sendNotification(req: WithAuth) {
+  validateDebugAddress(req.auth)
+  const { title, body, recipient, url, type } = req.body
+
+  if (type === NotificationType.TARGET && !recipient) {
+    throw new RequestError('Target type needs recipient', RequestError.BadRequest)
+  }
+
+  if (!title || !body) {
+    throw new RequestError('Invalid data', RequestError.BadRequest)
+  }
+
+  return await NotificationService.sendNotification({
+    type,
+    title,
+    body,
+    recipient,
+    url,
+    customType: NotificationCustomType.Announcement,
+  })
+}
+
+async function getUserFeed(req: Request) {
+  const address = req.params.address
+  if (!address) {
+    throw new RequestError('Missing user', RequestError.BadRequest)
+  }
+
+  return await NotificationService.getUserFeed(address)
+}
+
+async function getUserLastNotification(req: WithAuth) {
+  const config = await UserNotificationConfigModel.findOne<UserNotificationConfigAttributes>({ address: req.auth })
+  if (!config) {
+    throw new RequestError('User notification not found', RequestError.NotFound)
+  }
+
+  return config.last_notification_id
+}
+
+async function updateUserLastNotification(req: WithAuth) {
+  const last_notification_id = req.body.last_notification_id
+  if (!last_notification_id) {
+    throw new RequestError('Missing Notification ID', RequestError.BadRequest)
+  }
+
+  return await UserNotificationConfigModel.upsert({
+    address: req.auth,
+    last_notification_id,
+  })
+}

src/back/routes/proposal.ts

@@ -84,6 +84,7 @@ import { ProposalInCreation, ProposalService } from '../../services/ProposalServ
 import { getProfile } from '../../utils/Catalyst'
 import Time from '../../utils/date/Time'
 import { ErrorCategory } from '../../utils/errorCategories'
+import { NotificationService } from '../services/notification'
 import { validateAddress, validateProposalId } from '../utils/validations'
 
 export default routes((route) => {
@@ -521,10 +522,12 @@ export async function updateProposalStatus(req: WithAuth<Request<{ proposal: str
     updated_at: new Date(),
   }
 
-  if (update.status === ProposalStatus.Enacted) {
+  const isEnactedStatus = update.status === ProposalStatus.Enacted
+  const isGrantProposal = proposal.type === ProposalType.Grant
+  if (isEnactedStatus) {
     update.enacted = true
     update.enacted_by = user
-    if (proposal.type == ProposalType.Grant) {
+    if (isGrantProposal) {
       const { vesting_addresses } = configuration
       if (!vesting_addresses || vesting_addresses.length === 0) {
         throw new RequestError('Vesting addresses are required for grant proposals', RequestError.BadRequest)
@@ -552,6 +555,9 @@ export async function updateProposalStatus(req: WithAuth<Request<{ proposal: str
   }
 
   await ProposalModel.update<ProposalAttributes>(update, { id })
+  if (isEnactedStatus && isGrantProposal) {
+    NotificationService.grantProposalEnacted(proposal)
+  }
 
   ProposalService.commentProposalUpdateInDiscourse(id)
 

src/back/routes/snapshot.ts

@@ -26,7 +26,7 @@ export default routes((router) => {
   router.get('/snapshot/proposal-scores/:proposalSnapshotId', handleAPI(getProposalScores))
 })
 
-async function getStatus(req: Request) {
+async function getStatus() {
   return await SnapshotStatusService.getStatus()
 }
 

src/back/routes/votes.ts

@@ -1,3 +1,4 @@
+import RequestError from 'decentraland-gatsby/dist/entities/Route/error'
 import handleAPI from 'decentraland-gatsby/dist/entities/Route/handle'
 import routes from 'decentraland-gatsby/dist/entities/Route/routes'
 import { Request } from 'express'
@@ -28,7 +29,7 @@ export async function getProposalVotes(req: Request<{ proposal: string }>) {
   const id = validateProposalId(req.params.proposal)
 
   const proposal = await ProposalService.getProposal(id)
-  const latestVotes = await VoteService.getVotes(id)
+  const latestVotes = await VoteService.getVotes(proposal.id)
 
   if (!!latestVotes.hash && Time.date(proposal.finish_at).getTime() + Time.Hour < Date.now() && !refresh) {
     return latestVotes.votes
@@ -66,6 +67,10 @@ export async function updateSnapshotProposalVotes(proposal: ProposalAttributes,
 }
 
 export async function getCachedVotes(req: Request) {
+  if (!req.query.id) {
+    throw new RequestError('Missing proposal IDs', RequestError.BadRequest)
+  }
+
   const list = toProposalIds(req.query.id as string[])
   const scores = await VotesModel.findAny(list)
   return scores.reduce((result, vote) => {

src/back/services/coauthor.ts

@@ -1,8 +1,13 @@
 import CoauthorModel from '../../entities/Coauthor/model'
 import { CoauthorStatus } from '../../entities/Coauthor/types'
+import { ProposalAttributes } from '../../entities/Proposal/types'
 import { isSameAddress } from '../../entities/Snapshot/utils'
 
 export class CoauthorService {
+  static async getAllFromProposalId(proposalId: ProposalAttributes['id'], status?: CoauthorStatus) {
+    return await CoauthorModel.findCoauthors(proposalId, status || CoauthorStatus.APPROVED)
+  }
+
   static async isCoauthor(proposalId: string, address: string): Promise<boolean> {
     const coauthors = await CoauthorModel.findCoauthors(proposalId, CoauthorStatus.APPROVED)
     return !!coauthors.find((coauthor) => isSameAddress(coauthor.address, address))