@axxel/event-bus 1.0.4 → 1.0.6

package/README.md

@@ -40,7 +40,12 @@ KAFKA_BROKER="localhost:9092"
 ### 1️⃣ Producing messages
 
 ```ts
-import { produceTokenPrice, produceWalletTransaction } from '@axxel/event-bus';
+import {
+  produceTokenPrice,
+  produceWalletTransaction,
+  ensureTokenPriceEvent,
+  ensureWalletTransactionEvent,
+} from '@axxel/event-bus';
 
 await produceTokenPrice({
   chainId: 1,
@@ -49,7 +54,8 @@ await produceTokenPrice({
   price: {
     USD: { price: 3250.42, exchange: 'uniswap-v3', liquidity: 1250000 },
   },
-  marketcap: 1234567890,
+  priceInUsd: 3250.42,
+  fdvInUsd: 1234567890,
   symbol: 'WETH',
   updatedAt: Math.floor(Date.now() / 1000),
 });
@@ -71,6 +77,19 @@ await produceWalletTransaction({
   marketcap: 500000000,
   totalSupply: 1000000,
 });
+
+// Optional: validate and normalize before producing
+const safePricePayload = ensureTokenPriceEvent({
+  chainId: 1,
+  tokenAddress: '0xC02a...',
+  blockNumber: 21345678,
+  price: new Map([
+    ['USD', { price: 3250.42, exchange: 'uniswap-v3', liquidity: 1250000 }],
+  ]),
+  priceInUsd: 3250.42,
+  fdvInUsd: 1234567890,
+});
+await produceTokenPrice(safePricePayload);
 ```
 
 ---
@@ -126,7 +145,8 @@ interface TokenPriceEvent {
   tokenAddress: string;
   blockNumber: number;
   price: Record<string, PriceInfo> | Map<string, PriceInfo>;
-  marketcap?: number | null;
+  priceInUsd?: number | null;
+  fdvInUsd?: number | null;
   symbol?: string | null;
   updatedAt?: number;
 }
