@polygonlabs/servercore 1.0.0-dev.2 → 1.0.0-dev.4

package/dist/consumers/abstract_event_consumer.d.ts

@@ -0,0 +1,33 @@
+import { ConsumerError } from '../errors/consumer_errors.js';
+import { EventEmitter } from 'events';
+import '../errors/base_error.js';
+
+declare class AbstractEventConsumer extends EventEmitter {
+    /**
+     * @public
+     *
+     * Method to register listener for events. The Abstract Event Consumer emits fatalError
+     * event.
+     *
+     * @param {"fatalError"} eventName - Event name to register listener for.
+     * @param listener - Listener to be called when emitting the event.
+     *
+     * @returns {this} - Returns an instance of the class.
+     */
+    on(eventName: "fatalError", listener: (error: Error | ConsumerError) => void): this;
+    /**
+     * @public
+     *
+     * Method to register listener for events that will be called only once. The Abstract Event Consumer emits fatalError
+     * event.
+     *
+     * @param {"fatalError"} eventName - Event name to register listener for.
+     * @param listener - Listener to be called when emitting the event.
+     *
+     * @returns {this} - Returns an instance of the class.
+     */
+    once(eventName: "fatalError", listener: (error: Error | ConsumerError) => void): this;
+    protected onFatalError(error: Error | ConsumerError): void;
+}
+
+export { AbstractEventConsumer };

package/dist/consumers/abstract_event_consumer.js

@@ -0,0 +1,38 @@
+import { EventEmitter } from "events";
+class AbstractEventConsumer extends EventEmitter {
+  /**
+   * @public
+   *
+   * Method to register listener for events. The Abstract Event Consumer emits fatalError
+   * event.
+   *
+   * @param {"fatalError"} eventName - Event name to register listener for.
+   * @param listener - Listener to be called when emitting the event.
+   *
+   * @returns {this} - Returns an instance of the class.
+   */
+  on(eventName, listener) {
+    return super.on(eventName, listener);
+  }
+  /**
+   * @public
+   *
+   * Method to register listener for events that will be called only once. The Abstract Event Consumer emits fatalError
+   * event.
+   *
+   * @param {"fatalError"} eventName - Event name to register listener for.
+   * @param listener - Listener to be called when emitting the event.
+   *
+   * @returns {this} - Returns an instance of the class.
+   */
+  once(eventName, listener) {
+    return super.on(eventName, listener);
+  }
+  onFatalError(error) {
+    this.emit("fatalError", error);
+  }
+}
+export {
+  AbstractEventConsumer
+};
+//# sourceMappingURL=abstract_event_consumer.js.map

package/dist/consumers/abstract_event_consumer.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/consumers/abstract_event_consumer.ts"],"sourcesContent":["import type { ConsumerError } from \"../errors\";\nimport { EventEmitter } from \"events\";\n\nexport class AbstractEventConsumer extends EventEmitter {\n    /**\n     * @public\n     *\n     * Method to register listener for events. The Abstract Event Consumer emits fatalError\n     * event.\n     *\n     * @param {\"fatalError\"} eventName - Event name to register listener for.\n     * @param listener - Listener to be called when emitting the event.\n     *\n     * @returns {this} - Returns an instance of the class.\n     */\n    on(\n        eventName: \"fatalError\",\n        listener: (error: Error | ConsumerError) => void\n    ): this {\n        return super.on(eventName, listener);\n    }\n    /**\n     * @public\n     *\n     * Method to register listener for events that will be called only once. The Abstract Event Consumer emits fatalError\n     * event.\n     *\n     * @param {\"fatalError\"} eventName - Event name to register listener for.\n     * @param listener - Listener to be called when emitting the event.\n     *\n     * @returns {this} - Returns an instance of the class.\n     */\n    once(\n        eventName: \"fatalError\",\n        listener: (error: Error | ConsumerError) => void\n    ): this {\n        return super.on(eventName, listener);\n    }\n\n    protected onFatalError(error: Error | ConsumerError): void {\n        this.emit(\"fatalError\", error);\n    }\n}\n"],"mappings":"AACA,SAAS,oBAAoB;AAEtB,MAAM,8BAA8B,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYpD,GACI,WACA,UACI;AACJ,WAAO,MAAM,GAAG,WAAW,QAAQ;AAAA,EACvC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,KACI,WACA,UACI;AACJ,WAAO,MAAM,GAAG,WAAW,QAAQ;AAAA,EACvC;AAAA,EAEU,aAAa,OAAoC;AACvD,SAAK,KAAK,cAAc,KAAK;AAAA,EACjC;AACJ;","names":[]}

package/dist/consumers/event_consumer.d.ts

