@glowlabs-org/events-sdk 1.0.17 → 1.0.19

package/README.md

@@ -72,6 +72,8 @@ Currently supported event types and versions:
 | `fraction.sold`           | "v2-alpha" | `FractionSoldV2AlphaPayload`          | Fraction sold between creator and buyer             |
 | `fraction.closed`         | "v2-alpha" | `FractionClosedV2AlphaPayload`        | Fraction closed/cancelled                           |
 
+> **Environment:** All events include an `environment` field that defaults to `"production"`. You can set it to `"staging"` when creating an emitter.
+
 ---
 
 ### Event Types Enum
@@ -277,26 +279,44 @@ export interface FractionClosedV2AlphaPayload {
 }
 ```
 
-````
-
 **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...`).
+- `fractionId` is a string identifier.
+- `transactionHash` must be a 32-byte hex string.
+- `blockNumber`, `step`, `totalSteps`, and `amount` must be decimal strings representing unsigned big integers.
+- `token`, `owner`, `creator`, and `buyer` must be valid Ethereum addresses.
 
-### `application.created` v1
+---
 
 ```ts
-export interface ApplicationCreatedV1Payload {
-  gcaAddress: string; // Ethereum address (0x...)
-  lat: number;
-  lng: number;
-  estimatedCostOfPowerPerKWh: number;
-  estimatedKWhGeneratedPerYear: number;
-  installerCompanyName: string;
+export interface FractionSoldV2AlphaPayload {
+  fractionId: string;
+  transactionHash: string; // bytes32 hex string (0x...)
+  blockNumber: string; // uint256 (decimal)
+  logIndex: number;
+  creator: string; // Ethereum address (0x...)
+  buyer: string; // Ethereum address (0x...)
+  step: string; // uint256 (decimal)
+  amount: string; // uint256 (decimal)
+  timestamp: number;
 }
-````
+```
+
+### `fraction.closed` v2-alpha
+
+```ts
+export interface FractionClosedV2AlphaPayload {
+  fractionId: string;
+  transactionHash: string; // bytes32 hex string (0x...)
+  blockNumber: string; // uint256 (decimal)
+  logIndex: number;
+  token: string; // Ethereum address (0x...)
+  owner: string; // Ethereum address (0x...)
+  timestamp: number;
+}
+```
+
+---
 
 ### `application.created` v2-alpha
 
