@lerna-labs/hydra-sdk 1.0.0-beta.21 → 1.0.0-beta.22

package/dist/hydra/hydra-monitor.d.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from 'node:events';
 import { HydraWebSocket } from './hydra-websocket.js';
-import type { GreetingsMessage, HeadStatus, HydraMessage, HydraMonitorOptions, HydraStatus, ServerOutput, TimestampedEvent } from './types.js';
+import type { GreetingsMessage, HeadStatus, HydraHeadInfo, HydraMessage, HydraMonitorOptions, HydraStatus, ServerOutput, TimestampedEvent } from './types.js';
 /**
  * Persistent WebSocket monitor for a Hydra head.
  *
@@ -53,6 +53,12 @@ export declare class HydraMonitor extends EventEmitter {
     get headStatusMixed(): HeadStatus;
     /** The full Greetings message from the most recent connection. */
     get greetings(): GreetingsMessage | null;
+    /**
+     * Summary of Hydra head info extracted from the last Greetings.
+     * Excludes the full UTxO snapshot to keep payloads small.
+     * Returns `null` if no Greetings has been received yet.
+     */
+    get headInfo(): HydraHeadInfo | null;
     /** The last N events (configurable via eventBufferSize). Most recent last. */
     get recentEvents(): readonly TimestampedEvent[];
     /**

package/dist/hydra/hydra-monitor.js

@@ -92,6 +92,31 @@ export class HydraMonitor extends EventEmitter {
     get greetings() {
         return this.ws.lastGreetings;
     }
+    /**
+     * Summary of Hydra head info extracted from the last Greetings.
+     * Excludes the full UTxO snapshot to keep payloads small.
+     * Returns `null` if no Greetings has been received yet.
+     */
+    get headInfo() {
+        const g = this.greetings;
+        if (!g)
+            return null;
+        const peers = g.env?.configuredPeers;
+        const peerCount = peers ? peers.split(',').filter(Boolean).length : 0;
+        return {
+            headStatus: g.headStatus,
+            headId: g.hydraHeadId ?? null,
+            nodeVersion: g.hydraNodeVersion ?? null,
+            me: g.me.vkey,
+            contestationPeriod: g.env?.contestationPeriod ?? null,
+            depositPeriod: g.env?.depositPeriod ?? null,
+            participants: g.env?.participants ?? [],
+            networkConnected: g.networkInfo?.networkConnected ?? false,
+            peerCount,
+            chainSyncedStatus: g.chainSyncedStatus ?? null,
+            currentSlot: g.currentSlot ?? null,
+        };
+    }
     /** The last N events (configurable via eventBufferSize). Most recent last. */
     get recentEvents() {
         return this._events;

package/dist/hydra/hydra-websocket.js

@@ -149,10 +149,19 @@ export class HydraWebSocket extends EventEmitter {
         return this._lastGreetings;
     }
     handleMessage(msg) {
+        // Strip sensitive fields before caching or emitting
         if (msg.tag === 'Greetings') {
-            this._lastGreetings = msg;
+            const sanitized = { ...msg };
+            if (sanitized.env && typeof sanitized.env === 'object') {
+                const { signingKey: _, ...safeEnv } = sanitized.env;
+                sanitized.env = safeEnv;
+            }
+            this._lastGreetings = sanitized;
+            this.emit('message', sanitized);
+        }
+        else {
+            this.emit('message', msg);
         }
-        this.emit('message', msg);
         // Update status from Greetings headStatus
         if (msg.tag === 'Greetings' && 'headStatus' in msg) {
             const mapped = HEAD_STATUS_TO_HYDRA[msg.headStatus];

package/dist/hydra/messages.d.ts

@@ -11,4 +11,4 @@
  * }
  * ```
  */
-export type { ClientInput, ClientMessage, ConnectionState, HeadStatus, HydraMessage, HydraMonitorOptions, HydraStatus, HydraTransaction, HydraWsMessage, hydraStatus, hydraTransaction, ServerOutput, TimestampedEvent, } from './types.js';
+export type { ClientInput, ClientMessage, ConnectionState, HeadStatus, HydraHeadInfo, HydraMessage, HydraMonitorOptions, HydraStatus, HydraTransaction, HydraWsMessage, hydraStatus, hydraTransaction, ServerOutput, TimestampedEvent, } from './types.js';

package/dist/hydra/types.d.ts

@@ -72,6 +72,35 @@ export type ClientInput = {
     recoverTxId: string;
 };
 /** Greetings message received on initial WebSocket connection. */
+/** Hydra node environment info reported in Greetings. */
+export interface HydraEnv {
+    /** Configured peer addresses (comma-separated or empty). */
+    configuredPeers: string;
+    /** Contestation period in seconds. */
+    contestationPeriod: number;
+    /** Deposit period in seconds. */
+    depositPeriod: number;
+    /** Other parties' verification keys. */
+    otherParties: {
+        vkey: string;
+    }[];
+    /** All participant key hashes. */
+    participants: string[];
+    /** This node's party identity. */
+    party: {
+        vkey: string;
+    };
+    [key: string]: unknown;
+}
+/** Network connectivity info reported in Greetings. */
+export interface HydraNetworkInfo {
+    /** Whether the node is connected to the Cardano network. */
+    networkConnected: boolean;
+    /** Per-peer connection info. */
+    peersInfo: Record<string, unknown>;
+    [key: string]: unknown;
+}
+/** Greetings message received on initial WebSocket connection. */
 export interface GreetingsMessage {
     tag: 'Greetings';
     me: {
@@ -81,8 +110,40 @@ export interface GreetingsMessage {
     hydraHeadId?: string;
     snapshotUtxo?: HydraUTxOs;
     hydraNodeVersion?: string;
-    env?: Record<string, unknown>;
-    networkInfo?: Record<string, unknown>;
+    env?: HydraEnv;
+    networkInfo?: HydraNetworkInfo;
+    /** L1 chain sync status (e.g. `"InSync"`). Available in Hydra >= 1.3.0. */
+    chainSyncedStatus?: string;
+    /** Current L1 slot number. Available in Hydra >= 1.3.0. */
+    currentSlot?: number;
+}
+/**
+ * Summary of Hydra head info extracted from the Greetings message.
+ * Excludes the full UTxO snapshot to keep payloads small.
+ */
+export interface HydraHeadInfo {
+    /** Current head status. */
+    headStatus: HeadStatus;
+    /** On-chain head identifier / policy ID (null when head is Idle / not yet initialized). */
+    headId: string | null;
+    /** Hydra node version string. */
+    nodeVersion: string | null;
+    /** This node's verification key. */
+    me: string;
+    /** Contestation period in seconds. */
+    contestationPeriod: number | null;
+    /** Deposit period in seconds. */
+    depositPeriod: number | null;
+    /** All participant key hashes. */
+    participants: string[];
+    /** Whether the node is connected to the Cardano network. */
+    networkConnected: boolean;
+    /** Number of configured peers. */
+    peerCount: number;
+    /** L1 chain sync status (e.g. `"InSync"`). Null if not reported (Hydra < 1.3.0). */
+    chainSyncedStatus: string | null;
+    /** Current L1 slot number. Null if not reported (Hydra < 1.3.0). */
+    currentSlot: number | null;
 }
 export interface HeadIsInitializingMessage {
     tag: 'HeadIsInitializing';

package/dist/index.d.ts

@@ -2,7 +2,7 @@ export type { DiskCache, DiskCacheConfig } from './cache/disk-cache.js';
 export { createDiskCache } from './cache/disk-cache.js';
 export { optionalEnv, requireEnv } from './config.js';
 export { HydraMonitor } from './hydra/hydra-monitor.js';
-export type { HeadStatus, HydraMessage, HydraMonitorOptions, HydraStatus, HydraTransaction, HydraWsMessage, hydraStatus, hydraTransaction, ServerOutput, TimestampedEvent, } from './hydra/messages.js';
+export type { HeadStatus, HydraHeadInfo, HydraMessage, HydraMonitorOptions, HydraStatus, HydraTransaction, HydraWsMessage, hydraStatus, hydraTransaction, ServerOutput, TimestampedEvent, } from './hydra/messages.js';
 export type { ParsedUtxo, UtxoQueryOptions } from './hydra/utxo.js';
 export { getUtxoSet, queryUtxoByAddress } from './hydra/utxo.js';
 export type { IpfsClient, IpfsConfig, PinResult } from './ipfs/ipfs.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lerna-labs/hydra-sdk",
-  "version": "1.0.0-beta.21",
+  "version": "1.0.0-beta.22",
   "description": "TypeScript SDK for managing Cardano Hydra Heads — lifecycle, UTxO queries, wallet management, transaction submission, and signature verification",
   "keywords": [
     "cardano",