@glowlabs-org/events-sdk 1.0.5 → 1.0.7

package/README.md

@@ -54,13 +54,14 @@ Both `createGlowEventListener` and `createGlowEventEmitter` accept the following
 
 Currently supported event types and versions:
 
-| Event Name            | Version | Payload Type                  | Description                            |
-| --------------------- | ------- | ----------------------------- | -------------------------------------- |
-| `audit.pushed`        | "v1"    | `AuditPushedV1Payload`        | Emitted when an audit is pushed        |
-| `audit.slashed`       | "v1"    | `AuditSlashedV1Payload`       | Emitted when a farm is slashed         |
-| `audit.pfees.paid`    | "v1"    | `AuditPfeesPaidV1Payload`     | Paid (by applicationId)                |
-| `audit.pfees.paid`    | "v2"    | `AuditPfeesPaidV2Payload`     | Paid (by farmId)                       |
-| `application.created` | "v1"    | `ApplicationCreatedV1Payload` | Emitted when an application is created |
+| Event Name            | Version | Payload Type                  | Description                                         |
+| --------------------- | ------- | ----------------------------- | --------------------------------------------------- |
+| `audit.pushed`        | "v1"    | `AuditPushedV1Payload`        | Emitted when an audit is pushed                     |
+| `audit.slashed`       | "v1"    | `AuditSlashedV1Payload`       | Emitted when a farm is slashed                      |
+| `audit.pfees.paid`    | "v1"    | `AuditPfeesPaidV1Payload`     | Paid (by applicationId)                             |
+| `audit.pfees.paid`    | "v2"    | `AuditPfeesPaidV2Payload`     | Paid (by farmId)                                    |
+| `application.created` | "v1"    | `ApplicationCreatedV1Payload` | Emitted when an application is created              |
+| `audit.pushed`        | "v2"    | `AuditPushedV2Payload`        | Emitted when an audit is pushed (farmId is bytes16) |
 
 ---
 
@@ -88,7 +89,7 @@ Use these in your code to avoid hardcoding event names and to benefit from autoc
 
 ```ts
 export interface AuditPushedV1Payload {
-  farmId: string; // bytes32 hex string (0x...)
+  farmId: string; // UUID string
   protocolFeeUSDPrice_12Decimals: string; // uint256 (decimal) − 12 implied decimals
   expectedProduction_12Decimals: string; // uint256 (decimal) − 12 implied decimals
   txHash: string; // bytes32 hex string (0x...)
@@ -97,7 +98,7 @@ export interface AuditPushedV1Payload {
 
 **Validation:**
 
-- `farmId` must be a 32-byte hex string (e.g., `0x...`).
+- `farmId` must be a valid UUID string (e.g., `afbc56b6-0b16-4119-b144-025728067ba6`).
 - `protocolFeeUSDPrice_12Decimals` and `expectedProduction_12Decimals` must be decimal strings representing unsigned big integers.
 - `txHash` must be a 32-byte hex string (e.g., `0x...`).
 
@@ -105,7 +106,7 @@ export interface AuditPushedV1Payload {
 
 ```ts
 export interface AuditSlashedV1Payload {
-  farmId: string; // bytes32 hex string (0x...)
+  farmId: string; // bytes16 hex string (0x...)
   slasher: string; // Ethereum address (0x...)
   txHash: string; // bytes32 hex string (0x...)
 }