@@ -0,0 +1,24 @@
+import { PublicClient } from 'viem';
+import { ConsumerError } from '../errors/consumer_errors.js';
+import { IObserver } from '../types/observer.js';
+import { IEventConsumerConfig } from '../types/event_consumer_config.js';
+import { AbstractEventConsumer } from './abstract_event_consumer.js';
+import '../errors/base_error.js';
+import 'events';
+
+declare class EventConsumer<T, U> extends AbstractEventConsumer {
+    private config;
+    private consumerRunning;
+    protected client: PublicClient | null;
+    protected observer: IObserver<object, ConsumerError, object> | null;
+    constructor(config: IEventConsumerConfig);
+    start(observer: IObserver<T, ConsumerError, U>): Promise<void>;
+    /**
+     * Private method which updates the connection status of consumer to disconnected, and removes all listeners.
+     *
+     * @returns {void}
+     */
+    private onDisconnect;
+}
+
+export { EventConsumer };

package/dist/consumers/event_consumer.js

@@ -0,0 +1,78 @@
+import { createPublicClient, http } from "viem";
+import { ConsumerError, ExternalDependencyError } from "../errors";
+import { AbstractEventConsumer } from "./abstract_event_consumer";
+import { errorCodes } from "../constants";
+class EventConsumer extends AbstractEventConsumer {
+  constructor(config) {
+    super();
+    this.config = config;
+    this.client = createPublicClient({
+      chain: {
+        id: this.config.chainId,
+        name: "custom",
+        rpcUrls: { default: { http: [this.config.rpcUrl] } },
+        nativeCurrency: this.config.nativeCurrency
+      },
+      transport: http(this.config.rpcUrl)
+    });
+  }
+  consumerRunning = false;
+  client = null;
+  observer = null;
+  async start(observer) {
+    try {
+      this.client?.watchContractEvent({
+        address: this.config.contractAddress,
+        abi: this.config.abi,
+        eventName: this.config.eventName,
+        fromBlock: this.config.startBlock,
+        onLogs: (logs) => {
+          const transformedLogs = logs;
+          observer.next(transformedLogs);
+        },
+        onError: (error) => {
+          this.onDisconnect();
+          this.onFatalError(
+            new ConsumerError(error.name, {
+              name: "CONSUMER_ERROR",
+              code: 1001,
+              isFatal: true,
+              origin: "EventConsumer",
+              context: { eventName: this.config.eventName }
+            })
+          );
+        }
+      });
+    } catch (error) {
+      this.onDisconnect();
+      this.onFatalError(
+        new ExternalDependencyError(
+          this.config.rpcUrl,
+          "Failed to start the event consumer",
+          {
+            externalCode: errorCodes.external.UNKNOWN_EXTERNAL_DEPENDENCY_ERROR,
+            rawError: error,
+            origin: "EventConsumer",
+            context: { eventName: this.config.eventName }
+          }
+        )
+      );
+    }
+  }
+  /**
+   * Private method which updates the connection status of consumer to disconnected, and removes all listeners.
+   *
+   * @returns {void}
+   */
+  onDisconnect() {
+    if (this.consumerRunning) {
+      this.consumerRunning = false;
+      this.observer?.closed();
+      this.removeAllListeners();
+    }
+  }
+}
+export {
+  EventConsumer
+};
+//# sourceMappingURL=event_consumer.js.map

