Initial version

.env.example

@@ -0,0 +1 @@
+DATABASE_URL=postgresql://postgres:postgres@localhost:5432/adamant_ns?schema=public

.gitignore

@@ -1,4 +1,20 @@
+# NPM
 node_modules
+package-lock.json
 dist/
+
+# Editors
+.vscode
 .idea
+
+# Config
+.env
+config.json5
 firebase-credentials.json
+
+# Logs
+logs/*
+!/logs/.gitkeep
+
+
+

README.md

@@ -1,5 +1,15 @@
 # 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:
@@ -45,3 +55,49 @@ sequenceDiagram
     APNS_FCM-->>UserDevice: Notify user's device
     UserDevice->>UserDevice: Decrypt transaction using private key
 ```
+
+## ANS
+
+To register a token you must sign and send a signal transaction ([AIP-6: Signal Messages](https://aips.adamant.im/AIPS/aip-6)) to an ADAMANT node. You must set the `recipientId` of the current ANS service so the service can decode the transaction.
+
+Payload format:
+
+```ts
+type SignalMessagePayload = {
+  token: string;
+  provider: "APNS" | "FCM";
+  action: "add" | "remove";
+}
+```
+
+- `token`: User's device token
+- `provider`: Push service provider
+  - `APNS`: Apple Push Notification service (for iOS app)
+  - `FCM`: Firebase Cloud Messaging (for Web/Android apps)
+- `action`: Signal action
+  - `add`: Register new devise
+  - `remove`: Unregister device
+
+### Register new device
+
+The service will save the token to the database and start monitoring new messages on the blockchain. As soon as a new message arrives, a push notification will be sent.
+
+```json
+{
+  "token": "DeviceToken",
+  "provider": "FCM",
+  "action": "add"
+}
+```
+
+### Unregister device
+
+The service will remove the device token from the database and stop sending push notifications.
+
+```json
+{
+  "token": "DeviceToken",
+  "provider": "FCM",
+  "action": "remove"
+}
+```

config.sample.json5

@@ -0,0 +1,61 @@
+{
+  app: {
+    /*
+     Server port with health check endpoint
+    */
+    port: 3000
+  },
+
+  /*
+   The maximum number of hours after a transaction occurs during which a notification can be sent to the user.
+   If a transaction is older than the specified number of hours, the system will skip sending a notification for that transaction
+  */
+  notificationExpiryHours: 24,
+
+  /*
+   List of nodes to fetch transactions.
+   If one becomes unavailable, the bot will choose a live one.
+  */
+  admNodes: [
+    'https://bid.adamant.im',
+    'http://localhost:36666',
+    'https://endless.adamant.im',
+    'https://clown.adamant.im',
+    'https://unusual.adamant.im',
+    'https://debate.adamant.im',
+    'http://23.226.231.225:36666',
+    'http://78.47.205.206:36666',
+    'https://lake.adamant.im',
+    'https://sunshine.adamant.im'
+  ],
+
+  /*
+   Pass phrase for the incoming transaction's bot
+  */
+  passPhrase: '',
+
+  /*
+    Transaction types to notify:
+      0 - token transfer transaction
+      2 - delegate registration transaction
+      3 - vote for delegate transaction
+      8 - chat/message transaction
+      9 - store data in KVS transaction
+  */
+  notifyTxTypes: [0, 8],
+
+  /*
+    If service notifies "8" type of transactions (chat/message transaction)
+    include subtypes to notify of these transactions:
+      1 - Basic encrypted messages
+      2 - Rich content messages
+      3 - Signal messages
+  */
+  chatTxTypeIncludeSubtype: [1, 2],
+
+  /*
+   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
+  */
+  latestHeightToNotify: 500
+}

eslint.config.js

@@ -1,7 +1,7 @@
 // @ts-check
 
-import eslint from '@eslint/js'
-import tseslint from 'typescript-eslint'
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
 
 export default tseslint.config({
   files: ['src/**/*.ts'],
@@ -17,10 +17,11 @@ export default tseslint.config({
   },
   extends: [eslint.configs.recommended, ...tseslint.configs.recommended],
   rules: {
-    '@typescript-eslint/no-unsafe-argument': 'error',
-    '@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-argument': 'off',
+    '@typescript-eslint/no-unsafe-assignment': 'off',
+    '@typescript-eslint/no-unsafe-call': 'off',
+    '@typescript-eslint/no-unsafe-member-access': 'off',
+    '@typescript-eslint/no-unsafe-return': 'off',
+    '@typescript-eslint/no-explicit-any': 'off'
   }
-})
+});

firebase-credentials.example.json

@@ -0,0 +1,13 @@
+{
+  "type": "service_account",
+  "project_id": "firebase-project",
+  "private_key_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+  "private_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+  "client_email": "[email protected]",
+  "client_id": "892364582347597234697234",
+  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+  "token_uri": "https://oauth2.googleapis.com/token",
+  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/firebase-project.iam.gserviceaccount.com",
+  "universe_domain": "googleapis.com"
+}