@@ -113,7 +114,7 @@ export interface AuditSlashedV1Payload {
 
 **Validation:**
 
-- `farmId` must be a 32-byte hex string (e.g., `0x...`).
+- `farmId` must be a 16-byte hex string (e.g., `0x...`).
 - `slasher` must be a valid Ethereum address (0x...40 hex chars).
 - `txHash` must be a 32-byte hex string (e.g., `0x...`).
 
@@ -121,25 +122,25 @@ export interface AuditSlashedV1Payload {
 
 ```ts
 export interface AuditPfeesPaidV1Payload {
-  applicationId: string; // bytes32 hex string (0x...)
+  applicationId: string; // UUID string
   payer: string; // Ethereum address (0x...)
-  amount_12Decimals: string; // uint256 (decimal) − 12 implied decimals
+  amount_6Decimals: string; // uint256 (decimal) − 6 implied decimals
   txHash: string; // bytes32 hex string (0x...)
 }
 ```
 
 **Validation:**
 
-- `applicationId` must be a 32-byte hex string (e.g., `0x...`).
+- `applicationId` must be a valid UUID string (e.g., `3ed964b1-4f02-475a-9789-fb74b3466c70`).
 - `payer` must be a valid Ethereum address (0x...40 hex chars).
-- `amount_12Decimals` must be a decimal string representing an unsigned big integer (12 implied decimals).
+- `amount_6Decimals` must be a decimal string representing an unsigned big integer (6 implied decimals).
 - `txHash` must be a 32-byte hex string (e.g., `0x...`).
 
 ### `audit.pfees.paid` v2 (by farmId)
 
 ```ts
 export interface AuditPfeesPaidV2Payload {
-  farmId: string; // bytes32 hex string (0x...)
+  farmId: string; // bytes16 hex string (0x...)
   payer: string; // Ethereum address (0x...)
   amount_12Decimals: string; // uint256 (decimal) − 12 implied decimals
   txHash: string; // bytes32 hex string (0x...)
@@ -148,11 +149,28 @@ export interface AuditPfeesPaidV2Payload {
 
 **Validation:**
 
-- `farmId` must be a 32-byte hex string (e.g., `0x...`).
+- `farmId` must be a 16-byte hex string (e.g., `0x...`).
 - `payer` must be a valid Ethereum address (0x...40 hex chars).
 - `amount_12Decimals` must be a decimal string representing an unsigned big integer (12 implied decimals).
 - `txHash` must be a 32-byte hex string (e.g., `0x...`).
 
+### `audit.pushed` v2
+
+```ts
+export interface AuditPushedV2Payload {
+  farmId: string; // bytes16 hex string (0x...)
+  protocolFeeUSDPrice_12Decimals: string; // uint256 (decimal) − 12 implied decimals
+  expectedProduction_12Decimals: string; // uint256 (decimal) − 12 implied decimals
+  txHash: string; // bytes32 hex string (0x...)
+}
+```
+
+**Validation:**
+
+- `farmId` must be a 16-byte hex string (e.g., `0x...`).
+- `protocolFeeUSDPrice_12Decimals` and `expectedProduction_12Decimals` must be decimal strings representing unsigned big integers.
+- `txHash` must be a 32-byte hex string (e.g., `0x...`).
+
 ### `application.created` v1
 
 ```ts
@@ -215,7 +233,7 @@ listener.onEvent("audit.pfees.paid", "v1", (event) => {
     "Received audit.pfees.paid v1:",
     event.payload.applicationId,
     event.payload.payer,
-    event.payload.amount_12Decimals
+    event.payload.amount_6Decimals
   );
 });
 
@@ -264,7 +282,7 @@ await emitter.emit({
   eventType: "audit.pushed",
   schemaVersion: "v1",
   payload: {
-    farmId: "0x...",
+    farmId: "afbc56b6-0b16-4119-b144-025728067ba6", // UUID string
     protocolFeeUSDPrice_12Decimals: "...",
     expectedProduction_12Decimals: "...",
     txHash: "0x...",
@@ -285,9 +303,9 @@ await emitter.emit({
   eventType: "audit.pfees.paid",
   schemaVersion: "v1",
   payload: {
-    applicationId: "0x...",
+    applicationId: "3ed964b1-4f02-475a-9789-fb74b3466c70", // UUID string
     payer: "0x...",
-    amount_12Decimals: "1000000000000",
+    amount_6Decimals: "1000000000000",
     txHash: "0x...",
   },
 });

package/dist/event-registry.js

@@ -8,6 +8,7 @@ const audit_pfees_paid_v2_1 = require("./schemas/audit-pfees-paid.v2");
 const base_event_1 = require("./base-event");
 const application_created_v1_1 = require("./schemas/application-created.v1");
 const event_types_1 = require("./event-types");
+const audit_pushed_v2_1 = require("./schemas/audit-pushed.v2");
 const eventTypeRegistry = {
     [`${event_types_1.eventTypes.auditPushed}:v1`]: base_event_1.baseEventZ.extend({
         payload: audit_pushed_v1_1.auditPushedV1PayloadZ,
@@ -24,6 +25,9 @@ const eventTypeRegistry = {
     [`${event_types_1.eventTypes.applicationCreated}:v1`]: base_event_1.baseEventZ.extend({
         payload: application_created_v1_1.applicationCreatedV1PayloadZ,
     }),
+    [`${event_types_1.eventTypes.auditPushed}:v2`]: base_event_1.baseEventZ.extend({
+        payload: audit_pushed_v2_1.auditPushedV2PayloadZ,
+    }),
     // Add more event types/versions here
 };
 function getEventSchema(eventType, version) {

package/dist/patterns.d.ts

@@ -0,0 +1,5 @@
+export declare const hexBytes32: RegExp;
+export declare const ethAddress: RegExp;
+export declare const uint256: RegExp;
+export declare const exchangeOrQueueNamePattern: RegExp;
+export declare const hexBytes16: RegExp;

package/dist/patterns.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hexBytes16 = exports.exchangeOrQueueNamePattern = exports.uint256 = exports.ethAddress = exports.hexBytes32 = void 0;
+exports.hexBytes32 = /^0x[0-9a-fA-F]{64}$/;
+exports.ethAddress = /^0x[0-9a-fA-F]{40}$/;
+exports.uint256 = /^[0-9]+$/;
+exports.exchangeOrQueueNamePattern = /^[a-zA-Z0-9_-]+(\.[a-zA-Z0-9_-]+)+$/;
+exports.hexBytes16 = /^0x[0-9a-fA-F]{32}$/;

package/dist/schemas/application-created.v1.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.applicationCreatedV1PayloadZ = void 0;
 const zod_1 = require("zod");
-const utils_1 = require("../utils");
+const patterns_1 = require("../patterns");
 exports.applicationCreatedV1PayloadZ = zod_1.z.object({
-    gcaAddress: zod_1.z.string().regex(utils_1.ethAddress), // eth address
+    gcaAddress: zod_1.z.string().regex(patterns_1.ethAddress), // eth address
     lat: zod_1.z.number(),
     lng: zod_1.z.number(),
     estimatedCostOfPowerPerKWh: zod_1.z.number(),

package/dist/schemas/audit-pfees-paid.v1.d.ts

@@ -2,17 +2,17 @@ import { z } from "zod";
 export declare const auditPfeesPaidV1PayloadZ: z.ZodObject<{
     applicationId: z.ZodString;
     payer: z.ZodString;
-    amount_12Decimals: z.ZodString;
+    amount_6Decimals: z.ZodString;
     txHash: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     txHash: string;
     applicationId: string;
     payer: string;
-    amount_12Decimals: string;
+    amount_6Decimals: string;
 }, {
     txHash: string;
     applicationId: string;
     payer: string;
-    amount_12Decimals: string;
+    amount_6Decimals: string;
 }>;
 export type AuditPfeesPaidV1Payload = z.infer<typeof auditPfeesPaidV1PayloadZ>;

package/dist/schemas/audit-pfees-paid.v1.js

@@ -2,12 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.auditPfeesPaidV1PayloadZ = void 0;
 const zod_1 = require("zod");
-const utils_1 = require("../utils");
+const patterns_1 = require("../patterns");
 exports.auditPfeesPaidV1PayloadZ = zod_1.z.object({
-    applicationId: zod_1.z.string().regex(utils_1.hexBytes32, "bytes32 hex string"),
-    payer: zod_1.z.string().regex(utils_1.ethAddress, "Ethereum address"),
-    amount_12Decimals: zod_1.z
+    applicationId: zod_1.z.string().uuid("UUID string"),
+    payer: zod_1.z.string().regex(patterns_1.ethAddress, "Ethereum address"),
+    amount_6Decimals: zod_1.z
         .string()
-        .regex(utils_1.uint256, "uint256 (decimal) − 12 implied decimals"),
-    txHash: zod_1.z.string().regex(utils_1.hexBytes32, "bytes32 hex string"),
+        .regex(patterns_1.uint256, "uint256 (decimal) − 6 implied decimals"),
+    txHash: zod_1.z.string().regex(patterns_1.hexBytes32, "bytes32 hex string"),
 });

package/dist/schemas/audit-pfees-paid.v2.js

@@ -2,12 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.auditPfeesPaidV2PayloadZ = void 0;
 const zod_1 = require("zod");
-const utils_1 = require("../utils");
+const patterns_1 = require("../patterns");
 exports.auditPfeesPaidV2PayloadZ = zod_1.z.object({
-    farmId: zod_1.z.string().regex(utils_1.hexBytes32, "bytes32 hex string"),
-    payer: zod_1.z.string().regex(utils_1.ethAddress, "Ethereum address"),
+    farmId: zod_1.z.string().regex(patterns_1.hexBytes16, "bytes16 hex string"),
+    payer: zod_1.z.string().regex(patterns_1.ethAddress, "Ethereum address"),
     amount_12Decimals: zod_1.z
         .string()
-        .regex(utils_1.uint256, "uint256 (decimal) − 12 implied decimals"),
-    txHash: zod_1.z.string().regex(utils_1.hexBytes32, "bytes32 hex string"),
+        .regex(patterns_1.uint256, "uint256 (decimal) − 12 implied decimals"),
+    txHash: zod_1.z.string().regex(patterns_1.hexBytes32, "bytes32 hex string"),
 });

package/dist/schemas/audit-pushed.v1.js

@@ -2,12 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.auditPushedV1PayloadZ = void 0;
 const zod_1 = require("zod");
-const utils_1 = require("../utils");
+const patterns_1 = require("../patterns");
 exports.auditPushedV1PayloadZ = zod_1.z.object({
-    farmId: zod_1.z.string().regex(utils_1.hexBytes32, "bytes32 hex string"),
+    farmId: zod_1.z.string().uuid(),
     protocolFeeUSDPrice_12Decimals: zod_1.z
         .string()
-        .regex(utils_1.uint256, "uint256 (decimal) − 12 implied decimals"),
-    expectedProduction_12Decimals: zod_1.z.string().regex(utils_1.uint256),
-    txHash: zod_1.z.string().regex(utils_1.hexBytes32, "bytes32 hex string"),
+        .regex(patterns_1.uint256, "uint256 (decimal) − 12 implied decimals"),
+    expectedProduction_12Decimals: zod_1.z.string().regex(patterns_1.uint256),
+    txHash: zod_1.z.string().regex(patterns_1.hexBytes32, "bytes32 hex string"),
 });

package/dist/schemas/audit-pushed.v2.d.ts

@@ -0,0 +1,18 @@
+import { z } from "zod";
+export declare const auditPushedV2PayloadZ: z.ZodObject<{
+    farmId: z.ZodString;
+    protocolFeeUSDPrice_12Decimals: z.ZodString;
+    expectedProduction_12Decimals: z.ZodString;
+    txHash: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    farmId: string;
+    protocolFeeUSDPrice_12Decimals: string;
+    expectedProduction_12Decimals: string;
+    txHash: string;
+}, {
+    farmId: string;
+    protocolFeeUSDPrice_12Decimals: string;
+    expectedProduction_12Decimals: string;
+    txHash: string;
+}>;
+export type AuditPushedV2Payload = z.infer<typeof auditPushedV2PayloadZ>;

package/dist/schemas/audit-pushed.v2.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.auditPushedV2PayloadZ = void 0;
+const zod_1 = require("zod");
+const patterns_1 = require("../patterns");
+exports.auditPushedV2PayloadZ = zod_1.z.object({
+    farmId: zod_1.z.string().regex(patterns_1.hexBytes16, "bytes16 hex string"),
+    protocolFeeUSDPrice_12Decimals: zod_1.z
+        .string()
+        .regex(patterns_1.uint256, "uint256 (decimal) − 12 implied decimals"),
+    expectedProduction_12Decimals: zod_1.z.string().regex(patterns_1.uint256),
+    txHash: zod_1.z.string().regex(patterns_1.hexBytes32, "bytes32 hex string"),
+});

package/dist/schemas/audit-slashed.v1.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.auditSlashedV1PayloadZ = void 0;
 const zod_1 = require("zod");
-const utils_1 = require("../utils");
+const patterns_1 = require("../patterns");
 exports.auditSlashedV1PayloadZ = zod_1.z.object({
-    farmId: zod_1.z.string().regex(utils_1.hexBytes32, "bytes32 hex string"),
-    slasher: zod_1.z.string().regex(utils_1.ethAddress, "Ethereum address"),
-    txHash: zod_1.z.string().regex(utils_1.hexBytes32, "bytes32 hex string"),
+    farmId: zod_1.z.string().regex(patterns_1.hexBytes16, "bytes16 hex string"),
+    slasher: zod_1.z.string().regex(patterns_1.ethAddress, "Ethereum address"),
+    txHash: zod_1.z.string().regex(patterns_1.hexBytes32, "bytes32 hex string"),
 });

package/dist/types.d.ts

@@ -4,12 +4,14 @@ import type { AuditSlashedV1Payload } from "./schemas/audit-slashed.v1";
 import type { AuditPfeesPaidV1Payload } from "./schemas/audit-pfees-paid.v1";
 import type { AuditPfeesPaidV2Payload } from "./schemas/audit-pfees-paid.v2";
 import type { ApplicationCreatedV1Payload } from "./schemas/application-created.v1";
+import type { AuditPushedV2Payload } from "./schemas/audit-pushed.v2";
 import { eventTypes, EventType } from "./event-types";
 export { EventType, eventTypes };
 export type EventVersion = "v1" | "v2";
 export interface EventPayloadMap {
     [eventTypes.auditPushed]: {
         v1: AuditPushedV1Payload;
+        v2: AuditPushedV2Payload;
     };
     [eventTypes.auditSlashed]: {
         v1: AuditSlashedV1Payload;

package/dist/utils.d.ts

@@ -18,10 +18,6 @@ export declare function processEventMessage(msg: {
         routingKey: string;
     };
 }): any;
-export declare const hexBytes32: RegExp;
-export declare const ethAddress: RegExp;
-export declare const uint256: RegExp;
-export declare const exchangeOrQueueNamePattern: RegExp;
 export declare function validateName(name: string, type: "exchange" | "queue"): void;
 export declare function buildAmqpUrl({ username, password, host, }: {
     username: string;

package/dist/utils.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.exchangeOrQueueNamePattern = exports.uint256 = exports.ethAddress = exports.hexBytes32 = void 0;
 exports.validateZoneNameAndId = validateZoneNameAndId;
 exports.validateEventPayload = validateEventPayload;
 exports.processEventMessage = processEventMessage;
@@ -8,6 +7,7 @@ exports.validateName = validateName;
 exports.buildAmqpUrl = buildAmqpUrl;
 const event_registry_1 = require("./event-registry");
 const zones_1 = require("./zones");
+const patterns_1 = require("./patterns");
 /**
  * Validates that the zoneName matches the zoneId using the zoneMap.
  * Throws an error if the values are inconsistent.
@@ -46,12 +46,8 @@ function processEventMessage(msg) {
     validateEventPayload(eventType, schemaVersion, decoded);
     return (0, event_registry_1.getEventSchema)(eventType, schemaVersion).parse(decoded);
 }
-exports.hexBytes32 = /^0x[0-9a-fA-F]{64}$/;
-exports.ethAddress = /^0x[0-9a-fA-F]{40}$/;
-exports.uint256 = /^[0-9]+$/;
-exports.exchangeOrQueueNamePattern = /^[a-zA-Z0-9_-]+(\.[a-zA-Z0-9_-]+)+$/;
 function validateName(name, type) {
-    if (!exports.exchangeOrQueueNamePattern.test(name)) {
+    if (!patterns_1.exchangeOrQueueNamePattern.test(name)) {
         throw new Error(`${type} name '${name}' is invalid. Must be dot-separated (e.g., 'glow.zone-1.events').`);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glowlabs-org/events-sdk",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "Typed event SDK for Glow, powered by RabbitMQ and Zod.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",