add startup notif

Author: kianenigma

examples/config-dev-fellowship.json

@@ -0,0 +1,29 @@
+{
+	"accounts": [],
+	"endpoints": [
+		"wss://polkadot-collectives-rpc.polkadot.io",
+		"wss://kusama-rpc.dwellir.com"
+	],
+	"api_subscription": "finalized",
+	"startup_notification": false,
+	"method_subscription": {
+		"type": "only",
+		"only": [
+			{
+				"pallet": "FellowshipReferenda",
+				"method": "Confirmed"
+			},
+			{
+				"pallet": "FellowshipReferenda",
+				"method": "Submitted"
+			},
+			{
+				"pallet": "FellowshipSalary",
+				"method": "CycleStarted"
+			}
+		]
+	},
+	"reporters": {
+		"console": {}
+	}
+}

package.json

@@ -10,6 +10,7 @@
   ],
   "type": "module",
   "scripts": {
+	"run": "bun run src/index.ts",
     "dev": "bun run src/index.ts -c examples/config-dev-all.json",
     "devp": "bun run src/index.ts -c examples/config-p-dev-all.json",
 

src/config-ti.ts

@@ -5,104 +5,105 @@ import * as t from "ts-interface-checker";
 // tslint:disable:object-literal-key-quotes
 
 export const Only = t.iface([], {
-  "type": t.lit('only'),
-  "only": t.array("ISubscriptionTarget"),
+	"type": t.lit('only'),
+	"only": t.array("ISubscriptionTarget"),
 });
 
 export const Ignore = t.iface([], {
-  "type": t.lit('ignore'),
-  "ignore": t.array("ISubscriptionTarget"),
+	"type": t.lit('ignore'),
+	"ignore": t.array("ISubscriptionTarget"),
 });
 
 export const All = t.iface([], {
-  "type": t.lit('all'),
+	"type": t.lit('all'),
 });
 
 export const MethodSubscription = t.union("All", "Only", "Ignore");
 
 export const ISubscriptionTarget = t.iface([], {
-  "pallet": "string",
-  "method": "string",
+	"pallet": "string",
+	"method": "string",
 });
 
 export const RawAccount = t.iface([], {
-  "address": "string",
-  "nickname": "string",
+	"address": "string",
+	"nickname": "string",
 });
 
 export const BatchConfig = t.iface([], {
-  "interval": "number",
-  "misc": t.opt("boolean"),
-  "leftovers": t.opt("boolean"),
+	"interval": "number",
+	"misc": t.opt("boolean"),
+	"leftovers": t.opt("boolean"),
 });
 
 export const EmailConfig = t.iface([], {
-  "from": "string",
-  "to": t.array("string"),
-  "gpgpubkey": t.opt("string"),
-  "transporter": "any",
-  "batch": t.opt("BatchConfig"),
+	"from": "string",
+	"to": t.array("string"),
+	"gpgpubkey": t.opt("string"),
+	"transporter": "any",
+	"batch": t.opt("BatchConfig"),
 });
 
 export const MatrixConfig = t.iface([], {
-  "userId": t.opt("string"), // optional as it can be passed through env.MATRIX_USERID
-  "accessToken": t.opt("string"), // optional as it can be passed through env.MATRIX_ACCESSTOKEN
-  "roomId": "string",
-  "server": "string",
-  "batch": t.opt("BatchConfig"),
+	"userId": t.opt("string"), // optional as it can be passed through env.MATRIX_USERID
+	"accessToken": t.opt("string"), // optional as it can be passed through env.MATRIX_ACCESSTOKEN
+	"roomId": "string",
+	"server": "string",
+	"batch": t.opt("BatchConfig"),
 });
 
 export const FsConfig = t.iface([], {
-  "path": "string",
-  "batch": t.opt("BatchConfig"),
+	"path": "string",
+	"batch": t.opt("BatchConfig"),
 });
 
 export const ConsoleConfig = t.iface([], {
-  "batch": t.opt("BatchConfig"),
+	"batch": t.opt("BatchConfig"),
 });
 
 export const TelegramConfig = t.iface([], {
-  "chatId": "string",
-  "botToken": "string",
-  "batch": t.opt("BatchConfig"),
+	"chatId": "string",
+	"botToken": "string",
+	"batch": t.opt("BatchConfig"),
 });
 
 export const ReportersConfig = t.iface([], {
-  "email": t.opt("EmailConfig"),
-  "matrix": t.opt("MatrixConfig"),
-  "fs": t.opt("FsConfig"),
-  "telegram": t.opt("TelegramConfig"),
-  "console": t.opt("ConsoleConfig"),
+	"email": t.opt("EmailConfig"),
+	"matrix": t.opt("MatrixConfig"),
+	"fs": t.opt("FsConfig"),
+	"telegram": t.opt("TelegramConfig"),
+	"console": t.opt("ConsoleConfig"),
 });
 
 export const ApiSubscription = t.enumtype({
-  "Head": "head",
-  "Finalized": "finalized",
+	"Head": "head",
+	"Finalized": "finalized",
 });
 
 export const AppConfig = t.iface([], {
-  "accounts": t.array("RawAccount"),
-  "endpoints": t.array("string"),
-  "method_subscription": "MethodSubscription",
-  "api_subscription": "ApiSubscription",
-  "reporters": "ReportersConfig",
+	"accounts": t.array("RawAccount"),
+	"endpoints": t.array("string"),
+	"startup_notification": "boolean",
+	"method_subscription": "MethodSubscription",
+	"api_subscription": "ApiSubscription",
+	"reporters": "ReportersConfig",
 });
 
 const exportedTypeSuite: t.ITypeSuite = {
-  Only,
-  Ignore,
-  All,
-  MethodSubscription,
-  ISubscriptionTarget,
-  RawAccount,
-  BatchConfig,
-  EmailConfig,
-  MatrixConfig,
-  FsConfig,
-  ConsoleConfig,
-  TelegramConfig,
-  ReportersConfig,
-  ApiSubscription,
-  AppConfig,
+	Only,
+	Ignore,
+	All,
+	MethodSubscription,
+	ISubscriptionTarget,
+	RawAccount,
+	BatchConfig,
+	EmailConfig,
+	MatrixConfig,
+	FsConfig,
+	ConsoleConfig,
+	TelegramConfig,
+	ReportersConfig,
+	ApiSubscription,
+	AppConfig,
 };
 export default exportedTypeSuite;

src/config.ts

@@ -106,6 +106,7 @@ export enum ApiSubscription {
 export interface AppConfig {
 	accounts: RawAccount[];
 	endpoints: string[];
+	startup_notification: boolean;
 	method_subscription: MethodSubscription;
 	api_subscription: ApiSubscription;
 	reporters: ReportersConfig;

src/index.ts

@@ -9,7 +9,8 @@ import {
 	Reporter,
 	NotificationReportType,
 	EventInner,
-	ExtrinsicInner
+	ExtrinsicInner,
+	MiscReport
 } from './reporters';
 import { ApiSubscription, AppConfig, ConfigBuilder, MethodSubscription } from './config';
 import {
@@ -218,7 +219,7 @@ async function listAllChains(config: AppConfig, reporters: Reporter[]) {
 }
 
 async function main() {
-	const { config, reporters } = new ConfigBuilder();
+	const { config, reporters, configName } = new ConfigBuilder();
 
 	const graceful = () => {
 		// if they are batch reporters, clean them.
@@ -242,6 +243,18 @@ async function main() {
 	const retry = true;
 	while (retry) {
 		try {
+			if (config.startup_notification) {
+				// send a startup notification
+				const report: MiscReport = {
+					time: new Date(),
+					message: `program ${configName} restarted`,
+					_type: 'misc'
+				};
+				reporters.forEach(async (r) => {
+					await r.report(report);
+				});
+			}
+
 			await listAllChains(config, reporters);
 		} catch (e) {
 			// if they are batch reporters, clean them.