package/dist/consumers/event_consumer.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/consumers/event_consumer.ts"],"sourcesContent":["import { createPublicClient, http, type PublicClient } from \"viem\";\nimport { ConsumerError, ExternalDependencyError } from \"../errors\";\nimport type { IEventConsumerConfig, IObserver } from \"../types\";\nimport { AbstractEventConsumer } from \"./abstract_event_consumer\";\nimport { errorCodes } from \"../constants\";\n\nexport class EventConsumer<T, U> extends AbstractEventConsumer {\n    private consumerRunning: boolean = false;\n    protected client: PublicClient | null = null;\n    protected observer: IObserver<object, ConsumerError, object> | null = null;\n\n    constructor(private config: IEventConsumerConfig) {\n        super();\n        this.client = createPublicClient({\n            chain: {\n                id: this.config.chainId,\n                name: \"custom\",\n                rpcUrls: { default: { http: [this.config.rpcUrl] } },\n                nativeCurrency: this.config.nativeCurrency,\n            },\n            transport: http(this.config.rpcUrl),\n        });\n    }\n\n    public async start(\n        observer: IObserver<T, ConsumerError, U>\n    ): Promise<void> {\n        try {\n            this.client?.watchContractEvent({\n                address: this.config.contractAddress,\n                abi: this.config.abi,\n                eventName: this.config.eventName,\n                fromBlock: this.config.startBlock,\n                onLogs: (logs) => {\n                    const transformedLogs = logs as T;\n                    observer.next(transformedLogs);\n                },\n                onError: (error) => {\n                    this.onDisconnect();\n                    this.onFatalError(\n                        new ConsumerError(error.name, {\n                            name: \"CONSUMER_ERROR\",\n                            code: 1001,\n                            isFatal: true,\n                            origin: \"EventConsumer\",\n                            context: { eventName: this.config.eventName },\n                        })\n                    );\n                },\n            });\n        } catch (error) {\n            this.onDisconnect();\n            this.onFatalError(\n                new ExternalDependencyError(\n                    this.config.rpcUrl,\n                    \"Failed to start the event consumer\",\n                    {\n                        externalCode:\n                            errorCodes.external\n                                .UNKNOWN_EXTERNAL_DEPENDENCY_ERROR,\n                        rawError: error as Error,\n                        origin: \"EventConsumer\",\n                        context: { eventName: this.config.eventName },\n                    }\n                )\n            );\n        }\n    }\n\n    /**\n     * Private method which updates the connection status of consumer to disconnected, and removes all listeners.\n     *\n     * @returns {void}\n     */\n    private onDisconnect(): void {\n        if (this.consumerRunning) {\n            this.consumerRunning = false;\n            this.observer?.closed();\n            this.removeAllListeners();\n        }\n    }\n}\n"],"mappings":"AAAA,SAAS,oBAAoB,YAA+B;AAC5D,SAAS,eAAe,+BAA+B;AAEvD,SAAS,6BAA6B;AACtC,SAAS,kBAAkB;AAEpB,MAAM,sBAA4B,sBAAsB;AAAA,EAK3D,YAAoB,QAA8B;AAC9C,UAAM;AADU;AAEhB,SAAK,SAAS,mBAAmB;AAAA,MAC7B,OAAO;AAAA,QACH,IAAI,KAAK,OAAO;AAAA,QAChB,MAAM;AAAA,QACN,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,KAAK,OAAO,MAAM,EAAE,EAAE;AAAA,QACnD,gBAAgB,KAAK,OAAO;AAAA,MAChC;AAAA,MACA,WAAW,KAAK,KAAK,OAAO,MAAM;AAAA,IACtC,CAAC;AAAA,EACL;AAAA,EAfQ,kBAA2B;AAAA,EACzB,SAA8B;AAAA,EAC9B,WAA4D;AAAA,EAetE,MAAa,MACT,UACa;AACb,QAAI;AACA,WAAK,QAAQ,mBAAmB;AAAA,QAC5B,SAAS,KAAK,OAAO;AAAA,QACrB,KAAK,KAAK,OAAO;AAAA,QACjB,WAAW,KAAK,OAAO;AAAA,QACvB,WAAW,KAAK,OAAO;AAAA,QACvB,QAAQ,CAAC,SAAS;AACd,gBAAM,kBAAkB;AACxB,mBAAS,KAAK,eAAe;AAAA,QACjC;AAAA,QACA,SAAS,CAAC,UAAU;AAChB,eAAK,aAAa;AAClB,eAAK;AAAA,YACD,IAAI,cAAc,MAAM,MAAM;AAAA,cAC1B,MAAM;AAAA,cACN,MAAM;AAAA,cACN,SAAS;AAAA,cACT,QAAQ;AAAA,cACR,SAAS,EAAE,WAAW,KAAK,OAAO,UAAU;AAAA,YAChD,CAAC;AAAA,UACL;AAAA,QACJ;AAAA,MACJ,CAAC;AAAA,IACL,SAAS,OAAO;AACZ,WAAK,aAAa;AAClB,WAAK;AAAA,QACD,IAAI;AAAA,UACA,KAAK,OAAO;AAAA,UACZ;AAAA,UACA;AAAA,YACI,cACI,WAAW,SACN;AAAA,YACT,UAAU;AAAA,YACV,QAAQ;AAAA,YACR,SAAS,EAAE,WAAW,KAAK,OAAO,UAAU;AAAA,UAChD;AAAA,QACJ;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,eAAqB;AACzB,QAAI,KAAK,iBAAiB;AACtB,WAAK,kBAAkB;AACvB,WAAK,UAAU,OAAO;AACtB,WAAK,mBAAmB;AAAA,IAC5B;AAAA,EACJ;AACJ;","names":[]}

package/dist/consumers/index.d.ts

@@ -0,0 +1,8 @@
+export { EventConsumer } from './event_consumer.js';
+import 'viem';
+import '../errors/consumer_errors.js';
+import '../errors/base_error.js';
+import '../types/observer.js';
+import '../types/event_consumer_config.js';
+import './abstract_event_consumer.js';
+import 'events';

package/dist/consumers/index.js

@@ -0,0 +1,2 @@
+export * from "./event_consumer";
+//# sourceMappingURL=index.js.map

