Initial version

.gitignore

@@ -2,3 +2,6 @@ node_modules
 dist/
 .idea
 firebase-credentials.json
+logs/*
+!/logs/.gitkeep
+config.json5

README.md

@@ -1,5 +1,14 @@
 # ADAMANT Notification Service (ANS)
 
+## Configuration
+1. Fill `config5.json` file with configuration settings (`config.sample.json5` as an example)
+2. Create `firebase-credentials.json` file (`firebase-credentials-example.json` as an example)
+3. `pnpm install`
+4. `export DATABASE_URL=$database-url`
+5. `npx prisma migrate deploy`
+6. `pnpm run build`
+7. `pnpm run start`
+
 ## How it works
 
 To deliver notifcations privately and secure, 4 parties are involved:

config.json5 → config.sample.json5

@@ -40,7 +40,7 @@
   /**
   Pass phrase for the incoming transaction's bot
   **/
-  "passPhrase": "pig update shiver various bus van tourist sister plastic card reform satisfy",
+  "passPhrase": "",
 
   /**
   Transaction types to notify
@@ -62,9 +62,8 @@
   "chatTxTypeIncludeSubtype": [1, 2],
 
   /**
-  Notification service to use
-  APNS, FCM
+  If the service has been shut down, it will process blocks from the moment of switching off.
+  The setting specifies how many last blocks to notify users about new transactions
   **/
-
-  "notificationService": "FCM"
+  "latestHeightToNotify": 500
 }

eslint.config.js

@@ -21,6 +21,7 @@ export default tseslint.config({
     '@typescript-eslint/no-unsafe-assignment': 'error',
     '@typescript-eslint/no-unsafe-call': 'error',
     '@typescript-eslint/no-unsafe-member-access': 'error',
-    '@typescript-eslint/no-unsafe-return': 'error'
+    '@typescript-eslint/no-unsafe-return': 'error',
+    '@typescript-eslint/no-explicit-any': 'off'
   }
 })

package.json

@@ -11,7 +11,7 @@
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "format": "prettier --write ./src",
-    "postinstall": "husky install"
+    "postinstall": "husky install && prisma generate"
   },
   "author": "ADAMANT Foundation <[email protected]>",
   "license": "GPL-3.0",
@@ -57,6 +57,7 @@
     "firebase-admin": "^12.2.0",
     "json5": "^2.2.3",
     "node-cron": "^3.0.3",
-    "prisma": "^5.16.0"
+    "prisma": "^5.16.0",
+    "zod": "^3.23.8"
   }
 }

prisma/migrations/20240813133939_add_tx_to_notification/migration.sql

@@ -0,0 +1,8 @@
+/*
+  Warnings:
+
+  - Added the required column `admTx` to the `NotifyTransaction` table without a default value. This is not possible if the table is not empty.
+
+*/
+-- AlterTable
+ALTER TABLE "NotifyTransaction" ADD COLUMN     "admTx" JSONB NOT NULL;

prisma/schema.prisma