@@ -154,6 +174,19 @@ interface WalletTransactionEvent {
 }
 ```
 
+### Runtime validation helpers
+
+Shared Zod schemas are exported to normalize inputs consistently:
+
+```ts
+import { ensureTokenPriceEvent, ensureWalletTransactionEvent } from '@axxel/event-bus';
+
+const normalizedPrice = ensureTokenPriceEvent(rawPricePayload);
+const normalizedTx = ensureWalletTransactionEvent(rawTxPayload);
+```
+
+`ensureTokenPriceEvent` accepts either a `Record` or `Map` for `price`, and both helpers lowercase EVM addresses / tx hashes while rejecting malformed numeric fields.
+
 ---
 
 ## ⚙️ Environment Variables

package/dist/consumers/index.d.ts

@@ -1,3 +1,4 @@
 export * from './tokenPriceConsumer';
 export * from './walletTransactionConsumer';
+export * from './tradeExecutionConsumer';
 //# sourceMappingURL=index.d.ts.map

package/dist/consumers/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/consumers/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,6BAA6B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/consumers/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC"}

package/dist/consumers/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./tokenPriceConsumer"), exports);
 __exportStar(require("./walletTransactionConsumer"), exports);
+__exportStar(require("./tradeExecutionConsumer"), exports);

package/dist/consumers/tradeExecutionConsumer.d.ts

@@ -0,0 +1,8 @@
+import type { TradeExecutionEvent } from '../types/TradeExecutionEvent';
+/**
+ * Start consuming trade execution events.
+ * @param groupId - unique consumer group ID
+ * @param handler - function to handle each trade execution event
+ */
+export declare function startTradeExecutionConsumer(groupId: string, handler: (event: TradeExecutionEvent) => Promise<void> | void): Promise<void>;
+//# sourceMappingURL=tradeExecutionConsumer.d.ts.map

package/dist/consumers/tradeExecutionConsumer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tradeExecutionConsumer.d.ts","sourceRoot":"","sources":["../../src/consumers/tradeExecutionConsumer.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAExE;;;;GAIG;AACH,wBAAsB,2BAA2B,CAC/C,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,iBAqB9D"}

package/dist/consumers/tradeExecutionConsumer.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startTradeExecutionConsumer = startTradeExecutionConsumer;
+const kafka_1 = require("../config/kafka");
+const topics_1 = require("../topics");
+/**
+ * Start consuming trade execution events.
+ * @param groupId - unique consumer group ID
+ * @param handler - function to handle each trade execution event
+ */
+async function startTradeExecutionConsumer(groupId, handler) {
+    const consumer = kafka_1.kafka.consumer({ groupId });
+    await consumer.connect();
+    await consumer.subscribe({
+        topic: topics_1.TOPICS.TRADE_EXECUTION,
+        fromBeginning: false,
+    });
+    await consumer.run({
+        eachMessage: async ({ message }) => {
+            if (!message.value)
+                return;
+            const event = JSON.parse(message.value.toString());
+            await handler(event);
+        },
+    });
+    console.log(`📡 Listening for trade execution events (consumer group: ${groupId})`);
+}

package/dist/index.d.ts

@@ -5,6 +5,8 @@ export * from './validation/tokenPriceEvent.schema';
 export * from './validation/walletTransactionEvent.schema';
 export * from './producers/tokenPriceProducer';
 export * from './producers/walletTransactionProducer';
+export * from './producers/tradeExecutionProducer';
 export * from './consumers/tokenPriceConsumer';
 export * from './consumers/walletTransactionConsumer';
+export * from './consumers/tradeExecutionConsumer';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uCAAuC,CAAC;AAEtD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uCAAuC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uCAAuC,CAAC;AACtD,cAAc,oCAAoC,CAAC;AAEnD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uCAAuC,CAAC;AACtD,cAAc,oCAAoC,CAAC"}

package/dist/index.js

@@ -21,5 +21,7 @@ __exportStar(require("./validation/tokenPriceEvent.schema"), exports);
 __exportStar(require("./validation/walletTransactionEvent.schema"), exports);
 __exportStar(require("./producers/tokenPriceProducer"), exports);
 __exportStar(require("./producers/walletTransactionProducer"), exports);
+__exportStar(require("./producers/tradeExecutionProducer"), exports);
 __exportStar(require("./consumers/tokenPriceConsumer"), exports);
 __exportStar(require("./consumers/walletTransactionConsumer"), exports);
+__exportStar(require("./consumers/tradeExecutionConsumer"), exports);

package/dist/producers/index.d.ts

@@ -1,3 +1,4 @@
 export * from './tokenPriceProducer';
 export * from './walletTransactionProducer';
+export * from './tradeExecutionProducer';
 //# sourceMappingURL=index.d.ts.map

package/dist/producers/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/producers/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,6BAA6B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/producers/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC"}

package/dist/producers/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./tokenPriceProducer"), exports);
 __exportStar(require("./walletTransactionProducer"), exports);
+__exportStar(require("./tradeExecutionProducer"), exports);

package/dist/producers/tradeExecutionProducer.d.ts

@@ -0,0 +1,3 @@
+import type { TradeExecutionEvent } from '../types/TradeExecutionEvent';
+export declare function produceTradeExecution(event: TradeExecutionEvent): Promise<void>;
+//# sourceMappingURL=tradeExecutionProducer.d.ts.map

package/dist/producers/tradeExecutionProducer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tradeExecutionProducer.d.ts","sourceRoot":"","sources":["../../src/producers/tradeExecutionProducer.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAExE,wBAAsB,qBAAqB,CAAC,KAAK,EAAE,mBAAmB,iBAqBrE"}

package/dist/producers/tradeExecutionProducer.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.produceTradeExecution = produceTradeExecution;
+const kafka_1 = require("../config/kafka");
+const topics_1 = require("../topics");
+async function produceTradeExecution(event) {
+    const producer = kafka_1.kafka.producer();
+    await producer.connect();
+    const key = `${event.chainId}:${event.walletAddress}`;
+    await producer.send({
+        topic: topics_1.TOPICS.TRADE_EXECUTION,
+        messages: [
+            {
+                key,
+                value: JSON.stringify(event),
+            },
+        ],
+    });
+    await producer.disconnect();
+    console.log(`✅ Execution event added for wallet=${event.walletAddress} on chain=${event.chainId} for ${event.orderType} order of type (${event.type} )`);
+}

package/dist/topics.d.ts

@@ -1,6 +1,7 @@
 export declare const TOPICS: {
     readonly TOKEN_PRICES: "token-prices";
     readonly WALLET_TRANSACTIONS: "wallet-transactions";
+    readonly TRADE_EXECUTION: "trade-execution";
 };
 export type Topic = (typeof TOPICS)[keyof typeof TOPICS];
 //# sourceMappingURL=topics.d.ts.map

package/dist/topics.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"topics.d.ts","sourceRoot":"","sources":["../src/topics.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM;;;CAGT,CAAC;AAEX,MAAM,MAAM,KAAK,GAAG,CAAC,OAAO,MAAM,CAAC,CAAC,MAAM,OAAO,MAAM,CAAC,CAAC"}
+{"version":3,"file":"topics.d.ts","sourceRoot":"","sources":["../src/topics.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM;;;;CAIT,CAAC;AAEX,MAAM,MAAM,KAAK,GAAG,CAAC,OAAO,MAAM,CAAC,CAAC,MAAM,OAAO,MAAM,CAAC,CAAC"}

package/dist/topics.js

@@ -4,4 +4,5 @@ exports.TOPICS = void 0;
 exports.TOPICS = {
     TOKEN_PRICES: 'token-prices',
     WALLET_TRANSACTIONS: 'wallet-transactions',
+    TRADE_EXECUTION: 'trade-execution',
 };

package/dist/types/TokenPriceEvent.d.ts

@@ -8,7 +8,8 @@ export interface TokenPriceEvent {
     tokenAddress: string;
     blockNumber: number;
     price: Record<string, PriceInfo> | Map<string, PriceInfo>;
-    marketcap?: number | null;
+    priceInUsd?: number | null;
+    fdvInUsd?: number | null;
     symbol?: string | null;
     updatedAt?: number;
 }

package/dist/types/TokenPriceEvent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TokenPriceEvent.d.ts","sourceRoot":"","sources":["../../src/types/TokenPriceEvent.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IAEpB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC1D,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}
+{"version":3,"file":"TokenPriceEvent.d.ts","sourceRoot":"","sources":["../../src/types/TokenPriceEvent.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IAEpB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC1D,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/dist/types/TradeExecutionEvent.d.ts

@@ -0,0 +1,15 @@
+export type TradeExecutionEvent = {
+    orderId: string;
+    userId: string;
+    chainId: number;
+    tokenAddress: string;
+    walletAddress: string;
+    amount: string;
+    slippage: string;
+    mev: boolean;
+    totalFee: string;
+    type: string;
+    executionPriceUsd: string;
+    orderType: 'limit' | 'trailing';
+};
+//# sourceMappingURL=TradeExecutionEvent.d.ts.map

package/dist/types/TradeExecutionEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TradeExecutionEvent.d.ts","sourceRoot":"","sources":["../../src/types/TradeExecutionEvent.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,OAAO,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB,EAAE,MAAM,CAAC;IAC1B,SAAS,EAAE,OAAO,GAAG,UAAU,CAAC;CACjC,CAAC"}

package/dist/types/TradeExecutionEvent.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from './TokenPriceEvent';
 export * from './WalletTransactionEvent';
+export * from './TradeExecutionEvent';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC"}

package/dist/types/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./TokenPriceEvent"), exports);
 __exportStar(require("./WalletTransactionEvent"), exports);
+__exportStar(require("./TradeExecutionEvent"), exports);

package/dist/validation/tokenPriceEvent.schema.d.ts

@@ -8,7 +8,8 @@ export declare const tokenPriceEventSchema: z.ZodObject<{
         exchange: z.ZodString;
         liquidity: z.ZodNumber;
     }, z.core.$strip>>>>;
-    marketcap: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    priceInUsd: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    fdvInUsd: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     symbol: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     updatedAt: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;

package/dist/validation/tokenPriceEvent.schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tokenPriceEvent.schema.d.ts","sourceRoot":"","sources":["../../src/validation/tokenPriceEvent.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAuCxB,eAAO,MAAM,qBAAqB;;;;;;;;;;;;iBAQhC,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAE1E,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,qBAAqB,CAE3E"}
+{"version":3,"file":"tokenPriceEvent.schema.d.ts","sourceRoot":"","sources":["../../src/validation/tokenPriceEvent.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAiDxB,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;iBAShC,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAE1E,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,qBAAqB,CAE3E"}

package/dist/validation/tokenPriceEvent.schema.js

@@ -5,9 +5,9 @@ exports.ensureTokenPriceEvent = ensureTokenPriceEvent;
 const zod_1 = require("zod");
 const common_1 = require("./common");
 const priceEntrySchema = zod_1.z.object({
-    price: zod_1.z.number().finite(),
+    price: zod_1.z.number(),
     exchange: zod_1.z.string().min(1),
-    liquidity: zod_1.z.number().finite(),
+    liquidity: zod_1.z.number(),
 });
 const priceRecordSchema = zod_1.z.preprocess((value) => {
     if (value instanceof Map) {
@@ -16,7 +16,11 @@ const priceRecordSchema = zod_1.z.preprocess((value) => {
             if (typeof key !== 'string') {
                 throw new Error(`Invalid price key type: expected string, got ${typeof key}`);
             }
-            if (typeof entry === 'object' && entry !== null && 'price' in entry && 'exchange' in entry && 'liquidity' in entry) {
+            if (typeof entry === 'object' &&
+                entry !== null &&
+                'price' in entry &&
+                'exchange' in entry &&
+                'liquidity' in entry) {
                 normalized[key] = {
                     price: Number(entry.price),
                     exchange: String(entry.exchange),
@@ -38,7 +42,8 @@ exports.tokenPriceEventSchema = zod_1.z.object({
     tokenAddress: common_1.addressSchema,
     blockNumber: zod_1.z.number().int().min(0),
     price: priceRecordSchema,
-    marketcap: zod_1.z.number().nullable().optional(),
+    priceInUsd: zod_1.z.number().nullable().optional(),
+    fdvInUsd: zod_1.z.number().nullable().optional(),
     symbol: zod_1.z.string().nullable().optional(),
     updatedAt: zod_1.z.number().int().min(0).optional(),
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axxel/event-bus",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Axxel Kafka Event Bus SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",