package/dist/consumers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/consumers/index.ts"],"sourcesContent":["export * from \"./event_consumer\";\n"],"mappings":"AAAA,cAAc;","names":[]}

package/dist/index.d.ts

@@ -5,11 +5,17 @@ export { errorCodes } from './constants/error_codes.js';
 export { httpResposneCodes } from './constants/http_success_codes.js';
 export { ILoggerConfig } from './types/logger_config.js';
 export { IDocumentConditionalModifications, IQueryFilterOperationParams, IQueryOrderOperationParams, OrderByDirection, WhereFilterOp } from './types/database.js';
+export { IObserver } from './types/observer.js';
+export { ChainNativeCurrency, IEventConsumerConfig } from './types/event_consumer_config.js';
 export { ApiError, BadRequestError, ForbiddenError, NotFoundError, RateLimitError, TimeoutError, UnauthorizedError } from './errors/api_errors.js';
 export { DatabaseError } from './errors/database_errors.js';
 export { ExternalDependencyError } from './errors/external_dependency_error.js';
 export { BaseError } from './errors/base_error.js';
 export { ConsumerError } from './errors/consumer_errors.js';
 export { Database } from './database/db_interface.js';
+export { EventConsumer } from './consumers/event_consumer.js';
 import 'zod';
 import 'winston';
+import 'viem';
+import './consumers/abstract_event_consumer.js';
+import 'events';

package/dist/index.js

@@ -4,4 +4,5 @@ export * from "./constants";
 export * from "./types";
 export * from "./errors";
 export * from "./database";
+export * from "./consumers";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export * from \"./api\";\nexport * from \"./logger\";\nexport * from \"./constants\";\nexport * from \"./types\";\nexport * from \"./errors\";\nexport * from \"./database\";\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export * from \"./api\";\nexport * from \"./logger\";\nexport * from \"./constants\";\nexport * from \"./types\";\nexport * from \"./errors\";\nexport * from \"./database\";\nexport * from \"./consumers\";\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}

package/dist/types/event_consumer_config.d.ts

@@ -0,0 +1,18 @@
+import { Abi } from 'viem';
+
+type ChainNativeCurrency = {
+    name: string;
+    symbol: string;
+    decimals: number;
+};
+interface IEventConsumerConfig {
+    contractAddress: `0x${string}`;
+    eventName: string;
+    abi: Abi;
+    chainId: number;
+    rpcUrl: string;
+    nativeCurrency: ChainNativeCurrency;
+    startBlock: bigint;
+}
+
+export type { ChainNativeCurrency, IEventConsumerConfig };

package/dist/types/event_consumer_config.js

@@ -0,0 +1 @@
+//# sourceMappingURL=event_consumer_config.js.map

package/dist/types/event_consumer_config.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types/index.d.ts

@@ -1,3 +1,6 @@
 export { ILoggerConfig } from './logger_config.js';
 export { IDocumentConditionalModifications, IQueryFilterOperationParams, IQueryOrderOperationParams, OrderByDirection, WhereFilterOp } from './database.js';
+export { IObserver } from './observer.js';
+export { ChainNativeCurrency, IEventConsumerConfig } from './event_consumer_config.js';
 import 'winston';
+import 'viem';

package/dist/types/index.js

@@ -1,3 +1,5 @@
 export * from "./logger_config";
 export * from "./database";
+export * from "./observer";
+export * from "./event_consumer_config";
 //# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/index.ts"],"sourcesContent":["export * from \"./logger_config\";\nexport * from \"./database\";\n"],"mappings":"AAAA,cAAc;AACd,cAAc;","names":[]}
+{"version":3,"sources":["../../src/types/index.ts"],"sourcesContent":["export * from \"./logger_config\";\nexport * from \"./database\";\nexport * from \"./observer\";\nexport * from \"./event_consumer_config\";\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}

package/dist/types/observer.d.ts

@@ -0,0 +1,8 @@
+interface IObserver<T, E, U> {
+    next: (value: T) => Promise<void> | void;
+    summary: (value: U) => Promise<void> | void;
+    error: (value: E) => void;
+    closed: () => void;
+}
+
+export type { IObserver };

package/dist/types/observer.js

@@ -0,0 +1 @@
+//# sourceMappingURL=observer.js.map

package/dist/types/observer.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@polygonlabs/servercore",
-    "version": "1.0.0-dev.2",
+    "version": "1.0.0-dev.4",
     "publishConfig": {
         "access": "public"
     },
@@ -37,6 +37,7 @@
         "typescript": "^5"
     },
     "dependencies": {
+        "viem": "^2.26.3",
         "winston": "^3.17.0",
         "winston-transport-sentry-node": "^3.0.0",
         "zod": "^3.24.2"