@@ -27,8 +27,11 @@ model Device {
 model NotifyTransaction {
   id                  Int      @id @default(autoincrement())
   createdAt           DateTime @default(now())
+
   admTxId             String   @db.VarChar(20)
   admTxDate           DateTime
+  admTx               Json
+
   isNotified          Boolean  @default(false)
   lastNotifyDate      DateTime?
 

src/adapters/notification/apnsNotification.ts

@@ -0,0 +1,14 @@
+import { BaseNotificationInterface } from './baseNotification.js'
+import { PushServiceProvider } from '../../types/models.js'
+
+export class ApnsNotification implements BaseNotificationInterface {
+  provider = PushServiceProvider.APNS
+
+  message(): Promise<string> {
+    throw new Error('Not implemented')
+  }
+
+  messageMany() {
+    throw new Error('Not implemented')
+  }
+}

src/adapters/notification/baseNotification.ts

@@ -5,23 +5,13 @@ export interface BaseNotificationInterface {
 
   message(
     pushToken: string,
-    notification: { title: string; body: string }
-  ): void
+    notification: { title: string; body: string },
+    data?: { [key: string]: string }
+  ): Promise<string>
 
   messageMany(
     pushTokens: string[],
-    notification: { title: string; body: string }
+    notification: { title: string; body: string },
+    data?: { [key: string]: string }
   ): void
 }
-
-export class BaseNotification implements BaseNotificationInterface {
-  provider: PushServiceProvider | undefined
-
-  message(): void {
-    throw new Error('Not implemented')
-  }
-
-  messageMany(): void {
-    throw new Error('Not implemented')
-  }
-}

src/adapters/notification/fcmNotification.ts

@@ -1,28 +1,48 @@
 import { BaseNotificationInterface } from './baseNotification.js'
-import admin from 'firebase-admin'
-import App = admin.app.App
+import admin, { ServiceAccount } from 'firebase-admin'
 import { PushServiceProvider } from '../../types/models.js'
+import JSON5 from 'json5'
+import fs from 'fs'
+import path from 'path'
+import { config } from '../../config/index.js'
 
 export class FcmNotification implements BaseNotificationInterface {
   private service
   provider = PushServiceProvider.FCM
 
-  constructor(fcmClient: App) {
-    this.service = fcmClient
+  constructor() {
+    const credentials = JSON5.parse(
+      fs.readFileSync(
+        path.join(config.app.projectRoot, 'firebase-credentials.json'),
+        'utf8'
+      )
+    ) as ServiceAccount
+
+    this.service = admin.initializeApp({
+      credential: admin.credential.cert(credentials)
+    })
   }
 
-  message(pushToken: string, notification: { title: string; body: string }) {
-    this.service.messaging().send({ notification, token: pushToken })
+  message(
+    pushToken: string,
+    notification: { title: string; body: string },
+    data?: { [key: string]: string }
+  ) {
+    return this.service
+      .messaging()
+      .send({ notification, token: pushToken, ...(data ? { data } : {}) })
   }
 
   messageMany(
     pushTokens: string[],
-    notification: { title: string; body: string }
+    notification: { title: string; body: string },
+    data?: { [key: string]: string }
   ) {
     this.service.messaging().sendEach(
       pushTokens.map((pushToken) => ({
         notification,
-        token: pushToken
+        token: pushToken,
+        ...(data ? { data } : {})
       }))
     )
   }

src/config.ts → src/config/index.ts

@@ -5,35 +5,30 @@ import {
   createAddressFromPublicKey,
   createKeypairFromPassphrase
 } from 'adamant-api'
+import { schema, Schema as ConfigSchema } from './schema.js'
+import { fromZodError } from '../utils/zod.js'
 
 const projectRoot = process.cwd()
 
-interface ConfigFile {
-  database: {
-    url: string
-  }
-  app: {
-    port: number
-  }
-  notificationExpiryHours: number
-  admNodes: string[]
-  passPhrase: string
-  notifyTxTypes: number[]
-  chatTxTypeIncludeSubtype: number[]
-  notificationService: 'FCM' | 'APNS'
-}
-
 interface PackageFile {
   version: string
 }
 
 const configFile = JSON5.parse(
   fs.readFileSync(path.join(projectRoot, 'config.json5'), 'utf8')
-) as ConfigFile
+) as ConfigSchema
 const packageFile = JSON5.parse(
   fs.readFileSync(path.join(projectRoot, 'package.json'), 'utf8')
 ) as PackageFile
 
+const result = schema.safeParse(configFile)
+
+if (!result.success) {
+  const message = fromZodError(result.error)
+
+  throw new Error(`Service's config is wrong:\n${message}Cannot start the bot.`)
+}
+
 export const config = {
   app: {
     name: 'adamant-ns',
@@ -42,8 +37,8 @@ export const config = {
     projectRoot,
     notificationExpiryHours: configFile.notificationExpiryHours,
     txCheckInterval: '*/4 * * * * *', // in cron language
-    heightSkipPerHeight: 1,
-    notificationService: configFile.notificationService
+    retryNotifyInterval: '*/4 * * * * *', // */10 * * * * in cron language
+    heightSkipPerHeight: 1
   },
   database: {
     url: configFile.database.url
@@ -52,7 +47,8 @@ export const config = {
   notify: {
     passPhrase: configFile.passPhrase,
     notifyTxTypes: configFile.notifyTxTypes,
-    chatTxTypeIncludeSubtype: configFile.chatTxTypeIncludeSubtype
+    chatTxTypeIncludeSubtype: configFile.chatTxTypeIncludeSubtype,
+    latestHeightToNotify: configFile.latestHeightToNotify
   },
   adamantAccount: {
     passPhrase: configFile.passPhrase,

src/config/schema.ts

@@ -0,0 +1,22 @@
+import { z } from 'zod'
+
+export const schema = z
+  .object({
+    database: z.object({
+      url: z.string()
+    }),
+    app: z.object({
+      port: z.number()
+    }),
+    notificationExpiryHours: z.number(),
+    admNodes: z.array(z.string()),
+    passPhrase: z.string(),
+    notifyTxTypes: z.array(z.number()),
+    chatTxTypeIncludeSubtype: z.array(z.number()),
+    latestHeightToNotify: z.number()
+  })
+  .strict() /* Throw error on unknown properties. This will help users to migrate from the
+ * older versions of the bot that use different config schema
+ */
+
+export type Schema = z.infer<typeof schema>