@@ -403,6 +423,7 @@ const emitter = createGlowEventEmitter({
   password: "your-password-here",
   zoneId: getZoneId("CleanGridProject"), // must be a specific zone
   host: "my.rabbitmq.host:5672", // Optional: override the default host
+  environment: "staging", // Optional: defaults to "production"
 });
 
 await emitter.emit({

package/dist/base-event.d.ts

@@ -7,6 +7,7 @@ export declare const baseEventZ: z.ZodObject<{
     schemaVersion: z.ZodEnum<["v1", "v2", "v2-alpha"]>;
     eventType: z.ZodEnum<[EventType, ...EventType[]]>;
     timeStamp: z.ZodNumber;
+    environment: z.ZodDefault<z.ZodEnum<["staging", "production"]>>;
 }, "strip", z.ZodTypeAny, {
     id: string;
     zoneId: number;
@@ -14,6 +15,7 @@ export declare const baseEventZ: z.ZodObject<{
     schemaVersion: "v1" | "v2" | "v2-alpha";
     eventType: EventType;
     timeStamp: number;
+    environment: "staging" | "production";
 }, {
     id: string;
     zoneId: number;
@@ -21,6 +23,7 @@ export declare const baseEventZ: z.ZodObject<{
     schemaVersion: "v1" | "v2" | "v2-alpha";
     eventType: EventType;
     timeStamp: number;
+    environment?: "staging" | "production" | undefined;
 }>;
 export interface BaseEventAuditPushedV1 {
     id: string;
@@ -29,6 +32,7 @@ export interface BaseEventAuditPushedV1 {
     schemaVersion: "v1";
     eventType: "audit.pushed";
     timeStamp: number;
+    environment: "staging" | "production";
 }
 export interface BaseEventAuditSlashedV1 {
     id: string;
@@ -37,6 +41,7 @@ export interface BaseEventAuditSlashedV1 {
     schemaVersion: "v1";
     eventType: "audit.slashed";
     timeStamp: number;
+    environment: "staging" | "production";
 }
 export interface BaseEventAuditPfeesPaidV1 {
     id: string;
@@ -45,6 +50,7 @@ export interface BaseEventAuditPfeesPaidV1 {
     schemaVersion: "v1";
     eventType: "audit.pfees.paid";
     timeStamp: number;
+    environment: "staging" | "production";
 }
 export interface BaseEventAuditPfeesPaidV2 {
     id: string;
@@ -53,6 +59,7 @@ export interface BaseEventAuditPfeesPaidV2 {
     schemaVersion: "v2";
     eventType: "audit.pfees.paid";
     timeStamp: number;
+    environment: "staging" | "production";
 }
 export interface BaseEventAuditPfeesPaidV2Alpha {
     id: string;
@@ -61,6 +68,7 @@ export interface BaseEventAuditPfeesPaidV2Alpha {
     schemaVersion: "v2-alpha";
     eventType: "audit.pfees.paid";
     timeStamp: number;
+    environment: "staging" | "production";
 }
 export interface BaseEventApplicationCreatedV1 {
     id: string;
@@ -69,6 +77,7 @@ export interface BaseEventApplicationCreatedV1 {
     schemaVersion: "v1";
     eventType: "application.created";
     timeStamp: number;
+    environment: "staging" | "production";
 }
 export interface BaseEventApplicationCreatedV2Alpha {
     id: string;
@@ -77,6 +86,7 @@ export interface BaseEventApplicationCreatedV2Alpha {
     schemaVersion: "v2-alpha";
     eventType: "application.created";
     timeStamp: number;
+    environment: "staging" | "production";
 }
 export interface BaseEventApplicationPriceQuoteV2Alpha {
     id: string;
@@ -85,6 +95,7 @@ export interface BaseEventApplicationPriceQuoteV2Alpha {
     schemaVersion: "v2-alpha";
     eventType: "application.price.quote";
     timeStamp: number;
+    environment: "staging" | "production";
 }
 export interface BaseEventGctlMintedV2Alpha {
     id: string;
@@ -93,6 +104,7 @@ export interface BaseEventGctlMintedV2Alpha {
     schemaVersion: "v2-alpha";
     eventType: "gctl.minted";
     timeStamp: number;
+    environment: "staging" | "production";
 }
 export interface BaseEventAuditorFeesPaidV2Alpha {
     id: string;
@@ -101,6 +113,7 @@ export interface BaseEventAuditorFeesPaidV2Alpha {
     schemaVersion: "v2-alpha";
     eventType: "auditor.fees.paid";
     timeStamp: number;
+    environment: "staging" | "production";
 }
 export interface BaseEventFractionCreatedV2Alpha {
     id: string;
@@ -109,6 +122,7 @@ export interface BaseEventFractionCreatedV2Alpha {
     schemaVersion: "v2-alpha";
     eventType: "fraction.created";
     timeStamp: number;
+    environment: "staging" | "production";
 }
 export interface BaseEventFractionSoldV2Alpha {
     id: string;
@@ -117,6 +131,7 @@ export interface BaseEventFractionSoldV2Alpha {
     schemaVersion: "v2-alpha";
     eventType: "fraction.sold";
     timeStamp: number;
+    environment: "staging" | "production";
 }
 export interface BaseEventFractionClosedV2Alpha {
     id: string;
@@ -125,5 +140,6 @@ export interface BaseEventFractionClosedV2Alpha {
     schemaVersion: "v2-alpha";
     eventType: "fraction.closed";
     timeStamp: number;
+    environment: "staging" | "production";
 }
 export type BaseEvent = BaseEventAuditPushedV1 | BaseEventAuditSlashedV1 | BaseEventAuditPfeesPaidV1 | BaseEventAuditPfeesPaidV2 | BaseEventAuditPfeesPaidV2Alpha | BaseEventApplicationCreatedV1 | BaseEventApplicationCreatedV2Alpha | BaseEventApplicationPriceQuoteV2Alpha | BaseEventGctlMintedV2Alpha | BaseEventAuditorFeesPaidV2Alpha | BaseEventFractionCreatedV2Alpha | BaseEventFractionSoldV2Alpha | BaseEventFractionClosedV2Alpha;

package/dist/base-event.js

@@ -15,4 +15,5 @@ exports.baseEventZ = zod_1.z.object({
     schemaVersion: zod_1.z.enum(["v1", "v2", "v2-alpha"]),
     eventType: zod_1.z.enum(Object.values(event_types_1.eventTypes)),
     timeStamp: zod_1.z.number().int(),
+    environment: zod_1.z.enum(["staging", "production"]).default("production"),
 });

package/dist/emitter.d.ts

@@ -5,13 +5,14 @@ interface CreateGlowEventEmitterOptions {
     zoneId: number;
     exchangePrefix?: string;
     host?: string;
+    environment?: "staging" | "production";
 }
 interface EmitEventArgs<T extends EventType, V extends keyof EventPayloadMap[T]> {
     eventType: T;
     schemaVersion: V;
     payload: EventPayload<T, V>;
 }
-export declare function createGlowEventEmitter({ username, password, zoneId, exchangePrefix, host, }: CreateGlowEventEmitterOptions): {
+export declare function createGlowEventEmitter({ username, password, zoneId, exchangePrefix, host, environment, }: CreateGlowEventEmitterOptions): {
     emit: <T extends EventType, V extends keyof import("./types").EventPayloadMap[T]>(args: EmitEventArgs<T, V>) => Promise<void>;
     disconnect: () => Promise<void>;
 };

package/dist/emitter.js

@@ -8,7 +8,7 @@ const amqplib_1 = __importDefault(require("amqplib"));
 const utils_1 = require("./utils");
 const uuid_1 = require("uuid");
 const zones_1 = require("./zones");
-function createGlowEventEmitter({ username, password, zoneId, exchangePrefix = "glow.zone-", host = "turntable.proxy.rlwy.net:50784", }) {
+function createGlowEventEmitter({ username, password, zoneId, exchangePrefix = "glow.zone-", host = "turntable.proxy.rlwy.net:50784", environment = "production", }) {
     let amqpConnection = null;
     let amqpChannel = null;
     // Exchanges for global and specific zone
@@ -41,8 +41,6 @@ function createGlowEventEmitter({ username, password, zoneId, exchangePrefix = "
         const zoneName = zones_1.zoneMap[zoneId];
         if (!zoneName)
             throw new Error(`Invalid zoneId: ${zoneId}`);
-        if (zoneId === 0)
-            throw new Error("Cannot emit events with zoneId 0. Use a specific zone emitter.");
         const event = {
             id: (0, uuid_1.v4)(),
             eventType,
@@ -50,6 +48,7 @@ function createGlowEventEmitter({ username, password, zoneId, exchangePrefix = "
             zoneId,
             zoneName,
             timeStamp: Date.now(),
+            environment,
             payload,
         };
         (0, utils_1.validateZoneNameAndId)(event.zoneId, event.zoneName);

package/package.json

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